/AWS1/IF_QQB=>UPDATECHATCONTROLSCONF()

About UpdateChatControlsConfiguration

Updates a set of chat controls configured for an existing Amazon Q Business application.

Method Signature

METHODS /AWS1/IF_QQB~UPDATECHATCONTROLSCONF
  IMPORTING
    !IV_APPLICATIONID TYPE /AWS1/QQBAPPLICATIONID OPTIONAL
    !IV_CLIENTTOKEN TYPE /AWS1/QQBCLIENTTOKEN OPTIONAL
    !IV_RESPONSESCOPE TYPE /AWS1/QQBRESPONSESCOPE OPTIONAL
    !IO_ORCHESTRATIONCONF TYPE REF TO /AWS1/CL_QQBORCHESTRATIONCONF OPTIONAL
    !IO_BLOCKEDPHRASESCONFUPDATE TYPE REF TO /AWS1/CL_QQBBLKEDPHRASESCONFUP OPTIONAL
    !IT_TOPICCONFSTOCREATEORUPD TYPE /AWS1/CL_QQBTOPICCONFIGURATION=>TT_TOPICCONFIGURATIONS OPTIONAL
    !IT_TOPICCONFSTODELETE TYPE /AWS1/CL_QQBTOPICCONFIGURATION=>TT_TOPICCONFIGURATIONS OPTIONAL
    !IO_CREATORMODECONFIGURATION TYPE REF TO /AWS1/CL_QQBCREATORMODECONF OPTIONAL
    !IO_HALLUCINATIONREDUCTIONC00 TYPE REF TO /AWS1/CL_QQBHALLUCINATIONRED00 OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_qqbupdchatctlsconfrsp
  RAISING
    /AWS1/CX_QQBACCESSDENIEDEX
    /AWS1/CX_QQBCONFLICTEXCEPTION
    /AWS1/CX_QQBINTERNALSERVEREX
    /AWS1/CX_QQBRESOURCENOTFOUNDEX
    /AWS1/CX_QQBSERVICEQUOTAEXCDEX
    /AWS1/CX_QQBTHROTTLINGEX
    /AWS1/CX_QQBVALIDATIONEX
    /AWS1/CX_QQBCLIENTEXC
    /AWS1/CX_QQBSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_applicationid TYPE /AWS1/QQBAPPLICATIONID /AWS1/QQBAPPLICATIONID

The identifier of the application for which the chat controls are configured.

Optional arguments:

iv_clienttoken TYPE /AWS1/QQBCLIENTTOKEN /AWS1/QQBCLIENTTOKEN

A token that you provide to identify the request to update a Amazon Q Business application chat configuration.

iv_responsescope TYPE /AWS1/QQBRESPONSESCOPE /AWS1/QQBRESPONSESCOPE

The response scope configured for your application. This determines whether your application uses its retrieval augmented generation (RAG) system to generate answers only from your enterprise data, or also uses the large language models (LLM) knowledge to respons to end user questions in chat.

io_orchestrationconf TYPE REF TO /AWS1/CL_QQBORCHESTRATIONCONF /AWS1/CL_QQBORCHESTRATIONCONF

The chat response orchestration settings for your application.

io_blockedphrasesconfupdate TYPE REF TO /AWS1/CL_QQBBLKEDPHRASESCONFUP /AWS1/CL_QQBBLKEDPHRASESCONFUP

The phrases blocked from chat by your chat control configuration.

it_topicconfstocreateorupd TYPE /AWS1/CL_QQBTOPICCONFIGURATION=>TT_TOPICCONFIGURATIONS TT_TOPICCONFIGURATIONS

The configured topic specific chat controls you want to update.

it_topicconfstodelete TYPE /AWS1/CL_QQBTOPICCONFIGURATION=>TT_TOPICCONFIGURATIONS TT_TOPICCONFIGURATIONS

The configured topic specific chat controls you want to delete.

io_creatormodeconfiguration TYPE REF TO /AWS1/CL_QQBCREATORMODECONF /AWS1/CL_QQBCREATORMODECONF

The configuration details for CREATOR_MODE.

io_hallucinationreductionc00 TYPE REF TO /AWS1/CL_QQBHALLUCINATIONRED00 /AWS1/CL_QQBHALLUCINATIONRED00

The hallucination reduction settings for your application.

RETURNING

