Skip to content

/AWS1/CL_QQB=>GETCHATRESPONSECONFIGURATION()

About GetChatResponseConfiguration

Retrieves detailed information about a specific chat response configuration from an Amazon Q Business application. This operation returns the complete configuration settings and metadata.

Method Signature

IMPORTING

Required arguments:

iv_applicationid TYPE /AWS1/QQBAPPLICATIONID /AWS1/QQBAPPLICATIONID

The unique identifier of the Amazon Q Business application containing the chat response configuration to retrieve.

iv_chatresponseconfid TYPE /AWS1/QQBCHATRESPONSECONFID /AWS1/QQBCHATRESPONSECONFID

The unique identifier of the chat response configuration to retrieve from the specified application.

RETURNING

oo_output TYPE REF TO /aws1/cl_qqbgetchatrspconfrsp /AWS1/CL_QQBGETCHATRSPCONFRSP

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->/aws1/if_qqb~getchatresponseconfiguration(
  iv_applicationid = |string|
  iv_chatresponseconfid = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_chatresponseconfigurati = lo_result->get_chatresponseconfid( ).
  lv_chatresponseconfigurati_1 = lo_result->get_chatresponseconfarn( ).
  lv_displayname = lo_result->get_displayname( ).
  lv_timestamp = lo_result->get_createdat( ).
  lo_chatresponseconfigurati_2 = lo_result->get_inuseconfiguration( ).
  IF lo_chatresponseconfigurati_2 IS NOT INITIAL.
    LOOP AT lo_chatresponseconfigurati_2->get_responseconfigurations( ) into ls_row.
      lv_key = ls_row-key.
      lo_value = ls_row-value.
      IF lo_value IS NOT INITIAL.
        lo_instructioncollection = lo_value->get_instructioncollection( ).
        IF lo_instructioncollection IS NOT INITIAL.
          lv_instruction = lo_instructioncollection->get_responselength( ).
          lv_instruction = lo_instructioncollection->get_targetaudience( ).
          lv_instruction = lo_instructioncollection->get_perspective( ).
          lv_instruction = lo_instructioncollection->get_outputstyle( ).
          lv_instruction = lo_instructioncollection->get_identity( ).
          lv_instruction = lo_instructioncollection->get_tone( ).
          lv_instruction = lo_instructioncollection->get_custominstructions( ).
          lv_instruction = lo_instructioncollection->get_examples( ).
        ENDIF.
      ENDIF.
    ENDLOOP.
    lv_string = lo_chatresponseconfigurati_2->get_responseconfsummary( ).
    lv_chatresponseconfigurati_3 = lo_chatresponseconfigurati_2->get_status( ).
    lo_errordetail = lo_chatresponseconfigurati_2->get_error( ).
    IF lo_errordetail IS NOT INITIAL.
      lv_errormessage = lo_errordetail->get_errormessage( ).
      lv_errorcode = lo_errordetail->get_errorcode( ).
    ENDIF.
    lv_timestamp = lo_chatresponseconfigurati_2->get_updatedat( ).
  ENDIF.
  lo_chatresponseconfigurati_2 = lo_result->get_lastupdateconfiguration( ).
  IF lo_chatresponseconfigurati_2 IS NOT INITIAL.
    LOOP AT lo_chatresponseconfigurati_2->get_responseconfigurations( ) into ls_row.
      lv_key = ls_row-key.
      lo_value = ls_row-value.
      IF lo_value IS NOT INITIAL.
        lo_instructioncollection = lo_value->get_instructioncollection( ).
        IF lo_instructioncollection IS NOT INITIAL.
          lv_instruction = lo_instructioncollection->get_responselength( ).
          lv_instruction = lo_instructioncollection->get_targetaudience( ).
          lv_instruction = lo_instructioncollection->get_perspective( ).
          lv_instruction = lo_instructioncollection->get_outputstyle( ).
          lv_instruction = lo_instructioncollection->get_identity( ).
          lv_instruction = lo_instructioncollection->get_tone( ).
          lv_instruction = lo_instructioncollection->get_custominstructions( ).
          lv_instruction = lo_instructioncollection->get_examples( ).
        ENDIF.
      ENDIF.
    ENDLOOP.
    lv_string = lo_chatresponseconfigurati_2->get_responseconfsummary( ).
    lv_chatresponseconfigurati_3 = lo_chatresponseconfigurati_2->get_status( ).
    lo_errordetail = lo_chatresponseconfigurati_2->get_error( ).
    IF lo_errordetail IS NOT INITIAL.
      lv_errormessage = lo_errordetail->get_errormessage( ).
      lv_errorcode = lo_errordetail->get_errorcode( ).
    ENDIF.
    lv_timestamp = lo_chatresponseconfigurati_2->get_updatedat( ).
  ENDIF.
ENDIF.