org.openapitools.inference.client.api

Class InferenceApi

java.lang.Object

org.openapitools.inference.client.api.InferenceApi

public class InferenceApi
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
InferenceApi()
InferenceApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
EmbeddingsList	embed(EmbedRequest embedRequest) Embed data Generate embeddings for input data.
okhttp3.Call	embedAsync(EmbedRequest embedRequest, ApiCallback<EmbeddingsList> _callback) Embed data (asynchronously) Generate embeddings for input data.
okhttp3.Call	embedCall(EmbedRequest embedRequest, ApiCallback _callback) Build call for embed
ApiResponse<EmbeddingsList>	embedWithHttpInfo(EmbedRequest embedRequest) Embed data Generate embeddings for input data.
ApiClient	getApiClient()
java.lang.String	getCustomBaseUrl()
int	getHostIndex()
RerankResult	rerank(RerankRequest rerankRequest) Rerank documents Rerank documents according to their relevance to a query.
okhttp3.Call	rerankAsync(RerankRequest rerankRequest, ApiCallback<RerankResult> _callback) Rerank documents (asynchronously) Rerank documents according to their relevance to a query.
okhttp3.Call	rerankCall(RerankRequest rerankRequest, ApiCallback _callback) Build call for rerank
ApiResponse<RerankResult>	rerankWithHttpInfo(RerankRequest rerankRequest) Rerank documents Rerank documents according to their relevance to a query.
void	setApiClient(ApiClient apiClient)
void	setCustomBaseUrl(java.lang.String customBaseUrl)
void	setHostIndex(int hostIndex)

Methods inherited from class java.lang.Object

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

Constructor Detail

InferenceApi

public InferenceApi()

InferenceApi

public InferenceApi(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)

embedCall

public okhttp3.Call embedCall(EmbedRequest embedRequest,
                              ApiCallback _callback)
                       throws ApiException

Build call for embed

Parameters:

embedRequest - Generate embeddings for inputs. (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	OK	-
400	Bad request. The request body included invalid request parameters.	-
401	Unauthorized. Possible causes: Invalid API key.	-
500	Internal server error.	-

embed

public EmbeddingsList embed(EmbedRequest embedRequest)
                     throws ApiException

Embed data Generate embeddings for input data. For guidance and examples, see [Generate embeddings](https://docs.pinecone.io/guides/inference/generate-embeddings).

Parameters:

embedRequest - Generate embeddings for inputs. (optional)

Returns:

EmbeddingsList

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	OK	-
400	Bad request. The request body included invalid request parameters.	-
401	Unauthorized. Possible causes: Invalid API key.	-
500	Internal server error.	-

embedWithHttpInfo

public ApiResponse<EmbeddingsList> embedWithHttpInfo(EmbedRequest embedRequest)
                                              throws ApiException

Embed data Generate embeddings for input data. For guidance and examples, see [Generate embeddings](https://docs.pinecone.io/guides/inference/generate-embeddings).

Parameters:

embedRequest - Generate embeddings for inputs. (optional)

Returns:

ApiResponse<EmbeddingsList>

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	OK	-
400	Bad request. The request body included invalid request parameters.	-
401	Unauthorized. Possible causes: Invalid API key.	-
500	Internal server error.	-

embedAsync

public okhttp3.Call embedAsync(EmbedRequest embedRequest,
                               ApiCallback<EmbeddingsList> _callback)
                        throws ApiException

Embed data (asynchronously) Generate embeddings for input data. For guidance and examples, see [Generate embeddings](https://docs.pinecone.io/guides/inference/generate-embeddings).

Parameters:

embedRequest - Generate embeddings for inputs. (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	OK	-
400	Bad request. The request body included invalid request parameters.	-
401	Unauthorized. Possible causes: Invalid API key.	-
500	Internal server error.	-

rerankCall

public okhttp3.Call rerankCall(RerankRequest rerankRequest,
                               ApiCallback _callback)
                        throws ApiException

Build call for rerank

Parameters:

rerankRequest - Rerank documents for the given query (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	OK	-
400	Bad request. The request body included invalid request parameters.	-
401	Unauthorized. Possible causes: Invalid API key.	-
500	Internal server error.	-

rerank

public RerankResult rerank(RerankRequest rerankRequest)
                    throws ApiException

Rerank documents Rerank documents according to their relevance to a query. For guidance and examples, see [Rerank documents](https://docs.pinecone.io/guides/inference/rerank).

Parameters:

rerankRequest - Rerank documents for the given query (optional)

Returns:

RerankResult

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	OK	-
400	Bad request. The request body included invalid request parameters.	-
401	Unauthorized. Possible causes: Invalid API key.	-
500	Internal server error.	-

rerankWithHttpInfo

public ApiResponse<RerankResult> rerankWithHttpInfo(RerankRequest rerankRequest)
                                             throws ApiException

Rerank documents Rerank documents according to their relevance to a query. For guidance and examples, see [Rerank documents](https://docs.pinecone.io/guides/inference/rerank).

Parameters:

rerankRequest - Rerank documents for the given query (optional)

Returns:

ApiResponse<RerankResult>

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	OK	-
400	Bad request. The request body included invalid request parameters.	-
401	Unauthorized. Possible causes: Invalid API key.	-
500	Internal server error.	-

rerankAsync

public okhttp3.Call rerankAsync(RerankRequest rerankRequest,
                                ApiCallback<RerankResult> _callback)
                         throws ApiException

Rerank documents (asynchronously) Rerank documents according to their relevance to a query. For guidance and examples, see [Rerank documents](https://docs.pinecone.io/guides/inference/rerank).

Parameters:

rerankRequest - Rerank documents for the given query (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	OK	-
400	Bad request. The request body included invalid request parameters.	-
401	Unauthorized. Possible causes: Invalid API key.	-
500	Internal server error.	-