Get Knowledge Base Documents

bedrockagent_get_knowledge_base_documents

R Documentation

Retrieves specific documents from a data source that is connected to a knowledge base

Description

Retrieves specific documents from 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_get_knowledge_base_documents(dataSourceId,
  documentIdentifiers, knowledgeBaseId)

Arguments

dataSourceId

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

documentIdentifiers

[required] A list of objects, each of which contains information to identify a document for which to retrieve information.

knowledgeBaseId

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

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"
      )
    )
  )
)

Request syntax

svc$get_knowledge_base_documents(
  dataSourceId = "string",
  documentIdentifiers = list(
    list(
      custom = list(
        id = "string"
      ),
      dataSourceType = "CUSTOM"|"S3",
      s3 = list(
        uri = "string"
      )
    )
  ),
  knowledgeBaseId = "string"
)