Skip to content

/AWS1/IF_LM2=>LISTRECOMMENDEDINTENTS()

About ListRecommendedIntents

Gets a list of recommended intents provided by the bot recommendation that you can use in your bot. Intents in the response are ordered by relevance.

Method Signature

METHODS /AWS1/IF_LM2~LISTRECOMMENDEDINTENTS
  IMPORTING
    !IV_BOTID TYPE /AWS1/LM2ID OPTIONAL
    !IV_BOTVERSION TYPE /AWS1/LM2DRAFTBOTVERSION OPTIONAL
    !IV_LOCALEID TYPE /AWS1/LM2LOCALEID OPTIONAL
    !IV_BOTRECOMMENDATIONID TYPE /AWS1/LM2ID OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/LM2NEXTTOKEN OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/LM2MAXRESULTS OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_lm2lstrecommendedin01
  RAISING
    /AWS1/CX_LM2INTERNALSERVEREX
    /AWS1/CX_LM2RESOURCENOTFOUNDEX
    /AWS1/CX_LM2SERVICEQUOTAEXCDEX
    /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 associated with the recommended intents.

iv_botversion TYPE /AWS1/LM2DRAFTBOTVERSION /AWS1/LM2DRAFTBOTVERSION

The version of the bot that contains the recommended intents.

iv_localeid TYPE /AWS1/LM2LOCALEID /AWS1/LM2LOCALEID

The identifier of the language and locale of the recommended intents.

iv_botrecommendationid TYPE /AWS1/LM2ID /AWS1/LM2ID

The identifier of the bot recommendation that contains the recommended intents.

Optional arguments:

iv_nexttoken TYPE /AWS1/LM2NEXTTOKEN /AWS1/LM2NEXTTOKEN

If the response from the ListRecommendedIntents operation contains more results than specified in the maxResults parameter, a token is returned in the response. Use that token in the nextToken parameter to return the next page of results.

iv_maxresults TYPE /AWS1/LM2MAXRESULTS /AWS1/LM2MAXRESULTS

The maximum number of bot recommendations to return in each page of results. If there are fewer results than the max page size, only the actual number of results are returned.

RETURNING

oo_output TYPE REF TO /aws1/cl_lm2lstrecommendedin01 /AWS1/CL_LM2LSTRECOMMENDEDIN01

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->listrecommendedintents(
  iv_botid = |string|
  iv_botrecommendationid = |string|
  iv_botversion = |string|
  iv_localeid = |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_id = lo_result->get_botrecommendationid( ).
  LOOP AT lo_result->get_summarylist( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_id = lo_row_1->get_intentid( ).
      lv_name = lo_row_1->get_intentname( ).
      lv_sampleutterancescount = lo_row_1->get_sampleutterancescount( ).
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
ENDIF.