/AWS1/IF_QQB=>CREATERETRIEVER()

About CreateRetriever

Adds a retriever to your Amazon Q Business application.

Method Signature

METHODS /AWS1/IF_QQB~CREATERETRIEVER
  IMPORTING
    !IV_APPLICATIONID TYPE /AWS1/QQBAPPLICATIONID OPTIONAL
    !IV_TYPE TYPE /AWS1/QQBRETRIEVERTYPE OPTIONAL
    !IV_DISPLAYNAME TYPE /AWS1/QQBRETRIEVERNAME OPTIONAL
    !IO_CONFIGURATION TYPE REF TO /AWS1/CL_QQBRETRIEVERCONF OPTIONAL
    !IV_ROLEARN TYPE /AWS1/QQBROLEARN OPTIONAL
    !IV_CLIENTTOKEN TYPE /AWS1/QQBCLIENTTOKEN OPTIONAL
    !IT_TAGS TYPE /AWS1/CL_QQBTAG=>TT_TAGS OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_qqbcreateretrieverrsp
  RAISING
    /AWS1/CX_QQBACCESSDENIEDEX
    /AWS1/CX_QQBCONFLICTEXCEPTION
    /AWS1/CX_QQBINTERNALSERVEREX
    /AWS1/CX_QQBRESOURCENOTFOUNDEX
    /AWS1/CX_QQBSERVICEQUOTAEXCDEX
    /AWS1/CX_QQBTHROTTLINGEX
    /AWS1/CX_QQBVALIDATIONEX
    /AWS1/CX_QQBCLIENTEXC
    /AWS1/CX_QQBSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_applicationid TYPE /AWS1/QQBAPPLICATIONID /AWS1/QQBAPPLICATIONID

The identifier of your Amazon Q Business application.

iv_type TYPE /AWS1/QQBRETRIEVERTYPE /AWS1/QQBRETRIEVERTYPE

The type of retriever you are using.

iv_displayname TYPE /AWS1/QQBRETRIEVERNAME /AWS1/QQBRETRIEVERNAME

The name of your retriever.

io_configuration TYPE REF TO /AWS1/CL_QQBRETRIEVERCONF /AWS1/CL_QQBRETRIEVERCONF

configuration

Optional arguments:

iv_rolearn TYPE /AWS1/QQBROLEARN /AWS1/QQBROLEARN

The ARN of an IAM role used by Amazon Q Business to access the basic authentication credentials stored in a Secrets Manager secret.

iv_clienttoken TYPE /AWS1/QQBCLIENTTOKEN /AWS1/QQBCLIENTTOKEN

A token that you provide to identify the request to create your Amazon Q Business application retriever.

it_tags TYPE /AWS1/CL_QQBTAG=>TT_TAGS TT_TAGS

A list of key-value pairs that identify or categorize the retriever. You can also use tags to help control access to the retriever. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.

RETURNING

oo_output TYPE REF TO /aws1/cl_qqbcreateretrieverrsp /AWS1/CL_QQBCREATERETRIEVERRSP

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->createretriever(
  io_configuration = new /aws1/cl_qqbretrieverconf(
    io_kendraindexconfiguration = new /aws1/cl_qqbkendraindexconf( |string| )
    io_nativeindexconfiguration = new /aws1/cl_qqbnativeindexconf(
      it_boostingoverride = VALUE /aws1/cl_qqbdocattrboostingc00=>tt_docattrboostingoverridemap(
        (
          VALUE /aws1/cl_qqbdocattrboostingc00=>ts_docattrboostingove00_maprow(
            key = |string|
            value = new /aws1/cl_qqbdocattrboostingc00(
              io_dateconfiguration = new /aws1/cl_qqbdateattrboosting00(
                iv_boostingdurationinseconds = 123
                iv_boostinglevel = |string|
              )
              io_numberconfiguration = new /aws1/cl_qqbnoattrboostingconf(
                iv_boostinglevel = |string|
                iv_boostingtype = |string|
              )
              io_stringconfiguration = new /aws1/cl_qqbstrattrboostingc00(
                it_attributevalueboosting = VALUE /aws1/cl_qqbstrattrvalboosti00=>tt_stringattrvalueboosting(
                  (
                    VALUE /aws1/cl_qqbstrattrvalboosti00=>ts_strattrvalueboosting_maprow(
                      key = |string|
                      value = new /aws1/cl_qqbstrattrvalboosti00( |string| )
                    )
                  )
                )
                iv_boostinglevel = |string|
              )
              io_stringlistconfiguration = new /aws1/cl_qqbstrlstattrboosti00( |string| )
            )
          )
        )
      )
      iv_indexid = |string|
      iv_version = 123
    )
  )
  it_tags = VALUE /aws1/cl_qqbtag=>tt_tags(
    (
      new /aws1/cl_qqbtag(
        iv_key = |string|
        iv_value = |string|
      )
    )
  )
  iv_applicationid = |string|
  iv_clienttoken = |string|
  iv_displayname = |string|
  iv_rolearn = |string|
  iv_type = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_retrieverid = lo_result->get_retrieverid( ).
  lv_retrieverarn = lo_result->get_retrieverarn( ).
ENDIF.