vectorsearch

package
v0.73.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 19, 2025 License: Apache-2.0 Imports: 11 Imported by: 4

Documentation

Overview

These APIs allow you to manage Vector Search Endpoints, Vector Search Indexes, etc.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ColumnInfo

type ColumnInfo struct {
	// Name of the column.
	// Wire name: 'name'
	Name string `json:"name,omitempty"`

	ForceSendFields []string `json:"-" tf:"-"`
}

func (ColumnInfo) MarshalJSON

func (st ColumnInfo) MarshalJSON() ([]byte, error)

func (*ColumnInfo) UnmarshalJSON

func (st *ColumnInfo) UnmarshalJSON(b []byte) error

type CreateEndpoint

type CreateEndpoint struct {
	// The budget policy id to be applied
	// Wire name: 'budget_policy_id'
	BudgetPolicyId string `json:"budget_policy_id,omitempty"`
	// Type of endpoint
	// Wire name: 'endpoint_type'
	EndpointType EndpointType `json:"endpoint_type"`
	// Name of the vector search endpoint
	// Wire name: 'name'
	Name string `json:"name"`

	ForceSendFields []string `json:"-" tf:"-"`
}

func (CreateEndpoint) MarshalJSON added in v0.64.0

func (st CreateEndpoint) MarshalJSON() ([]byte, error)

func (*CreateEndpoint) UnmarshalJSON added in v0.64.0

func (st *CreateEndpoint) UnmarshalJSON(b []byte) error

type CreateVectorIndexRequest

type CreateVectorIndexRequest struct {
	// Specification for Delta Sync Index. Required if `index_type` is
	// `DELTA_SYNC`.
	// Wire name: 'delta_sync_index_spec'
	DeltaSyncIndexSpec *DeltaSyncVectorIndexSpecRequest `json:"delta_sync_index_spec,omitempty"`
	// Specification for Direct Vector Access Index. Required if `index_type` is
	// `DIRECT_ACCESS`.
	// Wire name: 'direct_access_index_spec'
	DirectAccessIndexSpec *DirectAccessVectorIndexSpec `json:"direct_access_index_spec,omitempty"`
	// Name of the endpoint to be used for serving the index
	// Wire name: 'endpoint_name'
	EndpointName string `json:"endpoint_name"`
	// There are 2 types of Vector 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. With this
	// model, the user manages index updates.
	// Wire name: 'index_type'
	IndexType VectorIndexType `json:"index_type"`
	// Name of the index
	// Wire name: 'name'
	Name string `json:"name"`
	// Primary key of the index
	// Wire name: 'primary_key'
	PrimaryKey string `json:"primary_key"`
}

func (CreateVectorIndexRequest) MarshalJSON

func (st CreateVectorIndexRequest) MarshalJSON() ([]byte, error)

func (*CreateVectorIndexRequest) UnmarshalJSON

func (st *CreateVectorIndexRequest) UnmarshalJSON(b []byte) error

type CustomTag added in v0.64.0

type CustomTag struct {
	// Key field for a vector search endpoint tag.
	// Wire name: 'key'
	Key string `json:"key"`
	// [Optional] Value field for a vector search endpoint tag.
	// Wire name: 'value'
	Value string `json:"value,omitempty"`

	ForceSendFields []string `json:"-" tf:"-"`
}

func (CustomTag) MarshalJSON added in v0.64.0

func (st CustomTag) MarshalJSON() ([]byte, error)

func (*CustomTag) UnmarshalJSON added in v0.64.0

func (st *CustomTag) UnmarshalJSON(b []byte) error

type DeleteDataResult

type DeleteDataResult struct {
	// List of primary keys for rows that failed to process.
	// Wire name: 'failed_primary_keys'
	FailedPrimaryKeys []string `json:"failed_primary_keys,omitempty"`
	// Count of successfully processed rows.
	// Wire name: 'success_row_count'
	SuccessRowCount int64 `json:"success_row_count,omitempty"`

	ForceSendFields []string `json:"-" tf:"-"`
}

func (DeleteDataResult) MarshalJSON

func (st DeleteDataResult) MarshalJSON() ([]byte, error)

func (*DeleteDataResult) UnmarshalJSON

func (st *DeleteDataResult) UnmarshalJSON(b []byte) error

type DeleteDataStatus

type DeleteDataStatus string
const DeleteDataStatusFailure DeleteDataStatus = `FAILURE`
const DeleteDataStatusPartialSuccess DeleteDataStatus = `PARTIAL_SUCCESS`
const DeleteDataStatusSuccess DeleteDataStatus = `SUCCESS`

func (*DeleteDataStatus) Set

func (f *DeleteDataStatus) Set(v string) error

Set raw string value and validate it against allowed values

func (*DeleteDataStatus) String

func (f *DeleteDataStatus) String() string

String representation for fmt.Print

func (*DeleteDataStatus) Type

func (f *DeleteDataStatus) Type() string

Type always returns DeleteDataStatus to satisfy [pflag.Value] interface

func (*DeleteDataStatus) Values added in v0.72.0

func (f *DeleteDataStatus) Values() []DeleteDataStatus

Values returns all possible values for DeleteDataStatus.

There is no guarantee on the order of the values in the slice.

type DeleteDataVectorIndexRequest

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

Delete data from index

func (DeleteDataVectorIndexRequest) MarshalJSON added in v0.73.0

func (st DeleteDataVectorIndexRequest) MarshalJSON() ([]byte, error)

func (*DeleteDataVectorIndexRequest) UnmarshalJSON added in v0.73.0

func (st *DeleteDataVectorIndexRequest) UnmarshalJSON(b []byte) error

type DeleteDataVectorIndexResponse

type DeleteDataVectorIndexResponse struct {
	// Result of the upsert or delete operation.
	// Wire name: 'result'
	Result *DeleteDataResult `json:"result,omitempty"`
	// Status of the delete operation.
	// Wire name: 'status'
	Status DeleteDataStatus `json:"status,omitempty"`
}

func (DeleteDataVectorIndexResponse) MarshalJSON added in v0.73.0

func (st DeleteDataVectorIndexResponse) MarshalJSON() ([]byte, error)

func (*DeleteDataVectorIndexResponse) UnmarshalJSON added in v0.73.0

func (st *DeleteDataVectorIndexResponse) UnmarshalJSON(b []byte) error

type DeleteEndpointRequest

type DeleteEndpointRequest struct {
	// Name of the vector search endpoint
	EndpointName string `json:"-" tf:"-"`
}

Delete an endpoint

func (DeleteEndpointRequest) MarshalJSON added in v0.73.0

func (st DeleteEndpointRequest) MarshalJSON() ([]byte, error)

func (*DeleteEndpointRequest) UnmarshalJSON added in v0.73.0

func (st *DeleteEndpointRequest) UnmarshalJSON(b []byte) error

type DeleteEndpointResponse added in v0.34.0

type DeleteEndpointResponse struct {
}

func (DeleteEndpointResponse) MarshalJSON added in v0.73.0

func (st DeleteEndpointResponse) MarshalJSON() ([]byte, error)

func (*DeleteEndpointResponse) UnmarshalJSON added in v0.73.0

func (st *DeleteEndpointResponse) UnmarshalJSON(b []byte) error

type DeleteIndexRequest

type DeleteIndexRequest struct {
	// Name of the index
	IndexName string `json:"-" tf:"-"`
}

Delete an index

