Vector Search API v1beta - Package cloud.google.com/go/vectorsearch/apiv1beta/vectorsearchpb (v0.7.0)

0.7.0 (latest) 0.6.0 0.5.0 0.4.0 0.3.0 0.2.0 0.1.0

Beta

This library is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

Note: To get more information about this package, such as access to older versions, view this package on pkg.go.dev.

Constants

DataObjectSearchService_SearchDataObjects_FullMethodName, DataObjectSearchService_QueryDataObjects_FullMethodName, DataObjectSearchService_AggregateDataObjects_FullMethodName, DataObjectSearchService_BatchSearchDataObjects_FullMethodName

const (
	DataObjectSearchService_SearchDataObjects_FullMethodName      = "/google.cloud.vectorsearch.v1beta.DataObjectSearchService/SearchDataObjects"
	DataObjectSearchService_QueryDataObjects_FullMethodName       = "/google.cloud.vectorsearch.v1beta.DataObjectSearchService/QueryDataObjects"
	DataObjectSearchService_AggregateDataObjects_FullMethodName   = "/google.cloud.vectorsearch.v1beta.DataObjectSearchService/AggregateDataObjects"
	DataObjectSearchService_BatchSearchDataObjects_FullMethodName = "/google.cloud.vectorsearch.v1beta.DataObjectSearchService/BatchSearchDataObjects"
)

DataObjectService_CreateDataObject_FullMethodName, DataObjectService_BatchCreateDataObjects_FullMethodName, DataObjectService_GetDataObject_FullMethodName, DataObjectService_UpdateDataObject_FullMethodName, DataObjectService_BatchUpdateDataObjects_FullMethodName, DataObjectService_DeleteDataObject_FullMethodName, DataObjectService_BatchDeleteDataObjects_FullMethodName

const (
	DataObjectService_CreateDataObject_FullMethodName       = "/google.cloud.vectorsearch.v1beta.DataObjectService/CreateDataObject"
	DataObjectService_BatchCreateDataObjects_FullMethodName = "/google.cloud.vectorsearch.v1beta.DataObjectService/BatchCreateDataObjects"
	DataObjectService_GetDataObject_FullMethodName          = "/google.cloud.vectorsearch.v1beta.DataObjectService/GetDataObject"
	DataObjectService_UpdateDataObject_FullMethodName       = "/google.cloud.vectorsearch.v1beta.DataObjectService/UpdateDataObject"
	DataObjectService_BatchUpdateDataObjects_FullMethodName = "/google.cloud.vectorsearch.v1beta.DataObjectService/BatchUpdateDataObjects"
	DataObjectService_DeleteDataObject_FullMethodName       = "/google.cloud.vectorsearch.v1beta.DataObjectService/DeleteDataObject"
	DataObjectService_BatchDeleteDataObjects_FullMethodName = "/google.cloud.vectorsearch.v1beta.DataObjectService/BatchDeleteDataObjects"
)

VectorSearchService_ListCollections_FullMethodName, VectorSearchService_GetCollection_FullMethodName, VectorSearchService_CreateCollection_FullMethodName, VectorSearchService_UpdateCollection_FullMethodName, VectorSearchService_DeleteCollection_FullMethodName, VectorSearchService_ListIndexes_FullMethodName, VectorSearchService_GetIndex_FullMethodName, VectorSearchService_CreateIndex_FullMethodName, VectorSearchService_DeleteIndex_FullMethodName, VectorSearchService_ImportDataObjects_FullMethodName, VectorSearchService_ExportDataObjects_FullMethodName

const (
	VectorSearchService_ListCollections_FullMethodName   = "/google.cloud.vectorsearch.v1beta.VectorSearchService/ListCollections"
	VectorSearchService_GetCollection_FullMethodName     = "/google.cloud.vectorsearch.v1beta.VectorSearchService/GetCollection"
	VectorSearchService_CreateCollection_FullMethodName  = "/google.cloud.vectorsearch.v1beta.VectorSearchService/CreateCollection"
	VectorSearchService_UpdateCollection_FullMethodName  = "/google.cloud.vectorsearch.v1beta.VectorSearchService/UpdateCollection"
	VectorSearchService_DeleteCollection_FullMethodName  = "/google.cloud.vectorsearch.v1beta.VectorSearchService/DeleteCollection"
	VectorSearchService_ListIndexes_FullMethodName       = "/google.cloud.vectorsearch.v1beta.VectorSearchService/ListIndexes"
	VectorSearchService_GetIndex_FullMethodName          = "/google.cloud.vectorsearch.v1beta.VectorSearchService/GetIndex"
	VectorSearchService_CreateIndex_FullMethodName       = "/google.cloud.vectorsearch.v1beta.VectorSearchService/CreateIndex"
	VectorSearchService_DeleteIndex_FullMethodName       = "/google.cloud.vectorsearch.v1beta.VectorSearchService/DeleteIndex"
	VectorSearchService_ImportDataObjects_FullMethodName = "/google.cloud.vectorsearch.v1beta.VectorSearchService/ImportDataObjects"
	VectorSearchService_ExportDataObjects_FullMethodName = "/google.cloud.vectorsearch.v1beta.VectorSearchService/ExportDataObjects"
)

Variables

DistanceMetric_name, DistanceMetric_value

var (
	DistanceMetric_name = map[int32]string{
		0: "DISTANCE_METRIC_UNSPECIFIED",
		1: "DOT_PRODUCT",
		2: "COSINE_DISTANCE",
	}
	DistanceMetric_value = map[string]int32{
		"DISTANCE_METRIC_UNSPECIFIED": 0,
		"DOT_PRODUCT":                 1,
		"COSINE_DISTANCE":             2,
	}
)

Enum value maps for DistanceMetric.

AggregationMethod_name, AggregationMethod_value

var (
	AggregationMethod_name = map[int32]string{
		0: "AGGREGATION_METHOD_UNSPECIFIED",
		1: "COUNT",
	}
	AggregationMethod_value = map[string]int32{
		"AGGREGATION_METHOD_UNSPECIFIED": 0,
		"COUNT":                          1,
	}
)

Enum value maps for AggregationMethod.

EmbeddingTaskType_name, EmbeddingTaskType_value

var (
	EmbeddingTaskType_name = map[int32]string{
		0: "EMBEDDING_TASK_TYPE_UNSPECIFIED",
		1: "RETRIEVAL_QUERY",
		2: "RETRIEVAL_DOCUMENT",
		3: "SEMANTIC_SIMILARITY",
		4: "CLASSIFICATION",
		5: "CLUSTERING",
		6: "QUESTION_ANSWERING",
		7: "FACT_VERIFICATION",
		8: "CODE_RETRIEVAL_QUERY",
	}
	EmbeddingTaskType_value = map[string]int32{
		"EMBEDDING_TASK_TYPE_UNSPECIFIED": 0,
		"RETRIEVAL_QUERY":                 1,
		"RETRIEVAL_DOCUMENT":              2,
		"SEMANTIC_SIMILARITY":             3,
		"CLASSIFICATION":                  4,
		"CLUSTERING":                      5,
		"QUESTION_ANSWERING":              6,
		"FACT_VERIFICATION":               7,
		"CODE_RETRIEVAL_QUERY":            8,
	}
)

Enum value maps for EmbeddingTaskType.

ExportDataObjectsRequest_GcsExportDestination_Format_name, ExportDataObjectsRequest_GcsExportDestination_Format_value

var (
	ExportDataObjectsRequest_GcsExportDestination_Format_name = map[int32]string{
		0: "FORMAT_UNSPECIFIED",
		1: "JSON",
	}
	ExportDataObjectsRequest_GcsExportDestination_Format_value = map[string]int32{
		"FORMAT_UNSPECIFIED": 0,
		"JSON":               1,
	}
)

Enum value maps for ExportDataObjectsRequest_GcsExportDestination_Format.

DedicatedInfrastructure_Mode_name, DedicatedInfrastructure_Mode_value

var (
	DedicatedInfrastructure_Mode_name = map[int32]string{
		0: "MODE_UNSPECIFIED",
		1: "STORAGE_OPTIMIZED",
		2: "PERFORMANCE_OPTIMIZED",
	}
	DedicatedInfrastructure_Mode_value = map[string]int32{
		"MODE_UNSPECIFIED":      0,
		"STORAGE_OPTIMIZED":     1,
		"PERFORMANCE_OPTIMIZED": 2,
	}
)

Enum value maps for DedicatedInfrastructure_Mode.

DenseScannIndex_FeatureNormType_name, DenseScannIndex_FeatureNormType_value

var (
	DenseScannIndex_FeatureNormType_name = map[int32]string{
		0: "FEATURE_NORM_TYPE_UNSPECIFIED",
		1: "NONE",
		2: "UNIT_L2_NORM",
	}
	DenseScannIndex_FeatureNormType_value = map[string]int32{
		"FEATURE_NORM_TYPE_UNSPECIFIED": 0,
		"NONE":                          1,
		"UNIT_L2_NORM":                  2,
	}
)

Enum value maps for DenseScannIndex_FeatureNormType.

DataObjectSearchService_ServiceDesc

var DataObjectSearchService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "google.cloud.vectorsearch.v1beta.DataObjectSearchService",
	HandlerType: (*DataObjectSearchServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "SearchDataObjects",
			Handler:    _DataObjectSearchService_SearchDataObjects_Handler,
		},
		{
			MethodName: "QueryDataObjects",
			Handler:    _DataObjectSearchService_QueryDataObjects_Handler,
		},
		{
			MethodName: "AggregateDataObjects",
			Handler:    _DataObjectSearchService_AggregateDataObjects_Handler,
		},
		{
			MethodName: "BatchSearchDataObjects",
			Handler:    _DataObjectSearchService_BatchSearchDataObjects_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "google/cloud/vectorsearch/v1beta/data_object_search_service.proto",
}

DataObjectSearchService_ServiceDesc is the grpc.ServiceDesc for DataObjectSearchService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

DataObjectService_ServiceDesc

var DataObjectService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "google.cloud.vectorsearch.v1beta.DataObjectService",
	HandlerType: (*DataObjectServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "CreateDataObject",
			Handler:    _DataObjectService_CreateDataObject_Handler,
		},
		{
			MethodName: "BatchCreateDataObjects",
			Handler:    _DataObjectService_BatchCreateDataObjects_Handler,
		},
		{
			MethodName: "GetDataObject",
			Handler:    _DataObjectService_GetDataObject_Handler,
		},
		{
			MethodName: "UpdateDataObject",
			Handler:    _DataObjectService_UpdateDataObject_Handler,
		},
		{
			MethodName: "BatchUpdateDataObjects",
			Handler:    _DataObjectService_BatchUpdateDataObjects_Handler,
		},
		{
			MethodName: "DeleteDataObject",
			Handler:    _DataObjectService_DeleteDataObject_Handler,
		},
		{
			MethodName: "BatchDeleteDataObjects",
			Handler:    _DataObjectService_BatchDeleteDataObjects_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "google/cloud/vectorsearch/v1beta/data_object_service.proto",
}

DataObjectService_ServiceDesc is the grpc.ServiceDesc for DataObjectService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

File_google_cloud_vectorsearch_v1beta_common_proto

var File_google_cloud_vectorsearch_v1beta_common_proto protoreflect.FileDescriptor

File_google_cloud_vectorsearch_v1beta_data_object_proto

var File_google_cloud_vectorsearch_v1beta_data_object_proto protoreflect.FileDescriptor

File_google_cloud_vectorsearch_v1beta_data_object_search_service_proto

var File_google_cloud_vectorsearch_v1beta_data_object_search_service_proto protoreflect.FileDescriptor

File_google_cloud_vectorsearch_v1beta_data_object_service_proto

var File_google_cloud_vectorsearch_v1beta_data_object_service_proto protoreflect.FileDescriptor

File_google_cloud_vectorsearch_v1beta_embedding_config_proto

var File_google_cloud_vectorsearch_v1beta_embedding_config_proto protoreflect.FileDescriptor

File_google_cloud_vectorsearch_v1beta_vectorsearch_service_proto

var File_google_cloud_vectorsearch_v1beta_vectorsearch_service_proto protoreflect.FileDescriptor

VectorSearchService_ServiceDesc

var VectorSearchService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "google.cloud.vectorsearch.v1beta.VectorSearchService",
	HandlerType: (*VectorSearchServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "ListCollections",
			Handler:    _VectorSearchService_ListCollections_Handler,
		},
		{
			MethodName: "GetCollection",
			Handler:    _VectorSearchService_GetCollection_Handler,
		},
		{
			MethodName: "CreateCollection",
			Handler:    _VectorSearchService_CreateCollection_Handler,
		},
		{
			MethodName: "UpdateCollection",
			Handler:    _VectorSearchService_UpdateCollection_Handler,
		},
		{
			MethodName: "DeleteCollection",
			Handler:    _VectorSearchService_DeleteCollection_Handler,
		},
		{
			MethodName: "ListIndexes",
			Handler:    _VectorSearchService_ListIndexes_Handler,
		},
		{
			MethodName: "GetIndex",
			Handler:    _VectorSearchService_GetIndex_Handler,
		},
		{
			MethodName: "CreateIndex",
			Handler:    _VectorSearchService_CreateIndex_Handler,
		},
		{
			MethodName: "DeleteIndex",
			Handler:    _VectorSearchService_DeleteIndex_Handler,
		},
		{
			MethodName: "ImportDataObjects",
			Handler:    _VectorSearchService_ImportDataObjects_Handler,
		},
		{
			MethodName: "ExportDataObjects",
			Handler:    _VectorSearchService_ExportDataObjects_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "google/cloud/vectorsearch/v1beta/vectorsearch_service.proto",
}

VectorSearchService_ServiceDesc is the grpc.ServiceDesc for VectorSearchService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

Functions

func RegisterDataObjectSearchServiceServer

func RegisterDataObjectSearchServiceServer(s grpc.ServiceRegistrar, srv DataObjectSearchServiceServer)

func RegisterDataObjectServiceServer

func RegisterDataObjectServiceServer(s grpc.ServiceRegistrar, srv DataObjectServiceServer)

func RegisterVectorSearchServiceServer

func RegisterVectorSearchServiceServer(s grpc.ServiceRegistrar, srv VectorSearchServiceServer)

AggregateDataObjectsRequest

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.v1beta.AggregationMethod" json:"aggregate,omitempty"`
	// contains filtered or unexported fields
}

Request message for [DataObjectSearchService.AggregateDataObjects][google.cloud.vectorsearch.v1beta.DataObjectSearchService.AggregateDataObjects].

func (*AggregateDataObjectsRequest) Descriptor

func (*AggregateDataObjectsRequest) Descriptor() ([]byte, []int)

Deprecated: Use AggregateDataObjectsRequest.ProtoReflect.Descriptor instead.

func (*AggregateDataObjectsRequest) GetAggregate

func (x *AggregateDataObjectsRequest) GetAggregate() AggregationMethod

func (*AggregateDataObjectsRequest) GetFilter

func (x *AggregateDataObjectsRequest) GetFilter() *structpb.Struct

func (*AggregateDataObjectsRequest) GetParent

func (x *AggregateDataObjectsRequest) GetParent() string

func (*AggregateDataObjectsRequest) ProtoMessage

func (*AggregateDataObjectsRequest) ProtoMessage()

func (*AggregateDataObjectsRequest) ProtoReflect

