Skip to content

get_agent_knowledge_base

Operation

get_agent_knowledge_base

get_agent_knowledge_base(request: GetAgentKnowledgeBaseInput | GetAgentKnowledgeBaseInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetAgentKnowledgeBaseInputDict]) -> GetAgentKnowledgeBaseOutput

Gets information about a knowledge base associated with an agent.

Parameters:

Name Type Description Default
request GetAgentKnowledgeBaseInput | GetAgentKnowledgeBaseInputDict | 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[GetAgentKnowledgeBaseInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetAgentKnowledgeBaseOutput

An instance of GetAgentKnowledgeBaseOutput.

get_agent_knowledge_base async

get_agent_knowledge_base(request: GetAgentKnowledgeBaseInput | GetAgentKnowledgeBaseInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetAgentKnowledgeBaseInputDict]) -> GetAgentKnowledgeBaseOutput

Gets information about a knowledge base associated with an agent.

Parameters:

Name Type Description Default
request GetAgentKnowledgeBaseInput | GetAgentKnowledgeBaseInputDict | 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[GetAgentKnowledgeBaseInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetAgentKnowledgeBaseOutput

An instance of GetAgentKnowledgeBaseOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

GetAgentKnowledgeBaseInputDict

Bases: TypedDict

Dictionary form of GetAgentKnowledgeBaseInput.

Attributes

agent_id instance-attribute
agent_id: Required[str]

The unique identifier of the agent with which the knowledge base is associated.

agent_version instance-attribute
agent_version: Required[str]

The version of the agent with which the knowledge base is associated.

knowledge_base_id instance-attribute
knowledge_base_id: Required[str]

The unique identifier of the knowledge base associated with the agent.

GetAgentKnowledgeBaseInput dataclass

Bases: _SerdeShape

Dataclass for GetAgentKnowledgeBaseInput structure.

Attributes

agent_id class-attribute instance-attribute
agent_id: str | None = ...

The unique identifier of the agent with which the knowledge base is associated.

agent_version class-attribute instance-attribute
agent_version: str | None = ...

The version of the agent with which the knowledge base is associated.

knowledge_base_id class-attribute instance-attribute
knowledge_base_id: str | None = ...

The unique identifier of the knowledge base associated with the agent.

Output

GetAgentKnowledgeBaseOutput dataclass

Bases: _SerdeShape

Dataclass for GetAgentKnowledgeBaseOutput structure.

Attributes

agent_knowledge_base instance-attribute
agent_knowledge_base: AgentKnowledgeBase

Contains details about a knowledge base attached to an agent.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

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.