Account Configuration
The Account is your central hub for managing and updating all aspects of a client account. It uses a reactive form interface that guides you through entering and validating key information.
You can navigate to the Account page by using the dropdown menu in the top right corner.
Main Sections of the Settings Page:
-
General Information:
- Read-Only ID:
The client’s unique identifier is displayed but cannot be changed. - Name and Logo:
Enter or update the client’s name and logo URL. - Description:
Provide a detailed description of the client. You also have the option to auto-generate this text by clicking the “Propose description” button. - Cookies to Collect:
A chip list lets you add keywords that indicate which cookies are collected. Click the “X” on a chip to remove it or type a new keyword and press Enter to add it. These cookies are used in chatbots.
- Read-Only ID:
-
Live Status and Domain:
- Live Toggle:
Use the slide toggle to mark whether the client is active in production. - Domain Field:
Input the client’s domain URL. The form validates that the URL is correct.
- Live Toggle:
-
AI API Settings:
- Toggle for Azure OpenAI:
Switch between Azure OpenAI and the standard OpenAI service. - Conditional Fields:
- When Azure is selected, you must enter an Azure API key (with a minimum length requirement) and a valid API endpoint.
- When using OpenAI, the OpenAI API key and project ID are required instead.
- Model Selection:
Choose an AI model from a list that dynamically shows available options based on your API provider selection.
- Toggle for Azure OpenAI:
-
Action Buttons:
- Save:
Click the Save button to commit your changes. The form won’t let you save if required fields are missing or contain errors. - Publish:
Use the Publish button (which opens a menu) to choose the target environment (local, beta, or live). Publishing deploys the client settings so that they become active.
- Save:
How to Use the Client Settings Page:
-
Fill in the Form:
- Update any fields as necessary. Required fields (like Name, Description, Domain, and API keys) are validated in real time.
- The chip list allows you to manage cookies by simply typing a keyword and adding or removing chips.
-
Auto-Generate a Description:
- If you’re not sure what to write for the description, click “Propose description.” This triggers an automated process to generate content, which is then populated into the description field.
-
Switching API Providers:
- Toggle the “Use Azure instead of OpenAI” option to reveal or hide the relevant API fields.
- The form automatically updates validators so that you only need to fill out the fields required for the selected service.
-
Save and Publish:
- After making changes, click Save to store your updates.
- When you’re ready to deploy the changes, select an environment from the Publish menu. Notifications will inform you whether your changes were saved or published successfully.
By following these steps, you can ensure that your client account is properly configured, up to date, and ready to serve your users across various environments.