func (x *AggregateDataObjectsRequest) ProtoReflect() protoreflect.Message

func (*AggregateDataObjectsRequest) Reset

func (x *AggregateDataObjectsRequest) Reset()

func (*AggregateDataObjectsRequest) String

func (x *AggregateDataObjectsRequest) String() string

AggregateDataObjectsResponse

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
}

Response message for [DataObjectSearchService.AggregateDataObjects][google.cloud.vectorsearch.v1beta.DataObjectSearchService.AggregateDataObjects].

func (*AggregateDataObjectsResponse) Descriptor

func (*AggregateDataObjectsResponse) Descriptor() ([]byte, []int)

Deprecated: Use AggregateDataObjectsResponse.ProtoReflect.Descriptor instead.

func (*AggregateDataObjectsResponse) GetAggregateResults

func (x *AggregateDataObjectsResponse) GetAggregateResults() []*structpb.Struct

func (*AggregateDataObjectsResponse) ProtoMessage

func (*AggregateDataObjectsResponse) ProtoMessage()

func (*AggregateDataObjectsResponse) ProtoReflect

func (x *AggregateDataObjectsResponse) ProtoReflect() protoreflect.Message

func (*AggregateDataObjectsResponse) Reset

func (x *AggregateDataObjectsResponse) Reset()

func (*AggregateDataObjectsResponse) String

func (x *AggregateDataObjectsResponse) String() string

AggregationMethod

type AggregationMethod int32

Aggregation methods.

AggregationMethod_AGGREGATION_METHOD_UNSPECIFIED, AggregationMethod_COUNT

const (
	// Should not be used.
	AggregationMethod_AGGREGATION_METHOD_UNSPECIFIED AggregationMethod = 0
	// Count the number of data objects that match the filter.
	AggregationMethod_COUNT AggregationMethod = 1
)

func (AggregationMethod) Descriptor

func (AggregationMethod) Descriptor() protoreflect.EnumDescriptor

func (AggregationMethod) Enum

func (x AggregationMethod) Enum() *AggregationMethod

func (AggregationMethod) EnumDescriptor

func (AggregationMethod) EnumDescriptor() ([]byte, []int)

Deprecated: Use AggregationMethod.Descriptor instead.

func (AggregationMethod) Number

func (x AggregationMethod) Number() protoreflect.EnumNumber

func (AggregationMethod) String

func (x AggregationMethod) String() string

func (AggregationMethod) Type

func (AggregationMethod) Type() protoreflect.EnumType

BatchCreateDataObjectsRequest

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
}

Request message for [DataObjectService.BatchCreateDataObjects][google.cloud.vectorsearch.v1beta.DataObjectService.BatchCreateDataObjects].

func (*BatchCreateDataObjectsRequest) Descriptor

func (*BatchCreateDataObjectsRequest) Descriptor() ([]byte, []int)

Deprecated: Use BatchCreateDataObjectsRequest.ProtoReflect.Descriptor instead.

func (*BatchCreateDataObjectsRequest) GetParent

func (x *BatchCreateDataObjectsRequest) GetParent() string

func (*BatchCreateDataObjectsRequest) GetRequests

func (x *BatchCreateDataObjectsRequest) GetRequests() []*CreateDataObjectRequest

func (*BatchCreateDataObjectsRequest) ProtoMessage

func (*BatchCreateDataObjectsRequest) ProtoMessage()

func (*BatchCreateDataObjectsRequest) ProtoReflect

func (x *BatchCreateDataObjectsRequest) ProtoReflect() protoreflect.Message

func (*BatchCreateDataObjectsRequest) Reset

func (x *BatchCreateDataObjectsRequest) Reset()

func (*BatchCreateDataObjectsRequest) String

func (x *BatchCreateDataObjectsRequest) String() string

BatchCreateDataObjectsResponse

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
}

Response message for [DataObjectService.BatchCreateDataObjects][google.cloud.vectorsearch.v1beta.DataObjectService.BatchCreateDataObjects].

func (*BatchCreateDataObjectsResponse) Descriptor

func (*BatchCreateDataObjectsResponse) Descriptor() ([]byte, []int)

Deprecated: Use BatchCreateDataObjectsResponse.ProtoReflect.Descriptor instead.

func (*BatchCreateDataObjectsResponse) GetDataObjects

func (x *BatchCreateDataObjectsResponse) GetDataObjects() []*DataObject

func (*BatchCreateDataObjectsResponse) ProtoMessage

func (*BatchCreateDataObjectsResponse) ProtoMessage()

func (*BatchCreateDataObjectsResponse) ProtoReflect

func (x *BatchCreateDataObjectsResponse) ProtoReflect() protoreflect.Message

func (*BatchCreateDataObjectsResponse) Reset

func (x *BatchCreateDataObjectsResponse) Reset()

func (*BatchCreateDataObjectsResponse) String

func (x *BatchCreateDataObjectsResponse) String() string

BatchDeleteDataObjectsRequest

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
}

Request message for [DataObjectService.BatchDeleteDataObjects][google.cloud.vectorsearch.v1beta.DataObjectService.BatchDeleteDataObjects].

func (*BatchDeleteDataObjectsRequest) Descriptor

func (*BatchDeleteDataObjectsRequest) Descriptor() ([]byte, []int)

Deprecated: Use BatchDeleteDataObjectsRequest.ProtoReflect.Descriptor instead.

func (*BatchDeleteDataObjectsRequest) GetParent

func (x *BatchDeleteDataObjectsRequest) GetParent() string

func (*BatchDeleteDataObjectsRequest) GetRequests

func (x *BatchDeleteDataObjectsRequest) GetRequests() []*DeleteDataObjectRequest

func (*BatchDeleteDataObjectsRequest) ProtoMessage

func (*BatchDeleteDataObjectsRequest) ProtoMessage()

func (*BatchDeleteDataObjectsRequest) ProtoReflect

func (x *BatchDeleteDataObjectsRequest) ProtoReflect() protoreflect.Message

func (*BatchDeleteDataObjectsRequest) Reset

func (x *BatchDeleteDataObjectsRequest) Reset()

func (*BatchDeleteDataObjectsRequest) String

func (x *BatchDeleteDataObjectsRequest) String() string

BatchSearchDataObjectsRequest

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
}

A request to perform a batch of search operations.

func (*BatchSearchDataObjectsRequest) Descriptor

func (*BatchSearchDataObjectsRequest) Descriptor() ([]byte, []int)

Deprecated: Use BatchSearchDataObjectsRequest.ProtoReflect.Descriptor instead.

func (*BatchSearchDataObjectsRequest) GetCombine

func (x *BatchSearchDataObjectsRequest) GetCombine() *BatchSearchDataObjectsRequest_CombineResultsOptions

func (*BatchSearchDataObjectsRequest) GetParent

func (x *BatchSearchDataObjectsRequest) GetParent() string

func (*BatchSearchDataObjectsRequest) GetSearches

func (x *BatchSearchDataObjectsRequest) GetSearches() []*Search

func (*BatchSearchDataObjectsRequest) ProtoMessage

func (*BatchSearchDataObjectsRequest) ProtoMessage()

func (*BatchSearchDataObjectsRequest) ProtoReflect

func (x *BatchSearchDataObjectsRequest) ProtoReflect() protoreflect.Message

func (*BatchSearchDataObjectsRequest) Reset

func (x *BatchSearchDataObjectsRequest) Reset()

func (*BatchSearchDataObjectsRequest) String

func (x *BatchSearchDataObjectsRequest) String() string

BatchSearchDataObjectsRequest_CombineResultsOptions

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
}

Options for combining the results of the batch search operations.

func (*BatchSearchDataObjectsRequest_CombineResultsOptions) Descriptor

func (*BatchSearchDataObjectsRequest_CombineResultsOptions) Descriptor() ([]byte, []int)

Deprecated: Use BatchSearchDataObjectsRequest_CombineResultsOptions.ProtoReflect.Descriptor instead.

func (*BatchSearchDataObjectsRequest_CombineResultsOptions) GetOutputFields

func (x *BatchSearchDataObjectsRequest_CombineResultsOptions) GetOutputFields() *OutputFields

func (*BatchSearchDataObjectsRequest_CombineResultsOptions) GetRanker

func (x *BatchSearchDataObjectsRequest_CombineResultsOptions) GetRanker() *Ranker

func (*BatchSearchDataObjectsRequest_CombineResultsOptions) GetTopK

func (x *BatchSearchDataObjectsRequest_CombineResultsOptions) GetTopK() int32

func (*BatchSearchDataObjectsRequest_CombineResultsOptions) ProtoMessage

func (*BatchSearchDataObjectsRequest_CombineResultsOptions) ProtoMessage()

func (*BatchSearchDataObjectsRequest_CombineResultsOptions) ProtoReflect

func (x *BatchSearchDataObjectsRequest_CombineResultsOptions) ProtoReflect() protoreflect.Message

func (*BatchSearchDataObjectsRequest_CombineResultsOptions) Reset

func (x *BatchSearchDataObjectsRequest_CombineResultsOptions) Reset()

func (*BatchSearchDataObjectsRequest_CombineResultsOptions) String

func (x *BatchSearchDataObjectsRequest_CombineResultsOptions) String() string

BatchSearchDataObjectsResponse

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
}

A response from a batch search operation.

func (*BatchSearchDataObjectsResponse) Descriptor

func (*BatchSearchDataObjectsResponse) Descriptor() ([]byte, []int)

Deprecated: Use BatchSearchDataObjectsResponse.ProtoReflect.Descriptor instead.

func (*BatchSearchDataObjectsResponse) GetResults

func (x *BatchSearchDataObjectsResponse) GetResults() []*SearchDataObjectsResponse

func (*BatchSearchDataObjectsResponse) ProtoMessage

func (*BatchSearchDataObjectsResponse) ProtoMessage()

func (*BatchSearchDataObjectsResponse) ProtoReflect

func (x *BatchSearchDataObjectsResponse) ProtoReflect() protoreflect.Message

func (*BatchSearchDataObjectsResponse) Reset

func (x *BatchSearchDataObjectsResponse) Reset()

func (*BatchSearchDataObjectsResponse) String

func (x *BatchSearchDataObjectsResponse) String() string

BatchUpdateDataObjectsRequest

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
}

Request message for [DataObjectService.BatchUpdateDataObjects][google.cloud.vectorsearch.v1beta.DataObjectService.BatchUpdateDataObjects].

func (*BatchUpdateDataObjectsRequest) Descriptor

func (*BatchUpdateDataObjectsRequest) Descriptor() ([]byte, []int)

Deprecated: Use BatchUpdateDataObjectsRequest.ProtoReflect.Descriptor instead.

func (*BatchUpdateDataObjectsRequest) GetParent

func (x *BatchUpdateDataObjectsRequest) GetParent() string

func (*BatchUpdateDataObjectsRequest) GetRequests

func (x *BatchUpdateDataObjectsRequest) GetRequests() []*UpdateDataObjectRequest

func (*BatchUpdateDataObjectsRequest) ProtoMessage

func (*BatchUpdateDataObjectsRequest) ProtoMessage()

func (*BatchUpdateDataObjectsRequest) ProtoReflect

func (x *BatchUpdateDataObjectsRequest) ProtoReflect() protoreflect.Message

func (*BatchUpdateDataObjectsRequest) Reset

func (x *BatchUpdateDataObjectsRequest) Reset()

func (*BatchUpdateDataObjectsRequest) String

func (x *BatchUpdateDataObjectsRequest) String() string

BatchUpdateDataObjectsResponse

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

Response message for [DataObjectService.BatchUpdateDataObjects][google.cloud.vectorsearch.v1beta.DataObjectService.BatchUpdateDataObjects].

func (*BatchUpdateDataObjectsResponse) Descriptor

func (*BatchUpdateDataObjectsResponse) Descriptor() ([]byte, []int)

Deprecated: Use BatchUpdateDataObjectsResponse.ProtoReflect.Descriptor instead.

func (*BatchUpdateDataObjectsResponse) ProtoMessage

func (*BatchUpdateDataObjectsResponse) ProtoMessage()

func (*BatchUpdateDataObjectsResponse) ProtoReflect

func (x *BatchUpdateDataObjectsResponse) ProtoReflect() protoreflect.Message

func (*BatchUpdateDataObjectsResponse) Reset

func (x *BatchUpdateDataObjectsResponse) Reset()

func (*BatchUpdateDataObjectsResponse) String

func (x *BatchUpdateDataObjectsResponse) String() string

Collection

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 `protobuf:"bytes,4,rep,name=labels,proto3" json:"labels,omitempty" protobuf_key:"bytes,1,opt,name=key" protobuf_val:"bytes,2,opt,name=value"`
	// Optional. Deprecated: JSON Schema for data. Please use data_schema instead.
	//
	// Deprecated: Marked as deprecated in google/cloud/vectorsearch/v1beta/vectorsearch_service.proto.
	Schema *structpb.Struct `protobuf:"bytes,5,opt,name=schema,proto3" json:"schema,omitempty"`
	// 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 `protobuf:"bytes,7,rep,name=vector_schema,json=vectorSchema,proto3" json:"vector_schema,omitempty" protobuf_key:"bytes,1,opt,name=key" protobuf_val:"bytes,2,opt,name=value"`
	// 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
}

Message describing Collection object

func (*Collection) Descriptor

func (*Collection) Descriptor() ([]byte, []int)

Deprecated: Use Collection.ProtoReflect.Descriptor instead.

func (*Collection) GetCreateTime

func (x *Collection) GetCreateTime() *timestamppb.Timestamp

func (*Collection) GetDataSchema

func (x *Collection) GetDataSchema() *structpb.Struct

func (*Collection) GetDescription

func (x *Collection) GetDescription() string

func (*Collection) GetDisplayName

func (x *Collection) GetDisplayName() string

func (*Collection) GetLabels

func (x *Collection) GetLabels() map[string]string

func (*Collection) GetName

func (x *Collection) GetName() string

func (*Collection) GetSchema

func (x *Collection) GetSchema() *structpb.Struct

Deprecated: Marked as deprecated in google/cloud/vectorsearch/v1beta/vectorsearch_service.proto.

func (*Collection) GetUpdateTime

func (x *Collection) GetUpdateTime() *timestamppb.Timestamp

func (*Collection) GetVectorSchema

func (x *Collection) GetVectorSchema() map[string]*VectorField

func (*Collection) ProtoMessage

func (*Collection) ProtoMessage()

func (*Collection) ProtoReflect

func (x *Collection) ProtoReflect() protoreflect.Message

func (*Collection) Reset

func (x *Collection) Reset()

func (*Collection) String

func (x *Collection) String() string

CreateCollectionRequest

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
}

Message for creating a Collection

func (*CreateCollectionRequest) Descriptor

func (*CreateCollectionRequest) Descriptor() ([]byte, []int)

Deprecated: Use CreateCollectionRequest.ProtoReflect.Descriptor instead.

func (*CreateCollectionRequest) GetCollection

func (x *CreateCollectionRequest) GetCollection() *Collection

func (*CreateCollectionRequest) GetCollectionId

func (x *CreateCollectionRequest) GetCollectionId() string

func (*CreateCollectionRequest) GetParent

func (x *CreateCollectionRequest) GetParent() string

func (*CreateCollectionRequest) GetRequestId

func (x *CreateCollectionRequest) GetRequestId() string

func (*CreateCollectionRequest) ProtoMessage

func (*CreateCollectionRequest) ProtoMessage()

