Skip to content
dbx tools

Variable: createIndexRequestSchema

const createIndexRequestSchema: ZodObject<{ columnsToSync: ZodOptional<ZodArray<ZodString>>; embeddingDimension: ZodOptional<ZodNumber>; embeddingModel: ZodOptional<ZodString>; embeddingSourceColumn: ZodOptional<ZodString>; endpoint: ZodOptional<ZodString>; name: ZodString; pipelineType: ZodOptional<ZodEnum<{ CONTINUOUS: "CONTINUOUS"; TRIGGERED: "TRIGGERED"; }>>; primaryKey: ZodOptional<ZodString>; sourceTable: ZodOptional<ZodString>; }, $strip>

Schema for creating an index (the create_index tool input / the POST /api/search/index body). Two shapes, both inferring aggressively: pass sourceTable for a Delta Sync index (Databricks computes embeddings and keeps it synced) or embeddingDimension for a direct-access index you write vectors to yourself.

createIndexRequest fields

Section titled “createIndexRequest fields”
  • name: Unity Catalog name for the new index (catalog.schema.index).
  • sourceTable (optional): Delta table (catalog.schema.table) to build a synced index from. Provide this OR embeddingDimension.
  • primaryKey (optional): Primary-key column. Defaults to ‘id’.
  • embeddingSourceColumn (optional): Text column embeddings are computed from (Delta Sync). Defaults to the first of text/content/body.
  • embeddingModel (optional): Embedding model endpoint (name or loose name). Defaults to the app’s embedding model, or the best embedding endpoint in the workspace.
  • endpoint (optional): Vector Search endpoint to host the index on. Defaults to the app’s configured endpoint.
  • embeddingDimension (optional): For a direct-access index (no source table): the embedding vector dimension.
  • pipelineType (optional): Delta Sync mode: ‘TRIGGERED’ (default) syncs on demand; ‘CONTINUOUS’ keeps the index fresh.
  • columnsToSync (optional): Extra columns to sync alongside the embedding source column (Delta Sync).