Skip to content

Variable: indexInfoSchema

const indexInfoSchema: ZodObject<{ columns: ZodArray<ZodString>; directAccess: ZodOptional<ZodBoolean>; endpoint: ZodOptional<ZodString>; name: ZodString; primaryKey: ZodOptional<ZodString>; ready: ZodBoolean; rowCount: ZodOptional<ZodNumber>; }, $strip> = searchSchemas.indexInfoSchema

Schema for the create_index tool output (a resolved index definition).

  • name: Unity Catalog name of the index.
  • endpoint (optional): The Vector Search endpoint hosting the index.
  • primaryKey (optional): The index’s primary-key column.
  • columns: Columns available on the index.
  • ready: True when the index has finished provisioning and can be queried.
  • rowCount (optional): Number of indexed rows, when known.
  • directAccess (optional): True for a DIRECT_ACCESS index that stores caller-supplied vectors.