Text Module AI API Configurations
The Text Module AI API Configurations page allows you to define and manage API endpoints that are used for AI text generation, template application, and translation. The page is accessed using Tell Me. Choose the 
icon, enter Text Module AI API Configurations, and then choose the related link. AI API configurations are used in the Text Module Setup page to define the API endpoints to be used for AI text generation, template application, and translation.
The fields on the Text Module AI API Configurations page are described in the following table.
| Field | Description |
|---|---|
| Code | Specifies the code of the AI API Configuration. This code is used to identify and select the AI API Configuration in the setup. |
| Description | Specifies the description of the AI API Configuration. |
| API Type | Specifies the API Type of the AI API Configuration. This can be either Azure OpenAI or OpenAI. |
| API Endpoint | Specifies the API Endpoint of the AI API Configuration. This can be either the URL of an Azure OpenAI endpoint (e.g., https://<YOUR RESOURCE NAME>.openai.azure.com/) or the URL of the OpenAI API (https://api.openai.com/v1/). |
| API Version | Specifies the API Version of the AI API Configuration. This must be the API Version of the Azure OpenAI resource (e.g., 2024-02-01). To ensure the best compatibility with the COSMO Text Module, we recommend using the default value which will be set automatically when selecting the API Type. A complete list of the available Azure OpenAI API versions can be found at Azure OpenAI Service REST API reference | Microsoft Learn. |
| API Key | Specifies the API Key of the AI API Configuration. This must be the API Key of the Azure OpenAI resource or the API Key of the OpenAI API. |
| Model Type | Specifies the Model Type of the AI API Configuration. Currently, only OpenAI Chat Completion is supported. |
| Model Name | When using an Azure OpenAI endpoint, specify the name of the large language model deployment as defined in the Azure OpenAI Studio of your Azure OpenAI resource. For the OpenAI API, specify the name of the large language model directly (e.g., gpt-3.5-turbo, gpt-4, gpt-4-32k). |
Feedback
Submit feedback for this page.