Skip to content

Function

Source code in docs_src/capo_bedrock_agent/types/function.py
class Function(TypedDict, closed=True):
    name: "capo_bedrock_agent.types.name.Name"
    """<p>A name for the function.</p>"""
    description: NotRequired[
        "capo_bedrock_agent.types.function_description.FunctionDescription"
    ]
    """<p>A description of the function and its purpose.</p>"""
    parameters: NotRequired["capo_bedrock_agent.types.parameter_map.ParameterMap"]
    """<p>The parameters that the agent elicits from the user to fulfill the function.</p>"""
    require_confirmation: NotRequired[
        "capo_bedrock_agent.types.require_confirmation.RequireConfirmation"
    ]
    """<p>Contains information if user confirmation is required to invoke the function.</p>"""

description instance-attribute

description: NotRequired[FunctionDescription]

A description of the function and its purpose.

name instance-attribute

name: Name

A name for the function.

parameters instance-attribute

parameters: NotRequired[ParameterMap]

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

require_confirmation instance-attribute

require_confirmation: NotRequired[RequireConfirmation]

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