The readme is very much a work in progress
Explanation and background..
- Get an OpenAi Api key
- You will need to register for an OpenAI account and generate a key if you don’t already have one.
If running in Docker a .env
file can be created in the project root.
Here’s an overview of the variables and what they are for:
- COMPOSE_PROJECT_NAME: The name of the project when using Docker Compose. (optional)
- Example:
myproject
- Example:
- OpenAi:ApiKey: The API key for accessing OpenAI services. (required if using OpenAI)
- Example: sk-xxxxxxxxxxxxxxxxxxxxxx
- set this key locally either using
user-secrets
or in environment variables.
to set the user-secrets
key locally:
Open a terminal:
cd RecipeProcessing.Api
dotnet user-secrets init
dotnet user-secrets set "OpenAi:ApiKey" "<your-api-key>"
- Remove or make OpenAI integration optional.