OpenWebUI/docs
1
0
Fork 0
mirror of https://github.com/open-webui/docs synced 2025-05-19 18:58:41 +00:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Merge pull request #509 from athoik/main

Browse Source 
docs(env): add Pinecone vector DB configuration documentation
This commit is contained in:
Tim Jaeryang Baek 2025-04-20 14:42:49 -07:00 committed by GitHub
commit 359f99f1b6
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 43 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

44
docs/getting-started/env-configuration.md
View File

@ -926,7 +926,7 @@ modeling files for reranking.
- Type: `str`
- Options:
- `chroma`, `elasticsearch`, `milvus`, `opensearch`, `pgvector`, `qdrant`
- `chroma`, `elasticsearch`, `milvus`, `opensearch`, `pgvector`, `qdrant`, `pinecone`
- Default: `chroma`
- Description: Specifies which vector database system to use. This setting determines which vector storage system will be used for managing embeddings.
@ -1106,6 +1106,48 @@ modeling files for reranking.
- Type: `str`
- Description: Sets the URI for Qdrant.
### Pinecone
When using Pinecone as the vector store, the following environment variables are used to control its behavior. Make sure to set these variables in your `.env` file or deployment environment.
#### `PINECONE_API_KEY`
- Type: `str`
- Default: `None`
- Description: Sets the API key used to authenticate with the Pinecone service.
#### `PINECONE_ENVIRONMENT`
- Type: `str`
- Default: `None`
- Description: Specifies the Pinecone environment to connect to (e.g., `us-west1-gcp`, `gcp-starter`, etc.).
#### `PINECONE_INDEX_NAME`
- Type: `str`
- Default: `open-webui-index`
- Description: Defines the name of the Pinecone index that will be used to store and query vector embeddings.
#### `PINECONE_DIMENSION`
- Type: `int`
- Default: `1536`
- Description: The dimensionality of the vector embeddings. Must match the dimension expected by the index (commonly 768, 1024, 1536, or 3072 based on model used).
#### `PINECONE_METRIC`
- Type: `str`
- Default: `cosine`
- Options: `cosine`, `dotproduct`, `euclidean`
- Description: Specifies the similarity metric to use for vector comparisons within the Pinecone index.
#### `PINECONE_CLOUD`
- Type: `str`
- Default: `aws`
- Options: `aws`, `gcp`, `azure`
- Description: Specifies the cloud provider where the Pinecone index is hosted.
## RAG Content Extraction Engine
#### `CONTENT_EXTRACTION_ENGINE`