data

package
v1.1.1 Latest Latest
Warning

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

 Go to latest Published: Sep 18, 2024 License: Apache-2.0 Imports: 10 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	VectorService_Upsert_FullMethodName             = "/VectorService/Upsert"
	VectorService_Delete_FullMethodName             = "/VectorService/Delete"
	VectorService_Fetch_FullMethodName              = "/VectorService/Fetch"
	VectorService_List_FullMethodName               = "/VectorService/List"
	VectorService_Query_FullMethodName              = "/VectorService/Query"
	VectorService_Update_FullMethodName             = "/VectorService/Update"
	VectorService_DescribeIndexStats_FullMethodName = "/VectorService/DescribeIndexStats"
)

Variables

View Source 
var File_data_2024_07_proto protoreflect.FileDescriptor
View Source 
var VectorService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "VectorService",
	HandlerType: (*VectorServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "Upsert",
			Handler:    _VectorService_Upsert_Handler,
		},
		{
			MethodName: "Delete",
			Handler:    _VectorService_Delete_Handler,
		},
		{
			MethodName: "Fetch",
			Handler:    _VectorService_Fetch_Handler,
		},
		{
			MethodName: "List",
			Handler:    _VectorService_List_Handler,
		},
		{
			MethodName: "Query",
			Handler:    _VectorService_Query_Handler,
		},
		{
			MethodName: "Update",
			Handler:    _VectorService_Update_Handler,
		},
		{
			MethodName: "DescribeIndexStats",
			Handler:    _VectorService_DescribeIndexStats_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "data_2024-07.proto",
}

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

Functions

func RegisterVectorServiceServer 

func RegisterVectorServiceServer(s grpc.ServiceRegistrar, srv VectorServiceServer)

Types

type DeleteRequest 

type DeleteRequest struct {

	// Vectors to delete.
	Ids []string `protobuf:"bytes,1,rep,name=ids,proto3" json:"ids,omitempty"`
	// This indicates that all vectors in the index namespace should be deleted.
	DeleteAll bool `protobuf:"varint,2,opt,name=delete_all,json=deleteAll,proto3" json:"delete_all,omitempty"`
	// The namespace to delete vectors from, if applicable.
	Namespace string `protobuf:"bytes,3,opt,name=namespace,proto3" json:"namespace,omitempty"`
	// If specified, the metadata filter here will be used to select the vectors to delete. This is mutually exclusive
	// with specifying ids to delete in the ids param or using `delete_all=True`.
	// For guidance and examples, see [Filter with metadata](https://docs.pinecone.io/guides/data/filter-with-metadata).
	// Serverless indexes do not support delete by metadata. Instead, you can use the `list` operation to fetch the vector IDs based on their common ID prefix and then delete the records by ID.
	Filter *structpb.Struct `protobuf:"bytes,4,opt,name=filter,proto3" json:"filter,omitempty"`
	// contains filtered or unexported fields
}

The request for the `Delete` operation.

func (*DeleteRequest) Descriptor deprecated 

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

Deprecated: Use DeleteRequest.ProtoReflect.Descriptor instead.

func (*DeleteRequest) GetDeleteAll 

func (x *DeleteRequest) GetDeleteAll() bool

func (*DeleteRequest) GetFilter 

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

func (*DeleteRequest) GetIds 

func (x *DeleteRequest) GetIds() []string

func (*DeleteRequest) GetNamespace 

func (x *DeleteRequest) GetNamespace() string

func (*DeleteRequest) ProtoMessage 

func (*DeleteRequest) ProtoMessage()

func (*DeleteRequest) ProtoReflect 

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

func (*DeleteRequest) Reset 

func (x *DeleteRequest) Reset()

func (*DeleteRequest) String 

func (x *DeleteRequest) String() string

type DeleteResponse 

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

The response for the `Delete` operation.

func (*DeleteResponse) Descriptor deprecated 

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

Deprecated: Use DeleteResponse.ProtoReflect.Descriptor instead.

func (*DeleteResponse) ProtoMessage 

func (*DeleteResponse) ProtoMessage()

func (*DeleteResponse) ProtoReflect 

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

func (*DeleteResponse) Reset 

func (x *DeleteResponse) Reset()

func (*DeleteResponse) String 

func (x *DeleteResponse) String() string

type DescribeIndexStatsRequest 

type DescribeIndexStatsRequest struct {

	// If this parameter is present, the operation only returns statistics
	// for vectors that satisfy the filter.
	// See https://docs.pinecone.io/guides/data/filtering-with-metadata.
	Filter *structpb.Struct `protobuf:"bytes,1,opt,name=filter,proto3" json:"filter,omitempty"`
	// contains filtered or unexported fields
}

The request for the `describe_index_stats` operation.

func (*DescribeIndexStatsRequest) Descriptor deprecated 

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

Deprecated: Use DescribeIndexStatsRequest.ProtoReflect.Descriptor instead.

func (*DescribeIndexStatsRequest) GetFilter 

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

func (*DescribeIndexStatsRequest) ProtoMessage 

func (*DescribeIndexStatsRequest) ProtoMessage()

func (*DescribeIndexStatsRequest) ProtoReflect 

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

func (*DescribeIndexStatsRequest) Reset 

func (x *DescribeIndexStatsRequest) Reset()

func (*DescribeIndexStatsRequest) String 

