CREATECHATRESPONSECONF()`¶

About CreateChatResponseConfiguration¶

Creates a new chat response configuration for an Amazon Q Business application. This operation establishes a set of parameters that define how the system generates and formats responses to user queries in chat interactions.

Method Signature¶

METHODS /AWS1/IF_QQB~CREATECHATRESPONSECONF
  IMPORTING
    !IV_APPLICATIONID TYPE /AWS1/QQBAPPLICATIONID OPTIONAL
    !IV_DISPLAYNAME TYPE /AWS1/QQBDISPLAYNAME OPTIONAL
    !IV_CLIENTTOKEN TYPE /AWS1/QQBSTRING OPTIONAL
    !IT_RESPONSECONFIGURATIONS TYPE /AWS1/CL_QQBRESPONSECONF=>TT_RESPONSECONFIGURATIONS OPTIONAL
    !IT_TAGS TYPE /AWS1/CL_QQBTAG=>TT_TAGS OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_qqbcrechatrspconfrsp
  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 unique identifier of the Amazon Q Business application for which to create the new chat response configuration.

`iv_displayname` `TYPE /AWS1/QQBDISPLAYNAME` `/AWS1/QQBDISPLAYNAME`¶

A human-readable name for the new chat response configuration, making it easier to identify and manage among multiple configurations.

`it_responseconfigurations` `TYPE /AWS1/CL_QQBRESPONSECONF=>TT_RESPONSECONFIGURATIONS` `TT_RESPONSECONFIGURATIONS`¶

A collection of response configuration settings that define how Amazon Q Business will generate and format responses to user queries in chat interactions.

Optional arguments:¶

`iv_clienttoken` `TYPE /AWS1/QQBSTRING` `/AWS1/QQBSTRING`¶

A unique, case-sensitive identifier to ensure idempotency of the request. This helps prevent the same configuration from being created multiple times if retries occur.

`it_tags` `TYPE /AWS1/CL_QQBTAG=>TT_TAGS` `TT_TAGS`¶

A list of key-value pairs to apply as tags to the new chat response configuration, enabling categorization and management of resources across Amazon Web Services services.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_qqbcrechatrspconfrsp` `/AWS1/CL_QQBCRECHATRSPCONFRSP`¶

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->createchatresponseconf(
  it_responseconfigurations = VALUE /aws1/cl_qqbresponseconf=>tt_responseconfigurations(
    (
      VALUE /aws1/cl_qqbresponseconf=>ts_responseconfs_maprow(
        value = new /aws1/cl_qqbresponseconf(
          io_instructioncollection = new /aws1/cl_qqbinstructioncoll(
            iv_custominstructions = |string|
            iv_examples = |string|
            iv_identity = |string|
            iv_outputstyle = |string|
            iv_perspective = |string|
            iv_responselength = |string|
            iv_targetaudience = |string|
            iv_tone = |string|
          )
        )
        key = |string|
      )
    )
  )
  it_tags = VALUE /aws1/cl_qqbtag=>tt_tags(
    (
      new /aws1/cl_qqbtag(
        iv_key = |string|
        iv_value = |string|
      )
    )
  )
  iv_applicationid = |string|
  iv_clienttoken = |string|
  iv_displayname = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_chatresponseconfigurati = lo_result->get_chatresponseconfid( ).
  lv_chatresponseconfigurati_1 = lo_result->get_chatresponseconfarn( ).
ENDIF.

/AWS1/IF_QQB=>CREATECHATRESPONSECONF()¶