Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rmncldyo/claude-ai-toolkit
A versatile CLI and Python wrapper for Anthropic's latest Claude 3.5 'Sonnet' model, along with the Claude 3 'Opus', 'Sonnet' and 'Haiku' language models. Streamline the creation of chatbots, generate dynamic text, and analyze images with ease.
https://github.com/rmncldyo/claude-ai-toolkit
anthropic anthropic-ai anthropic-claude anthropicai anthropicclaude chatbot claude claude-2 claude-3 claude-3-5 claude-3-5-sonnet claude-3-haiku claude-3-opus claude-3-sonnet claude-ai claude-api claude-haiku claude-opus claude-sonnet claude3
Last synced: 7 days ago
JSON representation
A versatile CLI and Python wrapper for Anthropic's latest Claude 3.5 'Sonnet' model, along with the Claude 3 'Opus', 'Sonnet' and 'Haiku' language models. Streamline the creation of chatbots, generate dynamic text, and analyze images with ease.
- Host: GitHub
- URL: https://github.com/rmncldyo/claude-ai-toolkit
- Owner: RMNCLDYO
- License: mit
- Created: 2024-03-04T22:15:51.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-07-26T02:02:59.000Z (6 months ago)
- Last Synced: 2024-07-26T03:26:35.103Z (6 months ago)
- Topics: anthropic, anthropic-ai, anthropic-claude, anthropicai, anthropicclaude, chatbot, claude, claude-2, claude-3, claude-3-5, claude-3-5-sonnet, claude-3-haiku, claude-3-opus, claude-3-sonnet, claude-ai, claude-api, claude-haiku, claude-opus, claude-sonnet, claude3
- Language: Python
- Homepage:
- Size: 206 KB
- Stars: 26
- Watchers: 2
- Forks: 5
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
> [!NOTE]
> *This toolkit supports Anthropic's newest Claude Sonnet 3.5 model (as of October 22, 2024)*
## Overview
The Claude AI Toolkit makes it easy to use Anthropic's latest Claude 3.5 'Sonnet' model, along with the Claude 3 'Opus', 'Sonnet' and 'Haiku' language models for creating chatbots, generating text, and analyzing images. It's designed for everyone, from beginners to experienced developers, allowing quick addition of AI features to projects with simple commands. While it offers simplicity and lightweight integration, it doesn't compromise on power; experienced developers can access the full suite of advanced options available via the API, ensuring robust customization and control. This toolkit is perfect for those looking to efficiently tap into advanced AI without getting bogged down in technical details, yet it still provides the depth needed for complex project requirements.
## Key Features
- **Conversational AI**: Create interactive, real-time chat experiences (chatbots) or AI assistants.
- **Image Captioning**: Generate detailed descriptions and insights or create captions from images.
- **Text Generation**: Produce coherent and contextually relevant text and answers from simple prompts.
- **Highly Customizable**: Tailor settings like streaming output, system prompts, sampling temperature and more to suit your specific requirements.
- **Lightweight Integration**: Efficiently designed with minimal dependencies, requiring only the `requests` package for core functionality.
## Prerequisites
- `Python 3.x`
- An API key from Anthropic
## Dependencies
The following Python packages are required:
- `requests`: For making HTTP requests to the Claude API.
The following Python packages are optional:
- `python-dotenv`: For managing API keys and other environment variables.
## Installation
To use the Claude AI Toolkit, clone the repository to your local machine and install the required Python packages.
Clone the repository:
```bash
git clone https://github.com/RMNCLDYO/claude-ai-toolkit.git
```
Navigate to the repositories folder:
```bash
cd claude-ai-toolkit
```
Install the required dependencies:
```bash
pip install -r requirements.txt
```
## Configuration
1. Obtain an API key from [Anthropic](https://console.anthropic.com/).
2. You have three options for managing your API key:
Click here to view the API key configuration options
- **Setting it as an environment variable on your device (recommended for everyday use)**
- Navigate to your terminal.
- Add your API key like so:
```bash
export CLAUDE_API_KEY=your_api_key
```
This method allows the API key to be loaded automatically when using the wrapper or CLI.
- **Using an .env file (recommended for development):**
- Install python-dotenv if you haven't already: `pip install python-dotenv`.
- Create a .env file in the project's root directory.
- Add your API key to the .env file like so:
```makefile
CLAUDE_API_KEY=your_api_key
```
This method allows the API key to be loaded automatically when using the wrapper or CLI, assuming you have python-dotenv installed and set up correctly.
- **Direct Input:**
- If you prefer not to use a `.env` file, you can directly pass your API key as an argument to the CLI or the wrapper functions.
***CLI***
```bash
--api_key "your_api_key"
```
***Wrapper***
```bash
api_key="your_api_key"
```
This method requires manually inputting your API key each time you initiate an API call, ensuring flexibility for different deployment environments.
## Usage
The Claude AI Toolkit can be used in three different modes: `Chat`, `Text`, and `Vision`. Each mode is designed for specific types of interactions with the suite of models.
## Chat Mode
Chat mode is intended for chatting with an AI model (similar to a chatbot) or building conversational applications.
#### Example Usage
***CLI***
```bash
python cli.py --chat
```
***Wrapper***
```python
from claude import Chat
Chat().run()
```
> An executable version of this example can be found [here](./examples/example_chat.py). (*You must move this file to the root folder before running the program.*)
## Text Mode
Text mode is suitable for generating text content based on a provided prompt.
#### Example Usage
***CLI***
```bash
python cli.py --text --prompt "Write a haiku about robots."
```
***Wrapper***
```python
from claude import Text
Text().run(prompt="Write a haiku about robots.")
```
> An executable version of this example can be found [here](./examples/example_text.py). (*You must move this file to the root folder before running the program.*)
## Vision Mode
Vision mode allows for generating text based on a combination of text prompts and images.
#### Example Usage
***CLI***
```bash
python cli.py --vision --prompt "Describe this image." --image "https://upload.wikimedia.org/wikipedia/commons/a/a7/Camponotus_flavomarginatus_ant.jpg"
```
***Wrapper***
```python
from claude import Vision
Vision().run(prompt="Describe this image.", image="https://upload.wikimedia.org/wikipedia/commons/a/a7/Camponotus_flavomarginatus_ant.jpg")
```
> An executable version of this example can be found [here](./examples/example_vision.py). (*You must move this file to the root folder before running the program.*)
## Advanced Configuration
### CLI and Wrapper Options
| **Description** | **CLI Flags** | **CLI Usage** | **Wrapper Usage** |
|-------------------------------|---------------------------|-------------------------------------------------------------|----------------------------------------------------------|
| Enable chat mode | `-c`, `--chat` | --chat | *See mode usage above.* |
| Enable text mode | `-t`, `--text` | --text | *See mode usage above.* |
| Enable vision mode | `-v`, `--vision` | --vision | *See mode usage above.* |
| User prompt | `-p`, `--prompt` | --prompt "Write a haiku about robots." | prompt="Write a haiku about robots." |
| Image file path or url | `-i`, `--image` | --prompt "Describe this image." --image "image_path_or_url" | prompt="Describe this image.", image="image_path_or_url" |
| API key for authentication | `-a`, `--api_key` | --api_key "your_api_key" | api_key="your_api_key" |
| Model name | `-m`, `--model` | --model "claude-3-5-sonnet-20241022" | model="claude-3-5-sonnet-20241022" |
| Enable streaming mode | `-s`, `--stream` | --stream | stream=True |
| System prompt (instructions) | `-sp, '--system_prompt` | --system_prompt "You are an advanced AI assistant." | system_prompt="You are an advanced AI assistant." |
| Maximum tokens to generate | `-mt`, `--max_tokens` | --max_tokens 1024 | max_tokens=1024 |
| Sampling temperature | `-tm`, `--temperature` | --temperature 0.7 | temperature=0.7 |
| Nucleus sampling threshold | `-tp`, `--top_p` | --top_p 0.9 | top_p=0.9 |
| Top-k sampling threshold | `-tk`, `--top_k` | --top_k 40 | top_k=40 |
| Stop sequences for completion | `-ss`, `--stop_sequences` | --stop_sequences ["\n", "."] | stop_sequences=["\n", "."] |
> *To exit the program at any time, you can type **`exit`** or **`quit`**. This command works similarly whether you're interacting with the program via the CLI or through the Python wrapper ensuring that you can easily and safely conclude your work with the Claude AI Toolkit without having to resort to interrupt signals or forcibly closing the terminal or command prompt.*
## Available Models
| **Model** | **Max Tokens** |
|------------------------------|----------------|
| `claude-3-5-sonnet-20241022` | 4096 |
| `claude-3-opus-20240229` | 4096 |
| `claude-3-haiku-20240307` | 4096 |
## Vision Mode Requirements & Suggestions:
#### Supported ***MIME*** *(image)* types: `JPEG`, `PNG`, `GIF`, and `WEBP`.
For optimal performance, Anthropic recommends resizing your images before uploading if it is likely to exceed size or token limits. If your image's long edge is more than 1568 pixels, or your image is more than ~1600 tokens, it will first be scaled down, preserving aspect ratio, until it is within size limits. If your input image is too large and needs to be resized, it will increase latency of time-to-first-token, without giving you any additional model performance. Very small images under 200 pixels on any given edge may lead to degraded performance.
## Contributing
Contributions are welcome!
Please refer to [CONTRIBUTING.md](.github/CONTRIBUTING.md) for detailed guidelines on how to contribute to this project.
## Reporting Issues
Encountered a bug? We'd love to hear about it. Please follow these steps to report any issues:
1. Check if the issue has already been reported.
2. Use the [Bug Report](.github/ISSUE_TEMPLATE/bug_report.md) template to create a detailed report.
3. Submit the report [here](https://github.com/RMNCLDYO/claude-ai-toolkit/issues).
Your report will help us make the project better for everyone.
## Feature Requests
Got an idea for a new feature? Feel free to suggest it. Here's how:
1. Check if the feature has already been suggested or implemented.
2. Use the [Feature Request](.github/ISSUE_TEMPLATE/feature_request.md) template to create a detailed request.
3. Submit the request [here](https://github.com/RMNCLDYO/claude-ai-toolkit/issues).
Your suggestions for improvements are always welcome.
## Versioning and Changelog
Stay up-to-date with the latest changes and improvements in each version:
- [CHANGELOG.md](.github/CHANGELOG.md) provides detailed descriptions of each release.
## Security
Your security is important to us. If you discover a security vulnerability, please follow our responsible disclosure guidelines found in [SECURITY.md](.github/SECURITY.md). Please refrain from disclosing any vulnerabilities publicly until said vulnerability has been reported and addressed.
## License
Licensed under the MIT License. See [LICENSE](LICENSE) for details.