Skip to content

delete_knowledge_base

Operation

delete_knowledge_base

delete_knowledge_base(request: DeleteKnowledgeBaseInput | DeleteKnowledgeBaseInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteKnowledgeBaseInputDict]) -> DeleteKnowledgeBaseOutput

Deletes a knowledge base. Before deleting a knowledge base, you should disassociate the knowledge base from any agents that it is associated with by making a DisassociateAgentKnowledgeBase request.

Parameters:

Name Type Description Default
request DeleteKnowledgeBaseInput | DeleteKnowledgeBaseInputDict | 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[DeleteKnowledgeBaseInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DeleteKnowledgeBaseOutput

An instance of DeleteKnowledgeBaseOutput.

delete_knowledge_base async

delete_knowledge_base(request: DeleteKnowledgeBaseInput | DeleteKnowledgeBaseInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteKnowledgeBaseInputDict]) -> DeleteKnowledgeBaseOutput

Deletes a knowledge base. Before deleting a knowledge base, you should disassociate the knowledge base from any agents that it is associated with by making a DisassociateAgentKnowledgeBase request.

Parameters:

Name Type Description Default
request DeleteKnowledgeBaseInput | DeleteKnowledgeBaseInputDict | 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[DeleteKnowledgeBaseInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DeleteKnowledgeBaseOutput

An instance of DeleteKnowledgeBaseOutput.

Input

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

DeleteKnowledgeBaseInputDict

Bases: TypedDict

Dictionary form of DeleteKnowledgeBaseInput.

Attributes

knowledge_base_id instance-attribute
knowledge_base_id: Required[str]

The unique identifier of the knowledge base to delete.

DeleteKnowledgeBaseInput dataclass

Bases: _SerdeShape

Dataclass for DeleteKnowledgeBaseInput structure.

Attributes

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

The unique identifier of the knowledge base to delete.

Output

DeleteKnowledgeBaseOutput dataclass

Bases: _SerdeShape

Dataclass for DeleteKnowledgeBaseOutput structure.

Attributes

knowledge_base_id instance-attribute
knowledge_base_id: str

The unique identifier of the knowledge base that was deleted.

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.

status instance-attribute
status: str

The status of the knowledge base and whether it has been successfully deleted.