From 0b2bd01267fdca3fcfd9809b4ab81fd8a4cda473 Mon Sep 17 00:00:00 2001 From: Tao Chen Date: Tue, 4 Feb 2025 06:50:56 +0000 Subject: [PATCH] Python: Update document generator demo README (#10386) ### Motivation and Context `AICodeSandbox` has updated their package name. A user also reached out about whether it is possible to use models for the demo. ### Description 1. Update the Document Generator demo README to reflect this change. 2. Update the README to include a note about using other models. ### Contribution Checklist - [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 :smile: Co-authored-by: Evan Mattson <35585003+moonbox3@users.noreply.github.com> --- python/samples/demos/document_generator/README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/python/samples/demos/document_generator/README.md b/python/samples/demos/document_generator/README.md index 3b0c8ee6307c..45bba5069d99 100644 --- a/python/samples/demos/document_generator/README.md +++ b/python/samples/demos/document_generator/README.md @@ -37,7 +37,7 @@ To learn more about the Semantic Kernel Agent Framework, please refer to the [Se - `AICodeSandbox` - for executing AI generated code in a sandbox environment ```bash - pip install AICodeSandbox + pip install ai-code-sandbox ``` > You must also have `docker` installed and running on your machine. Follow the instructions [here](https://docs.docker.com/get-started/introduction/get-docker-desktop/) to install docker for your platform. Images will be pulled during runtime if not already present. Containers will be created and destroyed during code execution. @@ -54,6 +54,7 @@ OPENAI_API_KEY= ``` > gpt-4o-2024-08-06 was used to generate [GENERATED_DOCUMENT.md](GENERATED_DOCUMENT.md). +> Feel free to use other models from OpenAI or other providers. When you use models from another provider, make sure to update the chat completion services accordingly. ```env