Skip to content

OpenAI

To start using an OpenAI model with Cognigy.AI features, follow these steps:

  1. Add a Model
  2. Apply the Model

Add a Model

You can add a model using one of the following interfaces:

Add a Model via GUI

You can add a model provided by OpenAI to Cognigy.AI in Build > LLM. To add the model, you will need the following parameters:

Parameter Description
apiKey Add an API Key from your OpenAI account. You can find this key in the User settings of your OpenAI account.
Parameter Description
Model Type Select Chat for the https://api.openai.com/v1/chat/completions API, Completion for the https://api.openai.com//v1/completions API, and Embedding for the https://api.openai.com//v1/embeddings API. For more information, refer to the OpenAI Text Generation Models documentation.
Model Name Enter the name of the model that you want to use as a custom model. To find model names, refer to the Azure OpenAI Service models documentation.
apiKey Add an API Key from your OpenAI account. You can find this key in the User settings of your OpenAI account.

Apply changes. Check if the connection was set up by clicking Test.

Add a Model via the API

You can add either a standard or custom model using the Cognigy.AI API POST /v2.0/largelanguagemodels request. Then, test your connection for the created model via the Cognigy.AI API POST /v2.0/largelanguagemodels/{largeLanguageModelId}/test.

Apply the Model

To apply a model, follow these steps:

  1. In the left-side menu of the Project, go to Manage > Settings.
  2. Go to the section based on your use case for using a model:
    • Generative AI Settings. In the Generative AI Settings section, activate Enable Generative AI Features. This setting is toggled on by default if you have previously set up the Generative AI credentials.
    • Knowledge AI Settings. Use this section if you need to add a model for Knowledge AI. Select a model for the Knowledge Search and Answer Extraction features. Refer to the list of standard models and find the models that support these features.
  3. Navigate to the desired feature and select a model from the list. If there are no models available for the selected feature, the system will automatically select None. Save changes.

More Information