Skip to content

ManagedSearchConfiguration

Source code in docs_src/capo_bedrock_agent_runtime/types/managed_search_configuration.py
class ManagedSearchConfiguration(TypedDict, closed=True):
    number_of_results: NotRequired["int"]
    """<p>The number of results to retrieve.</p>"""
    filter: NotRequired[
        "capo_bedrock_agent_runtime.types.retrieval_filter.RetrievalFilter"
    ]
    """<p>Filters the metadata of the retrieved results so that Amazon Bedrock returns only results that match the filter.</p>"""
    reranking_model_type: NotRequired[
        "capo_bedrock_agent_runtime.types.reranking_model_type.RerankingModelType"
    ]
    """<p>The type of reranking model to use when reranking results retrieved from the managed search. Use <code>CUSTOM</code> to specify a model, <code>MANAGED</code> to use the service default, or <code>NONE</code> to disable reranking.</p>"""
    reranking_configuration: NotRequired[
        "capo_bedrock_agent_runtime.types.managed_search_reranking_configuration.ManagedSearchRerankingConfiguration"
    ]
    """<p>Contains configurations for reranking the results retrieved from the managed search.</p>"""

filter instance-attribute

filter: NotRequired[RetrievalFilter]

Filters the metadata of the retrieved results so that Amazon Bedrock returns only results that match the filter.

number_of_results instance-attribute

number_of_results: NotRequired[int]

The number of results to retrieve.

reranking_configuration instance-attribute

reranking_configuration: NotRequired[ManagedSearchRerankingConfiguration]

Contains configurations for reranking the results retrieved from the managed search.

reranking_model_type instance-attribute

reranking_model_type: NotRequired[RerankingModelType]

The type of reranking model to use when reranking results retrieved from the managed search. Use CUSTOM to specify a model, MANAGED to use the service default, or NONE to disable reranking.