Databricks SDK for JavaScript
    Preparing search index...

    Interface Endpoint

    An AI Search endpoint — compute infrastructure that hosts AI Search indexes and serves queries against them. Customers create, query, and delete endpoints; the system manages provisioning, scaling, and health status.

    interface Endpoint {
        budgetPolicyId?: string;
        createTime?: Instant;
        creator?: string;
        customTags?: CustomTag[];
        effectiveBudgetPolicyId?: string;
        endpointStatus?: EndpointStatus;
        endpointType?: EndpointType;
        id?: string;
        indexCount?: number;
        lastUpdatedUser?: string;
        name?: string;
        replicaCount?: number;
        scalingInfo?: EndpointScalingInfo;
        targetQps?: number;
        throughputInfo?: EndpointThroughputInfo;
        updateTime?: Instant;
        usagePolicyId?: string;
    }
    Index

    Properties

    budgetPolicyId? createTime? creator? customTags? effectiveBudgetPolicyId? endpointStatus? endpointType? id? indexCount? lastUpdatedUser? name? replicaCount? scalingInfo? targetQps? throughputInfo? updateTime? usagePolicyId?

    Properties

    budgetPolicyId?: string

    The user-selected budget policy id for the endpoint.

    createTime?: Instant

    Time the endpoint was created.

    creator?: string

    Creator of the endpoint

    customTags?: CustomTag[]

    The custom tags assigned to the endpoint

    effectiveBudgetPolicyId?: string

    The budget policy id applied to the endpoint

    endpointStatus?: EndpointStatus

    Current status of the endpoint

    endpointType?: EndpointType

    Type of endpoint. Required on create and immutable thereafter.

    id?: string

    Unique identifier of the endpoint

    indexCount?: number

    Number of indexes on the endpoint

    lastUpdatedUser?: string

    User who last updated the endpoint

    name?: string

    Name of the AI Search endpoint. Server-assigned full resource path (workspaces/{workspace}/endpoints/{endpoint}) on output. On create, the user-supplied short name is conveyed via CreateEndpointRequest.endpoint_id; the server composes the full name and returns it on the response.

    replicaCount?: number

    The client-supplied desired number of replicas for the endpoint, applied at create/update time. Mutually exclusive with target_qps.

    scalingInfo?: EndpointScalingInfo

    Scaling information for the endpoint

    targetQps?: number

    Target QPS for the endpoint. Mutually exclusive with replica_count. Best-effort; the system does not guarantee this QPS will be achieved.

    throughputInfo?: EndpointThroughputInfo

    Throughput information for the endpoint

    updateTime?: Instant

    Time the endpoint was last updated.

    usagePolicyId?: string

    The usage policy id applied to the endpoint.

    Settings

    Member Visibility

    On This Page

    Properties