vectorsearch_tf

package
v1.57.0 Latest Latest
Warning

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

Go to latest
Published: Nov 6, 2024 License: Apache-2.0 Imports: 1 Imported by: 0

Documentation

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.
	Name types.String `tfsdk:"name" tf:"optional"`
}

func (*ColumnInfo) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0

func (newState *ColumnInfo) SyncEffectiveFieldsDuringCreateOrUpdate(plan ColumnInfo)

func (*ColumnInfo) SyncEffectiveFieldsDuringRead added in v1.54.0

func (newState *ColumnInfo) SyncEffectiveFieldsDuringRead(existingState ColumnInfo)

type CreateEndpoint

type CreateEndpoint struct {
	// Type of endpoint.
	EndpointType types.String `tfsdk:"endpoint_type" tf:""`
	// Name of endpoint
	Name types.String `tfsdk:"name" tf:""`
}

func (*CreateEndpoint) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0

func (newState *CreateEndpoint) SyncEffectiveFieldsDuringCreateOrUpdate(plan CreateEndpoint)

func (*CreateEndpoint) SyncEffectiveFieldsDuringRead added in v1.54.0

func (newState *CreateEndpoint) SyncEffectiveFieldsDuringRead(existingState CreateEndpoint)

type CreateVectorIndexRequest

type CreateVectorIndexRequest struct {
	// Specification for Delta Sync Index. Required if `index_type` is
	// `DELTA_SYNC`.
	DeltaSyncIndexSpec []DeltaSyncVectorIndexSpecRequest `tfsdk:"delta_sync_index_spec" tf:"optional,object"`
	// Specification for Direct Vector Access Index. Required if `index_type` is
	// `DIRECT_ACCESS`.
	DirectAccessIndexSpec []DirectAccessVectorIndexSpec `tfsdk:"direct_access_index_spec" tf:"optional,object"`
	// Name of the endpoint to be used for serving the index
	EndpointName types.String `tfsdk:"endpoint_name" tf:""`
	// 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.
	IndexType types.String `tfsdk:"index_type" tf:""`
	// Name of the index
	Name types.String `tfsdk:"name" tf:""`
	// Primary key of the index
	PrimaryKey types.String `tfsdk:"primary_key" tf:""`
}

func (*CreateVectorIndexRequest) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0

func (newState *CreateVectorIndexRequest) SyncEffectiveFieldsDuringCreateOrUpdate(plan CreateVectorIndexRequest)

func (*CreateVectorIndexRequest) SyncEffectiveFieldsDuringRead added in v1.54.0

func (newState *CreateVectorIndexRequest) SyncEffectiveFieldsDuringRead(existingState CreateVectorIndexRequest)

type CreateVectorIndexResponse

type CreateVectorIndexResponse struct {
	VectorIndex []VectorIndex `tfsdk:"vector_index" tf:"optional,object"`
}

func (*CreateVectorIndexResponse) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0

func (newState *CreateVectorIndexResponse) SyncEffectiveFieldsDuringCreateOrUpdate(plan CreateVectorIndexResponse)

func (*CreateVectorIndexResponse) SyncEffectiveFieldsDuringRead added in v1.54.0

func (newState *CreateVectorIndexResponse) SyncEffectiveFieldsDuringRead(existingState CreateVectorIndexResponse)

type DeleteDataResult

type DeleteDataResult struct {
	// List of primary keys for rows that failed to process.
	FailedPrimaryKeys []types.String `tfsdk:"failed_primary_keys" tf:"optional"`
	// Count of successfully processed rows.
	SuccessRowCount types.Int64 `tfsdk:"success_row_count" tf:"optional"`
}

Result of the upsert or delete operation.

func (*DeleteDataResult) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0

func (newState *DeleteDataResult) SyncEffectiveFieldsDuringCreateOrUpdate(plan DeleteDataResult)

func (*DeleteDataResult) SyncEffectiveFieldsDuringRead added in v1.54.0

func (newState *DeleteDataResult) SyncEffectiveFieldsDuringRead(existingState DeleteDataResult)

type DeleteDataVectorIndexRequest

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

