API for Amazon S3 Vectors¶
| ABAP Package | /AWS1/API_S3V_IMPL |
|---|---|
| ABAP SDK "TLA" | S3V |
| ABAP Interface | /AWS1/IF_S3V |
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 S3 Vectors is S3V.
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 S3Vectors 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 S3 vector buckets are a bucket type to store and search vectors with sub-second search times. They are designed to provide dedicated API operations for you to interact with vectors to do similarity search. Within a vector bucket, you use a vector index to organize and logically group your vector data. When you make a write or read request, you direct it to a single vector index. You store your vector data as vectors. A vector contains a key (a name that you assign), a multi-dimensional vector, and, optionally, metadata that describes a vector. The key uniquely identifies the vector in a vector index.
Using the SDK¶
In your code, create a client using the SDK module for Amazon S3 Vectors, which is created with
factory method /AWS1/CL_S3V_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_s3v) = /aws1/cl_s3v_factory=>create( go_session ).
Your variable go_s3v is an instance of /AWS1/IF_S3V,
and all of the operations
in the Amazon S3 Vectors service are accessed by calling methods in /AWS1/IF_S3V.
API Operations¶
For an overview of ABAP method calls corresponding to API operations in Amazon S3 Vectors, see the Operation List.
Factory Method¶
/AWS1/CL_S3V_FACTORY=>create( )¶
Creates an object of type /AWS1/IF_S3V.
IMPORTING¶
Optional arguments:¶
iv_protocol TYPE /aws1/rt_protocol /AWS1/RT_PROTOCOL¶
Domain /AWS1/RT_ACCOUNT_ID Primitive Type NUMC
io_session TYPE REF TO /aws1/cl_rt_session_base /AWS1/CL_RT_SESSION_BASE¶
Domain /AWS1/RT_ACCOUNT_ID Primitive Type NUMC
iv_region TYPE /aws1/rt_region_id /AWS1/RT_REGION_ID¶
Domain /AWS1/RT_ACCOUNT_ID Primitive Type NUMC
iv_custom_endpoint TYPE /aws1/rt_endpoint /AWS1/RT_ENDPOINT¶
Domain /AWS1/RT_ACCOUNT_ID Primitive Type NUMC
RETURNING¶
oo_client TYPE REF TO /aws1/if_s3v /AWS1/IF_S3V¶
/AWS1/IF_S3Vrepresents the ABAP client for the S3Vectors service, representing each operation as a method call. For more information see the API Page page.
Configuring Programmatically¶
DATA(lo_config) = DATA(go_s3v)->get_config( ).
lo_config is a variable of type /AWS1/CL_S3V_CONFIG. See the documentation for /AWS1/CL_S3V_CONFIG for
details on the settings that can be configured.
Paginators¶
Paginators for Amazon S3 Vectors can be created via `get_paginator()` which returns a paginator object of type [`/AWS1/IF_S3V_PAGINATOR`](./_AWS1_IF_S3V_PAGINATOR.md). 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 S3 Vectors can be found in interface [`/AWS1/IF_S3V_PAGINATOR`](./_AWS1_IF_S3V_PAGINATOR.md).