func (*CreateCollectionRequest) ProtoReflect

func (x *CreateCollectionRequest) ProtoReflect() protoreflect.Message

func (*CreateCollectionRequest) Reset

func (x *CreateCollectionRequest) Reset()

func (*CreateCollectionRequest) String

func (x *CreateCollectionRequest) String() string

CreateDataObjectRequest

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
}

Request message for [DataObjectService.CreateDataObject][google.cloud.vectorsearch.v1beta.DataObjectService.CreateDataObject].

func (*CreateDataObjectRequest) Descriptor

func (*CreateDataObjectRequest) Descriptor() ([]byte, []int)

Deprecated: Use CreateDataObjectRequest.ProtoReflect.Descriptor instead.

func (*CreateDataObjectRequest) GetDataObject

func (x *CreateDataObjectRequest) GetDataObject() *DataObject

func (*CreateDataObjectRequest) GetDataObjectId

func (x *CreateDataObjectRequest) GetDataObjectId() string

func (*CreateDataObjectRequest) GetParent

func (x *CreateDataObjectRequest) GetParent() string

func (*CreateDataObjectRequest) ProtoMessage

func (*CreateDataObjectRequest) ProtoMessage()

func (*CreateDataObjectRequest) ProtoReflect

func (x *CreateDataObjectRequest) ProtoReflect() protoreflect.Message

func (*CreateDataObjectRequest) Reset

func (x *CreateDataObjectRequest) Reset()

func (*CreateDataObjectRequest) String

func (x *CreateDataObjectRequest) String() string

CreateIndexRequest

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
}

Message for creating an Index.

func (*CreateIndexRequest) Descriptor

func (*CreateIndexRequest) Descriptor() ([]byte, []int)

Deprecated: Use CreateIndexRequest.ProtoReflect.Descriptor instead.

func (*CreateIndexRequest) GetIndex

func (x *CreateIndexRequest) GetIndex() *Index

func (*CreateIndexRequest) GetIndexId

func (x *CreateIndexRequest) GetIndexId() string

func (*CreateIndexRequest) GetParent

func (x *CreateIndexRequest) GetParent() string

func (*CreateIndexRequest) GetRequestId

func (x *CreateIndexRequest) GetRequestId() string

func (*CreateIndexRequest) ProtoMessage

func (*CreateIndexRequest) ProtoMessage()

func (*CreateIndexRequest) ProtoReflect

func (x *CreateIndexRequest) ProtoReflect() protoreflect.Message

func (*CreateIndexRequest) Reset

func (x *CreateIndexRequest) Reset()

func (*CreateIndexRequest) String

func (x *CreateIndexRequest) String() string

DataObject

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 `protobuf:"bytes,7,rep,name=vectors,proto3" json:"vectors,omitempty" protobuf_key:"bytes,1,opt,name=key" protobuf_val:"bytes,2,opt,name=value"`
	// Optional. The etag of the dataObject.
	Etag string `protobuf:"bytes,8,opt,name=etag,proto3" json:"etag,omitempty"`
	// contains filtered or unexported fields
}

A dataObject resource in Vector Search.

func (*DataObject) Descriptor

func (*DataObject) Descriptor() ([]byte, []int)

Deprecated: Use DataObject.ProtoReflect.Descriptor instead.

func (*DataObject) GetCreateTime

func (x *DataObject) GetCreateTime() *timestamppb.Timestamp

func (*DataObject) GetData

func (x *DataObject) GetData() *structpb.Struct

func (*DataObject) GetDataObjectId

func (x *DataObject) GetDataObjectId() string

func (*DataObject) GetEtag

func (x *DataObject) GetEtag() string

func (*DataObject) GetName

func (x *DataObject) GetName() string

func (*DataObject) GetUpdateTime

func (x *DataObject) GetUpdateTime() *timestamppb.Timestamp

func (*DataObject) GetVectors

func (x *DataObject) GetVectors() map[string]*Vector

func (*DataObject) ProtoMessage

func (*DataObject) ProtoMessage()

func (*DataObject) ProtoReflect

func (x *DataObject) ProtoReflect() protoreflect.Message

func (*DataObject) Reset

func (x *DataObject) Reset()

func (*DataObject) String

func (x *DataObject) String() string

DataObjectSearchServiceClient

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)
}

DataObjectSearchServiceClient is the client API for DataObjectSearchService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

func NewDataObjectSearchServiceClient

func NewDataObjectSearchServiceClient(cc grpc.ClientConnInterface) DataObjectSearchServiceClient

DataObjectSearchServiceServer

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)
}

DataObjectSearchServiceServer is the server API for DataObjectSearchService service. All implementations should embed UnimplementedDataObjectSearchServiceServer for forward compatibility

DataObjectServiceClient

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)
}

DataObjectServiceClient is the client API for DataObjectService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

func NewDataObjectServiceClient

func NewDataObjectServiceClient(cc grpc.ClientConnInterface) DataObjectServiceClient

DataObjectServiceServer

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)
}

DataObjectServiceServer is the server API for DataObjectService service. All implementations should embed UnimplementedDataObjectServiceServer for forward compatibility

DedicatedInfrastructure

type DedicatedInfrastructure struct {

	// Optional. Mode of the dedicated infrastructure.
	Mode *DedicatedInfrastructure_Mode `protobuf:"varint,1,opt,name=mode,proto3,enum=google.cloud.vectorsearch.v1beta.DedicatedInfrastructure_Mode,oneof" json:"mode,omitempty"`
	// 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
}

Represents dedicated infrastructure for the index.

func (*DedicatedInfrastructure) Descriptor

func (*DedicatedInfrastructure) Descriptor() ([]byte, []int)

Deprecated: Use DedicatedInfrastructure.ProtoReflect.Descriptor instead.

func (*DedicatedInfrastructure) GetAutoscalingSpec

func (x *DedicatedInfrastructure) GetAutoscalingSpec() *DedicatedInfrastructure_AutoscalingSpec

func (*DedicatedInfrastructure) GetMode

func (x *DedicatedInfrastructure) GetMode() DedicatedInfrastructure_Mode

func (*DedicatedInfrastructure) ProtoMessage

func (*DedicatedInfrastructure) ProtoMessage()

func (*DedicatedInfrastructure) ProtoReflect

func (x *DedicatedInfrastructure) ProtoReflect() protoreflect.Message

func (*DedicatedInfrastructure) Reset

func (x *DedicatedInfrastructure) Reset()

func (*DedicatedInfrastructure) String

func (x *DedicatedInfrastructure) String() string

DedicatedInfrastructure_AutoscalingSpec

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
}

Specification for autoscaling.

func (*DedicatedInfrastructure_AutoscalingSpec) Descriptor

func (*DedicatedInfrastructure_AutoscalingSpec) Descriptor() ([]byte, []int)

Deprecated: Use DedicatedInfrastructure_AutoscalingSpec.ProtoReflect.Descriptor instead.

func (*DedicatedInfrastructure_AutoscalingSpec) GetMaxReplicaCount

func (x *DedicatedInfrastructure_AutoscalingSpec) GetMaxReplicaCount() int32

func (*DedicatedInfrastructure_AutoscalingSpec) GetMinReplicaCount

func (x *DedicatedInfrastructure_AutoscalingSpec) GetMinReplicaCount() int32

func (*DedicatedInfrastructure_AutoscalingSpec) ProtoMessage

func (*DedicatedInfrastructure_AutoscalingSpec) ProtoMessage()

func (*DedicatedInfrastructure_AutoscalingSpec) ProtoReflect

func (x *DedicatedInfrastructure_AutoscalingSpec) ProtoReflect() protoreflect.Message

func (*DedicatedInfrastructure_AutoscalingSpec) Reset

func (x *DedicatedInfrastructure_AutoscalingSpec) Reset()

func (*DedicatedInfrastructure_AutoscalingSpec) String

func (x *DedicatedInfrastructure_AutoscalingSpec) String() string

DedicatedInfrastructure_Mode

type DedicatedInfrastructure_Mode int32

Mode of the dedicated infrastructure.

DedicatedInfrastructure_MODE_UNSPECIFIED, DedicatedInfrastructure_STORAGE_OPTIMIZED, DedicatedInfrastructure_PERFORMANCE_OPTIMIZED

const (
	// Default will use `PERFORMANCE_OPTIMIZED`.
	DedicatedInfrastructure_MODE_UNSPECIFIED DedicatedInfrastructure_Mode = 0
	// This is storage optimized variation.
	DedicatedInfrastructure_STORAGE_OPTIMIZED DedicatedInfrastructure_Mode = 1
	// This is Performance optimized on E2 or equivalent family.
	DedicatedInfrastructure_PERFORMANCE_OPTIMIZED DedicatedInfrastructure_Mode = 2
)

func (DedicatedInfrastructure_Mode) Descriptor

func (DedicatedInfrastructure_Mode) Descriptor() protoreflect.EnumDescriptor

func (DedicatedInfrastructure_Mode) Enum

func (x DedicatedInfrastructure_Mode) Enum() *DedicatedInfrastructure_Mode

func (DedicatedInfrastructure_Mode) EnumDescriptor

func (DedicatedInfrastructure_Mode) EnumDescriptor() ([]byte, []int)

Deprecated: Use DedicatedInfrastructure_Mode.Descriptor instead.

func (DedicatedInfrastructure_Mode) Number

func (x DedicatedInfrastructure_Mode) Number() protoreflect.EnumNumber

func (DedicatedInfrastructure_Mode) String

func (x DedicatedInfrastructure_Mode) String() string

func (DedicatedInfrastructure_Mode) Type

func (DedicatedInfrastructure_Mode) Type() protoreflect.EnumType

DeleteCollectionRequest

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
}

Message for deleting a Collection

func (*DeleteCollectionRequest) Descriptor

func (*DeleteCollectionRequest) Descriptor() ([]byte, []int)

Deprecated: Use DeleteCollectionRequest.ProtoReflect.Descriptor instead.

func (*DeleteCollectionRequest) GetName

func (x *DeleteCollectionRequest) GetName() string

func (*DeleteCollectionRequest) GetRequestId

func (x *DeleteCollectionRequest) GetRequestId() string

func (*DeleteCollectionRequest) ProtoMessage

func (*DeleteCollectionRequest) ProtoMessage()

func (*DeleteCollectionRequest) ProtoReflect

func (x *DeleteCollectionRequest) ProtoReflect() protoreflect.Message

func (*DeleteCollectionRequest) Reset

func (x *DeleteCollectionRequest) Reset()

func (*DeleteCollectionRequest) String

func (x *DeleteCollectionRequest) String() string

DeleteDataObjectRequest

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
}

Request message for [DataObjectService.DeleteDataObject][google.cloud.vectorsearch.v1beta.DataObjectService.DeleteDataObject].

func (*DeleteDataObjectRequest) Descriptor

func (*DeleteDataObjectRequest) Descriptor() ([]byte, []int)

Deprecated: Use DeleteDataObjectRequest.ProtoReflect.Descriptor instead.

func (*DeleteDataObjectRequest) GetEtag

func (x *DeleteDataObjectRequest) GetEtag() string

func (*DeleteDataObjectRequest) GetName

func (x *DeleteDataObjectRequest) GetName() string

func (*DeleteDataObjectRequest) ProtoMessage

func (*DeleteDataObjectRequest) ProtoMessage()

func (*DeleteDataObjectRequest) ProtoReflect

func (x *DeleteDataObjectRequest) ProtoReflect() protoreflect.Message

func (*DeleteDataObjectRequest) Reset

func (x *DeleteDataObjectRequest) Reset()

func (*DeleteDataObjectRequest) String

func (x *DeleteDataObjectRequest) String() string

DeleteIndexRequest

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
}

Message for deleting an Index.

func (*DeleteIndexRequest) Descriptor

func (*DeleteIndexRequest) Descriptor() ([]byte, []int)

Deprecated: Use DeleteIndexRequest.ProtoReflect.Descriptor instead.

func (*DeleteIndexRequest) GetName

func (x *DeleteIndexRequest) GetName() string

func (*DeleteIndexRequest) GetRequestId

func (x *DeleteIndexRequest) GetRequestId() string

func (*DeleteIndexRequest) ProtoMessage

func (*DeleteIndexRequest) ProtoMessage()

func (*DeleteIndexRequest) ProtoReflect

func (x *DeleteIndexRequest) ProtoReflect() protoreflect.Message

func (*DeleteIndexRequest) Reset

func (x *DeleteIndexRequest) Reset()

func (*DeleteIndexRequest) String

func (x *DeleteIndexRequest) String() string

DenseScannIndex

type DenseScannIndex struct {

	// Optional. Feature norm type.
	FeatureNormType DenseScannIndex_FeatureNormType `protobuf:"varint,2,opt,name=feature_norm_type,json=featureNormType,proto3,enum=google.cloud.vectorsearch.v1beta.DenseScannIndex_FeatureNormType" json:"feature_norm_type,omitempty"`
	// contains filtered or unexported fields
}

Dense ScaNN index configuration.

func (*DenseScannIndex) Descriptor

func (*DenseScannIndex) Descriptor() ([]byte, []int)

Deprecated: Use DenseScannIndex.ProtoReflect.Descriptor instead.

func (*DenseScannIndex) GetFeatureNormType

func (x *DenseScannIndex) GetFeatureNormType() DenseScannIndex_FeatureNormType

func (*DenseScannIndex) ProtoMessage

func (*DenseScannIndex) ProtoMessage()

func (*DenseScannIndex) ProtoReflect

func (x *DenseScannIndex) ProtoReflect() protoreflect.Message

func (*DenseScannIndex) Reset

func (x *DenseScannIndex) Reset()

func (*DenseScannIndex) String

func (x *DenseScannIndex) String() string

DenseScannIndex_FeatureNormType

type DenseScannIndex_FeatureNormType int32

Feature norm type for ScaNN index.

DenseScannIndex_FEATURE_NORM_TYPE_UNSPECIFIED, DenseScannIndex_NONE, DenseScannIndex_UNIT_L2_NORM

const (
	// Unspecified feature norm type.
	DenseScannIndex_FEATURE_NORM_TYPE_UNSPECIFIED DenseScannIndex_FeatureNormType = 0
	// No norm applied.
	DenseScannIndex_NONE DenseScannIndex_FeatureNormType = 1
	// Unit L2 norm.
	DenseScannIndex_UNIT_L2_NORM DenseScannIndex_FeatureNormType = 2
)

func (DenseScannIndex_FeatureNormType) Descriptor

func (DenseScannIndex_FeatureNormType) Descriptor() protoreflect.EnumDescriptor

func (DenseScannIndex_FeatureNormType) Enum

func (x DenseScannIndex_FeatureNormType) Enum() *DenseScannIndex_FeatureNormType

func (DenseScannIndex_FeatureNormType) EnumDescriptor

func (DenseScannIndex_FeatureNormType) EnumDescriptor() ([]byte, []int)

Deprecated: Use DenseScannIndex_FeatureNormType.Descriptor instead.

func (DenseScannIndex_FeatureNormType) Number

func (x DenseScannIndex_FeatureNormType) Number() protoreflect.EnumNumber

func (DenseScannIndex_FeatureNormType) String

func (x DenseScannIndex_FeatureNormType) String() string

func (DenseScannIndex_FeatureNormType) Type

func (DenseScannIndex_FeatureNormType) Type() protoreflect.EnumType

DenseVector

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
}

A dense vector.

