associate_agent_knowledge_base¶
Operation¶
async
¶
associate_agent_knowledge_base(input: AssociateAgentKnowledgeBaseInput, plugins: list[Plugin] | None = None) -> AssociateAgentKnowledgeBaseOutput
Associates a knowledge base with an agent. If a knowledge base is
associated and its indexState is set to Enabled, the agent queries
the knowledge base for information to augment its response to the user.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
AssociateAgentKnowledgeBaseInput
|
An instance of |
required |
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
AssociateAgentKnowledgeBaseOutput
|
An instance of |
Input¶
dataclass
¶
Dataclass for AssociateAgentKnowledgeBaseInput structure.
Attributes¶
class-attribute
instance-attribute
¶
agent_id: str | None = None
The unique identifier of the agent with which you want to associate the knowledge base.
class-attribute
instance-attribute
¶
agent_version: str | None = None
The version of the agent with which you want to associate the knowledge base.
class-attribute
instance-attribute
¶
description: str | None = None
A description of what the agent should use the knowledge base for.
class-attribute
instance-attribute
¶
knowledge_base_id: str | None = None
The unique identifier of the knowledge base to associate with the agent.
class-attribute
instance-attribute
¶
knowledge_base_state: KnowledgeBaseState | None = None
Specifies whether to use the knowledge base or not when sending an InvokeAgent request.
Output¶
dataclass
¶
Dataclass for AssociateAgentKnowledgeBaseOutput structure.
Attributes¶
instance-attribute
¶
agent_knowledge_base: AgentKnowledgeBase
Contains details about the knowledge base that has been associated with the agent.