Package com.databricks.sdk.service.aisearch

Interface Summary

Interface	Description
AiSearchService	**AI Search Endpoint**: Represents the compute resources to host AI Search indexes.

Class Summary

Class	Description
AiSearchAPI	**AI Search Endpoint**: Represents the compute resources to host AI Search indexes.
ColumnInfo	Column information (name and data type) for an index column.
CreateEndpointRequest
CreateIndexRequest
CustomTag	User-defined key/value tag attached to an AI Search endpoint for cost attribution and access control.
DataModificationResult	Per-row outcome of a data-plane upsert or delete operation.
DeleteEndpointRequest
DeleteIndexRequest
DeltaSyncIndexSpec	Specification for a Delta Sync index — the index is kept in sync with a source Delta table.
DirectAccessIndexSpec	Specification for a Direct Access index — the customer manages vectors and metadata directly.
EmbeddingSourceColumn	Name of an embedding source column and its associated embedding model endpoint.
EmbeddingVectorColumn	Name and dimension of an embedding vector column.
Endpoint	An AI Search endpoint — compute infrastructure that hosts AI Search indexes and serves queries against them.
EndpointScalingInfo	Scaling information for a Storage Optimized endpoint — current scaling state and the requested QPS target the system is scaling toward.
EndpointStatus	Lifecycle and health state of an AI Search endpoint, along with any human-readable detail about that state.
EndpointThroughputInfo	Throughput information for an AI Search endpoint, including requested and current concurrency settings.
FacetResultData	Facet aggregation rows returned by a query.
GetEndpointRequest
GetIndexRequest
Index	An AI Search index — a searchable collection of vectors and metadata hosted on an AI Search endpoint.
IndexStatus	Lifecycle and health state of an AI Search index, along with human-readable detail about that state and basic indexing progress.
ListEndpointsRequest
ListEndpointsResponse	Response for ListEndpoints carrying the page of endpoints and an optional continuation token.
ListIndexesRequest
ListIndexesResponse	Response for ListIndexes carrying the page of indexes and an optional continuation token.
QueryIndexRequest	Request to query (search) an AI Search index.
QueryIndexResponse	Response for QueryIndex carrying the matched rows and their column metadata.
RemoveDataRequest	Request to remove rows by primary key from a Direct Access AI Search index.
RemoveDataResponse	Response for RemoveData.
RerankerConfig	Configuration for reranking query results with a reranker model.
RerankerConfigRerankerParameters	Parameters controlling how the reranker processes results.
ResultData	The rows of a query result set.
ResultManifest	Metadata describing the columns of a query result set.
ScanIndexRequest	Request to scan (paginate over) the rows of an AI Search index.
ScanIndexResponse	Response for ScanIndex carrying a page of rows and an optional continuation token.
SyncIndexRequest	Request to synchronize a Delta Sync AI Search index with its source Delta table.
SyncIndexResponse	Response for SyncIndex.
UpdateEndpointRequest
UpsertDataRequest	Request to upsert rows into a Direct Access AI Search index.
UpsertDataResponse	Response for UpsertData.

Enum Summary

Enum	Description
DataModificationStatus	Overall outcome of a data-plane upsert or delete.
EndpointStatusState	Lifecycle state of an AI Search endpoint, used by both Standard and Storage Optimized SKUs.
EndpointType	Type of endpoint.
IndexSubtype	The subtype of the AI Search index, determining the indexing and retrieval strategy. - `VECTOR`: Not a supported create value — do not select it.
IndexType	There are 2 types of AI Search indexes: - `DELTA_SYNC`: An index that automatically syncs with a source Delta Table, automatically and incrementally updating the index as the underlying data in the Delta Table changes. - `DIRECT_ACCESS`: An index that supports direct read and write of vectors and metadata through our REST and SDK APIs.
PipelineType	Pipeline execution mode for a Delta Sync index.
RerankerConfigModelType	How the `model` field is interpreted.
ScalingChangeState	State of the most recent scaling change request for a Storage Optimized endpoint.
ThroughputChangeRequestState	State of the most recent throughput change request issued against a Storage Optimized endpoint.