DOC: add Example sections to KernelFunction.from_prompt and invoke#14150
Open
shoumikchakravarty-dev wants to merge 2 commits into
Open
Conversation
Add illustrative code examples to two public methods in KernelFunction: - from_prompt: shows creating a prompt-based function and registering it with the kernel - invoke: shows async invocation with KernelArguments using OpenAIChatCompletion Both examples follow the existing Google-style docstring convention used throughout the module.
Contributor
There was a problem hiding this comment.
Pull request overview
Adds usage examples to two key public KernelFunction entry points in the Python SDK so developers can discover common workflows (creating prompt-based functions and invoking them) directly from docstrings / generated API docs.
Changes:
- Expanded
KernelFunction.from_promptdocstring with an example that creates a prompt function and registers it with aKernel. - Expanded
KernelFunction.invokedocstring with an async example invoking a prompt function usingKernelArgumentsandOpenAIChatCompletion.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Add illustrative code examples to two public methods in KernelFunction:
Both examples follow the existing Google-style docstring convention used throughout the module.
Motivation and Context
Please help reviewers and future users, providing the following information:
Description
This PR adds illustrative code examples to two public methods in
KernelFunctionthat currently have minimal docstrings:from_prompt: shows creating a prompt-based function and registeringit with the kernel
invoke: shows async invocation withKernelArgumentsusingOpenAIChatCompletionBoth examples follow the existing Google-style docstring convention
used throughout the module. No logic changes.
Contribution Checklist