func (x *DescribeIndexStatsRequest) String() string

type DescribeIndexStatsResponse 

type DescribeIndexStatsResponse struct {

	// A mapping for each namespace in the index from the namespace name to a
	// summary of its contents. If a metadata filter expression is present, the
	// summary will reflect only vectors matching that expression.
	Namespaces map[string]*NamespaceSummary `` /* 161-byte string literal not displayed */
	// The dimension of the indexed vectors.
	Dimension uint32 `protobuf:"varint,2,opt,name=dimension,proto3" json:"dimension,omitempty"`
	// The fullness of the index, regardless of whether a metadata filter expression was passed. The granularity of this metric is 10%.
	//
	// Serverless indexes scale automatically as needed, so index fullness is relevant only for pod-based indexes.
	//
	// The index fullness result may be inaccurate during pod resizing; to get the status of a pod resizing process, use [`describe_index`](https://docs.pinecone.io/reference/api/control-plane/describe_index).
	IndexFullness float32 `protobuf:"fixed32,3,opt,name=index_fullness,json=indexFullness,proto3" json:"index_fullness,omitempty"`
	// The total number of vectors in the index, regardless of whether a metadata filter expression was passed
	TotalVectorCount uint32 `protobuf:"varint,4,opt,name=total_vector_count,json=totalVectorCount,proto3" json:"total_vector_count,omitempty"`
	// contains filtered or unexported fields
}

The response for the `describe_index_stats` operation.

func (*DescribeIndexStatsResponse) Descriptor deprecated 

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

Deprecated: Use DescribeIndexStatsResponse.ProtoReflect.Descriptor instead.

func (*DescribeIndexStatsResponse) GetDimension 

func (x *DescribeIndexStatsResponse) GetDimension() uint32

func (*DescribeIndexStatsResponse) GetIndexFullness 

func (x *DescribeIndexStatsResponse) GetIndexFullness() float32

func (*DescribeIndexStatsResponse) GetNamespaces 

func (x *DescribeIndexStatsResponse) GetNamespaces() map[string]*NamespaceSummary

func (*DescribeIndexStatsResponse) GetTotalVectorCount 

func (x *DescribeIndexStatsResponse) GetTotalVectorCount() uint32

func (*DescribeIndexStatsResponse) ProtoMessage 

func (*DescribeIndexStatsResponse) ProtoMessage()

func (*DescribeIndexStatsResponse) ProtoReflect 

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

func (*DescribeIndexStatsResponse) Reset 

func (x *DescribeIndexStatsResponse) Reset()

func (*DescribeIndexStatsResponse) String 

func (x *DescribeIndexStatsResponse) String() string

type FetchRequest 

type FetchRequest struct {

	// The vector IDs to fetch. Does not accept values containing spaces.
	Ids       []string `protobuf:"bytes,1,rep,name=ids,proto3" json:"ids,omitempty"`
	Namespace string   `protobuf:"bytes,2,opt,name=namespace,proto3" json:"namespace,omitempty"`
	// contains filtered or unexported fields
}

The request for the `fetch` operation.

func (*FetchRequest) Descriptor deprecated 

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

Deprecated: Use FetchRequest.ProtoReflect.Descriptor instead.

func (*FetchRequest) GetIds 

func (x *FetchRequest) GetIds() []string

func (*FetchRequest) GetNamespace 

func (x *FetchRequest) GetNamespace() string

func (*FetchRequest) ProtoMessage 

func (*FetchRequest) ProtoMessage()

func (*FetchRequest) ProtoReflect 

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

func (*FetchRequest) Reset 

func (x *FetchRequest) Reset()

func (*FetchRequest) String 

func (x *FetchRequest) String() string

type FetchResponse 

type FetchResponse struct {

	// The fetched vectors, in the form of a map between the fetched ids and the fetched vectors
	Vectors map[string]*Vector `` /* 155-byte string literal not displayed */
	// The namespace of the vectors.
	Namespace string `protobuf:"bytes,2,opt,name=namespace,proto3" json:"namespace,omitempty"`
	// The usage for this operation.
	Usage *Usage `protobuf:"bytes,3,opt,name=usage,proto3,oneof" json:"usage,omitempty"`
	// contains filtered or unexported fields
}

The response for the `fetch` operation.

func (*FetchResponse) Descriptor deprecated 

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

Deprecated: Use FetchResponse.ProtoReflect.Descriptor instead.

func (*FetchResponse) GetNamespace 

func (x *FetchResponse) GetNamespace() string

func (*FetchResponse) GetUsage 

func (x *FetchResponse) GetUsage() *Usage

func (*FetchResponse) GetVectors 

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

func (*FetchResponse) ProtoMessage 

func (*FetchResponse) ProtoMessage()

func (*FetchResponse) ProtoReflect 

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

func (*FetchResponse) Reset 

func (x *FetchResponse) Reset()

func (*FetchResponse) String 

func (x *FetchResponse) String() string

type ListItem 

type ListItem struct {
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// contains filtered or unexported fields
}

func (*ListItem) Descriptor deprecated 

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

Deprecated: Use ListItem.ProtoReflect.Descriptor instead.

func (*ListItem) GetId 

func (x *ListItem) GetId() string

func (*ListItem) ProtoMessage 

func (*ListItem) ProtoMessage()

func (*ListItem) ProtoReflect 

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

func (*ListItem) Reset 

