aws-sdk-qconnect 1.54.0 → 1.55.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-qconnect/client.rb +66 -1
- data/lib/aws-sdk-qconnect/client_api.rb +54 -0
- data/lib/aws-sdk-qconnect/types.rb +113 -0
- data/lib/aws-sdk-qconnect.rb +1 -1
- data/sig/client.rbs +15 -0
- data/sig/types.rbs +27 -0
- metadata +1 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 9fed72a8fcfedc9cf9b750f43c4cbc4656624c54559563896ecdb8434110b4b6
|
|
4
|
+
data.tar.gz: 5c11c05b5abbe22f4a85db5d8c3ddc421f51928d0d948e83a685c14c27629a13
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: d7875f521d4f3bf6576b56252e4411651179814aec8486fc6748e1684c4ca8c07b2c7c8f06ff3433f5466ee4b7300543bb6fe340c63a97be8c977596810cf787
|
|
7
|
+
data.tar.gz: 22e5bac35758efcb308f058581f74730d0f7733d39f9baf71337e112afd13a3cb9ddbd3446d3f4771d631533ef3701799b8a1c5ff98145e61aa11cd210a4d3b1
|
data/CHANGELOG.md
CHANGED
|
@@ -1,6 +1,11 @@
|
|
|
1
1
|
Unreleased Changes
|
|
2
2
|
------------------
|
|
3
3
|
|
|
4
|
+
1.55.0 (2026-05-14)
|
|
5
|
+
------------------
|
|
6
|
+
|
|
7
|
+
* Feature - ListModels is an API that returns the available AI models for a Connect Assistant based on its region and AI prompt type.
|
|
8
|
+
|
|
4
9
|
1.54.0 (2026-05-13)
|
|
5
10
|
------------------
|
|
6
11
|
|
data/VERSION
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
1.
|
|
1
|
+
1.55.0
|
|
@@ -6065,6 +6065,71 @@ module Aws::QConnect
|
|
|
6065
6065
|
req.send_request(options)
|
|
6066
6066
|
end
|
|
6067
6067
|
|
|
6068
|
+
# Lists the models available to an Amazon Q in Connect assistant in the
|
|
6069
|
+
# assistant's Amazon Web Services Region. The available models are
|
|
6070
|
+
# determined by the region of the specified assistant.
|
|
6071
|
+
#
|
|
6072
|
+
# @option params [required, String] :assistant_id
|
|
6073
|
+
# The identifier of the Amazon Q in Connect assistant. Can be either the
|
|
6074
|
+
# ID or the ARN. URLs cannot contain the ARN. The assistant's region
|
|
6075
|
+
# determines which models are available.
|
|
6076
|
+
#
|
|
6077
|
+
# @option params [String] :ai_prompt_type
|
|
6078
|
+
# The type of the AI Prompt to filter models by. When specified, only
|
|
6079
|
+
# models that support the given AI Prompt type are returned.
|
|
6080
|
+
#
|
|
6081
|
+
# @option params [String] :model_lifecycle
|
|
6082
|
+
# The lifecycle status of models to filter by. When specified, only
|
|
6083
|
+
# models with the given lifecycle status are returned.
|
|
6084
|
+
#
|
|
6085
|
+
# @option params [String] :next_token
|
|
6086
|
+
# The token for the next set of results. Use the value returned in the
|
|
6087
|
+
# previous response in the next request to retrieve the next set of
|
|
6088
|
+
# results.
|
|
6089
|
+
#
|
|
6090
|
+
# @option params [Integer] :max_results
|
|
6091
|
+
# The maximum number of results to return per page.
|
|
6092
|
+
#
|
|
6093
|
+
# @return [Types::ListModelsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
6094
|
+
#
|
|
6095
|
+
# * {Types::ListModelsResponse#model_summaries #model_summaries} => Array<Types::ModelSummary>
|
|
6096
|
+
# * {Types::ListModelsResponse#next_token #next_token} => String
|
|
6097
|
+
#
|
|
6098
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
|
6099
|
+
#
|
|
6100
|
+
# @example Request syntax with placeholder values
|
|
6101
|
+
#
|
|
6102
|
+
# resp = client.list_models({
|
|
6103
|
+
# assistant_id: "UuidOrArn", # required
|
|
6104
|
+
# ai_prompt_type: "ANSWER_GENERATION", # accepts 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_SUMMARIZATION
|
|
6105
|
+
# model_lifecycle: "ACTIVE", # accepts ACTIVE, LEGACY
|
|
6106
|
+
# next_token: "NextToken",
|
|
6107
|
+
# max_results: 1,
|
|
6108
|
+
# })
|
|
6109
|
+
#
|
|
6110
|
+
# @example Response structure
|
|
6111
|
+
#
|
|
6112
|
+
# resp.model_summaries #=> Array
|
|
6113
|
+
# resp.model_summaries[0].model_id #=> String
|
|
6114
|
+
# resp.model_summaries[0].display_name #=> String
|
|
6115
|
+
# resp.model_summaries[0].cross_region_status #=> String, one of "NONE", "REGIONAL", "GLOBAL"
|
|
6116
|
+
# resp.model_summaries[0].supports_prompt_caching #=> Boolean
|
|
6117
|
+
# resp.model_summaries[0].supported_ai_prompt_types #=> Array
|
|
6118
|
+
# resp.model_summaries[0].supported_ai_prompt_types[0] #=> String, one of "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_SUMMARIZATION"
|
|
6119
|
+
# resp.model_summaries[0].model_lifecycle #=> String, one of "ACTIVE", "LEGACY"
|
|
6120
|
+
# resp.model_summaries[0].legacy_timestamp #=> Time
|
|
6121
|
+
# resp.model_summaries[0].end_of_life_timestamp #=> Time
|
|
6122
|
+
# resp.next_token #=> String
|
|
6123
|
+
#
|
|
6124
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ListModels AWS API Documentation
|
|
6125
|
+
#
|
|
6126
|
+
# @overload list_models(params = {})
|
|
6127
|
+
# @param [Hash] params ({})
|
|
6128
|
+
def list_models(params = {}, options = {})
|
|
6129
|
+
req = build_request(:list_models, params)
|
|
6130
|
+
req.send_request(options)
|
|
6131
|
+
end
|
|
6132
|
+
|
|
6068
6133
|
# Lists information about quick response.
|
|
6069
6134
|
#
|
|
6070
6135
|
# @option params [String] :next_token
|
|
@@ -9464,7 +9529,7 @@ module Aws::QConnect
|
|
|
9464
9529
|
tracer: tracer
|
|
9465
9530
|
)
|
|
9466
9531
|
context[:gem_name] = 'aws-sdk-qconnect'
|
|
9467
|
-
context[:gem_version] = '1.
|
|
9532
|
+
context[:gem_version] = '1.55.0'
|
|
9468
9533
|
Seahorse::Client::Request.new(handlers, context)
|
|
9469
9534
|
end
|
|
9470
9535
|
|
|
@@ -46,6 +46,7 @@ module Aws::QConnect
|
|
|
46
46
|
AIPromptTemplateConfiguration = Shapes::UnionShape.new(name: 'AIPromptTemplateConfiguration')
|
|
47
47
|
AIPromptTemplateType = Shapes::StringShape.new(name: 'AIPromptTemplateType')
|
|
48
48
|
AIPromptType = Shapes::StringShape.new(name: 'AIPromptType')
|
|
49
|
+
AIPromptTypeList = Shapes::ListShape.new(name: 'AIPromptTypeList')
|
|
49
50
|
AIPromptVersionSummariesList = Shapes::ListShape.new(name: 'AIPromptVersionSummariesList')
|
|
50
51
|
AIPromptVersionSummary = Shapes::StructureShape.new(name: 'AIPromptVersionSummary')
|
|
51
52
|
AccessDeniedException = Shapes::StructureShape.new(name: 'AccessDeniedException')
|
|
@@ -156,6 +157,7 @@ module Aws::QConnect
|
|
|
156
157
|
CreateQuickResponseResponse = Shapes::StructureShape.new(name: 'CreateQuickResponseResponse')
|
|
157
158
|
CreateSessionRequest = Shapes::StructureShape.new(name: 'CreateSessionRequest')
|
|
158
159
|
CreateSessionResponse = Shapes::StructureShape.new(name: 'CreateSessionResponse')
|
|
160
|
+
CrossRegionStatus = Shapes::StringShape.new(name: 'CrossRegionStatus')
|
|
159
161
|
CustomAttributes = Shapes::MapShape.new(name: 'CustomAttributes')
|
|
160
162
|
CustomerProfileAttributes = Shapes::StructureShape.new(name: 'CustomerProfileAttributes')
|
|
161
163
|
DataDetails = Shapes::UnionShape.new(name: 'DataDetails')
|
|
@@ -351,6 +353,8 @@ module Aws::QConnect
|
|
|
351
353
|
ListMessageTemplatesResponse = Shapes::StructureShape.new(name: 'ListMessageTemplatesResponse')
|
|
352
354
|
ListMessagesRequest = Shapes::StructureShape.new(name: 'ListMessagesRequest')
|
|
353
355
|
ListMessagesResponse = Shapes::StructureShape.new(name: 'ListMessagesResponse')
|
|
356
|
+
ListModelsRequest = Shapes::StructureShape.new(name: 'ListModelsRequest')
|
|
357
|
+
ListModelsResponse = Shapes::StructureShape.new(name: 'ListModelsResponse')
|
|
354
358
|
ListQuickResponsesRequest = Shapes::StructureShape.new(name: 'ListQuickResponsesRequest')
|
|
355
359
|
ListQuickResponsesResponse = Shapes::StructureShape.new(name: 'ListQuickResponsesResponse')
|
|
356
360
|
ListSpansRequest = Shapes::StructureShape.new(name: 'ListSpansRequest')
|
|
@@ -402,6 +406,11 @@ module Aws::QConnect
|
|
|
402
406
|
MessageTemplateVersionSummary = Shapes::StructureShape.new(name: 'MessageTemplateVersionSummary')
|
|
403
407
|
MessageTemplateVersionSummaryList = Shapes::ListShape.new(name: 'MessageTemplateVersionSummaryList')
|
|
404
408
|
MessageType = Shapes::StringShape.new(name: 'MessageType')
|
|
409
|
+
ModelDisplayName = Shapes::StringShape.new(name: 'ModelDisplayName')
|
|
410
|
+
ModelId = Shapes::StringShape.new(name: 'ModelId')
|
|
411
|
+
ModelLifecycle = Shapes::StringShape.new(name: 'ModelLifecycle')
|
|
412
|
+
ModelSummary = Shapes::StructureShape.new(name: 'ModelSummary')
|
|
413
|
+
ModelSummaryList = Shapes::ListShape.new(name: 'ModelSummaryList')
|
|
405
414
|
Name = Shapes::StringShape.new(name: 'Name')
|
|
406
415
|
NextToken = Shapes::StringShape.new(name: 'NextToken')
|
|
407
416
|
NonEmptySensitiveString = Shapes::StringShape.new(name: 'NonEmptySensitiveString')
|
|
@@ -848,6 +857,8 @@ module Aws::QConnect
|
|
|
848
857
|
AIPromptTemplateConfiguration.add_member_subclass(:unknown, Types::AIPromptTemplateConfiguration::Unknown)
|
|
849
858
|
AIPromptTemplateConfiguration.struct_class = Types::AIPromptTemplateConfiguration
|
|
850
859
|
|
|
860
|
+
AIPromptTypeList.member = Shapes::ShapeRef.new(shape: AIPromptType)
|
|
861
|
+
|
|
851
862
|
AIPromptVersionSummariesList.member = Shapes::ShapeRef.new(shape: AIPromptVersionSummary)
|
|
852
863
|
|
|
853
864
|
AIPromptVersionSummary.add_member(:ai_prompt_summary, Shapes::ShapeRef.new(shape: AIPromptSummary, location_name: "aiPromptSummary"))
|
|
@@ -2077,6 +2088,17 @@ module Aws::QConnect
|
|
|
2077
2088
|
ListMessagesResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "nextToken"))
|
|
2078
2089
|
ListMessagesResponse.struct_class = Types::ListMessagesResponse
|
|
2079
2090
|
|
|
2091
|
+
ListModelsRequest.add_member(:assistant_id, Shapes::ShapeRef.new(shape: UuidOrArn, required: true, location: "uri", location_name: "assistantId"))
|
|
2092
|
+
ListModelsRequest.add_member(:ai_prompt_type, Shapes::ShapeRef.new(shape: AIPromptType, location: "querystring", location_name: "aiPromptType"))
|
|
2093
|
+
ListModelsRequest.add_member(:model_lifecycle, Shapes::ShapeRef.new(shape: ModelLifecycle, location: "querystring", location_name: "modelLifecycle"))
|
|
2094
|
+
ListModelsRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location: "querystring", location_name: "nextToken"))
|
|
2095
|
+
ListModelsRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResults, location: "querystring", location_name: "maxResults"))
|
|
2096
|
+
ListModelsRequest.struct_class = Types::ListModelsRequest
|
|
2097
|
+
|
|
2098
|
+
ListModelsResponse.add_member(:model_summaries, Shapes::ShapeRef.new(shape: ModelSummaryList, required: true, location_name: "modelSummaries"))
|
|
2099
|
+
ListModelsResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "nextToken"))
|
|
2100
|
+
ListModelsResponse.struct_class = Types::ListModelsResponse
|
|
2101
|
+
|
|
2080
2102
|
ListQuickResponsesRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NonEmptyString, location: "querystring", location_name: "nextToken"))
|
|
2081
2103
|
ListQuickResponsesRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResults, location: "querystring", location_name: "maxResults"))
|
|
2082
2104
|
ListQuickResponsesRequest.add_member(:knowledge_base_id, Shapes::ShapeRef.new(shape: UuidOrArn, required: true, location: "uri", location_name: "knowledgeBaseId"))
|
|
@@ -2293,6 +2315,18 @@ module Aws::QConnect
|
|
|
2293
2315
|
|
|
2294
2316
|
MessageTemplateVersionSummaryList.member = Shapes::ShapeRef.new(shape: MessageTemplateVersionSummary)
|
|
2295
2317
|
|
|
2318
|
+
ModelSummary.add_member(:model_id, Shapes::ShapeRef.new(shape: ModelId, required: true, location_name: "modelId"))
|
|
2319
|
+
ModelSummary.add_member(:display_name, Shapes::ShapeRef.new(shape: ModelDisplayName, required: true, location_name: "displayName"))
|
|
2320
|
+
ModelSummary.add_member(:cross_region_status, Shapes::ShapeRef.new(shape: CrossRegionStatus, location_name: "crossRegionStatus"))
|
|
2321
|
+
ModelSummary.add_member(:supports_prompt_caching, Shapes::ShapeRef.new(shape: Boolean, location_name: "supportsPromptCaching"))
|
|
2322
|
+
ModelSummary.add_member(:supported_ai_prompt_types, Shapes::ShapeRef.new(shape: AIPromptTypeList, location_name: "supportedAIPromptTypes"))
|
|
2323
|
+
ModelSummary.add_member(:model_lifecycle, Shapes::ShapeRef.new(shape: ModelLifecycle, location_name: "modelLifecycle"))
|
|
2324
|
+
ModelSummary.add_member(:legacy_timestamp, Shapes::ShapeRef.new(shape: Timestamp, location_name: "legacyTimestamp"))
|
|
2325
|
+
ModelSummary.add_member(:end_of_life_timestamp, Shapes::ShapeRef.new(shape: Timestamp, location_name: "endOfLifeTimestamp"))
|
|
2326
|
+
ModelSummary.struct_class = Types::ModelSummary
|
|
2327
|
+
|
|
2328
|
+
ModelSummaryList.member = Shapes::ShapeRef.new(shape: ModelSummary)
|
|
2329
|
+
|
|
2296
2330
|
NoteTakingAIAgentConfiguration.add_member(:note_taking_ai_prompt_id, Shapes::ShapeRef.new(shape: UuidWithQualifier, location_name: "noteTakingAIPromptId"))
|
|
2297
2331
|
NoteTakingAIAgentConfiguration.add_member(:note_taking_ai_guardrail_id, Shapes::ShapeRef.new(shape: UuidWithQualifier, location_name: "noteTakingAIGuardrailId"))
|
|
2298
2332
|
NoteTakingAIAgentConfiguration.add_member(:locale, Shapes::ShapeRef.new(shape: NonEmptyString, location_name: "locale"))
|
|
@@ -4193,6 +4227,26 @@ module Aws::QConnect
|
|
|
4193
4227
|
)
|
|
4194
4228
|
end)
|
|
4195
4229
|
|
|
4230
|
+
api.add_operation(:list_models, Seahorse::Model::Operation.new.tap do |o|
|
|
4231
|
+
o.name = "ListModels"
|
|
4232
|
+
o.http_method = "GET"
|
|
4233
|
+
o.http_request_uri = "/assistants/{assistantId}/models"
|
|
4234
|
+
o.input = Shapes::ShapeRef.new(shape: ListModelsRequest)
|
|
4235
|
+
o.output = Shapes::ShapeRef.new(shape: ListModelsResponse)
|
|
4236
|
+
o.errors << Shapes::ShapeRef.new(shape: ValidationException)
|
|
4237
|
+
o.errors << Shapes::ShapeRef.new(shape: ConflictException)
|
|
4238
|
+
o.errors << Shapes::ShapeRef.new(shape: UnauthorizedException)
|
|
4239
|
+
o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
|
|
4240
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
|
4241
|
+
o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
|
|
4242
|
+
o[:pager] = Aws::Pager.new(
|
|
4243
|
+
limit_key: "max_results",
|
|
4244
|
+
tokens: {
|
|
4245
|
+
"next_token" => "next_token"
|
|
4246
|
+
}
|
|
4247
|
+
)
|
|
4248
|
+
end)
|
|
4249
|
+
|
|
4196
4250
|
api.add_operation(:list_quick_responses, Seahorse::Model::Operation.new.tap do |o|
|
|
4197
4251
|
o.name = "ListQuickResponses"
|
|
4198
4252
|
o.http_method = "GET"
|
|
@@ -7010,6 +7010,62 @@ module Aws::QConnect
|
|
|
7010
7010
|
include Aws::Structure
|
|
7011
7011
|
end
|
|
7012
7012
|
|
|
7013
|
+
# @!attribute [rw] assistant_id
|
|
7014
|
+
# The identifier of the Amazon Q in Connect assistant. Can be either
|
|
7015
|
+
# the ID or the ARN. URLs cannot contain the ARN. The assistant's
|
|
7016
|
+
# region determines which models are available.
|
|
7017
|
+
# @return [String]
|
|
7018
|
+
#
|
|
7019
|
+
# @!attribute [rw] ai_prompt_type
|
|
7020
|
+
# The type of the AI Prompt to filter models by. When specified, only
|
|
7021
|
+
# models that support the given AI Prompt type are returned.
|
|
7022
|
+
# @return [String]
|
|
7023
|
+
#
|
|
7024
|
+
# @!attribute [rw] model_lifecycle
|
|
7025
|
+
# The lifecycle status of models to filter by. When specified, only
|
|
7026
|
+
# models with the given lifecycle status are returned.
|
|
7027
|
+
# @return [String]
|
|
7028
|
+
#
|
|
7029
|
+
# @!attribute [rw] next_token
|
|
7030
|
+
# The token for the next set of results. Use the value returned in the
|
|
7031
|
+
# previous response in the next request to retrieve the next set of
|
|
7032
|
+
# results.
|
|
7033
|
+
# @return [String]
|
|
7034
|
+
#
|
|
7035
|
+
# @!attribute [rw] max_results
|
|
7036
|
+
# The maximum number of results to return per page.
|
|
7037
|
+
# @return [Integer]
|
|
7038
|
+
#
|
|
7039
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ListModelsRequest AWS API Documentation
|
|
7040
|
+
#
|
|
7041
|
+
class ListModelsRequest < Struct.new(
|
|
7042
|
+
:assistant_id,
|
|
7043
|
+
:ai_prompt_type,
|
|
7044
|
+
:model_lifecycle,
|
|
7045
|
+
:next_token,
|
|
7046
|
+
:max_results)
|
|
7047
|
+
SENSITIVE = []
|
|
7048
|
+
include Aws::Structure
|
|
7049
|
+
end
|
|
7050
|
+
|
|
7051
|
+
# @!attribute [rw] model_summaries
|
|
7052
|
+
# The summaries of the models available to the assistant.
|
|
7053
|
+
# @return [Array<Types::ModelSummary>]
|
|
7054
|
+
#
|
|
7055
|
+
# @!attribute [rw] next_token
|
|
7056
|
+
# If there are additional results, this is the token for the next set
|
|
7057
|
+
# of results.
|
|
7058
|
+
# @return [String]
|
|
7059
|
+
#
|
|
7060
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ListModelsResponse AWS API Documentation
|
|
7061
|
+
#
|
|
7062
|
+
class ListModelsResponse < Struct.new(
|
|
7063
|
+
:model_summaries,
|
|
7064
|
+
:next_token)
|
|
7065
|
+
SENSITIVE = []
|
|
7066
|
+
include Aws::Structure
|
|
7067
|
+
end
|
|
7068
|
+
|
|
7013
7069
|
# @!attribute [rw] next_token
|
|
7014
7070
|
# The token for the next set of results. Use the value returned in the
|
|
7015
7071
|
# previous response in the next request to retrieve the next set of
|
|
@@ -7987,6 +8043,63 @@ module Aws::QConnect
|
|
|
7987
8043
|
include Aws::Structure
|
|
7988
8044
|
end
|
|
7989
8045
|
|
|
8046
|
+
# The summary of a model available to an Amazon Q in Connect assistant.
|
|
8047
|
+
#
|
|
8048
|
+
# @!attribute [rw] model_id
|
|
8049
|
+
# The identifier of the model.
|
|
8050
|
+
# @return [String]
|
|
8051
|
+
#
|
|
8052
|
+
# @!attribute [rw] display_name
|
|
8053
|
+
# The display name of the model.
|
|
8054
|
+
# @return [String]
|
|
8055
|
+
#
|
|
8056
|
+
# @!attribute [rw] cross_region_status
|
|
8057
|
+
# The cross-region availability status of the model. `NONE` indicates
|
|
8058
|
+
# the model is only available in a single region, `REGIONAL` indicates
|
|
8059
|
+
# the model is available through regional inference, and `GLOBAL`
|
|
8060
|
+
# indicates the model is available through global cross-region
|
|
8061
|
+
# inference.
|
|
8062
|
+
# @return [String]
|
|
8063
|
+
#
|
|
8064
|
+
# @!attribute [rw] supports_prompt_caching
|
|
8065
|
+
# Whether the model supports prompt caching.
|
|
8066
|
+
# @return [Boolean]
|
|
8067
|
+
#
|
|
8068
|
+
# @!attribute [rw] supported_ai_prompt_types
|
|
8069
|
+
# The list of AI Prompt types that the model supports.
|
|
8070
|
+
# @return [Array<String>]
|
|
8071
|
+
#
|
|
8072
|
+
# @!attribute [rw] model_lifecycle
|
|
8073
|
+
# The current lifecycle of the model. `ACTIVE` indicates the model is
|
|
8074
|
+
# recommended for use and `LEGACY` indicates the model is still usable
|
|
8075
|
+
# but is deprecated.
|
|
8076
|
+
# @return [String]
|
|
8077
|
+
#
|
|
8078
|
+
# @!attribute [rw] legacy_timestamp
|
|
8079
|
+
# The timestamp when the model lifecycle will transition from `ACTIVE`
|
|
8080
|
+
# to `LEGACY`.
|
|
8081
|
+
# @return [Time]
|
|
8082
|
+
#
|
|
8083
|
+
# @!attribute [rw] end_of_life_timestamp
|
|
8084
|
+
# The timestamp when the model will reach end of life and no longer be
|
|
8085
|
+
# available for use.
|
|
8086
|
+
# @return [Time]
|
|
8087
|
+
#
|
|
8088
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ModelSummary AWS API Documentation
|
|
8089
|
+
#
|
|
8090
|
+
class ModelSummary < Struct.new(
|
|
8091
|
+
:model_id,
|
|
8092
|
+
:display_name,
|
|
8093
|
+
:cross_region_status,
|
|
8094
|
+
:supports_prompt_caching,
|
|
8095
|
+
:supported_ai_prompt_types,
|
|
8096
|
+
:model_lifecycle,
|
|
8097
|
+
:legacy_timestamp,
|
|
8098
|
+
:end_of_life_timestamp)
|
|
8099
|
+
SENSITIVE = []
|
|
8100
|
+
include Aws::Structure
|
|
8101
|
+
end
|
|
8102
|
+
|
|
7990
8103
|
# The configuration for AI Agents of type `NOTE_TAKING`.
|
|
7991
8104
|
#
|
|
7992
8105
|
# @!attribute [rw] note_taking_ai_prompt_id
|
data/lib/aws-sdk-qconnect.rb
CHANGED
data/sig/client.rbs
CHANGED
|
@@ -1529,6 +1529,21 @@ module Aws
|
|
|
1529
1529
|
) -> _ListMessagesResponseSuccess
|
|
1530
1530
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListMessagesResponseSuccess
|
|
1531
1531
|
|
|
1532
|
+
interface _ListModelsResponseSuccess
|
|
1533
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ListModelsResponse]
|
|
1534
|
+
def model_summaries: () -> ::Array[Types::ModelSummary]
|
|
1535
|
+
def next_token: () -> ::String
|
|
1536
|
+
end
|
|
1537
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#list_models-instance_method
|
|
1538
|
+
def list_models: (
|
|
1539
|
+
assistant_id: ::String,
|
|
1540
|
+
?ai_prompt_type: ("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_SUMMARIZATION"),
|
|
1541
|
+
?model_lifecycle: ("ACTIVE" | "LEGACY"),
|
|
1542
|
+
?next_token: ::String,
|
|
1543
|
+
?max_results: ::Integer
|
|
1544
|
+
) -> _ListModelsResponseSuccess
|
|
1545
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListModelsResponseSuccess
|
|
1546
|
+
|
|
1532
1547
|
interface _ListQuickResponsesResponseSuccess
|
|
1533
1548
|
include ::Seahorse::Client::_ResponseSuccess[Types::ListQuickResponsesResponse]
|
|
1534
1549
|
def quick_response_summaries: () -> ::Array[Types::QuickResponseSummary]
|
data/sig/types.rbs
CHANGED
|
@@ -1826,6 +1826,21 @@ module Aws::QConnect
|
|
|
1826
1826
|
SENSITIVE: []
|
|
1827
1827
|
end
|
|
1828
1828
|
|
|
1829
|
+
class ListModelsRequest
|
|
1830
|
+
attr_accessor assistant_id: ::String
|
|
1831
|
+
attr_accessor ai_prompt_type: ("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_SUMMARIZATION")
|
|
1832
|
+
attr_accessor model_lifecycle: ("ACTIVE" | "LEGACY")
|
|
1833
|
+
attr_accessor next_token: ::String
|
|
1834
|
+
attr_accessor max_results: ::Integer
|
|
1835
|
+
SENSITIVE: []
|
|
1836
|
+
end
|
|
1837
|
+
|
|
1838
|
+
class ListModelsResponse
|
|
1839
|
+
attr_accessor model_summaries: ::Array[Types::ModelSummary]
|
|
1840
|
+
attr_accessor next_token: ::String
|
|
1841
|
+
SENSITIVE: []
|
|
1842
|
+
end
|
|
1843
|
+
|
|
1829
1844
|
class ListQuickResponsesRequest
|
|
1830
1845
|
attr_accessor next_token: ::String
|
|
1831
1846
|
attr_accessor max_results: ::Integer
|
|
@@ -2091,6 +2106,18 @@ module Aws::QConnect
|
|
|
2091
2106
|
SENSITIVE: [:channel]
|
|
2092
2107
|
end
|
|
2093
2108
|
|
|
2109
|
+
class ModelSummary
|
|
2110
|
+
attr_accessor model_id: ::String
|
|
2111
|
+
attr_accessor display_name: ::String
|
|
2112
|
+
attr_accessor cross_region_status: ("NONE" | "REGIONAL" | "GLOBAL")
|
|
2113
|
+
attr_accessor supports_prompt_caching: bool
|
|
2114
|
+
attr_accessor supported_ai_prompt_types: ::Array[("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_SUMMARIZATION")]
|
|
2115
|
+
attr_accessor model_lifecycle: ("ACTIVE" | "LEGACY")
|
|
2116
|
+
attr_accessor legacy_timestamp: ::Time
|
|
2117
|
+
attr_accessor end_of_life_timestamp: ::Time
|
|
2118
|
+
SENSITIVE: []
|
|
2119
|
+
end
|
|
2120
|
+
|
|
2094
2121
|
class NoteTakingAIAgentConfiguration
|
|
2095
2122
|
attr_accessor note_taking_ai_prompt_id: ::String
|
|
2096
2123
|
attr_accessor note_taking_ai_guardrail_id: ::String
|