io.pinecone.proto

Interface VectorServiceGrpc.AsyncService

All Known Implementing Classes:

VectorServiceGrpc.VectorServiceImplBase

Enclosing class:

VectorServiceGrpc

public static interface VectorServiceGrpc.AsyncService

 The `VectorService` interface is exposed by Pinecone's vector index services.
 This service could also be called a `gRPC` service or a `REST`-like api.
 

Method Summary

Modifier and Type	Method and Description
default void	delete(DeleteRequest request, io.grpc.stub.StreamObserver<DeleteResponse> responseObserver) Delete vectors The `delete` operation deletes vectors, by id, from a single namespace.
default void	describeIndexStats(DescribeIndexStatsRequest request, io.grpc.stub.StreamObserver<DescribeIndexStatsResponse> responseObserver) Get index stats The `describe_index_stats` operation returns statistics about the contents of an index, including the vector count per namespace and the number of dimensions, and the index fullness.
default void	fetch(FetchRequest request, io.grpc.stub.StreamObserver<FetchResponse> responseObserver) Fetch vectors The `fetch` operation looks up and returns vectors, by ID, from a single namespace.
default void	list(ListRequest request, io.grpc.stub.StreamObserver<ListResponse> responseObserver) List vector IDs The `list` operation lists the IDs of vectors in a single namespace of a serverless index.
default void	query(QueryRequest request, io.grpc.stub.StreamObserver<QueryResponse> responseObserver) Query vectors The `query` operation searches a namespace, using a query vector.
default void	update(UpdateRequest request, io.grpc.stub.StreamObserver<UpdateResponse> responseObserver) Update a vector The `update` operation updates a vector in a namespace.
default void	upsert(UpsertRequest request, io.grpc.stub.StreamObserver<UpsertResponse> responseObserver) Upsert vectors The `upsert` operation writes vectors into a namespace.

Method Detail

upsert

default void upsert(UpsertRequest request,
                    io.grpc.stub.StreamObserver<UpsertResponse> responseObserver)

 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/docs/upsert-data).
 

delete

default void delete(DeleteRequest request,
                    io.grpc.stub.StreamObserver<DeleteResponse> responseObserver)

 Delete vectors
 The `delete` operation deletes vectors, by id, from a single namespace.
 For guidance and examples, see [Delete data](https://docs.pinecone.io/docs/delete-data).
 

fetch

default void fetch(FetchRequest request,
                   io.grpc.stub.StreamObserver<FetchResponse> responseObserver)

 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/reference/fetch).
 

list

default void list(ListRequest request,
                  io.grpc.stub.StreamObserver<ListResponse> responseObserver)

 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 [Get record IDs](https://docs.pinecone.io/docs/get-record-ids).
 **Note:** `list` is supported only for serverless indexes.
 

query

default void query(QueryRequest request,
                   io.grpc.stub.StreamObserver<QueryResponse> responseObserver)

 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/docs/query-data).
 

update

default void update(UpdateRequest request,
                    io.grpc.stub.StreamObserver<UpdateResponse> responseObserver)

 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/reference/update).
 

describeIndexStats

default void describeIndexStats(DescribeIndexStatsRequest request,
                                io.grpc.stub.StreamObserver<DescribeIndexStatsResponse> responseObserver)

 Get index stats
 The `describe_index_stats` operation returns statistics about the contents of an index, including the vector count per namespace and 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://www.pinecone.io/docs/api/operation/describe_index/).