oo_output TYPE REF TO /aws1/cl_qqbupdchatctlsconfrsp /AWS1/CL_QQBUPDCHATCTLSCONFRSP

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->updatechatcontrolsconf(
  io_blockedphrasesconfupdate = new /aws1/cl_qqbblkedphrasesconfup(
    it_blockedphrasestocreorupd = VALUE /aws1/cl_qqbblockedphrases_w=>tt_blockedphrases(
      ( new /aws1/cl_qqbblockedphrases_w( |string| ) )
    )
    it_blockedphrasestodelete = VALUE /aws1/cl_qqbblockedphrases_w=>tt_blockedphrases(
      ( new /aws1/cl_qqbblockedphrases_w( |string| ) )
    )
    iv_systemmessageoverride = |string|
  )
  io_creatormodeconfiguration = new /aws1/cl_qqbcreatormodeconf( |string| )
  io_hallucinationreductionc00 = new /aws1/cl_qqbhallucinationred00( |string| )
  io_orchestrationconf = new /aws1/cl_qqborchestrationconf( |string| )
  it_topicconfstocreateorupd = VALUE /aws1/cl_qqbtopicconfiguration=>tt_topicconfigurations(
    (
      new /aws1/cl_qqbtopicconfiguration(
        it_examplechatmessages = VALUE /aws1/cl_qqbexamplechatmsgs_w=>tt_examplechatmessages(
          ( new /aws1/cl_qqbexamplechatmsgs_w( |string| ) )
        )
        it_rules = VALUE /aws1/cl_qqbrule=>tt_rules(
          (
            new /aws1/cl_qqbrule(
              io_excludedusersandgroups = new /aws1/cl_qqbusersandgroups(
                it_usergroups = VALUE /aws1/cl_qqbusergroups_w=>tt_usergroups(
                  ( new /aws1/cl_qqbusergroups_w( |string| ) )
                )
                it_userids = VALUE /aws1/cl_qqbuserids_w=>tt_userids(
                  ( new /aws1/cl_qqbuserids_w( |string| ) )
                )
              )
              io_includedusersandgroups = new /aws1/cl_qqbusersandgroups(
                it_usergroups = VALUE /aws1/cl_qqbusergroups_w=>tt_usergroups(
                  ( new /aws1/cl_qqbusergroups_w( |string| ) )
                )
                it_userids = VALUE /aws1/cl_qqbuserids_w=>tt_userids(
                  ( new /aws1/cl_qqbuserids_w( |string| ) )
                )
              )
              io_ruleconfiguration = new /aws1/cl_qqbruleconfiguration(
                io_contentblockerrule = new /aws1/cl_qqbcontentblockerrule( |string| )
                io_contentretrievalrule = new /aws1/cl_qqbcontretrievalrule(
                  it_eligibledatasources = VALUE /aws1/cl_qqbeligibledatasource=>tt_eligibledatasources(
                    (
                      new /aws1/cl_qqbeligibledatasource(
                        iv_datasourceid = |string|
                        iv_indexid = |string|
                      )
                    )
                  )
                )
              )
              iv_ruletype = |string|
            )
          )
        )
        iv_description = |string|
        iv_name = |string|
      )
    )
  )
  it_topicconfstodelete = VALUE /aws1/cl_qqbtopicconfiguration=>tt_topicconfigurations(
    (
      new /aws1/cl_qqbtopicconfiguration(
        it_examplechatmessages = VALUE /aws1/cl_qqbexamplechatmsgs_w=>tt_examplechatmessages(
          ( new /aws1/cl_qqbexamplechatmsgs_w( |string| ) )
        )
        it_rules = VALUE /aws1/cl_qqbrule=>tt_rules(
          (
            new /aws1/cl_qqbrule(
              io_excludedusersandgroups = new /aws1/cl_qqbusersandgroups(
                it_usergroups = VALUE /aws1/cl_qqbusergroups_w=>tt_usergroups(
                  ( new /aws1/cl_qqbusergroups_w( |string| ) )
                )
                it_userids = VALUE /aws1/cl_qqbuserids_w=>tt_userids(
                  ( new /aws1/cl_qqbuserids_w( |string| ) )
                )
              )
              io_includedusersandgroups = new /aws1/cl_qqbusersandgroups(
                it_usergroups = VALUE /aws1/cl_qqbusergroups_w=>tt_usergroups(
                  ( new /aws1/cl_qqbusergroups_w( |string| ) )
                )
                it_userids = VALUE /aws1/cl_qqbuserids_w=>tt_userids(
                  ( new /aws1/cl_qqbuserids_w( |string| ) )
                )
              )
              io_ruleconfiguration = new /aws1/cl_qqbruleconfiguration(
                io_contentblockerrule = new /aws1/cl_qqbcontentblockerrule( |string| )
                io_contentretrievalrule = new /aws1/cl_qqbcontretrievalrule(
                  it_eligibledatasources = VALUE /aws1/cl_qqbeligibledatasource=>tt_eligibledatasources(
                    (
                      new /aws1/cl_qqbeligibledatasource(
                        iv_datasourceid = |string|
                        iv_indexid = |string|
                      )
                    )
                  )
                )
              )
              iv_ruletype = |string|
            )
          )
        )
        iv_description = |string|
        iv_name = |string|
      )
    )
  )
  iv_applicationid = |string|
  iv_clienttoken = |string|
  iv_responsescope = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
ENDIF.