Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cohere-ai/cohere-toolkit
Cohere Toolkit is a collection of prebuilt components enabling users to quickly build and deploy RAG applications.
https://github.com/cohere-ai/cohere-toolkit
Last synced: 3 days ago
JSON representation
Cohere Toolkit is a collection of prebuilt components enabling users to quickly build and deploy RAG applications.
- Host: GitHub
- URL: https://github.com/cohere-ai/cohere-toolkit
- Owner: cohere-ai
- License: mit
- Created: 2024-04-19T09:59:08.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-10-29T14:55:10.000Z (about 1 month ago)
- Last Synced: 2024-10-29T15:09:29.638Z (about 1 month ago)
- Language: TypeScript
- Homepage:
- Size: 52.4 MB
- Stars: 2,811
- Watchers: 37
- Forks: 362
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
- awesome - cohere-ai/cohere-toolkit - Cohere Toolkit is a collection of prebuilt components enabling users to quickly build and deploy RAG applications. (TypeScript)
- StarryDivineSky - cohere-ai/cohere-toolkit
- AiTreasureBox - cohere-ai/cohere-toolkit - 11-30_2848_0](https://img.shields.io/github/stars/cohere-ai/cohere-toolkit.svg)|Toolkit is a collection of prebuilt components enabling users to quickly build and deploy RAG applications.| (Repos)
- jimsghstars - cohere-ai/cohere-toolkit - Cohere Toolkit is a collection of prebuilt components enabling users to quickly build and deploy RAG applications. (TypeScript)
README
# Cohere Toolkit
Toolkit is a deployable all-in-one RAG application that enables users to quickly build their LLM-based product.
- [Try Toolkit](#try-now)
- [About Toolkit](#about-toolkit)
- [Toolkit Setup](/docs/setup.md)
- [Troubleshooting](/docs/troubleshooting.md)
- [How to guides](/docs/how_to_guides.md)
- [How to set up command model providers](/docs/command_model_providers.md)
- [How to add tools](/docs/custom_tool_guides/tool_guide.md)
- [How to add auth to your tools](/docs/custom_tool_guides/tool_auth_guide.md)
- [How to setup Google Drive](/docs/custom_tool_guides/google_drive.md)
- [How to setup Gmail](/docs/custom_tool_guides/gmail.md)
- [How to setup Slack Tool](/docs/custom_tool_guides/slack.md)
- [How to setup Google Text-to-Speech](/docs/text_to_speech.md)
- [How to add authentication](/docs/auth_guide.md)
- [How to deploy toolkit services](/docs/service_deployments.md)
- [How to debug dockerized Toolkit API with VSCode/PyCharm](/docs/debugging.md)
- [How to set up Github Actions for automated DB migrations](/docs/github_migrations_action.md)
- [How to customize the theme](/docs/theming.md)
- [How to contribute](#contributing)
- [Try Cohere's Command Showcase](https://coral.cohere.com/)
## Try Now:
There are two main ways for quickly running Toolkit: local and cloud. See the specific instructions given below.
### Local
*You will need to have [Docker](https://www.docker.com/products/docker-desktop/) and [Docker-compose >= 2.22](https://docs.docker.com/compose/install/) installed. [Go here for a more detailed setup.](/docs/setup.md)*
Note: to include community tools when building locally, set the `INSTALL_COMMUNITY_DEPS` build arg in the `docker-compose.yml` to `true`.
Both options will make the frontend available at http://localhost:4000.
#### Using `make`
Use the provided Makefile to simplify and automate your development workflow with Cohere Toolkit, including Docker Compose management, testing, linting, and environment setup.
```bash
git clone https://github.com/cohere-ai/cohere-toolkit.git
cd cohere-toolkit
make first-run
```
#### Docker Compose only
Use Docker Compose directly if you want to quickly spin up and manage your container environment without the additional automation provided by the Makefile.
```bash
git clone https://github.com/cohere-ai/cohere-toolkit.git
cd cohere-toolkit
docker compose up
docker compose run --build backend alembic -c src/backend/alembic.ini upgrade head
```
### Cloud
#### GitHub Codespaces
To run this project using GitHub Codespaces, please refer to our [Codespaces Setup Guide](/docs/github_codespaces.md).
## About Toolkit
- **Interfaces** - any client-side UI, currently contains a web app and Slack bot.
- Defaults to Cohere's Web UI at `src/interfaces/coral_web` - A web app built in Next.js. Includes a simple SQL database out of the box to store conversation history in the app.
- You can turn on the Assistants view that uses `src/interfaces/assistants_web` instead.
- **Backend API** - in `src/backend` this follows a similar structure to the [Cohere Chat API](https://docs.cohere.com/reference/chat) but also include customizable elements:
- **Model** - you can customize with which provider you access Cohere's Command models. By default included in the toolkit is Cohere's Platform, Sagemaker, Azure, Bedrock, HuggingFace, local models. [More details here.](/docs/command_model_providers.md)
- **Retrieval**- you can customize tools and data sources that the application is run with.
- **Service Deployment Guides** - we also include guides for how to deploy the toolkit services in production including with AWS, GCP and Azure. [More details here.](/docs/service_deployments.md)
## Contributing
Contributions are what drive an open source community, any contributions made are greatly appreciated. To get started, check out our [documentation.](CONTRIBUTING.md)
## Contributors
Made with [contrib.rocks](https://contrib.rocks).