Databricks SDK for JavaScript
    Preparing search index...

    Interface Index

    An AI Search index — a searchable collection of vectors and metadata hosted on an AI Search endpoint. Indexes are children of endpoints; customers create, get, list, and delete them. The {index} segment of the resource name is the index's Unity Catalog table name.

    interface Index {
        creator?: string;
        endpoint?: string;
        indexSpec?:
            | {
                $case: "directAccessIndexSpec";
                directAccessIndexSpec: DirectAccessIndexSpec;
            }
            | { $case: "deltaSyncIndexSpec"; deltaSyncIndexSpec: DeltaSyncIndexSpec };
        indexSubtype?: IndexSubtype;
        indexType?: IndexType;
        name?: string;
        primaryKey?: string;
        status?: IndexStatus;
    }
    Index

    Properties

    creator? endpoint? indexSpec? indexSubtype? indexType? name? primaryKey? status?

    Properties

    creator?: string

    Creator of the index.

    endpoint?: string

    Name of the endpoint associated with the index. Ignored on create — the endpoint is taken from CreateIndexRequest.parent; populated only on output.

    indexSpec?:
        | {
            $case: "directAccessIndexSpec";
            directAccessIndexSpec: DirectAccessIndexSpec;
        }
        | { $case: "deltaSyncIndexSpec"; deltaSyncIndexSpec: DeltaSyncIndexSpec }

    Configuration of the index, dependent on index_type. Set on create and immutable thereafter.

    Type Declaration

    • { $case: "directAccessIndexSpec"; directAccessIndexSpec: DirectAccessIndexSpec }
      • $case: "directAccessIndexSpec"
      • directAccessIndexSpec: DirectAccessIndexSpec

        Specification for a Direct Access index. Set when index_type is DIRECT_ACCESS.

    • { $case: "deltaSyncIndexSpec"; deltaSyncIndexSpec: DeltaSyncIndexSpec }
      • $case: "deltaSyncIndexSpec"
      • deltaSyncIndexSpec: DeltaSyncIndexSpec

        Specification for a Delta Sync index. Set when index_type is DELTA_SYNC.

    indexSubtype?: IndexSubtype

    The subtype of the index. Set on create and immutable thereafter.

    indexType?: IndexType

    Type of index. Required on create and immutable thereafter.

    name?: string

    Name of the AI Search index. Server-assigned full resource path (workspaces/{workspace}/endpoints/{endpoint}/indexes/{index}) on output, where {index} is the index's Unity Catalog table name. On create, the user-supplied UC table name is conveyed via CreateIndexRequest.index_id; the server composes the full name and returns it on the response.

    primaryKey?: string

    Primary key of the index. Set on create and immutable thereafter.

    status?: IndexStatus

    Current status of the index.

    Settings

    Member Visibility

    On This Page

    Properties