mirror of
https://github.com/microsoft/semantic-kernel.git
synced 2026-10-12 11:19:56 +00:00
Evan Mattson
1a84cb64b2
### Motivation and Context To bring the SK Python framework closer to .Net parity, we need to support the ability to specify a prompt template config and kernel arguments for ChatCompletion Agents as well as for Assistant Agents. <!-- Thank you for your contribution to the semantic-kernel repo! Please help reviewers and future users, providing the following information: 1. Why is this change required? 2. What problem does it solve? 3. What scenario does it contribute to? 4. If it fixes an open issue, please link to the issue here. --> ### Description This PR adds support for: - being able to specify a prompt template config for SK agents. - allows kernel arguments to be passed to the agent as well as during invoke - invoke args, similar to other kwargs, take precedence over agent level config. - adds test coverage - creates agent templating samples for both ChatCompletionAgents and OpenAI/AzureAssistantAgents - closes #8022 - closes #8699 <!-- Describe your changes, the overall approach, the underlying design. These notes will help understanding how your code works. Thanks! --> ### Contribution Checklist <!-- Before submitting this PR, please make sure: --> - [X] The code builds clean without any errors or warnings - [X] The PR follows the [SK Contribution Guidelines](https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md) and the [pre-submission formatting script](https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md#development-scripts) raises no violations - [X] All unit tests pass, and I have added new tests where possible - [X] I didn't break anyone 😄
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