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.

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

.env.empty sample file - add documentation #3

Open
danielkon96 opened this issue Jul 12, 2023 · 2 comments
Open

.env.empty sample file - add documentation #3

danielkon96 opened this issue Jul 12, 2023 · 2 comments
Labels
documentation Improvements or additions to documentation

Comments

@danielkon96
Copy link
Contributor

danielkon96 commented Jul 12, 2023

Add additional documentation about the env.empty fields (or add comments about what each line refers to in the sample .env, adding comments will require testing to be sure nothing broke)

Update: Remove all OI and OP values as the toolkit only uses Azure Open AI

@danielkon96 danielkon96 added the documentation Improvements or additions to documentation label Jul 12, 2023
@Aionsphere Aionsphere moved this from 🆕 New to 📋 Backlog in React Component Toolkit Jul 14, 2023
@danielkon96
Copy link
Contributor Author

danielkon96 commented Jul 14, 2023

Documentation is being added to official azure docs. We can include it in the readme somewhere as well documenting all the env variables

@Aionsphere Aionsphere moved this from 📋 Backlog to 🔖 Ready in React Component Toolkit Jul 27, 2023
@Aionsphere Aionsphere moved this from 🔖 Ready to 📋 Backlog in React Component Toolkit Jul 27, 2023
@danielkon96
Copy link
Contributor Author

danielkon96 commented Jul 31, 2023

Update: Azure Docs will not have documentation for the env variables so we will need to do the following.

TODO:

  1. Change the env.empty file to contain the following fields:
APIM_OPENURL=
APIM_RESOURCEID=
AOI_ENDPOINT=
AOI_APIKEY=
AOI_DEPLOYMENT=
AOI_ENABLED=false
DEBUG_DIR=
  1. Add the following documentation to the README for additional context about the env.empty file:
  • The following values are in your environment file (if you don't plan to use Azure OpenAI, you may leave those values blank):
    • APIM_OPENURL - APIM developer portal URL for widget development and testing (e.g. https://contoso.developer.azure-api.net/)
    • APIM_RESOURCEID - Azure API Management resource ID (e.g. subscriptions//resourceGroups//providers/Microsoft.ApiManagement/service/).
    • AOI_ENDPOINT - Azure OpenAI Endpoint (e.g. https://contoso.openai.azure.com/).
    • AOI_APIKEY - Azure OpenAI API Key.
    • AOI_DEPLOYMENT - Azure OpenAI Model Deployment Name (e.g. contoso-deployment).
    • AOI_ENABLED - Set to true if you plan generate components using Azure OpenAI.
    • DEBUG_DIR - The path where the prompt and the response from Azure OpenAI will be stored. The path is OS specific (e.g. Windows: C:\Users\contoso\Desktop\Debug, Linux/Mac: home\user\contoso\debug).
  1. We may have to add one more field for tenant ID after the fix in APIM.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: 📋 Backlog
Development

No branches or pull requests

1 participant