modified: README.rst

This commit is contained in:
Russell Ballestrini 2023-12-20 08:11:54 -05:00
parent 71f8d9d15c
commit c95f2722e9

View file

@ -36,6 +36,7 @@ Requirements
- boto3 (for interacting with AWS Bedrock currently Claude, and S3 access)
- openai (for interacting with OpenAI's language models)
- mistralai (for interacting with MistralAI's language models)
- together (for interacting with together.ai language models)
Installation
------------
@ -56,13 +57,14 @@ To set up the project, follow these steps:
pip install -r requirements.txt
4. Set up environment variables for your AWS, OpenAI, or Mistral API keys::
4. Set up environment variables for your AWS, OpenAI, MistralAI, or together.ai API keys::
export AWS_ACCESS_KEY_ID="your_access_key"
export AWS_SECRET_ACCESS_KEY="your_secret_key"
export S3_BUCKET_NAME="your_s3_bucket_name"
export OPENAI_API_KEY="your_openai_api_key"
export MISTRAL_API_KEY="your_mistralai_api_key"
export TOGETHER_API_KEY="your_togetherai_api_key"
5. Initialize the database:
@ -92,7 +94,10 @@ To interact with the various language models, you can use the following commands
- For GPT-4, send a message with ``gpt-4`` and include your prompt.
- For Claude-v1, send a message with ``claude-v1`` and include your prompt.
- For Claude-v2, send a message with ``claude-v2`` and include your prompt.
- For Mistral-tiny, send a message with ``mistral`` and include your prompt.
- For Mistral-tiny, send a message with ``mistral-tiny`` and include your prompt.
- For Together OpenChat, send a message with ``together/openchat`` and include your prompt.
- For Together Mistral, send a message with ``together/mistral`` and include your prompt.
- For Together Mixtral, send a message with ``together/mixtral`` and include your prompt.
- For Dall-e-3, send a message with ``dall-e-3`` and include your prompt.
The system will process your message and provide a response from the selected language model.