1. Packages
  2. Packages
  3. Databricks Provider
  4. API Docs
  5. getAiSearchIndex
Viewing docs for Databricks v1.96.0
published on Thursday, Jun 18, 2026 by Pulumi
databricks logo
Viewing docs for Databricks v1.96.0
published on Thursday, Jun 18, 2026 by Pulumi

    Private Preview

    Using getAiSearchIndex

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getAiSearchIndex(args: GetAiSearchIndexArgs, opts?: InvokeOptions): Promise<GetAiSearchIndexResult>
    function getAiSearchIndexOutput(args: GetAiSearchIndexOutputArgs, opts?: InvokeOptions): Output<GetAiSearchIndexResult>
    def get_ai_search_index(name: Optional[str] = None,
                            provider_config: Optional[GetAiSearchIndexProviderConfig] = None,
                            opts: Optional[InvokeOptions] = None) -> GetAiSearchIndexResult
    def get_ai_search_index_output(name: pulumi.Input[Optional[str]] = None,
                            provider_config: pulumi.Input[Optional[GetAiSearchIndexProviderConfigArgs]] = None,
                            opts: Optional[InvokeOptions] = None) -> Output[GetAiSearchIndexResult]
    func LookupAiSearchIndex(ctx *Context, args *LookupAiSearchIndexArgs, opts ...InvokeOption) (*LookupAiSearchIndexResult, error)
    func LookupAiSearchIndexOutput(ctx *Context, args *LookupAiSearchIndexOutputArgs, opts ...InvokeOption) LookupAiSearchIndexResultOutput

    > Note: This function is named LookupAiSearchIndex in the Go SDK.

    public static class GetAiSearchIndex 
    {
        public static Task<GetAiSearchIndexResult> InvokeAsync(GetAiSearchIndexArgs args, InvokeOptions? opts = null)
        public static Output<GetAiSearchIndexResult> Invoke(GetAiSearchIndexInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetAiSearchIndexResult> getAiSearchIndex(GetAiSearchIndexArgs args, InvokeOptions options)
    public static Output<GetAiSearchIndexResult> getAiSearchIndex(GetAiSearchIndexArgs args, InvokeOptions options)
    
    fn::invoke:
      function: databricks:index/getAiSearchIndex:getAiSearchIndex
      arguments:
        # arguments dictionary
    data "databricks_getaisearchindex" "name" {
        # arguments
    }

    The following arguments are supported:

    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
    ProviderConfig GetAiSearchIndexProviderConfig
    Configure the provider for management through account provider.
    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
    ProviderConfig GetAiSearchIndexProviderConfig
    Configure the provider for management through account provider.
    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
    provider_config object
    Configure the provider for management through account provider.
    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
    providerConfig GetAiSearchIndexProviderConfig
    Configure the provider for management through account provider.
    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
    providerConfig GetAiSearchIndexProviderConfig
    Configure the provider for management through account provider.
    name str
    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
    provider_config GetAiSearchIndexProviderConfig
    Configure the provider for management through account provider.
    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
    providerConfig Property Map
    Configure the provider for management through account provider.

    getAiSearchIndex Result

    The following output properties are available:

    Creator string
    (string) - Creator of the index
    DeltaSyncIndexSpec GetAiSearchIndexDeltaSyncIndexSpec
    (DeltaSyncIndexSpec) - Specification for a Delta Sync index. Set when indexType is DELTA_SYNC
    DirectAccessIndexSpec GetAiSearchIndexDirectAccessIndexSpec
    (DirectAccessIndexSpec) - Specification for a Direct Access index. Set when indexType is DIRECT_ACCESS
    Endpoint string
    (string) - Name of the endpoint associated with the index. Ignored on create — the endpoint is taken from CreateIndexRequest.parent; populated only on output
    Id string
    The provider-assigned unique ID for this managed resource.
    IndexSubtype string
    (string) - The subtype of the index. Set on create and immutable thereafter. Possible values are: FULL_TEXT, HYBRID, VECTOR
    IndexType string
    (string) - Type of index. Required on create and immutable thereafter. Possible values are: DELTA_SYNC, DIRECT_ACCESS
    Name string
    (string) - Name of the column
    PrimaryKey string
    (string) - Primary key of the index. Set on create and immutable thereafter
    Status GetAiSearchIndexStatus
    (IndexStatus) - Current status of the index
    ProviderConfig GetAiSearchIndexProviderConfig
    Creator string
    (string) - Creator of the index
    DeltaSyncIndexSpec GetAiSearchIndexDeltaSyncIndexSpec
    (DeltaSyncIndexSpec) - Specification for a Delta Sync index. Set when indexType is DELTA_SYNC
    DirectAccessIndexSpec GetAiSearchIndexDirectAccessIndexSpec
    (DirectAccessIndexSpec) - Specification for a Direct Access index. Set when indexType is DIRECT_ACCESS
    Endpoint string
    (string) - Name of the endpoint associated with the index. Ignored on create — the endpoint is taken from CreateIndexRequest.parent; populated only on output
    Id string
    The provider-assigned unique ID for this managed resource.
    IndexSubtype string
    (string) - The subtype of the index. Set on create and immutable thereafter. Possible values are: FULL_TEXT, HYBRID, VECTOR
    IndexType string
    (string) - Type of index. Required on create and immutable thereafter. Possible values are: DELTA_SYNC, DIRECT_ACCESS
    Name string
    (string) - Name of the column
    PrimaryKey string
    (string) - Primary key of the index. Set on create and immutable thereafter
    Status GetAiSearchIndexStatus
    (IndexStatus) - Current status of the index
    ProviderConfig GetAiSearchIndexProviderConfig
    creator string
    (string) - Creator of the index
    delta_sync_index_spec object
    (DeltaSyncIndexSpec) - Specification for a Delta Sync index. Set when indexType is DELTA_SYNC
    direct_access_index_spec object
    (DirectAccessIndexSpec) - Specification for a Direct Access index. Set when indexType is DIRECT_ACCESS
    endpoint string
    (string) - Name of the endpoint associated with the index. Ignored on create — the endpoint is taken from CreateIndexRequest.parent; populated only on output
    id string
    The provider-assigned unique ID for this managed resource.
    index_subtype string
    (string) - The subtype of the index. Set on create and immutable thereafter. Possible values are: FULL_TEXT, HYBRID, VECTOR
    index_type string
    (string) - Type of index. Required on create and immutable thereafter. Possible values are: DELTA_SYNC, DIRECT_ACCESS
    name string
    (string) - Name of the column
    primary_key string
    (string) - Primary key of the index. Set on create and immutable thereafter
    status object
    (IndexStatus) - Current status of the index
    provider_config object
    creator String
    (string) - Creator of the index
    deltaSyncIndexSpec GetAiSearchIndexDeltaSyncIndexSpec
    (DeltaSyncIndexSpec) - Specification for a Delta Sync index. Set when indexType is DELTA_SYNC
    directAccessIndexSpec GetAiSearchIndexDirectAccessIndexSpec
    (DirectAccessIndexSpec) - Specification for a Direct Access index. Set when indexType is DIRECT_ACCESS
    endpoint String
    (string) - Name of the endpoint associated with the index. Ignored on create — the endpoint is taken from CreateIndexRequest.parent; populated only on output
    id String
    The provider-assigned unique ID for this managed resource.
    indexSubtype String
    (string) - The subtype of the index. Set on create and immutable thereafter. Possible values are: FULL_TEXT, HYBRID, VECTOR
    indexType String
    (string) - Type of index. Required on create and immutable thereafter. Possible values are: DELTA_SYNC, DIRECT_ACCESS
    name String
    (string) - Name of the column
    primaryKey String
    (string) - Primary key of the index. Set on create and immutable thereafter
    status GetAiSearchIndexStatus
    (IndexStatus) - Current status of the index
    providerConfig GetAiSearchIndexProviderConfig
    creator string
    (string) - Creator of the index
    deltaSyncIndexSpec GetAiSearchIndexDeltaSyncIndexSpec
    (DeltaSyncIndexSpec) - Specification for a Delta Sync index. Set when indexType is DELTA_SYNC
    directAccessIndexSpec GetAiSearchIndexDirectAccessIndexSpec
    (DirectAccessIndexSpec) - Specification for a Direct Access index. Set when indexType is DIRECT_ACCESS
    endpoint string
    (string) - Name of the endpoint associated with the index. Ignored on create — the endpoint is taken from CreateIndexRequest.parent; populated only on output
    id string
    The provider-assigned unique ID for this managed resource.
    indexSubtype string
    (string) - The subtype of the index. Set on create and immutable thereafter. Possible values are: FULL_TEXT, HYBRID, VECTOR
    indexType string
    (string) - Type of index. Required on create and immutable thereafter. Possible values are: DELTA_SYNC, DIRECT_ACCESS
    name string
    (string) - Name of the column
    primaryKey string
    (string) - Primary key of the index. Set on create and immutable thereafter
    status GetAiSearchIndexStatus
    (IndexStatus) - Current status of the index
    providerConfig GetAiSearchIndexProviderConfig
    creator str
    (string) - Creator of the index
    delta_sync_index_spec GetAiSearchIndexDeltaSyncIndexSpec
    (DeltaSyncIndexSpec) - Specification for a Delta Sync index. Set when indexType is DELTA_SYNC
    direct_access_index_spec GetAiSearchIndexDirectAccessIndexSpec
    (DirectAccessIndexSpec) - Specification for a Direct Access index. Set when indexType is DIRECT_ACCESS
    endpoint str
    (string) - Name of the endpoint associated with the index. Ignored on create — the endpoint is taken from CreateIndexRequest.parent; populated only on output
    id str
    The provider-assigned unique ID for this managed resource.
    index_subtype str
    (string) - The subtype of the index. Set on create and immutable thereafter. Possible values are: FULL_TEXT, HYBRID, VECTOR
    index_type str
    (string) - Type of index. Required on create and immutable thereafter. Possible values are: DELTA_SYNC, DIRECT_ACCESS
    name str
    (string) - Name of the column
    primary_key str
    (string) - Primary key of the index. Set on create and immutable thereafter
    status GetAiSearchIndexStatus
    (IndexStatus) - Current status of the index
    provider_config GetAiSearchIndexProviderConfig
    creator String
    (string) - Creator of the index
    deltaSyncIndexSpec Property Map
    (DeltaSyncIndexSpec) - Specification for a Delta Sync index. Set when indexType is DELTA_SYNC
    directAccessIndexSpec Property Map
    (DirectAccessIndexSpec) - Specification for a Direct Access index. Set when indexType is DIRECT_ACCESS
    endpoint String
    (string) - Name of the endpoint associated with the index. Ignored on create — the endpoint is taken from CreateIndexRequest.parent; populated only on output
    id String
    The provider-assigned unique ID for this managed resource.
    indexSubtype String
    (string) - The subtype of the index. Set on create and immutable thereafter. Possible values are: FULL_TEXT, HYBRID, VECTOR
    indexType String
    (string) - Type of index. Required on create and immutable thereafter. Possible values are: DELTA_SYNC, DIRECT_ACCESS
    name String
    (string) - Name of the column
    primaryKey String
    (string) - Primary key of the index. Set on create and immutable thereafter
    status Property Map
    (IndexStatus) - Current status of the index
    providerConfig Property Map

    Supporting Types

    GetAiSearchIndexDeltaSyncIndexSpec

    PipelineId string
    (string) - The ID of the pipeline that is used to sync the index
    PipelineType string
    (string) - Pipeline execution mode. Required on create — the backend rejects an unset value. Storage Optimized endpoints accept only TRIGGERED; Standard endpoints accept both. No explicit stage — a REQUIRED field staged below its service would be dropped from combined specs while remaining in required, tripping the OpenAPI required-vs-properties consistency check. The field inherits the service's launch stage. Possible values are: CONTINUOUS, TRIGGERED
    ColumnsToSyncs List<string>
    (list of string) - [Optional] Select the columns to sync with the index. If left blank, all columns from the source table are synced. The primary key column and embedding source or vector column are always synced
    EmbeddingSourceColumns List<GetAiSearchIndexDeltaSyncIndexSpecEmbeddingSourceColumn>
    (list of EmbeddingSourceColumn) - The columns that contain the embedding source
    EmbeddingVectorColumns List<GetAiSearchIndexDeltaSyncIndexSpecEmbeddingVectorColumn>
    (list of EmbeddingVectorColumn) - The columns that contain the embedding vectors
    EmbeddingWritebackTable string
    (string) - [Optional] Name of the Delta table to sync the index contents and computed embeddings to
    SourceTable string
    (string) - The full name of the source Delta table
    PipelineId string
    (string) - The ID of the pipeline that is used to sync the index
    PipelineType string
    (string) - Pipeline execution mode. Required on create — the backend rejects an unset value. Storage Optimized endpoints accept only TRIGGERED; Standard endpoints accept both. No explicit stage — a REQUIRED field staged below its service would be dropped from combined specs while remaining in required, tripping the OpenAPI required-vs-properties consistency check. The field inherits the service's launch stage. Possible values are: CONTINUOUS, TRIGGERED
    ColumnsToSyncs []string
    (list of string) - [Optional] Select the columns to sync with the index. If left blank, all columns from the source table are synced. The primary key column and embedding source or vector column are always synced
    EmbeddingSourceColumns []GetAiSearchIndexDeltaSyncIndexSpecEmbeddingSourceColumn
    (list of EmbeddingSourceColumn) - The columns that contain the embedding source
    EmbeddingVectorColumns []GetAiSearchIndexDeltaSyncIndexSpecEmbeddingVectorColumn
    (list of EmbeddingVectorColumn) - The columns that contain the embedding vectors
    EmbeddingWritebackTable string
    (string) - [Optional] Name of the Delta table to sync the index contents and computed embeddings to
    SourceTable string
    (string) - The full name of the source Delta table
    pipeline_id string
    (string) - The ID of the pipeline that is used to sync the index
    pipeline_type string
    (string) - Pipeline execution mode. Required on create — the backend rejects an unset value. Storage Optimized endpoints accept only TRIGGERED; Standard endpoints accept both. No explicit stage — a REQUIRED field staged below its service would be dropped from combined specs while remaining in required, tripping the OpenAPI required-vs-properties consistency check. The field inherits the service's launch stage. Possible values are: CONTINUOUS, TRIGGERED
    columns_to_syncs list(string)
    (list of string) - [Optional] Select the columns to sync with the index. If left blank, all columns from the source table are synced. The primary key column and embedding source or vector column are always synced
    embedding_source_columns list(object)
    (list of EmbeddingSourceColumn) - The columns that contain the embedding source
    embedding_vector_columns list(object)
    (list of EmbeddingVectorColumn) - The columns that contain the embedding vectors
    embedding_writeback_table string
    (string) - [Optional] Name of the Delta table to sync the index contents and computed embeddings to
    source_table string
    (string) - The full name of the source Delta table
    pipelineId String
    (string) - The ID of the pipeline that is used to sync the index
    pipelineType String
    (string) - Pipeline execution mode. Required on create — the backend rejects an unset value. Storage Optimized endpoints accept only TRIGGERED; Standard endpoints accept both. No explicit stage — a REQUIRED field staged below its service would be dropped from combined specs while remaining in required, tripping the OpenAPI required-vs-properties consistency check. The field inherits the service's launch stage. Possible values are: CONTINUOUS, TRIGGERED
    columnsToSyncs List<String>
    (list of string) - [Optional] Select the columns to sync with the index. If left blank, all columns from the source table are synced. The primary key column and embedding source or vector column are always synced
    embeddingSourceColumns List<GetAiSearchIndexDeltaSyncIndexSpecEmbeddingSourceColumn>
    (list of EmbeddingSourceColumn) - The columns that contain the embedding source
    embeddingVectorColumns List<GetAiSearchIndexDeltaSyncIndexSpecEmbeddingVectorColumn>
    (list of EmbeddingVectorColumn) - The columns that contain the embedding vectors
    embeddingWritebackTable String
    (string) - [Optional] Name of the Delta table to sync the index contents and computed embeddings to
    sourceTable String
    (string) - The full name of the source Delta table
    pipelineId string
    (string) - The ID of the pipeline that is used to sync the index
    pipelineType string
    (string) - Pipeline execution mode. Required on create — the backend rejects an unset value. Storage Optimized endpoints accept only TRIGGERED; Standard endpoints accept both. No explicit stage — a REQUIRED field staged below its service would be dropped from combined specs while remaining in required, tripping the OpenAPI required-vs-properties consistency check. The field inherits the service's launch stage. Possible values are: CONTINUOUS, TRIGGERED
    columnsToSyncs string[]
    (list of string) - [Optional] Select the columns to sync with the index. If left blank, all columns from the source table are synced. The primary key column and embedding source or vector column are always synced
    embeddingSourceColumns GetAiSearchIndexDeltaSyncIndexSpecEmbeddingSourceColumn[]
    (list of EmbeddingSourceColumn) - The columns that contain the embedding source
    embeddingVectorColumns GetAiSearchIndexDeltaSyncIndexSpecEmbeddingVectorColumn[]
    (list of EmbeddingVectorColumn) - The columns that contain the embedding vectors
    embeddingWritebackTable string
    (string) - [Optional] Name of the Delta table to sync the index contents and computed embeddings to
    sourceTable string
    (string) - The full name of the source Delta table
    pipeline_id str
    (string) - The ID of the pipeline that is used to sync the index
    pipeline_type str
    (string) - Pipeline execution mode. Required on create — the backend rejects an unset value. Storage Optimized endpoints accept only TRIGGERED; Standard endpoints accept both. No explicit stage — a REQUIRED field staged below its service would be dropped from combined specs while remaining in required, tripping the OpenAPI required-vs-properties consistency check. The field inherits the service's launch stage. Possible values are: CONTINUOUS, TRIGGERED
    columns_to_syncs Sequence[str]
    (list of string) - [Optional] Select the columns to sync with the index. If left blank, all columns from the source table are synced. The primary key column and embedding source or vector column are always synced
    embedding_source_columns Sequence[GetAiSearchIndexDeltaSyncIndexSpecEmbeddingSourceColumn]
    (list of EmbeddingSourceColumn) - The columns that contain the embedding source
    embedding_vector_columns Sequence[GetAiSearchIndexDeltaSyncIndexSpecEmbeddingVectorColumn]
    (list of EmbeddingVectorColumn) - The columns that contain the embedding vectors
    embedding_writeback_table str
    (string) - [Optional] Name of the Delta table to sync the index contents and computed embeddings to
    source_table str
    (string) - The full name of the source Delta table
    pipelineId String
    (string) - The ID of the pipeline that is used to sync the index
    pipelineType String
    (string) - Pipeline execution mode. Required on create — the backend rejects an unset value. Storage Optimized endpoints accept only TRIGGERED; Standard endpoints accept both. No explicit stage — a REQUIRED field staged below its service would be dropped from combined specs while remaining in required, tripping the OpenAPI required-vs-properties consistency check. The field inherits the service's launch stage. Possible values are: CONTINUOUS, TRIGGERED
    columnsToSyncs List<String>
    (list of string) - [Optional] Select the columns to sync with the index. If left blank, all columns from the source table are synced. The primary key column and embedding source or vector column are always synced
    embeddingSourceColumns List<Property Map>
    (list of EmbeddingSourceColumn) - The columns that contain the embedding source
    embeddingVectorColumns List<Property Map>
    (list of EmbeddingVectorColumn) - The columns that contain the embedding vectors
    embeddingWritebackTable String
    (string) - [Optional] Name of the Delta table to sync the index contents and computed embeddings to
    sourceTable String
    (string) - The full name of the source Delta table

    GetAiSearchIndexDeltaSyncIndexSpecEmbeddingSourceColumn

    EmbeddingModelEndpoint string
    (string) - Name of the embedding model endpoint, used by default for both ingestion and querying
    ModelEndpointNameForQuery string
    (string) - Name of the embedding model endpoint which, if specified, is used for querying (not ingestion)
    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
    EmbeddingModelEndpoint string
    (string) - Name of the embedding model endpoint, used by default for both ingestion and querying
    ModelEndpointNameForQuery string
    (string) - Name of the embedding model endpoint which, if specified, is used for querying (not ingestion)
    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
    embedding_model_endpoint string
    (string) - Name of the embedding model endpoint, used by default for both ingestion and querying
    model_endpoint_name_for_query string
    (string) - Name of the embedding model endpoint which, if specified, is used for querying (not ingestion)
    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
    embeddingModelEndpoint String
    (string) - Name of the embedding model endpoint, used by default for both ingestion and querying
    modelEndpointNameForQuery String
    (string) - Name of the embedding model endpoint which, if specified, is used for querying (not ingestion)
    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
    embeddingModelEndpoint string
    (string) - Name of the embedding model endpoint, used by default for both ingestion and querying
    modelEndpointNameForQuery string
    (string) - Name of the embedding model endpoint which, if specified, is used for querying (not ingestion)
    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
    embedding_model_endpoint str
    (string) - Name of the embedding model endpoint, used by default for both ingestion and querying
    model_endpoint_name_for_query str
    (string) - Name of the embedding model endpoint which, if specified, is used for querying (not ingestion)
    name str
    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
    embeddingModelEndpoint String
    (string) - Name of the embedding model endpoint, used by default for both ingestion and querying
    modelEndpointNameForQuery String
    (string) - Name of the embedding model endpoint which, if specified, is used for querying (not ingestion)
    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

    GetAiSearchIndexDeltaSyncIndexSpecEmbeddingVectorColumn

    EmbeddingDimension int
    (integer) - Dimension of the embedding vector
    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
    EmbeddingDimension int
    (integer) - Dimension of the embedding vector
    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
    embedding_dimension number
    (integer) - Dimension of the embedding vector
    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
    embeddingDimension Integer
    (integer) - Dimension of the embedding vector
    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
    embeddingDimension number
    (integer) - Dimension of the embedding vector
    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
    embedding_dimension int
    (integer) - Dimension of the embedding vector
    name str
    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
    embeddingDimension Number
    (integer) - Dimension of the embedding vector
    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

    GetAiSearchIndexDirectAccessIndexSpec

    EmbeddingSourceColumns List<GetAiSearchIndexDirectAccessIndexSpecEmbeddingSourceColumn>
    (list of EmbeddingSourceColumn) - The columns that contain the embedding source
    EmbeddingVectorColumns List<GetAiSearchIndexDirectAccessIndexSpecEmbeddingVectorColumn>
    (list of EmbeddingVectorColumn) - The columns that contain the embedding vectors
    SchemaJson string
    (string) - The schema of the index in JSON format. Supported types are integer, long, float, double, boolean, string, date, timestamp. Supported types for vector columns: array<float>, array<double>
    EmbeddingSourceColumns []GetAiSearchIndexDirectAccessIndexSpecEmbeddingSourceColumn
    (list of EmbeddingSourceColumn) - The columns that contain the embedding source
    EmbeddingVectorColumns []GetAiSearchIndexDirectAccessIndexSpecEmbeddingVectorColumn
    (list of EmbeddingVectorColumn) - The columns that contain the embedding vectors
    SchemaJson string
    (string) - The schema of the index in JSON format. Supported types are integer, long, float, double, boolean, string, date, timestamp. Supported types for vector columns: array<float>, array<double>
    embedding_source_columns list(object)
    (list of EmbeddingSourceColumn) - The columns that contain the embedding source
    embedding_vector_columns list(object)
    (list of EmbeddingVectorColumn) - The columns that contain the embedding vectors
    schema_json string
    (string) - The schema of the index in JSON format. Supported types are integer, long, float, double, boolean, string, date, timestamp. Supported types for vector columns: array<float>, array<double>
    embeddingSourceColumns List<GetAiSearchIndexDirectAccessIndexSpecEmbeddingSourceColumn>
    (list of EmbeddingSourceColumn) - The columns that contain the embedding source
    embeddingVectorColumns List<GetAiSearchIndexDirectAccessIndexSpecEmbeddingVectorColumn>
    (list of EmbeddingVectorColumn) - The columns that contain the embedding vectors
    schemaJson String
    (string) - The schema of the index in JSON format. Supported types are integer, long, float, double, boolean, string, date, timestamp. Supported types for vector columns: array<float>, array<double>
    embeddingSourceColumns GetAiSearchIndexDirectAccessIndexSpecEmbeddingSourceColumn[]
    (list of EmbeddingSourceColumn) - The columns that contain the embedding source
    embeddingVectorColumns GetAiSearchIndexDirectAccessIndexSpecEmbeddingVectorColumn[]
    (list of EmbeddingVectorColumn) - The columns that contain the embedding vectors
    schemaJson string
    (string) - The schema of the index in JSON format. Supported types are integer, long, float, double, boolean, string, date, timestamp. Supported types for vector columns: array<float>, array<double>
    embedding_source_columns Sequence[GetAiSearchIndexDirectAccessIndexSpecEmbeddingSourceColumn]
    (list of EmbeddingSourceColumn) - The columns that contain the embedding source
    embedding_vector_columns Sequence[GetAiSearchIndexDirectAccessIndexSpecEmbeddingVectorColumn]
    (list of EmbeddingVectorColumn) - The columns that contain the embedding vectors
    schema_json str
    (string) - The schema of the index in JSON format. Supported types are integer, long, float, double, boolean, string, date, timestamp. Supported types for vector columns: array<float>, array<double>
    embeddingSourceColumns List<Property Map>
    (list of EmbeddingSourceColumn) - The columns that contain the embedding source
    embeddingVectorColumns List<Property Map>
    (list of EmbeddingVectorColumn) - The columns that contain the embedding vectors
    schemaJson String
    (string) - The schema of the index in JSON format. Supported types are integer, long, float, double, boolean, string, date, timestamp. Supported types for vector columns: array<float>, array<double>

    GetAiSearchIndexDirectAccessIndexSpecEmbeddingSourceColumn

    EmbeddingModelEndpoint string
    (string) - Name of the embedding model endpoint, used by default for both ingestion and querying
    ModelEndpointNameForQuery string
    (string) - Name of the embedding model endpoint which, if specified, is used for querying (not ingestion)
    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
    EmbeddingModelEndpoint string
    (string) - Name of the embedding model endpoint, used by default for both ingestion and querying
    ModelEndpointNameForQuery string
    (string) - Name of the embedding model endpoint which, if specified, is used for querying (not ingestion)
    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
    embedding_model_endpoint string
    (string) - Name of the embedding model endpoint, used by default for both ingestion and querying
    model_endpoint_name_for_query string
    (string) - Name of the embedding model endpoint which, if specified, is used for querying (not ingestion)
    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
    embeddingModelEndpoint String
    (string) - Name of the embedding model endpoint, used by default for both ingestion and querying
    modelEndpointNameForQuery String
    (string) - Name of the embedding model endpoint which, if specified, is used for querying (not ingestion)
    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
    embeddingModelEndpoint string
    (string) - Name of the embedding model endpoint, used by default for both ingestion and querying
    modelEndpointNameForQuery string
    (string) - Name of the embedding model endpoint which, if specified, is used for querying (not ingestion)
    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
    embedding_model_endpoint str
    (string) - Name of the embedding model endpoint, used by default for both ingestion and querying
    model_endpoint_name_for_query str
    (string) - Name of the embedding model endpoint which, if specified, is used for querying (not ingestion)
    name str
    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
    embeddingModelEndpoint String
    (string) - Name of the embedding model endpoint, used by default for both ingestion and querying
    modelEndpointNameForQuery String
    (string) - Name of the embedding model endpoint which, if specified, is used for querying (not ingestion)
    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

    GetAiSearchIndexDirectAccessIndexSpecEmbeddingVectorColumn

    EmbeddingDimension int
    (integer) - Dimension of the embedding vector
    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
    EmbeddingDimension int
    (integer) - Dimension of the embedding vector
    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
    embedding_dimension number
    (integer) - Dimension of the embedding vector
    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
    embeddingDimension Integer
    (integer) - Dimension of the embedding vector
    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
    embeddingDimension number
    (integer) - Dimension of the embedding vector
    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
    embedding_dimension int
    (integer) - Dimension of the embedding vector
    name str
    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
    embeddingDimension Number
    (integer) - Dimension of the embedding vector
    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

    GetAiSearchIndexProviderConfig

    WorkspaceId string
    Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.
    WorkspaceId string
    Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.
    workspace_id string
    Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.
    workspaceId String
    Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.
    workspaceId string
    Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.
    workspace_id str
    Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.
    workspaceId String
    Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.

    GetAiSearchIndexStatus

    IndexUrl string
    (string) - Index API URL used to perform operations on the index
    IndexedRowCount int
    (integer) - Number of rows indexed
    Message string
    (string) - Human-readable detail about the index's current state
    Ready bool
    (boolean) - Whether the index is ready for search
    IndexUrl string
    (string) - Index API URL used to perform operations on the index
    IndexedRowCount int
    (integer) - Number of rows indexed
    Message string
    (string) - Human-readable detail about the index's current state
    Ready bool
    (boolean) - Whether the index is ready for search
    index_url string
    (string) - Index API URL used to perform operations on the index
    indexed_row_count number
    (integer) - Number of rows indexed
    message string
    (string) - Human-readable detail about the index's current state
    ready bool
    (boolean) - Whether the index is ready for search
    indexUrl String
    (string) - Index API URL used to perform operations on the index
    indexedRowCount Integer
    (integer) - Number of rows indexed
    message String
    (string) - Human-readable detail about the index's current state
    ready Boolean
    (boolean) - Whether the index is ready for search
    indexUrl string
    (string) - Index API URL used to perform operations on the index
    indexedRowCount number
    (integer) - Number of rows indexed
    message string
    (string) - Human-readable detail about the index's current state
    ready boolean
    (boolean) - Whether the index is ready for search
    index_url str
    (string) - Index API URL used to perform operations on the index
    indexed_row_count int
    (integer) - Number of rows indexed
    message str
    (string) - Human-readable detail about the index's current state
    ready bool
    (boolean) - Whether the index is ready for search
    indexUrl String
    (string) - Index API URL used to perform operations on the index
    indexedRowCount Number
    (integer) - Number of rows indexed
    message String
    (string) - Human-readable detail about the index's current state
    ready Boolean
    (boolean) - Whether the index is ready for search

    Package Details

    Repository
    databricks pulumi/pulumi-databricks
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the databricks Terraform Provider.
    databricks logo
    Viewing docs for Databricks v1.96.0
    published on Thursday, Jun 18, 2026 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial