vectorsearch

type Client struct {
	// contains filtered or unexported fields
}

type ColumnInfo struct {
	// Name of the column.
	Name *string
	// Data type of the column (e.g., "string", "int", "array<float>")
	TypeText *string
}

type CreateEndpointRequest struct {
	// Name of the AI Search endpoint
	Name *string
	// Type of endpoint
	EndpointType EndpointType
	// The budget policy id to be applied
	BudgetPolicyId *string
	// The usage policy id to be applied once we've migrated to usage policies
	UsagePolicyId *string
	// Target QPS for the endpoint. Mutually exclusive with num_replicas. The actual
	// replica count is calculated at index creation/sync time based on this value.
	// Best-effort target; the system does not guarantee this QPS will be achieved.
	TargetQps *int64
}

type CreateEndpointWaiter struct {
	// contains filtered or unexported fields
}

type CreateVectorIndexRequest struct {
	// Name of the index
	Name *string
	// Name of the endpoint to be used for serving the index
	EndpointName *string
	// Primary key of the index
	PrimaryKey *string
	IndexType  VectorIndexType
	IndexSpec  isCreateVectorIndexRequest_IndexSpec
	// The subtype of the index. Use `HYBRID` or `FULL_TEXT`. `VECTOR` is not
	// supported.
	IndexSubtype IndexSubtype
}

type CreateVectorIndexRequest_IndexSpec_DeltaSyncIndexSpec struct {
	DeltaSyncIndexSpec DeltaSyncVectorIndexSpecRequest
}

type CreateVectorIndexRequest_IndexSpec_DirectAccessIndexSpec struct {
	DirectAccessIndexSpec DirectAccessVectorIndexSpec
}

type CustomTag struct {
	// Key field for an AI Search endpoint tag.
	Key *string
	// [Optional] Value field for an AI Search endpoint tag.
	Value *string
}

type DeleteDataVectorIndexRequest struct {
	// Name of the vector index where data is to be deleted. Must be a Direct Vector
	// Access Index.
	Name *string
	// List of primary keys for the data to be deleted.
	PrimaryKeys []string
}

type DeleteDataVectorIndexResponse struct {
	// Status of the delete operation.
	Status UpsertDeleteDataStatus
	// Result of the upsert or delete operation.
	Result *UpsertDeleteDataResult
}

type DeleteEndpointRequest struct {
	// Name of the AI Search endpoint
	Name *string
}

type DeleteEndpointResponse struct {
}

type DeleteVectorIndexRequest struct {
	// Name of the index
	Name *string
}

type DeleteVectorIndexResponse struct {
}

type DeltaSyncVectorIndexSpec struct {
	// The name of the source table.
	SourceTable *string
	// The columns that contain the embedding source.
	EmbeddingSourceColumns []EmbeddingSourceColumn
	// The columns that contain the embedding vectors.
	EmbeddingVectorColumns []EmbeddingVectorColumn
	// Pipeline execution mode. - `TRIGGERED`: If the pipeline uses the triggered
	// execution mode, the system stops processing after successfully refreshing the
	// source table in the pipeline once, ensuring the table is updated based on the
	// data available when the update started. - `CONTINUOUS`: If the pipeline uses
	// continuous execution, the pipeline processes new data as it arrives in the
	// source table to keep vector index fresh.
	PipelineType PipelineType
	// The ID of the pipeline that is used to sync the index.
	PipelineId *string
	// [Optional] Name of the Delta table to sync the vector index contents and
	// computed embeddings to.
	EmbeddingWritebackTable *string
	// [Optional] Select the columns to sync with the vector index. If you leave
	// this field blank, all columns from the source table are synced with the
	// index. The primary key column and embedding source column or embedding vector
	// column are always synced.
	ColumnsToSync []string
	// [Optional] Alias for columns_to_sync. Select the columns to include in the
	// vector index. If you leave this field blank, all columns from the source
	// table are included. The primary key column and embedding source column or
	// embedding vector column are always included. Only one of columns_to_sync or
	// columns_to_index may be specified.
	ColumnsToIndex []string
}

type DeltaSyncVectorIndexSpecRequest struct {
	// The name of the source table.
	SourceTable *string
	// The columns that contain the embedding source.
	EmbeddingSourceColumns []EmbeddingSourceColumn
	// The columns that contain the embedding vectors.
	EmbeddingVectorColumns []EmbeddingVectorColumn
	// Pipeline execution mode. - `TRIGGERED`: If the pipeline uses the triggered
	// execution mode, the system stops processing after successfully refreshing the
	// source table in the pipeline once, ensuring the table is updated based on the
	// data available when the update started. - `CONTINUOUS`: If the pipeline uses
	// continuous execution, the pipeline processes new data as it arrives in the
	// source table to keep vector index fresh.
	PipelineType PipelineType
	// The ID of the pipeline that is used to sync the index.
	PipelineId *string
	// [Optional] Name of the Delta table to sync the vector index contents and
	// computed embeddings to.
	EmbeddingWritebackTable *string
	// [Optional] Select the columns to sync with the vector index. If you leave
	// this field blank, all columns from the source table are synced with the
	// index. The primary key column and embedding source column or embedding vector
	// column are always synced.
	ColumnsToSync []string
	// [Optional] Alias for columns_to_sync. Select the columns to include in the
	// vector index. If you leave this field blank, all columns from the source
	// table are included. The primary key column and embedding source column or
	// embedding vector column are always included. Only one of columns_to_sync or
	// columns_to_index may be specified.
	ColumnsToIndex []string
}

type DirectAccessVectorIndexSpec struct {
	// The columns that contain the embedding vectors. The format should be
	// array[double].
	EmbeddingVectorColumns []EmbeddingVectorColumn
	// The schema of the index in JSON format. Supported types are `integer`,
	// `long`, `float`, `double`, `boolean`, `string`, `date`, `timestamp`.
	// Supported types for vector column: `array<float>`, `array<double>`,`.
	SchemaJson *string
	// The columns that contain the embedding source. The format should be
	// array[double].
	EmbeddingSourceColumns []EmbeddingSourceColumn
}

type EmbeddingSourceColumn struct {
	// Name of the column
	Name *string
	// TODO: clean up ai gateway related code. It's deprecated on ModelServing side.
	EmbeddingConfig isEmbeddingSourceColumn_EmbeddingConfig
	// Name of the embedding model endpoint which, if specified, is used for
	// querying (not ingestion).
	ModelEndpointNameForQuery *string
}

type EmbeddingSourceColumn_EmbeddingConfig_EmbeddingModelEndpointName struct {
	EmbeddingModelEndpointName string
}

type EmbeddingVectorColumn struct {
	// Name of the column
	Name *string
	// Dimension of the embedding vector
	EmbeddingDimension *int
}

type Endpoint struct {
	// Name of the AI Search endpoint
	Name *string
	// Creator of the endpoint
	Creator *string
	// Timestamp of endpoint creation
	CreationTimestamp *int64
	// Timestamp of last update to the endpoint
	LastUpdatedTimestamp *int64
	// Type of endpoint
	EndpointType EndpointType
	// User who last updated the endpoint
	LastUpdatedUser *string
	// Unique identifier of the endpoint
	Id *string
	// Current status of the endpoint
	EndpointStatus *EndpointStatus
	// Number of indexes on the endpoint
	NumIndexes *int
	// The user-selected budget policy id for the endpoint.
	BudgetPolicyId *string
	// The budget policy id applied to the endpoint
	EffectiveBudgetPolicyId *string
	// The custom tags assigned to the endpoint
	CustomTags []CustomTag
	// Scaling information for the endpoint
	ScalingInfo *EndpointScalingInfo
}

type EndpointScalingInfo struct {
	// The current state of the scaling change request.
	State ScalingChangeState
	// The requested QPS target for the endpoint. Best-effort; the system does not
	// guarantee this QPS will be achieved.
	RequestedTargetQps *int64
}

type EndpointStatus struct {
	// Current state of the endpoint
	State EndpointStatus_State
	// Additional status message
	Message *string
}

type EndpointStatus_State string

type EndpointType string

type FacetResultData struct {
	// Number of facet rows returned.
	FacetRowCount *int
	// Facet rows. Each row is `[facet_column_name, value_or_range, count]`.
	FacetArray [][]json.RawMessage
}

type GetEndpointRequest struct {
	// Name of the endpoint
	Name *string
}

type GetVectorIndexRequest struct {
	// Name of the index
	Name *string
	// If true, the URL returned for the index is guaranteed to be compatible with
	// the reranker. Currently this means we return the CP URL regardless of how the
	// index is being accessed. If not set or set to false, the URL may still be
	// compatible with the reranker depending on what URL we return.
	EnsureRerankerCompatible *bool
}

type IndexSubtype string

type ListEndpointResponse struct {
	// An array of Endpoint objects
	Endpoints []Endpoint
	// A token that can be used to get the next page of results. If not present,
	// there are no more results to show.
	NextPageToken *string
}

type ListEndpointsRequest struct {
	// Token for pagination
	PageToken *string
}

type ListValue struct {
	// Repeated field of dynamically typed values.
	Values []Value
}

type ListVectorIndexRequest struct {
	// Name of the endpoint
	EndpointName *string
	// Token for pagination
	PageToken *string
}

type ListVectorIndexResponse struct {
	VectorIndexes []MiniVectorIndex
	// A token that can be used to get the next page of results. If not present,
	// there are no more results to show.
	NextPageToken *string
}

type MapStringValueEntry struct {
	// Column name.
	Key *string
	// Column value, nullable.
	Value *Value
}

type Metric struct {
	// Metric name
	Name *string
	// Metric labels
	Labels []MetricLabel
	// Percentile for the metric
	Percentile *float64
}

type MetricLabel struct {
	// Label name
	Name *string
	// Label value
	Value *string
}

type MetricValue struct {
	// Timestamp of the metric value (milliseconds since epoch)
	Timestamp *int64
	// Metric value
	Value *float64
}

type MetricValues struct {
	// Metric specification
	Metric *Metric
	// Time series of metric values
	Values []MetricValue
}

type MiniVectorIndex struct {
	// Name of the index
	Name *string
	// Name of the endpoint associated with the index
	EndpointName *string
	// Primary key of the index
	PrimaryKey *string
	IndexType  VectorIndexType
	IndexSpec  isMiniVectorIndex_IndexSpec
	Status     *VectorIndexStatus
	// The user who created the index.
	Creator *string
	// The subtype of the index.
	IndexSubtype IndexSubtype
	// ID of the endpoint associated with the index.
	EndpointId *string
}

type MiniVectorIndex_IndexSpec_DeltaSyncIndexSpec struct {
	DeltaSyncIndexSpec DeltaSyncVectorIndexSpec
}

type MiniVectorIndex_IndexSpec_DirectAccessIndexSpec struct {
	DirectAccessIndexSpec DirectAccessVectorIndexSpec
}

type PatchEndpointBudgetPolicyRequest struct {
	// Name of the AI Search endpoint
	Name *string
	// The budget policy id to be applied
	BudgetPolicyId *string
}

type PatchEndpointBudgetPolicyResponse struct {
	BudgetPolicyId *string
	// The budget policy applied to the AI Search endpoint.
	EffectiveBudgetPolicyId *string
}

type PatchEndpointRequest struct {
	// Name of the AI Search endpoint
	Name *string
	// Target QPS for the endpoint. Best-effort; the system does not guarantee this
	// QPS will be achieved.
	TargetQps *int64
}

type PipelineType string

type QueryVectorIndexNextPageRequest struct {
	// Name of the vector index to query.
	Name *string
	// Name of the endpoint.
	EndpointName *string
	// Page token returned from previous `QueryVectorIndex` or
	// `QueryVectorIndexNextPage` API.
	PageToken *string
}

type QueryVectorIndexRequest struct {
	// Name of the vector index to query.
	Name *string
	// Number of results to return. Defaults to 10.
	NumResults *int
	// List of column names to include in the response.
	Columns []string
	// JSON string representing query filters.
	//
	// Example filters:
	//
	// - `{"id <": 5}`: Filter for id less than 5. - `{"id >": 5}`: Filter for id
	// greater than 5. - `{"id <=": 5}`: Filter for id less than equal to 5. - `{"id
	// >=": 5}`: Filter for id greater than equal to 5. - `{"id": 5}`: Filter for id
	// equal to 5.
	FiltersJson *string
	// Query vector. Required for Direct Vector Access Index and Delta Sync Index
	// using self-managed vectors.
	QueryVector []float32
	// Query text. Required for Delta Sync Index using model endpoint.
	QueryText *string
	// Threshold for the approximate nearest neighbor search. Defaults to 0.0.
	ScoreThreshold *float32
	// The query type to use. Choices are `ANN` and `HYBRID` and `FULL_TEXT`.
	// Defaults to `ANN`.
	QueryType *string
	// Column names used to retrieve data to send to the reranker.
	ColumnsToRerank []string
	// If set, the top 50 results are reranked with the Databricks Reranker model
	// before returning the `num_results` results to the user. The setting
	// `columns_to_rerank` selects which columns are used for reranking. For each
	// datapoint, the columns selected are concatenated before being sent to the
	// reranking model. See
	// https://docs.databricks.com/aws/en/vector-search/query-vector-search#rerank
	// for more information.
	Reranker *RerankerConfig
	// Text columns to search for `query_text`. When empty, all text columns are
	// searched.
	QueryColumns []string
	// Sort results by column values instead of the default relevance ordering. Each
	// clause has the form `"<column> ASC"` or `"<column> DESC"`, for example
	// `["rating DESC", "price ASC"]`.
	SortColumns []string
	// Facets to compute over the matched results. Each entry has one of these
	// forms: `"<column>"` - top 10 distinct values by count `"<column> TOP <n>"` -
	// top n distinct values, where n > 0 `"<column> BUCKETS [[from,to],...]"` -
	// inclusive numeric ranges `TOP` and `BUCKETS` are case-insensitive. A column
	// may appear at most once.
	Facets []string
}

type QueryVectorIndexResponse struct {
	// Metadata about the result set.
	Manifest *ResultManifest
	// Data returned in the query result.
	Result *ResultData
	// [Optional] Token that can be used in `QueryVectorIndexNextPage` API to get
	// next page of results. If more than 1000 results satisfy the query, they are
	// returned in groups of 1000. Empty value means no more results. The maximum
	// number of results that can be returned is 10,000.
	NextPageToken *string
	// Facet aggregation rows returned by a query.
	FacetResult *FacetResultData
}

type RerankerConfig struct {
	// Reranker identifier: - When model_type=BASE/UNSPECIFIED: must be
	// "databricks_reranker". - When model_type=FINETUNED: the Model Serving
	// endpoint name hosting a finetuned reranker.
	Model *string
	// Parameters that control how the reranker processes the query results.
	Parameters *RerankerConfig_RerankerParameters
}

type RerankerConfig_RerankerParameters struct {
	ColumnsToRerank []string
}

type ResultData struct {
	// Number of rows in the result set.
	RowCount *int
	// Data rows returned in the query.
	DataArray [][]json.RawMessage
}

type ResultManifest struct {
	// Number of columns in the result set.
	ColumnCount *int
	// Information about each column in the result set.
	Columns []ColumnInfo
	// Number of columns in `facet_result`.
	FacetColumnCount *int
	// Information about each column in `facet_result`.
	FacetColumns []ColumnInfo
}

