update_agent_knowledge_base¶
Operation¶
update_agent_knowledge_base
¶
update_agent_knowledge_base(request: UpdateAgentKnowledgeBaseInput | UpdateAgentKnowledgeBaseInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[UpdateAgentKnowledgeBaseInputDict]) -> UpdateAgentKnowledgeBaseOutput
Updates the configuration for a knowledge base that has been associated with an agent.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
UpdateAgentKnowledgeBaseInput | UpdateAgentKnowledgeBaseInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
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
|
**kwargs
|
Unpack[UpdateAgentKnowledgeBaseInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
UpdateAgentKnowledgeBaseOutput
|
An instance of |
update_agent_knowledge_base
async
¶
update_agent_knowledge_base(request: UpdateAgentKnowledgeBaseInput | UpdateAgentKnowledgeBaseInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[UpdateAgentKnowledgeBaseInputDict]) -> UpdateAgentKnowledgeBaseOutput
Updates the configuration for a knowledge base that has been associated with an agent.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
UpdateAgentKnowledgeBaseInput | UpdateAgentKnowledgeBaseInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
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
|
**kwargs
|
Unpack[UpdateAgentKnowledgeBaseInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
UpdateAgentKnowledgeBaseOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
UpdateAgentKnowledgeBaseInputDict
¶
Bases: TypedDict
Dictionary form of UpdateAgentKnowledgeBaseInput.
Attributes¶
agent_id
instance-attribute
¶
The unique identifier of the agent associated with the knowledge base that you want to update.
agent_version
instance-attribute
¶
The version of the agent associated with the knowledge base that you want to update.
description
instance-attribute
¶
description: str | None
Specifies a new description for the knowledge base associated with an agent.
knowledge_base_id
instance-attribute
¶
The unique identifier of the knowledge base that has been associated with an agent.
knowledge_base_state
instance-attribute
¶
knowledge_base_state: str | None
Specifies whether the agent uses the knowledge base or not when sending an InvokeAgent request.
UpdateAgentKnowledgeBaseInput
dataclass
¶
Bases: _SerdeShape
Dataclass for UpdateAgentKnowledgeBaseInput structure.
Attributes¶
agent_id
class-attribute
instance-attribute
¶
agent_id: str | None = ...
The unique identifier of the agent associated with the knowledge base that you want to update.
agent_version
class-attribute
instance-attribute
¶
agent_version: str | None = ...
The version of the agent associated with the knowledge base that you want to update.
description
class-attribute
instance-attribute
¶
description: str | None = ...
Specifies a new description for the knowledge base associated with an agent.
knowledge_base_id
class-attribute
instance-attribute
¶
knowledge_base_id: str | None = ...
The unique identifier of the knowledge base that has been associated with an agent.
knowledge_base_state
class-attribute
instance-attribute
¶
knowledge_base_state: str | None = ...
Specifies whether the agent uses the knowledge base or not when sending an InvokeAgent request.
Output¶
UpdateAgentKnowledgeBaseOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for UpdateAgentKnowledgeBaseOutput structure.
Attributes¶
agent_knowledge_base
instance-attribute
¶
agent_knowledge_base: AgentKnowledgeBase
Contains details about the knowledge base that has been associated with an agent.
response_metadata
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.