Julia Ostheimer commited on
Commit
2f15fb0
·
1 Parent(s): 0db0599

Add info for how to setup specifics with Langfuse

Browse files
Files changed (1) hide show
  1. README.md +17 -0
README.md CHANGED
@@ -49,6 +49,23 @@ Alternatively, with a different dependency manager such as `venv` install direct
49
  **Note**: the dependencies then need to be documented manually in the `pyproject.toml`.
50
 
51
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
52
 
53
  ## To-Do
54
  - create bsaic set-up with Qdrant in memory, ingestion pipeline
 
49
  **Note**: the dependencies then need to be documented manually in the `pyproject.toml`.
50
 
51
 
52
+ ### Set up `.env` file for secrets
53
+ Locally set up a `.env` file for secrets. You require connection to an LLM, an embedding provider, and API keys for the Langfuse integration. The latter you can acquire after setting up a Langfuse project in the Langfuse GUI, either through a local setup or via Langfuse Cloud.
54
+
55
+ Here is how the `.env` file should look like:
56
+ ```
57
+ # .env
58
+ LLM_API_KEY= # Your LLM API key
59
+
60
+ # Langfuse credentials
61
+ LANGFUSE_PUBLIC_API_KEY= # Your Langfuse public API key
62
+ LANGFUSE_SECRET_API_KEY= # Your Langfuse secret API key
63
+ LANGFUSE_HOST="https://cloud.langfuse.com" # EU server for langfuse Cloud, can be different for other deployments
64
+ ```
65
+ **Note**: the `.env` file is not version-controlled.
66
+
67
+ ### Setup for Langfuse Prompt Management
68
+ Langfuse Prompt Management is used within this project. Therefore, setting up the prompt templates within Langfuse is mandatory. As the prompts directly integrate with the code, alignment is necessary. Current setup requirements can be provided by the maintainers.
69
 
70
  ## To-Do
71
  - create bsaic set-up with Qdrant in memory, ingestion pipeline