mirror of
https://github.com/microsoft/semantic-kernel.git
synced 2026-10-12 02:19:06 +00:00
Chris Vaisnor
ac1613aa1c
### Description When running the getting-started Python notebooks, the user is instructed to create and populate their own .env file. The values for the OpenAI specifications included an underscore between 'open' and 'ai'. This led to an error when initializing the chat/text/embedding model service. I have removed the underscore from the base .env files, README, and in the evaluate_with_prompt_flow.py script when reading from the .env file.
1.5 KiB
1.5 KiB
SK Python Documentation Examples
This project contains a collection of examples used in documentation on learn.microsoft.com.
Prerequisites
- Python 3.10 and above
- Install Semantic Kernel through PyPi:
pip install semantic-kernel
Configuring the sample
The samples can be configured with a .env file in the project which holds api keys and other secrets and configurations.
Make sure you have an Open AI API Key or Azure Open AI service key
Copy the .env.example file to a new file named .env. Then, copy those keys into the .env file:
GLOBAL_LLM_SERVICE="OpenAI" # Toggle between "OpenAI" or "AzureOpenAI"
OPENAI_CHAT_MODEL_ID="gpt-3.5-turbo-0125"
OPENAI_TEXT_MODEL_ID="gpt-3.5-turbo-instruct"
OPENAI_API_KEY=""
OPENAI_ORG_ID=""
AZURE_OPENAI_CHAT_DEPLOYMENT_NAME="gpt-35-turbo"
AZURE_OPENAI_TEXT_DEPLOYMENT_NAME="gpt-35-turbo-instruct"
AZURE_OPENAI_ENDPOINT=""
AZURE_OPENAI_API_KEY=""
AZURE_OPENAI_API_VERSION=""
Note: if running the examples with VSCode, it will look for your .env file at the main root of the repository.
Running the sample
To run the console application within Visual Studio Code, just hit F5.
Otherwise the sample can be run via the command line:
python.exe <absolute_path_to_sk_code>/python/samples/documentation_examples/planner.py