better understandability of azure keys setup for catalog generation in readme

Author: tolgaerdonmez

.env.example

@@ -14,11 +14,13 @@ EVALUATION_RUN_ASYNC=True
 EVALUATION_SHOW_INDICATOR=True
 EVALUATION_PARALLEL_TEST_CASES=1
 
-AZURE_OPENAI_API_VERSION=
-AZURE_OPENAI_ENDPOINT=
-AZURE_OPENAI_API_KEY=
-AZURE_OPENAI_DEPLOYMENT=
-AZURE_OPENAI_EMBEDDING_DEPLOYMENT=
+# required for catalog generation
+AZURE_OPENAI_ENDPOINT=CHANGEME
+AZURE_OPENAI_API_KEY=CHANGE
+AZURE_OPENAI_API_VERSION=2024-02-01
+AZURE_OPENAI_EMBEDDING_DEPLOYMENT=text-embedding-3-large
+
+# only for cli relevant
 AZURE_OPENAI_CHAT_DEPLOYMENT=
 
 # change if you are using external services

README.md

@@ -79,7 +79,7 @@ To run LLM-Eval locally (for evaluation and usage, not development), use our pre
    **Required:**
 
    - Generate the encryption keys set to `CHANGEME` with the respective commands commented next to them in `.env`
-   - Don't forget to set azure openai keys and the `AZURE_OPENAI_EMBEDDING_DEPLOYMENT=`
+   - Don't forget to set azure openai keys and the `AZURE_OPENAI_EMBEDDING_DEPLOYMENT=`, without these the catalog generation will fail.
 
 3. **Enable host networking in docker desktop (for macos users):**