API for Amazon Q Connect¶

ABAP Package	`/AWS1/API_QQC_IMPL`
ABAP SDK "TLA"	`QQC`
ABAP Interface	`/AWS1/IF_QQC`

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 Q Connect is QQC. 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 QConnect 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¶

Powered by Amazon Bedrock: Amazon Web Services implements automated abuse detection. Because Amazon Q in Connect is built on Amazon Bedrock, users can take full advantage of the controls implemented in Amazon Bedrock to enforce safety, security, and the responsible use of artificial intelligence (AI).

Amazon Q in Connect is a generative AI customer service assistant. It is an LLM-enhanced evolution of Amazon Connect Wisdom that delivers real-time recommendations to help contact center agents resolve customer issues quickly and accurately.

Amazon Q in Connect automatically detects customer intent during calls and chats using conversational analytics and natural language understanding (NLU). It then provides agents with immediate, real-time generative responses and suggested actions, and links to relevant documents and articles. Agents can also query Amazon Q in Connect directly using natural language or keywords to answer customer requests.

Use the Amazon Q in Connect APIs to create an assistant and a knowledge base, for example, or manage content by uploading custom files.

For more information, see Use Amazon Q in Connect for generative AI powered agent assistance in real-time in the Amazon Connect Administrator Guide.

Using the SDK¶

In your code, create a client using the SDK module for Amazon Q Connect, which is created with factory method /AWS1/CL_QQC_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_qqc)       = /aws1/cl_qqc_factory=>create( go_session ).

Your variable go_qqc is an instance of /AWS1/IF_QQC, and all of the operations in the Amazon Q Connect service are accessed by calling methods in /AWS1/IF_QQC.

API Operations¶

For an overview of ABAP method calls corresponding to API operations in Amazon Q Connect, see the Operation List.

Factory Method¶

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

Creates an object of type /AWS1/IF_QQC.

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_QQC` `/AWS1/IF_QQC`¶

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

Configuring Programmatically¶

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

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

Paginators¶

Paginators for Amazon Q Connect can be created via get_paginator() which returns a paginator object of type /AWS1/IF_QQC_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 Q Connect can be found in interface /AWS1/IF_QQC_PAGINATOR.