Skip to content

/AWS1/IF_QQC=>CREATEAIAGENT()

About CreateAIAgent

Creates an Amazon Q in Connect AI Agent.

Method Signature

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_name TYPE /AWS1/QQCNAME /AWS1/QQCNAME

The name of the AI Agent.

iv_type TYPE /AWS1/QQCAIAGENTTYPE /AWS1/QQCAIAGENTTYPE

The type of the AI Agent.

io_configuration TYPE REF TO /AWS1/CL_QQCAIAGENTCONF /AWS1/CL_QQCAIAGENTCONF

The configuration of the AI Agent.

iv_visibilitystatus TYPE /AWS1/QQCVISIBILITYSTATUS /AWS1/QQCVISIBILITYSTATUS

The visibility status of the AI Agent.

Optional arguments:

iv_clienttoken TYPE /AWS1/QQCCLIENTTOKEN /AWS1/QQCCLIENTTOKEN

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs..

it_tags TYPE /AWS1/CL_QQCTAGS_W=>TT_TAGS TT_TAGS

The tags used to organize, track, or control access for this resource.

iv_description TYPE /AWS1/QQCDESCRIPTION /AWS1/QQCDESCRIPTION

The description of the AI Agent.

RETURNING

oo_output TYPE REF TO /aws1/cl_qqccreateaiagentrsp /AWS1/CL_QQCCREATEAIAGENTRSP

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->/aws1/if_qqc~createaiagent(
  io_configuration = new /aws1/cl_qqcaiagentconf(
    io_answerrecommendationaia00 = new /aws1/cl_qqcanswerrecommenda00(
      it_associationconfigurations = VALUE /aws1/cl_qqcassociationconf=>tt_associationconflist(
        (
          new /aws1/cl_qqcassociationconf(
            io_associationconfdata = new /aws1/cl_qqcassociationconfd00(
              io_knowledgebaseassociatio00 = new /aws1/cl_qqcknowledgebaseass01(
                io_contenttagfilter = new /aws1/cl_qqctagfilter(
                  io_tagcondition = new /aws1/cl_qqctagcondition(
                    iv_key = |string|
                    iv_value = |string|
                  )
                  it_andconditions = VALUE /aws1/cl_qqctagcondition=>tt_andconditions(
                    (
                      new /aws1/cl_qqctagcondition(
                        iv_key = |string|
                        iv_value = |string|
                      )
                    )
                  )
                  it_orconditions = VALUE /aws1/cl_qqcorcondition=>tt_orconditions(
                    (
                      new /aws1/cl_qqcorcondition(
                        io_tagcondition = new /aws1/cl_qqctagcondition(
                          iv_key = |string|
                          iv_value = |string|
                        )
                        it_andconditions = VALUE /aws1/cl_qqctagcondition=>tt_andconditions(
                          (
                            new /aws1/cl_qqctagcondition(
                              iv_key = |string|
                              iv_value = |string|
                            )
                          )
                        )
                      )
                    )
                  )
                )
                iv_maxresults = 123
                iv_overrideknowledgebasesr00 = |string|
              )
            )
            iv_associationid = |string|
            iv_associationtype = |string|
          )
        )
      )
      iv_answergenerationaiguard00 = |string|
      iv_answergenerationaipromp00 = |string|
      iv_intentlabelinggeneratio00 = |string|
      iv_locale = |string|
      iv_queryreformulationaipro00 = |string|
    )
    io_manualsearchaiagentconf = new /aws1/cl_qqcmanualsrchaiagen00(
      it_associationconfigurations = VALUE /aws1/cl_qqcassociationconf=>tt_associationconflist(
        (
          new /aws1/cl_qqcassociationconf(
            io_associationconfdata = new /aws1/cl_qqcassociationconfd00(
              io_knowledgebaseassociatio00 = new /aws1/cl_qqcknowledgebaseass01(
                io_contenttagfilter = new /aws1/cl_qqctagfilter(
                  io_tagcondition = new /aws1/cl_qqctagcondition(
                    iv_key = |string|
                    iv_value = |string|
                  )
                  it_andconditions = VALUE /aws1/cl_qqctagcondition=>tt_andconditions(
                    (
                      new /aws1/cl_qqctagcondition(
                        iv_key = |string|
                        iv_value = |string|
                      )
                    )
                  )
                  it_orconditions = VALUE /aws1/cl_qqcorcondition=>tt_orconditions(
                    (
                      new /aws1/cl_qqcorcondition(
                        io_tagcondition = new /aws1/cl_qqctagcondition(
                          iv_key = |string|
                          iv_value = |string|
                        )
                        it_andconditions = VALUE /aws1/cl_qqctagcondition=>tt_andconditions(
                          (
                            new /aws1/cl_qqctagcondition(
                              iv_key = |string|
                              iv_value = |string|
                            )
                          )
                        )
                      )
                    )
                  )
                )
                iv_maxresults = 123
                iv_overrideknowledgebasesr00 = |string|
              )
            )
            iv_associationid = |string|
            iv_associationtype = |string|
          )
        )
      )
      iv_answergenerationaiguard00 = |string|
      iv_answergenerationaipromp00 = |string|
      iv_locale = |string|
    )
    io_selfserviceaiagentconf = new /aws1/cl_qqcselfsvcaiagentconf(
      it_associationconfigurations = VALUE /aws1/cl_qqcassociationconf=>tt_associationconflist(
        (
          new /aws1/cl_qqcassociationconf(
            io_associationconfdata = new /aws1/cl_qqcassociationconfd00(
              io_knowledgebaseassociatio00 = new /aws1/cl_qqcknowledgebaseass01(
                io_contenttagfilter = new /aws1/cl_qqctagfilter(
                  io_tagcondition = new /aws1/cl_qqctagcondition(
                    iv_key = |string|
                    iv_value = |string|
                  )
                  it_andconditions = VALUE /aws1/cl_qqctagcondition=>tt_andconditions(
                    (
                      new /aws1/cl_qqctagcondition(
                        iv_key = |string|
                        iv_value = |string|
                      )
                    )
                  )
                  it_orconditions = VALUE /aws1/cl_qqcorcondition=>tt_orconditions(
                    (
                      new /aws1/cl_qqcorcondition(
                        io_tagcondition = new /aws1/cl_qqctagcondition(
                          iv_key = |string|
                          iv_value = |string|
                        )
                        it_andconditions = VALUE /aws1/cl_qqctagcondition=>tt_andconditions(
                          (
                            new /aws1/cl_qqctagcondition(
                              iv_key = |string|
                              iv_value = |string|
                            )
                          )
                        )
                      )
                    )
                  )
                )
                iv_maxresults = 123
                iv_overrideknowledgebasesr00 = |string|
              )
            )
            iv_associationid = |string|
            iv_associationtype = |string|
          )
        )
      )
      iv_selfserviceaiguardrailid = |string|
      iv_selfsvcanswergeneration00 = |string|
      iv_selfsvcpreprocingaiprom00 = |string|
    )
  )
  it_tags = VALUE /aws1/cl_qqctags_w=>tt_tags(
    (
      VALUE /aws1/cl_qqctags_w=>ts_tags_maprow(
        key = |string|
        value = new /aws1/cl_qqctags_w( |string| )
      )
    )
  )
  iv_assistantid = |string|
  iv_clienttoken = |string|
  iv_description = |string|
  iv_name = |string|
  iv_type = |string|
  iv_visibilitystatus = |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( ).
      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.
    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_6.
      lv_key = ls_row_6-key.
      lo_value = ls_row_6-value.
      IF lo_value IS NOT INITIAL.
        lv_tagvalue = lo_value->get_value( ).
      ENDIF.
    ENDLOOP.
    lv_origin = lo_aiagentdata->get_origin( ).
    lv_status = lo_aiagentdata->get_status( ).
  ENDIF.
ENDIF.