How to Configure the OpenAI API Key

Follow

To configure the OpenAI API key, you can either add it as a Role level or User level attribute. It is recommended to add it at the Role level, so all users with the "Copilot Assistant (licensed)" role will automatically inherit the key. However, if needed, you can also configure it for individual users.

Follow these steps to set up the API key:

1. Access User Access Management

• Go to your User Access Management interface.

2. Add the Attribute for the Role (Recommended)

• Navigate to the Roles section.
• Select the "Copilot Assistant (licensed)" role.
• In the Attributes section, add a new attribute with the name openAiApiKey.
• Set the value to your OpenAI API key.
• Save the configuration.
  
  

By configuring the API key at the role level, all users with the "Copilot Assistant (licensed)" role will automatically inherit the API key, making management easier.

3. Add the Attribute for an Individual User (Alternative)

If you prefer to configure the API key for a specific user:

• Navigate to the User section and select the user.
• Under the Attributes section, add a new attribute with the name openAiApiKey.
• Set the value to your OpenAI API key.
• Save the configuration.
  
  

4. Ensure the User Has the Correct Role

• Verify that the user is assigned the "Copilot Assistant (licensed)" role. If not, assign the role to the user for them to inherit the API key.

5. Test the API Key

To confirm that the API key is set correctly, test the functionality by using the Chat with Your Data feature. If the API key is configured properly, users should be able to use the OpenAI-powered functionality without issues.

6. Verify the API Key Configuration

• If the key is configured at the Role level, all users assigned the "Copilot Assistant (licensed)" role will automatically leverage the same key. If configured at the User level, only the specified user will use the key.

Make sure that the OpenAI API key is kept secure and not shared unnecessarily.