From dfdec0618513094fcf82ff78518e69ee52a8b9c2 Mon Sep 17 00:00:00 2001 From: Pankaj Singh <98807258+pankajastro@users.noreply.github.com> Date: Wed, 25 Oct 2023 04:45:42 +0530 Subject: [PATCH] Fix static check (#53) check the broken static checks in main branch --- airflow/README.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/airflow/README.md b/airflow/README.md index a96f839e..3cfddcbb 100644 --- a/airflow/README.md +++ b/airflow/README.md @@ -61,20 +61,20 @@ cd ask-astro ``` 3. Create a file called `airflow/.env` with the following connection strings and environment variables. -- `ASK_ASTRO_ENV`: This is an environment variable that allows us to switch easily between local development and hosted test/prod instances. +- `ASK_ASTRO_ENV`: This is an environment variable that allows us to switch easily between local development and hosted test/prod instances. Example: ``` ASK_ASTRO_ENV='local' ``` -- `AIRFLOW_CONN_GITHUB_RO`: Add a github [personal access token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens). The token needs NO PRIVILEGES for the example DAGs since it is reading from public repos. If adding another private repo use a token with read privileges for that repo. +- `AIRFLOW_CONN_GITHUB_RO`: Add a github [personal access token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens). The token needs NO PRIVILEGES for the example DAGs since it is reading from public repos. If adding another private repo use a token with read privileges for that repo. Example: ``` AIRFLOW_CONN_GITHUB_RO='{"conn_type": "github", "password": "ghp_xxxxxxxxxxxxxx"}' ``` -- `AIRFLOW_CONN_WEAVIATE_LOCAL`: Add OpenAI keys to be used during embedding ingest and for data query. - -- `X-Azure-Api-Key`: Specify for OpenAI endpoints with Microsoft Azure. - -- `X-OpenAI-Api-Key`: Specify for public OpenAI endpoints. -Example: +- `AIRFLOW_CONN_WEAVIATE_LOCAL`: Add OpenAI keys to be used during embedding ingest and for data query. + -- `X-Azure-Api-Key`: Specify for OpenAI endpoints with Microsoft Azure. + -- `X-OpenAI-Api-Key`: Specify for public OpenAI endpoints. +Example: ``` AIRFLOW_CONN_WEAVIATE_LOCAL='{"conn_type": "weaviate", "host": "http://weaviate:8081", "extra": {"X-OpenAI-Api-Key": "sk-xxxxxxx"}}' ``` @@ -189,12 +189,12 @@ astro deployment variable update -n 'ask astro dev' ASK_ASTRO_ENV=dev astro deploy -fn 'ask astro dev' ``` -13. Query the Data: A simple Streamlit application is provided to query the data. For this application you will have needed to provide an OpenAI key with the Weaviate connection string in step 3. +13. Query the Data: A simple Streamlit application is provided to query the data. For this application you will have needed to provide an OpenAI key with the Weaviate connection string in step 3. - Connect to the webserver container with the Astro CLI ```bash astro dev bash -w -``` +``` - Start Streamlit ```bash