API for QBusiness¶

ABAP Package	`/AWS1/API_QQB_IMPL`
ABAP SDK "TLA"	`QQB`
ABAP Interface	`/AWS1/IF_QQB`

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 QBusiness is QQB. 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 QBusiness 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¶

This is the Amazon Q Business API Reference. Amazon Q Business is a fully managed, generative-AI powered enterprise chat assistant that you can deploy within your organization. Amazon Q Business enhances employee productivity by supporting key tasks such as question-answering, knowledge discovery, writing email messages, summarizing text, drafting document outlines, and brainstorming ideas. Users ask questions of Amazon Q Business and get answers that are presented in a conversational manner. For an introduction to the service, see the Amazon Q Business User Guide .

For an overview of the Amazon Q Business APIs, see Overview of Amazon Q Business API operations.

For information about the IAM access control permissions you need to use this API, see IAM roles for Amazon Q Business in the Amazon Q Business User Guide.

The following resources provide additional information about using the Amazon Q Business API:

Using the SDK¶

In your code, create a client using the SDK module for QBusiness, which is created with factory method /AWS1/CL_QQB_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_qqb)       = /aws1/cl_qqb_factory=>create( go_session ).

Your variable go_qqb is an instance of /AWS1/IF_QQB, and all of the operations in the QBusiness service are accessed by calling methods in /AWS1/IF_QQB.

API Operations¶

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

Factory Method¶

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

Creates an object of type /AWS1/IF_QQB.

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_QQB` `/AWS1/IF_QQB`¶

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

Configuring Programmatically¶

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

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

Paginators¶

Paginators for QBusiness can be created via get_paginator() which returns a paginator object of type /AWS1/IF_QQB_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 QBusiness can be found in interface /AWS1/IF_QQB_PAGINATOR.