PREDICTQARESULTS()`¶

About PredictQAResults¶

Predicts existing visuals or generates new visuals to answer a given query.

This API uses trusted identity propagation to ensure that an end user is authenticated and receives the embed URL that is specific to that user. The IAM Identity Center application that the user has logged into needs to have trusted Identity Propagation enabled for QuickSight with the scope value set to quicksight:read. Before you use this action, make sure that you have configured the relevant QuickSight resource and permissions.

We recommend enabling the QSearchStatus API to unlock the full potential of PredictQnA. When QSearchStatus is enabled, it first checks the specified dashboard for any existing visuals that match the question. If no matching visuals are found, PredictQnA uses generative Q&A to provide an answer. To update the QSearchStatus, see UpdateQuickSightQSearchConfiguration.

Method Signature¶

METHODS /AWS1/IF_QST~PREDICTQARESULTS
  IMPORTING
    !IV_AWSACCOUNTID TYPE /AWS1/QSTAWSACCOUNTID OPTIONAL
    !IV_QUERYTEXT TYPE /AWS1/QSTQAQUERYTEXT OPTIONAL
    !IV_INCLUDEQUICKSIGHTQINDEX TYPE /AWS1/QSTINCLQUICKSIGHTQINDEX OPTIONAL
    !IV_INCLUDEGENERATEDANSWER TYPE /AWS1/QSTINCLGENERATEDANSWER OPTIONAL
    !IV_MAXTOPICSTOCONSIDER TYPE /AWS1/QSTMAXTOPICSTOCONSIDER OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_qstpredictqarsltsrsp
  RAISING
    /AWS1/CX_QSTACCESSDENIEDEX
    /AWS1/CX_QSTINTERNALFAILUREEX
    /AWS1/CX_QSTINVPARAMVALUEEX
    /AWS1/CX_QSTTHROTTLINGEX
    /AWS1/CX_QSTCLIENTEXC
    /AWS1/CX_QSTSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_awsaccountid` `TYPE /AWS1/QSTAWSACCOUNTID` `/AWS1/QSTAWSACCOUNTID`¶

The ID of the Amazon Web Services account that the user wants to execute Predict QA results in.

`iv_querytext` `TYPE /AWS1/QSTQAQUERYTEXT` `/AWS1/QSTQAQUERYTEXT`¶

The query text to be used to predict QA results.

Optional arguments:¶

`iv_includequicksightqindex` `TYPE /AWS1/QSTINCLQUICKSIGHTQINDEX` `/AWS1/QSTINCLQUICKSIGHTQINDEX`¶

Indicates whether Q indicies are included or excluded.

`iv_includegeneratedanswer` `TYPE /AWS1/QSTINCLGENERATEDANSWER` `/AWS1/QSTINCLGENERATEDANSWER`¶

Indicates whether generated answers are included or excluded.

`iv_maxtopicstoconsider` `TYPE /AWS1/QSTMAXTOPICSTOCONSIDER` `/AWS1/QSTMAXTOPICSTOCONSIDER`¶

The number of maximum topics to be considered to predict QA results.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_qstpredictqarsltsrsp` `/AWS1/CL_QSTPREDICTQARSLTSRSP`¶

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->predictqaresults(
  iv_awsaccountid = |string|
  iv_includegeneratedanswer = |string|
  iv_includequicksightqindex = |string|
  iv_maxtopicstoconsider = 123
  iv_querytext = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_qaresult = lo_result->get_primaryresult( ).
  IF lo_qaresult IS NOT INITIAL.
    lv_qaresulttype = lo_qaresult->get_resulttype( ).
    lo_dashboardvisualresult = lo_qaresult->get_dashboardvisual( ).
    IF lo_dashboardvisualresult IS NOT INITIAL.
      lv_shortrestrictiveresourc = lo_dashboardvisualresult->get_dashboardid( ).
      lv_dashboardname = lo_dashboardvisualresult->get_dashboardname( ).
      lv_shortrestrictiveresourc = lo_dashboardvisualresult->get_sheetid( ).
      lv_sheetname = lo_dashboardvisualresult->get_sheetname( ).
      lv_shortrestrictiveresourc = lo_dashboardvisualresult->get_visualid( ).
      lv_visualtitle = lo_dashboardvisualresult->get_visualtitle( ).
      lv_visualsubtitle = lo_dashboardvisualresult->get_visualsubtitle( ).
      lv_qaurl = lo_dashboardvisualresult->get_dashboardurl( ).
    ENDIF.
    lo_generatedanswerresult = lo_qaresult->get_generatedanswer( ).
    IF lo_generatedanswerresult IS NOT INITIAL.
      lv_qaquerytext = lo_generatedanswerresult->get_questiontext( ).
      lv_generatedanswerstatus = lo_generatedanswerresult->get_answerstatus( ).
      lv_topicid = lo_generatedanswerresult->get_topicid( ).
      lv_resourcename = lo_generatedanswerresult->get_topicname( ).
      lv_qaquerytext = lo_generatedanswerresult->get_restatement( ).
      lv_questionid = lo_generatedanswerresult->get_questionid( ).
      lv_answerid = lo_generatedanswerresult->get_answerid( ).
      lv_qaurl = lo_generatedanswerresult->get_questionurl( ).
    ENDIF.
  ENDIF.
  LOOP AT lo_result->get_additionalresults( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_qaresulttype = lo_row_1->get_resulttype( ).
      lo_dashboardvisualresult = lo_row_1->get_dashboardvisual( ).
      IF lo_dashboardvisualresult IS NOT INITIAL.
        lv_shortrestrictiveresourc = lo_dashboardvisualresult->get_dashboardid( ).
        lv_dashboardname = lo_dashboardvisualresult->get_dashboardname( ).
        lv_shortrestrictiveresourc = lo_dashboardvisualresult->get_sheetid( ).
        lv_sheetname = lo_dashboardvisualresult->get_sheetname( ).
        lv_shortrestrictiveresourc = lo_dashboardvisualresult->get_visualid( ).
        lv_visualtitle = lo_dashboardvisualresult->get_visualtitle( ).
        lv_visualsubtitle = lo_dashboardvisualresult->get_visualsubtitle( ).
        lv_qaurl = lo_dashboardvisualresult->get_dashboardurl( ).
      ENDIF.
      lo_generatedanswerresult = lo_row_1->get_generatedanswer( ).
      IF lo_generatedanswerresult IS NOT INITIAL.
        lv_qaquerytext = lo_generatedanswerresult->get_questiontext( ).
        lv_generatedanswerstatus = lo_generatedanswerresult->get_answerstatus( ).
        lv_topicid = lo_generatedanswerresult->get_topicid( ).
        lv_resourcename = lo_generatedanswerresult->get_topicname( ).
        lv_qaquerytext = lo_generatedanswerresult->get_restatement( ).
        lv_questionid = lo_generatedanswerresult->get_questionid( ).
        lv_answerid = lo_generatedanswerresult->get_answerid( ).
        lv_qaurl = lo_generatedanswerresult->get_questionurl( ).
      ENDIF.
    ENDIF.
  ENDLOOP.
  lv_string = lo_result->get_requestid( ).
  lv_statuscode = lo_result->get_status( ).
ENDIF.

/AWS1/IF_QST=>PREDICTQARESULTS()¶