list_agent_knowledge_bases¶
Operation¶
list_agent_knowledge_bases
¶
list_agent_knowledge_bases(request: ListAgentKnowledgeBasesInput | ListAgentKnowledgeBasesInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListAgentKnowledgeBasesInputDict]) -> ListAgentKnowledgeBasesOutput
Lists knowledge bases associated with an agent and information about each one.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
ListAgentKnowledgeBasesInput | ListAgentKnowledgeBasesInputDict | 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[ListAgentKnowledgeBasesInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
ListAgentKnowledgeBasesOutput
|
An instance of |
list_agent_knowledge_bases
async
¶
list_agent_knowledge_bases(request: ListAgentKnowledgeBasesInput | ListAgentKnowledgeBasesInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListAgentKnowledgeBasesInputDict]) -> ListAgentKnowledgeBasesOutput
Lists knowledge bases associated with an agent and information about each one.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
ListAgentKnowledgeBasesInput | ListAgentKnowledgeBasesInputDict | 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[ListAgentKnowledgeBasesInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
ListAgentKnowledgeBasesOutput
|
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.
ListAgentKnowledgeBasesInputDict
¶
Bases: TypedDict
Dictionary form of ListAgentKnowledgeBasesInput.
Attributes¶
agent_id
instance-attribute
¶
The unique identifier of the agent for which to return information about knowledge bases associated with it.
agent_version
instance-attribute
¶
The version of the agent for which to return information about knowledge bases associated with it.
ListAgentKnowledgeBasesInput
dataclass
¶
Bases: _SerdeShape
Dataclass for ListAgentKnowledgeBasesInput structure.
Attributes¶
agent_id
class-attribute
instance-attribute
¶
agent_id: str | None = ...
The unique identifier of the agent for which to return information about knowledge bases associated with it.
agent_version
class-attribute
instance-attribute
¶
agent_version: str | None = ...
The version of the agent for which to return information about knowledge bases associated with it.
max_results
class-attribute
instance-attribute
¶
max_results: int | None = ...
The maximum number of results to return in the response. If the total
number of results is greater than this value, use the token returned in
the response in the nextToken field when making another request to
return the next batch of results.
Output¶
ListAgentKnowledgeBasesOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for ListAgentKnowledgeBasesOutput structure.
Attributes¶
agent_knowledge_base_summaries
instance-attribute
¶
agent_knowledge_base_summaries: list[AgentKnowledgeBaseSummary]
A list of objects, each of which contains information about a knowledge base associated with the agent.
next_token
class-attribute
instance-attribute
¶
next_token: str | None = ...
If the total number of results is greater than the maxResults value
provided in the request, use this token when making another request in
the nextToken field to return the next batch of results.
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.