Skip to content

ModelInvocationInput

Source code in docs_src/capo_bedrock_agent_runtime/types/model_invocation_input.py 
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
class ModelInvocationInput(TypedDict, closed=True):
    trace_id: NotRequired["capo_bedrock_agent_runtime.types.trace_id.TraceId"]
    """<p>The unique identifier of the trace.</p>"""
    text: NotRequired["capo_bedrock_agent_runtime.types.prompt_text.PromptText"]
    """<p>The text that prompted the agent at this step.</p>"""
    type: NotRequired["capo_bedrock_agent_runtime.types.prompt_type.PromptType"]
    """<p>The step in the agent sequence.</p>"""
    override_lambda: NotRequired[
        "capo_bedrock_agent_runtime.types.lambda_arn.LambdaArn"
    ]
    """<p>The ARN of the Lambda function to use when parsing the raw foundation model output in parts of the agent sequence.</p>"""
    prompt_creation_mode: NotRequired[
        "capo_bedrock_agent_runtime.types.creation_mode.CreationMode"
    ]
    """<p>Specifies whether the default prompt template was <code>OVERRIDDEN</code>. If it was, the <code>basePromptTemplate</code> that was set in the <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_PromptOverrideConfiguration.html">PromptOverrideConfiguration</a> object when the agent was created or updated is used instead.</p>"""
    inference_configuration: NotRequired[
        "capo_bedrock_agent_runtime.types.inference_configuration.InferenceConfiguration"
    ]
    """<p>Specifications about the inference parameters that were provided alongside the prompt. These are specified in the <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_PromptOverrideConfiguration.html">PromptOverrideConfiguration</a> object that was set when the agent was created or updated. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html">Inference parameters for foundation models</a>.</p>"""
    parser_mode: NotRequired[
        "capo_bedrock_agent_runtime.types.creation_mode.CreationMode"
    ]
    """<p>Specifies whether to override the default parser Lambda function when parsing the raw foundation model output in the part of the agent sequence defined by the <code>promptType</code>.</p>"""
    foundation_model: NotRequired[
        "capo_bedrock_agent_runtime.types.model_identifier.ModelIdentifier"
    ]
    """<p>The identifier of a foundation model.</p>"""

foundation_model instance-attribute 

foundation_model: NotRequired[ModelIdentifier]

The identifier of a foundation model.

inference_configuration instance-attribute 

inference_configuration: NotRequired[InferenceConfiguration]

Specifications about the inference parameters that were provided alongside the prompt. These are specified in the PromptOverrideConfiguration object that was set when the agent was created or updated. For more information, see Inference parameters for foundation models.

override_lambda instance-attribute 

override_lambda: NotRequired[LambdaArn]

The ARN of the Lambda function to use when parsing the raw foundation model output in parts of the agent sequence.

parser_mode instance-attribute 

parser_mode: NotRequired[CreationMode]

Specifies whether to override the default parser Lambda function when parsing the raw foundation model output in the part of the agent sequence defined by the promptType.

prompt_creation_mode instance-attribute 

prompt_creation_mode: NotRequired[CreationMode]

Specifies whether the default prompt template was OVERRIDDEN. If it was, the basePromptTemplate that was set in the PromptOverrideConfiguration object when the agent was created or updated is used instead.

text instance-attribute 

text: NotRequired[PromptText]

The text that prompted the agent at this step.

trace_id instance-attribute 

trace_id: NotRequired[TraceId]

The unique identifier of the trace.

type instance-attribute 

type: NotRequired[PromptType]

The step in the agent sequence.