func (*DenseVector) Descriptor

func (*DenseVector) Descriptor() ([]byte, []int)

Deprecated: Use DenseVector.ProtoReflect.Descriptor instead.

func (*DenseVector) GetValues

func (x *DenseVector) GetValues() []float32

func (*DenseVector) ProtoMessage

func (*DenseVector) ProtoMessage()

func (*DenseVector) ProtoReflect

func (x *DenseVector) ProtoReflect() protoreflect.Message

func (*DenseVector) Reset

func (x *DenseVector) Reset()

func (*DenseVector) String

func (x *DenseVector) String() string

DenseVectorField

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 `protobuf:"bytes,3,opt,name=vertex_embedding_config,json=vertexEmbeddingConfig,proto3" json:"vertex_embedding_config,omitempty"`
	// contains filtered or unexported fields
}

Message describing a dense vector field.

func (*DenseVectorField) Descriptor

func (*DenseVectorField) Descriptor() ([]byte, []int)

Deprecated: Use DenseVectorField.ProtoReflect.Descriptor instead.

func (*DenseVectorField) GetDimensions

func (x *DenseVectorField) GetDimensions() int32

func (*DenseVectorField) GetVertexEmbeddingConfig

func (x *DenseVectorField) GetVertexEmbeddingConfig() *VertexEmbeddingConfig

func (*DenseVectorField) ProtoMessage

func (*DenseVectorField) ProtoMessage()

func (*DenseVectorField) ProtoReflect

func (x *DenseVectorField) ProtoReflect() protoreflect.Message

func (*DenseVectorField) Reset

func (x *DenseVectorField) Reset()

func (*DenseVectorField) String

func (x *DenseVectorField) String() string

DistanceMetric

type DistanceMetric int32

Distance metric for vector search.

DistanceMetric_DISTANCE_METRIC_UNSPECIFIED, DistanceMetric_DOT_PRODUCT, DistanceMetric_COSINE_DISTANCE

const (
	// Default value, distance metric is not specified.
	DistanceMetric_DISTANCE_METRIC_UNSPECIFIED DistanceMetric = 0
	// Dot product distance metric.
	DistanceMetric_DOT_PRODUCT DistanceMetric = 1
	// Cosine distance metric.
	DistanceMetric_COSINE_DISTANCE DistanceMetric = 2
)

func (DistanceMetric) Descriptor

func (DistanceMetric) Descriptor() protoreflect.EnumDescriptor

func (DistanceMetric) Enum

func (x DistanceMetric) Enum() *DistanceMetric

func (DistanceMetric) EnumDescriptor

func (DistanceMetric) EnumDescriptor() ([]byte, []int)

Deprecated: Use DistanceMetric.Descriptor instead.

func (DistanceMetric) Number

func (x DistanceMetric) Number() protoreflect.EnumNumber

func (DistanceMetric) String

func (x DistanceMetric) String() string

func (DistanceMetric) Type

func (DistanceMetric) Type() protoreflect.EnumType

EmbeddingTaskType

type EmbeddingTaskType int32

Represents the task the embeddings will be used for.

EmbeddingTaskType_EMBEDDING_TASK_TYPE_UNSPECIFIED, EmbeddingTaskType_RETRIEVAL_QUERY, EmbeddingTaskType_RETRIEVAL_DOCUMENT, EmbeddingTaskType_SEMANTIC_SIMILARITY, EmbeddingTaskType_CLASSIFICATION, EmbeddingTaskType_CLUSTERING, EmbeddingTaskType_QUESTION_ANSWERING, EmbeddingTaskType_FACT_VERIFICATION, EmbeddingTaskType_CODE_RETRIEVAL_QUERY

const (
	// Unspecified task type.
	EmbeddingTaskType_EMBEDDING_TASK_TYPE_UNSPECIFIED EmbeddingTaskType = 0
	// Specifies the given text is a query in a search/retrieval setting.
	EmbeddingTaskType_RETRIEVAL_QUERY EmbeddingTaskType = 1
	// Specifies the given text is a document from the corpus being searched.
	EmbeddingTaskType_RETRIEVAL_DOCUMENT EmbeddingTaskType = 2
	// Specifies the given text will be used for STS.
	EmbeddingTaskType_SEMANTIC_SIMILARITY EmbeddingTaskType = 3
	// Specifies that the given text will be classified.
	EmbeddingTaskType_CLASSIFICATION EmbeddingTaskType = 4
	// Specifies that the embeddings will be used for clustering.
	EmbeddingTaskType_CLUSTERING EmbeddingTaskType = 5
	// Specifies that the embeddings will be used for question answering.
	EmbeddingTaskType_QUESTION_ANSWERING EmbeddingTaskType = 6
	// Specifies that the embeddings will be used for fact verification.
	EmbeddingTaskType_FACT_VERIFICATION EmbeddingTaskType = 7
	// Specifies that the embeddings will be used for code retrieval.
	EmbeddingTaskType_CODE_RETRIEVAL_QUERY EmbeddingTaskType = 8
)

func (EmbeddingTaskType) Descriptor

func (EmbeddingTaskType) Descriptor() protoreflect.EnumDescriptor

func (EmbeddingTaskType) Enum

func (x EmbeddingTaskType) Enum() *EmbeddingTaskType

func (EmbeddingTaskType) EnumDescriptor

func (EmbeddingTaskType) EnumDescriptor() ([]byte, []int)

Deprecated: Use EmbeddingTaskType.Descriptor instead.

func (EmbeddingTaskType) Number

func (x EmbeddingTaskType) Number() protoreflect.EnumNumber

func (EmbeddingTaskType) String

func (x EmbeddingTaskType) String() string

func (EmbeddingTaskType) Type

func (EmbeddingTaskType) Type() protoreflect.EnumType

ExportDataObjectsMetadata

type ExportDataObjectsMetadata 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.
	FinishTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=finish_time,json=finishTime,proto3" json:"finish_time,omitempty"`
	// contains filtered or unexported fields
}

Metadata for the ExportDataObjects LRO.

func (*ExportDataObjectsMetadata) Descriptor

func (*ExportDataObjectsMetadata) Descriptor() ([]byte, []int)

Deprecated: Use ExportDataObjectsMetadata.ProtoReflect.Descriptor instead.

func (*ExportDataObjectsMetadata) GetCreateTime

func (x *ExportDataObjectsMetadata) GetCreateTime() *timestamppb.Timestamp

func (*ExportDataObjectsMetadata) GetFinishTime

func (x *ExportDataObjectsMetadata) GetFinishTime() *timestamppb.Timestamp

func (*ExportDataObjectsMetadata) ProtoMessage

func (*ExportDataObjectsMetadata) ProtoMessage()

func (*ExportDataObjectsMetadata) ProtoReflect

func (x *ExportDataObjectsMetadata) ProtoReflect() protoreflect.Message

func (*ExportDataObjectsMetadata) Reset

func (x *ExportDataObjectsMetadata) Reset()

func (*ExportDataObjectsMetadata) String

func (x *ExportDataObjectsMetadata) String() string

ExportDataObjectsRequest

type ExportDataObjectsRequest struct {

	// The configuration for the export data.
	//
	// Types that are valid to be assigned to Destination:
	//
	//	*ExportDataObjectsRequest_GcsDestination
	Destination isExportDataObjectsRequest_Destination `protobuf_oneof:"destination"`
	// Required. The resource name of the Collection from which we want to export
	// Data Objects. Format:
	// `projects/{project}/locations/{location}/collections/{collection}`.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for [VectorSearchService.ExportDataObjects][google.cloud.vectorsearch.v1beta.VectorSearchService.ExportDataObjects].

func (*ExportDataObjectsRequest) Descriptor

func (*ExportDataObjectsRequest) Descriptor() ([]byte, []int)

Deprecated: Use ExportDataObjectsRequest.ProtoReflect.Descriptor instead.

func (*ExportDataObjectsRequest) GetDestination

func (x *ExportDataObjectsRequest) GetDestination() isExportDataObjectsRequest_Destination

func (*ExportDataObjectsRequest) GetGcsDestination

func (x *ExportDataObjectsRequest) GetGcsDestination() *ExportDataObjectsRequest_GcsExportDestination

func (*ExportDataObjectsRequest) GetName

func (x *ExportDataObjectsRequest) GetName() string

func (*ExportDataObjectsRequest) ProtoMessage

func (*ExportDataObjectsRequest) ProtoMessage()

func (*ExportDataObjectsRequest) ProtoReflect

func (x *ExportDataObjectsRequest) ProtoReflect() protoreflect.Message

func (*ExportDataObjectsRequest) Reset

func (x *ExportDataObjectsRequest) Reset()

func (*ExportDataObjectsRequest) String

func (x *ExportDataObjectsRequest) String() string

ExportDataObjectsRequest_GcsDestination

type ExportDataObjectsRequest_GcsDestination struct {
	// The Cloud Storage location where user wants to export Data Objects.
	GcsDestination *ExportDataObjectsRequest_GcsExportDestination `protobuf:"bytes,2,opt,name=gcs_destination,json=gcsDestination,proto3,oneof"`
}

ExportDataObjectsRequest_GcsExportDestination

type ExportDataObjectsRequest_GcsExportDestination struct {

	// Required. URI prefix of the Cloud Storage where to export Data Objects.
	// The bucket is required to be in the same region as the collection.
	ExportUri string `protobuf:"bytes,1,opt,name=export_uri,json=exportUri,proto3" json:"export_uri,omitempty"`
	// Required. The format of the exported Data Objects.
	Format ExportDataObjectsRequest_GcsExportDestination_Format `protobuf:"varint,2,opt,name=format,proto3,enum=google.cloud.vectorsearch.v1beta.ExportDataObjectsRequest_GcsExportDestination_Format" json:"format,omitempty"`
	// contains filtered or unexported fields
}

Google Cloud Storage configuration for the export.

func (*ExportDataObjectsRequest_GcsExportDestination) Descriptor

func (*ExportDataObjectsRequest_GcsExportDestination) Descriptor() ([]byte, []int)

Deprecated: Use ExportDataObjectsRequest_GcsExportDestination.ProtoReflect.Descriptor instead.

func (*ExportDataObjectsRequest_GcsExportDestination) GetExportUri

func (x *ExportDataObjectsRequest_GcsExportDestination) GetExportUri() string

func (*ExportDataObjectsRequest_GcsExportDestination) GetFormat

func (x *ExportDataObjectsRequest_GcsExportDestination) GetFormat() ExportDataObjectsRequest_GcsExportDestination_Format

func (*ExportDataObjectsRequest_GcsExportDestination) ProtoMessage

func (*ExportDataObjectsRequest_GcsExportDestination) ProtoMessage()

func (*ExportDataObjectsRequest_GcsExportDestination) ProtoReflect

func (x *ExportDataObjectsRequest_GcsExportDestination) ProtoReflect() protoreflect.Message

func (*ExportDataObjectsRequest_GcsExportDestination) Reset

func (x *ExportDataObjectsRequest_GcsExportDestination) Reset()

func (*ExportDataObjectsRequest_GcsExportDestination) String

func (x *ExportDataObjectsRequest_GcsExportDestination) String() string

ExportDataObjectsRequest_GcsExportDestination_Format

type ExportDataObjectsRequest_GcsExportDestination_Format int32

Options for the format of the exported Data Objects.

ExportDataObjectsRequest_GcsExportDestination_FORMAT_UNSPECIFIED, ExportDataObjectsRequest_GcsExportDestination_JSON

const (
	// Unspecified format.
	ExportDataObjectsRequest_GcsExportDestination_FORMAT_UNSPECIFIED ExportDataObjectsRequest_GcsExportDestination_Format = 0
	// The exported Data Objects will be in JSON format.
	ExportDataObjectsRequest_GcsExportDestination_JSON ExportDataObjectsRequest_GcsExportDestination_Format = 1
)

func (ExportDataObjectsRequest_GcsExportDestination_Format) Descriptor

func (ExportDataObjectsRequest_GcsExportDestination_Format) Descriptor() protoreflect.EnumDescriptor

func (ExportDataObjectsRequest_GcsExportDestination_Format) Enum

func (x ExportDataObjectsRequest_GcsExportDestination_Format) Enum() *ExportDataObjectsRequest_GcsExportDestination_Format

func (ExportDataObjectsRequest_GcsExportDestination_Format) EnumDescriptor

func (ExportDataObjectsRequest_GcsExportDestination_Format) EnumDescriptor() ([]byte, []int)

Deprecated: Use ExportDataObjectsRequest_GcsExportDestination_Format.Descriptor instead.

func (ExportDataObjectsRequest_GcsExportDestination_Format) Number

func (x ExportDataObjectsRequest_GcsExportDestination_Format) Number() protoreflect.EnumNumber

func (ExportDataObjectsRequest_GcsExportDestination_Format) String

func (x ExportDataObjectsRequest_GcsExportDestination_Format) String() string

func (ExportDataObjectsRequest_GcsExportDestination_Format) Type

func (ExportDataObjectsRequest_GcsExportDestination_Format) Type() protoreflect.EnumType

ExportDataObjectsResponse

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

Response for the ExportDataObjects LRO.

func (*ExportDataObjectsResponse) Descriptor

func (*ExportDataObjectsResponse) Descriptor() ([]byte, []int)

Deprecated: Use ExportDataObjectsResponse.ProtoReflect.Descriptor instead.

func (*ExportDataObjectsResponse) ProtoMessage

func (*ExportDataObjectsResponse) ProtoMessage()

func (*ExportDataObjectsResponse) ProtoReflect

func (x *ExportDataObjectsResponse) ProtoReflect() protoreflect.Message

func (*ExportDataObjectsResponse) Reset

func (x *ExportDataObjectsResponse) Reset()

func (*ExportDataObjectsResponse) String

func (x *ExportDataObjectsResponse) String() string

GetCollectionRequest

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
}

Message for getting a Collection

func (*GetCollectionRequest) Descriptor

func (*GetCollectionRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetCollectionRequest.ProtoReflect.Descriptor instead.

func (*GetCollectionRequest) GetName

func (x *GetCollectionRequest) GetName() string

func (*GetCollectionRequest) ProtoMessage

func (*GetCollectionRequest) ProtoMessage()

func (*GetCollectionRequest) ProtoReflect

func (x *GetCollectionRequest) ProtoReflect() protoreflect.Message

func (*GetCollectionRequest) Reset

func (x *GetCollectionRequest) Reset()

func (*GetCollectionRequest) String

func (x *GetCollectionRequest) String() string

GetDataObjectRequest

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
}

Request message for [DataObjectService.GetDataObject][google.cloud.vectorsearch.v1beta.DataObjectService.GetDataObject].

func (*GetDataObjectRequest) Descriptor

func (*GetDataObjectRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetDataObjectRequest.ProtoReflect.Descriptor instead.

func (*GetDataObjectRequest) GetName

func (x *GetDataObjectRequest) GetName() string

func (*GetDataObjectRequest) ProtoMessage

func (*GetDataObjectRequest) ProtoMessage()

func (*GetDataObjectRequest) ProtoReflect

func (x *GetDataObjectRequest) ProtoReflect() protoreflect.Message

func (*GetDataObjectRequest) Reset

func (x *GetDataObjectRequest) Reset()

func (*GetDataObjectRequest) String

func (x *GetDataObjectRequest) String() string

GetIndexRequest

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
}

Message for getting an Index

func (*GetIndexRequest) Descriptor

