INGESTKNOWLEDGEBASEDOCUMENTS()`¶

About IngestKnowledgeBaseDocuments¶

Ingests documents directly into the knowledge base that is connected to the data source. The dataSourceType specified in the content for each document must match the type of the data source that you specify in the header. For more information, see Ingest changes directly into a knowledge base in the Amazon Bedrock User Guide.

Method Signature¶

METHODS /AWS1/IF_BDA~INGESTKNOWLEDGEBASEDOCUMENTS
  IMPORTING
    !IV_KNOWLEDGEBASEID TYPE /AWS1/BDAID OPTIONAL
    !IV_DATASOURCEID TYPE /AWS1/BDAID OPTIONAL
    !IV_CLIENTTOKEN TYPE /AWS1/BDACLIENTTOKEN OPTIONAL
    !IT_DOCUMENTS TYPE /AWS1/CL_BDAKNOWLEDGEBASEDOC=>TT_KNOWLEDGEBASEDOCUMENTS OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_bdaingestknowledgeb01
  RAISING
    /AWS1/CX_BDAACCESSDENIEDEX
    /AWS1/CX_BDAINTERNALSERVEREX
    /AWS1/CX_BDARESOURCENOTFOUNDEX
    /AWS1/CX_BDASERVICEQUOTAEXCDEX
    /AWS1/CX_BDATHROTTLINGEX
    /AWS1/CX_BDAVALIDATIONEX
    /AWS1/CX_BDACLIENTEXC
    /AWS1/CX_BDASERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_knowledgebaseid` `TYPE /AWS1/BDAID` `/AWS1/BDAID`¶

The unique identifier of the knowledge base to ingest the documents into.

`iv_datasourceid` `TYPE /AWS1/BDAID` `/AWS1/BDAID`¶

The unique identifier of the data source connected to the knowledge base that you're adding documents to.

`it_documents` `TYPE /AWS1/CL_BDAKNOWLEDGEBASEDOC=>TT_KNOWLEDGEBASEDOCUMENTS` `TT_KNOWLEDGEBASEDOCUMENTS`¶

A list of objects, each of which contains information about the documents to add.

Optional arguments:¶

`iv_clienttoken` `TYPE /AWS1/BDACLIENTTOKEN` `/AWS1/BDACLIENTTOKEN`¶

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.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_bdaingestknowledgeb01` `/AWS1/CL_BDAINGESTKNOWLEDGEB01`¶

Domain /AWS1/RT_ACCOUNT_ID

Primitive Type NUMC

Examples¶

Syntax Example¶

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->ingestknowledgebasedocuments(
  it_documents = VALUE /aws1/cl_bdaknowledgebasedoc=>tt_knowledgebasedocuments(
    (
      new /aws1/cl_bdaknowledgebasedoc(
        io_content = new /aws1/cl_bdadocumentcontent(
          io_custom = new /aws1/cl_bdacustomcontent(
            io_customdocumentidentifier = new /aws1/cl_bdacustomdocumentid( |string| )
            io_inlinecontent = new /aws1/cl_bdainlinecontent(
              io_bytecontent = new /aws1/cl_bdabytecontentdoc(
                iv_data = '5347567362473873563239796247513D'
                iv_mimetype = |string|
              )
              io_textcontent = new /aws1/cl_bdatextcontentdoc( |string| )
              iv_type = |string|
            )
            io_s3location = new /aws1/cl_bdacustoms3location(
              iv_bucketowneraccountid = |string|
              iv_uri = |string|
            )
            iv_sourcetype = |string|
          )
          io_s3 = new /aws1/cl_bdas3content( new /aws1/cl_bdas3location( |string| ) )
          iv_datasourcetype = |string|
        )
        io_metadata = new /aws1/cl_bdadocumentmetadata(
          io_s3location = new /aws1/cl_bdacustoms3location(
            iv_bucketowneraccountid = |string|
            iv_uri = |string|
          )
          it_inlineattributes = VALUE /aws1/cl_bdametadataattribute=>tt_metadataattributes(
            (
              new /aws1/cl_bdametadataattribute(
                io_value = new /aws1/cl_bdametadataattrvalue(
                  it_stringlistvalue = VALUE /aws1/cl_bdastringlistvalue_w=>tt_stringlistvalue(
                    ( new /aws1/cl_bdastringlistvalue_w( |string| ) )
                  )
                  iv_booleanvalue = ABAP_TRUE
                  iv_numbervalue = '0.1'
                  iv_stringvalue = |string|
                  iv_type = |string|
                )
                iv_key = |string|
              )
            )
          )
          iv_type = |string|
        )
      )
    )
  )
  iv_clienttoken = |string|
  iv_datasourceid = |string|
  iv_knowledgebaseid = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  LOOP AT lo_result->get_documentdetails( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_id = lo_row_1->get_knowledgebaseid( ).
      lv_id = lo_row_1->get_datasourceid( ).
      lv_documentstatus = lo_row_1->get_status( ).
      lo_documentidentifier = lo_row_1->get_identifier( ).
      IF lo_documentidentifier IS NOT INITIAL.
        lv_contentdatasourcetype = lo_documentidentifier->get_datasourcetype( ).
        lo_s3location = lo_documentidentifier->get_s3( ).
        IF lo_s3location IS NOT INITIAL.
          lv_s3bucketuri = lo_s3location->get_uri( ).
        ENDIF.
        lo_customdocumentidentifie = lo_documentidentifier->get_custom( ).
        IF lo_customdocumentidentifie IS NOT INITIAL.
          lv_string = lo_customdocumentidentifie->get_id( ).
        ENDIF.
      ENDIF.
      lv_string = lo_row_1->get_statusreason( ).
      lv_datetimestamp = lo_row_1->get_updatedat( ).
    ENDIF.
  ENDLOOP.
ENDIF.

/AWS1/IF_BDA=>INGESTKNOWLEDGEBASEDOCUMENTS()¶