Cohere Toolkit Documentation

Cohere Toolkit is an all-in-one RAG (Retrieval-Augmented Generation) application consisting of several layers:

• Interfaces: Client-side UIs. The default is a Next.js web app located at src/interfaces/assistants_web which includes a SQL database for conversation history. Other interfaces include a Slack bot implementation.
• Backend API: Located in src/backend, this follows a structure similar to the Cohere Chat API but allows for customization of:
  • Model: Choose between providers like Cohere's Platform, Sagemaker, Azure, Bedrock, HuggingFace, or local models.
  • Retrieval: Customize tools and data sources.
• Deployment: Supports production deployment on AWS, GCP, and Azure.

Use the following commands to manage database migrations and resets:

• Apply migrations: make migrate
• Reset and re-migrate: make reset-db followed by make migrate

make migrate
# Or to reset:
make reset-db
make migrate

To deploy the toolkit, configure the substitutions section in the cloudbuild.yaml file located in the project root and use the gcloud CLI.

1. Configure cloudbuild.yaml substitutions

Fill in the following variables:

• _GCP_PROJECT_ID: Your GCP project ID.
• _GCP_REGION: The target region (e.g., us-central1).
• _DATABASE_URL: A connection string in the format postgresql://USERNAME:PASSWORD@HOST:PORT/DB_NAME.
  • Example: postgresql://myuser:mypassword@<your-db-public-ip-address>:5432/toolkit.
• _COHERE_API_KEY: Your Cohere API key from the Cohere Dashboard.

2. Execute Deployment

Run the following commands in your terminal:

# Authenticate with GCP
gcloud auth login

# Submit the build to Cloud Build
gcloud builds submit --region=<YOUR_GCP_REGION>

To use the Cohere Toolkit, you must provide a valid API key. In a GitHub Codespace environment, edit the .env file in the root directory and add the following line:

COHERE_API_KEY=your_api_key_here

To make the Gmail tool available in the frontend, modify src/interfaces/assistants_web/src/constants/tools.ts:

1. Add to available tools: Add TOOL_GMAIL_ID to the AGENT_SETTINGS_TOOLS array.
2. Enable for Base Agent: By default, the Gmail tool is excluded from the Base Agent. To enable it, remove TOOL_GMAIL_ID from the BASE_AGENT_EXCLUDED_TOOLS list (ensure the list is empty or does not contain the ID).

export const AGENT_SETTINGS_TOOLS = [
  TOOL_HYBRID_WEB_SEARCH_ID,
  TOOL_PYTHON_INTERPRETER_ID,
  TOOL_WEB_SCRAPE_ID,
  TOOL_GMAIL_ID,
];

export const BASE_AGENT_EXCLUDED_TOOLS = [];

By default, the toolkit operates without community tools or deployments. To enable them, set feature_flags.use_community_features to true in your configuration.yaml file, or run the make setup command.

feature_flags.use_community_features: true

Model providers allow the toolkit to connect to various model services, including Cohere's platform, Azure, AWS (Bedrock/Sagemaker), Hugging Face, or local models. To add a custom provider:

1. Add a new file at src/backend/model_deployments/{custom_provider}.
2. Implement the required invoke functions, such as invoke_chat_stream.
3. Add your model configuration to src/backend/config/deployments.py.

Generate an API key to authenticate your requests:

1. Open the Google Cloud Console.
2. Navigate to APIs & Services > Credentials.
3. Click Create Credentials and select API key.
4. Copy the generated key for configuration.

You can customize the visual appearance of the toolkit by either modifying the existing theme or adding a new one.

Modify Existing Theme

Update the color scheme values in src/interfaces/coral_web/src/themes/cohereTheme.js.

Add a New Theme

1. Create a new theme file in the src/interfaces/coral_web/src/themes directory.
2. Register the new theme in src/interfaces/coral_web/tailwind.config.js by adding it to the presets array.

Apply Changes

After modifying theme files, you must rebuild the frontend to apply the updates.

// Example: Updating colors in src/interfaces/coral_web/src/themes/cohereTheme.js
primary: {
  ... 
  600: '#E25D41',
  500: '#AE4359', 
  400: '#FF967E',
  ... 
}

// Example: Registering a new theme in src/interfaces/coral_web/tailwind.config.js
module.exports = {
  presets: [require('./src/themes/yourTheme')],
  ... 
}

To remove all resources deployed by the toolkit on AWS, run the cleanup script from the repository root:

./aws_copilot_deploy/aws_cleanup.sh

To deploy the toolkit using the provided AWS Copilot deployment script:

1. Navigate to the root directory of the cloned repository.
2. Execute the deployment script:

   ./aws_copilot_deploy/aws_deploy.sh

3. Wait for the process to finish. The script will print the application's URL upon successful deployment.