func (*GetIndexRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetIndexRequest.ProtoReflect.Descriptor instead.

func (*GetIndexRequest) GetName

func (x *GetIndexRequest) GetName() string

func (*GetIndexRequest) ProtoMessage

func (*GetIndexRequest) ProtoMessage()

func (*GetIndexRequest) ProtoReflect

func (x *GetIndexRequest) ProtoReflect() protoreflect.Message

func (*GetIndexRequest) Reset

func (x *GetIndexRequest) Reset()

func (*GetIndexRequest) String

func (x *GetIndexRequest) String() string

ImportDataObjectsMetadata

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
}

Metadata for [VectorSearchService.ImportDataObjects][google.cloud.vectorsearch.v1beta.VectorSearchService.ImportDataObjects].

func (*ImportDataObjectsMetadata) Descriptor

func (*ImportDataObjectsMetadata) Descriptor() ([]byte, []int)

Deprecated: Use ImportDataObjectsMetadata.ProtoReflect.Descriptor instead.

func (*ImportDataObjectsMetadata) GetCreateTime

func (x *ImportDataObjectsMetadata) GetCreateTime() *timestamppb.Timestamp

func (*ImportDataObjectsMetadata) GetFailureCount

func (x *ImportDataObjectsMetadata) GetFailureCount() int64

func (*ImportDataObjectsMetadata) GetSuccessCount

func (x *ImportDataObjectsMetadata) GetSuccessCount() int64

func (*ImportDataObjectsMetadata) GetUpdateTime

func (x *ImportDataObjectsMetadata) GetUpdateTime() *timestamppb.Timestamp

func (*ImportDataObjectsMetadata) ProtoMessage

func (*ImportDataObjectsMetadata) ProtoMessage()

func (*ImportDataObjectsMetadata) ProtoReflect

func (x *ImportDataObjectsMetadata) ProtoReflect() protoreflect.Message

func (*ImportDataObjectsMetadata) Reset

func (x *ImportDataObjectsMetadata) Reset()

func (*ImportDataObjectsMetadata) String

func (x *ImportDataObjectsMetadata) String() string

ImportDataObjectsRequest

type ImportDataObjectsRequest struct {

	// The configuration for the import data and error results.
	//
	// Types that are valid to be assigned 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
}

Request message for [VectorSearchService.ImportDataObjects][google.cloud.vectorsearch.v1beta.VectorSearchService.ImportDataObjects].

func (*ImportDataObjectsRequest) Descriptor

func (*ImportDataObjectsRequest) Descriptor() ([]byte, []int)

Deprecated: Use ImportDataObjectsRequest.ProtoReflect.Descriptor instead.

func (*ImportDataObjectsRequest) GetConfig

func (x *ImportDataObjectsRequest) GetConfig() isImportDataObjectsRequest_Config

func (*ImportDataObjectsRequest) GetGcsImport

func (x *ImportDataObjectsRequest) GetGcsImport() *ImportDataObjectsRequest_GcsImportConfig

func (*ImportDataObjectsRequest) GetName

func (x *ImportDataObjectsRequest) GetName() string

func (*ImportDataObjectsRequest) ProtoMessage

func (*ImportDataObjectsRequest) ProtoMessage()

func (*ImportDataObjectsRequest) ProtoReflect

func (x *ImportDataObjectsRequest) ProtoReflect() protoreflect.Message

func (*ImportDataObjectsRequest) Reset

func (x *ImportDataObjectsRequest) Reset()

func (*ImportDataObjectsRequest) String

func (x *ImportDataObjectsRequest) String() string

ImportDataObjectsRequest_GcsImport

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"`
}

ImportDataObjectsRequest_GcsImportConfig

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
}

Google Cloud Storage configuration for the import.

func (*ImportDataObjectsRequest_GcsImportConfig) Descriptor

func (*ImportDataObjectsRequest_GcsImportConfig) Descriptor() ([]byte, []int)

Deprecated: Use ImportDataObjectsRequest_GcsImportConfig.ProtoReflect.Descriptor instead.

func (*ImportDataObjectsRequest_GcsImportConfig) GetContentsUri

func (x *ImportDataObjectsRequest_GcsImportConfig) GetContentsUri() string

func (*ImportDataObjectsRequest_GcsImportConfig) GetErrorUri

func (x *ImportDataObjectsRequest_GcsImportConfig) GetErrorUri() string

func (*ImportDataObjectsRequest_GcsImportConfig) GetOutputUri

func (x *ImportDataObjectsRequest_GcsImportConfig) GetOutputUri() string

func (*ImportDataObjectsRequest_GcsImportConfig) ProtoMessage

func (*ImportDataObjectsRequest_GcsImportConfig) ProtoMessage()

func (*ImportDataObjectsRequest_GcsImportConfig) ProtoReflect

func (x *ImportDataObjectsRequest_GcsImportConfig) ProtoReflect() protoreflect.Message

func (*ImportDataObjectsRequest_GcsImportConfig) Reset

func (x *ImportDataObjectsRequest_GcsImportConfig) Reset()

func (*ImportDataObjectsRequest_GcsImportConfig) String

func (x *ImportDataObjectsRequest_GcsImportConfig) String() string

ImportDataObjectsResponse

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
}

Response for [VectorSearchService.ImportDataObjects][google.cloud.vectorsearch.v1beta.VectorSearchService.ImportDataObjects].

func (*ImportDataObjectsResponse) Descriptor

func (*ImportDataObjectsResponse) Descriptor() ([]byte, []int)

Deprecated: Use ImportDataObjectsResponse.ProtoReflect.Descriptor instead.

func (*ImportDataObjectsResponse) GetStatus

func (x *ImportDataObjectsResponse) GetStatus() *status.Status

func (*ImportDataObjectsResponse) ProtoMessage

func (*ImportDataObjectsResponse) ProtoMessage()

func (*ImportDataObjectsResponse) ProtoReflect

func (x *ImportDataObjectsResponse) ProtoReflect() protoreflect.Message

func (*ImportDataObjectsResponse) Reset

func (x *ImportDataObjectsResponse) Reset()

func (*ImportDataObjectsResponse) String

func (x *ImportDataObjectsResponse) String() string

Index

type Index struct {

	// The infrastructure type of the index.
	//
	// Types that are valid to be assigned to InfraType:
	//
	//	*Index_DedicatedInfrastructure
	InfraType isIndex_InfraType `protobuf_oneof:"infra_type"`
	// The type of the index.
	//
	// Types that are valid to be assigned 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 `protobuf:"bytes,10,rep,name=labels,proto3" json:"labels,omitempty" protobuf_key:"bytes,1,opt,name=key" protobuf_val:"bytes,2,opt,name=value"`
	// 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 `protobuf:"varint,4,opt,name=distance_metric,json=distanceMetric,proto3,enum=google.cloud.vectorsearch.v1beta.DistanceMetric" json:"distance_metric,omitempty"`
	// 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
}

Message describing Index object

func (*Index) Descriptor

func (*Index) Descriptor() ([]byte, []int)

Deprecated: Use Index.ProtoReflect.Descriptor instead.

func (*Index) GetCreateTime

func (x *Index) GetCreateTime() *timestamppb.Timestamp

func (*Index) GetDedicatedInfrastructure

func (x *Index) GetDedicatedInfrastructure() *DedicatedInfrastructure

func (*Index) GetDenseScann

func (x *Index) GetDenseScann() *DenseScannIndex

func (*Index) GetDescription

func (x *Index) GetDescription() string

func (*Index) GetDisplayName

func (x *Index) GetDisplayName() string

func (*Index) GetDistanceMetric

func (x *Index) GetDistanceMetric() DistanceMetric

func (*Index) GetFilterFields

func (x *Index) GetFilterFields() []string

func (*Index) GetIndexField

func (x *Index) GetIndexField() string

func (*Index) GetIndexType

func (x *Index) GetIndexType() isIndex_IndexType

func (*Index) GetInfraType

func (x *Index) GetInfraType() isIndex_InfraType

func (*Index) GetLabels

func (x *Index) GetLabels() map[string]string

func (*Index) GetName

func (x *Index) GetName() string

func (*Index) GetStoreFields

func (x *Index) GetStoreFields() []string

func (*Index) GetUpdateTime

func (x *Index) GetUpdateTime() *timestamppb.Timestamp

func (*Index) ProtoMessage

func (*Index) ProtoMessage()

func (*Index) ProtoReflect

func (x *Index) ProtoReflect() protoreflect.Message

func (*Index) Reset

func (x *Index) Reset()

func (*Index) String

func (x *Index) String() string

Index_DedicatedInfrastructure

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

Index_DenseScann

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

ListCollectionsRequest

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
}

Message for requesting list of Collections

func (*ListCollectionsRequest) Descriptor

func (*ListCollectionsRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListCollectionsRequest.ProtoReflect.Descriptor instead.

func (*ListCollectionsRequest) GetFilter

func (x *ListCollectionsRequest) GetFilter() string

func (*ListCollectionsRequest) GetOrderBy

func (x *ListCollectionsRequest) GetOrderBy() string

func (*ListCollectionsRequest) GetPageSize

func (x *ListCollectionsRequest) GetPageSize() int32

func (*ListCollectionsRequest) GetPageToken

func (x *ListCollectionsRequest) GetPageToken() string

func (*ListCollectionsRequest) GetParent

func (x *ListCollectionsRequest) GetParent() string

func (*ListCollectionsRequest) ProtoMessage

func (*ListCollectionsRequest) ProtoMessage()

func (*ListCollectionsRequest) ProtoReflect

func (x *ListCollectionsRequest) ProtoReflect() protoreflect.Message

func (*ListCollectionsRequest) Reset

func (x *ListCollectionsRequest) Reset()

func (*ListCollectionsRequest) String

func (x *ListCollectionsRequest) String() string

ListCollectionsResponse

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
}

Message for response to listing Collections

func (*ListCollectionsResponse) Descriptor

func (*ListCollectionsResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListCollectionsResponse.ProtoReflect.Descriptor instead.

func (*ListCollectionsResponse) GetCollections

func (x *ListCollectionsResponse) GetCollections() []*Collection

func (*ListCollectionsResponse) GetNextPageToken

func (x *ListCollectionsResponse) GetNextPageToken() string

func (*ListCollectionsResponse) GetUnreachable

func (x *ListCollectionsResponse) GetUnreachable() []string

func (*ListCollectionsResponse) ProtoMessage

func (*ListCollectionsResponse) ProtoMessage()

func (*ListCollectionsResponse) ProtoReflect

func (x *ListCollectionsResponse) ProtoReflect() protoreflect.Message

func (*ListCollectionsResponse) Reset

func (x *ListCollectionsResponse) Reset()

func (*ListCollectionsResponse) String

func (x *ListCollectionsResponse) String() string

ListIndexesRequest

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
}

Message for requesting list of Indexes

func (*ListIndexesRequest) Descriptor

func (*ListIndexesRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListIndexesRequest.ProtoReflect.Descriptor instead.

func (*ListIndexesRequest) GetFilter

func (x *ListIndexesRequest) GetFilter() string

func (*ListIndexesRequest) GetOrderBy

func (x *ListIndexesRequest) GetOrderBy() string

func (*ListIndexesRequest) GetPageSize

func (x *ListIndexesRequest) GetPageSize() int32

func (*ListIndexesRequest) GetPageToken

func (x *ListIndexesRequest) GetPageToken() string

func (*ListIndexesRequest) GetParent

func (x *ListIndexesRequest) GetParent() string

func (*ListIndexesRequest) ProtoMessage

func (*ListIndexesRequest) ProtoMessage()

func (*ListIndexesRequest) ProtoReflect

func (x *ListIndexesRequest) ProtoReflect() protoreflect.Message

func (*ListIndexesRequest) Reset

func (x *ListIndexesRequest) Reset()

func (*ListIndexesRequest) String

func (x *ListIndexesRequest) String() string

ListIndexesResponse

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
}

Message for response to listing Indexes

func (*ListIndexesResponse) Descriptor

func (*ListIndexesResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListIndexesResponse.ProtoReflect.Descriptor instead.

func (*ListIndexesResponse) GetIndexes

func (x *ListIndexesResponse) GetIndexes() []*Index

func (*ListIndexesResponse) GetNextPageToken

func (x *ListIndexesResponse) GetNextPageToken() string

func (*ListIndexesResponse) ProtoMessage

func (*ListIndexesResponse) ProtoMessage()

func (*ListIndexesResponse) ProtoReflect

func (x *ListIndexesResponse) ProtoReflect() protoreflect.Message

func (*ListIndexesResponse) Reset

func (x *ListIndexesResponse) Reset()

func (*ListIndexesResponse) String

func (x *ListIndexesResponse) String() string

OperationMetadata

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
}

Represents the metadata of the long-running operation.

func (*OperationMetadata) Descriptor

func (*OperationMetadata) Descriptor() ([]byte, []int)

Deprecated: Use OperationMetadata.ProtoReflect.Descriptor instead.

func (*OperationMetadata) GetApiVersion

func (x *OperationMetadata) GetApiVersion() string

func (*OperationMetadata) GetCreateTime

func (x *OperationMetadata) GetCreateTime() *timestamppb.Timestamp

func (*OperationMetadata) GetEndTime

func (x *OperationMetadata) GetEndTime() *timestamppb.Timestamp

func (*OperationMetadata) GetRequestedCancellation

func (x *OperationMetadata) GetRequestedCancellation() bool

func (*OperationMetadata) GetStatusMessage

func (x *OperationMetadata) GetStatusMessage() string

func (*OperationMetadata) GetTarget

func (x *OperationMetadata) GetTarget() string

func (*OperationMetadata) GetVerb

func (x *OperationMetadata) GetVerb() string

func (*OperationMetadata) ProtoMessage

func (*OperationMetadata) ProtoMessage()

func (*OperationMetadata) ProtoReflect

func (x *OperationMetadata) ProtoReflect() protoreflect.Message

func (*OperationMetadata) Reset

func (x *OperationMetadata) Reset()

func (*OperationMetadata) String

func (x *OperationMetadata) String() string

OutputFields

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
}

Defines a output fields struct for data in DataObject.

func (*OutputFields) Descriptor

func (*OutputFields) Descriptor() ([]byte, []int)

Deprecated: Use OutputFields.ProtoReflect.Descriptor instead.

func (*OutputFields) GetDataFields

func (x *OutputFields) GetDataFields() []string

func (*OutputFields) GetMetadataFields

func (x *OutputFields) GetMetadataFields() []string

func (*OutputFields) GetVectorFields

func (x *OutputFields) GetVectorFields() []string

func (*OutputFields) ProtoMessage

func (*OutputFields) ProtoMessage()

func (*OutputFields) ProtoReflect

func (x *OutputFields) ProtoReflect() protoreflect.Message

func (*OutputFields) Reset

func (x *OutputFields) Reset()

func (*OutputFields) String

func (x *OutputFields) String() string

