vectorsearchpb

type AggregateDataObjectsRequest struct {

	// Required. The resource name of the Collection for which to query.
	// Format: `projects/{project}/locations/{location}/collections/{collection}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Optional. A JSON filter expression, e.g. {"genre": {"$eq": "sci-fi"}},
	// represented as a google.protobuf.Struct.
	Filter *structpb.Struct `protobuf:"bytes,2,opt,name=filter,proto3" json:"filter,omitempty"`
	// Required. The aggregation method to apply to the query.
	Aggregate AggregationMethod `protobuf:"varint,3,opt,name=aggregate,proto3,enum=google.cloud.vectorsearch.v1.AggregationMethod" json:"aggregate,omitempty"`
	// contains filtered or unexported fields
}

type AggregateDataObjectsResponse struct {

	// Output only. The aggregated results of the query.
	AggregateResults []*structpb.Struct `protobuf:"bytes,1,rep,name=aggregate_results,json=aggregateResults,proto3" json:"aggregate_results,omitempty"`
	// contains filtered or unexported fields
}

type AggregationMethod int32

type BatchCreateDataObjectsRequest struct {

	// Required. The resource name of the Collection to create the DataObjects in.
	// Format: `projects/{project}/locations/{location}/collections/{collection}`.
	// The parent field in the CreateDataObjectRequest messages must match this
	// field.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. The request message specifying the resources to create.
	// A maximum of 1000 DataObjects can be created in a batch.
	Requests []*CreateDataObjectRequest `protobuf:"bytes,2,rep,name=requests,proto3" json:"requests,omitempty"`
	// contains filtered or unexported fields
}

type BatchCreateDataObjectsResponse struct {

	// Output only. DataObjects created.
	DataObjects []*DataObject `protobuf:"bytes,1,rep,name=data_objects,json=dataObjects,proto3" json:"data_objects,omitempty"`
	// contains filtered or unexported fields
}

type BatchDeleteDataObjectsRequest struct {

	// Required. The resource name of the Collection to delete the DataObjects in.
	// Format: `projects/{project}/locations/{location}/collections/{collection}`.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. The request message specifying the resources to delete.
	// A maximum of 1000 DataObjects can be deleted in a batch.
	Requests []*DeleteDataObjectRequest `protobuf:"bytes,3,rep,name=requests,proto3" json:"requests,omitempty"`
	// contains filtered or unexported fields
}

type BatchSearchDataObjectsRequest struct {

	// Required. The resource name of the Collection for which to search.
	// Format: `projects/{project}/locations/{location}/collections/{collection}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. A list of search requests to execute in parallel.
	Searches []*Search `protobuf:"bytes,2,rep,name=searches,proto3" json:"searches,omitempty"`
	// Optional. Options for combining the results of the batch search operations.
	Combine *BatchSearchDataObjectsRequest_CombineResultsOptions `protobuf:"bytes,3,opt,name=combine,proto3" json:"combine,omitempty"`
	// contains filtered or unexported fields
}

type BatchSearchDataObjectsRequest_CombineResultsOptions struct {

	// Required. The ranker to use for combining the results.
	Ranker *Ranker `protobuf:"bytes,1,opt,name=ranker,proto3" json:"ranker,omitempty"`
	// Optional. Mask specifying which fields to return.
	OutputFields *OutputFields `protobuf:"bytes,2,opt,name=output_fields,json=outputFields,proto3" json:"output_fields,omitempty"`
	// Optional. The number of results to return. If not set, a default value
	// will be used.
	TopK int32 `protobuf:"varint,3,opt,name=top_k,json=topK,proto3" json:"top_k,omitempty"`
	// contains filtered or unexported fields
}

type BatchSearchDataObjectsResponse struct {

	// Output only. A list of search responses, one for each request in the batch.
	// If a ranker is used, a single ranked list of results is returned.
	Results []*SearchDataObjectsResponse `protobuf:"bytes,1,rep,name=results,proto3" json:"results,omitempty"`
	// contains filtered or unexported fields
}

type BatchUpdateDataObjectsRequest struct {

	// Required. The resource name of the Collection to update the DataObjects in.
	// Format: `projects/{project}/locations/{location}/collections/{collection}`.
	// The parent field in the UpdateDataObjectRequest messages must match this
	// field.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. The request message specifying the resources to update.
	// A maximum of 1000 DataObjects can be updated in a batch.
	Requests []*UpdateDataObjectRequest `protobuf:"bytes,2,rep,name=requests,proto3" json:"requests,omitempty"`
	// contains filtered or unexported fields
}

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

