OpenAI Connection
This topic describes how to authenticate to OpenAI and configure any necessary connection properties in the OpenAI connection connector.
Connection Configuration
Each connection property available in the OpenAI connection configuration is explained below.
Connection Name
The name of the connection to be created should be provided. This is the name that will display on the list of available connections.
Type
The specific environment or service through which you are accessing OpenAI’s capabilities.
Select ‘API key’ for direct access to OpenAI’s API.
Steps to get the API Key...
Create an OpenAI Account: If you don’t already have one, sign up for an OpenAI account on the OpenAI website.
Log In: Log in to your OpenAI account.
Access API Section: Once logged in, navigate to the API section of your OpenAI account dashboard. This is where you’ll manage your API keys.
Create a New API Key: In the API section, you should find an option to create a new API key. Follow the prompts to generate a new key. You might need to specify the project or application you intend to use it for.
Retrieve the Key: After creating the API key, it should be displayed on the screen. Be sure to copy and securely store the key, as it’s sensitive information and will not be displayed again.
Select ‘Azure API key’ if you’re accessing OpenAI through Microsoft Azure.
Steps to get the Azure API Key...
Set Up Microsoft Azure Account: If you haven’t already, create and set up a Microsoft Azure account.
Access Azure Portal: Log in to the Azure portal using your Azure account credentials.
Create or Configure Resources: Within the Azure portal, you may need to create or configure Azure resources and services depending on your specific use case and the integration method you’re using with OpenAI.
Generate Azure API Key: For the integration with OpenAI, you might need to generate an Azure API key. This process can vary based on the specific Azure service you’re using.
Generate the API keys or access tokens associated with the service you’re using in Azure by following the Azure documentation instructions.
API Key
The secret key for accessing the end point.
Organization
The organization for which the connection should work.
Add Configuration: Additional properties can be added using this option as key-value pairs.
After entering all the details, click on the TEST button.
If the connection service identification and authentication details are provided correctly, a success message stating “connection available” is generated.
Click on the CREATE button to save the changes.
If the details are incorrect or the server is down, you will get a message “Connection unavailable”.
If you have any feedback on Gathr documentation, please email us!