Databricks SDK for JavaScript
    Preparing search index...

    Interface OpenAiConfig

    Configs needed to create an OpenAI model route.

    interface OpenAiConfig {
        microsoftEntraClientId?: string;
        microsoftEntraClientSecret?: string;
        microsoftEntraClientSecretPlaintext?: string;
        microsoftEntraTenantId?: string;
        openaiApiBase?: string;
        openaiApiKey?: string;
        openaiApiKeyPlaintext?: string;
        openaiApiType?: string;
        openaiApiVersion?: string;
        openaiDeploymentName?: string;
        openaiOrganization?: string;
    }
    Index

    Properties

    microsoftEntraClientId? microsoftEntraClientSecret? microsoftEntraClientSecretPlaintext? microsoftEntraTenantId? openaiApiBase? openaiApiKey? openaiApiKeyPlaintext? openaiApiType? openaiApiVersion? openaiDeploymentName? openaiOrganization?

    Properties

    microsoftEntraClientId?: string

    This field is only required for Azure AD OpenAI and is the Microsoft Entra Client ID.

    microsoftEntraClientSecret?: string

    The secret key reference for a client secret used for Microsoft Entra ID authentication. If you prefer to paste your client secret directly, see microsoft_entra_client_secret_plaintext. You must provide an API key using one of the following fields: microsoft_entra_client_secret or microsoft_entra_client_secret_plaintext.

    microsoftEntraClientSecretPlaintext?: string

    The client secret used for Microsoft Entra ID authentication provided as a plaintext string. If you prefer to reference your key using Databricks Secrets, see microsoft_entra_client_secret. You must provide an API key using one of the following fields: microsoft_entra_client_secret or microsoft_entra_client_secret_plaintext.

    microsoftEntraTenantId?: string

    This field is only required for Azure AD OpenAI and is the Microsoft Entra Tenant ID.

    openaiApiBase?: string

    This is a field to provide a customized base URl for the OpenAI API. For Azure OpenAI, this field is required, and is the base URL for the Azure OpenAI API service provided by Azure. For other OpenAI API types, this field is optional, and if left unspecified, the standard OpenAI base URL is used.

    openaiApiKey?: string

    The secret key reference for an OpenAI API key using the OpenAI or Azure service. If you prefer to paste your API key directly, see openai_api_key_plaintext. You must provide an API key using one of the following fields: openai_api_key or openai_api_key_plaintext.

    openaiApiKeyPlaintext?: string

    The OpenAI API key using the OpenAI or Azure service provided as a plaintext string. If you prefer to reference your key using Databricks Secrets, see openai_api_key. You must provide an API key using one of the following fields: openai_api_key or openai_api_key_plaintext.

    openaiApiType?: string

    This is an optional field to specify the type of OpenAI API to use. For Azure OpenAI, this field is required, and adjust this parameter to represent the preferred security access validation protocol. For access token validation, use azure. For authentication using Azure Active Directory (Azure AD) use, azuread.

    openaiApiVersion?: string

    This is an optional field to specify the OpenAI API version. For Azure OpenAI, this field is required, and is the version of the Azure OpenAI service to utilize, specified by a date.

    openaiDeploymentName?: string

    This field is only required for Azure OpenAI and is the name of the deployment resource for the Azure OpenAI service.

    openaiOrganization?: string

    This is an optional field to specify the organization in OpenAI or Azure OpenAI.

    Settings

    Member Visibility

    On This Page

    Properties