list_knowledge_base_documents¶
Operation¶
async
¶
list_knowledge_base_documents(input: ListKnowledgeBaseDocumentsInput, plugins: list[Plugin] | None = None) -> ListKnowledgeBaseDocumentsOutput
Retrieves all the documents contained in a data source that is connected to a knowledge base. For more information, see Ingest changes directly into a knowledge base in the Amazon Bedrock User Guide.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
ListKnowledgeBaseDocumentsInput
|
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 |
|---|---|
ListKnowledgeBaseDocumentsOutput
|
An instance of |
Input¶
dataclass
¶
Dataclass for ListKnowledgeBaseDocumentsInput structure.
Attributes¶
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
¶
knowledge_base_id: str | None = None
The unique identifier of the knowledge base that is connected to the data source.
class-attribute
instance-attribute
¶
max_results: int | None = None
The maximum number of results to return in the response. If the total
number of results is greater than this value, use the token returned in
the response in the nextToken field when making another request to
return the next batch of results.
class-attribute
instance-attribute
¶
next_token: str | None = None
If the total number of results is greater than the maxResults value
provided in the request, enter the token returned in the nextToken
field in the response in this field to return the next batch of results.
Output¶
dataclass
¶
Dataclass for ListKnowledgeBaseDocumentsOutput structure.
Attributes¶
instance-attribute
¶
document_details: list[KnowledgeBaseDocumentDetail]
A list of objects, each of which contains information about the documents that were retrieved.
class-attribute
instance-attribute
¶
next_token: str | None = None
If the total number of results is greater than the maxResults value
provided in the request, use this token when making another request in
the nextToken field to return the next batch of results.