API for Amazon Bedrock Runtime¶
ABAP Package | /AWS1/API_BDR_IMPL |
---|---|
ABAP SDK "TLA" | BDR |
ABAP Interface | /AWS1/IF_BDR |
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 Bedrock Runtime is BDR
.
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 Bedrock Runtime 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¶
Describes the API operations for running inference using Amazon Bedrock models.
Using the SDK¶
In your code, create a client using the SDK module for Amazon Bedrock Runtime, which is created with
factory method /AWS1/CL_BDR_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_bdr) = /aws1/cl_bdr_factory=>create( go_session ).
Your variable go_bdr
is an instance of /AWS1/IF_BDR
,
and all of the operations
in the Amazon Bedrock Runtime service are accessed by calling methods in /AWS1/IF_BDR
.
API Operations¶
For an overview of ABAP method calls corresponding to API operations in Amazon Bedrock Runtime, see the Operation List.
Factory Method¶
/AWS1/CL_BDR_FACTORY=>create( )
¶
Creates an object of type /AWS1/IF_BDR
.
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_BDR
/AWS1/IF_BDR
¶
/AWS1/IF_BDR
represents the ABAP client for the Bedrock Runtime service, representing each operation as a method call. For more information see the API Page page.
Configuring Programmatically¶
DATA(lo_config) = DATA(go_bdr)->get_config( ).
lo_config
is a variable of type /AWS1/CL_BDR_CONFIG
. See the documentation for /AWS1/CL_BDR_CONFIG
for
details on the settings that can be configured.
Paginators¶
Paginators for Amazon Bedrock Runtime can be created via get_paginator()
which returns a paginator object of type /AWS1/IF_BDR_PAGINATOR
. The operation method that is being paginated is called using the paginator object, which accepts any necessary parameters to provide to the underlying API operation. This returns an iterator object which can be used to iterate over paginated results using has_next()
and get_next()
methods.
Details about the paginator methods available for service Amazon Bedrock Runtime can be found in interface /AWS1/IF_BDR_PAGINATOR
.
Level 2 ("L2") Functionality¶
This module includes higher-level Level 2 or "L2" functions beyond the basic web API. The L2 functionality builds on top of the basic API by providing convenience functions to simplify the use of the service for ABAP programmers. The L2 functionality does not replace the lower-level API functions but may be useful in simplifying ABAP code.
The L2 client can be created using the methods of the factory class
/aws1/cl_bdr_l2_factory
. See the documentation of that class for more details.