type Collection struct {

	// Identifier. name of resource
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Optional. User-specified display name of the collection
	DisplayName string `protobuf:"bytes,8,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// Optional. User-specified description of the collection
	Description string `protobuf:"bytes,9,opt,name=description,proto3" json:"description,omitempty"`
	// Output only. [Output only] Create time stamp
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Output only. [Output only] Update time stamp
	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// Optional. Labels as key value pairs.
	Labels map[string]string `` /* 153-byte string literal not displayed */
	// Optional. Schema for vector fields. Only vector fields in this schema will
	// be searchable. Field names must contain only alphanumeric characters,
	// underscores, and hyphens.
	VectorSchema map[string]*VectorField `` /* 185-byte string literal not displayed */
	// Optional. JSON Schema for data.
	// Field names must contain only alphanumeric characters,
	// underscores, and hyphens.
	DataSchema *structpb.Struct `protobuf:"bytes,10,opt,name=data_schema,json=dataSchema,proto3" json:"data_schema,omitempty"`
	// contains filtered or unexported fields
}

type CreateCollectionRequest struct {

	// Required. Value for parent.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. ID of the Collection to create.
	// The id must be 1-63 characters long, and comply with
	// [RFC1035](https://www.ietf.org/rfc/rfc1035.txt).
	// Specifically, it must be 1-63 characters long and match the regular
	// expression `[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?`.
	CollectionId string `protobuf:"bytes,2,opt,name=collection_id,json=collectionId,proto3" json:"collection_id,omitempty"`
	// Required. The resource being created
	Collection *Collection `protobuf:"bytes,3,opt,name=collection,proto3" json:"collection,omitempty"`
	// Optional. An optional request ID to identify requests. Specify a unique
	// request ID so that if you must retry your request, the server will know to
	// ignore the request if it has already been completed. The server will
	// guarantee that for at least 60 minutes since the first request.
	//
	// For example, consider a situation where you make an initial request and the
	// request times out. If you make the request again with the same request
	// ID, the server can check if original operation with the same request ID
	// was received, and if so, will ignore the second request. This prevents
	// clients from accidentally creating duplicate commitments.
	//
	// The request ID must be a valid UUID with the exception that zero UUID is
	// not supported (00000000-0000-0000-0000-000000000000).
	RequestId string `protobuf:"bytes,4,opt,name=request_id,json=requestId,proto3" json:"request_id,omitempty"`
	// contains filtered or unexported fields
}

type CreateDataObjectRequest struct {

	// Required. The resource name of the Collection to create the DataObject in.
	// Format: `projects/{project}/locations/{location}/collections/{collection}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. The id of the dataObject to create.
	// The id must be 1-63 characters long, and comply with
	// [RFC1035](https://www.ietf.org/rfc/rfc1035.txt).
	// Specifically, it must be 1-63 characters long and match the regular
	// expression `[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?`.
	DataObjectId string `protobuf:"bytes,2,opt,name=data_object_id,json=dataObjectId,proto3" json:"data_object_id,omitempty"`
	// Required. The DataObject to create.
	DataObject *DataObject `protobuf:"bytes,3,opt,name=data_object,json=dataObject,proto3" json:"data_object,omitempty"`
	// contains filtered or unexported fields
}

type CreateIndexRequest struct {

	// Required. The resource name of the Collection for which to create the
	// Index. Format:
	// `projects/{project}/locations/{location}/collections/{collection}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. ID of the Index to create.
	// The id must be 1-63 characters long, and comply with
	// [RFC1035](https://www.ietf.org/rfc/rfc1035.txt).
	// Specifically, it must be 1-63 characters long and match the regular
	// expression `[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?`.
	IndexId string `protobuf:"bytes,2,opt,name=index_id,json=indexId,proto3" json:"index_id,omitempty"`
	// Required. The resource being created
	Index *Index `protobuf:"bytes,3,opt,name=index,proto3" json:"index,omitempty"`
	// Optional. An optional request ID to identify requests. Specify a unique
	// request ID so that if you must retry your request, the server will know to
	// ignore the request if it has already been completed. The server will
	// guarantee that for at least 60 minutes since the first request.
	//
	// For example, consider a situation where you make an initial request and the
	// request times out. If you make the request again with the same request
	// ID, the server can check if original operation with the same request ID
	// was received, and if so, will ignore the second request. This prevents
	// clients from accidentally creating duplicate commitments.
	//
	// The request ID must be a valid UUID with the exception that zero UUID is
	// not supported (00000000-0000-0000-0000-000000000000).
	RequestId string `protobuf:"bytes,4,opt,name=request_id,json=requestId,proto3" json:"request_id,omitempty"`
	// contains filtered or unexported fields
}

type DataObject struct {

	// Identifier. The fully qualified resource name of the dataObject.
	//
	// Format:
	// `projects/{project}/locations/{location}/collections/{collection}/dataObjects/{data_object_id}`
	// The data_object_id must be 1-63 characters
	// long, and comply with [RFC1035](https://www.ietf.org/rfc/rfc1035.txt).
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Output only. The id of the dataObject.
	DataObjectId string `protobuf:"bytes,2,opt,name=data_object_id,json=dataObjectId,proto3" json:"data_object_id,omitempty"`
	// Output only. Timestamp the dataObject was created at.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Output only. Timestamp the dataObject was last updated.
	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// Optional. The data of the dataObject.
	Data *structpb.Struct `protobuf:"bytes,6,opt,name=data,proto3" json:"data,omitempty"`
	// Optional. The vectors of the dataObject.
	Vectors map[string]*Vector `` /* 155-byte string literal not displayed */
	// Optional. The etag of the dataObject.
	Etag string `protobuf:"bytes,8,opt,name=etag,proto3" json:"etag,omitempty"`
	// contains filtered or unexported fields
}

type DataObjectSearchServiceClient interface {
	// Searches data objects.
	SearchDataObjects(ctx context.Context, in *SearchDataObjectsRequest, opts ...grpc.CallOption) (*SearchDataObjectsResponse, error)
	// Queries data objects.
	QueryDataObjects(ctx context.Context, in *QueryDataObjectsRequest, opts ...grpc.CallOption) (*QueryDataObjectsResponse, error)
	// Aggregates data objects.
	AggregateDataObjects(ctx context.Context, in *AggregateDataObjectsRequest, opts ...grpc.CallOption) (*AggregateDataObjectsResponse, error)
	// Batch searches data objects.
	BatchSearchDataObjects(ctx context.Context, in *BatchSearchDataObjectsRequest, opts ...grpc.CallOption) (*BatchSearchDataObjectsResponse, error)
}

type DataObjectSearchServiceServer interface {
	// Searches data objects.
	SearchDataObjects(context.Context, *SearchDataObjectsRequest) (*SearchDataObjectsResponse, error)
	// Queries data objects.
	QueryDataObjects(context.Context, *QueryDataObjectsRequest) (*QueryDataObjectsResponse, error)
	// Aggregates data objects.
	AggregateDataObjects(context.Context, *AggregateDataObjectsRequest) (*AggregateDataObjectsResponse, error)
	// Batch searches data objects.
	BatchSearchDataObjects(context.Context, *BatchSearchDataObjectsRequest) (*BatchSearchDataObjectsResponse, error)
}

type DataObjectServiceClient interface {
	// Creates a dataObject.
	CreateDataObject(ctx context.Context, in *CreateDataObjectRequest, opts ...grpc.CallOption) (*DataObject, error)
	// Creates a batch of dataObjects.
	BatchCreateDataObjects(ctx context.Context, in *BatchCreateDataObjectsRequest, opts ...grpc.CallOption) (*BatchCreateDataObjectsResponse, error)
	// Gets a data object.
	GetDataObject(ctx context.Context, in *GetDataObjectRequest, opts ...grpc.CallOption) (*DataObject, error)
	// Updates a dataObject.
	UpdateDataObject(ctx context.Context, in *UpdateDataObjectRequest, opts ...grpc.CallOption) (*DataObject, error)
	// Updates dataObjects in a batch.
	BatchUpdateDataObjects(ctx context.Context, in *BatchUpdateDataObjectsRequest, opts ...grpc.CallOption) (*BatchUpdateDataObjectsResponse, error)
	// Deletes a dataObject.
	DeleteDataObject(ctx context.Context, in *DeleteDataObjectRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// Deletes dataObjects in a batch.
	BatchDeleteDataObjects(ctx context.Context, in *BatchDeleteDataObjectsRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
}

type DataObjectServiceServer interface {
	// Creates a dataObject.
	CreateDataObject(context.Context, *CreateDataObjectRequest) (*DataObject, error)
	// Creates a batch of dataObjects.
	BatchCreateDataObjects(context.Context, *BatchCreateDataObjectsRequest) (*BatchCreateDataObjectsResponse, error)
	// Gets a data object.
	GetDataObject(context.Context, *GetDataObjectRequest) (*DataObject, error)
	// Updates a dataObject.
	UpdateDataObject(context.Context, *UpdateDataObjectRequest) (*DataObject, error)
	// Updates dataObjects in a batch.
	BatchUpdateDataObjects(context.Context, *BatchUpdateDataObjectsRequest) (*BatchUpdateDataObjectsResponse, error)
	// Deletes a dataObject.
	DeleteDataObject(context.Context, *DeleteDataObjectRequest) (*emptypb.Empty, error)
	// Deletes dataObjects in a batch.
	BatchDeleteDataObjects(context.Context, *BatchDeleteDataObjectsRequest) (*emptypb.Empty, error)
}

type DedicatedInfrastructure struct {

	// Optional. Mode of the dedicated infrastructure.
	Mode *DedicatedInfrastructure_Mode `` /* 131-byte string literal not displayed */
	// Optional. Autoscaling specification.
	AutoscalingSpec *DedicatedInfrastructure_AutoscalingSpec `protobuf:"bytes,2,opt,name=autoscaling_spec,json=autoscalingSpec,proto3" json:"autoscaling_spec,omitempty"`
	// contains filtered or unexported fields
}

type DedicatedInfrastructure_AutoscalingSpec struct {

	// Optional. The minimum number of replicas. If not set or set to `0`,
	// defaults to `2`. Must be >= `2` and <= `1000`.
	MinReplicaCount int32 `protobuf:"varint,1,opt,name=min_replica_count,json=minReplicaCount,proto3" json:"min_replica_count,omitempty"`
	// Optional. The maximum number of replicas. If not set or set to `0`,
	// defaults to the greater of `min_replica_count` and `5`. Must be >=
	// `min_replica_count` and <= `1000`.
	MaxReplicaCount int32 `protobuf:"varint,2,opt,name=max_replica_count,json=maxReplicaCount,proto3" json:"max_replica_count,omitempty"`
	// contains filtered or unexported fields
}

type DedicatedInfrastructure_Mode int32

type DeleteCollectionRequest struct {

	// Required. Name of the resource
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Optional. An optional request ID to identify requests. Specify a unique
	// request ID so that if you must retry your request, the server will know to
	// ignore the request if it has already been completed. The server will
	// guarantee that for at least 60 minutes after the first request.
	//
	// For example, consider a situation where you make an initial request and the
	// request times out. If you make the request again with the same request
	// ID, the server can check if original operation with the same request ID
	// was received, and if so, will ignore the second request. This prevents
	// clients from accidentally creating duplicate commitments.
	//
	// The request ID must be a valid UUID with the exception that zero UUID is
	// not supported (00000000-0000-0000-0000-000000000000).
	RequestId string `protobuf:"bytes,2,opt,name=request_id,json=requestId,proto3" json:"request_id,omitempty"`
	// contains filtered or unexported fields
}

type DeleteDataObjectRequest struct {

	// Required. The name of the DataObject resource to be deleted.
	// Format:
	// `projects/{project}/locations/{location}/collections/{collection}/dataObjects/{dataObject}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Optional. The current etag of the DataObject.
	// If an etag is provided and does not match the current etag of the
	// DataObject, deletion will be blocked and an ABORTED error will be returned.
	Etag string `protobuf:"bytes,2,opt,name=etag,proto3" json:"etag,omitempty"`
	// contains filtered or unexported fields
}

type DeleteIndexRequest struct {

	// Required. The resource name of the Index to delete.
	// Format:
	// `projects/{project}/locations/{location}/collections/{collection}/indexes/{index}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Optional. An optional request ID to identify requests. Specify a unique
	// request ID so that if you must retry your request, the server will know to
	// ignore the request if it has already been completed. The server will
	// guarantee that for at least 60 minutes since the first request.
	//
	// For example, consider a situation where you make an initial request and the
	// request times out. If you make the request again with the same request
	// ID, the server can check if original operation with the same request ID
	// was received, and if so, will ignore the second request. This prevents
	// clients from accidentally creating duplicate commitments.
	//
	// The request ID must be a valid UUID with the exception that zero UUID is
	// not supported (00000000-0000-0000-0000-000000000000).
	RequestId string `protobuf:"bytes,2,opt,name=request_id,json=requestId,proto3" json:"request_id,omitempty"`
	// contains filtered or unexported fields
}

type DenseScannIndex struct {

	// Optional. Feature norm type.
	FeatureNormType DenseScannIndex_FeatureNormType `` /* 175-byte string literal not displayed */
	// contains filtered or unexported fields
}

type DenseScannIndex_FeatureNormType int32

type DenseVector struct {

	// Required. The values of the vector.
	Values []float32 `protobuf:"fixed32,1,rep,packed,name=values,proto3" json:"values,omitempty"`
	// contains filtered or unexported fields
}

type DenseVectorField struct {

	// Dimensionality of the vector field.
	Dimensions int32 `protobuf:"varint,1,opt,name=dimensions,proto3" json:"dimensions,omitempty"`
	// Optional. Configuration for generating embeddings for the vector field. If
	// not specified, the embedding field must be populated in the DataObject.
	VertexEmbeddingConfig *VertexEmbeddingConfig `` /* 126-byte string literal not displayed */
	// contains filtered or unexported fields
}

type DistanceMetric int32

type EmbeddingTaskType int32

type GetCollectionRequest struct {

	// Required. Name of the resource
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

type GetDataObjectRequest struct {

	// Required. The name of the DataObject resource.
	// Format:
	// `projects/{project}/locations/{location}/collections/{collection}/dataObjects/{dataObject}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

type GetIndexRequest struct {

	// Required. Name of the resource
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

type ImportDataObjectsMetadata struct {

	// Output only. The time the operation was created.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Output only. The time the operation was last updated.
	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// Output only. Number of DataObjects that were processed successfully.
	SuccessCount int64 `protobuf:"varint,3,opt,name=success_count,json=successCount,proto3" json:"success_count,omitempty"`
	// Output only. Number of DataObjects that failed during processing.
	FailureCount int64 `protobuf:"varint,4,opt,name=failure_count,json=failureCount,proto3" json:"failure_count,omitempty"`
	// contains filtered or unexported fields
}

type ImportDataObjectsRequest struct {

	// The configuration for the import data and error results.
	//
	// Types that are assignable to Config:
	//
	//	*ImportDataObjectsRequest_GcsImport
	Config isImportDataObjectsRequest_Config `protobuf_oneof:"config"`
	// Required. The resource name of the Collection to import DataObjects into.
	// Format: `projects/{project}/locations/{location}/collections/{collection}`.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

type ImportDataObjectsRequest_GcsImport struct {
	// The Cloud Storage location of the input content.
	GcsImport *ImportDataObjectsRequest_GcsImportConfig `protobuf:"bytes,2,opt,name=gcs_import,json=gcsImport,proto3,oneof"`
}

type ImportDataObjectsRequest_GcsImportConfig struct {

	// Required. URI prefix of the Cloud Storage DataObjects to import.
	ContentsUri string `protobuf:"bytes,1,opt,name=contents_uri,json=contentsUri,proto3" json:"contents_uri,omitempty"`
	// Required. URI prefix of the Cloud Storage location to write any errors
	// encountered during the import.
	ErrorUri string `protobuf:"bytes,2,opt,name=error_uri,json=errorUri,proto3" json:"error_uri,omitempty"`
	// Optional. URI prefix of the Cloud Storage location to write DataObject
	// `IDs` and `etags` of DataObjects that were successfully imported. The
	// service will write the successfully imported DataObjects to sharded files
	// under this prefix. If this field is empty, no output will be written.
	OutputUri string `protobuf:"bytes,3,opt,name=output_uri,json=outputUri,proto3" json:"output_uri,omitempty"`
	// contains filtered or unexported fields
}

type ImportDataObjectsResponse struct {

	// Status of the LRO
	Status *status.Status `protobuf:"bytes,1,opt,name=status,proto3" json:"status,omitempty"`
	// contains filtered or unexported fields
}

type Index struct {

	// The infrastructure type of the index.
	//
	// Types that are assignable to InfraType:
	//
	//	*Index_DedicatedInfrastructure
	InfraType isIndex_InfraType `protobuf_oneof:"infra_type"`
	// The type of the index.
	//
	// Types that are assignable to IndexType:
	//
	//	*Index_DenseScann
	IndexType isIndex_IndexType `protobuf_oneof:"index_type"`
	// Identifier. name of resource
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Optional. User-specified display name of the index
	DisplayName string `protobuf:"bytes,8,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// Optional. User-specified description of the index
	Description string `protobuf:"bytes,9,opt,name=description,proto3" json:"description,omitempty"`
	// Optional. Labels as key value pairs.
	Labels map[string]string `` /* 154-byte string literal not displayed */
	// Output only. [Output only] Create time stamp
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Output only. [Output only] Update time stamp
	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// Optional. Distance metric used for indexing. If not specified, will default
	// to DOT_PRODUCT.
	DistanceMetric DistanceMetric `` /* 153-byte string literal not displayed */
	// Required. The collection schema field to index.
	IndexField string `protobuf:"bytes,5,opt,name=index_field,json=indexField,proto3" json:"index_field,omitempty"`
	// Optional. The fields to push into the index to enable fast ANN inline
	// filtering.
	FilterFields []string `protobuf:"bytes,6,rep,name=filter_fields,json=filterFields,proto3" json:"filter_fields,omitempty"`
	// Optional. The fields to push into the index to enable inline data
	// retrieval.
	StoreFields []string `protobuf:"bytes,7,rep,name=store_fields,json=storeFields,proto3" json:"store_fields,omitempty"`
	// contains filtered or unexported fields
}

type Index_DedicatedInfrastructure struct {
	// Optional. Dedicated infrastructure for the index.
	DedicatedInfrastructure *DedicatedInfrastructure `protobuf:"bytes,11,opt,name=dedicated_infrastructure,json=dedicatedInfrastructure,proto3,oneof"`
}

type Index_DenseScann struct {
	// Optional. Dense ScaNN index.
	DenseScann *DenseScannIndex `protobuf:"bytes,12,opt,name=dense_scann,json=denseScann,proto3,oneof"`
}

type ListCollectionsRequest struct {

	// Required. Parent value for ListCollectionsRequest
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Optional. Requested page size. Server may return fewer items than
	// requested. If unspecified, server will pick an appropriate default.
	PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// Optional. A token identifying a page of results the server should return.
	PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// Optional. Filtering results
	Filter string `protobuf:"bytes,4,opt,name=filter,proto3" json:"filter,omitempty"`
	// Optional. Hint for how to order the results
	OrderBy string `protobuf:"bytes,5,opt,name=order_by,json=orderBy,proto3" json:"order_by,omitempty"`
	// contains filtered or unexported fields
}

type ListCollectionsResponse struct {

	// The list of Collection
	Collections []*Collection `protobuf:"bytes,1,rep,name=collections,proto3" json:"collections,omitempty"`
	// A token identifying a page of results the server should return.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// Unordered list. Locations that could not be reached.
	Unreachable []string `protobuf:"bytes,3,rep,name=unreachable,proto3" json:"unreachable,omitempty"`
	// contains filtered or unexported fields
}

type ListIndexesRequest struct {

	// Required. Parent value for ListIndexesRequest
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Optional. Requested page size. Server may return fewer items than
	// requested. If unspecified, server will pick an appropriate default.
	PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// Optional. A token identifying a page of results the server should return.
	PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// Optional. Filtering results
	Filter string `protobuf:"bytes,4,opt,name=filter,proto3" json:"filter,omitempty"`
	// Optional. Hint for how to order the results
	OrderBy string `protobuf:"bytes,5,opt,name=order_by,json=orderBy,proto3" json:"order_by,omitempty"`
	// contains filtered or unexported fields
}

type ListIndexesResponse struct {

	// The list of Index
	Indexes []*Index `protobuf:"bytes,1,rep,name=indexes,proto3" json:"indexes,omitempty"`
	// A token identifying a page of results the server should return.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

type OperationMetadata struct {

	// Output only. The time the operation was created.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Output only. The time the operation finished running.
	EndTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=end_time,json=endTime,proto3" json:"end_time,omitempty"`
	// Output only. Server-defined resource path for the target of the operation.
	Target string `protobuf:"bytes,3,opt,name=target,proto3" json:"target,omitempty"`
	// Output only. Name of the verb executed by the operation.
	Verb string `protobuf:"bytes,4,opt,name=verb,proto3" json:"verb,omitempty"`
	// Output only. Human-readable status of the operation, if any.
	StatusMessage string `protobuf:"bytes,5,opt,name=status_message,json=statusMessage,proto3" json:"status_message,omitempty"`
	// Output only. Identifies whether the user has requested cancellation
	// of the operation. Operations that have been cancelled successfully
	// have
	// [google.longrunning.Operation.error][google.longrunning.Operation.error]
	// value with a [google.rpc.Status.code][google.rpc.Status.code] of `1`,
	// corresponding to `Code.CANCELLED`.
	RequestedCancellation bool `protobuf:"varint,6,opt,name=requested_cancellation,json=requestedCancellation,proto3" json:"requested_cancellation,omitempty"`
	// Output only. API version used to start the operation.
	ApiVersion string `protobuf:"bytes,7,opt,name=api_version,json=apiVersion,proto3" json:"api_version,omitempty"`
	// contains filtered or unexported fields
}

type OutputFields struct {

	// Optional. The fields from the data fields to include in the output.
	DataFields []string `protobuf:"bytes,1,rep,name=data_fields,json=dataFields,proto3" json:"data_fields,omitempty"`
	// Optional. The fields from the vector fields to include in the output.
	VectorFields []string `protobuf:"bytes,2,rep,name=vector_fields,json=vectorFields,proto3" json:"vector_fields,omitempty"`
	// Optional. The fields from the DataObject metadata to include in the output.
	MetadataFields []string `protobuf:"bytes,3,rep,name=metadata_fields,json=metadataFields,proto3" json:"metadata_fields,omitempty"`
	// contains filtered or unexported fields
}

type QueryDataObjectsRequest struct {

	// Required. The resource name of the Collection for which to query.
	// Format: `projects/{project}/locations/{location}/collections/{collection}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Optional. A JSON filter expression, e.g. {"genre": {"$eq": "sci-fi"}},
	// represented as a google.protobuf.Struct.
	Filter *structpb.Struct `protobuf:"bytes,2,opt,name=filter,proto3" json:"filter,omitempty"`
	// Optional. Mask specifying which fields to return.
	OutputFields *OutputFields `protobuf:"bytes,7,opt,name=output_fields,json=outputFields,proto3" json:"output_fields,omitempty"`
	// Optional. The standard list page size. Default is 100.
	// The maximum value is 1000; values above 1000 will be coerced to 1000.
	PageSize int32 `protobuf:"varint,5,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// Optional. The standard list page token.
	// Typically obtained via
	// [QueryDataObjectsResponse.next_page_token][google.cloud.vectorsearch.v1.QueryDataObjectsResponse.next_page_token]
	// of the previous
	// [DataObjectSearchService.QueryDataObjects][google.cloud.vectorsearch.v1.DataObjectSearchService.QueryDataObjects]
	// call.
	PageToken string `protobuf:"bytes,6,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// contains filtered or unexported fields
}

type QueryDataObjectsResponse struct {

	// Output only. The list of dataObjects that match the query.
	DataObjects []*DataObject `protobuf:"bytes,4,rep,name=data_objects,json=dataObjects,proto3" json:"data_objects,omitempty"`
	// Output only. A token to retrieve next page of results.
	// Pass to [DataObjectSearchService.QueryDataObjectsRequest.page_token][] to
	// obtain that page.
	NextPageToken string `protobuf:"bytes,3,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

type Ranker struct {

	// The ranking method to use.
	//
	// Types that are assignable to Ranker:
	//
	//	*Ranker_Rrf
	//	*Ranker_Vertex
	Ranker isRanker_Ranker `protobuf_oneof:"ranker"`
	// contains filtered or unexported fields
}

type Ranker_Rrf struct {
	// Reciprocal Rank Fusion ranking.
	Rrf *ReciprocalRankFusion `protobuf:"bytes,1,opt,name=rrf,proto3,oneof"`
}

type Ranker_Vertex struct {
	// Vertex AI ranking.
	Vertex *VertexRanker `protobuf:"bytes,2,opt,name=vertex,proto3,oneof"`
}

type ReciprocalRankFusion struct {

	// Required. The weights to apply to each search result set during fusion.
	Weights []float64 `protobuf:"fixed64,1,rep,packed,name=weights,proto3" json:"weights,omitempty"`
	// contains filtered or unexported fields
}

type Search struct {

	// The type of search to perform.
	//
	// Types that are assignable to SearchType:
	//
	//	*Search_VectorSearch
	//	*Search_SemanticSearch
	//	*Search_TextSearch
	SearchType isSearch_SearchType `protobuf_oneof:"search_type"`
	// contains filtered or unexported fields
}

type SearchDataObjectsRequest struct {

	// The query to search for.
	//
	// Types that are assignable to SearchType:
	//
	//	*SearchDataObjectsRequest_VectorSearch
	//	*SearchDataObjectsRequest_SemanticSearch
	//	*SearchDataObjectsRequest_TextSearch
	SearchType isSearchDataObjectsRequest_SearchType `protobuf_oneof:"search_type"`
	// Required. The resource name of the Collection for which to search.
	// Format: `projects/{project}/locations/{location}/collections/{collection}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Optional. The standard list page size. Only supported for KNN. If not set,
	// up to search_type.top_k results will be returned. The maximum value is
	// 1000; values above 1000 will be coerced to 1000.
	PageSize int32 `protobuf:"varint,5,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// Optional. The standard list page token.
	// Typically obtained via
	// [SearchDataObjectsResponse.next_page_token][google.cloud.vectorsearch.v1.SearchDataObjectsResponse.next_page_token]
	// of the previous
	// [DataObjectSearchService.SearchDataObjects][google.cloud.vectorsearch.v1.DataObjectSearchService.SearchDataObjects]
	// call.
	PageToken string `protobuf:"bytes,6,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// contains filtered or unexported fields
}

type SearchDataObjectsRequest_SemanticSearch struct {
	// A semantic search operation.
	SemanticSearch *SemanticSearch `protobuf:"bytes,4,opt,name=semantic_search,json=semanticSearch,proto3,oneof"`
}

type SearchDataObjectsRequest_TextSearch struct {
	// Optional. A text search operation.
	TextSearch *TextSearch `protobuf:"bytes,7,opt,name=text_search,json=textSearch,proto3,oneof"`
}

type SearchDataObjectsRequest_VectorSearch struct {
	// A vector search operation.
	VectorSearch *VectorSearch `protobuf:"bytes,2,opt,name=vector_search,json=vectorSearch,proto3,oneof"`
}

type SearchDataObjectsResponse struct {

	// Output only. The list of dataObjects that match the search criteria.
	Results []*SearchResult `protobuf:"bytes,1,rep,name=results,proto3" json:"results,omitempty"`
	// Output only. A token to retrieve next page of results.
	// Pass to [DataObjectSearchService.SearchDataObjectsRequest.page_token][] to
	// obtain that page.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

type SearchHint struct {

	// The type of index to use.
	//
	// Types that are assignable to IndexType:
	//
	//	*SearchHint_KnnHint_
	//	*SearchHint_IndexHint_
	IndexType isSearchHint_IndexType `protobuf_oneof:"index_type"`
	// contains filtered or unexported fields
}

type SearchHint_IndexHint struct {

	// The parameters for the index.
	//
	// Types that are assignable to Params:
	//
	//	*SearchHint_IndexHint_DenseScannParams_
	Params isSearchHint_IndexHint_Params `protobuf_oneof:"params"`
	// Required. The resource name of the index to use for the search.
	// The index must be in the same project, location, and collection.
	// Format:
	// `projects/{project}/locations/{location}/collections/{collection}/indexes/{index}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

type SearchHint_IndexHint_ struct {
	// Optional. Specifies that the search should use a particular index.
	IndexHint *SearchHint_IndexHint `protobuf:"bytes,4,opt,name=index_hint,json=indexHint,proto3,oneof"`
}

type SearchHint_IndexHint_DenseScannParams struct {

	// Optional. Dense ANN param overrides to control recall and latency.
	// The percentage of leaves to search, in the range [0, 100].
	SearchLeavesPct int32 `protobuf:"varint,1,opt,name=search_leaves_pct,json=searchLeavesPct,proto3" json:"search_leaves_pct,omitempty"`
	// Optional. The number of initial candidates. Must be a positive integer
	// (> 0).
	InitialCandidateCount int32 `` /* 127-byte string literal not displayed */
	// contains filtered or unexported fields
}

type SearchHint_IndexHint_DenseScannParams_ struct {
	// Optional. Dense ScaNN parameters.
	DenseScannParams *SearchHint_IndexHint_DenseScannParams `protobuf:"bytes,2,opt,name=dense_scann_params,json=denseScannParams,proto3,oneof"`
}

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

type SearchHint_KnnHint_ struct {
	// Optional. If set, the search will use the system's default
	// K-Nearest Neighbor (KNN) index engine.
	KnnHint *SearchHint_KnnHint `protobuf:"bytes,3,opt,name=knn_hint,json=knnHint,proto3,oneof"`
}

type SearchResult struct {

	// Output only. The matching data object.
	DataObject *DataObject `protobuf:"bytes,1,opt,name=data_object,json=dataObject,proto3" json:"data_object,omitempty"`
	// Output only. Similarity distance or ranker score returned by
	// BatchSearchDataObjects.
	Distance *float64 `protobuf:"fixed64,2,opt,name=distance,proto3,oneof" json:"distance,omitempty"`
	// contains filtered or unexported fields
}

type Search_SemanticSearch struct {
	// A semantic search.
	SemanticSearch *SemanticSearch `protobuf:"bytes,2,opt,name=semantic_search,json=semanticSearch,proto3,oneof"`
}

type Search_TextSearch struct {
	// A text search operation.
	TextSearch *TextSearch `protobuf:"bytes,3,opt,name=text_search,json=textSearch,proto3,oneof"`
}

type Search_VectorSearch struct {
	// A vector-based search.
	VectorSearch *VectorSearch `protobuf:"bytes,1,opt,name=vector_search,json=vectorSearch,proto3,oneof"`
}

type SemanticSearch struct {

	// Required. The query text, which is used to generate an embedding according
	// to the embedding model specified in the collection config.
	SearchText string `protobuf:"bytes,1,opt,name=search_text,json=searchText,proto3" json:"search_text,omitempty"`
	// Required. The vector field to search.
	SearchField string `protobuf:"bytes,2,opt,name=search_field,json=searchField,proto3" json:"search_field,omitempty"`
	// Required. The task type of the query embedding.
	TaskType EmbeddingTaskType `` /* 138-byte string literal not displayed */
	// Optional. The fields to return in the search results.
	OutputFields *OutputFields `protobuf:"bytes,3,opt,name=output_fields,json=outputFields,proto3" json:"output_fields,omitempty"`
	// Optional. A JSON filter expression, e.g. {"genre": {"$eq": "sci-fi"}},
	// represented as a google.protobuf.Struct.
	Filter *structpb.Struct `protobuf:"bytes,6,opt,name=filter,proto3" json:"filter,omitempty"`
	// Optional. The number of data objects to return.
	TopK *int32 `protobuf:"varint,4,opt,name=top_k,json=topK,proto3,oneof" json:"top_k,omitempty"`
	// Optional. Sets the search hint. If no strategy is specified, the service
	// will use an index if one is available, and fall back to KNN search
	// otherwise.
	SearchHint *SearchHint `protobuf:"bytes,7,opt,name=search_hint,json=searchHint,proto3" json:"search_hint,omitempty"`
	// contains filtered or unexported fields
}