Request payload for deleting data from a vector index.

func (*DeleteDataVectorIndexRequest) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0

func (newState *DeleteDataVectorIndexRequest) SyncEffectiveFieldsDuringCreateOrUpdate(plan DeleteDataVectorIndexRequest)

func (*DeleteDataVectorIndexRequest) SyncEffectiveFieldsDuringRead added in v1.54.0

func (newState *DeleteDataVectorIndexRequest) SyncEffectiveFieldsDuringRead(existingState DeleteDataVectorIndexRequest)

type DeleteDataVectorIndexResponse

type DeleteDataVectorIndexResponse struct {
	// Result of the upsert or delete operation.
	Result []DeleteDataResult `tfsdk:"result" tf:"optional,object"`
	// Status of the delete operation.
	Status types.String `tfsdk:"status" tf:"optional"`
}

Response to a delete data vector index request.

func (*DeleteDataVectorIndexResponse) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0

func (newState *DeleteDataVectorIndexResponse) SyncEffectiveFieldsDuringCreateOrUpdate(plan DeleteDataVectorIndexResponse)

func (*DeleteDataVectorIndexResponse) SyncEffectiveFieldsDuringRead added in v1.54.0

func (newState *DeleteDataVectorIndexResponse) SyncEffectiveFieldsDuringRead(existingState DeleteDataVectorIndexResponse)

type DeleteEndpointRequest

type DeleteEndpointRequest struct {
	// Name of the endpoint
	EndpointName types.String `tfsdk:"-"`
}

Delete an endpoint

func (*DeleteEndpointRequest) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0

func (newState *DeleteEndpointRequest) SyncEffectiveFieldsDuringCreateOrUpdate(plan DeleteEndpointRequest)

func (*DeleteEndpointRequest) SyncEffectiveFieldsDuringRead added in v1.54.0

func (newState *DeleteEndpointRequest) SyncEffectiveFieldsDuringRead(existingState DeleteEndpointRequest)

type DeleteEndpointResponse

type DeleteEndpointResponse struct {
}

func (*DeleteEndpointResponse) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0

func (newState *DeleteEndpointResponse) SyncEffectiveFieldsDuringCreateOrUpdate(plan DeleteEndpointResponse)

func (*DeleteEndpointResponse) SyncEffectiveFieldsDuringRead added in v1.54.0

func (newState *DeleteEndpointResponse) SyncEffectiveFieldsDuringRead(existingState DeleteEndpointResponse)

type DeleteIndexRequest

type DeleteIndexRequest struct {
	// Name of the index
	IndexName types.String `tfsdk:"-"`
}

Delete an index

func (*DeleteIndexRequest) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0

func (newState *DeleteIndexRequest) SyncEffectiveFieldsDuringCreateOrUpdate(plan DeleteIndexRequest)

func (*DeleteIndexRequest) SyncEffectiveFieldsDuringRead added in v1.54.0

func (newState *DeleteIndexRequest) SyncEffectiveFieldsDuringRead(existingState DeleteIndexRequest)

type DeleteIndexResponse

type DeleteIndexResponse struct {
}

func (*DeleteIndexResponse) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0

func (newState *DeleteIndexResponse) SyncEffectiveFieldsDuringCreateOrUpdate(plan DeleteIndexResponse)

func (*DeleteIndexResponse) SyncEffectiveFieldsDuringRead added in v1.54.0

func (newState *DeleteIndexResponse) SyncEffectiveFieldsDuringRead(existingState DeleteIndexResponse)

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.
	ColumnsToSync []types.String `tfsdk:"columns_to_sync" tf:"optional"`
	// The columns that contain the embedding source.
	EmbeddingSourceColumns []EmbeddingSourceColumn `tfsdk:"embedding_source_columns" tf:"optional"`
	// The columns that contain the embedding vectors. The format should be
	// array[double].
	EmbeddingVectorColumns []EmbeddingVectorColumn `tfsdk:"embedding_vector_columns" tf:"optional"`
	// [Optional] Automatically sync the vector index contents and computed
	// embeddings to the specified Delta table. The only supported table name is
	// the index name with the suffix `_writeback_table`.
	EmbeddingWritebackTable types.String `tfsdk:"embedding_writeback_table" tf:"optional"`
	// 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 types.String `tfsdk:"pipeline_type" tf:"optional"`
	// The name of the source table.
	SourceTable types.String `tfsdk:"source_table" tf:"optional"`
}

