org.openapitools.db_data.client.api

Class VectorOperationsApi

java.lang.Object

org.openapitools.db_data.client.api.VectorOperationsApi

public class VectorOperationsApi
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
VectorOperationsApi()
VectorOperationsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
java.lang.Object	deleteVectors(DeleteRequest deleteRequest) Delete vectors The `delete` operation deletes vectors, by id, from a single namespace.
okhttp3.Call	deleteVectorsAsync(DeleteRequest deleteRequest, ApiCallback<java.lang.Object> _callback) Delete vectors (asynchronously) The `delete` operation deletes vectors, by id, from a single namespace.
okhttp3.Call	deleteVectorsCall(DeleteRequest deleteRequest, ApiCallback _callback) Build call for deleteVectors
ApiResponse<java.lang.Object>	deleteVectorsWithHttpInfo(DeleteRequest deleteRequest) Delete vectors The `delete` operation deletes vectors, by id, from a single namespace.
IndexDescription	describeIndexStats(DescribeIndexStatsRequest describeIndexStatsRequest) 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.
okhttp3.Call	describeIndexStatsAsync(DescribeIndexStatsRequest describeIndexStatsRequest, ApiCallback<IndexDescription> _callback) Get index stats (asynchronously) 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.
okhttp3.Call	describeIndexStatsCall(DescribeIndexStatsRequest describeIndexStatsRequest, ApiCallback _callback) Build call for describeIndexStats
ApiResponse<IndexDescription>	describeIndexStatsWithHttpInfo(DescribeIndexStatsRequest describeIndexStatsRequest) 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.
FetchResponse	fetchVectors(java.util.List<java.lang.String> ids, java.lang.String namespace) Fetch vectors The `fetch` operation looks up and returns vectors, by ID, from a single namespace.
okhttp3.Call	fetchVectorsAsync(java.util.List<java.lang.String> ids, java.lang.String namespace, ApiCallback<FetchResponse> _callback) Fetch vectors (asynchronously) The `fetch` operation looks up and returns vectors, by ID, from a single namespace.
okhttp3.Call	fetchVectorsCall(java.util.List<java.lang.String> ids, java.lang.String namespace, ApiCallback _callback) Build call for fetchVectors
ApiResponse<FetchResponse>	fetchVectorsWithHttpInfo(java.util.List<java.lang.String> ids, java.lang.String namespace) Fetch vectors The `fetch` operation looks up and returns vectors, by ID, from a single namespace.
ApiClient	getApiClient()
java.lang.String	getCustomBaseUrl()
int	getHostIndex()
ListResponse	listVectors(java.lang.String prefix, java.lang.Long limit, java.lang.String paginationToken, java.lang.String namespace) List vector IDs The `list` operation lists the IDs of vectors in a single namespace of a serverless index.
okhttp3.Call	listVectorsAsync(java.lang.String prefix, java.lang.Long limit, java.lang.String paginationToken, java.lang.String namespace, ApiCallback<ListResponse> _callback) List vector IDs (asynchronously) The `list` operation lists the IDs of vectors in a single namespace of a serverless index.
okhttp3.Call	listVectorsCall(java.lang.String prefix, java.lang.Long limit, java.lang.String paginationToken, java.lang.String namespace, ApiCallback _callback) Build call for listVectors
ApiResponse<ListResponse>	listVectorsWithHttpInfo(java.lang.String prefix, java.lang.Long limit, java.lang.String paginationToken, java.lang.String namespace) List vector IDs The `list` operation lists the IDs of vectors in a single namespace of a serverless index.
QueryResponse	queryVectors(QueryRequest queryRequest) Query vectors The `query` operation searches a namespace, using a query vector.
okhttp3.Call	queryVectorsAsync(QueryRequest queryRequest, ApiCallback<QueryResponse> _callback) Query vectors (asynchronously) The `query` operation searches a namespace, using a query vector.
okhttp3.Call	queryVectorsCall(QueryRequest queryRequest, ApiCallback _callback) Build call for queryVectors
ApiResponse<QueryResponse>	queryVectorsWithHttpInfo(QueryRequest queryRequest) Query vectors The `query` operation searches a namespace, using a query vector.
void	setApiClient(ApiClient apiClient)
void	setCustomBaseUrl(java.lang.String customBaseUrl)
void	setHostIndex(int hostIndex)
java.lang.Object	updateVector(UpdateRequest updateRequest) Update a vector The `update` operation updates a vector in a namespace.
okhttp3.Call	updateVectorAsync(UpdateRequest updateRequest, ApiCallback<java.lang.Object> _callback) Update a vector (asynchronously) The `update` operation updates a vector in a namespace.
okhttp3.Call	updateVectorCall(UpdateRequest updateRequest, ApiCallback _callback) Build call for updateVector
ApiResponse<java.lang.Object>	updateVectorWithHttpInfo(UpdateRequest updateRequest) Update a vector The `update` operation updates a vector in a namespace.
UpsertResponse	upsertVectors(UpsertRequest upsertRequest) Upsert vectors The `upsert` operation writes vectors into a namespace.
okhttp3.Call	upsertVectorsAsync(UpsertRequest upsertRequest, ApiCallback<UpsertResponse> _callback) Upsert vectors (asynchronously) The `upsert` operation writes vectors into a namespace.
okhttp3.Call	upsertVectorsCall(UpsertRequest upsertRequest, ApiCallback _callback) Build call for upsertVectors
ApiResponse<UpsertResponse>	upsertVectorsWithHttpInfo(UpsertRequest upsertRequest) Upsert vectors The `upsert` operation writes vectors into a namespace.

