OpenAI Compatible Client Connection

This topic describes how to authenticate to an OpenAI Compatible Client and configure any necessary connection properties in the OpenAI Compatible Client Connection connector.

Connection Configuration #

Each connection property available in the OpenAI Compatible Client 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.

Scope #

Define the connection scope to customize their accessibility.

• Organization: Accessible to organization users across all Gathr projects for usage in applications.

• Project: Accessible to organization users limited to projects that are specified by the connection owner for usage in applications.

• Private: Accessible only to the connection owner for usage in applications.

Type #

The specific environment or service through which you are accessing OpenAI Compatible Client’s capabilities.

Select ‘API key’ for direct access to OpenAI Compatible Client’s API.

API Key #

The secret key for accessing the endpoint.

Base URL #

Base URL of the OpenAI Compatible Client.

Organization #

The organization for which the connection should work.

Model #

Enter the OpenAI Compatible Client model’s name that is to be used.

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”.