func (*DeltaSyncVectorIndexSpecRequest) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0

func (newState *DeltaSyncVectorIndexSpecRequest) SyncEffectiveFieldsDuringCreateOrUpdate(plan DeltaSyncVectorIndexSpecRequest)

func (*DeltaSyncVectorIndexSpecRequest) SyncEffectiveFieldsDuringRead added in v1.54.0

func (newState *DeltaSyncVectorIndexSpecRequest) SyncEffectiveFieldsDuringRead(existingState DeltaSyncVectorIndexSpecRequest)

type DeltaSyncVectorIndexSpecResponse

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

func (*DeltaSyncVectorIndexSpecResponse) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0

func (newState *DeltaSyncVectorIndexSpecResponse) SyncEffectiveFieldsDuringCreateOrUpdate(plan DeltaSyncVectorIndexSpecResponse)

func (*DeltaSyncVectorIndexSpecResponse) SyncEffectiveFieldsDuringRead added in v1.54.0

func (newState *DeltaSyncVectorIndexSpecResponse) SyncEffectiveFieldsDuringRead(existingState DeltaSyncVectorIndexSpecResponse)

type DirectAccessVectorIndexSpec

type DirectAccessVectorIndexSpec struct {
	// Contains the optional model endpoint to use during query time.
	EmbeddingSourceColumns []EmbeddingSourceColumn `tfsdk:"embedding_source_columns" tf:"optional"`

	EmbeddingVectorColumns []EmbeddingVectorColumn `tfsdk:"embedding_vector_columns" tf:"optional"`
	// 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 types.String `tfsdk:"schema_json" tf:"optional"`
}

func (*DirectAccessVectorIndexSpec) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0

func (newState *DirectAccessVectorIndexSpec) SyncEffectiveFieldsDuringCreateOrUpdate(plan DirectAccessVectorIndexSpec)

func (*DirectAccessVectorIndexSpec) SyncEffectiveFieldsDuringRead added in v1.54.0

func (newState *DirectAccessVectorIndexSpec) SyncEffectiveFieldsDuringRead(existingState DirectAccessVectorIndexSpec)

type EmbeddingSourceColumn

type EmbeddingSourceColumn struct {
	// Name of the embedding model endpoint
	EmbeddingModelEndpointName types.String `tfsdk:"embedding_model_endpoint_name" tf:"optional"`
	// Name of the column
	Name types.String `tfsdk:"name" tf:"optional"`
}

func (*EmbeddingSourceColumn) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0

func (newState *EmbeddingSourceColumn) SyncEffectiveFieldsDuringCreateOrUpdate(plan EmbeddingSourceColumn)

func (*EmbeddingSourceColumn) SyncEffectiveFieldsDuringRead added in v1.54.0

func (newState *EmbeddingSourceColumn) SyncEffectiveFieldsDuringRead(existingState EmbeddingSourceColumn)

type EmbeddingVectorColumn

type EmbeddingVectorColumn struct {
	// Dimension of the embedding vector
	EmbeddingDimension types.Int64 `tfsdk:"embedding_dimension" tf:"optional"`
	// Name of the column
	Name types.String `tfsdk:"name" tf:"optional"`
}

func (*EmbeddingVectorColumn) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0

func (newState *EmbeddingVectorColumn) SyncEffectiveFieldsDuringCreateOrUpdate(plan EmbeddingVectorColumn)

func (*EmbeddingVectorColumn) SyncEffectiveFieldsDuringRead added in v1.54.0

func (newState *EmbeddingVectorColumn) SyncEffectiveFieldsDuringRead(existingState EmbeddingVectorColumn)

type EndpointInfo