Methods inherited from class java.lang.Object

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

Constructor Detail

VectorOperationsApi

public VectorOperationsApi()

VectorOperationsApi

public VectorOperationsApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getHostIndex

public int getHostIndex()

setHostIndex

public void setHostIndex(int hostIndex)

getCustomBaseUrl

public java.lang.String getCustomBaseUrl()

setCustomBaseUrl

public void setCustomBaseUrl(java.lang.String customBaseUrl)

deleteVectorsCall

public okhttp3.Call deleteVectorsCall(DeleteRequest deleteRequest,
                                      ApiCallback _callback)
                               throws ApiException

Build call for deleteVectors

Parameters:

deleteRequest - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details

Status Code	Description	Response Headers
200	A successful response.	-
400	Bad request. The request body included invalid request parameters.	-
4XX	An unexpected error response.	-
5XX	An unexpected error response.	-

deleteVectors

public java.lang.Object deleteVectors(DeleteRequest deleteRequest)
                               throws ApiException

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

Parameters:

deleteRequest - (required)

Returns:

Object

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Status Code	Description	Response Headers
200	A successful response.	-
400	Bad request. The request body included invalid request parameters.	-
4XX	An unexpected error response.	-
5XX	An unexpected error response.	-

deleteVectorsWithHttpInfo

public ApiResponse<java.lang.Object> deleteVectorsWithHttpInfo(DeleteRequest deleteRequest)
                                                        throws ApiException

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

Parameters:

deleteRequest - (required)

Returns:

ApiResponse<Object>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Status Code	Description	Response Headers
200	A successful response.	-
400	Bad request. The request body included invalid request parameters.	-
4XX	An unexpected error response.	-
5XX	An unexpected error response.	-

deleteVectorsAsync

public okhttp3.Call deleteVectorsAsync(DeleteRequest deleteRequest,
                                       ApiCallback<java.lang.Object> _callback)
                                throws ApiException

Delete vectors (asynchronously) 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).

Parameters:

