Python: implement Chat history, and refactor prompt config/prompt config template by moonbox3 · Pull Request #5023 · microsoft/semantic-kernel

moonbox3 · 2024-02-14T21:18:06Z

Motivation and Context

This PR addresses a few of our remaining urgent work items: #4856, #4630.

Description

In this PR:

The prompt template/prompt template config is refactored to be similar to the dotnet versions.
The KernelPromptTemplate is introduced as the default prompt template (will need to make it more dynamic in the future when we have other prompt templates, like handlebars or jinja2).
The methods related to create_semantic_function were removed and it their places a method create_function_from_prompt was added.
ChatHistory was introduced as a way to take over what ChatMessage was doing. ChatHistory is passed into the complete chat/text methods.
As of these latest changes, all unit and integration tests are passing.
New kernel examples were added to exercise this new code.

Contribution Checklist

The code builds clean without any errors or warnings
The PR follows the SK Contribution Guidelines and the pre-submission formatting script raises no violations
All unit tests pass, and I have added new tests where possible
I didn't break anyone 😄

…mptConfig/PromptTemplateConfig to be similar to dotnet. Update both unit and integration tests. Implement a beginning of an ai service selector as ChatPromptTemplate is going away.

eavanvalkenburg

Still some work to do, but the basics are there!

python/samples/kernel-syntax-examples/azure_chat_gpt_api.py

python/semantic_kernel/services/ai_service_selector.py

python/semantic_kernel/kernel.py

python/semantic_kernel/functions/kernel_function.py

python/semantic_kernel/functions/prompt_rendering_result.py

python/semantic_kernel/services/ai_service_selector.py

python/semantic_kernel/template_engine/protocols/prompt_templating_engine.py

python/semantic_kernel/models/ai/chat_completion/chat_history.py

### Motivation and Context  Implements the AI Service Selector mechanism Revamps and simplifies the services in the Kernel Made service_id required field on all services ### Description  - Removed the individual service fields in kernel, replaced with single one, with dict[str, Class] as type - Also removed default_service fields from kernel - Reordered methods in Kernel and added region notes for easier folding in IDE - Added new service management methods incl tests, removed old ones. - Removed service linking to default service from kernel_function - Added AIServiceSelector class, single method that can be overridden, returns service and execution_settings with the right type - Removed usage of chat_prompt related fields, now checks if service is ChatCompletion and then usage that, otherwise falls back to TextCompletion - Added kernel test folder, with kernel_service_management tests, completely covering service related functions ### 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 - [ ] I didn't break anyone 😄

…o chat_history_and_prompt_config

### Motivation and Context  ### Description  ### Contribution Checklist  - [ ] The code builds clean without any errors or warnings - [ ] 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 - [ ] All unit tests pass, and I have added new tests where possible - [ ] I didn't break anyone 😄

eavanvalkenburg

what a lot of work, nice going! some comments added!

python/samples/kernel-syntax-examples/azure_chat_gpt_api.py

python/semantic_kernel/kernel.py

python/semantic_kernel/models/ai/chat_completion/chat_history.py

### Motivation and Context  Implements the AI Service Selector mechanism Revamps and simplifies the services in the Kernel Made service_id required field on all services ### Description  - Removed the individual service fields in kernel, replaced with single one, with dict[str, Class] as type - Also removed default_service fields from kernel - Reordered methods in Kernel and added region notes for easier folding in IDE - Added new service management methods incl tests, removed old ones. - Removed service linking to default service from kernel_function - Added AIServiceSelector class, single method that can be overridden, returns service and execution_settings with the right type - Removed usage of chat_prompt related fields, now checks if service is ChatCompletion and then usage that, otherwise falls back to TextCompletion - Added kernel test folder, with kernel_service_management tests, completely covering service related functions ### 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 - [ ] I didn't break anyone 😄

### Motivation and Context  ### Description  ### Contribution Checklist  - [ ] The code builds clean without any errors or warnings - [ ] 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 - [ ] All unit tests pass, and I have added new tests where possible - [ ] I didn't break anyone 😄

…te methods. Update more Jupyter notebooks. All tests passing.

…hanges. Still a few more todo.

eavanvalkenburg

man, what a load of work, looking good overall, lots of small notes!

python/samples/kernel-syntax-examples/azure_chat_gpt_api.py

python/samples/kernel-syntax-examples/chat.py

python/semantic_kernel/connectors/ai/chat_completion_client_base.py

python/semantic_kernel/connectors/ai/open_ai/contents/open_ai_chat_message_content.py

python/semantic_kernel/prompt_template/chat_prompt_template.py

python/semantic_kernel/prompt_template/kernel_prompt_template.py

python/tests/unit/models/ai/chat_completion/test_chat_history.py

python/tests/unit/test_serialization.py