QueryDataObjectsRequest

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.v1beta.QueryDataObjectsResponse.next_page_token]
	// of the previous
	// [DataObjectSearchService.QueryDataObjects][google.cloud.vectorsearch.v1beta.DataObjectSearchService.QueryDataObjects]
	// call.
	PageToken string `protobuf:"bytes,6,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// contains filtered or unexported fields
}

Request message for [DataObjectSearchService.QueryDataObjects][google.cloud.vectorsearch.v1beta.DataObjectSearchService.QueryDataObjects].

func (*QueryDataObjectsRequest) Descriptor

func (*QueryDataObjectsRequest) Descriptor() ([]byte, []int)

Deprecated: Use QueryDataObjectsRequest.ProtoReflect.Descriptor instead.

func (*QueryDataObjectsRequest) GetFilter

func (x *QueryDataObjectsRequest) GetFilter() *structpb.Struct

func (*QueryDataObjectsRequest) GetOutputFields

func (x *QueryDataObjectsRequest) GetOutputFields() *OutputFields

func (*QueryDataObjectsRequest) GetPageSize

func (x *QueryDataObjectsRequest) GetPageSize() int32

func (*QueryDataObjectsRequest) GetPageToken

func (x *QueryDataObjectsRequest) GetPageToken() string

func (*QueryDataObjectsRequest) GetParent

func (x *QueryDataObjectsRequest) GetParent() string

func (*QueryDataObjectsRequest) ProtoMessage

func (*QueryDataObjectsRequest) ProtoMessage()

func (*QueryDataObjectsRequest) ProtoReflect

func (x *QueryDataObjectsRequest) ProtoReflect() protoreflect.Message

func (*QueryDataObjectsRequest) Reset

func (x *QueryDataObjectsRequest) Reset()

func (*QueryDataObjectsRequest) String

func (x *QueryDataObjectsRequest) String() string

QueryDataObjectsResponse

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
}

Response message for [DataObjectSearchService.QueryDataObjects][google.cloud.vectorsearch.v1beta.DataObjectSearchService.QueryDataObjects].

func (*QueryDataObjectsResponse) Descriptor

func (*QueryDataObjectsResponse) Descriptor() ([]byte, []int)

Deprecated: Use QueryDataObjectsResponse.ProtoReflect.Descriptor instead.

func (*QueryDataObjectsResponse) GetDataObjects

func (x *QueryDataObjectsResponse) GetDataObjects() []*DataObject

func (*QueryDataObjectsResponse) GetNextPageToken

func (x *QueryDataObjectsResponse) GetNextPageToken() string

func (*QueryDataObjectsResponse) ProtoMessage

func (*QueryDataObjectsResponse) ProtoMessage()

func (*QueryDataObjectsResponse) ProtoReflect

func (x *QueryDataObjectsResponse) ProtoReflect() protoreflect.Message

func (*QueryDataObjectsResponse) Reset

func (x *QueryDataObjectsResponse) Reset()

func (*QueryDataObjectsResponse) String

func (x *QueryDataObjectsResponse) String() string

Ranker

type Ranker struct {

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

Defines a ranker to combine results from multiple searches.

func (*Ranker) Descriptor

func (*Ranker) Descriptor() ([]byte, []int)

Deprecated: Use Ranker.ProtoReflect.Descriptor instead.

func (*Ranker) GetRanker

func (x *Ranker) GetRanker() isRanker_Ranker

func (*Ranker) GetRrf

func (x *Ranker) GetRrf() *ReciprocalRankFusion

func (*Ranker) ProtoMessage

func (*Ranker) ProtoMessage()

func (*Ranker) ProtoReflect

func (x *Ranker) ProtoReflect() protoreflect.Message

func (*Ranker) Reset

func (x *Ranker) Reset()

func (*Ranker) String

func (x *Ranker) String() string

Ranker_Rrf

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

ReciprocalRankFusion

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
}

Defines the Reciprocal Rank Fusion (RRF) algorithm for result ranking.

func (*ReciprocalRankFusion) Descriptor

func (*ReciprocalRankFusion) Descriptor() ([]byte, []int)

Deprecated: Use ReciprocalRankFusion.ProtoReflect.Descriptor instead.

func (*ReciprocalRankFusion) GetWeights

func (x *ReciprocalRankFusion) GetWeights() []float64

func (*ReciprocalRankFusion) ProtoMessage

func (*ReciprocalRankFusion) ProtoMessage()

func (*ReciprocalRankFusion) ProtoReflect

func (x *ReciprocalRankFusion) ProtoReflect() protoreflect.Message

func (*ReciprocalRankFusion) Reset

func (x *ReciprocalRankFusion) Reset()

func (*ReciprocalRankFusion) String

func (x *ReciprocalRankFusion) String() string

Search

type Search struct {

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

A single search request within a batch operation.

func (*Search) Descriptor

func (*Search) Descriptor() ([]byte, []int)

Deprecated: Use Search.ProtoReflect.Descriptor instead.

func (*Search) GetSearchType

func (x *Search) GetSearchType() isSearch_SearchType

func (*Search) GetSemanticSearch

func (x *Search) GetSemanticSearch() *SemanticSearch

func (*Search) GetTextSearch

func (x *Search) GetTextSearch() *TextSearch

func (*Search) GetVectorSearch

func (x *Search) GetVectorSearch() *VectorSearch

func (*Search) ProtoMessage

func (*Search) ProtoMessage()

func (*Search) ProtoReflect

func (x *Search) ProtoReflect() protoreflect.Message

func (*Search) Reset

func (x *Search) Reset()

func (*Search) String

func (x *Search) String() string

SearchDataObjectsRequest

type SearchDataObjectsRequest struct {

	// The query to search for.
	//
	// Types that are valid to be assigned 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.v1beta.SearchDataObjectsResponse.next_page_token]
	// of the previous
	// [DataObjectSearchService.SearchDataObjects][google.cloud.vectorsearch.v1beta.DataObjectSearchService.SearchDataObjects]
	// call.
	PageToken string `protobuf:"bytes,6,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// contains filtered or unexported fields
}

Request for performing a single search.

func (*SearchDataObjectsRequest) Descriptor

func (*SearchDataObjectsRequest) Descriptor() ([]byte, []int)

Deprecated: Use SearchDataObjectsRequest.ProtoReflect.Descriptor instead.

func (*SearchDataObjectsRequest) GetPageSize

func (x *SearchDataObjectsRequest) GetPageSize() int32

func (*SearchDataObjectsRequest) GetPageToken

func (x *SearchDataObjectsRequest) GetPageToken() string

func (*SearchDataObjectsRequest) GetParent

func (x *SearchDataObjectsRequest) GetParent() string

func (*SearchDataObjectsRequest) GetSearchType

func (x *SearchDataObjectsRequest) GetSearchType() isSearchDataObjectsRequest_SearchType

func (*SearchDataObjectsRequest) GetSemanticSearch

func (x *SearchDataObjectsRequest) GetSemanticSearch() *SemanticSearch

func (*SearchDataObjectsRequest) GetTextSearch

func (x *SearchDataObjectsRequest) GetTextSearch() *TextSearch

func (*SearchDataObjectsRequest) GetVectorSearch

func (x *SearchDataObjectsRequest) GetVectorSearch() *VectorSearch

func (*SearchDataObjectsRequest) ProtoMessage

func (*SearchDataObjectsRequest) ProtoMessage()

func (*SearchDataObjectsRequest) ProtoReflect

func (x *SearchDataObjectsRequest) ProtoReflect() protoreflect.Message

func (*SearchDataObjectsRequest) Reset

func (x *SearchDataObjectsRequest) Reset()

func (*SearchDataObjectsRequest) String

func (x *SearchDataObjectsRequest) String() string

SearchDataObjectsRequest_SemanticSearch

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

SearchDataObjectsRequest_TextSearch

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

SearchDataObjectsRequest_VectorSearch

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

SearchDataObjectsResponse

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"`
	// Output only. Metadata about the search execution.
	SearchResponseMetadata *SearchResponseMetadata `protobuf:"bytes,3,opt,name=search_response_metadata,json=searchResponseMetadata,proto3" json:"search_response_metadata,omitempty"`
	// contains filtered or unexported fields
}

Response for a search request.

func (*SearchDataObjectsResponse) Descriptor

func (*SearchDataObjectsResponse) Descriptor() ([]byte, []int)

Deprecated: Use SearchDataObjectsResponse.ProtoReflect.Descriptor instead.

func (*SearchDataObjectsResponse) GetNextPageToken

func (x *SearchDataObjectsResponse) GetNextPageToken() string

func (*SearchDataObjectsResponse) GetResults

func (x *SearchDataObjectsResponse) GetResults() []*SearchResult

func (*SearchDataObjectsResponse) GetSearchResponseMetadata

func (x *SearchDataObjectsResponse) GetSearchResponseMetadata() *SearchResponseMetadata

func (*SearchDataObjectsResponse) ProtoMessage

func (*SearchDataObjectsResponse) ProtoMessage()

func (*SearchDataObjectsResponse) ProtoReflect

func (x *SearchDataObjectsResponse) ProtoReflect() protoreflect.Message

func (*SearchDataObjectsResponse) Reset

func (x *SearchDataObjectsResponse) Reset()

func (*SearchDataObjectsResponse) String

func (x *SearchDataObjectsResponse) String() string

SearchHint

type SearchHint struct {

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

Represents a hint to the search index engine.

func (*SearchHint) Descriptor

func (*SearchHint) Descriptor() ([]byte, []int)

Deprecated: Use SearchHint.ProtoReflect.Descriptor instead.

func (*SearchHint) GetIndexHint

func (x *SearchHint) GetIndexHint() *SearchHint_IndexHint

func (*SearchHint) GetIndexType

func (x *SearchHint) GetIndexType() isSearchHint_IndexType

func (*SearchHint) GetKnnHint

func (x *SearchHint) GetKnnHint() *SearchHint_KnnHint

func (*SearchHint) GetUseIndex

func (x *SearchHint) GetUseIndex() *SearchHint_IndexHint

Deprecated: Marked as deprecated in google/cloud/vectorsearch/v1beta/data_object_search_service.proto.

func (*SearchHint) GetUseKnn

func (x *SearchHint) GetUseKnn() bool

Deprecated: Marked as deprecated in google/cloud/vectorsearch/v1beta/data_object_search_service.proto.

func (*SearchHint) ProtoMessage

func (*SearchHint) ProtoMessage()

func (*SearchHint) ProtoReflect

func (x *SearchHint) ProtoReflect() protoreflect.Message

func (*SearchHint) Reset

func (x *SearchHint) Reset()

func (*SearchHint) String

func (x *SearchHint) String() string

SearchHint_IndexHint

type SearchHint_IndexHint struct {

	// The parameters for the index.
	//
	// Types that are valid to be assigned 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
}

Message to specify the index to use for the search.

func (*SearchHint_IndexHint) Descriptor

func (*SearchHint_IndexHint) Descriptor() ([]byte, []int)

Deprecated: Use SearchHint_IndexHint.ProtoReflect.Descriptor instead.

func (*SearchHint_IndexHint) GetDenseScannParams

func (x *SearchHint_IndexHint) GetDenseScannParams() *SearchHint_IndexHint_DenseScannParams

func (*SearchHint_IndexHint) GetName

func (x *SearchHint_IndexHint) GetName() string

func (*SearchHint_IndexHint) GetParams

func (x *SearchHint_IndexHint) GetParams() isSearchHint_IndexHint_Params

func (*SearchHint_IndexHint) ProtoMessage

func (*SearchHint_IndexHint) ProtoMessage()

func (*SearchHint_IndexHint) ProtoReflect

func (x *SearchHint_IndexHint) ProtoReflect() protoreflect.Message

func (*SearchHint_IndexHint) Reset

func (x *SearchHint_IndexHint) Reset()

func (*SearchHint_IndexHint) String

func (x *SearchHint_IndexHint) String() string

SearchHint_IndexHint_

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"`
}

SearchHint_IndexHint_DenseScannParams

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 `protobuf:"varint,2,opt,name=initial_candidate_count,json=initialCandidateCount,proto3" json:"initial_candidate_count,omitempty"`
	// contains filtered or unexported fields
}

Parameters for dense ScaNN.

func (*SearchHint_IndexHint_DenseScannParams) Descriptor

func (*SearchHint_IndexHint_DenseScannParams) Descriptor() ([]byte, []int)

Deprecated: Use SearchHint_IndexHint_DenseScannParams.ProtoReflect.Descriptor instead.

func (*SearchHint_IndexHint_DenseScannParams) GetInitialCandidateCount

func (x *SearchHint_IndexHint_DenseScannParams) GetInitialCandidateCount() int32

func (*SearchHint_IndexHint_DenseScannParams) GetSearchLeavesPct

func (x *SearchHint_IndexHint_DenseScannParams) GetSearchLeavesPct() int32

func (*SearchHint_IndexHint_DenseScannParams) ProtoMessage

func (*SearchHint_IndexHint_DenseScannParams) ProtoMessage()

func (*SearchHint_IndexHint_DenseScannParams) ProtoReflect

func (x *SearchHint_IndexHint_DenseScannParams) ProtoReflect() protoreflect.Message

func (*SearchHint_IndexHint_DenseScannParams) Reset

func (x *SearchHint_IndexHint_DenseScannParams) Reset()

func (*SearchHint_IndexHint_DenseScannParams) String

func (x *SearchHint_IndexHint_DenseScannParams) String() string

SearchHint_IndexHint_DenseScannParams_

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"`
}

SearchHint_KnnHint

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

KnnHint will be used if search should be explicitly done on system's default K-Nearest Neighbor (KNN) index engine.

func (*SearchHint_KnnHint) Descriptor

func (*SearchHint_KnnHint) Descriptor() ([]byte, []int)

Deprecated: Use SearchHint_KnnHint.ProtoReflect.Descriptor instead.

func (*SearchHint_KnnHint) ProtoMessage

func (*SearchHint_KnnHint) ProtoMessage()

func (*SearchHint_KnnHint) ProtoReflect

func (x *SearchHint_KnnHint) ProtoReflect() protoreflect.Message

func (*SearchHint_KnnHint) Reset

func (x *SearchHint_KnnHint) Reset()

func (*SearchHint_KnnHint) String

func (x *SearchHint_KnnHint) String() string

SearchHint_KnnHint_

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"`
}

SearchHint_UseIndex

type SearchHint_UseIndex struct {
	// Optional. Deprecated: Use `index_hint` instead.
	// Specifies that the search should use a particular index.
	//
	// Deprecated: Marked as deprecated in google/cloud/vectorsearch/v1beta/data_object_search_service.proto.
	UseIndex *SearchHint_IndexHint `protobuf:"bytes,1,opt,name=use_index,json=useIndex,proto3,oneof"`
}

SearchHint_UseKnn

type SearchHint_UseKnn struct {
	// Optional. Deprecated: Use `knn_hint` instead.
	// If set to true, the search will use the system's default
	// K-Nearest Neighbor (KNN) index engine.
	//
	// Deprecated: Marked as deprecated in google/cloud/vectorsearch/v1beta/data_object_search_service.proto.
	UseKnn bool `protobuf:"varint,2,opt,name=use_knn,json=useKnn,proto3,oneof"`
}

SearchResponseMetadata

type SearchResponseMetadata struct {

	// The type of index used.
	//
	// Types that are valid to be assigned to IndexType:
	//
	//	*SearchResponseMetadata_UsedIndex
	//	*SearchResponseMetadata_UsedKnn
	IndexType isSearchResponseMetadata_IndexType `protobuf_oneof:"index_type"`
	// contains filtered or unexported fields
}

Metadata about the search execution.

func (*SearchResponseMetadata) Descriptor

func (*SearchResponseMetadata) Descriptor() ([]byte, []int)

Deprecated: Use SearchResponseMetadata.ProtoReflect.Descriptor instead.