func (x *ListItem) Reset()

func (*ListItem) String 

func (x *ListItem) String() string

type ListRequest 

type ListRequest struct {

	// The vector IDs to fetch. Does not accept values containing spaces.
	Prefix *string `protobuf:"bytes,1,opt,name=prefix,proto3,oneof" json:"prefix,omitempty"`
	// Max number of ids to return
	Limit *uint32 `protobuf:"varint,2,opt,name=limit,proto3,oneof" json:"limit,omitempty"`
	// Pagination token to continue a previous listing operation
	PaginationToken *string `protobuf:"bytes,3,opt,name=pagination_token,json=paginationToken,proto3,oneof" json:"pagination_token,omitempty"`
	Namespace       string  `protobuf:"bytes,4,opt,name=namespace,proto3" json:"namespace,omitempty"`
	// contains filtered or unexported fields
}

The request for the `List` operation.

func (*ListRequest) Descriptor deprecated 

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

Deprecated: Use ListRequest.ProtoReflect.Descriptor instead.

func (*ListRequest) GetLimit 

func (x *ListRequest) GetLimit() uint32

func (*ListRequest) GetNamespace 

func (x *ListRequest) GetNamespace() string

func (*ListRequest) GetPaginationToken 

func (x *ListRequest) GetPaginationToken() string

func (*ListRequest) GetPrefix 

func (x *ListRequest) GetPrefix() string

func (*ListRequest) ProtoMessage 

func (*ListRequest) ProtoMessage()

func (*ListRequest) ProtoReflect 

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

func (*ListRequest) Reset 

func (x *ListRequest) Reset()

func (*ListRequest) String 

func (x *ListRequest) String() string

type ListResponse 

type ListResponse struct {

	// A list of ids
	Vectors []*ListItem `protobuf:"bytes,1,rep,name=vectors,proto3" json:"vectors,omitempty"`
	// Pagination token to continue past this listing
	Pagination *Pagination `protobuf:"bytes,2,opt,name=pagination,proto3,oneof" json:"pagination,omitempty"`
	// The namespace of the vectors.
	Namespace string `protobuf:"bytes,3,opt,name=namespace,proto3" json:"namespace,omitempty"`
	// The usage for this operation.
	Usage *Usage `protobuf:"bytes,4,opt,name=usage,proto3,oneof" json:"usage,omitempty"`
	// contains filtered or unexported fields
}

The response for the `List` operation.

func (*ListResponse) Descriptor deprecated 

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

Deprecated: Use ListResponse.ProtoReflect.Descriptor instead.

func (*ListResponse) GetNamespace 

func (x *ListResponse) GetNamespace() string

func (*ListResponse) GetPagination 

func (x *ListResponse) GetPagination() *Pagination

func (*ListResponse) GetUsage 

func (x *ListResponse) GetUsage() *Usage

func (*ListResponse) GetVectors 

func (x *ListResponse) GetVectors() []*ListItem

func (*ListResponse) ProtoMessage 

func (*ListResponse) ProtoMessage()

func (*ListResponse) ProtoReflect 

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

func (*ListResponse) Reset 

func (x *ListResponse) Reset()

func (*ListResponse) String 

func (x *ListResponse) String() string

type NamespaceSummary 

type NamespaceSummary struct {

	// The number of vectors stored in this namespace. Note that updates to this field may lag behind updates to the
	// underlying index and corresponding query results, etc.
	VectorCount uint32 `protobuf:"varint,1,opt,name=vector_count,json=vectorCount,proto3" json:"vector_count,omitempty"`
	// contains filtered or unexported fields
}

A summary of the contents of a namespace.

func (*NamespaceSummary) Descriptor deprecated 

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

Deprecated: Use NamespaceSummary.ProtoReflect.Descriptor instead.

func (*NamespaceSummary) GetVectorCount 

func (x *NamespaceSummary) GetVectorCount() uint32

func (*NamespaceSummary) ProtoMessage 

func (*NamespaceSummary) ProtoMessage()

func (*NamespaceSummary) ProtoReflect 

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

func (*NamespaceSummary) Reset 

func (x *NamespaceSummary) Reset()

func (*NamespaceSummary) String 

func (x *NamespaceSummary) String() string

type Pagination 

type Pagination struct {
	Next string `protobuf:"bytes,1,opt,name=next,proto3" json:"next,omitempty"`
	// contains filtered or unexported fields
}

func (*Pagination) Descriptor deprecated 

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

Deprecated: Use Pagination.ProtoReflect.Descriptor instead.

func (*Pagination) GetNext 

func (x *Pagination) GetNext() string

func (*Pagination) ProtoMessage 

func (*Pagination) ProtoMessage()

func (*Pagination) ProtoReflect 

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

func (*Pagination) Reset 

func (x *Pagination) Reset()

func (*Pagination) String 

func (x *Pagination) String() string

type QueryRequest 

