OperationsCompatibleWithOpenAiApisApi

All URIs are relative to http://localhost

Method	HTTP request	Description
embedTexts	POST /openai/v1/embeddings	Embed Texts
generateChatCompletions	POST /openai/v1/chat/completions	Generate Chat Completions
generateTextCompletions	POST /openai/v1/completions	Generate Text Completions
getModel	GET /openai/v1/models/{model_name}	Get Model
listModels	GET /openai/v1/models	List Models

embedTexts

Object embedTexts(openAIEmbeddingsRequest, trackingId)

Embed Texts

Create embeddings based on text(s), similar to OpenAI's /v1/embeddings endpoint

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.OperationsCompatibleWithOpenAiApisApi;

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");

    OperationsCompatibleWithOpenAiApisApi apiInstance = new OperationsCompatibleWithOpenAiApisApi(defaultClient);
    OpenAIEmbeddingsRequest openAIEmbeddingsRequest = new OpenAIEmbeddingsRequest(); // OpenAIEmbeddingsRequest | 
    String trackingId = "trackingId_example"; // String | The tracking ID of the requested task
    try {
      Object result = apiInstance.embedTexts(openAIEmbeddingsRequest, trackingId);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling OperationsCompatibleWithOpenAiApisApi#embedTexts");
      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	-

generateChatCompletions

Object generateChatCompletions(openAIChatCompletionsRequest, ensureFullSentences, chatTemplate, trackingId)

Generate Chat Completions

Generate chat response based on messages, similar to OpenAI's /v1/chat/completions

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.OperationsCompatibleWithOpenAiApisApi;

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");

    OperationsCompatibleWithOpenAiApisApi apiInstance = new OperationsCompatibleWithOpenAiApisApi(defaultClient);
    OpenAIChatCompletionsRequest openAIChatCompletionsRequest = new OpenAIChatCompletionsRequest(); // OpenAIChatCompletionsRequest | 
    Boolean ensureFullSentences = false; // Boolean | Whether to generate full sentences only
    String chatTemplate = "chatTemplate_example"; // String | Override chat template for prompt formatting
    String trackingId = "trackingId_example"; // String | The tracking ID of the requested task
    try {
      Object result = apiInstance.generateChatCompletions(openAIChatCompletionsRequest, ensureFullSentences, chatTemplate, trackingId);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling OperationsCompatibleWithOpenAiApisApi#generateChatCompletions");
      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
openAIChatCompletionsRequest	OpenAIChatCompletionsRequest
ensureFullSentences	Boolean	Whether to generate full sentences only	[optional] [default to false]
chatTemplate	String	Override chat template for prompt formatting	[optional]
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	-

generateTextCompletions

Object generateTextCompletions(openAICompletionsRequest, ensureFullSentences, chatTemplate, trackingId)

Generate Text Completions

Generate completion based on prompt, similar to OpenAI's /v1/completions

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.OperationsCompatibleWithOpenAiApisApi;

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");

    OperationsCompatibleWithOpenAiApisApi apiInstance = new OperationsCompatibleWithOpenAiApisApi(defaultClient);
    OpenAICompletionsRequest openAICompletionsRequest = new OpenAICompletionsRequest(); // OpenAICompletionsRequest | 
    Boolean ensureFullSentences = false; // Boolean | Whether to generate full sentences only
    String chatTemplate = "chatTemplate_example"; // String | Override chat template for prompt formatting
    String trackingId = "trackingId_example"; // String | The tracking ID of the requested task
    try {
      Object result = apiInstance.generateTextCompletions(openAICompletionsRequest, ensureFullSentences, chatTemplate, trackingId);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling OperationsCompatibleWithOpenAiApisApi#generateTextCompletions");
      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
openAICompletionsRequest	OpenAICompletionsRequest
ensureFullSentences	Boolean	Whether to generate full sentences only	[optional] [default to false]
chatTemplate	String	Override chat template for prompt formatting	[optional]
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	-

getModel

Object getModel(modelName)

Get Model

Get a specific model, similar to OpenAI's /v1/models/{model_id} endpoint

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.OperationsCompatibleWithOpenAiApisApi;

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");

    OperationsCompatibleWithOpenAiApisApi apiInstance = new OperationsCompatibleWithOpenAiApisApi(defaultClient);
    String modelName = "modelName_example"; // String | 
    try {
      Object result = apiInstance.getModel(modelName);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling OperationsCompatibleWithOpenAiApisApi#getModel");
      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
modelName	String

Return type

Object

Authorization

OAuth2PasswordBearer, APIKeyCookie

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

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

listModels

Object listModels()

List Models

List available models, similar to OpenAI's /v1/models endpoint

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.OperationsCompatibleWithOpenAiApisApi;

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");

    OperationsCompatibleWithOpenAiApisApi apiInstance = new OperationsCompatibleWithOpenAiApisApi(defaultClient);
    try {
      Object result = apiInstance.listModels();
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling OperationsCompatibleWithOpenAiApisApi#listModels");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

This endpoint does not need any parameter.

Return type

Object

Authorization

OAuth2PasswordBearer, APIKeyCookie

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-

Navigation Menu

Uh oh!

OperationsCompatibleWithOpenAiApisApi

embedTexts

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

generateChatCompletions

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

generateTextCompletions

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getModel

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

listModels

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

Uh oh!

FilesExpand file tree

OperationsCompatibleWithOpenAiApisApi.md

Latest commit

History

OperationsCompatibleWithOpenAiApisApi.md

File metadata and controls

OperationsCompatibleWithOpenAiApisApi

embedTexts

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

generateChatCompletions

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

generateTextCompletions

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getModel

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

listModels

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details