/AWS1/IF_QQC=>GETAIAGENT()¶
About GetAIAgent¶
Gets an Amazon Q in Connect AI Agent.
Method Signature¶
METHODS /AWS1/IF_QQC~GETAIAGENT
IMPORTING
!IV_ASSISTANTID TYPE /AWS1/QQCUUIDORARN OPTIONAL
!IV_AIAGENTID TYPE /AWS1/QQCUUIDORARNOREITHERWQ00 OPTIONAL
RETURNING
VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_qqcgetaiagentresponse
RAISING
/AWS1/CX_QQCACCESSDENIEDEX
/AWS1/CX_QQCRESOURCENOTFOUNDEX
/AWS1/CX_QQCTHROTTLINGEX
/AWS1/CX_QQCUNAUTHORIZEDEX
/AWS1/CX_QQCVALIDATIONEX
/AWS1/CX_QQCCLIENTEXC
/AWS1/CX_QQCSERVEREXC
/AWS1/CX_RT_TECHNICAL_GENERIC
/AWS1/CX_RT_SERVICE_GENERIC.
IMPORTING¶
Required arguments:¶
iv_assistantid TYPE /AWS1/QQCUUIDORARN /AWS1/QQCUUIDORARN¶
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
iv_aiagentid TYPE /AWS1/QQCUUIDORARNOREITHERWQ00 /AWS1/QQCUUIDORARNOREITHERWQ00¶
The identifier of the Amazon Q in Connect AI Agent (with or without a version qualifier). Can be either the ID or the ARN. URLs cannot contain the ARN.
RETURNING¶
oo_output TYPE REF TO /aws1/cl_qqcgetaiagentresponse /AWS1/CL_QQCGETAIAGENTRESPONSE¶
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->getaiagent(
iv_aiagentid = |string|
iv_assistantid = |string|
).
This is an example of reading all possible response values
lo_result = lo_result.
IF lo_result IS NOT INITIAL.
lo_aiagentdata = lo_result->get_aiagent( ).
IF lo_aiagentdata IS NOT INITIAL.
lv_uuid = lo_aiagentdata->get_assistantid( ).
lv_arn = lo_aiagentdata->get_assistantarn( ).
lv_uuid = lo_aiagentdata->get_aiagentid( ).
lv_arn = lo_aiagentdata->get_aiagentarn( ).
lv_name = lo_aiagentdata->get_name( ).
lv_aiagenttype = lo_aiagentdata->get_type( ).
lo_aiagentconfiguration = lo_aiagentdata->get_configuration( ).
IF lo_aiagentconfiguration IS NOT INITIAL.
lo_manualsearchaiagentconf = lo_aiagentconfiguration->get_manualsearchaiagentconf( ).
IF lo_manualsearchaiagentconf IS NOT INITIAL.
lv_uuidwithqualifier = lo_manualsearchaiagentconf->get_answergenerationaiprom00( ).
lv_uuidwithqualifier = lo_manualsearchaiagentconf->get_answergenerationaiguar00( ).
LOOP AT lo_manualsearchaiagentconf->get_associationconfs( ) into lo_row.
lo_row_1 = lo_row.
IF lo_row_1 IS NOT INITIAL.
lv_uuid = lo_row_1->get_associationid( ).
lv_aiagentassociationconfi = lo_row_1->get_associationtype( ).
lo_associationconfiguratio = lo_row_1->get_associationconfdata( ).
IF lo_associationconfiguratio IS NOT INITIAL.
lo_knowledgebaseassociatio = lo_associationconfiguratio->get_knowledgebaseassociati00( ).
IF lo_knowledgebaseassociatio IS NOT INITIAL.
lo_tagfilter = lo_knowledgebaseassociatio->get_contenttagfilter( ).
IF lo_tagfilter IS NOT INITIAL.
lo_tagcondition = lo_tagfilter->get_tagcondition( ).
IF lo_tagcondition IS NOT INITIAL.
lv_tagkey = lo_tagcondition->get_key( ).
lv_tagvalue = lo_tagcondition->get_value( ).
ENDIF.
LOOP AT lo_tagfilter->get_andconditions( ) into lo_row_2.
lo_row_3 = lo_row_2.
IF lo_row_3 IS NOT INITIAL.
lv_tagkey = lo_row_3->get_key( ).
lv_tagvalue = lo_row_3->get_value( ).
ENDIF.
ENDLOOP.
LOOP AT lo_tagfilter->get_orconditions( ) into lo_row_4.
lo_row_5 = lo_row_4.
IF lo_row_5 IS NOT INITIAL.
LOOP AT lo_row_5->get_andconditions( ) into lo_row_2.
lo_row_3 = lo_row_2.
IF lo_row_3 IS NOT INITIAL.
lv_tagkey = lo_row_3->get_key( ).
lv_tagvalue = lo_row_3->get_value( ).
ENDIF.
ENDLOOP.
lo_tagcondition = lo_row_5->get_tagcondition( ).
IF lo_tagcondition IS NOT INITIAL.
lv_tagkey = lo_tagcondition->get_key( ).
lv_tagvalue = lo_tagcondition->get_value( ).
ENDIF.
ENDIF.
ENDLOOP.
ENDIF.
lv_maxresults = lo_knowledgebaseassociatio->get_maxresults( ).
lv_knowledgebasesearchtype = lo_knowledgebaseassociatio->get_overrideknowledgebases00( ).
ENDIF.
ENDIF.
ENDIF.
ENDLOOP.
lv_nonemptystring = lo_manualsearchaiagentconf->get_locale( ).
ENDIF.
lo_answerrecommendationaia = lo_aiagentconfiguration->get_answerrecommendationai00( ).
IF lo_answerrecommendationaia IS NOT INITIAL.
lv_uuidwithqualifier = lo_answerrecommendationaia->get_intentlabelinggenerati00( ).
lv_uuidwithqualifier = lo_answerrecommendationaia->get_queryreformulationaipr00( ).
lv_uuidwithqualifier = lo_answerrecommendationaia->get_answergenerationaiprom00( ).
lv_uuidwithqualifier = lo_answerrecommendationaia->get_answergenerationaiguar00( ).
LOOP AT lo_answerrecommendationaia->get_associationconfs( ) into lo_row.
lo_row_1 = lo_row.
IF lo_row_1 IS NOT INITIAL.
lv_uuid = lo_row_1->get_associationid( ).
lv_aiagentassociationconfi = lo_row_1->get_associationtype( ).
lo_associationconfiguratio = lo_row_1->get_associationconfdata( ).
IF lo_associationconfiguratio IS NOT INITIAL.
lo_knowledgebaseassociatio = lo_associationconfiguratio->get_knowledgebaseassociati00( ).
IF lo_knowledgebaseassociatio IS NOT INITIAL.
lo_tagfilter = lo_knowledgebaseassociatio->get_contenttagfilter( ).
IF lo_tagfilter IS NOT INITIAL.
lo_tagcondition = lo_tagfilter->get_tagcondition( ).
IF lo_tagcondition IS NOT INITIAL.
lv_tagkey = lo_tagcondition->get_key( ).
lv_tagvalue = lo_tagcondition->get_value( ).
ENDIF.
LOOP AT lo_tagfilter->get_andconditions( ) into lo_row_2.
lo_row_3 = lo_row_2.
IF lo_row_3 IS NOT INITIAL.
lv_tagkey = lo_row_3->get_key( ).
lv_tagvalue = lo_row_3->get_value( ).
ENDIF.
ENDLOOP.
LOOP AT lo_tagfilter->get_orconditions( ) into lo_row_4.
lo_row_5 = lo_row_4.
IF lo_row_5 IS NOT INITIAL.
LOOP AT lo_row_5->get_andconditions( ) into lo_row_2.
lo_row_3 = lo_row_2.
IF lo_row_3 IS NOT INITIAL.
lv_tagkey = lo_row_3->get_key( ).
lv_tagvalue = lo_row_3->get_value( ).
ENDIF.
ENDLOOP.
lo_tagcondition = lo_row_5->get_tagcondition( ).
IF lo_tagcondition IS NOT INITIAL.
lv_tagkey = lo_tagcondition->get_key( ).
lv_tagvalue = lo_tagcondition->get_value( ).
ENDIF.
ENDIF.
ENDLOOP.
ENDIF.
lv_maxresults = lo_knowledgebaseassociatio->get_maxresults( ).
lv_knowledgebasesearchtype = lo_knowledgebaseassociatio->get_overrideknowledgebases00( ).
ENDIF.
ENDIF.
ENDIF.
ENDLOOP.
lv_nonemptystring = lo_answerrecommendationaia->get_locale( ).
LOOP AT lo_answerrecommendationaia->get_suggestedmessages( ) into lo_row_6.
lo_row_7 = lo_row_6.
IF lo_row_7 IS NOT INITIAL.
lv_nonemptysensitivestring = lo_row_7->get_value( ).
ENDIF.
ENDLOOP.
ENDIF.
lo_selfserviceaiagentconfi = lo_aiagentconfiguration->get_selfserviceaiagentconf( ).
IF lo_selfserviceaiagentconfi IS NOT INITIAL.
lv_uuidwithqualifier = lo_selfserviceaiagentconfi->get_selfsvcpreprocingaipro00( ).
lv_uuidwithqualifier = lo_selfserviceaiagentconfi->get_selfsvcanswergeneratio00( ).
lv_uuidwithqualifier = lo_selfserviceaiagentconfi->get_selfserviceaiguardrailid( ).
LOOP AT lo_selfserviceaiagentconfi->get_associationconfs( ) into lo_row.
lo_row_1 = lo_row.
IF lo_row_1 IS NOT INITIAL.
lv_uuid = lo_row_1->get_associationid( ).
lv_aiagentassociationconfi = lo_row_1->get_associationtype( ).
lo_associationconfiguratio = lo_row_1->get_associationconfdata( ).
IF lo_associationconfiguratio IS NOT INITIAL.
lo_knowledgebaseassociatio = lo_associationconfiguratio->get_knowledgebaseassociati00( ).
IF lo_knowledgebaseassociatio IS NOT INITIAL.
lo_tagfilter = lo_knowledgebaseassociatio->get_contenttagfilter( ).
IF lo_tagfilter IS NOT INITIAL.
lo_tagcondition = lo_tagfilter->get_tagcondition( ).
IF lo_tagcondition IS NOT INITIAL.
lv_tagkey = lo_tagcondition->get_key( ).
lv_tagvalue = lo_tagcondition->get_value( ).
ENDIF.
LOOP AT lo_tagfilter->get_andconditions( ) into lo_row_2.
lo_row_3 = lo_row_2.
IF lo_row_3 IS NOT INITIAL.
lv_tagkey = lo_row_3->get_key( ).
lv_tagvalue = lo_row_3->get_value( ).
ENDIF.
ENDLOOP.
LOOP AT lo_tagfilter->get_orconditions( ) into lo_row_4.
lo_row_5 = lo_row_4.
IF lo_row_5 IS NOT INITIAL.
LOOP AT lo_row_5->get_andconditions( ) into lo_row_2.
lo_row_3 = lo_row_2.
IF lo_row_3 IS NOT INITIAL.
lv_tagkey = lo_row_3->get_key( ).
lv_tagvalue = lo_row_3->get_value( ).
ENDIF.
ENDLOOP.
lo_tagcondition = lo_row_5->get_tagcondition( ).
IF lo_tagcondition IS NOT INITIAL.
lv_tagkey = lo_tagcondition->get_key( ).
lv_tagvalue = lo_tagcondition->get_value( ).
ENDIF.
ENDIF.
ENDLOOP.
ENDIF.
lv_maxresults = lo_knowledgebaseassociatio->get_maxresults( ).
lv_knowledgebasesearchtype = lo_knowledgebaseassociatio->get_overrideknowledgebases00( ).
ENDIF.
ENDIF.
ENDIF.
ENDLOOP.
ENDIF.
lo_emailresponseaiagentcon = lo_aiagentconfiguration->get_emailresponseaiagentconf( ).
IF lo_emailresponseaiagentcon IS NOT INITIAL.
lv_uuidwithqualifier = lo_emailresponseaiagentcon->get_emailresponseaipromptid( ).
lv_uuidwithqualifier = lo_emailresponseaiagentcon->get_emailqueryrefmltionaip00( ).
lv_nonemptystring = lo_emailresponseaiagentcon->get_locale( ).
LOOP AT lo_emailresponseaiagentcon->get_associationconfs( ) into lo_row.
lo_row_1 = lo_row.
IF lo_row_1 IS NOT INITIAL.
lv_uuid = lo_row_1->get_associationid( ).
lv_aiagentassociationconfi = lo_row_1->get_associationtype( ).
lo_associationconfiguratio = lo_row_1->get_associationconfdata( ).
IF lo_associationconfiguratio IS NOT INITIAL.
lo_knowledgebaseassociatio = lo_associationconfiguratio->get_knowledgebaseassociati00( ).
IF lo_knowledgebaseassociatio IS NOT INITIAL.
lo_tagfilter = lo_knowledgebaseassociatio->get_contenttagfilter( ).
IF lo_tagfilter IS NOT INITIAL.
lo_tagcondition = lo_tagfilter->get_tagcondition( ).
IF lo_tagcondition IS NOT INITIAL.
lv_tagkey = lo_tagcondition->get_key( ).
lv_tagvalue = lo_tagcondition->get_value( ).
ENDIF.
LOOP AT lo_tagfilter->get_andconditions( ) into lo_row_2.
lo_row_3 = lo_row_2.
IF lo_row_3 IS NOT INITIAL.
lv_tagkey = lo_row_3->get_key( ).
lv_tagvalue = lo_row_3->get_value( ).
ENDIF.
ENDLOOP.
LOOP AT lo_tagfilter->get_orconditions( ) into lo_row_4.
lo_row_5 = lo_row_4.
IF lo_row_5 IS NOT INITIAL.
LOOP AT lo_row_5->get_andconditions( ) into lo_row_2.
lo_row_3 = lo_row_2.
IF lo_row_3 IS NOT INITIAL.
lv_tagkey = lo_row_3->get_key( ).
lv_tagvalue = lo_row_3->get_value( ).
ENDIF.
ENDLOOP.
lo_tagcondition = lo_row_5->get_tagcondition( ).
IF lo_tagcondition IS NOT INITIAL.
lv_tagkey = lo_tagcondition->get_key( ).
lv_tagvalue = lo_tagcondition->get_value( ).
ENDIF.
ENDIF.
ENDLOOP.
ENDIF.
lv_maxresults = lo_knowledgebaseassociatio->get_maxresults( ).
lv_knowledgebasesearchtype = lo_knowledgebaseassociatio->get_overrideknowledgebases00( ).
ENDIF.
ENDIF.
ENDIF.
ENDLOOP.
ENDIF.
lo_emailoverviewaiagentcon = lo_aiagentconfiguration->get_emailoverviewaiagentconf( ).
IF lo_emailoverviewaiagentcon IS NOT INITIAL.
lv_uuidwithqualifier = lo_emailoverviewaiagentcon->get_emailoverviewaipromptid( ).
lv_nonemptystring = lo_emailoverviewaiagentcon->get_locale( ).
ENDIF.
lo_emailgenerativeanswerai = lo_aiagentconfiguration->get_emailgenerativeanswera01( ).
IF lo_emailgenerativeanswerai IS NOT INITIAL.
lv_uuidwithqualifier = lo_emailgenerativeanswerai->get_emailgenerativeanswera00( ).
lv_uuidwithqualifier = lo_emailgenerativeanswerai->get_emailqueryrefmltionaip00( ).
lv_nonemptystring = lo_emailgenerativeanswerai->get_locale( ).
LOOP AT lo_emailgenerativeanswerai->get_associationconfs( ) into lo_row.
lo_row_1 = lo_row.
IF lo_row_1 IS NOT INITIAL.
lv_uuid = lo_row_1->get_associationid( ).
lv_aiagentassociationconfi = lo_row_1->get_associationtype( ).
lo_associationconfiguratio = lo_row_1->get_associationconfdata( ).
IF lo_associationconfiguratio IS NOT INITIAL.
lo_knowledgebaseassociatio = lo_associationconfiguratio->get_knowledgebaseassociati00( ).
IF lo_knowledgebaseassociatio IS NOT INITIAL.
lo_tagfilter = lo_knowledgebaseassociatio->get_contenttagfilter( ).
IF lo_tagfilter IS NOT INITIAL.
lo_tagcondition = lo_tagfilter->get_tagcondition( ).
IF lo_tagcondition IS NOT INITIAL.
lv_tagkey = lo_tagcondition->get_key( ).
lv_tagvalue = lo_tagcondition->get_value( ).
ENDIF.
LOOP AT lo_tagfilter->get_andconditions( ) into lo_row_2.
lo_row_3 = lo_row_2.
IF lo_row_3 IS NOT INITIAL.
lv_tagkey = lo_row_3->get_key( ).
lv_tagvalue = lo_row_3->get_value( ).
ENDIF.
ENDLOOP.
LOOP AT lo_tagfilter->get_orconditions( ) into lo_row_4.
lo_row_5 = lo_row_4.
IF lo_row_5 IS NOT INITIAL.
LOOP AT lo_row_5->get_andconditions( ) into lo_row_2.
lo_row_3 = lo_row_2.
IF lo_row_3 IS NOT INITIAL.
lv_tagkey = lo_row_3->get_key( ).
lv_tagvalue = lo_row_3->get_value( ).
ENDIF.
ENDLOOP.
lo_tagcondition = lo_row_5->get_tagcondition( ).
IF lo_tagcondition IS NOT INITIAL.
lv_tagkey = lo_tagcondition->get_key( ).
lv_tagvalue = lo_tagcondition->get_value( ).
ENDIF.
ENDIF.
ENDLOOP.
ENDIF.
lv_maxresults = lo_knowledgebaseassociatio->get_maxresults( ).
lv_knowledgebasesearchtype = lo_knowledgebaseassociatio->get_overrideknowledgebases00( ).
ENDIF.
ENDIF.
ENDIF.
ENDLOOP.
ENDIF.
lo_orchestrationaiagentcon = lo_aiagentconfiguration->get_orchaiagentconfiguration( ).
IF lo_orchestrationaiagentcon IS NOT INITIAL.
lv_uuidwithqualifier = lo_orchestrationaiagentcon->get_orchestrationaipromptid( ).
lv_uuidwithqualifier = lo_orchestrationaiagentcon->get_orchaiguardrailid( ).
LOOP AT lo_orchestrationaiagentcon->get_toolconfigurations( ) into lo_row_8.
lo_row_9 = lo_row_8.
IF lo_row_9 IS NOT INITIAL.
lv_nonemptystring = lo_row_9->get_toolname( ).
lv_tooltype = lo_row_9->get_tooltype( ).
lv_nonemptysensitivestring = lo_row_9->get_title( ).
lv_nonemptystring = lo_row_9->get_toolid( ).
lv_nonemptysensitivestring = lo_row_9->get_description( ).
lo_toolinstruction = lo_row_9->get_instruction( ).
IF lo_toolinstruction IS NOT INITIAL.
lv_string = lo_toolinstruction->get_instruction( ).
LOOP AT lo_toolinstruction->get_examples( ) into lo_row_10.
lo_row_11 = lo_row_10.
IF lo_row_11 IS NOT INITIAL.
lv_string = lo_row_11->get_value( ).
ENDIF.
ENDLOOP.
ENDIF.
LOOP AT lo_row_9->get_overrideinputvalues( ) into lo_row_12.
lo_row_13 = lo_row_12.
IF lo_row_13 IS NOT INITIAL.
lv_nonemptystring = lo_row_13->get_jsonpath( ).
lo_tooloverrideinputvaluec = lo_row_13->get_value( ).
IF lo_tooloverrideinputvaluec IS NOT INITIAL.
lo_tooloverrideconstantinp = lo_tooloverrideinputvaluec->get_constant( ).
IF lo_tooloverrideconstantinp IS NOT INITIAL.
lv_tooloverrideinputvaluet = lo_tooloverrideconstantinp->get_type( ).
lv_nonemptysensitivestring = lo_tooloverrideconstantinp->get_value( ).
ENDIF.
ENDIF.
ENDIF.
ENDLOOP.
LOOP AT lo_row_9->get_outputfilters( ) into lo_row_14.
lo_row_15 = lo_row_14.
IF lo_row_15 IS NOT INITIAL.
lv_nonemptystring = lo_row_15->get_jsonpath( ).
lo_tooloutputconfiguration = lo_row_15->get_outputconfiguration( ).
IF lo_tooloutputconfiguration IS NOT INITIAL.
lv_nonemptystring = lo_tooloutputconfiguration->get_outputvariablenameovrd( ).
lv_nonemptystring = lo_tooloutputconfiguration->get_sessiondatanamespace( ).
ENDIF.
ENDIF.
ENDLOOP.
lo_value = lo_row_9->get_inputschema( ).
IF lo_value IS NOT INITIAL.
ENDIF.
lo_value = lo_row_9->get_outputschema( ).
IF lo_value IS NOT INITIAL.
ENDIF.
lo_annotation = lo_row_9->get_annotations( ).
IF lo_annotation IS NOT INITIAL.
lv_string = lo_annotation->get_title( ).
lv_boolean = lo_annotation->get_destructivehint( ).
ENDIF.
lo_userinteractionconfigur = lo_row_9->get_userinteractionconf( ).
IF lo_userinteractionconfigur IS NOT INITIAL.
lv_boolean = lo_userinteractionconfigur->get_isuserconfirmationreqd( ).
ENDIF.
ENDIF.
ENDLOOP.
lv_genericarn = lo_orchestrationaiagentcon->get_connectinstancearn( ).
lv_nonemptystring = lo_orchestrationaiagentcon->get_locale( ).
ENDIF.
lo_notetakingaiagentconfig = lo_aiagentconfiguration->get_notetakingaiagentconf( ).
IF lo_notetakingaiagentconfig IS NOT INITIAL.
lv_uuidwithqualifier = lo_notetakingaiagentconfig->get_notetakingaipromptid( ).
lv_uuidwithqualifier = lo_notetakingaiagentconfig->get_notetakingaiguardrailid( ).
lv_nonemptystring = lo_notetakingaiagentconfig->get_locale( ).
ENDIF.
lo_casesummarizationaiagen = lo_aiagentconfiguration->get_casesummaiagentconf( ).
IF lo_casesummarizationaiagen IS NOT INITIAL.
lv_uuidwithqualifier = lo_casesummarizationaiagen->get_casesummaipromptid( ).
lv_uuidwithqualifier = lo_casesummarizationaiagen->get_casesummaiguardrailid( ).
lv_nonemptystring = lo_casesummarizationaiagen->get_locale( ).
ENDIF.
ENDIF.
lv_timestamp = lo_aiagentdata->get_modifiedtime( ).
lv_description = lo_aiagentdata->get_description( ).
lv_visibilitystatus = lo_aiagentdata->get_visibilitystatus( ).
LOOP AT lo_aiagentdata->get_tags( ) into ls_row_16.
lv_key = ls_row_16-key.
lo_value_1 = ls_row_16-value.
IF lo_value_1 IS NOT INITIAL.
lv_tagvalue = lo_value_1->get_value( ).
ENDIF.
ENDLOOP.
lv_origin = lo_aiagentdata->get_origin( ).
lv_status = lo_aiagentdata->get_status( ).
ENDIF.
lv_version = lo_result->get_versionnumber( ).
ENDIF.