type QueryRequest struct {

	// The namespace to query.
	Namespace string `protobuf:"bytes,1,opt,name=namespace,proto3" json:"namespace,omitempty"`
	// The number of results to return for each query.
	TopK uint32 `protobuf:"varint,2,opt,name=top_k,json=topK,proto3" json:"top_k,omitempty"`
	// The filter to apply. You can use vector metadata to limit your search. See [Filter with metadata](https://docs.pinecone.io/guides/data/filter-with-metadata).
	Filter *structpb.Struct `protobuf:"bytes,3,opt,name=filter,proto3" json:"filter,omitempty"`
	// Indicates whether vector values are included in the response.
	IncludeValues bool `protobuf:"varint,4,opt,name=include_values,json=includeValues,proto3" json:"include_values,omitempty"`
	// Indicates whether metadata is included in the response as well as the ids.
	IncludeMetadata bool `protobuf:"varint,5,opt,name=include_metadata,json=includeMetadata,proto3" json:"include_metadata,omitempty"`
	// DEPRECATED. The query vectors. Each `query()` request can contain only one of the parameters `queries`, `vector`, or  `id`.
	//
	// Deprecated: Marked as deprecated in data_2024-07.proto.
	Queries []*QueryVector `protobuf:"bytes,6,rep,name=queries,proto3" json:"queries,omitempty"`
	// The query vector. This should be the same length as the dimension of the index being queried. Each `query()` request can contain only one of the parameters `id` or `vector`.
	Vector []float32 `protobuf:"fixed32,7,rep,packed,name=vector,proto3" json:"vector,omitempty"`
	// The query sparse values.
	SparseVector *SparseValues `protobuf:"bytes,9,opt,name=sparse_vector,json=sparseVector,proto3" json:"sparse_vector,omitempty"`
	// The unique ID of the vector to be used as a query vector. Each `query()` request can contain only one of the parameters `queries`, `vector`, or  `id`.
	Id string `protobuf:"bytes,8,opt,name=id,proto3" json:"id,omitempty"`
	// contains filtered or unexported fields
}

The request for the `query` operation.

func (*QueryRequest) Descriptor deprecated 

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

Deprecated: Use QueryRequest.ProtoReflect.Descriptor instead.

func (*QueryRequest) GetFilter 

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

func (*QueryRequest) GetId 

func (x *QueryRequest) GetId() string

func (*QueryRequest) GetIncludeMetadata 

func (x *QueryRequest) GetIncludeMetadata() bool

func (*QueryRequest) GetIncludeValues 

func (x *QueryRequest) GetIncludeValues() bool

func (*QueryRequest) GetNamespace 

func (x *QueryRequest) GetNamespace() string

func (*QueryRequest) GetQueries deprecated 

func (x *QueryRequest) GetQueries() []*QueryVector

Deprecated: Marked as deprecated in data_2024-07.proto.

func (*QueryRequest) GetSparseVector 

func (x *QueryRequest) GetSparseVector() *SparseValues

func (*QueryRequest) GetTopK 

func (x *QueryRequest) GetTopK() uint32

func (*QueryRequest) GetVector 

func (x *QueryRequest) GetVector() []float32

func (*QueryRequest) ProtoMessage 

func (*QueryRequest) ProtoMessage()

func (*QueryRequest) ProtoReflect 

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

func (*QueryRequest) Reset 

func (x *QueryRequest) Reset()

func (*QueryRequest) String 

func (x *QueryRequest) String() string

type QueryResponse 

type QueryResponse struct {

	// DEPRECATED. The results of each query. The order is the same as `QueryRequest.queries`.
	//
	// Deprecated: Marked as deprecated in data_2024-07.proto.
	Results []*SingleQueryResults `protobuf:"bytes,1,rep,name=results,proto3" json:"results,omitempty"`
	// The matches for the vectors.
	Matches []*ScoredVector `protobuf:"bytes,2,rep,name=matches,proto3" json:"matches,omitempty"`
	// The namespace for the vectors.
	Namespace string `protobuf:"bytes,3,opt,name=namespace,proto3" json:"namespace,omitempty"`
	// The usage for this operation.
	Usage *Usage `protobuf:"bytes,4,opt,name=usage,proto3,oneof" json:"usage,omitempty"`
	// contains filtered or unexported fields
}

The response for the `query` operation. These are the matches found for a particular query vector. The matches are ordered from most similar to least similar.

func (*QueryResponse) Descriptor deprecated 

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

Deprecated: Use QueryResponse.ProtoReflect.Descriptor instead.

func (*QueryResponse) GetMatches 

func (x *QueryResponse) GetMatches() []*ScoredVector

func (*QueryResponse) GetNamespace 

func (x *QueryResponse) GetNamespace() string

func (*QueryResponse) GetResults deprecated 

func (x *QueryResponse) GetResults() []*SingleQueryResults

Deprecated: Marked as deprecated in data_2024-07.proto.

func (*QueryResponse) GetUsage 

func (x *QueryResponse) GetUsage() *Usage

func (*QueryResponse) ProtoMessage 

func (*QueryResponse) ProtoMessage()

func (*QueryResponse) ProtoReflect 

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

func (*QueryResponse) Reset 

func (x *QueryResponse) Reset()

func (*QueryResponse) String 

func (x *QueryResponse) String() string

type QueryVector 

type QueryVector struct {

	// The query vector values. This should be the same length as the dimension of the index being queried.
	Values []float32 `protobuf:"fixed32,1,rep,packed,name=values,proto3" json:"values,omitempty"`
	// The query sparse values.
	SparseValues *SparseValues `protobuf:"bytes,5,opt,name=sparse_values,json=sparseValues,proto3" json:"sparse_values,omitempty"`
	// An override for the number of results to return for this query vector.
	TopK uint32 `protobuf:"varint,2,opt,name=top_k,json=topK,proto3" json:"top_k,omitempty"`
	// An override the namespace to search.
	Namespace string `protobuf:"bytes,3,opt,name=namespace,proto3" json:"namespace,omitempty"`
	// An override for the metadata filter to apply. This replaces the request-level filter.
	Filter *structpb.Struct `protobuf:"bytes,4,opt,name=filter,proto3" json:"filter,omitempty"`
	// contains filtered or unexported fields
}

