Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 47 additions & 1 deletion python/semantic_kernel/functions/kernel_function.py
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,26 @@ def from_prompt(
"PromptExecutionSettings | Sequence[PromptExecutionSettings] | Mapping[str, PromptExecutionSettings] | None"
) = None,
) -> "KernelFunctionFromPrompt":
"""Create a new instance of the KernelFunctionFromPrompt class."""
"""Create a new instance of the KernelFunctionFromPrompt class.

Example:
Create a prompt-based function and register it with the kernel:

from semantic_kernel import Kernel
from semantic_kernel.functions import KernelFunction

kernel = Kernel()
func = KernelFunction.from_prompt(
function_name="summarize",
plugin_name="WriterPlugin",
description="Summarizes the provided text in one sentence.",
prompt="Summarize the following in one sentence: {{$input}}",
)
kernel.add_function(plugin_name="WriterPlugin", function=func)
print(func.name) # summarize
print(func.plugin_name) # WriterPlugin
print(func.is_prompt) # True
"""
from semantic_kernel.functions.kernel_function_from_prompt import KernelFunctionFromPrompt

return KernelFunctionFromPrompt(
Expand Down Expand Up @@ -255,6 +274,33 @@ async def invoke(

Returns:
FunctionResult: The result of the function

Example:
Invoke a prompt function with arguments:

import asyncio
from semantic_kernel import Kernel
from semantic_kernel.connectors.ai.open_ai import OpenAIChatCompletion
from semantic_kernel.functions import KernelArguments, KernelFunction

async def main():
kernel = Kernel()
# Requires OPENAI_API_KEY env var (or pass api_key explicitly).
kernel.add_service(OpenAIChatCompletion(ai_model_id="gpt-4o-mini", service_id="default"))
func = KernelFunction.from_prompt(
function_name="summarize",
plugin_name="WriterPlugin",
prompt="Summarize the following in one sentence: {{$input}}",
)
result = await func.invoke(
kernel=kernel,
arguments=KernelArguments(
input="Azure API Management is a fully managed gateway service."
),
)
print(result)

asyncio.run(main())
"""
if arguments is None:
arguments = KernelArguments(**kwargs)
Expand Down
Loading