deleteRequest - (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details

Status Code	Description	Response Headers
200	A successful response.	-
400	Bad request. The request body included invalid request parameters.	-
4XX	An unexpected error response.	-
5XX	An unexpected error response.	-

describeIndexStatsCall

public okhttp3.Call describeIndexStatsCall(DescribeIndexStatsRequest describeIndexStatsRequest,
                                           ApiCallback _callback)
                                    throws ApiException

Build call for describeIndexStats

Parameters:

describeIndexStatsRequest - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details

Status Code	Description	Response Headers
200	A successful response.	-
400	Bad request. The request body included invalid request parameters.	-
4XX	An unexpected error response.	-
5XX	An unexpected error response.	-

describeIndexStats

public IndexDescription describeIndexStats(DescribeIndexStatsRequest describeIndexStatsRequest)
                                    throws ApiException

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

Parameters:

describeIndexStatsRequest - (required)

Returns:

IndexDescription

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Status Code	Description	Response Headers
200	A successful response.	-
400	Bad request. The request body included invalid request parameters.	-
4XX	An unexpected error response.	-
5XX	An unexpected error response.	-

describeIndexStatsWithHttpInfo

public ApiResponse<IndexDescription> describeIndexStatsWithHttpInfo(DescribeIndexStatsRequest describeIndexStatsRequest)
                                                             throws ApiException

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

Parameters:

describeIndexStatsRequest - (required)

Returns:

ApiResponse<IndexDescription>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Status Code	Description	Response Headers
200	A successful response.	-
400	Bad request. The request body included invalid request parameters.	-
4XX	An unexpected error response.	-
5XX	An unexpected error response.	-

describeIndexStatsAsync

public okhttp3.Call describeIndexStatsAsync(DescribeIndexStatsRequest describeIndexStatsRequest,
                                            ApiCallback<IndexDescription> _callback)
                                     throws ApiException

Get index stats (asynchronously) 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).

Parameters:

