Skip to content

Commit d8344a0

Browse files
committed
docs: update readme
1 parent 1cc1547 commit d8344a0

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

README.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -124,30 +124,30 @@ These are just a few examples of the analytics and accounting courses offered at
124124
- [make](https://gnuwin32.sourceforge.net/packages/make.htm). _pre-installed on Linux and macOS._
125125
- [OpenAI platform API key](https://platform.openai.com/).
126126
_If you're new to OpenAI API then see [How to Get an OpenAI API Key](./doc/OPENAI_API_GETTING_STARTED_GUIDE.md)_
127-
- [Pinecone](https://www.pinecone.io/) API key.
128-
- [Python 3.12](https://www.python.org/downloads/): for creating virtual environment used for building AWS Lambda Layer, and locally by pre-commit linters and code formatters.
129-
- [NodeJS](https://nodejs.org/en/download): used with NPM for local ReactJS developer environment, and for configuring/testing Semantic Release.
127+
- [Pinecone](https://www.pinecone.io/) API key. A vector database for storing embedding results.
128+
- [Python 3.12](https://www.python.org/downloads/): for creating virtual environment. Also used by pre-commit linters and code formatters.
129+
- [NodeJS](https://nodejs.org/en/download): used with NPM for configuring/testing Semantic Release.
130130

131131
## Configuration defaults
132132

133133
Set these as environment variables on the command line, or in a .env file that should be located in the root of the repo.
134134

135135
```console
136136
# OpenAI API
137-
OPENAI_API_ORGANIZATION=PLEASE-ADD-ME
138-
OPENAI_API_KEY=PLEASE-ADD-ME
139-
OPENAI_CHAT_MAX_RETRIES=3
137+
OPENAI_API_ORGANIZATION=ADD-ME-PLEASE
138+
OPENAI_API_KEY=ADD-ME-PLEASE
140139
OPENAI_CHAT_MODEL_NAME=gpt-4
141-
OPENAI_CHAT_TEMPERATURE=0.0
142140
OPENAI_PROMPT_MODEL_NAME=gpt-4
141+
OPENAI_CHAT_TEMPERATURE=0.0
142+
OPENAI_CHAT_MAX_RETRIES=3
143143

144144
# Pinecone API
145-
PINECONE_API_KEY=PLEASE-ADD-ME
146-
PINECONE_DIMENSIONS=1536
145+
PINECONE_API_KEY=ADD-ME-PLEASE
147146
PINECONE_ENVIRONMENT=gcp-starter
148-
PINECONE_INDEX_NAME=rag
149-
PINECONE_METRIC=dotproduct
147+
PINECONE_INDEX_NAME=openai-embeddings
150148
PINECONE_VECTORSTORE_TEXT_KEY=lc_id
149+
PINECONE_METRIC=dotproduct
150+
PINECONE_DIMENSIONS=1536
151151

152152
# This package
153153
DEBUG_MODE=False

0 commit comments

Comments
 (0)