From e81dde4b9c4730aadb68f4313e3da298ae4a86d1 Mon Sep 17 00:00:00 2001
From: timothycarambat <rambat1010@gmail.com>
Date: Fri, 9 Jun 2023 11:33:13 -0700
Subject: [PATCH] add Pinecone Readme

---
 .../pinecone/PINECONE_SETUP.md                | 21 +++++++++++++++++++
 1 file changed, 21 insertions(+)
 create mode 100644 server/utils/vectorDbProviders/pinecone/PINECONE_SETUP.md

diff --git a/server/utils/vectorDbProviders/pinecone/PINECONE_SETUP.md b/server/utils/vectorDbProviders/pinecone/PINECONE_SETUP.md
new file mode 100644
index 000000000..38b641017
--- /dev/null
+++ b/server/utils/vectorDbProviders/pinecone/PINECONE_SETUP.md
@@ -0,0 +1,21 @@
+# How to setup Pinecone Vector Database for AnythingLLM
+
+[Official Pinecone Docs](https://docs.pinecone.io/docs/overview) for reference.
+
+### How to get started
+
+**Requirements**
+- Pinecone account (free or paid)
+
+**Instructions**
+- Create an index on your Pinecone account. Name can be anything eg: `my-primary-index`
+- Metric `cosine`
+- Dimensions `1536` since we use OpenAI for embeddings
+- 1 pod, all other default settings are fine.
+
+```
+VECTOR_DB="pinecone"
+PINECONE_ENVIRONMENT=us-west4-gcp-free
+PINECONE_API_KEY=sklive-123xyz
+PINECONE_INDEX=my-primary-index # the value from the first instruction!
+```