List Knowledge Base Documents

bedrockagent_list_knowledge_base_documents

R Documentation

Retrieves all the documents contained in a data source that is connected to a knowledge base

Description

Retrieves all the documents contained in a data source that is connected to a knowledge base. For more information, see Ingest documents into a knowledge base in real-time in the Amazon Bedrock User Guide.

Usage

bedrockagent_list_knowledge_base_documents(dataSourceId,
  knowledgeBaseId, maxResults, nextToken)

Arguments

dataSourceId

[required] The unique identifier of the data source that contains the documents.

knowledgeBaseId

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

maxResults

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.

nextToken

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.

Value

A list with the following syntax:

list(
  documentDetails = list(
    list(
      dataSourceId = "string",
      identifier = list(
        custom = list(
          id = "string"
        ),
        dataSourceType = "CUSTOM"|"S3",
        s3 = list(
          uri = "string"
        )
      ),
      knowledgeBaseId = "string",
      status = "INDEXED"|"PARTIALLY_INDEXED"|"PENDING"|"FAILED"|"METADATA_PARTIALLY_INDEXED"|"METADATA_UPDATE_FAILED"|"IGNORED"|"NOT_FOUND"|"STARTING"|"IN_PROGRESS"|"DELETING"|"DELETE_IN_PROGRESS",
      statusReason = "string",
      updatedAt = as.POSIXct(
        "2015-01-01"
      )
    )
  ),
  nextToken = "string"
)

Request syntax

svc$list_knowledge_base_documents(
  dataSourceId = "string",
  knowledgeBaseId = "string",
  maxResults = 123,
  nextToken = "string"
)