Sign in Dashboard Get started
  1. Packages
  2. Packages
  3. Databricks Provider
  4. API Docs
  5. AiSearchIndex
Viewing docs for Databricks v1.97.0
published on Thursday, Jun 25, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-databricks

databricks.AiSearchIndex

databricks logo
Viewing docs for Databricks v1.97.0
published on Thursday, Jun 25, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-databricks

    Private Preview

    Create AiSearchIndex Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new AiSearchIndex(name: string, args: AiSearchIndexArgs, opts?: CustomResourceOptions);
    @overload
def AiSearchIndex(resource_name: str,
                  args: AiSearchIndexArgs,
                  opts: Optional[ResourceOptions] = None)

@overload
def AiSearchIndex(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  index_type: Optional[str] = None,
                  parent: Optional[str] = None,
                  primary_key: Optional[str] = None,
                  delta_sync_index_spec: Optional[AiSearchIndexDeltaSyncIndexSpecArgs] = None,
                  direct_access_index_spec: Optional[AiSearchIndexDirectAccessIndexSpecArgs] = None,
                  index_id: Optional[str] = None,
                  index_subtype: Optional[str] = None,
                  provider_config: Optional[AiSearchIndexProviderConfigArgs] = None)
    func NewAiSearchIndex(ctx *Context, name string, args AiSearchIndexArgs, opts ...ResourceOption) (*AiSearchIndex, error)
    public AiSearchIndex(string name, AiSearchIndexArgs args, CustomResourceOptions? opts = null)
    public AiSearchIndex(String name, AiSearchIndexArgs args)