type EndpointInfo struct {
	// Timestamp of endpoint creation
	CreationTimestamp types.Int64 `tfsdk:"creation_timestamp" tf:"optional"`
	// Creator of the endpoint
	Creator types.String `tfsdk:"creator" tf:"optional"`
	// Current status of the endpoint
	EndpointStatus []EndpointStatus `tfsdk:"endpoint_status" tf:"optional,object"`
	// Type of endpoint.
	EndpointType types.String `tfsdk:"endpoint_type" tf:"optional"`
	// Unique identifier of the endpoint
	Id types.String `tfsdk:"id" tf:"optional"`
	// Timestamp of last update to the endpoint
	LastUpdatedTimestamp types.Int64 `tfsdk:"last_updated_timestamp" tf:"optional"`
	// User who last updated the endpoint
	LastUpdatedUser types.String `tfsdk:"last_updated_user" tf:"optional"`
	// Name of endpoint
	Name types.String `tfsdk:"name" tf:"optional"`
	// Number of indexes on the endpoint
	NumIndexes types.Int64 `tfsdk:"num_indexes" tf:"optional"`
}

func (*EndpointInfo) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0

func (newState *EndpointInfo) SyncEffectiveFieldsDuringCreateOrUpdate(plan EndpointInfo)

func (*EndpointInfo) SyncEffectiveFieldsDuringRead added in v1.54.0

func (newState *EndpointInfo) SyncEffectiveFieldsDuringRead(existingState EndpointInfo)

type EndpointStatus

type EndpointStatus struct {
	// Additional status message
	Message types.String `tfsdk:"message" tf:"optional"`
	// Current state of the endpoint
	State types.String `tfsdk:"state" tf:"optional"`
}

Status information of an endpoint

func (*EndpointStatus) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0

func (newState *EndpointStatus) SyncEffectiveFieldsDuringCreateOrUpdate(plan EndpointStatus)

func (*EndpointStatus) SyncEffectiveFieldsDuringRead added in v1.54.0

func (newState *EndpointStatus) SyncEffectiveFieldsDuringRead(existingState EndpointStatus)

type GetEndpointRequest

type GetEndpointRequest struct {
	// Name of the endpoint
	EndpointName types.String `tfsdk:"-"`
}

Get an endpoint

func (*GetEndpointRequest) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0

func (newState *GetEndpointRequest) SyncEffectiveFieldsDuringCreateOrUpdate(plan GetEndpointRequest)

func (*GetEndpointRequest) SyncEffectiveFieldsDuringRead added in v1.54.0

func (newState *GetEndpointRequest) SyncEffectiveFieldsDuringRead(existingState GetEndpointRequest)

type GetIndexRequest

type GetIndexRequest struct {
	// Name of the index
	IndexName types.String `tfsdk:"-"`
}

Get an index

func (*GetIndexRequest) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0

func (newState *GetIndexRequest) SyncEffectiveFieldsDuringCreateOrUpdate(plan GetIndexRequest)

func (*GetIndexRequest) SyncEffectiveFieldsDuringRead added in v1.54.0

func (newState *GetIndexRequest) SyncEffectiveFieldsDuringRead(existingState GetIndexRequest)

type ListEndpointResponse

type ListEndpointResponse struct {
	// An array of Endpoint objects
	Endpoints []EndpointInfo `tfsdk:"endpoints" tf:"optional"`
	// A token that can be used to get the next page of results. If not present,
	// there are no more results to show.
	NextPageToken types.String `tfsdk:"next_page_token" tf:"optional"`
}

func (*ListEndpointResponse) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0

func (newState *ListEndpointResponse) SyncEffectiveFieldsDuringCreateOrUpdate(plan ListEndpointResponse)

func (*ListEndpointResponse) SyncEffectiveFieldsDuringRead added in v1.54.0

func (newState *ListEndpointResponse) SyncEffectiveFieldsDuringRead(existingState ListEndpointResponse)

type ListEndpointsRequest

type ListEndpointsRequest struct {
	// Token for pagination
	PageToken types.String `tfsdk:"-"`
}

List all endpoints

func (*ListEndpointsRequest) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0

func (newState *ListEndpointsRequest) SyncEffectiveFieldsDuringCreateOrUpdate(plan ListEndpointsRequest)