func (DeleteIndexRequest) MarshalJSON added in v0.73.0

func (st DeleteIndexRequest) MarshalJSON() ([]byte, error)

func (*DeleteIndexRequest) UnmarshalJSON added in v0.73.0

func (st *DeleteIndexRequest) UnmarshalJSON(b []byte) error

type DeleteIndexResponse added in v0.34.0

type DeleteIndexResponse struct {
}

func (DeleteIndexResponse) MarshalJSON added in v0.73.0

func (st DeleteIndexResponse) MarshalJSON() ([]byte, error)

func (*DeleteIndexResponse) UnmarshalJSON added in v0.73.0

func (st *DeleteIndexResponse) UnmarshalJSON(b []byte) error

type DeltaSyncVectorIndexSpecRequest

type DeltaSyncVectorIndexSpecRequest struct {
	// [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.
	// Wire name: 'columns_to_sync'
	ColumnsToSync []string `json:"columns_to_sync,omitempty"`
	// The columns that contain the embedding source.
	// Wire name: 'embedding_source_columns'
	EmbeddingSourceColumns []EmbeddingSourceColumn `json:"embedding_source_columns,omitempty"`
	// The columns that contain the embedding vectors.
	// Wire name: 'embedding_vector_columns'
	EmbeddingVectorColumns []EmbeddingVectorColumn `json:"embedding_vector_columns,omitempty"`
	// [Optional] Name of the Delta table to sync the vector index contents and
	// computed embeddings to.
	// Wire name: 'embedding_writeback_table'
	EmbeddingWritebackTable string `json:"embedding_writeback_table,omitempty"`
	// 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.
	// Wire name: 'pipeline_type'
	PipelineType PipelineType `json:"pipeline_type,omitempty"`
	// The name of the source table.
	// Wire name: 'source_table'
	SourceTable string `json:"source_table,omitempty"`

	ForceSendFields []string `json:"-" tf:"-"`
}

func (DeltaSyncVectorIndexSpecRequest) MarshalJSON

func (st DeltaSyncVectorIndexSpecRequest) MarshalJSON() ([]byte, error)

func (*DeltaSyncVectorIndexSpecRequest) UnmarshalJSON

func (st *DeltaSyncVectorIndexSpecRequest) UnmarshalJSON(b []byte) error

type DeltaSyncVectorIndexSpecResponse

type DeltaSyncVectorIndexSpecResponse struct {
	// The columns that contain the embedding source.
	// Wire name: 'embedding_source_columns'
	EmbeddingSourceColumns []EmbeddingSourceColumn `json:"embedding_source_columns,omitempty"`
	// The columns that contain the embedding vectors.
	// Wire name: 'embedding_vector_columns'
	EmbeddingVectorColumns []EmbeddingVectorColumn `json:"embedding_vector_columns,omitempty"`
	// [Optional] Name of the Delta table to sync the vector index contents and
	// computed embeddings to.
	// Wire name: 'embedding_writeback_table'
	EmbeddingWritebackTable string `json:"embedding_writeback_table,omitempty"`
	// The ID of the pipeline that is used to sync the index.
	// Wire name: 'pipeline_id'
	PipelineId string `json:"pipeline_id,omitempty"`
	// 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.
	// Wire name: 'pipeline_type'
	PipelineType PipelineType `json:"pipeline_type,omitempty"`
	// The name of the source table.
	// Wire name: 'source_table'
	SourceTable string `json:"source_table,omitempty"`

	ForceSendFields []string `json:"-" tf:"-"`
}

func (DeltaSyncVectorIndexSpecResponse) MarshalJSON

func (st DeltaSyncVectorIndexSpecResponse) MarshalJSON() ([]byte, error)

func (*DeltaSyncVectorIndexSpecResponse) UnmarshalJSON

func (st *DeltaSyncVectorIndexSpecResponse) UnmarshalJSON(b []byte) error

type DirectAccessVectorIndexSpec

type DirectAccessVectorIndexSpec struct {
	// The columns that contain the embedding source. The format should be
	// array[double].
	// Wire name: 'embedding_source_columns'
	EmbeddingSourceColumns []EmbeddingSourceColumn `json:"embedding_source_columns,omitempty"`
	// The columns that contain the embedding vectors. The format should be
	// array[double].
	// Wire name: 'embedding_vector_columns'
	EmbeddingVectorColumns []EmbeddingVectorColumn `json:"embedding_vector_columns,omitempty"`
	// 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>`,`.
	// Wire name: 'schema_json'
	SchemaJson string `json:"schema_json,omitempty"`

	ForceSendFields []string `json:"-" tf:"-"`
}

func (DirectAccessVectorIndexSpec) MarshalJSON

func (st DirectAccessVectorIndexSpec) MarshalJSON() ([]byte, error)

func (*DirectAccessVectorIndexSpec) UnmarshalJSON

func (st *DirectAccessVectorIndexSpec) UnmarshalJSON(b []byte) error

type EmbeddingSourceColumn

type EmbeddingSourceColumn struct {
	// Name of the embedding model endpoint
	// Wire name: 'embedding_model_endpoint_name'
	EmbeddingModelEndpointName string `json:"embedding_model_endpoint_name,omitempty"`
	// Name of the column
	// Wire name: 'name'
	Name string `json:"name,omitempty"`

	ForceSendFields []string `json:"-" tf:"-"`
}

func (EmbeddingSourceColumn) MarshalJSON

func (st EmbeddingSourceColumn) MarshalJSON() ([]byte, error)

func (*EmbeddingSourceColumn) UnmarshalJSON

func (st *EmbeddingSourceColumn) UnmarshalJSON(b []byte) error

type EmbeddingVectorColumn

type EmbeddingVectorColumn struct {
	// Dimension of the embedding vector
	// Wire name: 'embedding_dimension'
	EmbeddingDimension int `json:"embedding_dimension,omitempty"`
	// Name of the column
	// Wire name: 'name'
	Name string `json:"name,omitempty"`

	ForceSendFields []string `json:"-" tf:"-"`
}

func (EmbeddingVectorColumn) MarshalJSON

func (st EmbeddingVectorColumn) MarshalJSON() ([]byte, error)

func (*EmbeddingVectorColumn) UnmarshalJSON

func (st *EmbeddingVectorColumn) UnmarshalJSON(b []byte) error

type EndpointInfo

type EndpointInfo struct {
	// Timestamp of endpoint creation
	// Wire name: 'creation_timestamp'
	CreationTimestamp int64 `json:"creation_timestamp,omitempty"`
	// Creator of the endpoint
	// Wire name: 'creator'
	Creator string `json:"creator,omitempty"`
	// The custom tags assigned to the endpoint
	// Wire name: 'custom_tags'
	CustomTags []CustomTag `json:"custom_tags,omitempty"`
	// The budget policy id applied to the endpoint
	// Wire name: 'effective_budget_policy_id'
	EffectiveBudgetPolicyId string `json:"effective_budget_policy_id,omitempty"`
	// Current status of the endpoint
	// Wire name: 'endpoint_status'
	EndpointStatus *EndpointStatus `json:"endpoint_status,omitempty"`
	// Type of endpoint
	// Wire name: 'endpoint_type'
	EndpointType EndpointType `json:"endpoint_type,omitempty"`
	// Unique identifier of the endpoint
	// Wire name: 'id'
	Id string `json:"id,omitempty"`
	// Timestamp of last update to the endpoint
	// Wire name: 'last_updated_timestamp'
	LastUpdatedTimestamp int64 `json:"last_updated_timestamp,omitempty"`
	// User who last updated the endpoint
	// Wire name: 'last_updated_user'
	LastUpdatedUser string `json:"last_updated_user,omitempty"`
	// Name of the vector search endpoint
	// Wire name: 'name'
	Name string `json:"name,omitempty"`
	// Number of indexes on the endpoint
	// Wire name: 'num_indexes'
	NumIndexes int `json:"num_indexes,omitempty"`

	ForceSendFields []string `json:"-" tf:"-"`
}

