io.pinecone.proto

Class VectorServiceGrpc.VectorServiceFutureStub

java.lang.Object

io.grpc.stub.AbstractStub<S>

io.grpc.stub.AbstractFutureStub<VectorServiceGrpc.VectorServiceFutureStub>

io.pinecone.proto.VectorServiceGrpc.VectorServiceFutureStub

Enclosing class:

VectorServiceGrpc

public static final class VectorServiceGrpc.VectorServiceFutureStub
extends io.grpc.stub.AbstractFutureStub<VectorServiceGrpc.VectorServiceFutureStub>

A stub to allow clients to do ListenableFuture-style rpc calls to service VectorService.

 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.
 

Nested Class Summary

Nested classes/interfaces inherited from class io.grpc.stub.AbstractStub

io.grpc.stub.AbstractStub.StubFactory<T extends io.grpc.stub.AbstractStub<T>>

Method Summary

Modifier and Type	Method and Description
protected VectorServiceGrpc.VectorServiceFutureStub	build(io.grpc.Channel channel, io.grpc.CallOptions callOptions)
com.google.common.util.concurrent.ListenableFuture<DeleteResponse>	delete(DeleteRequest request) Delete vectors The `delete` operation deletes vectors, by id, from a single namespace.
com.google.common.util.concurrent.ListenableFuture<DescribeIndexStatsResponse>	describeIndexStats(DescribeIndexStatsRequest request) 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.
com.google.common.util.concurrent.ListenableFuture<FetchResponse>	fetch(FetchRequest request) Fetch vectors The `fetch` operation looks up and returns vectors, by ID, from a single namespace.
com.google.common.util.concurrent.ListenableFuture<ListResponse>	list(ListRequest request) List vector IDs The `list` operation lists the IDs of vectors in a single namespace of a serverless index.
com.google.common.util.concurrent.ListenableFuture<QueryResponse>	query(QueryRequest request) Query vectors The `query` operation searches a namespace, using a query vector.
com.google.common.util.concurrent.ListenableFuture<UpdateResponse>	update(UpdateRequest request) Update a vector The `update` operation updates a vector in a namespace.
com.google.common.util.concurrent.ListenableFuture<UpsertResponse>	upsert(UpsertRequest request) Upsert vectors The `upsert` operation writes vectors into a namespace.

Methods inherited from class io.grpc.stub.AbstractFutureStub

newStub, newStub

Methods inherited from class io.grpc.stub.AbstractStub

getCallOptions, getChannel, withCallCredentials, withChannel, withCompression, withDeadline, withDeadlineAfter, withExecutor, withInterceptors, withMaxInboundMessageSize, withMaxOutboundMessageSize, withOption, withWaitForReady

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

build

protected VectorServiceGrpc.VectorServiceFutureStub build(io.grpc.Channel channel,
                                                          io.grpc.CallOptions callOptions)

Specified by:

build in class io.grpc.stub.AbstractStub<VectorServiceGrpc.VectorServiceFutureStub>

upsert

public com.google.common.util.concurrent.ListenableFuture<UpsertResponse> upsert(UpsertRequest request)

 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

public com.google.common.util.concurrent.ListenableFuture<DeleteResponse> delete(DeleteRequest request)

 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

public com.google.common.util.concurrent.ListenableFuture<FetchResponse> fetch(FetchRequest request)

 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

public com.google.common.util.concurrent.ListenableFuture<ListResponse> list(ListRequest request)

 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

public com.google.common.util.concurrent.ListenableFuture<QueryResponse> query(QueryRequest request)

 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

public com.google.common.util.concurrent.ListenableFuture<UpdateResponse> update(UpdateRequest request)

 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

public com.google.common.util.concurrent.ListenableFuture<DescribeIndexStatsResponse> describeIndexStats(DescribeIndexStatsRequest request)

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