Skip to content

KnowledgeBase

Source code in docs_src/capo_bedrock_agent_runtime/types/knowledge_base.py
class KnowledgeBase(TypedDict, closed=True):
    knowledge_base_id: (
        "capo_bedrock_agent_runtime.types.knowledge_base_id.KnowledgeBaseId"
    )
    """<p> The unique identifier for a knowledge base associated with the inline agent. </p>"""
    description: (
        "capo_bedrock_agent_runtime.types.resource_description.ResourceDescription"
    )
    """<p> The description of the knowledge base associated with the inline agent. </p>"""
    retrieval_configuration: NotRequired[
        "capo_bedrock_agent_runtime.types.knowledge_base_retrieval_configuration.KnowledgeBaseRetrievalConfiguration"
    ]
    """<p> The configurations to apply to the knowledge base during query. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html">Query configurations</a>. </p>"""

description instance-attribute

description: ResourceDescription

The description of the knowledge base associated with the inline agent.

knowledge_base_id instance-attribute

knowledge_base_id: KnowledgeBaseId

The unique identifier for a knowledge base associated with the inline agent.

retrieval_configuration instance-attribute

retrieval_configuration: NotRequired[KnowledgeBaseRetrievalConfiguration]

The configurations to apply to the knowledge base during query. For more information, see Query configurations.