delete_knowledge_base_documents¶
Operation¶
async
¶
delete_knowledge_base_documents(input: DeleteKnowledgeBaseDocumentsInput, plugins: list[Plugin] | None = None) -> 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 |
|---|---|---|---|
input
|
DeleteKnowledgeBaseDocumentsInput
|
An instance of |
required |
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
|
Returns:
| Type | Description |
|---|---|
DeleteKnowledgeBaseDocumentsOutput
|
An instance of |
Input¶
dataclass
¶
Dataclass for DeleteKnowledgeBaseDocumentsInput structure.
Attributes¶
class-attribute
instance-attribute
¶
client_token: str | None = 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.
class-attribute
instance-attribute
¶
data_source_id: str | None = None
The unique identifier of the data source that contains the documents.
class-attribute
instance-attribute
¶
document_identifiers: list[DocumentIdentifier] | None = None
A list of objects, each of which contains information to identify a document to delete.
class-attribute
instance-attribute
¶
knowledge_base_id: str | None = None
The unique identifier of the knowledge base that is connected to the data source.
Output¶
dataclass
¶
Dataclass for DeleteKnowledgeBaseDocumentsOutput structure.
Attributes¶
class-attribute
instance-attribute
¶
document_details: list[KnowledgeBaseDocumentDetail] | None = None
A list of objects, each of which contains information about the documents that were deleted.