Skip to content

ParameterDetail

Source code in docs_src/capo_bedrock_agent_runtime/types/parameter_detail.py
class ParameterDetail(TypedDict, closed=True):
    description: NotRequired[
        "capo_bedrock_agent_runtime.types.parameter_description.ParameterDescription"
    ]
    """<p> A description of the parameter. Helps the foundation model determine how to elicit the parameters from the user. </p>"""
    type: "capo_bedrock_agent_runtime.types.parameter_type.ParameterType"
    """<p> The data type of the parameter. </p>"""
    required: NotRequired["bool"]
    """<p> Whether the parameter is required for the agent to complete the function for action group invocation. </p>"""

description instance-attribute

description: NotRequired[ParameterDescription]

A description of the parameter. Helps the foundation model determine how to elicit the parameters from the user.

required instance-attribute

required: NotRequired[bool]

Whether the parameter is required for the agent to complete the function for action group invocation.

type instance-attribute

The data type of the parameter.