Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: adapt docs for optional OPENAI_API_KEY #319

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+9 −14
Open

docs: adapt docs for optional OPENAI_API_KEY #319

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions docs/vectorizer-quick-start-openai.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,14 +32,13 @@ On your local machine:
image: timescale/pgai-vectorizer-worker:v0.2.1
environment:
PGAI_VECTORIZER_WORKER_DB_URL: postgres://postgres:postgres@db:5432/postgres
OPENAI_API_KEY: <your-api-key>
volumes:
data:
```

1. **Tune the developer image for your AI provider**

Replace the instances of `OPENAI_API_KEY` with a key from your AI provider.
Replace `OPENAI_API_KEY` with a key from your AI provider.

1. **Start the database**
```shell
Expand Down
20 changes: 8 additions & 12 deletions docs/vectorizer-worker.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,11 +121,7 @@ On your local machine:
a vectorizer worker to generate and update your embeddings:

1. Configure environment variables if necessary (see [Additional configuration via environment variables](#additional-configuration-via-environment-variables))
for a list of the available environment variables:

```bash
export OPENAI_API_KEY="..."
```
for a list of the available environment variables.

1. Run the vectorizer worker:

Expand Down Expand Up @@ -248,13 +244,13 @@ multiple asynchronous tasks to process a queue:
Some important internals of the vectorizer worker are configured through
the following environment variables.

| Environment Variable | Default | Purpose |
|---------------------------------------------|------------------------|-------------------------------------------------------------------------------------------|
| PGAI_VECTORIZER_WORKER_DB_URL | - | Configures the database url that the vectorizer worker uses to procesa vectorizers. |
| OPENAI_API_KEY | - | The API key that the vectorizer worker uses to authenticate against the OpenAI API. |
| VOYAGE_API_KEY | - | The API key that the vectorizer worker uses to authenticate against the Voyage AI API. |
| OLLAMA_HOST | http://localhost:11434 | The host to use when communicating with the Ollama API. |
| PGAI_VECTORIZER_OLLAMA_MAX_CHUNKS_PER_BATCH | 2048 | Configures the number of chunks of data embedded in one Ollama API call, defaults to 2048 |
| Environment Variable | Default | Purpose |
|---------------------------------------------|------------------------|---------------------------------------------------------------------------------------------------------------------------------|
| PGAI_VECTORIZER_WORKER_DB_URL | - | Configures the database url that the vectorizer worker uses to procesa vectorizers. |
| OPENAI_API_KEY | - | The API key that the vectorizer worker uses to authenticate against the OpenAI API. Can also be provided on the db instance. |
| VOYAGE_API_KEY | - | The API key that the vectorizer worker uses to authenticate against the Voyage AI API. Can also be provided on the db instance. |
| OLLAMA_HOST | http://localhost:11434 | The host to use when communicating with the Ollama API. |
| PGAI_VECTORIZER_OLLAMA_MAX_CHUNKS_PER_BATCH | 2048 | Configures the number of chunks of data embedded in one Ollama API call, defaults to 2048 |


[python3]: https://www.python.org/downloads/
Expand Down
Loading