Skip to content

AgenticRetrieveConfiguration

Used by
Source code in docs_src/capo_bedrock_agent_runtime/types/agentic_retrieve_configuration.py 
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
class AgenticRetrieveConfiguration(TypedDict, closed=True):
    foundation_model_type: (
        "capo_bedrock_agent_runtime.types.foundation_model_type.FoundationModelType"
    )
    """<p>The type of foundation model to use. CUSTOM uses a specified model, MANAGED uses the service default.</p>"""
    foundation_model_configuration: NotRequired[
        "capo_bedrock_agent_runtime.types.foundation_model_configuration.FoundationModelConfiguration"
    ]
    """<p>The foundation model configuration. Required when foundationModelType is CUSTOM.</p>"""
    reranking_model_type: NotRequired[
        "capo_bedrock_agent_runtime.types.agentic_retrieve_reranking_model_type.AgenticRetrieveRerankingModelType"
    ]
    """<p>The type of reranking model to use. CUSTOM uses a specified model, MANAGED uses the service default. If not specified, defaults to MANAGED for managed embedding knowledge bases and NONE for custom embedding knowledge bases.</p>"""
    reranking_configuration: NotRequired[
        "capo_bedrock_agent_runtime.types.agentic_retrieve_reranking_configuration.AgenticRetrieveRerankingConfiguration"
    ]
    """<p>The reranking model configuration. Required when rerankingModelType is CUSTOM.</p>"""
    max_agent_iteration: "int"
    """<p>The maximum number of agent iterations for retrieval.</p>"""

foundation_model_configuration instance-attribute 

foundation_model_configuration: NotRequired[FoundationModelConfiguration]

The foundation model configuration. Required when foundationModelType is CUSTOM.

foundation_model_type instance-attribute 

foundation_model_type: FoundationModelType

The type of foundation model to use. CUSTOM uses a specified model, MANAGED uses the service default.

max_agent_iteration instance-attribute 

max_agent_iteration: int

The maximum number of agent iterations for retrieval.

reranking_configuration instance-attribute 

reranking_configuration: NotRequired[AgenticRetrieveRerankingConfiguration]

The reranking model configuration. Required when rerankingModelType is CUSTOM.

reranking_model_type instance-attribute 

reranking_model_type: NotRequired[AgenticRetrieveRerankingModelType]

The type of reranking model to use. CUSTOM uses a specified model, MANAGED uses the service default. If not specified, defaults to MANAGED for managed embedding knowledge bases and NONE for custom embedding knowledge bases.