Index

View as Markdown

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

Get an AI Search indexGET /api/2.0/ai-search/{name=workspaces/*/endpoints/*/indexes/*}List AI Search indexesGET /api/2.0/ai-search/{parent=workspaces/*/endpoints/*}/indexesCreate an AI Search indexPOST /api/2.0/ai-search/{parent=workspaces/*/endpoints/*}/indexesDelete an AI Search indexDELETE /api/2.0/ai-search/{name=workspaces/*/endpoints/*/indexes/*}

Index object

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

namestringPublic Preview

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.

Example: main.default.docs_index

endpointstringPublic PreviewOutput only

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

Example: docs-endpoint

primary_keystringPublic PreviewImmutable

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

index_typestringPublic PreviewImmutable

Type of index. Required on create and immutable thereafter.

Values:

• DELTA_SYNC
• DIRECT_ACCESS

direct_access_index_specobjectPublic PreviewImmutable

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

Show child attributesHide child attributes

embedding_vector_columnsarray of objectPublic Preview

The columns that contain the embedding vectors.

Show child attributesHide child attributes

namestringPublic Preview

Name of the column.

embedding_dimensionint32Public Preview

Dimension of the embedding vector.

schema_jsonstringPublic Preview

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_columnsarray of objectPublic Preview

The columns that contain the embedding source.

Show child attributesHide child attributes

namestringPublic Preview

Name of the source column.

embedding_model_endpointstringPublic Preview

Name of the embedding model endpoint, used by default for both ingestion and querying.

model_endpoint_name_for_querystringPublic Preview

Name of the embedding model endpoint which, if specified, is used for querying (not ingestion).

delta_sync_index_specobjectPublic PreviewImmutable

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

Show child attributesHide child attributes

source_tablestringPublic Preview

The full name of the source Delta table.

embedding_source_columnsarray of objectPublic Preview

The columns that contain the embedding source.

Show child attributesHide child attributes

namestringPublic Preview

Name of the source column.

embedding_model_endpointstringPublic Preview

Name of the embedding model endpoint, used by default for both ingestion and querying.

model_endpoint_name_for_querystringPublic Preview

Name of the embedding model endpoint which, if specified, is used for querying (not ingestion).

embedding_vector_columnsarray of objectPublic Preview

The columns that contain the embedding vectors.

Show child attributesHide child attributes

namestringPublic Preview

Name of the column.

embedding_dimensionint32Public Preview

Dimension of the embedding vector.

embedding_writeback_tablestringPublic Preview

[Optional] Name of the Delta table to sync the index contents and computed embeddings to.

columns_to_syncarray of stringPublic Preview

[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.

pipeline_idstringPublic PreviewOutput only

The ID of the pipeline that is used to sync the index.

pipeline_typestringPublic Preview

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.

Values:

• PIPELINE_TYPE_UNSPECIFIED
• TRIGGERED
• CONTINUOUS

statusobjectPublic PreviewOutput only

Current status of the index.

Show child attributesHide child attributes

messagestringPublic PreviewOutput only

Human-readable detail about the index's current state.

indexed_row_countint64Public PreviewOutput only

Number of rows indexed.

readybooleanPublic PreviewOutput only

Whether the index is ready for search.

index_urlstringPublic PreviewOutput only

Index API URL used to perform operations on the index.

creatorstringPublic PreviewOutput only

Creator of the index.

Example: john@example.com

index_subtypestringPublic PreviewImmutable

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

Values:

• VECTOR
• FULL_TEXT
• HYBRID

View as Markdown

The Index object

{
  "name": "main.default.docs_index",
  "endpoint": "docs-endpoint",
  "primary_key": "string",
  "index_type": "string",
  "direct_access_index_spec": {
    "embedding_vector_columns": [
      {}
    ],
    "schema_json": "string",
    "embedding_source_columns": [
      {}
    ]
  },
  "delta_sync_index_spec": {
    "source_table": "string",
    "embedding_source_columns": [
      {}
    ],
    "embedding_vector_columns": [
      {}
    ],
    "embedding_writeback_table": "string",
    "columns_to_sync": [
      "string"
    ],
    "pipeline_id": "string",
    "pipeline_type": "string"
  },
  "status": {
    "message": "string",
    "indexed_row_count": 0,
    "ready": true,
    "index_url": "string"
  },
  "creator": "john@example.com",
  "index_subtype": "string"
}

Get an AI Search index Public Preview

GET /api/2.0/ai-search/{name=workspaces/*/endpoints/*/indexes/*}

Get details for a single AI Search index.

API scopes: ai-search

Parameters

namestringRequiredpath

Full resource name of the index. Format: workspaces/{workspace_id}/endpoints/{endpoint_id}/indexes/{index_id}

Response

Returns the Index object.

View as Markdown

Response

{
  "name": "main.default.docs_index",
  "endpoint": "docs-endpoint",
  "primary_key": "string",
  "index_type": "string",
  "direct_access_index_spec": {
    "embedding_vector_columns": [
      {}
    ],
    "schema_json": "string",
    "embedding_source_columns": [
      {}
    ]
  },
  "delta_sync_index_spec": {
    "source_table": "string",
    "embedding_source_columns": [
      {}
    ],
    "embedding_vector_columns": [
      {}
    ],
    "embedding_writeback_table": "string",
    "columns_to_sync": [
      "string"
    ],
    "pipeline_id": "string",
    "pipeline_type": "string"
  },
  "status": {
    "message": "string",
    "indexed_row_count": 0,
    "ready": true,
    "index_url": "string"
  },
  "creator": "john@example.com",
  "index_subtype": "string"
}

List AI Search indexes Public Preview

GET /api/2.0/ai-search/{parent=workspaces/*/endpoints/*}/indexes

List AI Search indexes on an endpoint.

API scopes: ai-search

Parameters

parentstringRequiredpath

The Endpoint that owns this collection of indexes. Format: workspaces/{workspace_id}/endpoints/{endpoint_id}

page_sizeint32query

Best-effort upper bound on the number of results to return. Honored as an upper bound by the shim: page_size only narrows the legacy backend's response, never widens it, so the practical cap is min(page_size, legacy_fixed_page_size).

page_tokenstringquery

Page token from a previous response. If not provided, returns the first page.

Response

Returns a list of Index objects.

View as Markdown

Response

{
  "indexes": [
    {
      "name": "main.default.docs_index",
      "endpoint": "docs-endpoint",
      "primary_key": "string",
      "index_type": "string",
      "direct_access_index_spec": {},
      "delta_sync_index_spec": {},
      "status": {},
      "creator": "john@example.com",
      "index_subtype": "string"
    }
  ],
  "next_page_token": "string"
}

Create an AI Search index Public Preview

POST /api/2.0/ai-search/{parent=workspaces/*/endpoints/*}/indexes

Create a new AI Search index.

API scopes: ai-search

Parameters

parentstringRequiredpath

The Endpoint where this Index will be created. Format: workspaces/{workspace_id}/endpoints/{endpoint_id}

index_idstringquery

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 index_id 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.

Request body

The Index resource to create. Fields other than index.name carry the desired configuration; index.name is server-assigned from parent and index_id.

namestring

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.

Example: main.default.docs_index

primary_keystringRequiredImmutable

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

index_typestringRequiredImmutable

Type of index. Required on create and immutable thereafter.

Values:

• DELTA_SYNC
• DIRECT_ACCESS

direct_access_index_specobjectImmutable

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

Show child attributesHide child attributes

embedding_vector_columnsarray of object

The columns that contain the embedding vectors.

Show child attributesHide child attributes

namestring

Name of the column.

embedding_dimensionint32

Dimension of the embedding vector.

schema_jsonstring

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_columnsarray of object

The columns that contain the embedding source.

Show child attributesHide child attributes

namestring

Name of the source column.

embedding_model_endpointstring

Name of the embedding model endpoint, used by default for both ingestion and querying.

model_endpoint_name_for_querystring

Name of the embedding model endpoint which, if specified, is used for querying (not ingestion).

delta_sync_index_specobjectImmutable

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

Show child attributesHide child attributes

source_tablestring

The full name of the source Delta table.

embedding_source_columnsarray of object

The columns that contain the embedding source.

Show child attributesHide child attributes

namestring

Name of the source column.

embedding_model_endpointstring

Name of the embedding model endpoint, used by default for both ingestion and querying.

model_endpoint_name_for_querystring

Name of the embedding model endpoint which, if specified, is used for querying (not ingestion).

embedding_vector_columnsarray of object

The columns that contain the embedding vectors.

Show child attributesHide child attributes

namestring

Name of the column.

embedding_dimensionint32

Dimension of the embedding vector.

embedding_writeback_tablestring

[Optional] Name of the Delta table to sync the index contents and computed embeddings to.

columns_to_syncarray 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.

pipeline_typestringRequired

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.

Values:

• PIPELINE_TYPE_UNSPECIFIED
• TRIGGERED
• CONTINUOUS

index_subtypestringImmutable

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

Values:

• VECTOR
• FULL_TEXT
• HYBRID

Response

Returns the Index object.

View as Markdown

Request

{
  "name": "main.default.docs_index",
  "primary_key": "string",
  "index_type": "string",
  "direct_access_index_spec": {
    "embedding_vector_columns": [
      {}
    ],
    "schema_json": "string",
    "embedding_source_columns": [
      {}
    ]
  },
  "delta_sync_index_spec": {
    "source_table": "string",
    "embedding_source_columns": [
      {}
    ],
    "embedding_vector_columns": [
      {}
    ],
    "embedding_writeback_table": "string",
    "columns_to_sync": [
      "string"
    ],
    "pipeline_type": "string"
  },
  "index_subtype": "string"
}

Response

{
  "name": "main.default.docs_index",
  "endpoint": "docs-endpoint",
  "primary_key": "string",
  "index_type": "string",
  "direct_access_index_spec": {
    "embedding_vector_columns": [
      {}
    ],
    "schema_json": "string",
    "embedding_source_columns": [
      {}
    ]
  },
  "delta_sync_index_spec": {
    "source_table": "string",
    "embedding_source_columns": [
      {}
    ],
    "embedding_vector_columns": [
      {}
    ],
    "embedding_writeback_table": "string",
    "columns_to_sync": [
      "string"
    ],
    "pipeline_id": "string",
    "pipeline_type": "string"
  },
  "status": {
    "message": "string",
    "indexed_row_count": 0,
    "ready": true,
    "index_url": "string"
  },
  "creator": "john@example.com",
  "index_subtype": "string"
}

Delete an AI Search index Public Preview

DELETE /api/2.0/ai-search/{name=workspaces/*/endpoints/*/indexes/*}

Delete an AI Search index.

API scopes: ai-search

Parameters

namestringRequiredpath

Full resource name of the index to delete. Format: workspaces/{workspace_id}/endpoints/{endpoint_id}/indexes/{index_id}

View as Markdown

Response

{}