ModelSummary
The summary of a model available to an Amazon Q in Connect assistant.
Contents
- displayName
-
The display name of the model.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Required: Yes
- modelId
-
The identifier of the model.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Required: Yes
- crossRegionStatus
-
The cross-region availability status of the model.
NONEindicates the model is only available in a single region,REGIONALindicates the model is available through regional inference, andGLOBALindicates the model is available through global cross-region inference.Type: String
Valid Values:
NONE | REGIONAL | GLOBALRequired: No
- endOfLifeTimestamp
-
The timestamp when the model will reach end of life and no longer be available for use.
Type: Timestamp
Required: No
- legacyTimestamp
-
The timestamp when the model lifecycle will transition from
ACTIVEtoLEGACY.Type: Timestamp
Required: No
- modelLifecycle
-
The current lifecycle of the model.
ACTIVEindicates the model is recommended for use andLEGACYindicates the model is still usable but is deprecated.Type: String
Valid Values:
ACTIVE | LEGACYRequired: No
- supportedAIPromptTypes
-
The list of AI Prompt types that the model supports.
Type: Array of strings
Valid Values:
ANSWER_GENERATION | INTENT_LABELING_GENERATION | QUERY_REFORMULATION | SELF_SERVICE_PRE_PROCESSING | SELF_SERVICE_ANSWER_GENERATION | EMAIL_RESPONSE | EMAIL_OVERVIEW | EMAIL_GENERATIVE_ANSWER | EMAIL_QUERY_REFORMULATION | ORCHESTRATION | NOTE_TAKING | CASE_SUMMARIZATIONRequired: No
- supportsPromptCaching
-
Whether the model supports prompt caching.
Type: Boolean
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
