aisearch

package
v0.142.0 Latest Latest
Warning

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

Go to latest
Published: Jun 9, 2026 License: Apache-2.0 Imports: 12 Imported by: 0

Documentation

Overview

**AI Search Endpoint**: Represents the compute resources to host AI Search indexes. AIP-conformant replacement for the legacy VectorSearchEndpoints API; functionally equivalent.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AiSearchAPI

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

**AI Search Endpoint**: Represents the compute resources to host AI Search indexes. AIP-conformant replacement for the legacy VectorSearchEndpoints API; functionally equivalent.

func NewAiSearch

func NewAiSearch(client *client.DatabricksClient) *AiSearchAPI

func (*AiSearchAPI) CreateEndpoint

func (a *AiSearchAPI) CreateEndpoint(ctx context.Context, request CreateEndpointRequest) (*Endpoint, error)

func (*AiSearchAPI) CreateIndex

func (a *AiSearchAPI) CreateIndex(ctx context.Context, request CreateIndexRequest) (*Index, error)

func (*AiSearchAPI) DeleteEndpoint

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

func (*AiSearchAPI) DeleteIndex

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

func (*AiSearchAPI) GetEndpoint

func (a *AiSearchAPI) GetEndpoint(ctx context.Context, request GetEndpointRequest) (*Endpoint, error)

func (*AiSearchAPI) GetIndex

func (a *AiSearchAPI) GetIndex(ctx context.Context, request GetIndexRequest) (*Index, error)

func (*AiSearchAPI) ListEndpoints

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

List AI Search endpoints in a workspace.

func (*AiSearchAPI) ListEndpointsAll

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

List AI Search endpoints in a workspace.

func (*AiSearchAPI) ListIndexes

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

List AI Search indexes on an endpoint.

func (*AiSearchAPI) ListIndexesAll

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

List AI Search indexes on an endpoint.

func (*AiSearchAPI) QueryIndex

func (a *AiSearchAPI) QueryIndex(ctx context.Context, request QueryIndexRequest) (*QueryIndexResponse, error)

func (*AiSearchAPI) RemoveData

func (a *AiSearchAPI) RemoveData(ctx context.Context, request RemoveDataRequest) (*RemoveDataResponse, error)

func (*AiSearchAPI) ScanIndex

func (a *AiSearchAPI) ScanIndex(ctx context.Context, request ScanIndexRequest) (*ScanIndexResponse, error)

func (*AiSearchAPI) SyncIndex

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

func (*AiSearchAPI) UpdateEndpoint

func (a *AiSearchAPI) UpdateEndpoint(ctx context.Context, request UpdateEndpointRequest) (*Endpoint, error)

func (*AiSearchAPI) UpsertData

func (a *AiSearchAPI) UpsertData(ctx context.Context, request UpsertDataRequest) (*UpsertDataResponse, error)

type AiSearchInterface

type AiSearchInterface interface {

	// Create a new AI Search endpoint.
	CreateEndpoint(ctx context.Context, request CreateEndpointRequest) (*Endpoint, error)

	// Create a new AI Search index.
	CreateIndex(ctx context.Context, request CreateIndexRequest) (*Index, error)

	// Delete an AI Search endpoint.
	DeleteEndpoint(ctx context.Context, request DeleteEndpointRequest) error

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

	// Get details for a single AI Search endpoint.
	GetEndpoint(ctx context.Context, request GetEndpointRequest) (*Endpoint, error)

	// Get details for a single AI Search index.
	GetIndex(ctx context.Context, request GetIndexRequest) (*Index, error)

	// List AI Search endpoints in a workspace.
	//
	// This method is generated by Databricks SDK Code Generator.
	ListEndpoints(ctx context.Context, request ListEndpointsRequest) listing.Iterator[Endpoint]

	// List AI Search endpoints in a workspace.
	//
	// This method is generated by Databricks SDK Code Generator.
	ListEndpointsAll(ctx context.Context, request ListEndpointsRequest) ([]Endpoint, error)

	// List AI Search indexes on an endpoint.
	//
	// This method is generated by Databricks SDK Code Generator.
	ListIndexes(ctx context.Context, request ListIndexesRequest) listing.Iterator[Index]

	// List AI Search indexes on an endpoint.
	//
	// This method is generated by Databricks SDK Code Generator.
	ListIndexesAll(ctx context.Context, request ListIndexesRequest) ([]Index, error)

	// Query (search) an AI Search index. Read-only, so a read-scoped token may
	// invoke it.
	QueryIndex(ctx context.Context, request QueryIndexRequest) (*QueryIndexResponse, error)

	// Remove rows by primary key from a Direct Access AI Search index.
	RemoveData(ctx context.Context, request RemoveDataRequest) (*RemoveDataResponse, error)

	// Scan (paginate over) the rows of an AI Search index.
	ScanIndex(ctx context.Context, request ScanIndexRequest) (*ScanIndexResponse, error)

	// Synchronize a Delta Sync AI Search index with its source Delta table. Applies
	// only to Delta Sync indexes; Direct Access indexes are written via the
	// data-plane upsert path.
	SyncIndex(ctx context.Context, request SyncIndexRequest) (*SyncIndexResponse, error)

	// Update an existing AI Search endpoint. Multi-bucket masks are supported and
	// dispatched in deterministic bucket order: budget policy, custom tags,
	// throughput, then scaling/replicas. Per-bucket dispatch is not atomic across
	// buckets — if a later bucket fails, earlier buckets may already have been
	// applied.
	UpdateEndpoint(ctx context.Context, request UpdateEndpointRequest) (*Endpoint, error)

	// Upsert rows into a Direct Access AI Search index.
	UpsertData(ctx context.Context, request UpsertDataRequest) (*UpsertDataResponse, error)
}

