https://github.com/zoom/zoom-cohere-chatbot-sample
The Zoom-Cohere-Chatbot integrates Cohere's AI with Zoom Team Chat, creating an intelligent assistant for users within Zoom conversations. It leverages Cohere's language capabilities to provide context-aware responses to user queries on various topics, enhancing team communication and productivity.
https://github.com/zoom/zoom-cohere-chatbot-sample
Last synced: 7 months ago
JSON representation
The Zoom-Cohere-Chatbot integrates Cohere's AI with Zoom Team Chat, creating an intelligent assistant for users within Zoom conversations. It leverages Cohere's language capabilities to provide context-aware responses to user queries on various topics, enhancing team communication and productivity.
- Host: GitHub
- URL: https://github.com/zoom/zoom-cohere-chatbot-sample
- Owner: zoom
- Created: 2024-10-07T17:26:09.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-07T22:26:31.000Z (over 1 year ago)
- Last Synced: 2025-01-22T11:23:16.428Z (about 1 year ago)
- Language: JavaScript
- Homepage:
- Size: 433 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# Zoom-Cohere-Chatbot
This project integrates Cohere's AI with Zoom Team Chat, creating an intelligent chatbot that can assist users directly within their Zoom conversations. The bot leverages Cohere's advanced language understanding and generation capabilities to provide helpful responses to user queries on a wide range of topics.
## What the Chatbot Does
- Responds to user messages in Zoom Team Chat using Cohere's AI.
- Maintains conversation history for context-aware responses.
- Can be used in direct messages or invoked in group chats and channels.
- Provides helpful information, answers questions, assists with tasks, and engages in discussions on various topics.
## Prerequisites
Before you can use this chatbot, you'll need the following:
- Node.js (version 12 or later)
- A Zoom account
- A Cohere AI account
## Setup
First, clone the repository:
```bash
git clone https://github.com/zoom/zoom-chat-cohere.git
cd zoom-chat-cohere
```
Next, install the required Node.js packages:
```bash
npm install
```
## Configuration
You need to set up your environment variables. Create a `.env` file in the project root and add the following variables:
``` bash
ZOOM_CLIENT_ID=your_zoom_client_id
ZOOM_CLIENT_SECRET=your_zoom_client_secret
ZOOM_BOT_JID=your_zoom_bot_jid
ZOOM_WEBHOOK_SECRET_TOKEN=your_zoom_webhook_secret_token
COHERE_API_KEY=your_cohere_api_key
```
To obtain these variables:
- For Zoom variables (ZOOM_CLIENT_ID, ZOOM_CLIENT_SECRET, ZOOM_BOT_JID, ZOOM_WEBHOOK_SECRET_TOKEN, ZOOM_VERIFICATION_CODE), refer to the [Zoom App Marketplace guide on creating a Team Chat app](https://developers.zoom.us/docs/team-chat-apps/create/).
- For the COHERE_API_KEY, you can obtain it from your Cohere account dashboard.
## Running the Application
To start the application:
node index.js
The application will run on `http://localhost:4000/` by default, but you can set a different port by changing the `PORT` variable in your `.env` file.
## Usage
1. In your Zoom Team Chat App's Credentials section, go to the Local Test or Submit page depending on which environment you are using (Development or Production), and click "Add".
2. After authorizing, you will be redirected to Zoom Team Chat and see a message from the chatbot:
"Greetings from Zoom-Cohere-Chatbot!"
3. To use the bot, type a message in the chat like this:
"Tell me about the history of San Jose, California"
4. The response from the bot will look like this:
[AI-generated response about history of San Jose, California]
5. The bot remembers context from previous messages:
6. If you want to use the bot in a chat or a channel, you can invoke the bot with a "/" command:
Example:
`/cohere-bot Tell me about the history of San Francisco`
## Key Functions
Our codebase includes several important functions that drive the chatbot's functionality:
- `handleZoomWebhook` (src/zoomWebhookHandler.js): This function processes incoming webhook events from Zoom. It handles different event types, including bot notifications, installations, and uninstallations. For message events, it triggers the Cohere API call.
- `callCohereAPI` (src/cohere.js): This function is responsible for interacting with the Cohere API. It prepares the conversation history, sends the user's message to Cohere, and processes the AI-generated response. It also manages the conversation history for context-aware responses.
- `getChatbotToken` (src/zoomAuth.js): This function obtains an authentication token from Zoom, which is necessary for sending messages back to the Zoom chat. It uses the client credentials flow for secure authentication.
- `sendChatToZoom` (src/sendChatbotMessage.js): After receiving a response from Cohere, this function sends the AI-generated message back to the Zoom chat. It formats the message and uses the Zoom API to deliver the response to the correct chat or channel.
These functions work together to create a seamless flow from receiving a user message in Zoom, processing it with Cohere's AI, and sending the response back to the user in Zoom Team Chat.
## License
This project is licensed under the MIT License:
MIT License
Copyright (c)
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.