Skip to content

AssociateAgentKnowledgeBaseRequest

Source code in docs_src/capo_bedrock_agent/types/associate_agent_knowledge_base_request.py
class AssociateAgentKnowledgeBaseRequest(TypedDict, closed=True):
    agent_id: "capo_bedrock_agent.types.id.Id"
    """<p>The unique identifier of the agent with which you want to associate the knowledge base.</p>"""
    agent_version: "capo_bedrock_agent.types.draft_version.DraftVersion"
    """<p>The version of the agent with which you want to associate the knowledge base.</p>"""
    knowledge_base_id: "capo_bedrock_agent.types.id.Id"
    """<p>The unique identifier of the knowledge base to associate with the agent.</p>"""
    description: "capo_bedrock_agent.types.description.Description"
    """<p>A description of what the agent should use the knowledge base for.</p>"""
    knowledge_base_state: NotRequired[
        "capo_bedrock_agent.types.knowledge_base_state.KnowledgeBaseState"
    ]
    """<p>Specifies whether to use the knowledge base or not when sending an <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html">InvokeAgent</a> request.</p>"""

agent_id instance-attribute

agent_id: Id

The unique identifier of the agent with which you want to associate the knowledge base.

agent_version instance-attribute

agent_version: DraftVersion

The version of the agent with which you want to associate the knowledge base.

description instance-attribute

description: Description

A description of what the agent should use the knowledge base for.

knowledge_base_id instance-attribute

knowledge_base_id: Id

The unique identifier of the knowledge base to associate with the agent.

knowledge_base_state instance-attribute

knowledge_base_state: NotRequired[KnowledgeBaseState]

Specifies whether to use the knowledge base or not when sending an InvokeAgent request.