Skip to content

/AWS1/IF_QQC=>CREATEAIPROMPT()

About CreateAIPrompt

Creates an Amazon Q in Connect AI Prompt.

Method Signature

METHODS /AWS1/IF_QQC~CREATEAIPROMPT
  IMPORTING
    !IV_CLIENTTOKEN TYPE /AWS1/QQCCLIENTTOKEN OPTIONAL
    !IV_ASSISTANTID TYPE /AWS1/QQCUUIDORARN OPTIONAL
    !IV_NAME TYPE /AWS1/QQCNAME OPTIONAL
    !IV_TYPE TYPE /AWS1/QQCAIPROMPTTYPE OPTIONAL
    !IO_TEMPLATECONFIGURATION TYPE REF TO /AWS1/CL_QQCAIPROMPTTMPLCONF OPTIONAL
    !IV_VISIBILITYSTATUS TYPE /AWS1/QQCVISIBILITYSTATUS OPTIONAL
    !IV_TEMPLATETYPE TYPE /AWS1/QQCAIPROMPTTEMPLATETYPE OPTIONAL
    !IV_MODELID TYPE /AWS1/QQCAIPROMPTMODELID OPTIONAL
    !IV_APIFORMAT TYPE /AWS1/QQCAIPROMPTAPIFORMAT OPTIONAL
    !IT_TAGS TYPE /AWS1/CL_QQCTAGS_W=>TT_TAGS OPTIONAL
    !IV_DESCRIPTION TYPE /AWS1/QQCDESCRIPTION OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_qqccreateaipromptrsp
  RAISING
    /AWS1/CX_QQCACCESSDENIEDEX
    /AWS1/CX_QQCCONFLICTEXCEPTION
    /AWS1/CX_QQCRESOURCENOTFOUNDEX
    /AWS1/CX_QQCSERVICEQUOTAEXCDEX
    /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_name TYPE /AWS1/QQCNAME /AWS1/QQCNAME

The name of the AI Prompt.

iv_type TYPE /AWS1/QQCAIPROMPTTYPE /AWS1/QQCAIPROMPTTYPE

The type of this AI Prompt.

io_templateconfiguration TYPE REF TO /AWS1/CL_QQCAIPROMPTTMPLCONF /AWS1/CL_QQCAIPROMPTTMPLCONF

The configuration of the prompt template for this AI Prompt.

iv_visibilitystatus TYPE /AWS1/QQCVISIBILITYSTATUS /AWS1/QQCVISIBILITYSTATUS

The visibility status of the AI Prompt.

iv_templatetype TYPE /AWS1/QQCAIPROMPTTEMPLATETYPE /AWS1/QQCAIPROMPTTEMPLATETYPE

The type of the prompt template for this AI Prompt.

iv_modelid TYPE /AWS1/QQCAIPROMPTMODELID /AWS1/QQCAIPROMPTMODELID

The identifier of the model used for this AI Prompt.

For information about which models are supported in each Amazon Web Services Region, see Supported models for system/custom prompts.

iv_apiformat TYPE /AWS1/QQCAIPROMPTAPIFORMAT /AWS1/QQCAIPROMPTAPIFORMAT

The API Format of the AI Prompt.

Recommended values: MESSAGES | TEXT_COMPLETIONS

The values ANTHROPIC_CLAUDE_MESSAGES | ANTHROPIC_CLAUDE_TEXT_COMPLETIONS will be deprecated.

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 Prompt.

RETURNING

oo_output TYPE REF TO /aws1/cl_qqccreateaipromptrsp /AWS1/CL_QQCCREATEAIPROMPTRSP

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->createaiprompt(
  io_templateconfiguration = new /aws1/cl_qqcaiprompttmplconf( new /aws1/cl_qqctxtfullaiprompte00( |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_apiformat = |string|
  iv_assistantid = |string|
  iv_clienttoken = |string|
  iv_description = |string|
  iv_modelid = |string|
  iv_name = |string|
  iv_templatetype = |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_aipromptdata = lo_result->get_aiprompt( ).
  IF lo_aipromptdata IS NOT INITIAL.
    lv_uuid = lo_aipromptdata->get_assistantid( ).
    lv_arn = lo_aipromptdata->get_assistantarn( ).
    lv_uuid = lo_aipromptdata->get_aipromptid( ).
    lv_arn = lo_aipromptdata->get_aipromptarn( ).
    lv_name = lo_aipromptdata->get_name( ).
    lv_aiprompttype = lo_aipromptdata->get_type( ).
    lv_aiprompttemplatetype = lo_aipromptdata->get_templatetype( ).
    lv_aipromptmodelidentifier = lo_aipromptdata->get_modelid( ).
    lv_aipromptapiformat = lo_aipromptdata->get_apiformat( ).
    lo_aiprompttemplateconfigu = lo_aipromptdata->get_templateconfiguration( ).
    IF lo_aiprompttemplateconfigu IS NOT INITIAL.
      lo_textfullaipromptedittem = lo_aiprompttemplateconfigu->get_txtfullaipromptedittmp00( ).
      IF lo_textfullaipromptedittem IS NOT INITIAL.
        lv_textaiprompt = lo_textfullaipromptedittem->get_text( ).
      ENDIF.
    ENDIF.
    lv_timestamp = lo_aipromptdata->get_modifiedtime( ).
    lv_description = lo_aipromptdata->get_description( ).
    lv_visibilitystatus = lo_aipromptdata->get_visibilitystatus( ).
    LOOP AT lo_aipromptdata->get_tags( ) into ls_row.
      lv_key = ls_row-key.
      lo_value = ls_row-value.
      IF lo_value IS NOT INITIAL.
        lv_tagvalue = lo_value->get_value( ).
      ENDIF.
    ENDLOOP.
    lv_origin = lo_aipromptdata->get_origin( ).
    lv_status = lo_aipromptdata->get_status( ).
  ENDIF.
ENDIF.