func (EndpointInfo) MarshalJSON

func (st EndpointInfo) MarshalJSON() ([]byte, error)

func (*EndpointInfo) UnmarshalJSON

func (st *EndpointInfo) UnmarshalJSON(b []byte) error

type EndpointStatus

type EndpointStatus struct {
	// Additional status message
	// Wire name: 'message'
	Message string `json:"message,omitempty"`
	// Current state of the endpoint
	// Wire name: 'state'
	State EndpointStatusState `json:"state,omitempty"`

	ForceSendFields []string `json:"-" tf:"-"`
}

Status information of an endpoint

func (EndpointStatus) MarshalJSON

func (st EndpointStatus) MarshalJSON() ([]byte, error)

func (*EndpointStatus) UnmarshalJSON

func (st *EndpointStatus) UnmarshalJSON(b []byte) error

type EndpointStatusState

type EndpointStatusState string

Current state of the endpoint

const EndpointStatusStateOffline EndpointStatusState = `OFFLINE`
const EndpointStatusStateOnline EndpointStatusState = `ONLINE`
const EndpointStatusStateProvisioning EndpointStatusState = `PROVISIONING`

func (*EndpointStatusState) Set

func (f *EndpointStatusState) Set(v string) error

Set raw string value and validate it against allowed values

func (*EndpointStatusState) String

func (f *EndpointStatusState) String() string

String representation for fmt.Print

func (*EndpointStatusState) Type

func (f *EndpointStatusState) Type() string

Type always returns EndpointStatusState to satisfy [pflag.Value] interface

func (*EndpointStatusState) Values added in v0.72.0

Values returns all possible values for EndpointStatusState.

There is no guarantee on the order of the values in the slice.

type EndpointType

type EndpointType string

Type of endpoint.

const EndpointTypeStandard EndpointType = `STANDARD`

func (*EndpointType) Set

func (f *EndpointType) Set(v string) error

Set raw string value and validate it against allowed values

func (*EndpointType) String

func (f *EndpointType) String() string

String representation for fmt.Print

func (*EndpointType) Type

func (f *EndpointType) Type() string

Type always returns EndpointType to satisfy [pflag.Value] interface

func (*EndpointType) Values added in v0.72.0

func (f *EndpointType) Values() []EndpointType

Values returns all possible values for EndpointType.

There is no guarantee on the order of the values in the slice.

type GetEndpointRequest

type GetEndpointRequest struct {
	// Name of the endpoint
	EndpointName string `json:"-" tf:"-"`
}

Get an endpoint

func (GetEndpointRequest) MarshalJSON added in v0.73.0

func (st GetEndpointRequest) MarshalJSON() ([]byte, error)

func (*GetEndpointRequest) UnmarshalJSON added in v0.73.0

func (st *GetEndpointRequest) UnmarshalJSON(b []byte) error

type GetIndexRequest

type GetIndexRequest struct {
	// Name of the index
	IndexName string `json:"-" tf:"-"`
}

Get an index

func (GetIndexRequest) MarshalJSON added in v0.73.0

func (st GetIndexRequest) MarshalJSON() ([]byte, error)

func (*GetIndexRequest) UnmarshalJSON added in v0.73.0

func (st *GetIndexRequest) UnmarshalJSON(b []byte) error

type ListEndpointResponse

type ListEndpointResponse struct {
	// An array of Endpoint objects
	// Wire name: 'endpoints'
	Endpoints []EndpointInfo `json:"endpoints,omitempty"`
	// A token that can be used to get the next page of results. If not present,
	// there are no more results to show.
	// Wire name: 'next_page_token'
	NextPageToken string `json:"next_page_token,omitempty"`

	ForceSendFields []string `json:"-" tf:"-"`
}

func (ListEndpointResponse) MarshalJSON

func (st ListEndpointResponse) MarshalJSON() ([]byte, error)

func (*ListEndpointResponse) UnmarshalJSON

func (st *ListEndpointResponse) UnmarshalJSON(b []byte) error

type ListEndpointsRequest

type ListEndpointsRequest struct {
	// Token for pagination
	PageToken string `json:"-" tf:"-"`

	ForceSendFields []string `json:"-" tf:"-"`
}

List all endpoints

func (ListEndpointsRequest) MarshalJSON

func (st ListEndpointsRequest) MarshalJSON() ([]byte, error)

func (*ListEndpointsRequest) UnmarshalJSON

func (st *ListEndpointsRequest) UnmarshalJSON(b []byte) error

type ListIndexesRequest

type ListIndexesRequest struct {
	// Name of the endpoint
	EndpointName string `json:"-" tf:"-"`
	// Token for pagination
	PageToken string `json:"-" tf:"-"`

	ForceSendFields []string `json:"-" tf:"-"`
}

List indexes

func (ListIndexesRequest) MarshalJSON

func (st ListIndexesRequest) MarshalJSON() ([]byte, error)

func (*ListIndexesRequest) UnmarshalJSON

func (st *ListIndexesRequest) UnmarshalJSON(b []byte) error

type ListValue added in v0.41.0

type ListValue struct {
	// Repeated field of dynamically typed values.
	// Wire name: 'values'
	Values []Value `json:"values,omitempty"`
}

func (ListValue) MarshalJSON added in v0.73.0

func (st ListValue) MarshalJSON() ([]byte, error)

func (*ListValue) UnmarshalJSON added in v0.73.0

func (st *ListValue) UnmarshalJSON(b []byte) error

type ListVectorIndexesResponse

type ListVectorIndexesResponse struct {
	// A token that can be used to get the next page of results. If not present,
	// there are no more results to show.
	// Wire name: 'next_page_token'
	NextPageToken string `json:"next_page_token,omitempty"`

	// Wire name: 'vector_indexes'
	VectorIndexes []MiniVectorIndex `json:"vector_indexes,omitempty"`

	ForceSendFields []string `json:"-" tf:"-"`
}

func (ListVectorIndexesResponse) MarshalJSON

func (st ListVectorIndexesResponse) MarshalJSON() ([]byte, error)

func (*ListVectorIndexesResponse) UnmarshalJSON

func (st *ListVectorIndexesResponse) UnmarshalJSON(b []byte) error

type MapStringValueEntry added in v0.41.0

type MapStringValueEntry struct {
	// Column name.
	// Wire name: 'key'
	Key string `json:"key,omitempty"`
	// Column value, nullable.
	// Wire name: 'value'
	Value *Value `json:"value,omitempty"`

	ForceSendFields []string `json:"-" tf:"-"`
}

Key-value pair.

func (MapStringValueEntry) MarshalJSON added in v0.41.0

func (st MapStringValueEntry) MarshalJSON() ([]byte, error)

func (*MapStringValueEntry) UnmarshalJSON added in v0.41.0