A single query vector within a `QueryRequest`.

func (*QueryVector) Descriptor deprecated 

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

Deprecated: Use QueryVector.ProtoReflect.Descriptor instead.

func (*QueryVector) GetFilter 

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

func (*QueryVector) GetNamespace 

func (x *QueryVector) GetNamespace() string

func (*QueryVector) GetSparseValues 

func (x *QueryVector) GetSparseValues() *SparseValues

func (*QueryVector) GetTopK 

func (x *QueryVector) GetTopK() uint32

func (*QueryVector) GetValues 

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

func (*QueryVector) ProtoMessage 

func (*QueryVector) ProtoMessage()

func (*QueryVector) ProtoReflect 

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

func (*QueryVector) Reset 

func (x *QueryVector) Reset()

func (*QueryVector) String 

func (x *QueryVector) String() string

type RequestUnion 

type RequestUnion struct {

	// Types that are assignable to RequestUnionInner:
	//
	//	*RequestUnion_Upsert
	//	*RequestUnion_Delete
	//	*RequestUnion_Update
	RequestUnionInner isRequestUnion_RequestUnionInner `protobuf_oneof:"RequestUnionInner"`
	// contains filtered or unexported fields
}

This is a container to hold mutating vector requests. This is not actually used in any public APIs.

func (*RequestUnion) Descriptor deprecated 

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

Deprecated: Use RequestUnion.ProtoReflect.Descriptor instead.

func (*RequestUnion) GetDelete 

func (x *RequestUnion) GetDelete() *DeleteRequest

func (*RequestUnion) GetRequestUnionInner 

func (m *RequestUnion) GetRequestUnionInner() isRequestUnion_RequestUnionInner

func (*RequestUnion) GetUpdate 

func (x *RequestUnion) GetUpdate() *UpdateRequest

func (*RequestUnion) GetUpsert 

func (x *RequestUnion) GetUpsert() *UpsertRequest

func (*RequestUnion) ProtoMessage 

func (*RequestUnion) ProtoMessage()

func (*RequestUnion) ProtoReflect 

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

func (*RequestUnion) Reset 

func (x *RequestUnion) Reset()

func (*RequestUnion) String 

func (x *RequestUnion) String() string

type RequestUnion_Delete 

type RequestUnion_Delete struct {
	Delete *DeleteRequest `protobuf:"bytes,2,opt,name=delete,proto3,oneof"`
}

type RequestUnion_Update 

type RequestUnion_Update struct {
	Update *UpdateRequest `protobuf:"bytes,3,opt,name=update,proto3,oneof"`
}

type RequestUnion_Upsert 

type RequestUnion_Upsert struct {
	Upsert *UpsertRequest `protobuf:"bytes,1,opt,name=upsert,proto3,oneof"`
}

type ScoredVector 

type ScoredVector struct {

	// This is the vector's unique id.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// This is a measure of similarity between this vector and the query vector.  The higher the score, the more they are similar.
	Score float32 `protobuf:"fixed32,2,opt,name=score,proto3" json:"score,omitempty"`
	// This is the vector data, if it is requested.
	Values []float32 `protobuf:"fixed32,3,rep,packed,name=values,proto3" json:"values,omitempty"`
	// This is the sparse data, if it is requested.
	SparseValues *SparseValues `protobuf:"bytes,5,opt,name=sparse_values,json=sparseValues,proto3" json:"sparse_values,omitempty"`
	// This is the metadata, if it is requested.
	Metadata *structpb.Struct `protobuf:"bytes,4,opt,name=metadata,proto3" json:"metadata,omitempty"`
	// contains filtered or unexported fields
}

func (*ScoredVector) Descriptor deprecated 

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

Deprecated: Use ScoredVector.ProtoReflect.Descriptor instead.

func (*ScoredVector) GetId 

func (x *ScoredVector) GetId() string

func (*ScoredVector) GetMetadata 

func (x *ScoredVector) GetMetadata() *structpb.Struct

func (*ScoredVector) GetScore 

func (x *ScoredVector) GetScore() float32

func (*ScoredVector) GetSparseValues 

func (x *ScoredVector) GetSparseValues() *SparseValues

func (*ScoredVector) GetValues 

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

func (*ScoredVector) ProtoMessage 

func (*ScoredVector) ProtoMessage()

func (*ScoredVector) ProtoReflect 

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

func (*ScoredVector) Reset 

func (x *ScoredVector) Reset()

func (*ScoredVector) String 

func (x *ScoredVector) String() string

type SingleQueryResults 

type SingleQueryResults struct {

	// The matches for the vectors.
	Matches []*ScoredVector `protobuf:"bytes,1,rep,name=matches,proto3" json:"matches,omitempty"`
	// The namespace for the vectors.
	Namespace string `protobuf:"bytes,2,opt,name=namespace,proto3" json:"namespace,omitempty"`
	// contains filtered or unexported fields
}

