Skip to content

FunctionDefinition

Structure Class

FunctionDefinition dataclass

Bases: _SerdeShape

Defines parameters that the agent needs to invoke from the user to complete the function. Corresponds to an action in an action group.

Attributes

description class-attribute instance-attribute
description: str | None = ...

A description of the function and its purpose.

name instance-attribute
name: str

A name for the function.

parameters class-attribute instance-attribute
parameters: dict[str, ParameterDetail] | None = ...

The parameters that the agent elicits from the user to fulfill the function.

require_confirmation class-attribute instance-attribute
require_confirmation: str | None = ...

Contains information if user confirmation is required to invoke the function.