Share via

KernelFunctionMetadata Class

The kernel function metadata.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Constructor

KernelFunctionMetadata(*, name: Annotated[str, _PydanticGeneralMetadata(pattern='^[0-9A-Za-z_]+$')], plugin_name: Annotated[str | None, _PydanticGeneralMetadata(pattern='^[0-9A-Za-z_]+$')] = None, description: str | None = None, parameters: list[KernelParameterMetadata] = None, is_prompt: bool, is_asynchronous: bool | None = True, return_parameter: KernelParameterMetadata | None = None, additional_properties: dict[str, Any] | None = None)

Keyword-Only Parameters

Name Description
name
Required
plugin_name
Required
description
Required
parameters
Required
is_prompt
Required
is_asynchronous
Default value: True
return_parameter
Required
additional_properties
Required

Methods

custom_fully_qualified_name

Get the fully qualified name of the function with a custom separator.

custom_fully_qualified_name

Get the fully qualified name of the function with a custom separator.

custom_fully_qualified_name(separator: str) -> str

Parameters

Name Description
separator
Required
str

The custom separator.

Returns

Type Description

The fully qualified name of the function with a custom separator.

Attributes

fully_qualified_name

Get the fully qualified name of the function.

A fully qualified name is the name of the combination of the plugin name and the function name, separated by a hyphen, if the plugin name is present. Otherwise, it is just the function name.

Returns

Type Description

The fully qualified name of the function.

additional_properties 

additional_properties: dict[str, Any] | None

description 

description: str | None

is_asynchronous 

is_asynchronous: bool | None

is_prompt 

is_prompt: bool

name 

name: str

parameters 

parameters: list[KernelParameterMetadata]

plugin_name 

plugin_name: str | None

return_parameter 

return_parameter: KernelParameterMetadata | None