The query results for a single `QueryVector`

func (*SingleQueryResults) Descriptor deprecated 

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

Deprecated: Use SingleQueryResults.ProtoReflect.Descriptor instead.

func (*SingleQueryResults) GetMatches 

func (x *SingleQueryResults) GetMatches() []*ScoredVector

func (*SingleQueryResults) GetNamespace 

func (x *SingleQueryResults) GetNamespace() string

func (*SingleQueryResults) ProtoMessage 

func (*SingleQueryResults) ProtoMessage()

func (*SingleQueryResults) ProtoReflect 

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

func (*SingleQueryResults) Reset 

func (x *SingleQueryResults) Reset()

func (*SingleQueryResults) String 

func (x *SingleQueryResults) String() string

type SparseValues 

type SparseValues struct {
	Indices []uint32  `protobuf:"varint,1,rep,packed,name=indices,proto3" json:"indices,omitempty"`
	Values  []float32 `protobuf:"fixed32,2,rep,packed,name=values,proto3" json:"values,omitempty"`
	// contains filtered or unexported fields
}

func (*SparseValues) Descriptor deprecated 

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

Deprecated: Use SparseValues.ProtoReflect.Descriptor instead.

func (*SparseValues) GetIndices 

func (x *SparseValues) GetIndices() []uint32

func (*SparseValues) GetValues 

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

func (*SparseValues) ProtoMessage 

func (*SparseValues) ProtoMessage()

func (*SparseValues) ProtoReflect 

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

func (*SparseValues) Reset 

func (x *SparseValues) Reset()

func (*SparseValues) String 

func (x *SparseValues) String() string

type UnimplementedVectorServiceServer 

type UnimplementedVectorServiceServer struct {
}

UnimplementedVectorServiceServer must be embedded to have forward compatible implementations.

func (UnimplementedVectorServiceServer) Delete 

func (UnimplementedVectorServiceServer) Delete(context.Context, *DeleteRequest) (*DeleteResponse, error)

func (UnimplementedVectorServiceServer) DescribeIndexStats 

func (UnimplementedVectorServiceServer) DescribeIndexStats(context.Context, *DescribeIndexStatsRequest) (*DescribeIndexStatsResponse, error)

func (UnimplementedVectorServiceServer) Fetch 

func (UnimplementedVectorServiceServer) Fetch(context.Context, *FetchRequest) (*FetchResponse, error)

func (UnimplementedVectorServiceServer) List 

func (UnimplementedVectorServiceServer) List(context.Context, *ListRequest) (*ListResponse, error)

func (UnimplementedVectorServiceServer) Query 

func (UnimplementedVectorServiceServer) Query(context.Context, *QueryRequest) (*QueryResponse, error)

func (UnimplementedVectorServiceServer) Update 

func (UnimplementedVectorServiceServer) Update(context.Context, *UpdateRequest) (*UpdateResponse, error)

func (UnimplementedVectorServiceServer) Upsert 

func (UnimplementedVectorServiceServer) Upsert(context.Context, *UpsertRequest) (*UpsertResponse, error)

type UnsafeVectorServiceServer 

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

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

type UpdateRequest 

type UpdateRequest struct {

	// Vector's unique id.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// Vector data.
	Values       []float32     `protobuf:"fixed32,2,rep,packed,name=values,proto3" json:"values,omitempty"`
	SparseValues *SparseValues `protobuf:"bytes,5,opt,name=sparse_values,json=sparseValues,proto3" json:"sparse_values,omitempty"`
	// Metadata to set for the vector.
	SetMetadata *structpb.Struct `protobuf:"bytes,3,opt,name=set_metadata,json=setMetadata,proto3" json:"set_metadata,omitempty"`
	// The namespace containing the vector to update.
	Namespace string `protobuf:"bytes,4,opt,name=namespace,proto3" json:"namespace,omitempty"`
	// contains filtered or unexported fields
}

The request for the `update` operation.

func (*UpdateRequest) Descriptor deprecated 

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

Deprecated: Use UpdateRequest.ProtoReflect.Descriptor instead.

func (*UpdateRequest) GetId 

func (x *UpdateRequest) GetId() string

func (*UpdateRequest) GetNamespace 

func (x *UpdateRequest) GetNamespace() string

func (*UpdateRequest) GetSetMetadata 

func (x *UpdateRequest) GetSetMetadata() *structpb.Struct

func (*UpdateRequest) GetSparseValues 

func (x *UpdateRequest) GetSparseValues() *SparseValues

func (*UpdateRequest) GetValues 

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

func (*UpdateRequest) ProtoMessage 

func (*UpdateRequest) ProtoMessage()

func (*UpdateRequest) ProtoReflect 

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

func (*UpdateRequest) Reset 

func (x *UpdateRequest) Reset()

func (*UpdateRequest) String 

func (x *UpdateRequest) String() string

type UpdateResponse 

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

The response for the `update` operation.

func (*UpdateResponse) Descriptor deprecated 

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

Deprecated: Use UpdateResponse.ProtoReflect.Descriptor instead.

func (*UpdateResponse) ProtoMessage 

func (*UpdateResponse) ProtoMessage()

func (*UpdateResponse) ProtoReflect 

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

func (*UpdateResponse) Reset 

func (x *UpdateResponse) Reset()

func (*UpdateResponse) String 

func (x *UpdateResponse) String() string

