Settings

The settings page in ZBrain offers a centralized hub for configuring and managing essential aspects of your account. It enables seamless control over user permissions, model settings, connections, billing details, and personal information. It provides a comprehensive and easy-to-navigate interface, ensuring that managing your ZBrain environment is streamlined and efficient.

To access the settings, click on the gear icon ⚙️ at the right end of the page and select Settings.

1. Users

This section outlines how system administrators can effectively define and manage users, their roles, and access levels within the system.

Overview of the Users page

The Users page offers a comprehensive summary of user management, including:

• Registered and invited users: View all users currently registered in the system and those who have been invited.

• Roles and status: Identify each user's assigned role and their current status (e.g., active, pending).

Key functionalities

The Users page enables administrators to:

• Invite or remove users: Add new users to the system or remove existing ones as needed.

• View and update roles: Adjust user roles to ensure they have the appropriate access levels required for their responsibilities.

• Customize settings: Tailor user permissions to control access to knowledge bases, apps, flows, and agents, ensuring alignment with specific organizational requirements.

This centralized page simplifies user management while ensuring optimal control over access and roles.

Adding a new user

Follow these steps to add a new user to your ZBrain apps/agents:

1. Navigate to the Users page.

2. Locate the Add New User panel on the right side of the screen and click the ‘+Add’ button. This will open a form to enter the new user’s details.

Fill in user details

In the User Details tab of the form, provide the following information:

• First name: Enter the first name of the user.

• Last name: Enter the last name of the user.

• Access email: Provide the email address where the user will receive their access credentials.

• Role: From the dropdown menu, select the appropriate role for the user. The roles are:

  • Admin

  • Builder

  • Operator

• Choose the appropriate role for the user and click ‘Invite’.

Roles and permissions

Admin

Definition: Admins are users with the highest level of control, having unrestricted access across the system, including user management and permission assignments.

Access capabilities:

• Full access to create, update, view, and delete any components, including knowledge bases, apps, agents, and flows.

• Configure and modify system-wide settings and functionalities.

• Assign or revoke roles and permissions for other users, including Builder and Operator roles.

• Monitor system usage, access logs, and manage user accounts.

• No restrictions on visibility or interaction with any part of the system.

Builder

Definition: Builders are users with comprehensive creation and modification privileges, enabling them to design and manage system elements.

Access capabilities:

• Create and update knowledge bases, apps, agents, flows, and other system components.

• Modify settings for the elements they create or manage.

• Execute and use features they configure or are granted access to.

• Possess broad access to configure and maintain the system’s functionalities.

Operator

Definition: Operators are users with view-only and usage privileges, allowing them to interact with the system’s resources without making changes to configurations or content.

Access capabilities:

• View datasets, knowledge bases, and system configurations.

• Use existing apps, upload files for events, and interact with flows without the ability to modify or update them.

• Restricted from adding or updating content (e.g., “Add” or “Update” buttons are disabled).

• Limited to viewing and interacting only with the entries they have explicit access to.

Note: There is no limit to the number of users you can add.

Defining access

• Click on the user to open the Provide Access panel.

• In the search bar, look for the agent, app, flow, or knowledge base you want to grant access to.

• Select the desired resource from the search results.

• After selection, click ‘Done’ to confirm and apply access.

Managing access

• To modify an existing user’s access, click the pencil icon next to their name.

• Make the necessary changes such as:

  • First Name, Last Name, or Access Email

  • Role (Admin, Builder, Operator)

  • Status (Active, Inactive)

• Once all changes are made, click ‘Update’ to save them.

2. Models

To add a new model, follow these steps to configure it correctly for your agents/applications. You can add either Text-Embedding Models or LLM (Large Language Models) based on your use case.

Step 1: Add a model

1. Click on the ‘+ Add model’ button.

2. A pop-up form will open to input the model details.

Step 2: Enter model details

• Model name: Provide a unique name for the model.

• Model type: Select the model type from the following options:

  • Text-Embedding

  • LLM

Text-Embedding and LLM configuration guide

Follow the steps carefully to ensure smooth integration and setup.

Text-Embedding model configuration

Text-Embedding models are used for semantic search, similarity measurement, and document clustering. The configuration process depends on the chosen provider.

Option 1: OpenAI Text-Embedding model

1. Enter API key and Base URL:

   • API Key: Obtain it from your OpenAI account.

   • Base URL: https://api.openai.com/v1/

2. Make it default model (Optional):

   • Toggle to set this as your default model.

3. Click ‘Add’.

Steps to retrieve OpenAI credentials:

• Sign up or log in to OpenAI’s platform.

• Navigate to API keys by clicking your profile icon in the top-right corner.

• Click ‘Create New Secret Key’ to generate an API key.

• Copy and store the key securely.

Option 2: Azure OpenAI Text-Embedding model

1. Enter API key, Base URL, and API version:

   • API key: Obtain it from your Azure portal.

   • Base URL: Format: https://<your-resource-name>.openai.azure.com/

   • API version: Use the latest version.

2. Make it default model (Optional):

   • Toggle to set this as your default model.

3. Click ‘Add.’

Steps to retrieve Azure OpenAI credentials:

• Create a resource in the Azure Portal.

• Navigate to keys and endpoint on your Azure OpenAI resource page.

• Copy and securely store the API key and Base URL.

LLM configuration

LLMs are used for tasks like text generation, translation, summarization, and question answering. The configuration for LLMs varies based on the chosen provider.

Option 1: OpenAI LLM

1. Select OpenAI as the provider.

