# The 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.

## Attributes

- `name` (string, Public 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`
- `endpoint` (string, Public Preview, Output 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_key` (string, Public Preview, Immutable)
  Primary key of the index. Set on create and immutable thereafter.
- `index_type` (string, Public Preview, Immutable)
  Type of index. Required on create and immutable thereafter.
  Possible values:
  - `DELTA_SYNC`
  - `DIRECT_ACCESS`
- `direct_access_index_spec` (object, Public Preview, Immutable)
  Specification for a Direct Access index. Set when `index_type` is `DIRECT_ACCESS`.
  - `embedding_vector_columns` (array of object, Public Preview)
    The columns that contain the embedding vectors.
    - `name` (string, Public Preview)
      Name of the column.
    - `embedding_dimension` (int32, Public Preview)
      Dimension of the embedding vector.
  - `schema_json` (string, Public 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_columns` (array of object, Public Preview)
    The columns that contain the embedding source.
    - `name` (string, Public Preview)
      Name of the source column.
    - `embedding_model_endpoint` (string, Public Preview)
      Name of the embedding model endpoint, used by default for both ingestion and querying.
    - `model_endpoint_name_for_query` (string, Public Preview)
      Name of the embedding model endpoint which, if specified, is used for querying (not ingestion).
- `delta_sync_index_spec` (object, Public Preview, Immutable)
  Specification for a Delta Sync index. Set when `index_type` is `DELTA_SYNC`.
  - `source_table` (string, Public Preview)
    The full name of the source Delta table.
  - `embedding_source_columns` (array of object, Public Preview)
    The columns that contain the embedding source.
    - `name` (string, Public Preview)
      Name of the source column.
    - `embedding_model_endpoint` (string, Public Preview)
      Name of the embedding model endpoint, used by default for both ingestion and querying.
    - `model_endpoint_name_for_query` (string, Public Preview)
      Name of the embedding model endpoint which, if specified, is used for querying (not ingestion).
  - `embedding_vector_columns` (array of object, Public Preview)
    The columns that contain the embedding vectors.
    - `name` (string, Public Preview)
      Name of the column.
    - `embedding_dimension` (int32, Public Preview)
      Dimension of the embedding vector.
  - `embedding_writeback_table` (string, Public Preview)
    [Optional] Name of the Delta table to sync the index contents and computed embeddings to.
  - `columns_to_sync` (array of string, Public 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_id` (string, Public Preview, Output only)
    The ID of the pipeline that is used to sync the index.
  - `pipeline_type` (string, Public 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.
    Possible values:
    - `PIPELINE_TYPE_UNSPECIFIED`
    - `TRIGGERED`
    - `CONTINUOUS`
- `status` (object, Public Preview, Output only)
  Current status of the index.
  - `message` (string, Public Preview, Output only)
    Human-readable detail about the index's current state.
  - `indexed_row_count` (int64, Public Preview, Output only)
    Number of rows indexed.
  - `ready` (boolean, Public Preview, Output only)
    Whether the index is ready for search.
  - `index_url` (string, Public Preview, Output only)
    Index API URL used to perform operations on the index.
- `creator` (string, Public Preview, Output only)
  Creator of the index.
  Example: `john@example.com`
- `index_subtype` (string, Public Preview, Immutable)
  The subtype of the index. Set on create and immutable thereafter.
  Possible values:
  - `VECTOR`
  - `FULL_TEXT`
  - `HYBRID`

## Example

```json
{
  "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"
}
```