type AiSearchService deprecated

type AiSearchService interface {

	// Create a new AI Search endpoint.
	CreateEndpoint(ctx context.Context, request CreateEndpointRequest) (*Endpoint, error)

	// Create a new AI Search index.
	CreateIndex(ctx context.Context, request CreateIndexRequest) (*Index, error)

	// Delete an AI Search endpoint.
	DeleteEndpoint(ctx context.Context, request DeleteEndpointRequest) error

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

	// Get details for a single AI Search endpoint.
	GetEndpoint(ctx context.Context, request GetEndpointRequest) (*Endpoint, error)

	// Get details for a single AI Search index.
	GetIndex(ctx context.Context, request GetIndexRequest) (*Index, error)

	// List AI Search endpoints in a workspace.
	ListEndpoints(ctx context.Context, request ListEndpointsRequest) (*ListEndpointsResponse, error)

	// List AI Search indexes on an endpoint.
	ListIndexes(ctx context.Context, request ListIndexesRequest) (*ListIndexesResponse, error)

	// Query (search) an AI Search index. Read-only, so a read-scoped token may
	// invoke it.
	QueryIndex(ctx context.Context, request QueryIndexRequest) (*QueryIndexResponse, error)

	// Remove rows by primary key from a Direct Access AI Search index.
	RemoveData(ctx context.Context, request RemoveDataRequest) (*RemoveDataResponse, error)

	// Scan (paginate over) the rows of an AI Search index.
	ScanIndex(ctx context.Context, request ScanIndexRequest) (*ScanIndexResponse, error)

	// Synchronize a Delta Sync AI Search index with its source Delta table.
	// Applies only to Delta Sync indexes; Direct Access indexes are written via
	// the data-plane upsert path.
	SyncIndex(ctx context.Context, request SyncIndexRequest) (*SyncIndexResponse, error)

	// Update an existing AI Search endpoint. Multi-bucket masks are supported
	// and dispatched in deterministic bucket order: budget policy, custom tags,
	// throughput, then scaling/replicas. Per-bucket dispatch is not atomic
	// across buckets — if a later bucket fails, earlier buckets may already
	// have been applied.
	UpdateEndpoint(ctx context.Context, request UpdateEndpointRequest) (*Endpoint, error)

	// Upsert rows into a Direct Access AI Search index.
	UpsertData(ctx context.Context, request UpsertDataRequest) (*UpsertDataResponse, error)
}

**AI Search Endpoint**: Represents the compute resources to host AI Search indexes. AIP-conformant replacement for the legacy VectorSearchEndpoints API; functionally equivalent.

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

type ColumnInfo