2. Enter API key:

   • Sign up or log in to OpenAI’s platform.

   • Navigate to API Keys and create a new secret key.

   • Copy and store the API key securely.

3. Base URL:

   • Use the base URL: https://api.openai.com/v1/

4. Make it default model (Optional):

   • Toggle to make OpenAI the default LLM model.

5. Click ‘Add.'

Option 2: Azure OpenAI LLM

1. Select Azure OpenAI as the provider.

2. Enter API key:

   • Sign in to the Azure Portal.

   • Go to Keys and Endpoint on your Azure OpenAI resource page.

   • Copy and securely store the API key.

3. Base URL:

   • Use the format: https://<your-resource-name>.openai.azure.com/

4. API version:

   • Specify the API version found on your Azure OpenAI resource page.

5. Make it default model (Optional):

   • Toggle to make Azure OpenAI the default model.

6. Click ‘Add.’

Option 3: Google Generative AI

Enter API key

• API key: Obtain it from your Google Generative AI account.

• Make it default model (Optional): Toggle this option to set Gemini as your default model.

• Click ‘Add’ to complete the process.

Steps to get an API key from Gemini

1. Sign in to your Google account: Ensure you're logged into the Google account associated with your Google Cloud project.

2. Access Google AI Studio: Navigate to Google AI Studio and go to the Gemini API section.

3. Create an API key:

   • Click on ‘Get API Key’ in the Gemini API section.

   • Select the appropriate model (e.g., Gemini Pro).

   • Choose an existing Google Cloud project or create a new one if necessary.

4. Generate and secure your API key:

   • Click ‘Create API Key’ to generate your key.

   • Copy the API key and store it securely. (Note: For security reasons, you won’t be able to view the key again after closing the window.)

Option 4: Groq

1. Enter API key:

   • Retrieve it from your Groq Cloud account.

2. Make it default model (Optional):

   • Toggle to make it the default.

3. Click ‘Add.'

Steps to retrieve Groq credentials:

• Sign up or log in to Groq Cloud.

• Navigate to API Keys in your account settings.

• Click ‘Create API Key’, name it, and securely store the key.

Option 5: Bedrock Claude

1. Enter access key, secret key, session token, and region:

   • Access key and secret key: Obtain from AWS.

   • Session token: Generated via AWS CLI or SDKs.

   • Region: Specify your AWS region.

2. Make it default model (Optional):

   • Toggle to make it the default.

3. Click ‘Add.’

Steps to retrieve Bedrock Claude credentials:

• Sign in to the AWS Management Console.

• Go to IAM and create/select a user.

• Generate access keys and session token via AWS CLI or SDKs.

• Retrieve the region configuration with aws configure get region.

Option 6: Custom

Use this option to connect your own custom model by providing the necessary API details. Follow the steps below to set it up:

1. Enter API key:

   • Input the API key required to authenticate requests to your custom model.

   • Ensure the key has appropriate permissions to access and invoke the model endpoints.

2. Enter base URL:

   • Provide the full base URL where your model’s API is hosted (e.g., https://api.yourmodel.com/v1).

   • Make sure the URL is accessible and corresponds to the correct version and endpoint of the model.

3. Make it default model (Optional):

   • If you want this model to be used as the default for all relevant operations within the platform, toggle Make it default model to ON.

   • This is optional, if left off, the model will still be available, but won’t be selected by default.

3. Connections

The Connections Page provides an overview of all connections used within your Flows and Agents, offering valuable details to help administrators manage these connections effectively. The following information is displayed:

• App icon:A visual identifier that represents the app across the platform for quick recognition.

• Connection name: The specific name of the connection.

• Last updated: The date when the connection was last updated.

• Status: The current status of the connection (e.g., active, inactive).

Managing connections

Connections allow your system to integrate with external tools or components. You can manage these connections to keep them updated, renamed, or reconnected when needed.

To rename an existing connection:

• Locate the connection you want to rename from the list of existing connections.

• Click the pencil icon next to the connection name.

• Enter the new name for the connection in the provided field.

• Click 'Confirm' to save the updated name.

To reconnect an existing connection:

• If a connection has expired or needs to be refreshed, click the repeat (↻) icon beside the connection.

• Follow the prompts to re-authenticate or update the credentials as required by the connected tool or service.

• Once completed, click ‘Save’, the connection will be re-established and ready for use.

Adding new connections

Adding a new connection allows your system to communicate with third-party tools or internal services required for automation, data sharing, or feature expansion.

To add a new connection:

1. Click the ‘New Connection’ button to begin the setup process.

2. From the list, select the tool or component you wish to connect.(Example: Gmail, Amazon S3, Zoho Books etc.)

1. Provide the required credentials, such as API keys, authentication tokens, client IDs, or any additional configuration fields as prompted.

2. Ensure all required fields are filled correctly to avoid connection errors.

3. Click ‘Save’ to complete the integration.

Once saved, the new connection will be listed among your existing connections and can be managed or edited anytime.

4. My account

Manage your account information and settings by updating the following fields:

• Upload avatar: Upload an image to represent your account.

• Enter your name: Provide your full name.

• Enter your company name: Input the name of your company or organization.

• Enter your work email: Enter your official work email address associated with the account.

• Enter your API key: Input your unique API key for authentication.

Regenerate API key

If you need to generate a new API key, follow these steps:

1. Click on "Regenerate API Key": This option allows you to create a fresh key.

2. Confirmation pop-up: A pop-up will appear asking you to confirm the regeneration.

3. Click Confirm: To regenerate the API key, click ‘Confirm.'

This will create a new key, ensuring the security of your API access.