Skip to content

Commit

Permalink
Merge branch 'feature/django' of https://github.com/codebanesr/vsearch
Browse files Browse the repository at this point in the history
…into feature/django
  • Loading branch information
codebanesr committed Aug 10, 2023
2 parents ee33d0f + 10a4825 commit 3a297c6
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 9 deletions.
21 changes: 14 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,12 +77,19 @@ We love hearing from you! Got any cool ideas or requests? We're all ears! So, if
git clone git@github.com:openchatai/OpenChat.git
```

- Update common.env with your keys:
```
OPENAI_API_KEY=# you can get it from your account in openai.com
PINECONE_API_KEY=# you can get from "API Keys" tab in pinecone
PINECONE_ENVIRONMENT=# you can get it after creating your index in pinecone
VECTOR_STORE_INDEX_NAME=# you can get it after creating your index in pinecone
---
### Setting Up Your Environment

**Note**: Starting July, Qdrant is our Preferred Open-Source Vector Store 🚀 No initial Pinecone registration required. To begin, delve into the comprehensive guide: [**Using Qdrant**](#using-qdrant), provided in the following section.

#### Before you begin, make sure to update the `common.env` file with the necessary keys:

```sh
OPENAI_API_KEY=# Retrieve from your [openai.com](https://www.openai.com) account
PINECONE_API_KEY=# Obtain from the "API Keys" tab in [pinecone](https://www.pinecone.io)
PINECONE_ENVIRONMENT=# Obtain after creating your index in [pinecone](https://www.pinecone.io)
VECTOR_STORE_INDEX_NAME=# Obtain after creating your index in [pinecone](https://www.pinecone.io)
STORE=pinecone
```


Expand All @@ -96,7 +103,7 @@ VECTOR_STORE_INDEX_NAME=# you can get it after creating your index in pinecone

#### Using Qdrant
If you want to switch from Pinecone to Qdrant, you can set the following environment variables:

- `OPENAI_API_KEY`= Your open ai key
- `QDRANT_URL`: The URL of the Qdrant server.
- `STORE`: The store to use to store embeddings. Can be `qdrant` or `pinecone`.

Expand Down
5 changes: 3 additions & 2 deletions docker-compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ services:
ports:
- 6333:6333
volumes:
- /tmp/qdrant_storage:/qdrant/storage
- qdrant_storage:/qdrant/storage
networks:
- openchat_network

Expand All @@ -73,4 +73,5 @@ networks:

volumes:
shared_data:
database:
database:
qdrant_storage:

0 comments on commit 3a297c6

Please sign in to comment.