STARTBOTANALYZER()`¶

About StartBotAnalyzer¶

Initiates an asynchronous analysis of your bot configuration using AI-powered analysis to identify potential issues and recommend improvements based on AWS best practices.

The analysis examines your bot's configuration, including intents, utterances, slots, and conversation flows, to provide actionable recommendations for optimization.

Method Signature¶

METHODS /AWS1/IF_LM2~STARTBOTANALYZER
  IMPORTING
    !IV_BOTID TYPE /AWS1/LM2ID OPTIONAL
    !IV_ANALYSISSCOPE TYPE /AWS1/LM2ANALYSISSCOPE OPTIONAL
    !IV_LOCALEID TYPE /AWS1/LM2LOCALEID OPTIONAL
    !IV_BOTVERSION TYPE /AWS1/LM2DRAFTBOTVERSION OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_lm2startbotanlyzrrsp
  RAISING
    /AWS1/CX_LM2CONFLICTEXCEPTION
    /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 to analyze.

`iv_analysisscope` `TYPE /AWS1/LM2ANALYSISSCOPE` `/AWS1/LM2ANALYSISSCOPE`¶

The scope of analysis to perform. Currently only BotLocale scope is supported.

Valid Values: BotLocale

Optional arguments:¶

`iv_localeid` `TYPE /AWS1/LM2LOCALEID` `/AWS1/LM2LOCALEID`¶

The locale identifier for the bot locale to analyze. Required when analysisScope is BotLocale.

`iv_botversion` `TYPE /AWS1/LM2DRAFTBOTVERSION` `/AWS1/LM2DRAFTBOTVERSION`¶

The version of the bot to analyze. Defaults to DRAFT if not specified.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_lm2startbotanlyzrrsp` `/AWS1/CL_LM2STARTBOTANLYZRRSP`¶

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->startbotanalyzer(
  iv_analysisscope = |string|
  iv_botid = |string|
  iv_botversion = |string|
  iv_localeid = |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_uuid = lo_result->get_botanalyzerrequestid( ).
  lv_timestamp = lo_result->get_creationdatetime( ).
ENDIF.

/AWS1/IF_LM2=>STARTBOTANALYZER()¶