Skip to content

OrchestrationConfiguration

Source code in docs_src/capo_bedrock_agent_runtime/types/orchestration_configuration.py 
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
class OrchestrationConfiguration(TypedDict, closed=True):
    prompt_template: NotRequired[
        "capo_bedrock_agent_runtime.types.prompt_template.PromptTemplate"
    ]
    """<p>Contains the template for the prompt that's sent to the model. Orchestration prompts must include the <code>$conversation_history$</code> and <code>$output_format_instructions$</code> variables. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-placeholders.html">Use placeholder variables</a> in the user guide.</p>"""
    inference_config: NotRequired[
        "capo_bedrock_agent_runtime.types.inference_config.InferenceConfig"
    ]
    """<p> Configuration settings for inference when using RetrieveAndGenerate to generate responses while using a knowledge base as a source. </p>"""
    additional_model_request_fields: NotRequired[
        "capo_bedrock_agent_runtime.types.additional_model_request_fields.AdditionalModelRequestFields"
    ]
    """<p> Additional model parameters and corresponding values not included in the textInferenceConfig structure for a knowledge base. This allows users to provide custom model parameters specific to the language model being used. </p>"""
    query_transformation_configuration: NotRequired[
        "capo_bedrock_agent_runtime.types.query_transformation_configuration.QueryTransformationConfiguration"
    ]
    """<p>To split up the prompt and retrieve multiple sources, set the transformation type to <code>QUERY_DECOMPOSITION</code>.</p>"""
    performance_config: NotRequired[
        "capo_bedrock_agent_runtime.types.performance_configuration.PerformanceConfiguration"
    ]
    """<p>The latency configuration for the model.</p>"""

additional_model_request_fields instance-attribute 

additional_model_request_fields: NotRequired[AdditionalModelRequestFields]

Additional model parameters and corresponding values not included in the textInferenceConfig structure for a knowledge base. This allows users to provide custom model parameters specific to the language model being used.

inference_config instance-attribute 

inference_config: NotRequired[InferenceConfig]

Configuration settings for inference when using RetrieveAndGenerate to generate responses while using a knowledge base as a source.

performance_config instance-attribute 

performance_config: NotRequired[PerformanceConfiguration]

The latency configuration for the model.

prompt_template instance-attribute 

prompt_template: NotRequired[PromptTemplate]

Contains the template for the prompt that's sent to the model. Orchestration prompts must include the $conversation_history$ and $output_format_instructions$ variables. For more information, see Use placeholder variables in the user guide.

query_transformation_configuration instance-attribute 

query_transformation_configuration: NotRequired[QueryTransformationConfiguration]

To split up the prompt and retrieve multiple sources, set the transformation type to QUERY_DECOMPOSITION.