RETRIEVE()`¶

About Retrieve¶

Retrieves content from knowledge sources based on a query.

Method Signature¶

METHODS /AWS1/IF_QQC~RETRIEVE
  IMPORTING
    !IV_ASSISTANTID TYPE /AWS1/QQCUUIDORARN OPTIONAL
    !IO_RETRIEVALCONFIGURATION TYPE REF TO /AWS1/CL_QQCRETRIEVALCONF OPTIONAL
    !IV_RETRIEVALQUERY TYPE /AWS1/QQCNONEMPTYSENSITIVESTR OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_qqcretrieveresponse
  RAISING
    /AWS1/CX_QQCACCESSDENIEDEX
    /AWS1/CX_QQCCONFLICTEXCEPTION
    /AWS1/CX_QQCDEPENDENCYFAILEDEX
    /AWS1/CX_QQCREQUESTTIMEOUTEX
    /AWS1/CX_QQCRESOURCENOTFOUNDEX
    /AWS1/CX_QQCSERVICEQUOTAEXCDEX
    /AWS1/CX_QQCTHROTTLINGEX
    /AWS1/CX_QQCVALIDATIONEX
    /AWS1/CX_QQCCLIENTEXC
    /AWS1/CX_QQCSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_assistantid` `TYPE /AWS1/QQCUUIDORARN` `/AWS1/QQCUUIDORARN`¶

The identifier of the Amazon Q in Connect assistant for content retrieval.

`io_retrievalconfiguration` `TYPE REF TO /AWS1/CL_QQCRETRIEVALCONF` `/AWS1/CL_QQCRETRIEVALCONF`¶

The configuration for the content retrieval operation.

`iv_retrievalquery` `TYPE /AWS1/QQCNONEMPTYSENSITIVESTR` `/AWS1/QQCNONEMPTYSENSITIVESTR`¶

