/AWS1/IF_CNT=>CREATEEXTRACTIONDEFINITION()

About CreateExtractionDefinition

Creates an extraction definition in the specified Connect Customer instance. An extraction definition specifies how structured data is extracted from customer interactions using generative AI, including the prompt hint that guides extraction and the behavior when a value cannot be found.

Method Signature

METHODS /AWS1/IF_CNT~CREATEEXTRACTIONDEFINITION
  IMPORTING
    !IV_CLIENTTOKEN TYPE /AWS1/CNTCLIENTTOKEN OPTIONAL
    !IV_INSTANCEID TYPE /AWS1/CNTINSTANCEID OPTIONAL
    !IV_NAME TYPE /AWS1/CNTEXTDEFINITIONNAME OPTIONAL
    !IO_EXTRACTIONCONFIGURATION TYPE REF TO /AWS1/CL_CNTEXTRACTIONCONF OPTIONAL
    !IO_DISPLAY TYPE REF TO /AWS1/CL_CNTEXTDEFNDISPLAY OPTIONAL
    !IT_TAGS TYPE /AWS1/CL_CNTTAGMAP_W=>TT_TAGMAP OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_cntcreateextdefnrsp
  RAISING
    /AWS1/CX_CNTACCESSDENIEDEX
    /AWS1/CX_CNTINTERNALSERVICEEX
    /AWS1/CX_CNTINVALIDREQUESTEX
    /AWS1/CX_CNTRESOURCECONFLICTEX
    /AWS1/CX_CNTRESOURCENOTFOUNDEX
    /AWS1/CX_CNTSERVICEQUOTAEXCDEX
    /AWS1/CX_CNTTHROTTLINGEX
    /AWS1/CX_CNTCLIENTEXC
    /AWS1/CX_CNTSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_instanceid TYPE /AWS1/CNTINSTANCEID /AWS1/CNTINSTANCEID

The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

iv_name TYPE /AWS1/CNTEXTDEFINITIONNAME /AWS1/CNTEXTDEFINITIONNAME

A unique name of the extraction definition.

io_extractionconfiguration TYPE REF TO /AWS1/CL_CNTEXTRACTIONCONF /AWS1/CL_CNTEXTRACTIONCONF

The configuration that defines how data is extracted, including the prompt hint and not-found behavior.

Optional arguments:

iv_clienttoken TYPE /AWS1/CNTCLIENTTOKEN /AWS1/CNTCLIENTTOKEN

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.

io_display TYPE REF TO /AWS1/CL_CNTEXTDEFNDISPLAY /AWS1/CL_CNTEXTDEFNDISPLAY

The display settings for the extraction definition, including the label shown in the agent workspace.

it_tags TYPE /AWS1/CL_CNTTAGMAP_W=>TT_TAGMAP TT_TAGMAP

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

RETURNING

oo_output TYPE REF TO /aws1/cl_cntcreateextdefnrsp /AWS1/CL_CNTCREATEEXTDEFNRSP

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->createextractiondefinition(
  io_display = new /aws1/cl_cntextdefndisplay( |string| )
  io_extractionconfiguration = new /aws1/cl_cntextractionconf(
    io_notfoundbehavior = new /aws1/cl_cntextdefnnotfndbehav(
      iv_behavior = |string|
      iv_defaultvalue = |string|
    )
    iv_prompthint = |string|
  )
  it_tags = VALUE /aws1/cl_cnttagmap_w=>tt_tagmap(
    (
      VALUE /aws1/cl_cnttagmap_w=>ts_tagmap_maprow(
        key = |string|
        value = new /aws1/cl_cnttagmap_w( |string| )
      )
    )
  )
  iv_clienttoken = |string|
  iv_instanceid = |string|
  iv_name = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_arn = lo_result->get_extractiondefinitionarn( ).
  lv_extractiondefinitionid = lo_result->get_extractiondefinitionid( ).
ENDIF.