Databricks SDK for JavaScript
    Preparing search index...

    Interface ModelProviderService

    A governed external model-provider connection stored in Unity Catalog (e.g. an OpenAI API account, an Azure OpenAI deployment, an Amazon Bedrock account). Owns the provider type and the auth/configuration the platform needs to invoke that provider, and is referenced from ExternalModelConfig.model_provider_service on a ModelService.

    One ModelProviderService can back many ModelServices (e.g. an openai_prod provider serving multiple models); a single ModelService can fan out across multiple ModelProviderServices for traffic split or failover.

    interface ModelProviderService {
        browseOnly?: boolean;
        comment?: string;
        config?: ModelProviderServiceConfig;
        createdBy?: string;
        createTime?: Instant;
        effectiveOwner?: string;
        etag?: Uint8Array<ArrayBufferLike>;
        metastoreId?: string;
        name?: string;
        owner?: string;
        updatedBy?: string;
        updateTime?: Instant;
    }
    Index

    Properties

    browseOnly? comment? config? createdBy? createTime? effectiveOwner? etag? metastoreId? name? owner? updatedBy? updateTime?

    Properties

    browseOnly?: boolean

    Whether the caller sees only metadata available through the BROWSE privilege.

    comment?: string

    User-provided description.

    config?: ModelProviderServiceConfig

    Behavioral configuration: provider connection, model catalog, and passthrough policy. See ModelProviderServiceConfig for the per-field contract. Required on CreateModelProviderService; on Update it is required only when config (or a config.* subpath) appears in update_mask.

    createdBy?: string

    Creator identity.

    createTime?: Instant

    When the provider service was created.

    effectiveOwner?: string

    The resolved owner of the model provider service. Falls back to the caller's identity when owner is not explicitly set on creation.

    etag?: Uint8Array<ArrayBufferLike>

    Optimistic concurrency control token. Server-generated from the entity's state and returned on every read. To use it as an if-match precondition on a mutation, echo the last-read value back via the dedicated etag field on the Update / Delete request; the server rejects the mutation if the stored etag differs.

    metastoreId?: string

    Metastore hosting the provider service.

    name?: string

    Resource name of the provider service. Format: model-provider-services/{catalog}.{schema}.{model_provider_service}. Each {...} component is capped at 255 characters individually. Server-derived on Create from parent + model_provider_service_id; required and immutable on Update/Get/Delete.

    owner?: string

    The owner of the model provider service. Write-only; read owner via effective_owner.

    updatedBy?: string

    Identity of the last updater.

    updateTime?: Instant

    When the provider service was last modified.

    Settings

    Member Visibility

    On This Page

    Properties