Skip to content

/AWS1/CL_QQCMODELSUMMARY

The summary of a model available to an Amazon Q in Connect assistant.

CONSTRUCTOR

IMPORTING

Required arguments:

iv_modelid TYPE /AWS1/QQCMODELID /AWS1/QQCMODELID

The identifier of the model.

iv_displayname TYPE /AWS1/QQCMODELDISPLAYNAME /AWS1/QQCMODELDISPLAYNAME

The display name of the model.

Optional arguments:

iv_crossregionstatus TYPE /AWS1/QQCCROSSREGIONSTATUS /AWS1/QQCCROSSREGIONSTATUS

The cross-region availability status of the model. NONE indicates the model is only available in a single region, REGIONAL indicates the model is available through regional inference, and GLOBAL indicates the model is available through global cross-region inference.

iv_supportspromptcaching TYPE /AWS1/QQCBOOLEAN /AWS1/QQCBOOLEAN

Whether the model supports prompt caching.

it_supportedaiprompttypes TYPE /AWS1/CL_QQCAIPROMPTTYPELIST_W=>TT_AIPROMPTTYPELIST TT_AIPROMPTTYPELIST

The list of AI Prompt types that the model supports.

iv_modellifecycle TYPE /AWS1/QQCMODELLIFECYCLE /AWS1/QQCMODELLIFECYCLE

The current lifecycle of the model. ACTIVE indicates the model is recommended for use and LEGACY indicates the model is still usable but is deprecated.

iv_legacytimestamp TYPE /AWS1/QQCTIMESTAMP /AWS1/QQCTIMESTAMP

The timestamp when the model lifecycle will transition from ACTIVE to LEGACY.

iv_endoflifetimestamp TYPE /AWS1/QQCTIMESTAMP /AWS1/QQCTIMESTAMP

The timestamp when the model will reach end of life and no longer be available for use.


Queryable Attributes

modelId

The identifier of the model.

Accessible with the following methods

Method Description
GET_MODELID() Getter for MODELID, with configurable default
ASK_MODELID() Getter for MODELID w/ exceptions if field has no value
HAS_MODELID() Determine if MODELID has a value

displayName

The display name of the model.

Accessible with the following methods

Method Description
GET_DISPLAYNAME() Getter for DISPLAYNAME, with configurable default
ASK_DISPLAYNAME() Getter for DISPLAYNAME w/ exceptions if field has no value
HAS_DISPLAYNAME() Determine if DISPLAYNAME has a value

crossRegionStatus

The cross-region availability status of the model. NONE indicates the model is only available in a single region, REGIONAL indicates the model is available through regional inference, and GLOBAL indicates the model is available through global cross-region inference.

Accessible with the following methods

Method Description
GET_CROSSREGIONSTATUS() Getter for CROSSREGIONSTATUS, with configurable default
ASK_CROSSREGIONSTATUS() Getter for CROSSREGIONSTATUS w/ exceptions if field has no v
HAS_CROSSREGIONSTATUS() Determine if CROSSREGIONSTATUS has a value

supportsPromptCaching

Whether the model supports prompt caching.

Accessible with the following methods

Method Description
GET_SUPPORTSPROMPTCACHING() Getter for SUPPORTSPROMPTCACHING, with configurable default
ASK_SUPPORTSPROMPTCACHING() Getter for SUPPORTSPROMPTCACHING w/ exceptions if field has
HAS_SUPPORTSPROMPTCACHING() Determine if SUPPORTSPROMPTCACHING has a value

supportedAIPromptTypes

The list of AI Prompt types that the model supports.

Accessible with the following methods

Method Description
GET_SUPPORTEDAIPROMPTTYPES() Getter for SUPPORTEDAIPROMPTTYPES, with configurable default
ASK_SUPPORTEDAIPROMPTTYPES() Getter for SUPPORTEDAIPROMPTTYPES w/ exceptions if field has
HAS_SUPPORTEDAIPROMPTTYPES() Determine if SUPPORTEDAIPROMPTTYPES has a value

modelLifecycle

The current lifecycle of the model. ACTIVE indicates the model is recommended for use and LEGACY indicates the model is still usable but is deprecated.

Accessible with the following methods

Method Description
GET_MODELLIFECYCLE() Getter for MODELLIFECYCLE, with configurable default
ASK_MODELLIFECYCLE() Getter for MODELLIFECYCLE w/ exceptions if field has no valu
HAS_MODELLIFECYCLE() Determine if MODELLIFECYCLE has a value

legacyTimestamp

The timestamp when the model lifecycle will transition from ACTIVE to LEGACY.

Accessible with the following methods

Method Description
GET_LEGACYTIMESTAMP() Getter for LEGACYTIMESTAMP, with configurable default
ASK_LEGACYTIMESTAMP() Getter for LEGACYTIMESTAMP w/ exceptions if field has no val
HAS_LEGACYTIMESTAMP() Determine if LEGACYTIMESTAMP has a value

endOfLifeTimestamp

The timestamp when the model will reach end of life and no longer be available for use.

Accessible with the following methods

Method Description
GET_ENDOFLIFETIMESTAMP() Getter for ENDOFLIFETIMESTAMP, with configurable default
ASK_ENDOFLIFETIMESTAMP() Getter for ENDOFLIFETIMESTAMP w/ exceptions if field has no
HAS_ENDOFLIFETIMESTAMP() Determine if ENDOFLIFETIMESTAMP has a value

Public Local Types In This Class

Internal table types, representing arrays and maps of this class, are defined as local types:

TT_MODELSUMMARYLIST

TYPES TT_MODELSUMMARYLIST TYPE STANDARD TABLE OF REF TO /AWS1/CL_QQCMODELSUMMARY WITH DEFAULT KEY
.