func (*SearchResponseMetadata) GetIndexType

func (x *SearchResponseMetadata) GetIndexType() isSearchResponseMetadata_IndexType

func (*SearchResponseMetadata) GetUsedIndex

func (x *SearchResponseMetadata) GetUsedIndex() *SearchResponseMetadata_IndexInfo

func (*SearchResponseMetadata) GetUsedKnn

func (x *SearchResponseMetadata) GetUsedKnn() bool

func (*SearchResponseMetadata) ProtoMessage

func (*SearchResponseMetadata) ProtoMessage()

func (*SearchResponseMetadata) ProtoReflect

func (x *SearchResponseMetadata) ProtoReflect() protoreflect.Message

func (*SearchResponseMetadata) Reset

func (x *SearchResponseMetadata) Reset()

func (*SearchResponseMetadata) String

func (x *SearchResponseMetadata) String() string

SearchResponseMetadata_IndexInfo

type SearchResponseMetadata_IndexInfo struct {

	// Output only. The resource name of the index used for the search.
	// 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
}

Message that indicates the index used for the search.

func (*SearchResponseMetadata_IndexInfo) Descriptor

func (*SearchResponseMetadata_IndexInfo) Descriptor() ([]byte, []int)

Deprecated: Use SearchResponseMetadata_IndexInfo.ProtoReflect.Descriptor instead.

func (*SearchResponseMetadata_IndexInfo) GetName

func (x *SearchResponseMetadata_IndexInfo) GetName() string

func (*SearchResponseMetadata_IndexInfo) ProtoMessage

func (*SearchResponseMetadata_IndexInfo) ProtoMessage()

func (*SearchResponseMetadata_IndexInfo) ProtoReflect

func (x *SearchResponseMetadata_IndexInfo) ProtoReflect() protoreflect.Message

func (*SearchResponseMetadata_IndexInfo) Reset

func (x *SearchResponseMetadata_IndexInfo) Reset()

func (*SearchResponseMetadata_IndexInfo) String

func (x *SearchResponseMetadata_IndexInfo) String() string

SearchResponseMetadata_UsedIndex

type SearchResponseMetadata_UsedIndex struct {
	// Indicates that the search used a particular index.
	UsedIndex *SearchResponseMetadata_IndexInfo `protobuf:"bytes,1,opt,name=used_index,json=usedIndex,proto3,oneof"`
}

SearchResponseMetadata_UsedKnn

type SearchResponseMetadata_UsedKnn struct {
	// Output only. If true, the search used the system's default
	// K-Nearest Neighbor (KNN) index engine.
	UsedKnn bool `protobuf:"varint,2,opt,name=used_knn,json=usedKnn,proto3,oneof"`
}

SearchResult

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
}

A single search result.

func (*SearchResult) Descriptor

func (*SearchResult) Descriptor() ([]byte, []int)

Deprecated: Use SearchResult.ProtoReflect.Descriptor instead.

func (*SearchResult) GetDataObject

func (x *SearchResult) GetDataObject() *DataObject

func (*SearchResult) GetDistance

func (x *SearchResult) GetDistance() float64

func (*SearchResult) ProtoMessage

func (*SearchResult) ProtoMessage()

func (*SearchResult) ProtoReflect

func (x *SearchResult) ProtoReflect() protoreflect.Message

func (*SearchResult) Reset

func (x *SearchResult) Reset()

func (*SearchResult) String

func (x *SearchResult) String() string

Search_SemanticSearch

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

Search_TextSearch

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

Search_VectorSearch

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

SemanticSearch

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 `protobuf:"varint,5,opt,name=task_type,json=taskType,proto3,enum=google.cloud.vectorsearch.v1beta.EmbeddingTaskType" json:"task_type,omitempty"`
	// 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
}

Defines a semantic search operation.

func (*SemanticSearch) Descriptor

func (*SemanticSearch) Descriptor() ([]byte, []int)

Deprecated: Use SemanticSearch.ProtoReflect.Descriptor instead.

func (*SemanticSearch) GetFilter

func (x *SemanticSearch) GetFilter() *structpb.Struct

func (*SemanticSearch) GetOutputFields

func (x *SemanticSearch) GetOutputFields() *OutputFields

func (*SemanticSearch) GetSearchField

func (x *SemanticSearch) GetSearchField() string

func (*SemanticSearch) GetSearchHint

func (x *SemanticSearch) GetSearchHint() *SearchHint

func (*SemanticSearch) GetSearchText

func (x *SemanticSearch) GetSearchText() string

func (*SemanticSearch) GetTaskType

func (x *SemanticSearch) GetTaskType() EmbeddingTaskType

func (*SemanticSearch) GetTopK

func (x *SemanticSearch) GetTopK() int32

func (*SemanticSearch) ProtoMessage

func (*SemanticSearch) ProtoMessage()

func (*SemanticSearch) ProtoReflect

func (x *SemanticSearch) ProtoReflect() protoreflect.Message

func (*SemanticSearch) Reset

func (x *SemanticSearch) Reset()

func (*SemanticSearch) String

func (x *SemanticSearch) String() string

SparseVector

