DESCRIBEBOTANALYZERREC()`¶

About DescribeBotAnalyzerRecommendation¶

Retrieves the analysis results and recommendations for bot optimization. The analysis must be in Available status before recommendations can be retrieved.

Recommendations are returned with pagination support. Each recommendation includes the issue location, priority level, detailed description, and proposed fix.

Method Signature¶

METHODS /AWS1/IF_LM2~DESCRIBEBOTANALYZERREC
  IMPORTING
    !IV_BOTID TYPE /AWS1/LM2ID OPTIONAL
    !IV_BOTANALYZERREQUESTID TYPE /AWS1/LM2UUID OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/LM2NEXTTOKEN OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/LM2MAXRESULTS OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_lm2dscbotanlzrecrsp
  RAISING
    /AWS1/CX_LM2INTERNALSERVEREX
    /AWS1/CX_LM2RESOURCENOTFOUNDEX
    /AWS1/CX_LM2THROTTLINGEX
    /AWS1/CX_LM2VALIDATIONEX
    /AWS1/CX_LM2CLIENTEXC
    /AWS1/CX_LM2SERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_botid` `TYPE /AWS1/LM2ID` `/AWS1/LM2ID`¶

The unique identifier of the bot.

`iv_botanalyzerrequestid` `TYPE /AWS1/LM2UUID` `/AWS1/LM2UUID`¶

The unique identifier of the analysis request.

Optional arguments:¶

`iv_nexttoken` `TYPE /AWS1/LM2NEXTTOKEN` `/AWS1/LM2NEXTTOKEN`¶

If the response from a previous request was truncated, the nextToken value is used to retrieve the next page of recommendations.

`iv_maxresults` `TYPE /AWS1/LM2MAXRESULTS` `/AWS1/LM2MAXRESULTS`¶

The maximum number of recommendations to return in the response. The default is 5.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_lm2dscbotanlzrecrsp` `/AWS1/CL_LM2DSCBOTANLZRECRSP`¶

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->describebotanalyzerrec(
  iv_botanalyzerrequestid = |string|
  iv_botid = |string|
  iv_maxresults = 123
  iv_nexttoken = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_id = lo_result->get_botid( ).
  lv_draftbotversion = lo_result->get_botversion( ).
  lv_localeid = lo_result->get_localeid( ).
  lv_botanalyzerstatus = lo_result->get_botanalyzerstatus( ).
  lv_timestamp = lo_result->get_creationdatetime( ).
  LOOP AT lo_result->get_botanalyzerreclist( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lo_issuelocation = lo_row_1->get_issuelocation( ).
      IF lo_issuelocation IS NOT INITIAL.
        lv_localeid = lo_issuelocation->get_botlocale( ).
        lv_id = lo_issuelocation->get_intentid( ).
        lv_id = lo_issuelocation->get_slotid( ).
      ENDIF.
      lv_priority = lo_row_1->get_priority( ).
      lv_description = lo_row_1->get_issuedescription( ).
      lv_description = lo_row_1->get_proposedfix( ).
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
ENDIF.

/AWS1/IF_LM2=>DESCRIBEBOTANALYZERREC()¶