…th named_args added (microsoft#5014) ### Motivation and Context  This implements ADR0009 multiple arguments in a template function. Closes microsoft#5003 ### Description  Added NamedArgBlocks class and updated codetokenizer and templatetokenizer to recognize these and implement them, add code to CodeBlock class to use it. ### 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 😄

…prompt. Add chat history tests, and chathistory serialization test. Other small updates. All tests passing.

python/semantic_kernel/functions/kernel_function.py

moonbox3 and others added 4 commits February 14, 2024 11:33

kernel args and func result

0605673

remove functions view

e1d58dd

updated blocks, small updates to samples and tests

cabdcaf

Use ChatHistory in place of input prompts or messages. Tailor the Pro…

3f364e7

…mptConfig/PromptTemplateConfig to be similar to dotnet. Update both unit and integration tests. Implement a beginning of an ai service selector as ChatPromptTemplate is going away.

moonbox3 requested a review from a team as a code owner February 14, 2024 21:18

shawncal added the python Pull requests for the Python Semantic Kernel label Feb 14, 2024

moonbox3 changed the title ~~Python: implement Chat history and ai service selector, and refactor prompt config/prompt config templat~~ Python: implement Chat history and ai service selector, and refactor prompt config/prompt config template Feb 14, 2024

This was linked to issues Feb 14, 2024

Python: add ChatHistory concept in sync with dotnet and adapt chat_prompt_template accordingly #4856

Closed

Python: Add AI service selector to Python #4631

Closed

Python: Refactor prompt_template and prompt_template_config to match dotnet #4630

Closed

eavanvalkenburg requested changes Feb 15, 2024

View reviewed changes

moonbox3 changed the title ~~Python: implement Chat history and ai service selector, and refactor prompt config/prompt config template~~ Python: implement Chat history, and refactor prompt config/prompt config template Feb 15, 2024

eavanvalkenburg and others added 8 commits February 16, 2024 13:06

Updates to kernel examples. Clean up other small issues.

91694d0

Merge remote-tracking branch 'upstream/python_kernel_args_latest' int…

9e772d0

…o chat_history_and_prompt_config

Updates to support new prompt function

5451894

All unit tests running.

a6aff16

All unit and integration tests are passing.

22e7519

Merge feature branch to local branch

1aa396a

eavanvalkenburg requested changes Feb 19, 2024

View reviewed changes

moonbox3 and others added 5 commits February 20, 2024 13:02

kernel args and func result

6b3498c

remove functions view

5356afc

updated blocks, small updates to samples and tests

c48dcdb

eavanvalkenburg force-pushed the python_kernel_args_latest branch from fe5887e to a9e9085 Compare February 20, 2024 12:03

moonbox3 added 3 commits February 20, 2024 13:30

Updates to better use/parse ChatHistory. Fix tests. Formatting fixes.

3d6bef1

Return KernelException instead of a generic one.

0d22b12

Add user message for prompt, not system.

4e5d2df

moonbox3 added 6 commits February 20, 2024 15:02

Merge upstream feature branch to local feature branch

154d261

Update test from merge issue

0e5ad04

Update Jupyter notebooks 0-4 for latest code.

1023b21

Update complete stream arg name to chat_history to match other comple…

31a820a

…te methods. Update more Jupyter notebooks. All tests passing.

Clean up kernel examples and Jupyter notebooks based on latest code c…

d15752c

…hanges. Still a few more todo.

Formatting fixes.

7e0b47c

moonbox3 removed a link to an issue Feb 21, 2024

Python: Add AI service selector to Python #4631

Closed

eavanvalkenburg requested changes Feb 21, 2024

View reviewed changes

eavanvalkenburg and others added 4 commits February 21, 2024 10:15

Restructure chat history init, revert text completion changes to use …

b4f80fd

…prompt. Add chat history tests, and chathistory serialization test. Other small updates. All tests passing.

Merge upstream to local

3dfb0b1

Updates to code to support latest changes.

87c154d

markwallace-microsoft added documentation memory labels Feb 21, 2024

eavanvalkenburg force-pushed the python_kernel_args_latest branch from 2a3e52a to a2aaf8c Compare February 22, 2024 08:01

eavanvalkenburg approved these changes Feb 22, 2024

View reviewed changes

python/semantic_kernel/functions/kernel_function.py Show resolved Hide resolved

Merge upstream to local

fbc88dd

moonbox3 merged commit ec02d89 into microsoft:python_kernel_args_latest Feb 22, 2024

Conversation

moonbox3 commented Feb 14, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Motivation and Context

Description

Contribution Checklist

Uh oh!

eavanvalkenburg left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

eavanvalkenburg left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

eavanvalkenburg left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

moonbox3 commented Feb 14, 2024 •

edited

Loading