Skip to content

EmbeddingsApi.md

Latest commit

 

History

History
85 lines (64 loc) · 2.89 KB

EmbeddingsApi.md

File metadata and controls

85 lines (64 loc) · 2.89 KB
Raw

EmbeddingsApi

All URIs are relative to http://localhost

Method HTTP request Description
getTextEmbeddings POST /embeddings Get Text Embeddings

getTextEmbeddings

Object getTextEmbeddings(openAIEmbeddingsRequest, trackingId)

Get Text Embeddings

Create embeddings based on text(s)

Example

// Import classes:
import org.cms.client.ApiClient;
import org.cms.client.ApiException;
import org.cms.client.Configuration;
import org.cms.client.auth.*;
import org.cms.client.models.*;
import org.cms.client.api.EmbeddingsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost");
    
    // Configure OAuth2 access token for authorization: OAuth2PasswordBearer
    OAuth OAuth2PasswordBearer = (OAuth) defaultClient.getAuthentication("OAuth2PasswordBearer");
    OAuth2PasswordBearer.setAccessToken("YOUR ACCESS TOKEN");

    // Configure API key authorization: APIKeyCookie
    ApiKeyAuth APIKeyCookie = (ApiKeyAuth) defaultClient.getAuthentication("APIKeyCookie");
    APIKeyCookie.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //APIKeyCookie.setApiKeyPrefix("Token");

    EmbeddingsApi apiInstance = new EmbeddingsApi(defaultClient);
    OpenAIEmbeddingsRequest openAIEmbeddingsRequest = new OpenAIEmbeddingsRequest(); // OpenAIEmbeddingsRequest | 
    String trackingId = "trackingId_example"; // String | The tracking ID of the requested task
    try {
      Object result = apiInstance.getTextEmbeddings(openAIEmbeddingsRequest, trackingId);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling EmbeddingsApi#getTextEmbeddings");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
openAIEmbeddingsRequest OpenAIEmbeddingsRequest
trackingId String The tracking ID of the requested task [optional]

Return type

Object

Authorization

OAuth2PasswordBearer, APIKeyCookie

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful Response -
422 Validation Error -