describeIndexStatsRequest - (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details

Status Code	Description	Response Headers
200	A successful response.	-
400	Bad request. The request body included invalid request parameters.	-
4XX	An unexpected error response.	-
5XX	An unexpected error response.	-

fetchVectorsCall

public okhttp3.Call fetchVectorsCall(java.util.List<java.lang.String> ids,
                                     java.lang.String namespace,
                                     ApiCallback _callback)
                              throws ApiException

Build call for fetchVectors

Parameters:

ids - The vector IDs to fetch. Does not accept values containing spaces. (required)

namespace - (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details

Status Code	Description	Response Headers
200	A successful response.	-
400	Bad request. The request body included invalid request parameters.	-
4XX	An unexpected error response.	-
5XX	An unexpected error response.	-

fetchVectors

public FetchResponse fetchVectors(java.util.List<java.lang.String> ids,
                                  java.lang.String namespace)
                           throws ApiException

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

Parameters:

ids - The vector IDs to fetch. Does not accept values containing spaces. (required)

namespace - (optional)

Returns:

FetchResponse

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Status Code	Description	Response Headers
200	A successful response.	-
400	Bad request. The request body included invalid request parameters.	-
4XX	An unexpected error response.	-
5XX	An unexpected error response.	-

fetchVectorsWithHttpInfo

public ApiResponse<FetchResponse> fetchVectorsWithHttpInfo(java.util.List<java.lang.String> ids,
                                                           java.lang.String namespace)
                                                    throws ApiException

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

Parameters:

ids - The vector IDs to fetch. Does not accept values containing spaces. (required)

namespace - (optional)

Returns:

ApiResponse<FetchResponse>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Status Code	Description	Response Headers
200	A successful response.	-
400	Bad request. The request body included invalid request parameters.	-
4XX	An unexpected error response.	-
5XX	An unexpected error response.	-

fetchVectorsAsync

public okhttp3.Call fetchVectorsAsync(java.util.List<java.lang.String> ids,
                                      java.lang.String namespace,
                                      ApiCallback<FetchResponse> _callback)
                               throws ApiException

Fetch vectors (asynchronously) 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).

Parameters:

ids - The vector IDs to fetch. Does not accept values containing spaces. (required)

namespace - (optional)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details

Status Code	Description	Response Headers
200	A successful response.	-
400	Bad request. The request body included invalid request parameters.	-
4XX	An unexpected error response.	-
5XX	An unexpected error response.	-

listVectorsCall

public okhttp3.Call listVectorsCall(java.lang.String prefix,
                                    java.lang.Long limit,
                                    java.lang.String paginationToken,
                                    java.lang.String namespace,
                                    ApiCallback _callback)
                             throws ApiException

Build call for listVectors

Parameters:

prefix - The vector IDs to fetch. Does not accept values containing spaces. (optional)

limit - Max number of IDs to return per page. (optional)

paginationToken - Pagination token to continue a previous listing operation. (optional)

namespace - (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details

Status Code	Description	Response Headers
200	A successful response.	-
400	Bad request. The request body included invalid request parameters.	-
4XX	An unexpected error response.	-
5XX	An unexpected error response.	-

listVectors

public ListResponse listVectors(java.lang.String prefix,
                                java.lang.Long limit,
                                java.lang.String paginationToken,
                                java.lang.String namespace)
                         throws ApiException

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_vectors` is supported only for serverless indexes.

Parameters:

prefix - The vector IDs to fetch. Does not accept values containing spaces. (optional)

limit - Max number of IDs to return per page. (optional)

paginationToken - Pagination token to continue a previous listing operation. (optional)

namespace - (optional)

Returns:

ListResponse

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Status Code	Description	Response Headers
200	A successful response.	-
400	Bad request. The request body included invalid request parameters.	-
4XX	An unexpected error response.	-
5XX	An unexpected error response.	-

listVectorsWithHttpInfo

public ApiResponse<ListResponse> listVectorsWithHttpInfo(java.lang.String prefix,
                                                         java.lang.Long limit,
                                                         java.lang.String paginationToken,
                                                         java.lang.String namespace)
                                                  throws ApiException

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_vectors` is supported only for serverless indexes.

Parameters:

prefix - The vector IDs to fetch. Does not accept values containing spaces. (optional)

limit - Max number of IDs to return per page. (optional)

paginationToken - Pagination token to continue a previous listing operation. (optional)

namespace - (optional)

Returns:

ApiResponse<ListResponse>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Status Code	Description	Response Headers
200	A successful response.	-
400	Bad request. The request body included invalid request parameters.	-
4XX	An unexpected error response.	-
5XX	An unexpected error response.	-

listVectorsAsync

public okhttp3.Call listVectorsAsync(java.lang.String prefix,
                                     java.lang.Long limit,
                                     java.lang.String paginationToken,
                                     java.lang.String namespace,
                                     ApiCallback<ListResponse> _callback)
                              throws ApiException

List vector IDs (asynchronously) 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_vectors` is supported only for serverless indexes.

Parameters:

prefix - The vector IDs to fetch. Does not accept values containing spaces. (optional)

limit - Max number of IDs to return per page. (optional)

paginationToken - Pagination token to continue a previous listing operation. (optional)

namespace - (optional)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details

Status Code	Description	Response Headers
200	A successful response.	-
400	Bad request. The request body included invalid request parameters.	-
4XX	An unexpected error response.	-
5XX	An unexpected error response.	-

queryVectorsCall

public okhttp3.Call queryVectorsCall(QueryRequest queryRequest,
                                     ApiCallback _callback)
                              throws ApiException

Build call for queryVectors

Parameters:

queryRequest - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details

Status Code	Description	Response Headers
200	A successful response.	-
400	Bad request. The request body included invalid request parameters.	-
4XX	An unexpected error response.	-
5XX	An unexpected error response.	-

queryVectors

public QueryResponse queryVectors(QueryRequest queryRequest)
                           throws ApiException

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

Parameters:

queryRequest - (required)

Returns:

QueryResponse

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Status Code	Description	Response Headers
200	A successful response.	-
400	Bad request. The request body included invalid request parameters.	-
4XX	An unexpected error response.	-
5XX	An unexpected error response.	-

queryVectorsWithHttpInfo

public ApiResponse<QueryResponse> queryVectorsWithHttpInfo(QueryRequest queryRequest)
                                                    throws ApiException

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

Parameters:

queryRequest - (required)

Returns:

ApiResponse<QueryResponse>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Status Code	Description	Response Headers
200	A successful response.	-
400	Bad request. The request body included invalid request parameters.	-
4XX	An unexpected error response.	-
5XX	An unexpected error response.	-

queryVectorsAsync

public okhttp3.Call queryVectorsAsync(QueryRequest queryRequest,
                                      ApiCallback<QueryResponse> _callback)
                               throws ApiException

Query vectors (asynchronously) 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).

Parameters:

queryRequest - (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details

Status Code	Description	Response Headers
200	A successful response.	-
400	Bad request. The request body included invalid request parameters.	-
4XX	An unexpected error response.	-
5XX	An unexpected error response.	-

updateVectorCall

public okhttp3.Call updateVectorCall(UpdateRequest updateRequest,
                                     ApiCallback _callback)
                              throws ApiException

Build call for updateVector

Parameters:

updateRequest - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details

Status Code	Description	Response Headers
200	A successful response.	-
400	Bad request. The request body included invalid request parameters.	-
4XX	An unexpected error response.	-
5XX	An unexpected error response.	-

updateVector

public java.lang.Object updateVector(UpdateRequest updateRequest)
                              throws ApiException

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

Parameters:

updateRequest - (required)

Returns:

Object

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Status Code	Description	Response Headers
200	A successful response.	-
400	Bad request. The request body included invalid request parameters.	-
4XX	An unexpected error response.	-
5XX	An unexpected error response.	-

updateVectorWithHttpInfo

public ApiResponse<java.lang.Object> updateVectorWithHttpInfo(UpdateRequest updateRequest)
                                                       throws ApiException

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

Parameters:

updateRequest - (required)

Returns:

ApiResponse<Object>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Status Code	Description	Response Headers
200	A successful response.	-
400	Bad request. The request body included invalid request parameters.	-
4XX	An unexpected error response.	-
5XX	An unexpected error response.	-

updateVectorAsync

public okhttp3.Call updateVectorAsync(UpdateRequest updateRequest,
                                      ApiCallback<java.lang.Object> _callback)
                               throws ApiException

Update a vector (asynchronously) 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).

Parameters:

updateRequest - (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details

Status Code	Description	Response Headers
200	A successful response.	-
400	Bad request. The request body included invalid request parameters.	-
4XX	An unexpected error response.	-
5XX	An unexpected error response.	-

upsertVectorsCall

public okhttp3.Call upsertVectorsCall(UpsertRequest upsertRequest,
                                      ApiCallback _callback)
                               throws ApiException

Build call for upsertVectors

Parameters:

upsertRequest - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details

Status Code	Description	Response Headers
200	A successful response.	-
400	Bad request. The request body included invalid request parameters.	-
4XX	An unexpected error response.	-
5XX	An unexpected error response.	-

upsertVectors

public UpsertResponse upsertVectors(UpsertRequest upsertRequest)
                             throws ApiException

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

Parameters:

upsertRequest - (required)

Returns:

UpsertResponse

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Status Code	Description	Response Headers
200	A successful response.	-
400	Bad request. The request body included invalid request parameters.	-
4XX	An unexpected error response.	-
5XX	An unexpected error response.	-

upsertVectorsWithHttpInfo

public ApiResponse<UpsertResponse> upsertVectorsWithHttpInfo(UpsertRequest upsertRequest)
                                                      throws ApiException

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

Parameters:

upsertRequest - (required)

Returns:

ApiResponse<UpsertResponse>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Status Code	Description	Response Headers
200	A successful response.	-
400	Bad request. The request body included invalid request parameters.	-
4XX	An unexpected error response.	-
5XX	An unexpected error response.	-

upsertVectorsAsync

public okhttp3.Call upsertVectorsAsync(UpsertRequest upsertRequest,
                                       ApiCallback<UpsertResponse> _callback)
                                throws ApiException

Upsert vectors (asynchronously) 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).

Parameters:

upsertRequest - (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details

Status Code	Description	Response Headers
200	A successful response.	-
400	Bad request. The request body included invalid request parameters.	-
4XX	An unexpected error response.	-
5XX	An unexpected error response.	-