Databricks SDK for JavaScript
    Preparing search index...

    Interface ModelService

    A governed AI Gateway endpoint in Unity Catalog that routes inference requests to one or more model destinations (for example a foundation model or an external LLM reached through a ModelProviderService). Applies centralized access control, rate limits, guardrails, and auditing to the traffic it serves.

    interface ModelService {
        browseOnly?: boolean;
        comment?: string;
        config?: ModelServiceConfig;
        createdBy?: string;
        createTime?: Instant;
        effectiveOwner?: string;
        etag?: Uint8Array<ArrayBufferLike>;
        metastoreId?: string;
        name?: string;
        owner?: string;
        supportedApiTypes?: string[];
        updatedBy?: string;
        updateTime?: Instant;
    }
    Index

    Properties

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

    Properties

    browseOnly?: boolean

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

    comment?: string

    User-provided description.

    config?: ModelServiceConfig

    Operational configuration: destinations, routing, rate limits, inference table. Required on CreateModelService; on UpdateModelService it is required only when config (or a config.* subpath) appears in update_mask.

    createdBy?: string

    Creator identity.

    createTime?: Instant

    When the model service was created.

    effectiveOwner?: string

    The resolved owner of the ModelService. 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 model service.

    name?: string

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

    owner?: string

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

    supportedApiTypes?: string[]

    Unified API types this endpoint supports (e.g. "chat", "embeddings", "completions"). Derived from the destinations' backing models / providers at read time.

    updatedBy?: string

    Identity of the last updater.

    updateTime?: Instant

    When the model service was last modified.

    Settings

    Member Visibility

    On This Page

    Properties