type SparseVector struct {

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

A sparse vector.

func (*SparseVector) Descriptor

func (*SparseVector) Descriptor() ([]byte, []int)

Deprecated: Use SparseVector.ProtoReflect.Descriptor instead.

func (*SparseVector) GetIndices

func (x *SparseVector) GetIndices() []int32

func (*SparseVector) GetValues

func (x *SparseVector) GetValues() []float32

func (*SparseVector) ProtoMessage

func (*SparseVector) ProtoMessage()

func (*SparseVector) ProtoReflect

func (x *SparseVector) ProtoReflect() protoreflect.Message

func (*SparseVector) Reset

func (x *SparseVector) Reset()

func (*SparseVector) String

func (x *SparseVector) String() string

SparseVectorField

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

Message describing a sparse vector field.

func (*SparseVectorField) Descriptor

func (*SparseVectorField) Descriptor() ([]byte, []int)

Deprecated: Use SparseVectorField.ProtoReflect.Descriptor instead.

func (*SparseVectorField) ProtoMessage

func (*SparseVectorField) ProtoMessage()

func (*SparseVectorField) ProtoReflect

func (x *SparseVectorField) ProtoReflect() protoreflect.Message

func (*SparseVectorField) Reset

func (x *SparseVectorField) Reset()

func (*SparseVectorField) String

func (x *SparseVectorField) String() string

TextSearch

type TextSearch struct {

	// Required. The query text.
	SearchText string `protobuf:"bytes,1,opt,name=search_text,json=searchText,proto3" json:"search_text,omitempty"`
	// Required. The data field names to search.
	DataFieldNames []string `protobuf:"bytes,2,rep,name=data_field_names,json=dataFieldNames,proto3" json:"data_field_names,omitempty"`
	// 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. The number of results to return.
	TopK *int32 `protobuf:"varint,4,opt,name=top_k,json=topK,proto3,oneof" json:"top_k,omitempty"`
	// Optional. A JSON filter expression, e.g. `{"genre": {"$eq": "sci-fi"}}`,
	// represented as a `google.protobuf.Struct`.
	Filter *structpb.Struct `protobuf:"bytes,5,opt,name=filter,proto3" json:"filter,omitempty"`
	// contains filtered or unexported fields
}

Defines a text search operation.

func (*TextSearch) Descriptor

func (*TextSearch) Descriptor() ([]byte, []int)

Deprecated: Use TextSearch.ProtoReflect.Descriptor instead.

func (*TextSearch) GetDataFieldNames

func (x *TextSearch) GetDataFieldNames() []string

func (*TextSearch) GetFilter

func (x *TextSearch) GetFilter() *structpb.Struct

func (*TextSearch) GetOutputFields

func (x *TextSearch) GetOutputFields() *OutputFields

func (*TextSearch) GetSearchText

func (x *TextSearch) GetSearchText() string

func (*TextSearch) GetTopK

func (x *TextSearch) GetTopK() int32

func (*TextSearch) ProtoMessage

func (*TextSearch) ProtoMessage()

func (*TextSearch) ProtoReflect

func (x *TextSearch) ProtoReflect() protoreflect.Message

func (*TextSearch) Reset

func (x *TextSearch) Reset()

func (*TextSearch) String

func (x *TextSearch) String() string

UnimplementedDataObjectSearchServiceServer

type UnimplementedDataObjectSearchServiceServer struct {
}

UnimplementedDataObjectSearchServiceServer should be embedded to have forward compatible implementations.

func (UnimplementedDataObjectSearchServiceServer) AggregateDataObjects

func (UnimplementedDataObjectSearchServiceServer) AggregateDataObjects(context.Context, *AggregateDataObjectsRequest) (*AggregateDataObjectsResponse, error)

func (UnimplementedDataObjectSearchServiceServer) BatchSearchDataObjects

func (UnimplementedDataObjectSearchServiceServer) BatchSearchDataObjects(context.Context, *BatchSearchDataObjectsRequest) (*BatchSearchDataObjectsResponse, error)

func (UnimplementedDataObjectSearchServiceServer) QueryDataObjects

func (UnimplementedDataObjectSearchServiceServer) QueryDataObjects(context.Context, *QueryDataObjectsRequest) (*QueryDataObjectsResponse, error)

func (UnimplementedDataObjectSearchServiceServer) SearchDataObjects

func (UnimplementedDataObjectSearchServiceServer) SearchDataObjects(context.Context, *SearchDataObjectsRequest) (*SearchDataObjectsResponse, error)

UnimplementedDataObjectServiceServer

type UnimplementedDataObjectServiceServer struct {
}

UnimplementedDataObjectServiceServer should be embedded to have forward compatible implementations.

func (UnimplementedDataObjectServiceServer) BatchCreateDataObjects

func (UnimplementedDataObjectServiceServer) BatchCreateDataObjects(context.Context, *BatchCreateDataObjectsRequest) (*BatchCreateDataObjectsResponse, error)

func (UnimplementedDataObjectServiceServer) BatchDeleteDataObjects

func (UnimplementedDataObjectServiceServer) BatchDeleteDataObjects(context.Context, *BatchDeleteDataObjectsRequest) (*emptypb.Empty, error)

func (UnimplementedDataObjectServiceServer) BatchUpdateDataObjects

func (UnimplementedDataObjectServiceServer) BatchUpdateDataObjects(context.Context, *BatchUpdateDataObjectsRequest) (*BatchUpdateDataObjectsResponse, error)

func (UnimplementedDataObjectServiceServer) CreateDataObject

func (UnimplementedDataObjectServiceServer) CreateDataObject(context.Context, *CreateDataObjectRequest) (*DataObject, error)

func (UnimplementedDataObjectServiceServer) DeleteDataObject

func (UnimplementedDataObjectServiceServer) DeleteDataObject(context.Context, *DeleteDataObjectRequest) (*emptypb.Empty, error)

func (UnimplementedDataObjectServiceServer) GetDataObject

func (UnimplementedDataObjectServiceServer) GetDataObject(context.Context, *GetDataObjectRequest) (*DataObject, error)

func (UnimplementedDataObjectServiceServer) UpdateDataObject

func (UnimplementedDataObjectServiceServer) UpdateDataObject(context.Context, *UpdateDataObjectRequest) (*DataObject, error)

UnimplementedVectorSearchServiceServer

type UnimplementedVectorSearchServiceServer struct {
}

UnimplementedVectorSearchServiceServer should be embedded to have forward compatible implementations.

func (UnimplementedVectorSearchServiceServer) CreateCollection

func (UnimplementedVectorSearchServiceServer) CreateCollection(context.Context, *CreateCollectionRequest) (*longrunningpb.Operation, error)

func (UnimplementedVectorSearchServiceServer) CreateIndex

func (UnimplementedVectorSearchServiceServer) CreateIndex(context.Context, *CreateIndexRequest) (*longrunningpb.Operation, error)

func (UnimplementedVectorSearchServiceServer) DeleteCollection

func (UnimplementedVectorSearchServiceServer) DeleteCollection(context.Context, *DeleteCollectionRequest) (*longrunningpb.Operation, error)

func (UnimplementedVectorSearchServiceServer) DeleteIndex

func (UnimplementedVectorSearchServiceServer) DeleteIndex(context.Context, *DeleteIndexRequest) (*longrunningpb.Operation, error)

func (UnimplementedVectorSearchServiceServer) ExportDataObjects

func (UnimplementedVectorSearchServiceServer) ExportDataObjects(context.Context, *ExportDataObjectsRequest) (*longrunningpb.Operation, error)

func (UnimplementedVectorSearchServiceServer) GetCollection

func (UnimplementedVectorSearchServiceServer) GetCollection(context.Context, *GetCollectionRequest) (*Collection, error)

func (UnimplementedVectorSearchServiceServer) GetIndex

func (UnimplementedVectorSearchServiceServer) GetIndex(context.Context, *GetIndexRequest) (*Index, error)

func (UnimplementedVectorSearchServiceServer) ImportDataObjects

func (UnimplementedVectorSearchServiceServer) ImportDataObjects(context.Context, *ImportDataObjectsRequest) (*longrunningpb.Operation, error)

func (UnimplementedVectorSearchServiceServer) ListCollections

func (UnimplementedVectorSearchServiceServer) ListCollections(context.Context, *ListCollectionsRequest) (*ListCollectionsResponse, error)

func (UnimplementedVectorSearchServiceServer) ListIndexes

func (UnimplementedVectorSearchServiceServer) ListIndexes(context.Context, *ListIndexesRequest) (*ListIndexesResponse, error)

func (UnimplementedVectorSearchServiceServer) UpdateCollection

func (UnimplementedVectorSearchServiceServer) UpdateCollection(context.Context, *UpdateCollectionRequest) (*longrunningpb.Operation, error)

UnsafeDataObjectSearchServiceServer

type UnsafeDataObjectSearchServiceServer interface {
	// contains filtered or unexported methods
}

UnsafeDataObjectSearchServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to DataObjectSearchServiceServer will result in compilation errors.

UnsafeDataObjectServiceServer

type UnsafeDataObjectServiceServer interface {
	// contains filtered or unexported methods
}

UnsafeDataObjectServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to DataObjectServiceServer will result in compilation errors.

UnsafeVectorSearchServiceServer

type UnsafeVectorSearchServiceServer interface {
	// contains filtered or unexported methods
}

UnsafeVectorSearchServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to VectorSearchServiceServer will result in compilation errors.

UpdateCollectionRequest

type UpdateCollectionRequest struct {

	// Optional. Field mask is used to specify the fields to be overwritten in the
	// Collection resource by the update.
	// The fields specified in the update_mask are relative to the resource, not
	// the full request. A field will be overwritten if it is in the mask. If the
	// user does not provide a mask then all fields present in the request will be
	// overwritten.
	//
	// The following fields support update: `display_name`, `description`,
	// `labels`, `data_schema`, `vector_schema`.
	// For `data_schema` and `vector_schema`, fields can only be added, not
	// deleted, but `vertex_embedding_config` in `vector_schema` can be added or
	// removed.
	// Partial updates for `data_schema` and `vector_schema` are also supported
	// by using sub-field paths in `update_mask`, e.g.
	// `data_schema.properties.foo` or `vector_schema.my_vector_field`.
	//
	// If `*` is provided in the update_mask, full replacement will be performed.
	UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,1,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
	// Required. The resource being updated
	Collection *Collection `protobuf:"bytes,2,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,3,opt,name=request_id,json=requestId,proto3" json:"request_id,omitempty"`
	// contains filtered or unexported fields
}

Message for updating a Collection

func (*UpdateCollectionRequest) Descriptor

func (*UpdateCollectionRequest) Descriptor() ([]byte, []int)

Deprecated: Use UpdateCollectionRequest.ProtoReflect.Descriptor instead.

func (*UpdateCollectionRequest) GetCollection

func (x *UpdateCollectionRequest) GetCollection() *Collection

func (*UpdateCollectionRequest) GetRequestId

func (x *UpdateCollectionRequest) GetRequestId() string

func (*UpdateCollectionRequest) GetUpdateMask

func (x *UpdateCollectionRequest) GetUpdateMask() *fieldmaskpb.FieldMask

func (*UpdateCollectionRequest) ProtoMessage

func (*UpdateCollectionRequest) ProtoMessage()

func (*UpdateCollectionRequest) ProtoReflect

func (x *UpdateCollectionRequest) ProtoReflect() protoreflect.Message

func (*UpdateCollectionRequest) Reset

func (x *UpdateCollectionRequest) Reset()

func (*UpdateCollectionRequest) String

func (x *UpdateCollectionRequest) String() string

UpdateDataObjectRequest

type UpdateDataObjectRequest struct {

	// Required. The DataObject which replaces the resource on the server.
	DataObject *DataObject `protobuf:"bytes,1,opt,name=data_object,json=dataObject,proto3" json:"data_object,omitempty"`
	// Optional. The update mask applies to the resource. See
	// [google.protobuf.FieldMask][google.protobuf.FieldMask].
	UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
	// contains filtered or unexported fields
}

Request message for [DataObjectService.UpdateDataObject][google.cloud.vectorsearch.v1beta.DataObjectService.UpdateDataObject].

func (*UpdateDataObjectRequest) Descriptor

func (*UpdateDataObjectRequest) Descriptor() ([]byte, []int)

Deprecated: Use UpdateDataObjectRequest.ProtoReflect.Descriptor instead.

func (*UpdateDataObjectRequest) GetDataObject

func (x *UpdateDataObjectRequest) GetDataObject() *DataObject

func (*UpdateDataObjectRequest) GetUpdateMask

func (x *UpdateDataObjectRequest) GetUpdateMask() *fieldmaskpb.FieldMask

func (*UpdateDataObjectRequest) ProtoMessage

func (*UpdateDataObjectRequest) ProtoMessage()

func (*UpdateDataObjectRequest) ProtoReflect

func (x *UpdateDataObjectRequest) ProtoReflect() protoreflect.Message

func (*UpdateDataObjectRequest) Reset

func (x *UpdateDataObjectRequest) Reset()

func (*UpdateDataObjectRequest) String

func (x *UpdateDataObjectRequest) String() string

Vector

type Vector struct {

	// The type of the vector.
	//
	// Types that are valid to be assigned to VectorType:
	//
	//	*Vector_Dense
	//	*Vector_Sparse
	VectorType isVector_VectorType `protobuf_oneof:"vector_type"`
	// Deprecated: Use `dense` or `sparse` instead.
	//
	// Deprecated: Marked as deprecated in google/cloud/vectorsearch/v1beta/data_object.proto.
	Values []float32 `protobuf:"fixed32,1,rep,packed,name=values,proto3" json:"values,omitempty"`
	// contains filtered or unexported fields
}

A vector which can be either dense or sparse.

func (*Vector) Descriptor

func (*Vector) Descriptor() ([]byte, []int)

Deprecated: Use Vector.ProtoReflect.Descriptor instead.

func (*Vector) GetDense

func (x *Vector) GetDense() *DenseVector

func (*Vector) GetSparse

func (x *Vector) GetSparse() *SparseVector

func (*Vector) GetValues

func (x *Vector) GetValues() []float32

Deprecated: Marked as deprecated in google/cloud/vectorsearch/v1beta/data_object.proto.

func (*Vector) GetVectorType

func (x *Vector) GetVectorType() isVector_VectorType

func (*Vector) ProtoMessage

func (*Vector) ProtoMessage()

func (*Vector) ProtoReflect

func (x *Vector) ProtoReflect() protoreflect.Message

func (*Vector) Reset

func (x *Vector) Reset()

func (*Vector) String

func (x *Vector) String() string

VectorField

type VectorField struct {

	// Vector type configuration.
	//
	// Types that are valid to be assigned to VectorTypeConfig:
	//
	//	*VectorField_DenseVector
	//	*VectorField_SparseVector
	VectorTypeConfig isVectorField_VectorTypeConfig `protobuf_oneof:"vector_type_config"`
	// contains filtered or unexported fields
}

Message describing a vector field.

func (*VectorField) Descriptor

func (*VectorField) Descriptor() ([]byte, []int)

Deprecated: Use VectorField.ProtoReflect.Descriptor instead.

func (*VectorField) GetDenseVector

func (x *VectorField) GetDenseVector() *DenseVectorField

func (*VectorField) GetSparseVector

func (x *VectorField) GetSparseVector() *SparseVectorField

func (*VectorField) GetVectorTypeConfig

func (x *VectorField) GetVectorTypeConfig() isVectorField_VectorTypeConfig

func (*VectorField) ProtoMessage

func (*VectorField) ProtoMessage()

func (*VectorField) ProtoReflect

func (x *VectorField) ProtoReflect() protoreflect.Message

func (*VectorField) Reset

func (x *VectorField) Reset()

func (*VectorField) String

func (x *VectorField) String() string

VectorField_DenseVector

type VectorField_DenseVector struct {
	// Dense vector field.
	DenseVector *DenseVectorField `protobuf:"bytes,3,opt,name=dense_vector,json=denseVector,proto3,oneof"`
}

VectorField_SparseVector

type VectorField_SparseVector struct {
	// Sparse vector field.
	SparseVector *SparseVectorField `protobuf:"bytes,4,opt,name=sparse_vector,json=sparseVector,proto3,oneof"`
}

VectorSearch

type VectorSearch struct {

	// Types that are valid to be assigned to VectorType:
	//
	//	*VectorSearch_Vector
	//	*VectorSearch_SparseVector
	VectorType isVectorSearch_VectorType `protobuf_oneof:"vector_type"`
	// Required. The vector field to search.
	SearchField string `protobuf:"bytes,8,opt,name=search_field,json=searchField,proto3" json:"search_field,omitempty"`
	// Optional. A JSON filter expression, e.g. {"genre": {"$eq": "sci-fi"}},
	// represented as a google.protobuf.Struct.
	Filter *structpb.Struct `protobuf:"bytes,4,opt,name=filter,proto3" json:"filter,omitempty"`
	// Optional. The number of nearest neighbors to return.
	TopK *int32 `protobuf:"varint,5,opt,name=top_k,json=topK,proto3,oneof" json:"top_k,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. Sets the search hint. If no strategy is specified, the service
	// will use an index if one is available, and fall back to the default KNN
	// search otherwise.
	SearchHint *SearchHint `protobuf:"bytes,9,opt,name=search_hint,json=searchHint,proto3" json:"search_hint,omitempty"`
	// Optional. The distance metric to use for the KNN search. If not specified,
	// DOT_PRODUCT will be used as the default.
	DistanceMetric DistanceMetric `protobuf:"varint,11,opt,name=distance_metric,json=distanceMetric,proto3,enum=google.cloud.vectorsearch.v1beta.DistanceMetric" json:"distance_metric,omitempty"`
	// contains filtered or unexported fields
}

Defines a search operation using a query vector.

func (*VectorSearch) Descriptor

func (*VectorSearch) Descriptor() ([]byte, []int)

Deprecated: Use VectorSearch.ProtoReflect.Descriptor instead.

func (*VectorSearch) GetDistanceMetric

func (x *VectorSearch) GetDistanceMetric() DistanceMetric

func (*VectorSearch) GetFilter

func (x *VectorSearch) GetFilter() *structpb.Struct

func (*VectorSearch) GetOutputFields

func (x *VectorSearch) GetOutputFields() *OutputFields

func (*VectorSearch) GetSearchField

func (x *VectorSearch) GetSearchField() string

func (*VectorSearch) GetSearchHint

func (x *VectorSearch) GetSearchHint() *SearchHint

func (*VectorSearch) GetSparseVector

func (x *VectorSearch) GetSparseVector() *SparseVector

func (*VectorSearch) GetTopK

func (x *VectorSearch) GetTopK() int32

func (*VectorSearch) GetVector

func (x *VectorSearch) GetVector() *DenseVector

func (*VectorSearch) GetVectorType

func (x *VectorSearch) GetVectorType() isVectorSearch_VectorType

func (*VectorSearch) ProtoMessage

func (*VectorSearch) ProtoMessage()

func (*VectorSearch) ProtoReflect

func (x *VectorSearch) ProtoReflect() protoreflect.Message

func (*VectorSearch) Reset

func (x *VectorSearch) Reset()

func (*VectorSearch) String

func (x *VectorSearch) String() string

VectorSearchServiceClient

type VectorSearchServiceClient interface {
	// Lists Collections in a given project and location.
	ListCollections(ctx context.Context, in *ListCollectionsRequest, opts ...grpc.CallOption) (*ListCollectionsResponse, error)
	// Gets details of a single Collection.
	GetCollection(ctx context.Context, in *GetCollectionRequest, opts ...grpc.CallOption) (*Collection, error)
	// Creates a new Collection in a given project and location.
	CreateCollection(ctx context.Context, in *CreateCollectionRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Updates the parameters of a single Collection.
	UpdateCollection(ctx context.Context, in *UpdateCollectionRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Deletes a single Collection.
	DeleteCollection(ctx context.Context, in *DeleteCollectionRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Lists Indexes in a given project and location.
	ListIndexes(ctx context.Context, in *ListIndexesRequest, opts ...grpc.CallOption) (*ListIndexesResponse, error)
	// Gets details of a single Index.
	GetIndex(ctx context.Context, in *GetIndexRequest, opts ...grpc.CallOption) (*Index, error)
	// Creates a new Index in a given project and location.
	CreateIndex(ctx context.Context, in *CreateIndexRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Deletes a single Index.
	DeleteIndex(ctx context.Context, in *DeleteIndexRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Initiates a Long-Running Operation to import DataObjects into a Collection.
	ImportDataObjects(ctx context.Context, in *ImportDataObjectsRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Initiates a Long-Running Operation to export DataObjects from a Collection.
	ExportDataObjects(ctx context.Context, in *ExportDataObjectsRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
}

VectorSearchServiceClient is the client API for VectorSearchService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

func NewVectorSearchServiceClient

func NewVectorSearchServiceClient(cc grpc.ClientConnInterface) VectorSearchServiceClient

VectorSearchServiceServer

type VectorSearchServiceServer interface {
	// Lists Collections in a given project and location.
	ListCollections(context.Context, *ListCollectionsRequest) (*ListCollectionsResponse, error)
	// Gets details of a single Collection.
	GetCollection(context.Context, *GetCollectionRequest) (*Collection, error)
	// Creates a new Collection in a given project and location.
	CreateCollection(context.Context, *CreateCollectionRequest) (*longrunningpb.Operation, error)
	// Updates the parameters of a single Collection.
	UpdateCollection(context.Context, *UpdateCollectionRequest) (*longrunningpb.Operation, error)
	// Deletes a single Collection.
	DeleteCollection(context.Context, *DeleteCollectionRequest) (*longrunningpb.Operation, error)
	// Lists Indexes in a given project and location.
	ListIndexes(context.Context, *ListIndexesRequest) (*ListIndexesResponse, error)
	// Gets details of a single Index.
	GetIndex(context.Context, *GetIndexRequest) (*Index, error)
	// Creates a new Index in a given project and location.
	CreateIndex(context.Context, *CreateIndexRequest) (*longrunningpb.Operation, error)
	// Deletes a single Index.
	DeleteIndex(context.Context, *DeleteIndexRequest) (*longrunningpb.Operation, error)
	// Initiates a Long-Running Operation to import DataObjects into a Collection.
	ImportDataObjects(context.Context, *ImportDataObjectsRequest) (*longrunningpb.Operation, error)
	// Initiates a Long-Running Operation to export DataObjects from a Collection.
	ExportDataObjects(context.Context, *ExportDataObjectsRequest) (*longrunningpb.Operation, error)
}

VectorSearchServiceServer is the server API for VectorSearchService service. All implementations should embed UnimplementedVectorSearchServiceServer for forward compatibility

VectorSearch_SparseVector

type VectorSearch_SparseVector struct {
	// A sparse vector for the query.
	SparseVector *SparseVector `protobuf:"bytes,2,opt,name=sparse_vector,json=sparseVector,proto3,oneof"`
}

VectorSearch_Vector

type VectorSearch_Vector struct {
	// A dense vector for the query.
	Vector *DenseVector `protobuf:"bytes,1,opt,name=vector,proto3,oneof"`
}

Vector_Dense

type Vector_Dense struct {
	// A dense vector.
	Dense *DenseVector `protobuf:"bytes,2,opt,name=dense,proto3,oneof"`
}

Vector_Sparse

type Vector_Sparse struct {
	// A sparse vector.
	Sparse *SparseVector `protobuf:"bytes,3,opt,name=sparse,proto3,oneof"`
}

VertexEmbeddingConfig

type VertexEmbeddingConfig struct {

	// Required. Required: ID of the embedding model to use. See
	// https://cloud.google.com/vertex-ai/generative-ai/docs/learn/models#embeddings-models
	// for the list of supported models.
	ModelId string `protobuf:"bytes,1,opt,name=model_id,json=modelId,proto3" json:"model_id,omitempty"`
	// Required. Required: Text template for the input to the model. The template
	// must contain one or more references to fields in the DataObject, e.g.:
	// "Movie Title: {title} ---- Movie Plot: {plot}".
	TextTemplate string `protobuf:"bytes,2,opt,name=text_template,json=textTemplate,proto3" json:"text_template,omitempty"`
	// Required. Required: Task type for the embeddings.
	TaskType EmbeddingTaskType `protobuf:"varint,3,opt,name=task_type,json=taskType,proto3,enum=google.cloud.vectorsearch.v1beta.EmbeddingTaskType" json:"task_type,omitempty"`
	// contains filtered or unexported fields
}

Message describing the configuration for generating embeddings for a vector field using Vertex AI embeddings API.

func (*VertexEmbeddingConfig) Descriptor

func (*VertexEmbeddingConfig) Descriptor() ([]byte, []int)

Deprecated: Use VertexEmbeddingConfig.ProtoReflect.Descriptor instead.

func (*VertexEmbeddingConfig) GetModelId

func (x *VertexEmbeddingConfig) GetModelId() string

func (*VertexEmbeddingConfig) GetTaskType

func (x *VertexEmbeddingConfig) GetTaskType() EmbeddingTaskType

func (*VertexEmbeddingConfig) GetTextTemplate

func (x *VertexEmbeddingConfig) GetTextTemplate() string

func (*VertexEmbeddingConfig) ProtoMessage

func (*VertexEmbeddingConfig) ProtoMessage()

func (*VertexEmbeddingConfig) ProtoReflect

func (x *VertexEmbeddingConfig) ProtoReflect() protoreflect.Message

func (*VertexEmbeddingConfig) Reset

func (x *VertexEmbeddingConfig) Reset()

func (*VertexEmbeddingConfig) String

func (x *VertexEmbeddingConfig) String() string