The query for content retrieval.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_qqcretrieveresponse` `/AWS1/CL_QQCRETRIEVERESPONSE`¶

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->retrieve(
  io_retrievalconfiguration = new /aws1/cl_qqcretrievalconf(
    io_filter = new /aws1/cl_qqcretrievalfiltconf(
      io_equals = new /aws1/cl_qqcfilterattribute(
        io_value = /AWS1/CL_RT_DOCUMENT=>FROM_JSON_STR( |\{"foo":"this is a JSON object..."\}| )
        iv_key = |string|
      )
      io_greaterthan = new /aws1/cl_qqcfilterattribute(
        io_value = /AWS1/CL_RT_DOCUMENT=>FROM_JSON_STR( |\{"foo":"this is a JSON object..."\}| )
        iv_key = |string|
      )
      io_greaterthanorequals = new /aws1/cl_qqcfilterattribute(
        io_value = /AWS1/CL_RT_DOCUMENT=>FROM_JSON_STR( |\{"foo":"this is a JSON object..."\}| )
        iv_key = |string|
      )
      io_in = new /aws1/cl_qqcfilterattribute(
        io_value = /AWS1/CL_RT_DOCUMENT=>FROM_JSON_STR( |\{"foo":"this is a JSON object..."\}| )
        iv_key = |string|
      )
      io_lessthan = new /aws1/cl_qqcfilterattribute(
        io_value = /AWS1/CL_RT_DOCUMENT=>FROM_JSON_STR( |\{"foo":"this is a JSON object..."\}| )
        iv_key = |string|
      )
      io_lessthanorequals = new /aws1/cl_qqcfilterattribute(
        io_value = /AWS1/CL_RT_DOCUMENT=>FROM_JSON_STR( |\{"foo":"this is a JSON object..."\}| )
        iv_key = |string|
      )
      io_listcontains = new /aws1/cl_qqcfilterattribute(
        io_value = /AWS1/CL_RT_DOCUMENT=>FROM_JSON_STR( |\{"foo":"this is a JSON object..."\}| )
        iv_key = |string|
      )
      io_notequals = new /aws1/cl_qqcfilterattribute(
        io_value = /AWS1/CL_RT_DOCUMENT=>FROM_JSON_STR( |\{"foo":"this is a JSON object..."\}| )
        iv_key = |string|
      )
      io_notin = new /aws1/cl_qqcfilterattribute(
        io_value = /AWS1/CL_RT_DOCUMENT=>FROM_JSON_STR( |\{"foo":"this is a JSON object..."\}| )
        iv_key = |string|
      )
      io_startswith = new /aws1/cl_qqcfilterattribute(
        io_value = /AWS1/CL_RT_DOCUMENT=>FROM_JSON_STR( |\{"foo":"this is a JSON object..."\}| )
        iv_key = |string|
      )
      io_stringcontains = new /aws1/cl_qqcfilterattribute(
        io_value = /AWS1/CL_RT_DOCUMENT=>FROM_JSON_STR( |\{"foo":"this is a JSON object..."\}| )
        iv_key = |string|
      )
      it_andall = VALUE /aws1/cl_qqcretrievalfiltconf=>tt_retrievalfilterlist(
        (
          new /aws1/cl_qqcretrievalfiltconf(
            io_equals = new /aws1/cl_qqcfilterattribute(
              io_value = /AWS1/CL_RT_DOCUMENT=>FROM_JSON_STR( |\{"foo":"this is a JSON object..."\}| )
              iv_key = |string|
            )
            io_greaterthan = new /aws1/cl_qqcfilterattribute(
              io_value = /AWS1/CL_RT_DOCUMENT=>FROM_JSON_STR( |\{"foo":"this is a JSON object..."\}| )
              iv_key = |string|
            )
            io_greaterthanorequals = new /aws1/cl_qqcfilterattribute(
              io_value = /AWS1/CL_RT_DOCUMENT=>FROM_JSON_STR( |\{"foo":"this is a JSON object..."\}| )
              iv_key = |string|
            )
            io_in = new /aws1/cl_qqcfilterattribute(
              io_value = /AWS1/CL_RT_DOCUMENT=>FROM_JSON_STR( |\{"foo":"this is a JSON object..."\}| )
              iv_key = |string|
            )
            io_lessthan = new /aws1/cl_qqcfilterattribute(
              io_value = /AWS1/CL_RT_DOCUMENT=>FROM_JSON_STR( |\{"foo":"this is a JSON object..."\}| )
              iv_key = |string|
            )
            io_lessthanorequals = new /aws1/cl_qqcfilterattribute(
              io_value = /AWS1/CL_RT_DOCUMENT=>FROM_JSON_STR( |\{"foo":"this is a JSON object..."\}| )
              iv_key = |string|
            )
            io_listcontains = new /aws1/cl_qqcfilterattribute(
              io_value = /AWS1/CL_RT_DOCUMENT=>FROM_JSON_STR( |\{"foo":"this is a JSON object..."\}| )
              iv_key = |string|
            )
            io_notequals = new /aws1/cl_qqcfilterattribute(
              io_value = /AWS1/CL_RT_DOCUMENT=>FROM_JSON_STR( |\{"foo":"this is a JSON object..."\}| )
              iv_key = |string|
            )
            io_notin = new /aws1/cl_qqcfilterattribute(
              io_value = /AWS1/CL_RT_DOCUMENT=>FROM_JSON_STR( |\{"foo":"this is a JSON object..."\}| )
              iv_key = |string|
            )
            io_startswith = new /aws1/cl_qqcfilterattribute(
              io_value = /AWS1/CL_RT_DOCUMENT=>FROM_JSON_STR( |\{"foo":"this is a JSON object..."\}| )
              iv_key = |string|
            )
            io_stringcontains = new /aws1/cl_qqcfilterattribute(
              io_value = /AWS1/CL_RT_DOCUMENT=>FROM_JSON_STR( |\{"foo":"this is a JSON object..."\}| )
              iv_key = |string|
            )
            it_orall = VALUE /aws1/cl_qqcretrievalfiltconf=>tt_retrievalfilterlist(
            )
          )
        )
      )
      it_orall = VALUE /aws1/cl_qqcretrievalfiltconf=>tt_retrievalfilterlist(
        (
          new /aws1/cl_qqcretrievalfiltconf(
            io_equals = new /aws1/cl_qqcfilterattribute(
              io_value = /AWS1/CL_RT_DOCUMENT=>FROM_JSON_STR( |\{"foo":"this is a JSON object..."\}| )
              iv_key = |string|
            )
            io_greaterthan = new /aws1/cl_qqcfilterattribute(
              io_value = /AWS1/CL_RT_DOCUMENT=>FROM_JSON_STR( |\{"foo":"this is a JSON object..."\}| )
              iv_key = |string|
            )
            io_greaterthanorequals = new /aws1/cl_qqcfilterattribute(
              io_value = /AWS1/CL_RT_DOCUMENT=>FROM_JSON_STR( |\{"foo":"this is a JSON object..."\}| )
              iv_key = |string|
            )
            io_in = new /aws1/cl_qqcfilterattribute(
              io_value = /AWS1/CL_RT_DOCUMENT=>FROM_JSON_STR( |\{"foo":"this is a JSON object..."\}| )
              iv_key = |string|
            )
            io_lessthan = new /aws1/cl_qqcfilterattribute(
              io_value = /AWS1/CL_RT_DOCUMENT=>FROM_JSON_STR( |\{"foo":"this is a JSON object..."\}| )
              iv_key = |string|
            )
            io_lessthanorequals = new /aws1/cl_qqcfilterattribute(
              io_value = /AWS1/CL_RT_DOCUMENT=>FROM_JSON_STR( |\{"foo":"this is a JSON object..."\}| )
              iv_key = |string|
            )
            io_listcontains = new /aws1/cl_qqcfilterattribute(
              io_value = /AWS1/CL_RT_DOCUMENT=>FROM_JSON_STR( |\{"foo":"this is a JSON object..."\}| )
              iv_key = |string|
            )
            io_notequals = new /aws1/cl_qqcfilterattribute(
              io_value = /AWS1/CL_RT_DOCUMENT=>FROM_JSON_STR( |\{"foo":"this is a JSON object..."\}| )
              iv_key = |string|
            )
            io_notin = new /aws1/cl_qqcfilterattribute(
              io_value = /AWS1/CL_RT_DOCUMENT=>FROM_JSON_STR( |\{"foo":"this is a JSON object..."\}| )
              iv_key = |string|
            )
            io_startswith = new /aws1/cl_qqcfilterattribute(
              io_value = /AWS1/CL_RT_DOCUMENT=>FROM_JSON_STR( |\{"foo":"this is a JSON object..."\}| )
              iv_key = |string|
            )
            io_stringcontains = new /aws1/cl_qqcfilterattribute(
              io_value = /AWS1/CL_RT_DOCUMENT=>FROM_JSON_STR( |\{"foo":"this is a JSON object..."\}| )
              iv_key = |string|
            )
            it_andall = VALUE /aws1/cl_qqcretrievalfiltconf=>tt_retrievalfilterlist(
            )
          )
        )
      )
    )
    io_knowledgesource = new /aws1/cl_qqcknowledgesource(
      it_assistantassociationids = VALUE /aws1/cl_qqcassistantascidls00=>tt_assistantassociationidlist(
        ( new /aws1/cl_qqcassistantascidls00( |string| ) )
      )
    )
    iv_numberofresults = 123
    iv_overrideknowledgebasesr00 = |string|
  )
  iv_assistantid = |string|
  iv_retrievalquery = |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_results( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_uuid = lo_row_1->get_associationid( ).
      lv_sensitivestring = lo_row_1->get_sourceid( ).
      lv_referencetype = lo_row_1->get_referencetype( ).
      lv_sensitivestring = lo_row_1->get_contenttext( ).
    ENDIF.
  ENDLOOP.
ENDIF.

/AWS1/IF_QQC=>RETRIEVE()¶