Skip to content

/AWS1/IF_TEX=>CREATEADAPTER()

About CreateAdapter

Creates an adapter, which can be fine-tuned for enhanced performance on user provided documents. Takes an AdapterName and FeatureType. Currently the only supported feature type is QUERIES. You can also provide a Description, Tags, and a ClientRequestToken. You can choose whether or not the adapter should be AutoUpdated with the AutoUpdate argument. By default, AutoUpdate is set to DISABLED.

Method Signature

METHODS /AWS1/IF_TEX~CREATEADAPTER
  IMPORTING
    !IV_ADAPTERNAME TYPE /AWS1/TEXADAPTERNAME OPTIONAL
    !IV_CLIENTREQUESTTOKEN TYPE /AWS1/TEXCLIENTREQUESTTOKEN OPTIONAL
    !IV_DESCRIPTION TYPE /AWS1/TEXADAPTERDESCRIPTION OPTIONAL
    !IT_FEATURETYPES TYPE /AWS1/CL_TEXFEATURETYPES_W=>TT_FEATURETYPES OPTIONAL
    !IV_AUTOUPDATE TYPE /AWS1/TEXAUTOUPDATE OPTIONAL
    !IT_TAGS TYPE /AWS1/CL_TEXTAGMAP_W=>TT_TAGMAP OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_texcreateadapterrsp
  RAISING
    /AWS1/CX_TEXACCESSDENIEDEX
    /AWS1/CX_TEXCONFLICTEXCEPTION
    /AWS1/CX_TEXIDEMPOTENTPRMMIS00
    /AWS1/CX_TEXINTERNALSERVERERR
    /AWS1/CX_TEXINVALIDPARAMETEREX
    /AWS1/CX_TEXLIMITEXCEEDEDEX
    /AWS1/CX_TEXPROVTHRUPUTEXCDEX
    /AWS1/CX_TEXSERVICEQUOTAEXCDEX
    /AWS1/CX_TEXTHROTTLINGEX
    /AWS1/CX_TEXVALIDATIONEX
    /AWS1/CX_TEXCLIENTEXC
    /AWS1/CX_TEXSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_adaptername TYPE /AWS1/TEXADAPTERNAME /AWS1/TEXADAPTERNAME

The name to be assigned to the adapter being created.

it_featuretypes TYPE /AWS1/CL_TEXFEATURETYPES_W=>TT_FEATURETYPES TT_FEATURETYPES

The type of feature that the adapter is being trained on. Currrenly, supported feature types are: QUERIES

Optional arguments:

iv_clientrequesttoken TYPE /AWS1/TEXCLIENTREQUESTTOKEN /AWS1/TEXCLIENTREQUESTTOKEN

Idempotent token is used to recognize the request. If the same token is used with multiple CreateAdapter requests, the same session is returned. This token is employed to avoid unintentionally creating the same session multiple times.

iv_description TYPE /AWS1/TEXADAPTERDESCRIPTION /AWS1/TEXADAPTERDESCRIPTION

The description to be assigned to the adapter being created.

iv_autoupdate TYPE /AWS1/TEXAUTOUPDATE /AWS1/TEXAUTOUPDATE

Controls whether or not the adapter should automatically update.

it_tags TYPE /AWS1/CL_TEXTAGMAP_W=>TT_TAGMAP TT_TAGMAP

A list of tags to be added to the adapter.

RETURNING

oo_output TYPE REF TO /aws1/cl_texcreateadapterrsp /AWS1/CL_TEXCREATEADAPTERRSP

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->createadapter(
  it_featuretypes = VALUE /aws1/cl_texfeaturetypes_w=>tt_featuretypes(
    ( new /aws1/cl_texfeaturetypes_w( |string| ) )
  )
  it_tags = VALUE /aws1/cl_textagmap_w=>tt_tagmap(
    (
      VALUE /aws1/cl_textagmap_w=>ts_tagmap_maprow(
        value = new /aws1/cl_textagmap_w( |string| )
        key = |string|
      )
    )
  )
  iv_adaptername = |string|
  iv_autoupdate = |string|
  iv_clientrequesttoken = |string|
  iv_description = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_adapterid = lo_result->get_adapterid( ).
ENDIF.