KnowledgeBaseFlowNodeConfiguration ¶

class KnowledgeBaseFlowNodeConfiguration(TypedDict, closed=True):
    knowledge_base_id: (
        "capo_bedrock_agent.types.flow_knowledge_base_id.FlowKnowledgeBaseId"
    )
    """<p>The unique identifier of the knowledge base to query.</p>"""
    model_id: NotRequired[
        "capo_bedrock_agent.types.knowledge_base_model_identifier.KnowledgeBaseModelIdentifier"
    ]
    """<p>The unique identifier of the model or <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/cross-region-inference.html">inference profile</a> to use to generate a response from the query results. Omit this field if you want to return the retrieved results as an array.</p>"""
    guardrail_configuration: NotRequired[
        "capo_bedrock_agent.types.guardrail_configuration.GuardrailConfiguration"
    ]
    """<p>Contains configurations for a guardrail to apply during query and response generation for the knowledge base in this configuration.</p>"""
    number_of_results: NotRequired["int"]
    """<p>The number of results to retrieve from the knowledge base.</p>"""
    prompt_template: NotRequired[
        "capo_bedrock_agent.types.knowledge_base_prompt_template.KnowledgeBasePromptTemplate"
    ]
    """<p>A custom prompt template to use with the knowledge base for generating responses.</p>"""
    inference_configuration: NotRequired[
        "capo_bedrock_agent.types.prompt_inference_configuration.PromptInferenceConfiguration"
    ]
    """<p>Contains inference configurations for the prompt.</p>"""
    reranking_configuration: NotRequired[
        "capo_bedrock_agent.types.vector_search_reranking_configuration.VectorSearchRerankingConfiguration"
    ]
    """<p>The configuration for reranking the retrieved results from the knowledge base to improve relevance.</p>"""
    orchestration_configuration: NotRequired[
        "capo_bedrock_agent.types.knowledge_base_orchestration_configuration.KnowledgeBaseOrchestrationConfiguration"
    ]
    """<p>The configuration for orchestrating the retrieval and generation process in the knowledge base node.</p>"""