API for Amazon Lex Runtime Service¶

ABAP Package	`/AWS1/API_LR1_IMPL`
ABAP SDK "TLA"	`LR1`
ABAP Interface	`/AWS1/IF_LR1`

The "TLA" is a Three Letter Abbreviation that appears in ABAP class names, data dictionary objects and other ABAP objects throughout the AWS SDK for SAP ABAP. The TLA for Amazon Lex Runtime Service is LR1. This TLA helps squeeze ABAP objects into the 30-character length limit of the ABAP data dictionary.

Installation¶

To install the AWS SDK for SAP ABAP, import the Core transport, along with the transport for the Lex Runtime Service module and other API modules you are interested in. A few modules are included in the Core transport itself. For more information, see the Developer Guide guide.

About The Service¶

Amazon Lex provides both build and runtime endpoints. Each endpoint provides a set of operations (API). Your conversational bot uses the runtime API to understand user utterances (user input text or voice). For example, suppose a user says "I want pizza", your bot sends this input to Amazon Lex using the runtime API. Amazon Lex recognizes that the user request is for the OrderPizza intent (one of the intents defined in the bot). Then Amazon Lex engages in user conversation on behalf of the bot to elicit required information (slot values, such as pizza size and crust type), and then performs fulfillment activity (that you configured when you created the bot). You use the build-time API to create and manage your Amazon Lex bot. For a list of build-time operations, see the build-time API, .

Using the SDK¶

In your code, create a client using the SDK module for Amazon Lex Runtime Service, which is created with factory method /AWS1/CL_LR1_FACTORY=>create(). In this example we will assume you have configured an SDK profile in transaction /AWS1/IMG called ZFINANCE.

DATA(go_session)   = /aws1/cl_rt_session_aws=>create( 'ZFINANCE' ).
DATA(go_lr1)       = /aws1/cl_lr1_factory=>create( go_session ).

Your variable go_lr1 is an instance of /AWS1/IF_LR1, and all of the operations in the Amazon Lex Runtime Service service are accessed by calling methods in /AWS1/IF_LR1.

API Operations¶

For an overview of ABAP method calls corresponding to API operations in Amazon Lex Runtime Service, see the Operation List.

Factory Method¶

`/AWS1/CL_LR1_FACTORY=>create( )`¶

Creates an object of type /AWS1/IF_LR1.

IMPORTING¶

Optional arguments:¶

`IV_PROTOCOL` `TYPE /AWS1/RT_PROTOCOL` `/AWS1/RT_PROTOCOL`¶

`IO_SESSION` `TYPE REF TO /AWS1/CL_RT_SESSION_BASE` `/AWS1/CL_RT_SESSION_BASE`¶

`IV_REGION` `TYPE /AWS1/RT_REGION_ID` `/AWS1/RT_REGION_ID`¶

`IV_CUSTOM_ENDPOINT` `TYPE /AWS1/RT_ENDPOINT` `/AWS1/RT_ENDPOINT`¶

RETURNING¶

`OO_CLIENT` `TYPE REF TO /AWS1/IF_LR1` `/AWS1/IF_LR1`¶

/AWS1/IF_LR1 represents the ABAP client for the Lex Runtime Service service, representing each operation as a method call. For more information see the API Page page.

Configuring Programmatically¶

DATA(lo_config) = DATA(go_lr1)->get_config( ).

lo_config is a variable of type /AWS1/CL_LR1_CONFIG. See the documentation for /AWS1/CL_LR1_CONFIG for details on the settings that can be configured.