type RetrieveUserVisibleMetricsRequest struct {
	// AI Search endpoint name
	Name *string
	// Start time for metrics query
	StartTime *types.Time
	// End time for metrics query
	EndTime *types.Time
	// Granularity in seconds
	GranularityInSeconds *int
	// List of metrics to retrieve
	Metrics []Metric
	// Token for pagination
	PageToken *string
}

type RetrieveUserVisibleMetricsResponse struct {
	// Collection of metric values
	MetricValues []MetricValues
	// A token that can be used to get the next page of results. If not present,
	// there are no more results to show.
	NextPageToken *string
}

type ScalingChangeState string

type ScanVectorIndexRequest struct {
	// Name of the vector index to scan.
	Name *string
	// Number of results to return. Defaults to 10.
	NumResults *int
	// Primary key of the last entry returned in the previous scan.
	LastPrimaryKey *string
}

type ScanVectorIndexResponse struct {
	// List of data entries
	Data []Struct
	// Primary key of the last entry.
	LastPrimaryKey *string
}

type Struct struct {
	// Data entry, corresponding to a row in a vector index.
	Fields []MapStringValueEntry
}

type SyncVectorIndexRequest struct {
	// Name of the vector index to synchronize. Must be a Delta Sync Index.
	Name *string
}

type SyncVectorIndexResponse struct {
}

type UpdateEndpointCustomTagsRequest struct {
	// Name of the AI Search endpoint
	Name *string
	// The new custom tags for the AI Search endpoint
	CustomTags []CustomTag
}

type UpdateEndpointCustomTagsResponse struct {
	// The name of the AI Search endpoint whose custom tags were updated.
	Name *string
	// All the custom tags that are applied to the AI Search endpoint.
	CustomTags []CustomTag
}

type UpsertDataVectorIndexRequest struct {
	// Name of the vector index where data is to be upserted. Must be a Direct
	// Vector Access Index.
	Name *string
	// JSON string representing the data to be upserted.
	InputsJson *string
}

type UpsertDataVectorIndexResponse struct {
	// Status of the upsert operation.
	Status UpsertDeleteDataStatus
	// Result of the upsert or delete operation.
	Result *UpsertDeleteDataResult
}

type UpsertDeleteDataResult struct {
	// Count of successfully processed rows.
	SuccessRowCount *int64
	// List of primary keys for rows that failed to process.
	FailedPrimaryKeys []string
}

type UpsertDeleteDataStatus string

type Value struct {
	// (--The kind of value.--)
	Kind isValue_Kind
}

type Value_Kind_BoolValue struct {
	BoolValue bool
}

type Value_Kind_ListValue struct {
	ListValue ListValue
}

type Value_Kind_NumberValue struct {
	NumberValue float64
}

type Value_Kind_StringValue struct {
	StringValue string
}

type Value_Kind_StructValue struct {
	StructValue Struct
}

type VectorIndex struct {
	// Name of the index
	Name *string
	// Name of the endpoint associated with the index
	EndpointName *string
	// Primary key of the index
	PrimaryKey *string
	IndexType  VectorIndexType
	IndexSpec  isVectorIndex_IndexSpec
	Status     *VectorIndexStatus
	// The user who created the index.
	Creator *string
	// The subtype of the index.
	IndexSubtype IndexSubtype
	// ID of the endpoint associated with the index.
	EndpointId *string
}

type VectorIndexStatus struct {
	// Message associated with the index status
	Message *string
	// Number of rows indexed
	IndexedRowCount *int64
	// Whether the index is ready for search
	Ready *bool
	// Index API Url to be used to perform operations on the index
	IndexUrl *string
}

type VectorIndexType string

type VectorIndex_IndexSpec_DeltaSyncIndexSpec struct {
	DeltaSyncIndexSpec DeltaSyncVectorIndexSpec
}

type VectorIndex_IndexSpec_DirectAccessIndexSpec struct {
	DirectAccessIndexSpec DirectAccessVectorIndexSpec
}