func (*ListEndpointsRequest) SyncEffectiveFieldsDuringRead added in v1.54.0

func (newState *ListEndpointsRequest) SyncEffectiveFieldsDuringRead(existingState ListEndpointsRequest)

type ListIndexesRequest

type ListIndexesRequest struct {
	// Name of the endpoint
	EndpointName types.String `tfsdk:"-"`
	// Token for pagination
	PageToken types.String `tfsdk:"-"`
}

List indexes

func (*ListIndexesRequest) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0

func (newState *ListIndexesRequest) SyncEffectiveFieldsDuringCreateOrUpdate(plan ListIndexesRequest)

func (*ListIndexesRequest) SyncEffectiveFieldsDuringRead added in v1.54.0

func (newState *ListIndexesRequest) SyncEffectiveFieldsDuringRead(existingState ListIndexesRequest)

type ListValue

type ListValue struct {
	Values []Value `tfsdk:"values" tf:"optional"`
}

func (*ListValue) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0

func (newState *ListValue) SyncEffectiveFieldsDuringCreateOrUpdate(plan ListValue)

func (*ListValue) SyncEffectiveFieldsDuringRead added in v1.54.0

func (newState *ListValue) SyncEffectiveFieldsDuringRead(existingState ListValue)

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.
	NextPageToken types.String `tfsdk:"next_page_token" tf:"optional"`

	VectorIndexes []MiniVectorIndex `tfsdk:"vector_indexes" tf:"optional"`
}

func (*ListVectorIndexesResponse) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0

func (newState *ListVectorIndexesResponse) SyncEffectiveFieldsDuringCreateOrUpdate(plan ListVectorIndexesResponse)

func (*ListVectorIndexesResponse) SyncEffectiveFieldsDuringRead added in v1.54.0

func (newState *ListVectorIndexesResponse) SyncEffectiveFieldsDuringRead(existingState ListVectorIndexesResponse)

type MapStringValueEntry

type MapStringValueEntry struct {
	// Column name.
	Key types.String `tfsdk:"key" tf:"optional"`
	// Column value, nullable.
	Value []Value `tfsdk:"value" tf:"optional,object"`
}

Key-value pair.

func (*MapStringValueEntry) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0

func (newState *MapStringValueEntry) SyncEffectiveFieldsDuringCreateOrUpdate(plan MapStringValueEntry)

func (*MapStringValueEntry) SyncEffectiveFieldsDuringRead added in v1.54.0

func (newState *MapStringValueEntry) SyncEffectiveFieldsDuringRead(existingState MapStringValueEntry)

type MiniVectorIndex

type MiniVectorIndex struct {
	// The user who created the index.
	Creator types.String `tfsdk:"creator" tf:"optional"`
	// Name of the endpoint associated with the index
	EndpointName types.String `tfsdk:"endpoint_name" tf:"optional"`
	// 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.
	IndexType types.String `tfsdk:"index_type" tf:"optional"`
	// Name of the index
	Name types.String `tfsdk:"name" tf:"optional"`
	// Primary key of the index
	PrimaryKey types.String `tfsdk:"primary_key" tf:"optional"`
}

func (*MiniVectorIndex) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0

func (newState *MiniVectorIndex) SyncEffectiveFieldsDuringCreateOrUpdate(plan MiniVectorIndex)

func (*MiniVectorIndex) SyncEffectiveFieldsDuringRead added in v1.54.0

func (newState *MiniVectorIndex) SyncEffectiveFieldsDuringRead(existingState MiniVectorIndex)

type QueryVectorIndexNextPageRequest

type QueryVectorIndexNextPageRequest struct {
	// Name of the endpoint.
	EndpointName types.String `tfsdk:"endpoint_name" tf:"optional"`
	// Name of the vector index to query.
	IndexName types.String `tfsdk:"-"`
	// Page token returned from previous `QueryVectorIndex` or
	// `QueryVectorIndexNextPage` API.
	PageToken types.String `tfsdk:"page_token" tf:"optional"`
}

Request payload for getting next page of results.

func (*QueryVectorIndexNextPageRequest) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0

