Skip to content

delete_data_source

Operation

delete_data_source

delete_data_source(request: DeleteDataSourceInput | DeleteDataSourceInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteDataSourceInputDict]) -> DeleteDataSourceOutput

Deletes a data source from a knowledge base.

Parameters:

Name Type Description Default
request DeleteDataSourceInput | DeleteDataSourceInputDict | 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[DeleteDataSourceInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DeleteDataSourceOutput

An instance of DeleteDataSourceOutput.

delete_data_source async

delete_data_source(request: DeleteDataSourceInput | DeleteDataSourceInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteDataSourceInputDict]) -> DeleteDataSourceOutput

Deletes a data source from a knowledge base.

Parameters:

Name Type Description Default
request DeleteDataSourceInput | DeleteDataSourceInputDict | 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[DeleteDataSourceInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DeleteDataSourceOutput

An instance of DeleteDataSourceOutput.

Input

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

DeleteDataSourceInputDict

Bases: TypedDict

Dictionary form of DeleteDataSourceInput.

Attributes

data_source_id instance-attribute
data_source_id: Required[str]

The unique identifier of the data source to delete.

knowledge_base_id instance-attribute
knowledge_base_id: Required[str]

The unique identifier of the knowledge base from which to delete the data source.

DeleteDataSourceInput dataclass

Bases: _SerdeShape

Dataclass for DeleteDataSourceInput structure.

Attributes

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

The unique identifier of the data source to delete.

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

The unique identifier of the knowledge base from which to delete the data source.

Output

DeleteDataSourceOutput dataclass

Bases: _SerdeShape

Dataclass for DeleteDataSourceOutput structure.

Attributes

data_source_id instance-attribute
data_source_id: str

The unique identifier of the data source that was deleted.

knowledge_base_id instance-attribute
knowledge_base_id: str

The unique identifier of the knowledge base to which the data source that was deleted belonged.

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 data source.