public AiSearchIndex(String name, AiSearchIndexArgs args, CustomResourceOptions options)

    type: databricks:AiSearchIndex
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "databricks_aisearchindex" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args AiSearchIndexArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args AiSearchIndexArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args AiSearchIndexArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AiSearchIndexArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AiSearchIndexArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var aiSearchIndexResource = new Databricks.AiSearchIndex("aiSearchIndexResource", new()
{
    IndexType = "string",
    Parent = "string",
    PrimaryKey = "string",
    DeltaSyncIndexSpec = new Databricks.Inputs.AiSearchIndexDeltaSyncIndexSpecArgs
    {
        PipelineType = "string",
        ColumnsToSyncs = new[]
        {
            "string",
        },
        EmbeddingSourceColumns = new[]
        {
            new Databricks.Inputs.AiSearchIndexDeltaSyncIndexSpecEmbeddingSourceColumnArgs
            {
                EmbeddingModelEndpoint = "string",
                ModelEndpointNameForQuery = "string",
                Name = "string",
            },
        },
        EmbeddingVectorColumns = new[]
        {
            new Databricks.Inputs.AiSearchIndexDeltaSyncIndexSpecEmbeddingVectorColumnArgs
            {
                EmbeddingDimension = 0,
                Name = "string",
            },
        },
        EmbeddingWritebackTable = "string",
        PipelineId = "string",
        SourceTable = "string",
    },
    DirectAccessIndexSpec = new Databricks.Inputs.AiSearchIndexDirectAccessIndexSpecArgs
    {
        EmbeddingSourceColumns = new[]
        {
            new Databricks.Inputs.AiSearchIndexDirectAccessIndexSpecEmbeddingSourceColumnArgs
            {
                EmbeddingModelEndpoint = "string",
                ModelEndpointNameForQuery = "string",
                Name = "string",
            },
        },
        EmbeddingVectorColumns = new[]
        {
            new Databricks.Inputs.AiSearchIndexDirectAccessIndexSpecEmbeddingVectorColumnArgs
            {
                EmbeddingDimension = 0,
                Name = "string",
            },
        },
        SchemaJson = "string",
    },
    IndexId = "string",
    IndexSubtype = "string",
    ProviderConfig = new Databricks.Inputs.AiSearchIndexProviderConfigArgs
    {
        WorkspaceId = "string",
    },
});

    example, err := databricks.NewAiSearchIndex(ctx, "aiSearchIndexResource", &databricks.AiSearchIndexArgs{
	IndexType:  pulumi.String("string"),
	Parent:     pulumi.String("string"),
	PrimaryKey: pulumi.String("string"),
	DeltaSyncIndexSpec: &databricks.AiSearchIndexDeltaSyncIndexSpecArgs{
		PipelineType: pulumi.String("string"),
		ColumnsToSyncs: pulumi.StringArray{
			pulumi.String("string"),
		},
		EmbeddingSourceColumns: databricks.AiSearchIndexDeltaSyncIndexSpecEmbeddingSourceColumnArray{
			&databricks.AiSearchIndexDeltaSyncIndexSpecEmbeddingSourceColumnArgs{
				EmbeddingModelEndpoint:    pulumi.String("string"),
				ModelEndpointNameForQuery: pulumi.String("string"),
				Name:                      pulumi.String("string"),
			},
		},
		EmbeddingVectorColumns: databricks.AiSearchIndexDeltaSyncIndexSpecEmbeddingVectorColumnArray{
			&databricks.AiSearchIndexDeltaSyncIndexSpecEmbeddingVectorColumnArgs{
				EmbeddingDimension: pulumi.Int(0),
				Name:               pulumi.String("string"),
			},
		},
		EmbeddingWritebackTable: pulumi.String("string"),
		PipelineId:              pulumi.String("string"),
		SourceTable:             pulumi.String("string"),
	},
	DirectAccessIndexSpec: &databricks.AiSearchIndexDirectAccessIndexSpecArgs{
		EmbeddingSourceColumns: databricks.AiSearchIndexDirectAccessIndexSpecEmbeddingSourceColumnArray{
			&databricks.AiSearchIndexDirectAccessIndexSpecEmbeddingSourceColumnArgs{
				EmbeddingModelEndpoint:    pulumi.String("string"),
				ModelEndpointNameForQuery: pulumi.String("string"),
				Name:                      pulumi.String("string"),
			},
		},
		EmbeddingVectorColumns: databricks.AiSearchIndexDirectAccessIndexSpecEmbeddingVectorColumnArray{
			&databricks.AiSearchIndexDirectAccessIndexSpecEmbeddingVectorColumnArgs{
				EmbeddingDimension: pulumi.Int(0),
				Name:               pulumi.String("string"),
			},
		},
		SchemaJson: pulumi.String("string"),
	},
	IndexId:      pulumi.String("string"),
	IndexSubtype: pulumi.String("string"),
	ProviderConfig: &databricks.AiSearchIndexProviderConfigArgs{
		WorkspaceId: pulumi.String("string"),
	},
})

    resource "databricks_aisearchindex" "aiSearchIndexResource" {
  index_type  = "string"
  parent      = "string"
  primary_key = "string"
  delta_sync_index_spec = {
    pipeline_type    = "string"
    columns_to_syncs = ["string"]
    embedding_source_columns = [{
      "embeddingModelEndpoint"    = "string"
      "modelEndpointNameForQuery" = "string"
      "name"                      = "string"
    }]
    embedding_vector_columns = [{
      "embeddingDimension" = 0
      "name"               = "string"
    }]
    embedding_writeback_table = "string"
    pipeline_id               = "string"
    source_table              = "string"
  }
  direct_access_index_spec = {
    embedding_source_columns = [{
      "embeddingModelEndpoint"    = "string"
      "modelEndpointNameForQuery" = "string"
      "name"                      = "string"
    }]
    embedding_vector_columns = [{
      "embeddingDimension" = 0
      "name"               = "string"
    }]
    schema_json = "string"
  }
  index_id      = "string"
  index_subtype = "string"
  provider_config = {
    workspace_id = "string"
  }
}

    var aiSearchIndexResource = new AiSearchIndex("aiSearchIndexResource", AiSearchIndexArgs.builder()
    .indexType("string")
    .parent("string")
    .primaryKey("string")
    .deltaSyncIndexSpec(AiSearchIndexDeltaSyncIndexSpecArgs.builder()
        .pipelineType("string")
        .columnsToSyncs("string")
        .embeddingSourceColumns(AiSearchIndexDeltaSyncIndexSpecEmbeddingSourceColumnArgs.builder()
            .embeddingModelEndpoint("string")
            .modelEndpointNameForQuery("string")
            .name("string")
            .build())
        .embeddingVectorColumns(AiSearchIndexDeltaSyncIndexSpecEmbeddingVectorColumnArgs.builder()
            .embeddingDimension(0)
            .name("string")
            .build())
        .embeddingWritebackTable("string")
        .pipelineId("string")
        .sourceTable("string")
        .build())
    .directAccessIndexSpec(AiSearchIndexDirectAccessIndexSpecArgs.builder()
        .embeddingSourceColumns(AiSearchIndexDirectAccessIndexSpecEmbeddingSourceColumnArgs.builder()
            .embeddingModelEndpoint("string")
            .modelEndpointNameForQuery("string")
            .name("string")
            .build())
        .embeddingVectorColumns(AiSearchIndexDirectAccessIndexSpecEmbeddingVectorColumnArgs.builder()
            .embeddingDimension(0)
            .name("string")
            .build())
        .schemaJson("string")
        .build())
    .indexId("string")
    .indexSubtype("string")
    .providerConfig(AiSearchIndexProviderConfigArgs.builder()
        .workspaceId("string")
        .build())
    .build());

    ai_search_index_resource = databricks.AiSearchIndex("aiSearchIndexResource",
    index_type="string",
    parent="string",
    primary_key="string",
    delta_sync_index_spec={
        "pipeline_type": "string",
        "columns_to_syncs": ["string"],
        "embedding_source_columns": [{
            "embedding_model_endpoint": "string",
            "model_endpoint_name_for_query": "string",
            "name": "string",
        }],
        "embedding_vector_columns": [{
            "embedding_dimension": 0,
            "name": "string",
        }],
        "embedding_writeback_table": "string",
        "pipeline_id": "string",
        "source_table": "string",
    },
    direct_access_index_spec={
        "embedding_source_columns": [{
            "embedding_model_endpoint": "string",
            "model_endpoint_name_for_query": "string",
            "name": "string",
        }],
        "embedding_vector_columns": [{
            "embedding_dimension": 0,
            "name": "string",
        }],
        "schema_json": "string",
    },
    index_id="string",
    index_subtype="string",
    provider_config={
        "workspace_id": "string",
    })

    const aiSearchIndexResource = new databricks.AiSearchIndex("aiSearchIndexResource", {
    indexType: "string",
    parent: "string",
    primaryKey: "string",
    deltaSyncIndexSpec: {
        pipelineType: "string",
        columnsToSyncs: ["string"],
        embeddingSourceColumns: [{
            embeddingModelEndpoint: "string",
            modelEndpointNameForQuery: "string",
            name: "string",
        }],
        embeddingVectorColumns: [{
            embeddingDimension: 0,
            name: "string",
        }],
        embeddingWritebackTable: "string",
        pipelineId: "string",
        sourceTable: "string",
    },
    directAccessIndexSpec: {
        embeddingSourceColumns: [{
            embeddingModelEndpoint: "string",
            modelEndpointNameForQuery: "string",
            name: "string",
        }],
        embeddingVectorColumns: [{
            embeddingDimension: 0,
            name: "string",
        }],
        schemaJson: "string",
    },
    indexId: "string",
    indexSubtype: "string",
    providerConfig: {
        workspaceId: "string",
    },
});

    type: databricks:AiSearchIndex