func (newState *QueryVectorIndexNextPageRequest) SyncEffectiveFieldsDuringCreateOrUpdate(plan QueryVectorIndexNextPageRequest)

func (*QueryVectorIndexNextPageRequest) SyncEffectiveFieldsDuringRead added in v1.54.0

func (newState *QueryVectorIndexNextPageRequest) SyncEffectiveFieldsDuringRead(existingState QueryVectorIndexNextPageRequest)

type QueryVectorIndexRequest

type QueryVectorIndexRequest struct {
	// List of column names to include in the response.
	Columns []types.String `tfsdk:"columns" tf:""`
	// 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 types.String `tfsdk:"filters_json" tf:"optional"`
	// Name of the vector index to query.
	IndexName types.String `tfsdk:"-"`
	// Number of results to return. Defaults to 10.
	NumResults types.Int64 `tfsdk:"num_results" tf:"optional"`
	// Query text. Required for Delta Sync Index using model endpoint.
	QueryText types.String `tfsdk:"query_text" tf:"optional"`
	// The query type to use. Choices are `ANN` and `HYBRID`. Defaults to `ANN`.
	QueryType types.String `tfsdk:"query_type" tf:"optional"`
	// Query vector. Required for Direct Vector Access Index and Delta Sync
	// Index using self-managed vectors.
	QueryVector []types.Float64 `tfsdk:"query_vector" tf:"optional"`
	// Threshold for the approximate nearest neighbor search. Defaults to 0.0.
	ScoreThreshold types.Float64 `tfsdk:"score_threshold" tf:"optional"`
}

func (*QueryVectorIndexRequest) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0

func (newState *QueryVectorIndexRequest) SyncEffectiveFieldsDuringCreateOrUpdate(plan QueryVectorIndexRequest)

func (*QueryVectorIndexRequest) SyncEffectiveFieldsDuringRead added in v1.54.0

func (newState *QueryVectorIndexRequest) SyncEffectiveFieldsDuringRead(existingState QueryVectorIndexRequest)

type QueryVectorIndexResponse

type QueryVectorIndexResponse struct {
	// Metadata about the result set.
	Manifest []ResultManifest `tfsdk:"manifest" tf:"optional,object"`
	// [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.
	NextPageToken types.String `tfsdk:"next_page_token" tf:"optional"`
	// Data returned in the query result.
	Result []ResultData `tfsdk:"result" tf:"optional,object"`
}

func (*QueryVectorIndexResponse) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0

func (newState *QueryVectorIndexResponse) SyncEffectiveFieldsDuringCreateOrUpdate(plan QueryVectorIndexResponse)

func (*QueryVectorIndexResponse) SyncEffectiveFieldsDuringRead added in v1.54.0

func (newState *QueryVectorIndexResponse) SyncEffectiveFieldsDuringRead(existingState QueryVectorIndexResponse)

type ResultData

type ResultData struct {
	// Data rows returned in the query.
	DataArray [][]types.String `tfsdk:"data_array" tf:"optional"`
	// Number of rows in the result set.
	RowCount types.Int64 `tfsdk:"row_count" tf:"optional"`
}

Data returned in the query result.

func (*ResultData) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0

func (newState *ResultData) SyncEffectiveFieldsDuringCreateOrUpdate(plan ResultData)

func (*ResultData) SyncEffectiveFieldsDuringRead added in v1.54.0

func (newState *ResultData) SyncEffectiveFieldsDuringRead(existingState ResultData)

type ResultManifest

type ResultManifest struct {
	// Number of columns in the result set.
	ColumnCount types.Int64 `tfsdk:"column_count" tf:"optional"`
	// Information about each column in the result set.
	Columns []ColumnInfo `tfsdk:"columns" tf:"optional"`
}

Metadata about the result set.

func (*ResultManifest) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0

func (newState *ResultManifest) SyncEffectiveFieldsDuringCreateOrUpdate(plan ResultManifest)

func (*ResultManifest) SyncEffectiveFieldsDuringRead added in v1.54.0

func (newState *ResultManifest) SyncEffectiveFieldsDuringRead(existingState ResultManifest)

type ScanVectorIndexRequest