func (st *MapStringValueEntry) UnmarshalJSON(b []byte) error

type MiniVectorIndex

type MiniVectorIndex struct {
	// The user who created the index.
	// Wire name: 'creator'
	Creator string `json:"creator,omitempty"`
	// Name of the endpoint associated with the index
	// Wire name: 'endpoint_name'
	EndpointName string `json:"endpoint_name,omitempty"`
	// There are 2 types of Vector 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. With this
	// model, the user manages index updates.
	// Wire name: 'index_type'
	IndexType VectorIndexType `json:"index_type,omitempty"`
	// Name of the index
	// Wire name: 'name'
	Name string `json:"name,omitempty"`
	// Primary key of the index
	// Wire name: 'primary_key'
	PrimaryKey string `json:"primary_key,omitempty"`

	ForceSendFields []string `json:"-" tf:"-"`
}

func (MiniVectorIndex) MarshalJSON

func (st MiniVectorIndex) MarshalJSON() ([]byte, error)

func (*MiniVectorIndex) UnmarshalJSON

func (st *MiniVectorIndex) UnmarshalJSON(b []byte) error

type PatchEndpointBudgetPolicyRequest added in v0.64.0

type PatchEndpointBudgetPolicyRequest struct {
	// The budget policy id to be applied
	// Wire name: 'budget_policy_id'
	BudgetPolicyId string `json:"budget_policy_id"`
	// Name of the vector search endpoint
	EndpointName string `json:"-" tf:"-"`
}

func (PatchEndpointBudgetPolicyRequest) MarshalJSON added in v0.73.0

func (st PatchEndpointBudgetPolicyRequest) MarshalJSON() ([]byte, error)

func (*PatchEndpointBudgetPolicyRequest) UnmarshalJSON added in v0.73.0

func (st *PatchEndpointBudgetPolicyRequest) UnmarshalJSON(b []byte) error

type PatchEndpointBudgetPolicyResponse added in v0.64.0

type PatchEndpointBudgetPolicyResponse struct {
	// The budget policy applied to the vector search endpoint.
	// Wire name: 'effective_budget_policy_id'
	EffectiveBudgetPolicyId string `json:"effective_budget_policy_id,omitempty"`

	ForceSendFields []string `json:"-" tf:"-"`
}

func (PatchEndpointBudgetPolicyResponse) MarshalJSON added in v0.64.0

func (st PatchEndpointBudgetPolicyResponse) MarshalJSON() ([]byte, error)

func (*PatchEndpointBudgetPolicyResponse) UnmarshalJSON added in v0.64.0

func (st *PatchEndpointBudgetPolicyResponse) UnmarshalJSON(b []byte) error

type PipelineType

type PipelineType string

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.

const PipelineTypeContinuous PipelineType = `CONTINUOUS`

If the pipeline uses continuous execution, the pipeline processes new data as it arrives in the source table to keep vector index fresh.

const PipelineTypeTriggered PipelineType = `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.

func (*PipelineType) Set

func (f *PipelineType) Set(v string) error

Set raw string value and validate it against allowed values

func (*PipelineType) String

func (f *PipelineType) String() string

String representation for fmt.Print

func (*PipelineType) Type

func (f *PipelineType) Type() string

Type always returns PipelineType to satisfy [pflag.Value] interface

func (*PipelineType) Values added in v0.72.0

func (f *PipelineType) Values() []PipelineType

Values returns all possible values for PipelineType.

There is no guarantee on the order of the values in the slice.

type QueryVectorIndexNextPageRequest added in v0.43.0

type QueryVectorIndexNextPageRequest struct {
	// Name of the endpoint.
	// Wire name: 'endpoint_name'
	EndpointName string `json:"endpoint_name,omitempty"`
	// Name of the vector index to query.
	IndexName string `json:"-" tf:"-"`
	// Page token returned from previous `QueryVectorIndex` or
	// `QueryVectorIndexNextPage` API.
	// Wire name: 'page_token'
	PageToken string `json:"page_token,omitempty"`

	ForceSendFields []string `json:"-" tf:"-"`
}

Request payload for getting next page of results.

func (QueryVectorIndexNextPageRequest) MarshalJSON added in v0.43.0

func (st QueryVectorIndexNextPageRequest) MarshalJSON() ([]byte, error)

func (*QueryVectorIndexNextPageRequest) UnmarshalJSON added in v0.43.0

func (st *QueryVectorIndexNextPageRequest) UnmarshalJSON(b []byte) error

type QueryVectorIndexRequest

type QueryVectorIndexRequest struct {
	// List of column names to include in the response.
	// Wire name: 'columns'
	Columns []string `json:"columns"`
	// Column names used to retrieve data to send to the reranker.
	// Wire name: 'columns_to_rerank'
	ColumnsToRerank []string `json:"columns_to_rerank,omitempty"`
	// 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.
	// Wire name: 'filters_json'
	FiltersJson string `json:"filters_json,omitempty"`
	// Name of the vector index to query.
	IndexName string `json:"-" tf:"-"`
	// Number of results to return. Defaults to 10.
	// Wire name: 'num_results'
	NumResults int `json:"num_results,omitempty"`
	// Query text. Required for Delta Sync Index using model endpoint.
	// Wire name: 'query_text'
	QueryText string `json:"query_text,omitempty"`
	// The query type to use. Choices are `ANN` and `HYBRID`. Defaults to `ANN`.
	// Wire name: 'query_type'
	QueryType string `json:"query_type,omitempty"`
	// Query vector. Required for Direct Vector Access Index and Delta Sync
	// Index using self-managed vectors.
	// Wire name: 'query_vector'
	QueryVector []float64 `json:"query_vector,omitempty"`
	// Threshold for the approximate nearest neighbor search. Defaults to 0.0.
	// Wire name: 'score_threshold'
	ScoreThreshold float64 `json:"score_threshold,omitempty"`

	ForceSendFields []string `json:"-" tf:"-"`
}

func (QueryVectorIndexRequest) MarshalJSON

func (st QueryVectorIndexRequest) MarshalJSON() ([]byte, error)

func (*QueryVectorIndexRequest) UnmarshalJSON

func (st *QueryVectorIndexRequest) UnmarshalJSON(b []byte) error

type QueryVectorIndexResponse

type QueryVectorIndexResponse struct {
	// Metadata about the result set.
	// Wire name: 'manifest'
	Manifest *ResultManifest `json:"manifest,omitempty"`
	// [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.
	// Wire name: 'next_page_token'
	NextPageToken string `json:"next_page_token,omitempty"`
	// Data returned in the query result.
	// Wire name: 'result'
	Result *ResultData `json:"result,omitempty"`

	ForceSendFields []string `json:"-" tf:"-"`
}

func (QueryVectorIndexResponse) MarshalJSON added in v0.43.0

func (st QueryVectorIndexResponse) MarshalJSON() ([]byte, error)

func (*QueryVectorIndexResponse) UnmarshalJSON added in v0.43.0

func (st *QueryVectorIndexResponse) UnmarshalJSON(b []byte) error

type ResultData

type ResultData struct {
	// Data rows returned in the query.
	// Wire name: 'data_array'
	DataArray [][]string `json:"data_array,omitempty"`
	// Number of rows in the result set.
	// Wire name: 'row_count'
	RowCount int `json:"row_count,omitempty"`

	ForceSendFields []string `json:"-" tf:"-"`
}

Data returned in the query result.

func (ResultData) MarshalJSON

func (st ResultData) MarshalJSON() ([]byte, error)

func (*ResultData) UnmarshalJSON

func (st *ResultData) UnmarshalJSON(b []byte) error

type ResultManifest

type ResultManifest struct {
	// Number of columns in the result set.
	// Wire name: 'column_count'
	ColumnCount int `json:"column_count,omitempty"`
	// Information about each column in the result set.
	// Wire name: 'columns'
	Columns []ColumnInfo `json:"columns,omitempty"`

	ForceSendFields []string `json:"-" tf:"-"`
}

Metadata about the result set.

func (ResultManifest) MarshalJSON

func (st ResultManifest) MarshalJSON() ([]byte, error)

func (*ResultManifest) UnmarshalJSON

func (st *ResultManifest) UnmarshalJSON(b []byte) error

type ScanVectorIndexRequest added in v0.41.0

type ScanVectorIndexRequest struct {
	// Name of the vector index to scan.
	IndexName string `json:"-" tf:"-"`
	// Primary key of the last entry returned in the previous scan.
	// Wire name: 'last_primary_key'
	LastPrimaryKey string `json:"last_primary_key,omitempty"`
	// Number of results to return. Defaults to 10.
	// Wire name: 'num_results'
	NumResults int `json:"num_results,omitempty"`

	ForceSendFields []string `json:"-" tf:"-"`
}

func (ScanVectorIndexRequest) MarshalJSON added in v0.41.0

func (st ScanVectorIndexRequest) MarshalJSON() ([]byte, error)

func (*ScanVectorIndexRequest) UnmarshalJSON added in v0.41.0

func (st *ScanVectorIndexRequest) UnmarshalJSON(b []byte) error

type ScanVectorIndexResponse added in v0.41.0

type ScanVectorIndexResponse struct {
	// List of data entries
	// Wire name: 'data'
	Data []Struct `json:"data,omitempty"`
	// Primary key of the last entry.
	// Wire name: 'last_primary_key'
	LastPrimaryKey string `json:"last_primary_key,omitempty"`

	ForceSendFields []string `json:"-" tf:"-"`
}

Response to a scan vector index request.

func (ScanVectorIndexResponse) MarshalJSON added in v0.41.0

func (st ScanVectorIndexResponse) MarshalJSON() ([]byte, error)

func (*ScanVectorIndexResponse) UnmarshalJSON added in v0.41.0

func (st *ScanVectorIndexResponse) UnmarshalJSON(b []byte) error

type Struct added in v0.41.0

type Struct struct {
	// Data entry, corresponding to a row in a vector index.
	// Wire name: 'fields'
	Fields []MapStringValueEntry `json:"fields,omitempty"`
}

func (Struct) MarshalJSON added in v0.73.0

func (st Struct) MarshalJSON() ([]byte, error)

func (*Struct) UnmarshalJSON added in v0.73.0

func (st *Struct) UnmarshalJSON(b []byte) error

type SyncIndexRequest

type SyncIndexRequest struct {
	// Name of the vector index to synchronize. Must be a Delta Sync Index.
	IndexName string `json:"-" tf:"-"`
}

Synchronize an index

func (SyncIndexRequest) MarshalJSON added in v0.73.0

func (st SyncIndexRequest) MarshalJSON() ([]byte, error)

func (*SyncIndexRequest) UnmarshalJSON added in v0.73.0

func (st *SyncIndexRequest) UnmarshalJSON(b []byte) error

type SyncIndexResponse added in v0.34.0

type SyncIndexResponse struct {
}

func (SyncIndexResponse) MarshalJSON added in v0.73.0

func (st SyncIndexResponse) MarshalJSON() ([]byte, error)

func (*SyncIndexResponse) UnmarshalJSON added in v0.73.0

func (st *SyncIndexResponse) UnmarshalJSON(b []byte) error

type UpdateEndpointCustomTagsRequest added in v0.64.0

type UpdateEndpointCustomTagsRequest struct {
	// The new custom tags for the vector search endpoint
	// Wire name: 'custom_tags'
	CustomTags []CustomTag `json:"custom_tags"`
	// Name of the vector search endpoint
	EndpointName string `json:"-" tf:"-"`
}

func (UpdateEndpointCustomTagsRequest) MarshalJSON added in v0.73.0

func (st UpdateEndpointCustomTagsRequest) MarshalJSON() ([]byte, error)

func (*UpdateEndpointCustomTagsRequest) UnmarshalJSON added in v0.73.0

func (st *UpdateEndpointCustomTagsRequest) UnmarshalJSON(b []byte) error

type UpdateEndpointCustomTagsResponse added in v0.64.0

type UpdateEndpointCustomTagsResponse struct {
	// All the custom tags that are applied to the vector search endpoint.
	// Wire name: 'custom_tags'
	CustomTags []CustomTag `json:"custom_tags,omitempty"`
	// The name of the vector search endpoint whose custom tags were updated.
	// Wire name: 'name'
	Name string `json:"name,omitempty"`

	ForceSendFields []string `json:"-" tf:"-"`
}

func (UpdateEndpointCustomTagsResponse) MarshalJSON added in v0.64.0

func (st UpdateEndpointCustomTagsResponse) MarshalJSON() ([]byte, error)

func (*UpdateEndpointCustomTagsResponse) UnmarshalJSON added in v0.64.0

func (st *UpdateEndpointCustomTagsResponse) UnmarshalJSON(b []byte) error

type UpsertDataResult

type UpsertDataResult struct {
	// List of primary keys for rows that failed to process.
	// Wire name: 'failed_primary_keys'
	FailedPrimaryKeys []string `json:"failed_primary_keys,omitempty"`
	// Count of successfully processed rows.
	// Wire name: 'success_row_count'
	SuccessRowCount int64 `json:"success_row_count,omitempty"`

	ForceSendFields []string `json:"-" tf:"-"`
}

func (UpsertDataResult) MarshalJSON

func (st UpsertDataResult) MarshalJSON() ([]byte, error)

func (*UpsertDataResult) UnmarshalJSON

func (st *UpsertDataResult) UnmarshalJSON(b []byte) error

type UpsertDataStatus

type UpsertDataStatus string
const UpsertDataStatusFailure UpsertDataStatus = `FAILURE`
const UpsertDataStatusPartialSuccess UpsertDataStatus = `PARTIAL_SUCCESS`
const UpsertDataStatusSuccess UpsertDataStatus = `SUCCESS`

func (*UpsertDataStatus) Set

func (f *UpsertDataStatus) Set(v string) error

Set raw string value and validate it against allowed values

func (*UpsertDataStatus) String

func (f *UpsertDataStatus) String() string

String representation for fmt.Print

func (*UpsertDataStatus) Type

func (f *UpsertDataStatus) Type() string

Type always returns UpsertDataStatus to satisfy [pflag.Value] interface

func (*UpsertDataStatus) Values added in v0.72.0

func (f *UpsertDataStatus) Values() []UpsertDataStatus

Values returns all possible values for UpsertDataStatus.

There is no guarantee on the order of the values in the slice.

type UpsertDataVectorIndexRequest

type UpsertDataVectorIndexRequest struct {
	// Name of the vector index where data is to be upserted. Must be a Direct
	// Vector Access Index.
	IndexName string `json:"-" tf:"-"`
	// JSON string representing the data to be upserted.
	// Wire name: 'inputs_json'
	InputsJson string `json:"inputs_json"`
}

func (UpsertDataVectorIndexRequest) MarshalJSON added in v0.73.0

func (st UpsertDataVectorIndexRequest) MarshalJSON() ([]byte, error)

func (*UpsertDataVectorIndexRequest) UnmarshalJSON added in v0.73.0

func (st *UpsertDataVectorIndexRequest) UnmarshalJSON(b []byte) error

type UpsertDataVectorIndexResponse

type UpsertDataVectorIndexResponse struct {
	// Result of the upsert or delete operation.
	// Wire name: 'result'
	Result *UpsertDataResult `json:"result,omitempty"`
	// Status of the upsert operation.
	// Wire name: 'status'
	Status UpsertDataStatus `json:"status,omitempty"`
}

func (UpsertDataVectorIndexResponse) MarshalJSON added in v0.73.0

func (st UpsertDataVectorIndexResponse) MarshalJSON() ([]byte, error)

func (*UpsertDataVectorIndexResponse) UnmarshalJSON added in v0.73.0

func (st *UpsertDataVectorIndexResponse) UnmarshalJSON(b []byte) error

type Value added in v0.41.0

type Value struct {

	// Wire name: 'bool_value'
	BoolValue bool `json:"bool_value,omitempty"`

	// Wire name: 'list_value'
	ListValue *ListValue `json:"list_value,omitempty"`

	// Wire name: 'number_value'
	NumberValue float64 `json:"number_value,omitempty"`

	// Wire name: 'string_value'
	StringValue string `json:"string_value,omitempty"`

	// Wire name: 'struct_value'
	StructValue *Struct `json:"struct_value,omitempty"`

	ForceSendFields []string `json:"-" tf:"-"`
}

func (Value) MarshalJSON added in v0.41.0

func (st Value) MarshalJSON() ([]byte, error)

func (*Value) UnmarshalJSON added in v0.41.0

func (st *Value) UnmarshalJSON(b []byte) error

type VectorIndex

type VectorIndex struct {
	// The user who created the index.
	// Wire name: 'creator'
	Creator string `json:"creator,omitempty"`

	// Wire name: 'delta_sync_index_spec'
	DeltaSyncIndexSpec *DeltaSyncVectorIndexSpecResponse `json:"delta_sync_index_spec,omitempty"`

	// Wire name: 'direct_access_index_spec'
	DirectAccessIndexSpec *DirectAccessVectorIndexSpec `json:"direct_access_index_spec,omitempty"`
	// Name of the endpoint associated with the index
	// Wire name: 'endpoint_name'
	EndpointName string `json:"endpoint_name,omitempty"`
	// There are 2 types of Vector 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. With this
	// model, the user manages index updates.
	// Wire name: 'index_type'
	IndexType VectorIndexType `json:"index_type,omitempty"`
	// Name of the index
	// Wire name: 'name'
	Name string `json:"name,omitempty"`
	// Primary key of the index
	// Wire name: 'primary_key'
	PrimaryKey string `json:"primary_key,omitempty"`

	// Wire name: 'status'
	Status *VectorIndexStatus `json:"status,omitempty"`

	ForceSendFields []string `json:"-" tf:"-"`
}

func (VectorIndex) MarshalJSON

func (st VectorIndex) MarshalJSON() ([]byte, error)

func (*VectorIndex) UnmarshalJSON

func (st *VectorIndex) UnmarshalJSON(b []byte) error

type VectorIndexStatus

type VectorIndexStatus struct {
	// Index API Url to be used to perform operations on the index
	// Wire name: 'index_url'
	IndexUrl string `json:"index_url,omitempty"`
	// Number of rows indexed
	// Wire name: 'indexed_row_count'
	IndexedRowCount int64 `json:"indexed_row_count,omitempty"`
	// Message associated with the index status
	// Wire name: 'message'
	Message string `json:"message,omitempty"`
	// Whether the index is ready for search
	// Wire name: 'ready'
	Ready bool `json:"ready,omitempty"`

	ForceSendFields []string `json:"-" tf:"-"`
}

func (VectorIndexStatus) MarshalJSON

func (st VectorIndexStatus) MarshalJSON() ([]byte, error)

func (*VectorIndexStatus) UnmarshalJSON

func (st *VectorIndexStatus) UnmarshalJSON(b []byte) error

type VectorIndexType

type VectorIndexType string

There are 2 types of Vector 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. With this model, the user manages index updates.

const VectorIndexTypeDeltaSync VectorIndexType = `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.

const VectorIndexTypeDirectAccess VectorIndexType = `DIRECT_ACCESS`

An index that supports direct read and write of vectors and metadata through our REST and SDK APIs. With this model, the user manages index updates.

func (*VectorIndexType) Set

func (f *VectorIndexType) Set(v string) error

Set raw string value and validate it against allowed values

func (*VectorIndexType) String

func (f *VectorIndexType) String() string

String representation for fmt.Print

func (*VectorIndexType) Type

func (f *VectorIndexType) Type() string

Type always returns VectorIndexType to satisfy [pflag.Value] interface

func (*VectorIndexType) Values added in v0.72.0

func (f *VectorIndexType) Values() []VectorIndexType

Values returns all possible values for VectorIndexType.

There is no guarantee on the order of the values in the slice.

type VectorSearchEndpointsAPI

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

**Endpoint**: Represents the compute resources to host vector search indexes.

func NewVectorSearchEndpoints

func NewVectorSearchEndpoints(client *client.DatabricksClient) *VectorSearchEndpointsAPI

func (*VectorSearchEndpointsAPI) CreateEndpoint

Create a new endpoint.

func (*VectorSearchEndpointsAPI) CreateEndpointAndWait deprecated

func (a *VectorSearchEndpointsAPI) CreateEndpointAndWait(ctx context.Context, createEndpoint CreateEndpoint, options ...retries.Option[EndpointInfo]) (*EndpointInfo, error)

Calls VectorSearchEndpointsAPI.CreateEndpoint and waits to reach ONLINE state

You can override the default timeout of 20 minutes by calling adding retries.Timeout[EndpointInfo](60*time.Minute) functional option.

Deprecated: use VectorSearchEndpointsAPI.CreateEndpoint.Get() or VectorSearchEndpointsAPI.WaitGetEndpointVectorSearchEndpointOnline

func (*VectorSearchEndpointsAPI) DeleteEndpoint

func (a *VectorSearchEndpointsAPI) DeleteEndpoint(ctx context.Context, request DeleteEndpointRequest) error

func (*VectorSearchEndpointsAPI) DeleteEndpointByEndpointName

func (a *VectorSearchEndpointsAPI) DeleteEndpointByEndpointName(ctx context.Context, endpointName string) error

Delete a vector search endpoint.

func (*VectorSearchEndpointsAPI) GetEndpoint

func (a *VectorSearchEndpointsAPI) GetEndpoint(ctx context.Context, request GetEndpointRequest) (*EndpointInfo, error)

func (*VectorSearchEndpointsAPI) GetEndpointByEndpointName

func (a *VectorSearchEndpointsAPI) GetEndpointByEndpointName(ctx context.Context, endpointName string) (*EndpointInfo, error)

Get details for a single vector search endpoint.

func (*VectorSearchEndpointsAPI) ListEndpoints

func (a *VectorSearchEndpointsAPI) ListEndpoints(ctx context.Context, request ListEndpointsRequest) listing.Iterator[EndpointInfo]

List all vector search endpoints in the workspace.

func (*VectorSearchEndpointsAPI) ListEndpointsAll

func (a *VectorSearchEndpointsAPI) ListEndpointsAll(ctx context.Context, request ListEndpointsRequest) ([]EndpointInfo, error)

List all vector search endpoints in the workspace.

func (*VectorSearchEndpointsAPI) UpdateEndpointBudgetPolicy added in v0.64.0

func (a *VectorSearchEndpointsAPI) UpdateEndpointBudgetPolicy(ctx context.Context, request PatchEndpointBudgetPolicyRequest) (*PatchEndpointBudgetPolicyResponse, error)

func (*VectorSearchEndpointsAPI) UpdateEndpointCustomTags added in v0.64.0

func (a *VectorSearchEndpointsAPI) UpdateEndpointCustomTags(ctx context.Context, request UpdateEndpointCustomTagsRequest) (*UpdateEndpointCustomTagsResponse, error)

func (*VectorSearchEndpointsAPI) WaitGetEndpointVectorSearchEndpointOnline

func (a *VectorSearchEndpointsAPI) WaitGetEndpointVectorSearchEndpointOnline(ctx context.Context, endpointName string,
	timeout time.Duration, callback func(*EndpointInfo)) (*EndpointInfo, error)

WaitGetEndpointVectorSearchEndpointOnline repeatedly calls VectorSearchEndpointsAPI.GetEndpoint and waits to reach ONLINE state

type VectorSearchEndpointsInterface

type VectorSearchEndpointsInterface interface {

	// WaitGetEndpointVectorSearchEndpointOnline repeatedly calls [VectorSearchEndpointsAPI.GetEndpoint] and waits to reach ONLINE state
	WaitGetEndpointVectorSearchEndpointOnline(ctx context.Context, endpointName string,
		timeout time.Duration, callback func(*EndpointInfo)) (*EndpointInfo, error)

	// Create a new endpoint.
	CreateEndpoint(ctx context.Context, createEndpoint CreateEndpoint) (*WaitGetEndpointVectorSearchEndpointOnline[EndpointInfo], error)

	// Calls [VectorSearchEndpointsAPIInterface.CreateEndpoint] and waits to reach ONLINE state
	//
	// You can override the default timeout of 20 minutes by calling adding
	// retries.Timeout[EndpointInfo](60*time.Minute) functional option.
	//
	// Deprecated: use [VectorSearchEndpointsAPIInterface.CreateEndpoint].Get() or [VectorSearchEndpointsAPIInterface.WaitGetEndpointVectorSearchEndpointOnline]
	CreateEndpointAndWait(ctx context.Context, createEndpoint CreateEndpoint, options ...retries.Option[EndpointInfo]) (*EndpointInfo, error)

	// Delete a vector search endpoint.
	DeleteEndpoint(ctx context.Context, request DeleteEndpointRequest) error

	// Delete a vector search endpoint.
	DeleteEndpointByEndpointName(ctx context.Context, endpointName string) error

	// Get details for a single vector search endpoint.
	GetEndpoint(ctx context.Context, request GetEndpointRequest) (*EndpointInfo, error)

	// Get details for a single vector search endpoint.
	GetEndpointByEndpointName(ctx context.Context, endpointName string) (*EndpointInfo, error)

	// List all vector search endpoints in the workspace.
	//
	// This method is generated by Databricks SDK Code Generator.
	ListEndpoints(ctx context.Context, request ListEndpointsRequest) listing.Iterator[EndpointInfo]

	// List all vector search endpoints in the workspace.
	//
	// This method is generated by Databricks SDK Code Generator.
	ListEndpointsAll(ctx context.Context, request ListEndpointsRequest) ([]EndpointInfo, error)

	// Update the budget policy of an endpoint
	UpdateEndpointBudgetPolicy(ctx context.Context, request PatchEndpointBudgetPolicyRequest) (*PatchEndpointBudgetPolicyResponse, error)

	// Update the custom tags of an endpoint.
	UpdateEndpointCustomTags(ctx context.Context, request UpdateEndpointCustomTagsRequest) (*UpdateEndpointCustomTagsResponse, error)
}

type VectorSearchEndpointsService deprecated

type VectorSearchEndpointsService interface {

	// Create a new endpoint.
	CreateEndpoint(ctx context.Context, request CreateEndpoint) (*EndpointInfo, error)

	// Delete a vector search endpoint.
	DeleteEndpoint(ctx context.Context, request DeleteEndpointRequest) error

	// Get details for a single vector search endpoint.
	GetEndpoint(ctx context.Context, request GetEndpointRequest) (*EndpointInfo, error)

	// List all vector search endpoints in the workspace.
	ListEndpoints(ctx context.Context, request ListEndpointsRequest) (*ListEndpointResponse, error)

	// Update the budget policy of an endpoint
	UpdateEndpointBudgetPolicy(ctx context.Context, request PatchEndpointBudgetPolicyRequest) (*PatchEndpointBudgetPolicyResponse, error)

	// Update the custom tags of an endpoint.
	UpdateEndpointCustomTags(ctx context.Context, request UpdateEndpointCustomTagsRequest) (*UpdateEndpointCustomTagsResponse, error)
}

**Endpoint**: Represents the compute resources to host vector search indexes.

Deprecated: Do not use this interface, it will be removed in a future version of the SDK.

type VectorSearchIndexesAPI

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

**Index**: An efficient representation of your embedding vectors that supports real-time and efficient approximate nearest neighbor (ANN) search queries.

There are 2 types of Vector Search indexes: - **Delta Sync Index**: 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 Vector Access Index**: An index that supports direct read and write of vectors and metadata through our REST and SDK APIs. With this model, the user manages index updates.

func NewVectorSearchIndexes

func NewVectorSearchIndexes(client *client.DatabricksClient) *VectorSearchIndexesAPI

func (*VectorSearchIndexesAPI) CreateIndex

func (a *VectorSearchIndexesAPI) CreateIndex(ctx context.Context, request CreateVectorIndexRequest) (*VectorIndex, error)

func (*VectorSearchIndexesAPI) DeleteDataVectorIndex

func (a *VectorSearchIndexesAPI) DeleteDataVectorIndex(ctx context.Context, request DeleteDataVectorIndexRequest) (*DeleteDataVectorIndexResponse, error)

func (*VectorSearchIndexesAPI) DeleteDataVectorIndexByIndexName added in v0.64.0

func (a *VectorSearchIndexesAPI) DeleteDataVectorIndexByIndexName(ctx context.Context, indexName string) (*DeleteDataVectorIndexResponse, error)

Handles the deletion of data from a specified vector index.

func (*VectorSearchIndexesAPI) DeleteIndex

func (a *VectorSearchIndexesAPI) DeleteIndex(ctx context.Context, request DeleteIndexRequest) error

func (*VectorSearchIndexesAPI) DeleteIndexByIndexName

func (a *VectorSearchIndexesAPI) DeleteIndexByIndexName(ctx context.Context, indexName string) error

Delete an index.

func (*VectorSearchIndexesAPI) GetIndex

func (a *VectorSearchIndexesAPI) GetIndex(ctx context.Context, request GetIndexRequest) (*VectorIndex, error)

func (*VectorSearchIndexesAPI) GetIndexByIndexName

func (a *VectorSearchIndexesAPI) GetIndexByIndexName(ctx context.Context, indexName string) (*VectorIndex, error)

Get an index.

func (*VectorSearchIndexesAPI) ListIndexes

func (a *VectorSearchIndexesAPI) ListIndexes(ctx context.Context, request ListIndexesRequest) listing.Iterator[MiniVectorIndex]

List all indexes in the given endpoint.

func (*VectorSearchIndexesAPI) ListIndexesAll

func (a *VectorSearchIndexesAPI) ListIndexesAll(ctx context.Context, request ListIndexesRequest) ([]MiniVectorIndex, error)

List all indexes in the given endpoint.

func (*VectorSearchIndexesAPI) QueryIndex

func (a *VectorSearchIndexesAPI) QueryIndex(ctx context.Context, request QueryVectorIndexRequest) (*QueryVectorIndexResponse, error)

func (*VectorSearchIndexesAPI) QueryNextPage added in v0.43.0

func (a *VectorSearchIndexesAPI) QueryNextPage(ctx context.Context, request QueryVectorIndexNextPageRequest) (*QueryVectorIndexResponse, error)

func (*VectorSearchIndexesAPI) ScanIndex added in v0.41.0

func (a *VectorSearchIndexesAPI) ScanIndex(ctx context.Context, request ScanVectorIndexRequest) (*ScanVectorIndexResponse, error)

func (*VectorSearchIndexesAPI) SyncIndex

func (a *VectorSearchIndexesAPI) SyncIndex(ctx context.Context, request SyncIndexRequest) error

func (*VectorSearchIndexesAPI) UpsertDataVectorIndex

func (a *VectorSearchIndexesAPI) UpsertDataVectorIndex(ctx context.Context, request UpsertDataVectorIndexRequest) (*UpsertDataVectorIndexResponse, error)

type VectorSearchIndexesInterface

type VectorSearchIndexesInterface interface {

	// Create a new index.
	CreateIndex(ctx context.Context, request CreateVectorIndexRequest) (*VectorIndex, error)

	// Handles the deletion of data from a specified vector index.
	DeleteDataVectorIndex(ctx context.Context, request DeleteDataVectorIndexRequest) (*DeleteDataVectorIndexResponse, error)

	// Handles the deletion of data from a specified vector index.
	DeleteDataVectorIndexByIndexName(ctx context.Context, indexName string) (*DeleteDataVectorIndexResponse, error)

	// Delete an index.
	DeleteIndex(ctx context.Context, request DeleteIndexRequest) error

	// Delete an index.
	DeleteIndexByIndexName(ctx context.Context, indexName string) error

	// Get an index.
	GetIndex(ctx context.Context, request GetIndexRequest) (*VectorIndex, error)

	// Get an index.
	GetIndexByIndexName(ctx context.Context, indexName string) (*VectorIndex, error)

	// List all indexes in the given endpoint.
	//
	// This method is generated by Databricks SDK Code Generator.
	ListIndexes(ctx context.Context, request ListIndexesRequest) listing.Iterator[MiniVectorIndex]

	// List all indexes in the given endpoint.
	//
	// This method is generated by Databricks SDK Code Generator.
	ListIndexesAll(ctx context.Context, request ListIndexesRequest) ([]MiniVectorIndex, error)

	// Query the specified vector index.
	QueryIndex(ctx context.Context, request QueryVectorIndexRequest) (*QueryVectorIndexResponse, error)

	// Use `next_page_token` returned from previous `QueryVectorIndex` or
	// `QueryVectorIndexNextPage` request to fetch next page of results.
	QueryNextPage(ctx context.Context, request QueryVectorIndexNextPageRequest) (*QueryVectorIndexResponse, error)

	// Scan the specified vector index and return the first `num_results` entries
	// after the exclusive `primary_key`.
	ScanIndex(ctx context.Context, request ScanVectorIndexRequest) (*ScanVectorIndexResponse, error)

	// Triggers a synchronization process for a specified vector index.
	SyncIndex(ctx context.Context, request SyncIndexRequest) error

	// Handles the upserting of data into a specified vector index.
	UpsertDataVectorIndex(ctx context.Context, request UpsertDataVectorIndexRequest) (*UpsertDataVectorIndexResponse, error)
}

type VectorSearchIndexesService deprecated

type VectorSearchIndexesService interface {

	// Create a new index.
	CreateIndex(ctx context.Context, request CreateVectorIndexRequest) (*VectorIndex, error)

	// Handles the deletion of data from a specified vector index.
	DeleteDataVectorIndex(ctx context.Context, request DeleteDataVectorIndexRequest) (*DeleteDataVectorIndexResponse, error)

	// Delete an index.
	DeleteIndex(ctx context.Context, request DeleteIndexRequest) error

	// Get an index.
	GetIndex(ctx context.Context, request GetIndexRequest) (*VectorIndex, error)

	// List all indexes in the given endpoint.
	ListIndexes(ctx context.Context, request ListIndexesRequest) (*ListVectorIndexesResponse, error)

	// Query the specified vector index.
	QueryIndex(ctx context.Context, request QueryVectorIndexRequest) (*QueryVectorIndexResponse, error)

	// Use `next_page_token` returned from previous `QueryVectorIndex` or
	// `QueryVectorIndexNextPage` request to fetch next page of results.
	QueryNextPage(ctx context.Context, request QueryVectorIndexNextPageRequest) (*QueryVectorIndexResponse, error)

	// Scan the specified vector index and return the first `num_results`
	// entries after the exclusive `primary_key`.
	ScanIndex(ctx context.Context, request ScanVectorIndexRequest) (*ScanVectorIndexResponse, error)

	// Triggers a synchronization process for a specified vector index.
	SyncIndex(ctx context.Context, request SyncIndexRequest) error

	// Handles the upserting of data into a specified vector index.
	UpsertDataVectorIndex(ctx context.Context, request UpsertDataVectorIndexRequest) (*UpsertDataVectorIndexResponse, error)
}

**Index**: An efficient representation of your embedding vectors that supports real-time and efficient approximate nearest neighbor (ANN) search queries.

There are 2 types of Vector Search indexes: - **Delta Sync Index**: 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 Vector Access Index**: An index that supports direct read and write of vectors and metadata through our REST and SDK APIs. With this model, the user manages index updates.

Deprecated: Do not use this interface, it will be removed in a future version of the SDK.

type WaitGetEndpointVectorSearchEndpointOnline

type WaitGetEndpointVectorSearchEndpointOnline[R any] struct {
	Response     *R
	EndpointName string `json:"endpoint_name"`
	Poll         func(time.Duration, func(*EndpointInfo)) (*EndpointInfo, error)
	// contains filtered or unexported fields
}

WaitGetEndpointVectorSearchEndpointOnline is a wrapper that calls VectorSearchEndpointsAPI.WaitGetEndpointVectorSearchEndpointOnline and waits to reach ONLINE state.

func (*WaitGetEndpointVectorSearchEndpointOnline[R]) Get

Get the EndpointInfo with the default timeout of 20 minutes.

func (*WaitGetEndpointVectorSearchEndpointOnline[R]) GetWithTimeout

func (w *WaitGetEndpointVectorSearchEndpointOnline[R]) GetWithTimeout(timeout time.Duration) (*EndpointInfo, error)

Get the EndpointInfo with custom timeout.

func (*WaitGetEndpointVectorSearchEndpointOnline[R]) OnProgress

OnProgress invokes a callback every time it polls for the status update.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL