Skip to content

get_knowledge_base

Operation

get_knowledge_base

get_knowledge_base(request: GetKnowledgeBaseInput | GetKnowledgeBaseInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetKnowledgeBaseInputDict]) -> GetKnowledgeBaseOutput

Gets information about a knowledge base.

Parameters:

Name Type Description Default
request GetKnowledgeBaseInput | GetKnowledgeBaseInputDict | 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[GetKnowledgeBaseInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetKnowledgeBaseOutput

An instance of GetKnowledgeBaseOutput.

get_knowledge_base async

get_knowledge_base(request: GetKnowledgeBaseInput | GetKnowledgeBaseInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetKnowledgeBaseInputDict]) -> GetKnowledgeBaseOutput

Gets information about a knowledge base.

Parameters:

Name Type Description Default
request GetKnowledgeBaseInput | GetKnowledgeBaseInputDict | 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[GetKnowledgeBaseInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetKnowledgeBaseOutput

An instance of GetKnowledgeBaseOutput.

Input

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

GetKnowledgeBaseInputDict

Bases: TypedDict

Dictionary form of GetKnowledgeBaseInput.

Attributes

knowledge_base_id instance-attribute
knowledge_base_id: Required[str]

The unique identifier of the knowledge base you want to get information on.

GetKnowledgeBaseInput dataclass

Bases: _SerdeShape

Dataclass for GetKnowledgeBaseInput structure.

Attributes

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

The unique identifier of the knowledge base you want to get information on.

Output

GetKnowledgeBaseOutput dataclass

Bases: _SerdeShape

Dataclass for GetKnowledgeBaseOutput structure.

Attributes

knowledge_base instance-attribute
knowledge_base: KnowledgeBase

Contains details about the knowledge base.

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.