type ScanVectorIndexRequest struct {
	// Name of the vector index to scan.
	IndexName types.String `tfsdk:"-"`
	// Primary key of the last entry returned in the previous scan.
	LastPrimaryKey types.String `tfsdk:"last_primary_key" tf:"optional"`
	// Number of results to return. Defaults to 10.
	NumResults types.Int64 `tfsdk:"num_results" tf:"optional"`
}

Request payload for scanning data from a vector index.

func (*ScanVectorIndexRequest) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0

func (newState *ScanVectorIndexRequest) SyncEffectiveFieldsDuringCreateOrUpdate(plan ScanVectorIndexRequest)

func (*ScanVectorIndexRequest) SyncEffectiveFieldsDuringRead added in v1.54.0

func (newState *ScanVectorIndexRequest) SyncEffectiveFieldsDuringRead(existingState ScanVectorIndexRequest)

type ScanVectorIndexResponse

type ScanVectorIndexResponse struct {
	// List of data entries
	Data []Struct `tfsdk:"data" tf:"optional"`
	// Primary key of the last entry.
	LastPrimaryKey types.String `tfsdk:"last_primary_key" tf:"optional"`
}

Response to a scan vector index request.

func (*ScanVectorIndexResponse) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0

func (newState *ScanVectorIndexResponse) SyncEffectiveFieldsDuringCreateOrUpdate(plan ScanVectorIndexResponse)

func (*ScanVectorIndexResponse) SyncEffectiveFieldsDuringRead added in v1.54.0

func (newState *ScanVectorIndexResponse) SyncEffectiveFieldsDuringRead(existingState ScanVectorIndexResponse)

type Struct

type Struct struct {
	// Data entry, corresponding to a row in a vector index.
	Fields []MapStringValueEntry `tfsdk:"fields" tf:"optional"`
}

func (*Struct) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0

func (newState *Struct) SyncEffectiveFieldsDuringCreateOrUpdate(plan Struct)

func (*Struct) SyncEffectiveFieldsDuringRead added in v1.54.0

func (newState *Struct) SyncEffectiveFieldsDuringRead(existingState Struct)

type SyncIndexRequest

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

Synchronize an index

func (*SyncIndexRequest) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0

func (newState *SyncIndexRequest) SyncEffectiveFieldsDuringCreateOrUpdate(plan SyncIndexRequest)

func (*SyncIndexRequest) SyncEffectiveFieldsDuringRead added in v1.54.0

func (newState *SyncIndexRequest) SyncEffectiveFieldsDuringRead(existingState SyncIndexRequest)

type SyncIndexResponse

type SyncIndexResponse struct {
}

func (*SyncIndexResponse) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0

func (newState *SyncIndexResponse) SyncEffectiveFieldsDuringCreateOrUpdate(plan SyncIndexResponse)

func (*SyncIndexResponse) SyncEffectiveFieldsDuringRead added in v1.54.0

func (newState *SyncIndexResponse) SyncEffectiveFieldsDuringRead(existingState SyncIndexResponse)

type UpsertDataResult

type UpsertDataResult struct {
	// List of primary keys for rows that failed to process.
	FailedPrimaryKeys []types.String `tfsdk:"failed_primary_keys" tf:"optional"`
	// Count of successfully processed rows.
	SuccessRowCount types.Int64 `tfsdk:"success_row_count" tf:"optional"`
}

Result of the upsert or delete operation.

func (*UpsertDataResult) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0

func (newState *UpsertDataResult) SyncEffectiveFieldsDuringCreateOrUpdate(plan UpsertDataResult)

func (*UpsertDataResult) SyncEffectiveFieldsDuringRead added in v1.54.0

func (newState *UpsertDataResult) SyncEffectiveFieldsDuringRead(existingState UpsertDataResult)

type UpsertDataVectorIndexRequest

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

Request payload for upserting data into a vector index.

func (*UpsertDataVectorIndexRequest) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0

func (newState *UpsertDataVectorIndexRequest) SyncEffectiveFieldsDuringCreateOrUpdate(plan UpsertDataVectorIndexRequest)

func (*UpsertDataVectorIndexRequest) SyncEffectiveFieldsDuringRead added in v1.54.0

func (newState *UpsertDataVectorIndexRequest) SyncEffectiveFieldsDuringRead(existingState UpsertDataVectorIndexRequest)

type UpsertDataVectorIndexResponse

type UpsertDataVectorIndexResponse struct {
	// Result of the upsert or delete operation.
	Result []UpsertDataResult `tfsdk:"result" tf:"optional,object"`
	// Status of the upsert operation.
	Status types.String `tfsdk:"status" tf:"optional"`
}

Response to an upsert data vector index request.

func (*UpsertDataVectorIndexResponse) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0

func (newState *UpsertDataVectorIndexResponse) SyncEffectiveFieldsDuringCreateOrUpdate(plan UpsertDataVectorIndexResponse)

func (*UpsertDataVectorIndexResponse) SyncEffectiveFieldsDuringRead added in v1.54.0

func (newState *UpsertDataVectorIndexResponse) SyncEffectiveFieldsDuringRead(existingState UpsertDataVectorIndexResponse)

type Value

type Value struct {
	BoolValue types.Bool `tfsdk:"bool_value" tf:"optional"`

	ListValue []ListValue `tfsdk:"list_value" tf:"optional,object"`

	NullValue types.String `tfsdk:"null_value" tf:"optional"`

	NumberValue types.Float64 `tfsdk:"number_value" tf:"optional"`

	StringValue types.String `tfsdk:"string_value" tf:"optional"`

	StructValue []Struct `tfsdk:"struct_value" tf:"optional,object"`
}

func (*Value) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0

func (newState *Value) SyncEffectiveFieldsDuringCreateOrUpdate(plan Value)

func (*Value) SyncEffectiveFieldsDuringRead added in v1.54.0

func (newState *Value) SyncEffectiveFieldsDuringRead(existingState Value)

type VectorIndex

type VectorIndex struct {
	// The user who created the index.
	Creator types.String `tfsdk:"creator" tf:"optional"`

	DeltaSyncIndexSpec []DeltaSyncVectorIndexSpecResponse `tfsdk:"delta_sync_index_spec" tf:"optional,object"`

	DirectAccessIndexSpec []DirectAccessVectorIndexSpec `tfsdk:"direct_access_index_spec" tf:"optional,object"`
	// Name of the endpoint associated with the index
	EndpointName types.String `tfsdk:"endpoint_name" tf:"optional"`
	// 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.
	IndexType types.String `tfsdk:"index_type" tf:"optional"`
	// Name of the index
	Name types.String `tfsdk:"name" tf:"optional"`
	// Primary key of the index
	PrimaryKey types.String `tfsdk:"primary_key" tf:"optional"`

	Status []VectorIndexStatus `tfsdk:"status" tf:"optional,object"`
}

func (*VectorIndex) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0

func (newState *VectorIndex) SyncEffectiveFieldsDuringCreateOrUpdate(plan VectorIndex)

func (*VectorIndex) SyncEffectiveFieldsDuringRead added in v1.54.0

func (newState *VectorIndex) SyncEffectiveFieldsDuringRead(existingState VectorIndex)

type VectorIndexStatus

type VectorIndexStatus struct {
	// Index API Url to be used to perform operations on the index
	IndexUrl types.String `tfsdk:"index_url" tf:"optional"`
	// Number of rows indexed
	IndexedRowCount types.Int64 `tfsdk:"indexed_row_count" tf:"optional"`
	// Message associated with the index status
	Message types.String `tfsdk:"message" tf:"optional"`
	// Whether the index is ready for search
	Ready types.Bool `tfsdk:"ready" tf:"optional"`
}

func (*VectorIndexStatus) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0

func (newState *VectorIndexStatus) SyncEffectiveFieldsDuringCreateOrUpdate(plan VectorIndexStatus)

func (*VectorIndexStatus) SyncEffectiveFieldsDuringRead added in v1.54.0

func (newState *VectorIndexStatus) SyncEffectiveFieldsDuringRead(existingState VectorIndexStatus)

Jump to

Keyboard shortcuts

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