properties:
    deltaSyncIndexSpec:
        columnsToSyncs:
            - string
        embeddingSourceColumns:
            - embeddingModelEndpoint: string
              modelEndpointNameForQuery: string
              name: string
        embeddingVectorColumns:
            - embeddingDimension: 0
              name: string
        embeddingWritebackTable: string
        pipelineId: string
        pipelineType: string
        sourceTable: string
    directAccessIndexSpec:
        embeddingSourceColumns:
            - embeddingModelEndpoint: string
              modelEndpointNameForQuery: string
              name: string
        embeddingVectorColumns:
            - embeddingDimension: 0
              name: string
        schemaJson: string
    indexId: string
    indexSubtype: string
    indexType: string
    parent: string
    primaryKey: string
    providerConfig:
        workspaceId: string

    AiSearchIndex Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The AiSearchIndex resource accepts the following input properties:

    IndexType string
    Type of index. Required on create and immutable thereafter. Possible values are: DELTA_SYNC, DIRECT_ACCESS
    Parent string
    The Endpoint where this Index will be created. Format: workspaces/{workspace_id}/endpoints/{endpoint_id}
    PrimaryKey string
    Primary key of the index. Set on create and immutable thereafter
    DeltaSyncIndexSpec AiSearchIndexDeltaSyncIndexSpec
    Specification for a Delta Sync index. Set when indexType is DELTA_SYNC
    DirectAccessIndexSpec AiSearchIndexDirectAccessIndexSpec
    Specification for a Direct Access index. Set when indexType is DIRECT_ACCESS
    IndexId string
    The user-supplied Unity Catalog table name for the Index, per AIP-133. The server composes the full Index.name as {parent}/indexes/{index_id}. AIP-133 does not list indexId as a fields-may-be-required entry, so we annotate it OPTIONAL on the wire; the server still rejects empty values with INVALID_PARAMETER_VALUE
    IndexSubtype string
    The subtype of the index. Set on create and immutable thereafter. Possible values are: FULL_TEXT, HYBRID, VECTOR
    ProviderConfig AiSearchIndexProviderConfig
    Configure the provider for management through account provider.
    IndexType string
    Type of index. Required on create and immutable thereafter. Possible values are: DELTA_SYNC, DIRECT_ACCESS
    Parent string
    The Endpoint where this Index will be created. Format: workspaces/{workspace_id}/endpoints/{endpoint_id}
    PrimaryKey string
    Primary key of the index. Set on create and immutable thereafter
    DeltaSyncIndexSpec AiSearchIndexDeltaSyncIndexSpecArgs
    Specification for a Delta Sync index. Set when indexType is DELTA_SYNC
    DirectAccessIndexSpec AiSearchIndexDirectAccessIndexSpecArgs
    Specification for a Direct Access index. Set when indexType is DIRECT_ACCESS
    IndexId string
    The user-supplied Unity Catalog table name for the Index, per AIP-133. The server composes the full Index.name as {parent}/indexes/{index_id}. AIP-133 does not list indexId as a fields-may-be-required entry, so we annotate it OPTIONAL on the wire; the server still rejects empty values with INVALID_PARAMETER_VALUE
    IndexSubtype string
    The subtype of the index. Set on create and immutable thereafter. Possible values are: FULL_TEXT, HYBRID, VECTOR
    ProviderConfig AiSearchIndexProviderConfigArgs
    Configure the provider for management through account provider.
    index_type string
    Type of index. Required on create and immutable thereafter. Possible values are: DELTA_SYNC, DIRECT_ACCESS
    parent string
    The Endpoint where this Index will be created. Format: workspaces/{workspace_id}/endpoints/{endpoint_id}
    primary_key string
    Primary key of the index. Set on create and immutable thereafter
    delta_sync_index_spec object
    Specification for a Delta Sync index. Set when indexType is DELTA_SYNC
    direct_access_index_spec object
    Specification for a Direct Access index. Set when indexType is DIRECT_ACCESS
    index_id string
    The user-supplied Unity Catalog table name for the Index, per AIP-133. The server composes the full Index.name as {parent}/indexes/{index_id}. AIP-133 does not list indexId as a fields-may-be-required entry, so we annotate it OPTIONAL on the wire; the server still rejects empty values with INVALID_PARAMETER_VALUE
    index_subtype string
    The subtype of the index. Set on create and immutable thereafter. Possible values are: FULL_TEXT, HYBRID, VECTOR
    provider_config object
    Configure the provider for management through account provider.
    indexType String
    Type of index. Required on create and immutable thereafter. Possible values are: DELTA_SYNC, DIRECT_ACCESS
    parent String
    The Endpoint where this Index will be created. Format: workspaces/{workspace_id}/endpoints/{endpoint_id}
    primaryKey String
    Primary key of the index. Set on create and immutable thereafter
    deltaSyncIndexSpec AiSearchIndexDeltaSyncIndexSpec
    Specification for a Delta Sync index. Set when indexType is DELTA_SYNC
    directAccessIndexSpec AiSearchIndexDirectAccessIndexSpec
    Specification for a Direct Access index. Set when indexType is DIRECT_ACCESS
    indexId String
    The user-supplied Unity Catalog table name for the Index, per AIP-133. The server composes the full Index.name as {parent}/indexes/{index_id}. AIP-133 does not list indexId as a fields-may-be-required entry, so we annotate it OPTIONAL on the wire; the server still rejects empty values with INVALID_PARAMETER_VALUE
    indexSubtype String
    The subtype of the index. Set on create and immutable thereafter. Possible values are: FULL_TEXT, HYBRID, VECTOR
    providerConfig AiSearchIndexProviderConfig
    Configure the provider for management through account provider.
    indexType string
    Type of index. Required on create and immutable thereafter. Possible values are: DELTA_SYNC, DIRECT_ACCESS
    parent string
    The Endpoint where this Index will be created. Format: workspaces/{workspace_id}/endpoints/{endpoint_id}
    primaryKey string
    Primary key of the index. Set on create and immutable thereafter
    deltaSyncIndexSpec AiSearchIndexDeltaSyncIndexSpec
    Specification for a Delta Sync index. Set when indexType is DELTA_SYNC
    directAccessIndexSpec AiSearchIndexDirectAccessIndexSpec
    Specification for a Direct Access index. Set when indexType is DIRECT_ACCESS
    indexId string
    The user-supplied Unity Catalog table name for the Index, per AIP-133. The server composes the full Index.name as {parent}/indexes/{index_id}. AIP-133 does not list indexId as a fields-may-be-required entry, so we annotate it OPTIONAL on the wire; the server still rejects empty values with INVALID_PARAMETER_VALUE
    indexSubtype string
    The subtype of the index. Set on create and immutable thereafter. Possible values are: FULL_TEXT, HYBRID, VECTOR
    providerConfig AiSearchIndexProviderConfig
    Configure the provider for management through account provider.
    index_type str
    Type of index. Required on create and immutable thereafter. Possible values are: DELTA_SYNC, DIRECT_ACCESS
    parent str
    The Endpoint where this Index will be created. Format: workspaces/{workspace_id}/endpoints/{endpoint_id}
    primary_key str
    Primary key of the index. Set on create and immutable thereafter
    delta_sync_index_spec AiSearchIndexDeltaSyncIndexSpecArgs
    Specification for a Delta Sync index. Set when indexType is DELTA_SYNC
    direct_access_index_spec AiSearchIndexDirectAccessIndexSpecArgs
    Specification for a Direct Access index. Set when indexType is DIRECT_ACCESS
    index_id str
    The user-supplied Unity Catalog table name for the Index, per AIP-133. The server composes the full Index.name as {parent}/indexes/{index_id}. AIP-133 does not list indexId as a fields-may-be-required entry, so we annotate it OPTIONAL on the wire; the server still rejects empty values with INVALID_PARAMETER_VALUE
    index_subtype str
    The subtype of the index. Set on create and immutable thereafter. Possible values are: FULL_TEXT, HYBRID, VECTOR
    provider_config AiSearchIndexProviderConfigArgs
    Configure the provider for management through account provider.
    indexType String
    Type of index. Required on create and immutable thereafter. Possible values are: DELTA_SYNC, DIRECT_ACCESS
    parent String
    The Endpoint where this Index will be created. Format: workspaces/{workspace_id}/endpoints/{endpoint_id}
    primaryKey String
    Primary key of the index. Set on create and immutable thereafter
    deltaSyncIndexSpec Property Map
    Specification for a Delta Sync index. Set when indexType is DELTA_SYNC
    directAccessIndexSpec Property Map
    Specification for a Direct Access index. Set when indexType is DIRECT_ACCESS
    indexId String
    The user-supplied Unity Catalog table name for the Index, per AIP-133. The server composes the full Index.name as {parent}/indexes/{index_id}. AIP-133 does not list indexId as a fields-may-be-required entry, so we annotate it OPTIONAL on the wire; the server still rejects empty values with INVALID_PARAMETER_VALUE
    indexSubtype String
    The subtype of the index. Set on create and immutable thereafter. Possible values are: FULL_TEXT, HYBRID, VECTOR
    providerConfig Property Map
    Configure the provider for management through account provider.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the AiSearchIndex resource produces the following output properties:

    Creator string
    (string) - Creator of the index
    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.
    Name string
    (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
    Status AiSearchIndexStatus
    (IndexStatus) - Current status of the index
    Creator string
    (string) - Creator of the index
    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.
    Name string
    (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
    Status AiSearchIndexStatus
    (IndexStatus) - Current status of the index
    creator string
    (string) - Creator of the index
    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.
    name string
    (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
    status object
    (IndexStatus) - Current status of the index
    creator String
    (string) - Creator of the index
    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.
    name String
    (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
    status AiSearchIndexStatus
    (IndexStatus) - Current status of the index
    creator string
    (string) - Creator of the index
    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.
    name string
    (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
    status AiSearchIndexStatus
    (IndexStatus) - Current status of the index
    creator str
    (string) - Creator of the index
    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.
    name str
    (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
    status AiSearchIndexStatus
    (IndexStatus) - Current status of the index
    creator String
    (string) - Creator of the index
    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.
    name String
    (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
    status Property Map
    (IndexStatus) - Current status of the index

    Look up Existing AiSearchIndex Resource

    Get an existing AiSearchIndex resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: AiSearchIndexState, opts?: CustomResourceOptions): AiSearchIndex
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        creator: Optional[str] = None,
        delta_sync_index_spec: Optional[AiSearchIndexDeltaSyncIndexSpecArgs] = None,
        direct_access_index_spec: Optional[AiSearchIndexDirectAccessIndexSpecArgs] = None,
        endpoint: Optional[str] = None,
        index_id: Optional[str] = None,
        index_subtype: Optional[str] = None,
        index_type: Optional[str] = None,
        name: Optional[str] = None,
        parent: Optional[str] = None,
        primary_key: Optional[str] = None,
        provider_config: Optional[AiSearchIndexProviderConfigArgs] = None,
        status: Optional[AiSearchIndexStatusArgs] = None) -> AiSearchIndex
    func GetAiSearchIndex(ctx *Context, name string, id IDInput, state *AiSearchIndexState, opts ...ResourceOption) (*AiSearchIndex, error)
    public static AiSearchIndex Get(string name, Input<string> id, AiSearchIndexState? state, CustomResourceOptions? opts = null)
    public static AiSearchIndex get(String name, Output<String> id, AiSearchIndexState state, CustomResourceOptions options)
    resources:  _:    type: databricks:AiSearchIndex    get:      id: ${id}
    import {
  to = databricks_aisearchindex.example
  id = "${id}"
}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Creator string
    (string) - Creator of the index
    DeltaSyncIndexSpec AiSearchIndexDeltaSyncIndexSpec
    Specification for a Delta Sync index. Set when indexType is DELTA_SYNC
    DirectAccessIndexSpec AiSearchIndexDirectAccessIndexSpec
    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
    IndexId string
    The user-supplied Unity Catalog table name for the Index, per AIP-133. The server composes the full Index.name as {parent}/indexes/{index_id}. AIP-133 does not list indexId as a fields-may-be-required entry, so we annotate it OPTIONAL on the wire; the server still rejects empty values with INVALID_PARAMETER_VALUE
    IndexSubtype string
    The subtype of the index. Set on create and immutable thereafter. Possible values are: FULL_TEXT, HYBRID, VECTOR
    IndexType string
    Type of index. Required on create and immutable thereafter. Possible values are: DELTA_SYNC, DIRECT_ACCESS
    Name string
    (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
    Parent string
    The Endpoint where this Index will be created. Format: workspaces/{workspace_id}/endpoints/{endpoint_id}
    PrimaryKey string
    Primary key of the index. Set on create and immutable thereafter
    ProviderConfig AiSearchIndexProviderConfig
    Configure the provider for management through account provider.
    Status AiSearchIndexStatus
    (IndexStatus) - Current status of the index
    Creator string
    (string) - Creator of the index
    DeltaSyncIndexSpec AiSearchIndexDeltaSyncIndexSpecArgs
    Specification for a Delta Sync index. Set when indexType is DELTA_SYNC
    DirectAccessIndexSpec AiSearchIndexDirectAccessIndexSpecArgs
    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
    IndexId string
    The user-supplied Unity Catalog table name for the Index, per AIP-133. The server composes the full Index.name as {parent}/indexes/{index_id}. AIP-133 does not list indexId as a fields-may-be-required entry, so we annotate it OPTIONAL on the wire; the server still rejects empty values with INVALID_PARAMETER_VALUE
    IndexSubtype string
    The subtype of the index. Set on create and immutable thereafter. Possible values are: FULL_TEXT, HYBRID, VECTOR
    IndexType string
    Type of index. Required on create and immutable thereafter. Possible values are: DELTA_SYNC, DIRECT_ACCESS
    Name string
    (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
    Parent string
    The Endpoint where this Index will be created. Format: workspaces/{workspace_id}/endpoints/{endpoint_id}
    PrimaryKey string
    Primary key of the index. Set on create and immutable thereafter
    ProviderConfig AiSearchIndexProviderConfigArgs
    Configure the provider for management through account provider.
    Status AiSearchIndexStatusArgs
    (IndexStatus) - Current status of the index
    creator string
    (string) - Creator of the index
    delta_sync_index_spec object
    Specification for a Delta Sync index. Set when indexType is DELTA_SYNC
    direct_access_index_spec object
    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
    index_id string
    The user-supplied Unity Catalog table name for the Index, per AIP-133. The server composes the full Index.name as {parent}/indexes/{index_id}. AIP-133 does not list indexId as a fields-may-be-required entry, so we annotate it OPTIONAL on the wire; the server still rejects empty values with INVALID_PARAMETER_VALUE
    index_subtype string
    The subtype of the index. Set on create and immutable thereafter. Possible values are: FULL_TEXT, HYBRID, VECTOR
    index_type string
    Type of index. Required on create and immutable thereafter. Possible values are: DELTA_SYNC, DIRECT_ACCESS
    name string
    (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
    parent string
    The Endpoint where this Index will be created. Format: workspaces/{workspace_id}/endpoints/{endpoint_id}
    primary_key string
    Primary key of the index. Set on create and immutable thereafter
    provider_config object
    Configure the provider for management through account provider.
    status object
    (IndexStatus) - Current status of the index
    creator String
    (string) - Creator of the index
    deltaSyncIndexSpec AiSearchIndexDeltaSyncIndexSpec
    Specification for a Delta Sync index. Set when indexType is DELTA_SYNC
    directAccessIndexSpec AiSearchIndexDirectAccessIndexSpec
    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
    indexId String
    The user-supplied Unity Catalog table name for the Index, per AIP-133. The server composes the full Index.name as {parent}/indexes/{index_id}. AIP-133 does not list indexId as a fields-may-be-required entry, so we annotate it OPTIONAL on the wire; the server still rejects empty values with INVALID_PARAMETER_VALUE
    indexSubtype String
    The subtype of the index. Set on create and immutable thereafter. Possible values are: FULL_TEXT, HYBRID, VECTOR
    indexType String
    Type of index. Required on create and immutable thereafter. Possible values are: DELTA_SYNC, DIRECT_ACCESS
    name String
    (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
    parent String
    The Endpoint where this Index will be created. Format: workspaces/{workspace_id}/endpoints/{endpoint_id}
    primaryKey String
    Primary key of the index. Set on create and immutable thereafter
    providerConfig AiSearchIndexProviderConfig
    Configure the provider for management through account provider.
    status AiSearchIndexStatus
    (IndexStatus) - Current status of the index
    creator string
    (string) - Creator of the index
    deltaSyncIndexSpec AiSearchIndexDeltaSyncIndexSpec
    Specification for a Delta Sync index. Set when indexType is DELTA_SYNC
    directAccessIndexSpec AiSearchIndexDirectAccessIndexSpec
    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
    indexId string
    The user-supplied Unity Catalog table name for the Index, per AIP-133. The server composes the full Index.name as {parent}/indexes/{index_id}. AIP-133 does not list indexId as a fields-may-be-required entry, so we annotate it OPTIONAL on the wire; the server still rejects empty values with INVALID_PARAMETER_VALUE
    indexSubtype string
    The subtype of the index. Set on create and immutable thereafter. Possible values are: FULL_TEXT, HYBRID, VECTOR
    indexType string
    Type of index. Required on create and immutable thereafter. Possible values are: DELTA_SYNC, DIRECT_ACCESS
    name string
    (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
    parent string
    The Endpoint where this Index will be created. Format: workspaces/{workspace_id}/endpoints/{endpoint_id}
    primaryKey string
    Primary key of the index. Set on create and immutable thereafter
    providerConfig AiSearchIndexProviderConfig
    Configure the provider for management through account provider.
    status AiSearchIndexStatus
    (IndexStatus) - Current status of the index
    creator str
    (string) - Creator of the index
    delta_sync_index_spec AiSearchIndexDeltaSyncIndexSpecArgs
    Specification for a Delta Sync index. Set when indexType is DELTA_SYNC
    direct_access_index_spec AiSearchIndexDirectAccessIndexSpecArgs
    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
    index_id str
    The user-supplied Unity Catalog table name for the Index, per AIP-133. The server composes the full Index.name as {parent}/indexes/{index_id}. AIP-133 does not list indexId as a fields-may-be-required entry, so we annotate it OPTIONAL on the wire; the server still rejects empty values with INVALID_PARAMETER_VALUE
    index_subtype str
    The subtype of the index. Set on create and immutable thereafter. Possible values are: FULL_TEXT, HYBRID, VECTOR
    index_type str
    Type of index. Required on create and immutable thereafter. Possible values are: DELTA_SYNC, DIRECT_ACCESS
    name str
    (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
    parent str
    The Endpoint where this Index will be created. Format: workspaces/{workspace_id}/endpoints/{endpoint_id}
    primary_key str
    Primary key of the index. Set on create and immutable thereafter
    provider_config AiSearchIndexProviderConfigArgs
    Configure the provider for management through account provider.
    status AiSearchIndexStatusArgs
    (IndexStatus) - Current status of the index
    creator String
    (string) - Creator of the index
    deltaSyncIndexSpec Property Map
    Specification for a Delta Sync index. Set when indexType is DELTA_SYNC
    directAccessIndexSpec Property Map
    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
    indexId String
    The user-supplied Unity Catalog table name for the Index, per AIP-133. The server composes the full Index.name as {parent}/indexes/{index_id}. AIP-133 does not list indexId as a fields-may-be-required entry, so we annotate it OPTIONAL on the wire; the server still rejects empty values with INVALID_PARAMETER_VALUE
    indexSubtype String
    The subtype of the index. Set on create and immutable thereafter. Possible values are: FULL_TEXT, HYBRID, VECTOR
    indexType String
    Type of index. Required on create and immutable thereafter. Possible values are: DELTA_SYNC, DIRECT_ACCESS
    name String
    (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
    parent String
    The Endpoint where this Index will be created. Format: workspaces/{workspace_id}/endpoints/{endpoint_id}
    primaryKey String
    Primary key of the index. Set on create and immutable thereafter
    providerConfig Property Map
    Configure the provider for management through account provider.
    status Property Map
    (IndexStatus) - Current status of the index

    Supporting Types

    AiSearchIndexDeltaSyncIndexSpec, AiSearchIndexDeltaSyncIndexSpecArgs

    PipelineType 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>
    [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<AiSearchIndexDeltaSyncIndexSpecEmbeddingSourceColumn>
    EmbeddingVectorColumns List<AiSearchIndexDeltaSyncIndexSpecEmbeddingVectorColumn>
    EmbeddingWritebackTable string
    [Optional] Name of the Delta table to sync the index contents and computed embeddings to
    PipelineId string
    (string) - The ID of the pipeline that is used to sync the index
    SourceTable string
    The full name of the source Delta table
    PipelineType 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
    [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 []AiSearchIndexDeltaSyncIndexSpecEmbeddingSourceColumn
    EmbeddingVectorColumns []AiSearchIndexDeltaSyncIndexSpecEmbeddingVectorColumn
    EmbeddingWritebackTable string
    [Optional] Name of the Delta table to sync the index contents and computed embeddings to
    PipelineId string
    (string) - The ID of the pipeline that is used to sync the index
    SourceTable string
    The full name of the source Delta table
    pipeline_type 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)
    [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)
    embedding_vector_columns list(object)
    embedding_writeback_table string
    [Optional] Name of the Delta table to sync the index contents and computed embeddings to
    pipeline_id string
    (string) - The ID of the pipeline that is used to sync the index
    source_table string
    The full name of the source Delta table
    pipelineType 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>
    [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<AiSearchIndexDeltaSyncIndexSpecEmbeddingSourceColumn>
    embeddingVectorColumns List<AiSearchIndexDeltaSyncIndexSpecEmbeddingVectorColumn>
    embeddingWritebackTable String
    [Optional] Name of the Delta table to sync the index contents and computed embeddings to
    pipelineId String
    (string) - The ID of the pipeline that is used to sync the index
    sourceTable String
    The full name of the source Delta table
    pipelineType 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[]
    [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 AiSearchIndexDeltaSyncIndexSpecEmbeddingSourceColumn[]
    embeddingVectorColumns AiSearchIndexDeltaSyncIndexSpecEmbeddingVectorColumn[]
    embeddingWritebackTable string
    [Optional] Name of the Delta table to sync the index contents and computed embeddings to
    pipelineId string
    (string) - The ID of the pipeline that is used to sync the index
    sourceTable string
    The full name of the source Delta table
    pipeline_type str
    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]
    [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[AiSearchIndexDeltaSyncIndexSpecEmbeddingSourceColumn]
    embedding_vector_columns Sequence[AiSearchIndexDeltaSyncIndexSpecEmbeddingVectorColumn]
    embedding_writeback_table str
    [Optional] Name of the Delta table to sync the index contents and computed embeddings to
    pipeline_id str
    (string) - The ID of the pipeline that is used to sync the index
    source_table str
    The full name of the source Delta table
    pipelineType 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>
    [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>
    embeddingVectorColumns List<Property Map>
    embeddingWritebackTable String
    [Optional] Name of the Delta table to sync the index contents and computed embeddings to
    pipelineId String
    (string) - The ID of the pipeline that is used to sync the index
    sourceTable String
    The full name of the source Delta table

    AiSearchIndexDeltaSyncIndexSpecEmbeddingSourceColumn, AiSearchIndexDeltaSyncIndexSpecEmbeddingSourceColumnArgs

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

    AiSearchIndexDeltaSyncIndexSpecEmbeddingVectorColumn, AiSearchIndexDeltaSyncIndexSpecEmbeddingVectorColumnArgs

    EmbeddingDimension int
    Dimension of the embedding vector
    Name string
    (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
    Dimension of the embedding vector
    Name string
    (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
    Dimension of the embedding vector
    name string
    (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
    Dimension of the embedding vector
    name String
    (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
    Dimension of the embedding vector
    name string
    (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
    Dimension of the embedding vector
    name str
    (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
    Dimension of the embedding vector
    name String
    (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

    AiSearchIndexDirectAccessIndexSpec, AiSearchIndexDirectAccessIndexSpecArgs

    EmbeddingSourceColumns List<AiSearchIndexDirectAccessIndexSpecEmbeddingSourceColumn>
    EmbeddingVectorColumns List<AiSearchIndexDirectAccessIndexSpecEmbeddingVectorColumn>
    SchemaJson 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 []AiSearchIndexDirectAccessIndexSpecEmbeddingSourceColumn
    EmbeddingVectorColumns []AiSearchIndexDirectAccessIndexSpecEmbeddingVectorColumn
    SchemaJson 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)
    embedding_vector_columns list(object)
    schema_json 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<AiSearchIndexDirectAccessIndexSpecEmbeddingSourceColumn>
    embeddingVectorColumns List<AiSearchIndexDirectAccessIndexSpecEmbeddingVectorColumn>
    schemaJson 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 AiSearchIndexDirectAccessIndexSpecEmbeddingSourceColumn[]
    embeddingVectorColumns AiSearchIndexDirectAccessIndexSpecEmbeddingVectorColumn[]
    schemaJson 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[AiSearchIndexDirectAccessIndexSpecEmbeddingSourceColumn]
    embedding_vector_columns Sequence[AiSearchIndexDirectAccessIndexSpecEmbeddingVectorColumn]
    schema_json str
    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>
    embeddingVectorColumns List<Property Map>
    schemaJson 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>

    AiSearchIndexDirectAccessIndexSpecEmbeddingSourceColumn, AiSearchIndexDirectAccessIndexSpecEmbeddingSourceColumnArgs

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

    AiSearchIndexDirectAccessIndexSpecEmbeddingVectorColumn, AiSearchIndexDirectAccessIndexSpecEmbeddingVectorColumnArgs

    EmbeddingDimension int
    Dimension of the embedding vector
    Name string
    (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
    Dimension of the embedding vector
    Name string
    (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
    Dimension of the embedding vector
    name string
    (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
    Dimension of the embedding vector
    name String
    (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
    Dimension of the embedding vector
    name string
    (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
    Dimension of the embedding vector
    name str
    (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
    Dimension of the embedding vector
    name String
    (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

    AiSearchIndexProviderConfig, AiSearchIndexProviderConfigArgs

    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.

    AiSearchIndexStatus, AiSearchIndexStatusArgs

    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.97.0
    published on Thursday, Jun 25, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-databricks

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial