Skip to content

delete_knowledge_base_documents

Operation

delete_knowledge_base_documents

delete_knowledge_base_documents(request: DeleteKnowledgeBaseDocumentsInput | DeleteKnowledgeBaseDocumentsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteKnowledgeBaseDocumentsInputDict]) -> DeleteKnowledgeBaseDocumentsOutput

Deletes documents from a data source and syncs the changes to the knowledge base that is connected to it. For more information, see Ingest changes directly into a knowledge base in the Amazon Bedrock User Guide.

Parameters:

Name Type Description Default
request DeleteKnowledgeBaseDocumentsInput | DeleteKnowledgeBaseDocumentsInputDict | 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[DeleteKnowledgeBaseDocumentsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DeleteKnowledgeBaseDocumentsOutput

An instance of DeleteKnowledgeBaseDocumentsOutput.

delete_knowledge_base_documents async

delete_knowledge_base_documents(request: DeleteKnowledgeBaseDocumentsInput | DeleteKnowledgeBaseDocumentsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteKnowledgeBaseDocumentsInputDict]) -> DeleteKnowledgeBaseDocumentsOutput

Deletes documents from a data source and syncs the changes to the knowledge base that is connected to it. For more information, see Ingest changes directly into a knowledge base in the Amazon Bedrock User Guide.

Parameters:

Name Type Description Default
request DeleteKnowledgeBaseDocumentsInput | DeleteKnowledgeBaseDocumentsInputDict | 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[DeleteKnowledgeBaseDocumentsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DeleteKnowledgeBaseDocumentsOutput

An instance of DeleteKnowledgeBaseDocumentsOutput.

Input

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

DeleteKnowledgeBaseDocumentsInputDict

Bases: TypedDict

Dictionary form of DeleteKnowledgeBaseDocumentsInput.

Attributes

client_token instance-attribute
client_token: str | None

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.

This field is autopopulated if not provided.

data_source_id instance-attribute
data_source_id: Required[str]

The unique identifier of the data source that contains the documents.

document_identifiers instance-attribute

A list of objects, each of which contains information to identify a document to delete.

knowledge_base_id instance-attribute
knowledge_base_id: Required[str]

The unique identifier of the knowledge base that is connected to the data source.

DeleteKnowledgeBaseDocumentsInput dataclass

Bases: _SerdeShape

Dataclass for DeleteKnowledgeBaseDocumentsInput structure.

Attributes

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

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.

This field is autopopulated if not provided.

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

The unique identifier of the data source that contains the documents.

document_identifiers class-attribute instance-attribute
document_identifiers: list[DocumentIdentifier] | None = ...

A list of objects, each of which contains information to identify a document to delete.

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

The unique identifier of the knowledge base that is connected to the data source.

Output

DeleteKnowledgeBaseDocumentsOutput dataclass

Bases: _SerdeShape

Dataclass for DeleteKnowledgeBaseDocumentsOutput structure.

Attributes

document_details class-attribute instance-attribute
document_details: list[KnowledgeBaseDocumentDetail] | None = ...

A list of objects, each of which contains information about the documents that were 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.