type ColumnInfo struct {
	// Name of the column.
	Name string `json:"name,omitempty"`
	// Data type of the column (e.g., "string", "int", "array<float>").
	TypeText string `json:"type_text,omitempty"`

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

Column information (name and data type) for an index column. Surfaced on `Index.column_info`.

func (ColumnInfo) MarshalJSON

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

func (*ColumnInfo) UnmarshalJSON

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

type CreateEndpointRequest

type CreateEndpointRequest struct {
	// The Endpoint resource to create. Fields other than `endpoint.name` carry
	// the desired configuration; `endpoint.name` is server-assigned from
	// `parent` and `endpoint_id`.
	Endpoint Endpoint `json:"endpoint"`
	// The user-supplied short name for the Endpoint, per AIP-133. The server
	// composes the full `Endpoint.name` as `{parent}/endpoints/{endpoint_id}`.
	// AIP-133 does not list `endpoint_id` as a fields-may-be-required entry, so
	// we annotate it OPTIONAL on the wire; the server still rejects empty
	// values with INVALID_PARAMETER_VALUE.
	EndpointId string `json:"-" url:"endpoint_id,omitempty"`
	// The Workspace where this Endpoint will be created. Format:
	// `workspaces/{workspace_id}`
	Parent string `json:"-" url:"-"`

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

func (CreateEndpointRequest) MarshalJSON

func (s CreateEndpointRequest) MarshalJSON() ([]byte, error)

func (*CreateEndpointRequest) UnmarshalJSON

func (s *CreateEndpointRequest) UnmarshalJSON(b []byte) error

type CreateIndexRequest

type CreateIndexRequest struct {
	// The Index resource to create. Fields other than `index.name` carry the
	// desired configuration; `index.name` is server-assigned from `parent` and
	// `index_id`.
	Index Index `json:"index"`
	// The user-supplied Unity Catalog table name for the Index, per AIP-133.
	// The server composes the full `Index.name` as
	// `{parent}/indexes/{index_id}`. AIP-133 does not list `index_id` as a
	// fields-may-be-required entry, so we annotate it OPTIONAL on the wire; the
	// server still rejects empty values with INVALID_PARAMETER_VALUE.
	IndexId string `json:"-" url:"index_id,omitempty"`
	// The Endpoint where this Index will be created. Format:
	// `workspaces/{workspace_id}/endpoints/{endpoint_id}`
	Parent string `json:"-" url:"-"`

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

func (CreateIndexRequest) MarshalJSON

func (s CreateIndexRequest) MarshalJSON() ([]byte, error)

func (*CreateIndexRequest) UnmarshalJSON

func (s *CreateIndexRequest) UnmarshalJSON(b []byte) error

type CustomTag

type CustomTag struct {
	// Key field for an AI Search endpoint tag.
	Key string `json:"key"`
	// [Optional] Value field for an AI Search endpoint tag.
	Value string `json:"value,omitempty"`

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

User-defined key/value tag attached to an AI Search endpoint for cost attribution and access control.

func (CustomTag) MarshalJSON

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

func (*CustomTag) UnmarshalJSON

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

type DataModificationResult

type DataModificationResult struct {
	// Primary keys of rows that failed to process.
	FailedPrimaryKeys []string `json:"failed_primary_keys,omitempty"`
	// Count of rows processed successfully.
	SuccessRowCount int64 `json:"success_row_count,omitempty"`

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

Per-row outcome of a data-plane upsert or delete operation.

func (DataModificationResult) MarshalJSON

func (s DataModificationResult) MarshalJSON() ([]byte, error)

func (*DataModificationResult) UnmarshalJSON

func (s *DataModificationResult) UnmarshalJSON(b []byte) error

type DataModificationStatus

type DataModificationStatus string

Overall outcome of a data-plane upsert or delete. Mirrors the legacy `databricks.brickindexscheduler.UpsertDeleteDataStatus` value-for-value.

const DataModificationStatusFailure DataModificationStatus = `FAILURE`
const DataModificationStatusPartialSuccess DataModificationStatus = `PARTIAL_SUCCESS`
const DataModificationStatusSuccess DataModificationStatus = `SUCCESS`

func (*DataModificationStatus) Set

Set raw string value and validate it against allowed values

func (*DataModificationStatus) String

func (f *DataModificationStatus) String() string

String representation for fmt.Print

func (*DataModificationStatus) Type

func (f *DataModificationStatus) Type() string

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

func (*DataModificationStatus) Values

Values returns all possible values for DataModificationStatus.

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

type DeleteEndpointRequest

type DeleteEndpointRequest struct {
	// Full resource name of the endpoint to delete. Format:
	// `workspaces/{workspace_id}/endpoints/{endpoint_id}`
	Name string `json:"-" url:"-"`
}

type DeleteIndexRequest

type DeleteIndexRequest struct {
	// Full resource name of the index to delete. Format:
	// `workspaces/{workspace_id}/endpoints/{endpoint_id}/indexes/{index_id}`
	Name string `json:"-" url:"-"`
}

type DeltaSyncIndexSpec

type DeltaSyncIndexSpec struct {
	// [Optional] Select the columns to sync with the index. If left blank, all
	// columns from the source table are synced. The primary key column and
	// embedding source or vector column are always synced.
	ColumnsToSync []string `json:"columns_to_sync,omitempty"`
	// The columns that contain the embedding source.
	EmbeddingSourceColumns []EmbeddingSourceColumn `json:"embedding_source_columns,omitempty"`
	// The columns that contain the embedding vectors.
	EmbeddingVectorColumns []EmbeddingVectorColumn `json:"embedding_vector_columns,omitempty"`
	// [Optional] Name of the Delta table to sync the index contents and
	// computed embeddings to.
	EmbeddingWritebackTable string `json:"embedding_writeback_table,omitempty"`
	// The ID of the pipeline that is used to sync the index.
	PipelineId string `json:"pipeline_id,omitempty"`
	// Pipeline execution mode. Required on create — the backend rejects an
	// unset value. Storage Optimized endpoints accept only `TRIGGERED`;
	// Standard endpoints accept both. No explicit `stage` — a REQUIRED field
	// staged below its service would be dropped from combined specs while
	// remaining in `required`, tripping the OpenAPI required-vs-properties
	// consistency check. The field inherits the service's launch stage.
	PipelineType PipelineType `json:"pipeline_type"`
	// The full name of the source Delta table.
	SourceTable string `json:"source_table,omitempty"`

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

Specification for a Delta Sync index — the index is kept in sync with a source Delta table.

func (DeltaSyncIndexSpec) MarshalJSON

func (s DeltaSyncIndexSpec) MarshalJSON() ([]byte, error)

func (*DeltaSyncIndexSpec) UnmarshalJSON

func (s *DeltaSyncIndexSpec) UnmarshalJSON(b []byte) error

type DirectAccessIndexSpec

type DirectAccessIndexSpec struct {
	// The columns that contain the embedding source.
	EmbeddingSourceColumns []EmbeddingSourceColumn `json:"embedding_source_columns,omitempty"`
	// The columns that contain the embedding vectors.
	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 columns: `array<float>`, `array<double>`.
	SchemaJson string `json:"schema_json,omitempty"`

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

Specification for a Direct Access index — the customer manages vectors and metadata directly.

func (DirectAccessIndexSpec) MarshalJSON

func (s DirectAccessIndexSpec) MarshalJSON() ([]byte, error)

func (*DirectAccessIndexSpec) UnmarshalJSON

func (s *DirectAccessIndexSpec) UnmarshalJSON(b []byte) error

type EmbeddingSourceColumn

type EmbeddingSourceColumn struct {
	// Name of the embedding model endpoint, used by default for both ingestion
	// and querying.
	EmbeddingModelEndpoint string `json:"embedding_model_endpoint,omitempty"`
	// Name of the embedding model endpoint which, if specified, is used for
	// querying (not ingestion).
	ModelEndpointNameForQuery string `json:"model_endpoint_name_for_query,omitempty"`
	// Name of the source column.
	Name string `json:"name,omitempty"`

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

Name of an embedding source column and its associated embedding model endpoint.

func (EmbeddingSourceColumn) MarshalJSON

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

func (*EmbeddingSourceColumn) UnmarshalJSON

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

type EmbeddingVectorColumn

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

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

Name and dimension of an embedding vector column.

func (EmbeddingVectorColumn) MarshalJSON

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

func (*EmbeddingVectorColumn) UnmarshalJSON

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

type Endpoint

type Endpoint struct {
	// The user-selected budget policy id for the endpoint.
	BudgetPolicyId string `json:"budget_policy_id,omitempty"`
	// Time the endpoint was created.
	CreateTime *time.Time `json:"create_time,omitempty"`
	// Creator of the endpoint
	Creator string `json:"creator,omitempty"`
	// The custom tags assigned to the endpoint
	CustomTags []CustomTag `json:"custom_tags,omitempty"`
	// The budget policy id applied to the endpoint
	EffectiveBudgetPolicyId string `json:"effective_budget_policy_id,omitempty"`
	// Current status of the endpoint
	EndpointStatus *EndpointStatus `json:"endpoint_status,omitempty"`
	// Type of endpoint. Required on create and immutable thereafter.
	EndpointType EndpointType `json:"endpoint_type"`
	// Unique identifier of the endpoint
	Id string `json:"id,omitempty"`
	// Number of indexes on the endpoint
	IndexCount int `json:"index_count,omitempty"`
	// User who last updated the endpoint
	LastUpdatedUser string `json:"last_updated_user,omitempty"`
	// Name of the AI Search endpoint. Server-assigned full resource path
	// (`workspaces/{workspace}/endpoints/{endpoint}`) on output. On create, the
	// user-supplied short name is conveyed via
	// `CreateEndpointRequest.endpoint_id`; the server composes the full `name`
	// and returns it on the response.
	Name string `json:"name,omitempty"`
	// The client-supplied desired number of replicas for the endpoint, applied
	// at create/update time. Mutually exclusive with `target_qps`.
	ReplicaCount int `json:"replica_count,omitempty"`
	// Scaling information for the endpoint
	ScalingInfo *EndpointScalingInfo `json:"scaling_info,omitempty"`
	// Target QPS for the endpoint. Mutually exclusive with `replica_count`.
	// Best-effort; the system does not guarantee this QPS will be achieved.
	TargetQps int `json:"target_qps,omitempty"`
	// Throughput information for the endpoint
	ThroughputInfo *EndpointThroughputInfo `json:"throughput_info,omitempty"`
	// Time the endpoint was last updated.
	UpdateTime *time.Time `json:"update_time,omitempty"`
	// The usage policy id applied to the endpoint.
	UsagePolicyId string `json:"usage_policy_id,omitempty"`

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

An AI Search endpoint — compute infrastructure that hosts AI Search indexes and serves queries against them. Customers create, query, and delete endpoints; the system manages provisioning, scaling, and health status.

func (Endpoint) MarshalJSON

func (s Endpoint) MarshalJSON() ([]byte, error)

func (*Endpoint) UnmarshalJSON

func (s *Endpoint) UnmarshalJSON(b []byte) error

type EndpointScalingInfo

type EndpointScalingInfo struct {
	// The requested QPS target for the endpoint. Best-effort; the system does
	// not guarantee this QPS will be achieved.
	RequestedTargetQps int64 `json:"requested_target_qps,omitempty"`
	// The current state of the scaling change request.
	State ScalingChangeState `json:"state,omitempty"`

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

Scaling information for a Storage Optimized endpoint — current scaling state and the requested QPS target the system is scaling toward.

func (EndpointScalingInfo) MarshalJSON

func (s EndpointScalingInfo) MarshalJSON() ([]byte, error)

func (*EndpointScalingInfo) UnmarshalJSON

func (s *EndpointScalingInfo) UnmarshalJSON(b []byte) error

type EndpointStatus

type EndpointStatus struct {
	// Human-readable detail about the endpoint's current state or the reason
	// for a state transition.
	Message string `json:"message,omitempty"`
	// Current lifecycle state of the endpoint. See `State` for the meaning of
	// each value.
	State EndpointStatusState `json:"state,omitempty"`

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

Lifecycle and health state of an AI Search endpoint, along with any human-readable detail about that state.

func (EndpointStatus) MarshalJSON

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

func (*EndpointStatus) UnmarshalJSON

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

type EndpointStatusState

type EndpointStatusState string

Lifecycle state of an AI Search endpoint, used by both Standard and Storage Optimized SKUs.

const EndpointStatusStateDeleted EndpointStatusState = `DELETED`
const EndpointStatusStateOffline EndpointStatusState = `OFFLINE`
const EndpointStatusStateOnline EndpointStatusState = `ONLINE`
const EndpointStatusStateProvisioning EndpointStatusState = `PROVISIONING`
const EndpointStatusStateRedState EndpointStatusState = `RED_STATE`
const EndpointStatusStateYellowState EndpointStatusState = `YELLOW_STATE`

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

Values returns all possible values for EndpointStatusState.

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

type EndpointThroughputInfo

type EndpointThroughputInfo struct {
	// Additional information about the throughput change request
	ChangeRequestMessage string `json:"change_request_message,omitempty"`
	// The state of the most recent throughput change request
	ChangeRequestState ThroughputChangeRequestState `json:"change_request_state,omitempty"`
	// The current concurrency (total CPU) allocated to the endpoint
	CurrentConcurrency float64 `json:"current_concurrency,omitempty"`
	// The current utilization of concurrency as a percentage (0-100)
	CurrentConcurrencyUtilizationPercentage float64 `json:"current_concurrency_utilization_percentage,omitempty"`
	// The current number of replicas allocated to the endpoint
	CurrentNumReplicas int `json:"current_num_replicas,omitempty"`
	// The maximum concurrency allowed for this endpoint
	MaximumConcurrencyAllowed float64 `json:"maximum_concurrency_allowed,omitempty"`
	// The minimum concurrency allowed for this endpoint
	MinimalConcurrencyAllowed float64 `json:"minimal_concurrency_allowed,omitempty"`
	// The requested concurrency (total CPU) for the endpoint
	RequestedConcurrency float64 `json:"requested_concurrency,omitempty"`
	// The requested number of replicas for the endpoint
	RequestedNumReplicas int `json:"requested_num_replicas,omitempty"`

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

Throughput information for an AI Search endpoint, including requested and current concurrency settings.

func (EndpointThroughputInfo) MarshalJSON

func (s EndpointThroughputInfo) MarshalJSON() ([]byte, error)

func (*EndpointThroughputInfo) UnmarshalJSON

func (s *EndpointThroughputInfo) UnmarshalJSON(b []byte) error

type EndpointType

type EndpointType string

Type of endpoint.

const EndpointTypeStandard EndpointType = `STANDARD`
const EndpointTypeStorageOptimized EndpointType = `STORAGE_OPTIMIZED`

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

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 FacetResultData

type FacetResultData struct {
	// Facet rows; each row is `[facet_column_name, value_or_range, count]`.
	FacetArray [][]json.RawMessage `json:"facet_array,omitempty"`
	// Number of facet rows returned.
	FacetRowCount int `json:"facet_row_count,omitempty"`

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

Facet aggregation rows returned by a query.

func (FacetResultData) MarshalJSON

func (s FacetResultData) MarshalJSON() ([]byte, error)

func (*FacetResultData) UnmarshalJSON

func (s *FacetResultData) UnmarshalJSON(b []byte) error

type GetEndpointRequest

type GetEndpointRequest struct {
	// Full resource name of the endpoint. Format:
	// `workspaces/{workspace_id}/endpoints/{endpoint_id}`
	Name string `json:"-" url:"-"`
}

type GetIndexRequest

type GetIndexRequest struct {
	// Full resource name of the index. Format:
	// `workspaces/{workspace_id}/endpoints/{endpoint_id}/indexes/{index_id}`
	Name string `json:"-" url:"-"`
}

type Index

type Index struct {
	// Creator of the index.
	Creator string `json:"creator,omitempty"`
	// Specification for a Delta Sync index. Set when `index_type` is
	// `DELTA_SYNC`.
	DeltaSyncIndexSpec *DeltaSyncIndexSpec `json:"delta_sync_index_spec,omitempty"`
	// Specification for a Direct Access index. Set when `index_type` is
	// `DIRECT_ACCESS`.
	DirectAccessIndexSpec *DirectAccessIndexSpec `json:"direct_access_index_spec,omitempty"`
	// Name of the endpoint associated with the index. Ignored on create — the
	// endpoint is taken from `CreateIndexRequest.parent`; populated only on
	// output.
	Endpoint string `json:"endpoint,omitempty"`
	// The subtype of the index. Set on create and immutable thereafter.
	IndexSubtype IndexSubtype `json:"index_subtype,omitempty"`
	// Type of index. Required on create and immutable thereafter.
	IndexType IndexType `json:"index_type"`
	// Name of the AI Search index. Server-assigned full resource path
	// (`workspaces/{workspace}/endpoints/{endpoint}/indexes/{index}`) on
	// output, where `{index}` is the index's Unity Catalog table name. On
	// create, the user-supplied UC table name is conveyed via
	// `CreateIndexRequest.index_id`; the server composes the full `name` and
	// returns it on the response.
	Name string `json:"name,omitempty"`
	// Primary key of the index. Set on create and immutable thereafter.
	PrimaryKey string `json:"primary_key"`
	// Current status of the index.
	Status *IndexStatus `json:"status,omitempty"`

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

An AI Search index — a searchable collection of vectors and metadata hosted on an AI Search endpoint. Indexes are children of endpoints; customers create, get, list, and delete them. The `{index}` segment of the resource name is the index's Unity Catalog table name.

func (Index) MarshalJSON

func (s Index) MarshalJSON() ([]byte, error)

func (*Index) UnmarshalJSON

func (s *Index) UnmarshalJSON(b []byte) error

type IndexStatus

type IndexStatus struct {
	// Index API URL used to perform operations on the index.
	IndexUrl string `json:"index_url,omitempty"`
	// Number of rows indexed.
	IndexedRowCount int64 `json:"indexed_row_count,omitempty"`
	// Human-readable detail about the index's current state.
	Message string `json:"message,omitempty"`
	// Whether the index is ready for search.
	Ready bool `json:"ready,omitempty"`

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

Lifecycle and health state of an AI Search index, along with human-readable detail about that state and basic indexing progress.

func (IndexStatus) MarshalJSON

func (s IndexStatus) MarshalJSON() ([]byte, error)

func (*IndexStatus) UnmarshalJSON

func (s *IndexStatus) UnmarshalJSON(b []byte) error

type IndexSubtype

type IndexSubtype string

The subtype of the AI Search index, determining the indexing and retrieval strategy. - `VECTOR`: Not a supported create value — do not select it. Use `HYBRID` (vector + hybrid search) or `FULL_TEXT` (full-text only). It is the proto2 default (`= 0`) solely to mirror the legacy `index_v2.proto` enum value-for-value; it is not an offered index subtype. - `FULL_TEXT`: An index that uses full-text search without vector embeddings. - `HYBRID`: An index that uses vector embeddings for similarity search and hybrid search.

const IndexSubtypeFullText IndexSubtype = `FULL_TEXT`

An index that uses full-text search without vector embeddings.

const IndexSubtypeHybrid IndexSubtype = `HYBRID`

An index that uses vector embeddings for similarity search and hybrid search.

const IndexSubtypeVector IndexSubtype = `VECTOR`

Not a supported create value — do not select it. Use `HYBRID` (vector + hybrid

func (*IndexSubtype) Set

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

Set raw string value and validate it against allowed values

func (*IndexSubtype) String

func (f *IndexSubtype) String() string

String representation for fmt.Print

func (*IndexSubtype) Type

func (f *IndexSubtype) Type() string

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

func (*IndexSubtype) Values

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

Values returns all possible values for IndexSubtype.

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

type IndexType

type IndexType string

There are 2 types of AI Search indexes: - `DELTA_SYNC`: An index that automatically syncs with a source Delta Table, automatically and incrementally updating the index as the underlying data in the Delta Table changes. - `DIRECT_ACCESS`: An index that supports direct read and write of vectors and metadata through our REST and SDK APIs. With this model, the user manages index updates.

const IndexTypeDeltaSync IndexType = `DELTA_SYNC`

An index that automatically syncs with a source Delta Table,

const IndexTypeDirectAccess IndexType = `DIRECT_ACCESS`

An index that supports direct read and write of vectors and

func (*IndexType) Set

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

Set raw string value and validate it against allowed values

func (*IndexType) String

func (f *IndexType) String() string

String representation for fmt.Print

func (*IndexType) Type

func (f *IndexType) Type() string

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

func (*IndexType) Values

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

Values returns all possible values for IndexType.

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

type ListEndpointsRequest

type ListEndpointsRequest struct {
	// Best-effort upper bound on the number of results to return. Honored as an
	// upper bound by the shim: `page_size` only narrows the legacy backend's
	// response, never widens it, so the practical cap is `min(page_size,
	// legacy_fixed_page_size)`.
	PageSize int `json:"-" url:"page_size,omitempty"`
	// Page token from a previous response. If not provided, returns the first
	// page.
	PageToken string `json:"-" url:"page_token,omitempty"`
	// The Workspace that owns this collection of endpoints. Format:
	// `workspaces/{workspace_id}`
	Parent string `json:"-" url:"-"`

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

func (ListEndpointsRequest) MarshalJSON

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

func (*ListEndpointsRequest) UnmarshalJSON

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

type ListEndpointsResponse

type ListEndpointsResponse struct {
	// The endpoints in the workspace.
	Endpoints []Endpoint `json:"endpoints,omitempty"`
	// A token that can be used to get the next page of results. Empty when
	// there are no more results.
	NextPageToken string `json:"next_page_token,omitempty"`

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

Response for ListEndpoints carrying the page of endpoints and an optional continuation token.

func (ListEndpointsResponse) MarshalJSON

func (s ListEndpointsResponse) MarshalJSON() ([]byte, error)

func (*ListEndpointsResponse) UnmarshalJSON

func (s *ListEndpointsResponse) UnmarshalJSON(b []byte) error

type ListIndexesRequest

type ListIndexesRequest struct {
	// Best-effort upper bound on the number of results to return. Honored as an
	// upper bound by the shim: `page_size` only narrows the legacy backend's
	// response, never widens it, so the practical cap is `min(page_size,
	// legacy_fixed_page_size)`.
	PageSize int `json:"-" url:"page_size,omitempty"`
	// Page token from a previous response. If not provided, returns the first
	// page.
	PageToken string `json:"-" url:"page_token,omitempty"`
	// The Endpoint that owns this collection of indexes. Format:
	// `workspaces/{workspace_id}/endpoints/{endpoint_id}`
	Parent string `json:"-" url:"-"`

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

func (ListIndexesRequest) MarshalJSON

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

func (*ListIndexesRequest) UnmarshalJSON

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

type ListIndexesResponse

type ListIndexesResponse struct {
	// The indexes on the endpoint. The field is named `indexes` (not the
	// irregular plural `indices`) to satisfy core::0132, which derives the
	// response field name from the ListIndexes method.
	// core::0158::response-plural-first-field independently computes the
	// resource plural as `indices` and is satisfied via a scoped field
	// exception below.
	Indexes []Index `json:"indexes,omitempty"`
	// A token that can be used to get the next page of results. Empty when
	// there are no more results.
	NextPageToken string `json:"next_page_token,omitempty"`

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

Response for ListIndexes carrying the page of indexes and an optional continuation token.

func (ListIndexesResponse) MarshalJSON

func (s ListIndexesResponse) MarshalJSON() ([]byte, error)

func (*ListIndexesResponse) UnmarshalJSON

func (s *ListIndexesResponse) UnmarshalJSON(b []byte) error

type PipelineType

type PipelineType string

Pipeline execution mode for a Delta Sync index. Required on create for Delta Sync indexes; the legacy backend rejects an unset value with INVALID_PARAMETER_VALUE. - `TRIGGERED`: the pipeline stops after refreshing the source table once, using the data available when the update started. - `CONTINUOUS`: the pipeline processes new data as it arrives in the source table to keep the index fresh.

const PipelineTypeContinuous PipelineType = `CONTINUOUS`

the pipeline processes new data as it arrives in the source table to

const PipelineTypeTriggered PipelineType = `TRIGGERED`

the pipeline stops after refreshing the source table once, using the

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

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 QueryIndexRequest

type QueryIndexRequest struct {
	// Column names to include in each result row.
	Columns []string `json:"columns"`
	// Columns whose values are sent to the reranker.
	ColumnsToRerank []string `json:"columns_to_rerank,omitempty"`
	// Facets to compute over the matched results (e.g. `"category TOP 5"`).
	Facets []string `json:"facets,omitempty"`
	// JSON string describing query filters (e.g. `{"id >": 5}`).
	FiltersJson string `json:"filters_json,omitempty"`
	// Maximum number of results to return (the legacy `num_results`). Defaults
	// to 10.
	MaxResults int `json:"max_results,omitempty"`
	// Full resource name of the index to query. Format:
	// `workspaces/{workspace_id}/endpoints/{endpoint_id}/indexes/{index_id}`
	Name string `json:"-" url:"-"`
	// Text columns to search for `query_text`. When empty, all text columns are
	// searched.
	QueryColumns []string `json:"query_columns,omitempty"`
	// Query text. Required for Delta Sync indexes that compute embeddings from
	// a model endpoint.
	QueryText string `json:"query_text,omitempty"`
	// Query type: `ANN`, `HYBRID`, or `FULL_TEXT`. Defaults to `ANN`.
	QueryType string `json:"query_type,omitempty"`
	// Query vector. Required for Direct Access indexes and Delta Sync indexes
	// with self-managed vectors.
	QueryVector []float64 `json:"query_vector,omitempty"`
	// If set, results are reranked before being returned.
	Reranker *RerankerConfig `json:"reranker,omitempty"`
	// Score threshold for the approximate nearest-neighbor search. Defaults to
	// 0.0.
	ScoreThreshold float64 `json:"score_threshold,omitempty"`
	// Sort clauses, e.g. `["rating DESC", "price ASC"]`. Overrides relevance
	// ordering.
	SortColumns []string `json:"sort_columns,omitempty"`

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

Request to query (search) an AI Search index. The legacy `num_results` count is exposed as `max_results`; v1 returns up to `max_results` rows in a single response (no cursor pagination — see the note on `max_results` below).

func (QueryIndexRequest) MarshalJSON

func (s QueryIndexRequest) MarshalJSON() ([]byte, error)

func (*QueryIndexRequest) UnmarshalJSON

func (s *QueryIndexRequest) UnmarshalJSON(b []byte) error

type QueryIndexResponse

type QueryIndexResponse struct {
	// Facet aggregation rows, when facets were requested.
	FacetResult *FacetResultData `json:"facet_result,omitempty"`
	// Metadata describing the result columns.
	Manifest *ResultManifest `json:"manifest,omitempty"`
	// The matched result rows.
	Result *ResultData `json:"result,omitempty"`
}

Response for QueryIndex carrying the matched rows and their column metadata.

type RemoveDataRequest

type RemoveDataRequest struct {
	// Full resource name of the index. Must be a Direct Access index. Format:
	// `workspaces/{workspace_id}/endpoints/{endpoint_id}/indexes/{index_id}`
	Name string `json:"-" url:"-"`
	// Primary keys of the rows to remove.
	PrimaryKeys []string `json:"primary_keys"`
}

Request to remove rows by primary key from a Direct Access AI Search index. Named RemoveData (not DeleteData) so the linter does not classify it as a standard AIP-135 Delete method — it deletes rows within an index, not the index resource.

type RemoveDataResponse

type RemoveDataResponse struct {
	// Per-row outcome of the delete.
	Result *DataModificationResult `json:"result,omitempty"`
	// Overall status of the delete.
	Status DataModificationStatus `json:"status,omitempty"`
}

Response for RemoveData.

type RerankerConfig

type RerankerConfig struct {
	// Reranker identifier: "databricks_reranker" for the base model, or a Model
	// Serving endpoint name when `model_type` is MODEL_TYPE_FINETUNED.
	Model string `json:"model,omitempty"`
	// Discriminator for how `model` is interpreted.
	ModelType RerankerConfigModelType `json:"model_type,omitempty"`
	// Parameters controlling reranking.
	Parameters *RerankerConfigRerankerParameters `json:"parameters,omitempty"`

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

Configuration for reranking query results with a reranker model.

func (RerankerConfig) MarshalJSON

func (s RerankerConfig) MarshalJSON() ([]byte, error)

func (*RerankerConfig) UnmarshalJSON

func (s *RerankerConfig) UnmarshalJSON(b []byte) error

type RerankerConfigModelType

type RerankerConfigModelType string

How the `model` field is interpreted.

const RerankerConfigModelTypeModelTypeBase RerankerConfigModelType = `MODEL_TYPE_BASE`
const RerankerConfigModelTypeModelTypeFinetuned RerankerConfigModelType = `MODEL_TYPE_FINETUNED`

func (*RerankerConfigModelType) Set

Set raw string value and validate it against allowed values

func (*RerankerConfigModelType) String

func (f *RerankerConfigModelType) String() string

String representation for fmt.Print

func (*RerankerConfigModelType) Type

func (f *RerankerConfigModelType) Type() string

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

func (*RerankerConfigModelType) Values

Values returns all possible values for RerankerConfigModelType.

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

type RerankerConfigRerankerParameters

type RerankerConfigRerankerParameters struct {
	// Columns whose values are concatenated and sent to the reranker.
	ColumnsToRerank []string `json:"columns_to_rerank,omitempty"`
}

Parameters controlling how the reranker processes results.

type ResultData

type ResultData struct {
	// Result rows; each row is a list of column values aligned with the
	// manifest columns.
	DataArray [][]json.RawMessage `json:"data_array,omitempty"`
	// Number of rows in the result set.
	RowCount int `json:"row_count,omitempty"`

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

The rows of a query result set.

func (ResultData) MarshalJSON

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

func (*ResultData) UnmarshalJSON

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

type ResultManifest

type ResultManifest struct {
	// Number of columns in the result set.
	ColumnCount int `json:"column_count,omitempty"`
	// Information about each column in the result set.
	Columns []ColumnInfo `json:"columns,omitempty"`
	// Number of columns in the facet result.
	FacetColumnCount int `json:"facet_column_count,omitempty"`
	// Information about each facet column.
	FacetColumns []ColumnInfo `json:"facet_columns,omitempty"`

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

Metadata describing the columns of a query result set.

func (ResultManifest) MarshalJSON

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

func (*ResultManifest) UnmarshalJSON

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

type ScalingChangeState

type ScalingChangeState string

State of the most recent scaling change request for a Storage Optimized endpoint.

const ScalingChangeStateScalingChangeApplied ScalingChangeState = `SCALING_CHANGE_APPLIED`
const ScalingChangeStateScalingChangeInProgress ScalingChangeState = `SCALING_CHANGE_IN_PROGRESS`
const ScalingChangeStateScalingChangeUnspecified ScalingChangeState = `SCALING_CHANGE_UNSPECIFIED`

func (*ScalingChangeState) Set

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

Set raw string value and validate it against allowed values

func (*ScalingChangeState) String

func (f *ScalingChangeState) String() string

String representation for fmt.Print

func (*ScalingChangeState) Type

func (f *ScalingChangeState) Type() string

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

func (*ScalingChangeState) Values

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

Values returns all possible values for ScalingChangeState.

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

type ScanIndexRequest

type ScanIndexRequest struct {
	// Full resource name of the index to scan. Format:
	// `workspaces/{workspace_id}/endpoints/{endpoint_id}/indexes/{index_id}`
	Name string `json:"-" url:"-"`
	// Maximum number of rows to return in this page.
	PageSize int `json:"page_size,omitempty"`
	// Page token from a previous response; if unset, scanning starts from the
	// beginning.
	PageToken string `json:"page_token,omitempty"`

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

Request to scan (paginate over) the rows of an AI Search index. Models the legacy `num_results` / `last_primary_key` cursor as AIP-158 `page_size` / `page_token`.

func (ScanIndexRequest) MarshalJSON

func (s ScanIndexRequest) MarshalJSON() ([]byte, error)

func (*ScanIndexRequest) UnmarshalJSON

func (s *ScanIndexRequest) UnmarshalJSON(b []byte) error

type ScanIndexResponse

type ScanIndexResponse struct {
	// The rows in this page, each a struct of column name to value.
	Data []map[string]json.RawMessage `json:"data,omitempty"`
	// Token for the next page; empty when the scan is exhausted.
	NextPageToken string `json:"next_page_token,omitempty"`

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

Response for ScanIndex carrying a page of rows and an optional continuation token.

func (ScanIndexResponse) MarshalJSON

func (s ScanIndexResponse) MarshalJSON() ([]byte, error)

func (*ScanIndexResponse) UnmarshalJSON

func (s *ScanIndexResponse) UnmarshalJSON(b []byte) error

type SyncIndexRequest

type SyncIndexRequest struct {
	// Full resource name of the index to synchronize. Must be a Delta Sync
	// index. Format:
	// `workspaces/{workspace_id}/endpoints/{endpoint_id}/indexes/{index_id}`
	Name string `json:"-" url:"-"`
}

Request to synchronize a Delta Sync AI Search index with its source Delta table.

type SyncIndexResponse

type SyncIndexResponse struct {
}

Response for SyncIndex. Empty today; reserved so future sync metadata (e.g. an operation handle) can be added without breaking the wire contract.

type ThroughputChangeRequestState

type ThroughputChangeRequestState string

State of the most recent throughput change request issued against a Storage Optimized endpoint. Surfaced on `EndpointThroughputInfo.change_request_state`.

const ThroughputChangeRequestStateChangeAdjusted ThroughputChangeRequestState = `CHANGE_ADJUSTED`
const ThroughputChangeRequestStateChangeFailed ThroughputChangeRequestState = `CHANGE_FAILED`
const ThroughputChangeRequestStateChangeInProgress ThroughputChangeRequestState = `CHANGE_IN_PROGRESS`
const ThroughputChangeRequestStateChangeReachedMaximum ThroughputChangeRequestState = `CHANGE_REACHED_MAXIMUM`
const ThroughputChangeRequestStateChangeReachedMinimum ThroughputChangeRequestState = `CHANGE_REACHED_MINIMUM`
const ThroughputChangeRequestStateChangeSuccess ThroughputChangeRequestState = `CHANGE_SUCCESS`

func (*ThroughputChangeRequestState) Set

Set raw string value and validate it against allowed values

func (*ThroughputChangeRequestState) String

String representation for fmt.Print

func (*ThroughputChangeRequestState) Type

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

func (*ThroughputChangeRequestState) Values

Values returns all possible values for ThroughputChangeRequestState.

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

type UpdateEndpointRequest

type UpdateEndpointRequest struct {
	// The Endpoint resource to update. `endpoint.name` carries the full
	// resource path.
	Endpoint Endpoint `json:"endpoint"`
	// Name of the AI Search endpoint. Server-assigned full resource path
	// (`workspaces/{workspace}/endpoints/{endpoint}`) on output. On create, the
	// user-supplied short name is conveyed via
	// `CreateEndpointRequest.endpoint_id`; the server composes the full `name`
	// and returns it on the response.
	Name string `json:"-" url:"-"`
	// The list of fields to update.
	UpdateMask fieldmask.FieldMask `json:"-" url:"update_mask"`
}

type UpsertDataRequest

type UpsertDataRequest struct {
	// JSON document describing the rows to upsert.
	InputsJson string `json:"inputs_json"`
	// Full resource name of the index. Must be a Direct Access index. Format:
	// `workspaces/{workspace_id}/endpoints/{endpoint_id}/indexes/{index_id}`
	Name string `json:"-" url:"-"`
}

Request to upsert rows into a Direct Access AI Search index.

type UpsertDataResponse

type UpsertDataResponse struct {
	// Per-row outcome of the upsert.
	Result *DataModificationResult `json:"result,omitempty"`
	// Overall status of the upsert.
	Status DataModificationStatus `json:"status,omitempty"`
}

Response for UpsertData.

Jump to

Keyboard shortcuts

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