type UpsertRequest 

type UpsertRequest struct {

	// An array containing the vectors to upsert. Recommended batch limit is 100 vectors.
	Vectors []*Vector `protobuf:"bytes,1,rep,name=vectors,proto3" json:"vectors,omitempty"`
	// The namespace where you upsert vectors.
	Namespace string `protobuf:"bytes,2,opt,name=namespace,proto3" json:"namespace,omitempty"`
	// contains filtered or unexported fields
}

The request for the `upsert` operation.

func (*UpsertRequest) Descriptor deprecated 

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

Deprecated: Use UpsertRequest.ProtoReflect.Descriptor instead.

func (*UpsertRequest) GetNamespace 

func (x *UpsertRequest) GetNamespace() string

func (*UpsertRequest) GetVectors 

func (x *UpsertRequest) GetVectors() []*Vector

func (*UpsertRequest) ProtoMessage 

func (*UpsertRequest) ProtoMessage()

func (*UpsertRequest) ProtoReflect 

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

func (*UpsertRequest) Reset 

func (x *UpsertRequest) Reset()

func (*UpsertRequest) String 

func (x *UpsertRequest) String() string

type UpsertResponse 

type UpsertResponse struct {

	// The number of vectors upserted.
	UpsertedCount uint32 `protobuf:"varint,1,opt,name=upserted_count,json=upsertedCount,proto3" json:"upserted_count,omitempty"`
	// contains filtered or unexported fields
}

The response for the `upsert` operation.

func (*UpsertResponse) Descriptor deprecated 

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

Deprecated: Use UpsertResponse.ProtoReflect.Descriptor instead.

func (*UpsertResponse) GetUpsertedCount 

func (x *UpsertResponse) GetUpsertedCount() uint32

func (*UpsertResponse) ProtoMessage 

func (*UpsertResponse) ProtoMessage()

func (*UpsertResponse) ProtoReflect 

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

func (*UpsertResponse) Reset 

func (x *UpsertResponse) Reset()

func (*UpsertResponse) String 

func (x *UpsertResponse) String() string

type Usage 

type Usage struct {

	// The number of read units consumed by this operation.
	ReadUnits *uint32 `protobuf:"varint,1,opt,name=read_units,json=readUnits,proto3,oneof" json:"read_units,omitempty"`
	// contains filtered or unexported fields
}

func (*Usage) Descriptor deprecated 

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

Deprecated: Use Usage.ProtoReflect.Descriptor instead.

func (*Usage) GetReadUnits 

func (x *Usage) GetReadUnits() uint32

func (*Usage) ProtoMessage 

func (*Usage) ProtoMessage()

func (*Usage) ProtoReflect 

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

func (*Usage) Reset 

func (x *Usage) Reset()

func (*Usage) String 

func (x *Usage) String() string

type Vector 

type Vector struct {

	// This is the vector's unique id.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// This is the vector data included in the request.
	Values       []float32     `protobuf:"fixed32,2,rep,packed,name=values,proto3" json:"values,omitempty"`
	SparseValues *SparseValues `protobuf:"bytes,4,opt,name=sparse_values,json=sparseValues,proto3" json:"sparse_values,omitempty"`
	// This is the metadata included in the request.
	Metadata *structpb.Struct `protobuf:"bytes,3,opt,name=metadata,proto3" json:"metadata,omitempty"`
	// contains filtered or unexported fields
}

func (*Vector) Descriptor deprecated 

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

Deprecated: Use Vector.ProtoReflect.Descriptor instead.

func (*Vector) GetId 

func (x *Vector) GetId() string

func (*Vector) GetMetadata 

func (x *Vector) GetMetadata() *structpb.Struct

func (*Vector) GetSparseValues 

func (x *Vector) GetSparseValues() *SparseValues

func (*Vector) GetValues 

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

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

type VectorServiceClient 

type VectorServiceClient interface {
	// Upsert vectors
	//
	// The `upsert` operation writes vectors into a namespace. If a new value is upserted for an existing vector ID, it will overwrite the previous value.
	//
	// For guidance and examples, see [Upsert data](https://docs.pinecone.io/guides/data/upsert-data).
	Upsert(ctx context.Context, in *UpsertRequest, opts ...grpc.CallOption) (*UpsertResponse, error)
	// Delete vectors
	//
	// The `delete` operation deletes vectors, by id, from a single namespace.
	//
	// For guidance and examples, see [Delete data](https://docs.pinecone.io/guides/data/delete-data).
	Delete(ctx context.Context, in *DeleteRequest, opts ...grpc.CallOption) (*DeleteResponse, error)
	// Fetch vectors
	//
	// The `fetch` operation looks up and returns vectors, by ID, from a single namespace. The returned vectors include the vector data and/or metadata.
	//
	// For guidance and examples, see [Fetch data](https://docs.pinecone.io/guides/data/fetch-data).
	Fetch(ctx context.Context, in *FetchRequest, opts ...grpc.CallOption) (*FetchResponse, error)
	// List vector IDs
	//
	// The `list` operation lists the IDs of vectors in a single namespace of a serverless index. An optional prefix can be passed to limit the results to IDs with a common prefix.
	//
	// `list` returns up to 100 IDs at a time by default in sorted order (bitwise/"C" collation). If the `limit` parameter is set, `list` returns up to that number of IDs instead. Whenever there are additional IDs to return, the response also includes a `pagination_token` that you can use to get the next batch of IDs. When the response does not include a `pagination_token`, there are no more IDs to return.
	//
	// For guidance and examples, see [List record IDs](https://docs.pinecone.io/guides/data/list-record-ids).
	//
	// **Note:** `list` is supported only for serverless indexes.
	List(ctx context.Context, in *ListRequest, opts ...grpc.CallOption) (*ListResponse, error)
	// Query vectors
	//
	// The `query` operation searches a namespace, using a query vector. It retrieves the ids of the most similar items in a namespace, along with their similarity scores.
	//
	// For guidance and examples, see [Query data](https://docs.pinecone.io/guides/data/query-data).
	Query(ctx context.Context, in *QueryRequest, opts ...grpc.CallOption) (*QueryResponse, error)
	// Update a vector
	//
	// The `update` operation updates a vector in a namespace. If a value is included, it will overwrite the previous value. If a `set_metadata` is included, the values of the fields specified in it will be added or overwrite the previous value.
	//
	// For guidance and examples, see [Update data](https://docs.pinecone.io/guides/data/update-data).
	Update(ctx context.Context, in *UpdateRequest, opts ...grpc.CallOption) (*UpdateResponse, error)
	// Get index stats
	//
	// The `describe_index_stats` operation returns statistics about the contents of an index, including the vector count per namespace, the number of dimensions, and the index fullness.
	//
	// Serverless indexes scale automatically as needed, so index fullness is relevant only for pod-based indexes.
	//
	// For pod-based indexes, the index fullness result may be inaccurate during pod resizing; to get the status of a pod resizing process, use [`describe_index`](https://docs.pinecone.io/reference/api/control-plane/describe_index).
	DescribeIndexStats(ctx context.Context, in *DescribeIndexStatsRequest, opts ...grpc.CallOption) (*DescribeIndexStatsResponse, error)
}

VectorServiceClient is the client API for VectorService 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 NewVectorServiceClient 

func NewVectorServiceClient(cc grpc.ClientConnInterface) VectorServiceClient

type VectorServiceServer 

type VectorServiceServer interface {
	// Upsert vectors
	//
	// The `upsert` operation writes vectors into a namespace. If a new value is upserted for an existing vector ID, it will overwrite the previous value.
	//
	// For guidance and examples, see [Upsert data](https://docs.pinecone.io/guides/data/upsert-data).
	Upsert(context.Context, *UpsertRequest) (*UpsertResponse, error)
	// Delete vectors
	//
	// The `delete` operation deletes vectors, by id, from a single namespace.
	//
	// For guidance and examples, see [Delete data](https://docs.pinecone.io/guides/data/delete-data).
	Delete(context.Context, *DeleteRequest) (*DeleteResponse, error)
	// Fetch vectors
	//
	// The `fetch` operation looks up and returns vectors, by ID, from a single namespace. The returned vectors include the vector data and/or metadata.
	//
	// For guidance and examples, see [Fetch data](https://docs.pinecone.io/guides/data/fetch-data).
	Fetch(context.Context, *FetchRequest) (*FetchResponse, error)
	// List vector IDs
	//
	// The `list` operation lists the IDs of vectors in a single namespace of a serverless index. An optional prefix can be passed to limit the results to IDs with a common prefix.
	//
	// `list` returns up to 100 IDs at a time by default in sorted order (bitwise/"C" collation). If the `limit` parameter is set, `list` returns up to that number of IDs instead. Whenever there are additional IDs to return, the response also includes a `pagination_token` that you can use to get the next batch of IDs. When the response does not include a `pagination_token`, there are no more IDs to return.
	//
	// For guidance and examples, see [List record IDs](https://docs.pinecone.io/guides/data/list-record-ids).
	//
	// **Note:** `list` is supported only for serverless indexes.
	List(context.Context, *ListRequest) (*ListResponse, error)
	// Query vectors
	//
	// The `query` operation searches a namespace, using a query vector. It retrieves the ids of the most similar items in a namespace, along with their similarity scores.
	//
	// For guidance and examples, see [Query data](https://docs.pinecone.io/guides/data/query-data).
	Query(context.Context, *QueryRequest) (*QueryResponse, error)
	// Update a vector
	//
	// The `update` operation updates a vector in a namespace. If a value is included, it will overwrite the previous value. If a `set_metadata` is included, the values of the fields specified in it will be added or overwrite the previous value.
	//
	// For guidance and examples, see [Update data](https://docs.pinecone.io/guides/data/update-data).
	Update(context.Context, *UpdateRequest) (*UpdateResponse, error)
	// Get index stats
	//
	// The `describe_index_stats` operation returns statistics about the contents of an index, including the vector count per namespace, the number of dimensions, and the index fullness.
	//
	// Serverless indexes scale automatically as needed, so index fullness is relevant only for pod-based indexes.
	//
	// For pod-based indexes, the index fullness result may be inaccurate during pod resizing; to get the status of a pod resizing process, use [`describe_index`](https://docs.pinecone.io/reference/api/control-plane/describe_index).
	DescribeIndexStats(context.Context, *DescribeIndexStatsRequest) (*DescribeIndexStatsResponse, error)
	// contains filtered or unexported methods
}

VectorServiceServer is the server API for VectorService service. All implementations must embed UnimplementedVectorServiceServer for forward compatibility

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.