aws-sdk-qconnect 1.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/CHANGELOG.md +8 -0
- data/LICENSE.txt +202 -0
- data/VERSION +1 -0
- data/lib/aws-sdk-qconnect/client.rb +2941 -0
- data/lib/aws-sdk-qconnect/client_api.rb +1666 -0
- data/lib/aws-sdk-qconnect/customizations.rb +0 -0
- data/lib/aws-sdk-qconnect/endpoint_parameters.rb +66 -0
- data/lib/aws-sdk-qconnect/endpoint_provider.rb +54 -0
- data/lib/aws-sdk-qconnect/endpoints.rb +590 -0
- data/lib/aws-sdk-qconnect/errors.rb +180 -0
- data/lib/aws-sdk-qconnect/plugins/endpoints.rb +151 -0
- data/lib/aws-sdk-qconnect/resource.rb +26 -0
- data/lib/aws-sdk-qconnect/types.rb +4229 -0
- data/lib/aws-sdk-qconnect.rb +57 -0
- metadata +94 -0
@@ -0,0 +1,4229 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# WARNING ABOUT GENERATED CODE
|
4
|
+
#
|
5
|
+
# This file is generated. See the contributing guide for more information:
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
7
|
+
#
|
8
|
+
# WARNING ABOUT GENERATED CODE
|
9
|
+
|
10
|
+
module Aws::QConnect
|
11
|
+
module Types
|
12
|
+
|
13
|
+
# You do not have sufficient access to perform this action.
|
14
|
+
#
|
15
|
+
# @!attribute [rw] message
|
16
|
+
# @return [String]
|
17
|
+
#
|
18
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/AccessDeniedException AWS API Documentation
|
19
|
+
#
|
20
|
+
class AccessDeniedException < Struct.new(
|
21
|
+
:message)
|
22
|
+
SENSITIVE = []
|
23
|
+
include Aws::Structure
|
24
|
+
end
|
25
|
+
|
26
|
+
# Configuration information for Amazon AppIntegrations to automatically
|
27
|
+
# ingest content.
|
28
|
+
#
|
29
|
+
# @!attribute [rw] app_integration_arn
|
30
|
+
# The Amazon Resource Name (ARN) of the AppIntegrations
|
31
|
+
# DataIntegration to use for ingesting content.
|
32
|
+
#
|
33
|
+
# * For [ Salesforce][1], your AppIntegrations DataIntegration must
|
34
|
+
# have an ObjectConfiguration if objectFields is not provided,
|
35
|
+
# including at least `Id`, `ArticleNumber`, `VersionNumber`,
|
36
|
+
# `Title`, `PublishStatus`, and `IsDeleted` as source fields.
|
37
|
+
#
|
38
|
+
# * For [ ServiceNow][2], your AppIntegrations DataIntegration must
|
39
|
+
# have an ObjectConfiguration if objectFields is not provided,
|
40
|
+
# including at least `number`, `short_description`, `sys_mod_count`,
|
41
|
+
# `workflow_state`, and `active` as source fields.
|
42
|
+
#
|
43
|
+
# * For [ Zendesk][3], your AppIntegrations DataIntegration must have
|
44
|
+
# an ObjectConfiguration if `objectFields` is not provided,
|
45
|
+
# including at least `id`, `title`, `updated_at`, and `draft` as
|
46
|
+
# source fields.
|
47
|
+
#
|
48
|
+
# * For [SharePoint][4], your AppIntegrations DataIntegration must
|
49
|
+
# have a FileConfiguration, including only file extensions that are
|
50
|
+
# among `docx`, `pdf`, `html`, `htm`, and `txt`.
|
51
|
+
#
|
52
|
+
# * For [Amazon S3][5], the ObjectConfiguration and FileConfiguration
|
53
|
+
# of your AppIntegrations DataIntegration must be null. The
|
54
|
+
# `SourceURI` of your DataIntegration must use the following format:
|
55
|
+
# `s3://your_s3_bucket_name`.
|
56
|
+
#
|
57
|
+
# The bucket policy of the corresponding S3 bucket must allow the
|
58
|
+
# Amazon Web Services principal `app-integrations.amazonaws.com` to
|
59
|
+
# perform `s3:ListBucket`, `s3:GetObject`, and
|
60
|
+
# `s3:GetBucketLocation` against the bucket.
|
61
|
+
#
|
62
|
+
#
|
63
|
+
#
|
64
|
+
# [1]: https://developer.salesforce.com/docs/atlas.en-us.knowledge_dev.meta/knowledge_dev/sforce_api_objects_knowledge__kav.htm
|
65
|
+
# [2]: https://developer.servicenow.com/dev.do#!/reference/api/rome/rest/knowledge-management-api
|
66
|
+
# [3]: https://developer.zendesk.com/api-reference/help_center/help-center-api/articles/
|
67
|
+
# [4]: https://learn.microsoft.com/en-us/sharepoint/dev/sp-add-ins/sharepoint-net-server-csom-jsom-and-rest-api-index
|
68
|
+
# [5]: https://aws.amazon.com/s3/
|
69
|
+
# @return [String]
|
70
|
+
#
|
71
|
+
# @!attribute [rw] object_fields
|
72
|
+
# The fields from the source that are made available to your agents in
|
73
|
+
# Amazon Q. Optional if ObjectConfiguration is included in the
|
74
|
+
# provided DataIntegration.
|
75
|
+
#
|
76
|
+
# * For [ Salesforce][1], you must include at least `Id`,
|
77
|
+
# `ArticleNumber`, `VersionNumber`, `Title`, `PublishStatus`, and
|
78
|
+
# `IsDeleted`.
|
79
|
+
#
|
80
|
+
# * For [ ServiceNow][2], you must include at least `number`,
|
81
|
+
# `short_description`, `sys_mod_count`, `workflow_state`, and
|
82
|
+
# `active`.
|
83
|
+
#
|
84
|
+
# * For [ Zendesk][3], you must include at least `id`, `title`,
|
85
|
+
# `updated_at`, and `draft`.
|
86
|
+
#
|
87
|
+
# Make sure to include additional fields. These fields are indexed and
|
88
|
+
# used to source recommendations.
|
89
|
+
#
|
90
|
+
#
|
91
|
+
#
|
92
|
+
# [1]: https://developer.salesforce.com/docs/atlas.en-us.knowledge_dev.meta/knowledge_dev/sforce_api_objects_knowledge__kav.htm
|
93
|
+
# [2]: https://developer.servicenow.com/dev.do#!/reference/api/rome/rest/knowledge-management-api
|
94
|
+
# [3]: https://developer.zendesk.com/api-reference/help_center/help-center-api/articles/
|
95
|
+
# @return [Array<String>]
|
96
|
+
#
|
97
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/AppIntegrationsConfiguration AWS API Documentation
|
98
|
+
#
|
99
|
+
class AppIntegrationsConfiguration < Struct.new(
|
100
|
+
:app_integration_arn,
|
101
|
+
:object_fields)
|
102
|
+
SENSITIVE = []
|
103
|
+
include Aws::Structure
|
104
|
+
end
|
105
|
+
|
106
|
+
# Information about the assistant association.
|
107
|
+
#
|
108
|
+
# @!attribute [rw] assistant_arn
|
109
|
+
# The Amazon Resource Name (ARN) of the Amazon Q assistant.
|
110
|
+
# @return [String]
|
111
|
+
#
|
112
|
+
# @!attribute [rw] assistant_association_arn
|
113
|
+
# The Amazon Resource Name (ARN) of the assistant association.
|
114
|
+
# @return [String]
|
115
|
+
#
|
116
|
+
# @!attribute [rw] assistant_association_id
|
117
|
+
# The identifier of the assistant association.
|
118
|
+
# @return [String]
|
119
|
+
#
|
120
|
+
# @!attribute [rw] assistant_id
|
121
|
+
# The identifier of the Amazon Q assistant.
|
122
|
+
# @return [String]
|
123
|
+
#
|
124
|
+
# @!attribute [rw] association_data
|
125
|
+
# A union type that currently has a single argument, the knowledge
|
126
|
+
# base ID.
|
127
|
+
# @return [Types::AssistantAssociationOutputData]
|
128
|
+
#
|
129
|
+
# @!attribute [rw] association_type
|
130
|
+
# The type of association.
|
131
|
+
# @return [String]
|
132
|
+
#
|
133
|
+
# @!attribute [rw] tags
|
134
|
+
# The tags used to organize, track, or control access for this
|
135
|
+
# resource.
|
136
|
+
# @return [Hash<String,String>]
|
137
|
+
#
|
138
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/AssistantAssociationData AWS API Documentation
|
139
|
+
#
|
140
|
+
class AssistantAssociationData < Struct.new(
|
141
|
+
:assistant_arn,
|
142
|
+
:assistant_association_arn,
|
143
|
+
:assistant_association_id,
|
144
|
+
:assistant_id,
|
145
|
+
:association_data,
|
146
|
+
:association_type,
|
147
|
+
:tags)
|
148
|
+
SENSITIVE = []
|
149
|
+
include Aws::Structure
|
150
|
+
end
|
151
|
+
|
152
|
+
# The data that is input into Amazon Q as a result of the assistant
|
153
|
+
# association.
|
154
|
+
#
|
155
|
+
# @note AssistantAssociationInputData is a union - when making an API calls you must set exactly one of the members.
|
156
|
+
#
|
157
|
+
# @!attribute [rw] knowledge_base_id
|
158
|
+
# The identifier of the knowledge base. This should not be a
|
159
|
+
# QUICK\_RESPONSES type knowledge base if you're storing Amazon Q
|
160
|
+
# Content resource to it.
|
161
|
+
# @return [String]
|
162
|
+
#
|
163
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/AssistantAssociationInputData AWS API Documentation
|
164
|
+
#
|
165
|
+
class AssistantAssociationInputData < Struct.new(
|
166
|
+
:knowledge_base_id,
|
167
|
+
:unknown)
|
168
|
+
SENSITIVE = []
|
169
|
+
include Aws::Structure
|
170
|
+
include Aws::Structure::Union
|
171
|
+
|
172
|
+
class KnowledgeBaseId < AssistantAssociationInputData; end
|
173
|
+
class Unknown < AssistantAssociationInputData; end
|
174
|
+
end
|
175
|
+
|
176
|
+
# The data that is output as a result of the assistant association.
|
177
|
+
#
|
178
|
+
# @note AssistantAssociationOutputData is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of AssistantAssociationOutputData corresponding to the set member.
|
179
|
+
#
|
180
|
+
# @!attribute [rw] knowledge_base_association
|
181
|
+
# The knowledge base where output data is sent.
|
182
|
+
# @return [Types::KnowledgeBaseAssociationData]
|
183
|
+
#
|
184
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/AssistantAssociationOutputData AWS API Documentation
|
185
|
+
#
|
186
|
+
class AssistantAssociationOutputData < Struct.new(
|
187
|
+
:knowledge_base_association,
|
188
|
+
:unknown)
|
189
|
+
SENSITIVE = []
|
190
|
+
include Aws::Structure
|
191
|
+
include Aws::Structure::Union
|
192
|
+
|
193
|
+
class KnowledgeBaseAssociation < AssistantAssociationOutputData; end
|
194
|
+
class Unknown < AssistantAssociationOutputData; end
|
195
|
+
end
|
196
|
+
|
197
|
+
# Summary information about the assistant association.
|
198
|
+
#
|
199
|
+
# @!attribute [rw] assistant_arn
|
200
|
+
# The Amazon Resource Name (ARN) of the Amazon Q assistant.
|
201
|
+
# @return [String]
|
202
|
+
#
|
203
|
+
# @!attribute [rw] assistant_association_arn
|
204
|
+
# The Amazon Resource Name (ARN) of the assistant association.
|
205
|
+
# @return [String]
|
206
|
+
#
|
207
|
+
# @!attribute [rw] assistant_association_id
|
208
|
+
# The identifier of the assistant association.
|
209
|
+
# @return [String]
|
210
|
+
#
|
211
|
+
# @!attribute [rw] assistant_id
|
212
|
+
# The identifier of the Amazon Q assistant.
|
213
|
+
# @return [String]
|
214
|
+
#
|
215
|
+
# @!attribute [rw] association_data
|
216
|
+
# The association data.
|
217
|
+
# @return [Types::AssistantAssociationOutputData]
|
218
|
+
#
|
219
|
+
# @!attribute [rw] association_type
|
220
|
+
# The type of association.
|
221
|
+
# @return [String]
|
222
|
+
#
|
223
|
+
# @!attribute [rw] tags
|
224
|
+
# The tags used to organize, track, or control access for this
|
225
|
+
# resource.
|
226
|
+
# @return [Hash<String,String>]
|
227
|
+
#
|
228
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/AssistantAssociationSummary AWS API Documentation
|
229
|
+
#
|
230
|
+
class AssistantAssociationSummary < Struct.new(
|
231
|
+
:assistant_arn,
|
232
|
+
:assistant_association_arn,
|
233
|
+
:assistant_association_id,
|
234
|
+
:assistant_id,
|
235
|
+
:association_data,
|
236
|
+
:association_type,
|
237
|
+
:tags)
|
238
|
+
SENSITIVE = []
|
239
|
+
include Aws::Structure
|
240
|
+
end
|
241
|
+
|
242
|
+
# The capability configuration for a Amazon Q assistant.
|
243
|
+
#
|
244
|
+
# @!attribute [rw] type
|
245
|
+
# The type of Amazon Q assistant capability.
|
246
|
+
# @return [String]
|
247
|
+
#
|
248
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/AssistantCapabilityConfiguration AWS API Documentation
|
249
|
+
#
|
250
|
+
class AssistantCapabilityConfiguration < Struct.new(
|
251
|
+
:type)
|
252
|
+
SENSITIVE = []
|
253
|
+
include Aws::Structure
|
254
|
+
end
|
255
|
+
|
256
|
+
# The assistant data.
|
257
|
+
#
|
258
|
+
# @!attribute [rw] assistant_arn
|
259
|
+
# The Amazon Resource Name (ARN) of the Amazon Q assistant.
|
260
|
+
# @return [String]
|
261
|
+
#
|
262
|
+
# @!attribute [rw] assistant_id
|
263
|
+
# The identifier of the Amazon Q assistant.
|
264
|
+
# @return [String]
|
265
|
+
#
|
266
|
+
# @!attribute [rw] capability_configuration
|
267
|
+
# The configuration information for the Amazon Q assistant capability.
|
268
|
+
# @return [Types::AssistantCapabilityConfiguration]
|
269
|
+
#
|
270
|
+
# @!attribute [rw] description
|
271
|
+
# The description.
|
272
|
+
# @return [String]
|
273
|
+
#
|
274
|
+
# @!attribute [rw] integration_configuration
|
275
|
+
# The configuration information for the Amazon Q assistant
|
276
|
+
# integration.
|
277
|
+
# @return [Types::AssistantIntegrationConfiguration]
|
278
|
+
#
|
279
|
+
# @!attribute [rw] name
|
280
|
+
# The name.
|
281
|
+
# @return [String]
|
282
|
+
#
|
283
|
+
# @!attribute [rw] server_side_encryption_configuration
|
284
|
+
# The configuration information for the customer managed key used for
|
285
|
+
# encryption.
|
286
|
+
#
|
287
|
+
# This KMS key must have a policy that allows `kms:CreateGrant`,
|
288
|
+
# `kms:DescribeKey`, `kms:Decrypt`, and `kms:GenerateDataKey*`
|
289
|
+
# permissions to the IAM identity using the key to invoke Amazon Q. To
|
290
|
+
# use Amazon Q with chat, the key policy must also allow
|
291
|
+
# `kms:Decrypt`, `kms:GenerateDataKey*`, and `kms:DescribeKey`
|
292
|
+
# permissions to the `connect.amazonaws.com` service principal.
|
293
|
+
#
|
294
|
+
# For more information about setting up a customer managed key for
|
295
|
+
# Amazon Q, see [Enable Amazon Q in Connect for your instance][1].
|
296
|
+
#
|
297
|
+
#
|
298
|
+
#
|
299
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/enable-q.html
|
300
|
+
# @return [Types::ServerSideEncryptionConfiguration]
|
301
|
+
#
|
302
|
+
# @!attribute [rw] status
|
303
|
+
# The status of the assistant.
|
304
|
+
# @return [String]
|
305
|
+
#
|
306
|
+
# @!attribute [rw] tags
|
307
|
+
# The tags used to organize, track, or control access for this
|
308
|
+
# resource.
|
309
|
+
# @return [Hash<String,String>]
|
310
|
+
#
|
311
|
+
# @!attribute [rw] type
|
312
|
+
# The type of assistant.
|
313
|
+
# @return [String]
|
314
|
+
#
|
315
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/AssistantData AWS API Documentation
|
316
|
+
#
|
317
|
+
class AssistantData < Struct.new(
|
318
|
+
:assistant_arn,
|
319
|
+
:assistant_id,
|
320
|
+
:capability_configuration,
|
321
|
+
:description,
|
322
|
+
:integration_configuration,
|
323
|
+
:name,
|
324
|
+
:server_side_encryption_configuration,
|
325
|
+
:status,
|
326
|
+
:tags,
|
327
|
+
:type)
|
328
|
+
SENSITIVE = []
|
329
|
+
include Aws::Structure
|
330
|
+
end
|
331
|
+
|
332
|
+
# The configuration information for the Amazon Q assistant integration.
|
333
|
+
#
|
334
|
+
# @!attribute [rw] topic_integration_arn
|
335
|
+
# The Amazon Resource Name (ARN) of the integrated Amazon SNS topic
|
336
|
+
# used for streaming chat messages.
|
337
|
+
# @return [String]
|
338
|
+
#
|
339
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/AssistantIntegrationConfiguration AWS API Documentation
|
340
|
+
#
|
341
|
+
class AssistantIntegrationConfiguration < Struct.new(
|
342
|
+
:topic_integration_arn)
|
343
|
+
SENSITIVE = []
|
344
|
+
include Aws::Structure
|
345
|
+
end
|
346
|
+
|
347
|
+
# Summary information about the assistant.
|
348
|
+
#
|
349
|
+
# @!attribute [rw] assistant_arn
|
350
|
+
# The Amazon Resource Name (ARN) of the Amazon Q assistant.
|
351
|
+
# @return [String]
|
352
|
+
#
|
353
|
+
# @!attribute [rw] assistant_id
|
354
|
+
# The identifier of the Amazon Q assistant.
|
355
|
+
# @return [String]
|
356
|
+
#
|
357
|
+
# @!attribute [rw] capability_configuration
|
358
|
+
# The configuration information for the Amazon Q assistant capability.
|
359
|
+
# @return [Types::AssistantCapabilityConfiguration]
|
360
|
+
#
|
361
|
+
# @!attribute [rw] description
|
362
|
+
# The description of the assistant.
|
363
|
+
# @return [String]
|
364
|
+
#
|
365
|
+
# @!attribute [rw] integration_configuration
|
366
|
+
# The configuration information for the Amazon Q assistant
|
367
|
+
# integration.
|
368
|
+
# @return [Types::AssistantIntegrationConfiguration]
|
369
|
+
#
|
370
|
+
# @!attribute [rw] name
|
371
|
+
# The name of the assistant.
|
372
|
+
# @return [String]
|
373
|
+
#
|
374
|
+
# @!attribute [rw] server_side_encryption_configuration
|
375
|
+
# The configuration information for the customer managed key used for
|
376
|
+
# encryption.
|
377
|
+
#
|
378
|
+
# This KMS key must have a policy that allows `kms:CreateGrant`,
|
379
|
+
# `kms:DescribeKey`, `kms:Decrypt`, and `kms:GenerateDataKey*`
|
380
|
+
# permissions to the IAM identity using the key to invoke Amazon Q. To
|
381
|
+
# use Amazon Q with chat, the key policy must also allow
|
382
|
+
# `kms:Decrypt`, `kms:GenerateDataKey*`, and `kms:DescribeKey`
|
383
|
+
# permissions to the `connect.amazonaws.com` service principal.
|
384
|
+
#
|
385
|
+
# For more information about setting up a customer managed key for
|
386
|
+
# Amazon Q, see [Enable Amazon Q in Connect for your instance][1].
|
387
|
+
#
|
388
|
+
#
|
389
|
+
#
|
390
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/enable-q.html
|
391
|
+
# @return [Types::ServerSideEncryptionConfiguration]
|
392
|
+
#
|
393
|
+
# @!attribute [rw] status
|
394
|
+
# The status of the assistant.
|
395
|
+
# @return [String]
|
396
|
+
#
|
397
|
+
# @!attribute [rw] tags
|
398
|
+
# The tags used to organize, track, or control access for this
|
399
|
+
# resource.
|
400
|
+
# @return [Hash<String,String>]
|
401
|
+
#
|
402
|
+
# @!attribute [rw] type
|
403
|
+
# The type of the assistant.
|
404
|
+
# @return [String]
|
405
|
+
#
|
406
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/AssistantSummary AWS API Documentation
|
407
|
+
#
|
408
|
+
class AssistantSummary < Struct.new(
|
409
|
+
:assistant_arn,
|
410
|
+
:assistant_id,
|
411
|
+
:capability_configuration,
|
412
|
+
:description,
|
413
|
+
:integration_configuration,
|
414
|
+
:name,
|
415
|
+
:server_side_encryption_configuration,
|
416
|
+
:status,
|
417
|
+
:tags,
|
418
|
+
:type)
|
419
|
+
SENSITIVE = []
|
420
|
+
include Aws::Structure
|
421
|
+
end
|
422
|
+
|
423
|
+
# The configuration information of the external data source.
|
424
|
+
#
|
425
|
+
# @note Configuration is a union - when making an API calls you must set exactly one of the members.
|
426
|
+
#
|
427
|
+
# @note Configuration is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of Configuration corresponding to the set member.
|
428
|
+
#
|
429
|
+
# @!attribute [rw] connect_configuration
|
430
|
+
# The configuration information of the Amazon Connect data source.
|
431
|
+
# @return [Types::ConnectConfiguration]
|
432
|
+
#
|
433
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/Configuration AWS API Documentation
|
434
|
+
#
|
435
|
+
class Configuration < Struct.new(
|
436
|
+
:connect_configuration,
|
437
|
+
:unknown)
|
438
|
+
SENSITIVE = []
|
439
|
+
include Aws::Structure
|
440
|
+
include Aws::Structure::Union
|
441
|
+
|
442
|
+
class ConnectConfiguration < Configuration; end
|
443
|
+
class Unknown < Configuration; end
|
444
|
+
end
|
445
|
+
|
446
|
+
# The request could not be processed because of conflict in the current
|
447
|
+
# state of the resource. For example, if you're using a `Create` API
|
448
|
+
# (such as `CreateAssistant`) that accepts name, a conflicting resource
|
449
|
+
# (usually with the same name) is being created or mutated.
|
450
|
+
#
|
451
|
+
# @!attribute [rw] message
|
452
|
+
# @return [String]
|
453
|
+
#
|
454
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ConflictException AWS API Documentation
|
455
|
+
#
|
456
|
+
class ConflictException < Struct.new(
|
457
|
+
:message)
|
458
|
+
SENSITIVE = []
|
459
|
+
include Aws::Structure
|
460
|
+
end
|
461
|
+
|
462
|
+
# The configuration information of the Amazon Connect data source.
|
463
|
+
#
|
464
|
+
# @!attribute [rw] instance_id
|
465
|
+
# The identifier of the Amazon Connect instance. You can find the
|
466
|
+
# instanceId in the ARN of the instance.
|
467
|
+
# @return [String]
|
468
|
+
#
|
469
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ConnectConfiguration AWS API Documentation
|
470
|
+
#
|
471
|
+
class ConnectConfiguration < Struct.new(
|
472
|
+
:instance_id)
|
473
|
+
SENSITIVE = []
|
474
|
+
include Aws::Structure
|
475
|
+
end
|
476
|
+
|
477
|
+
# Information about the content.
|
478
|
+
#
|
479
|
+
# @!attribute [rw] content_arn
|
480
|
+
# The Amazon Resource Name (ARN) of the content.
|
481
|
+
# @return [String]
|
482
|
+
#
|
483
|
+
# @!attribute [rw] content_id
|
484
|
+
# The identifier of the content.
|
485
|
+
# @return [String]
|
486
|
+
#
|
487
|
+
# @!attribute [rw] content_type
|
488
|
+
# The media type of the content.
|
489
|
+
# @return [String]
|
490
|
+
#
|
491
|
+
# @!attribute [rw] knowledge_base_arn
|
492
|
+
# The Amazon Resource Name (ARN) of the knowledge base.
|
493
|
+
# @return [String]
|
494
|
+
#
|
495
|
+
# @!attribute [rw] knowledge_base_id
|
496
|
+
# The identifier of the knowledge base. This should not be a
|
497
|
+
# QUICK\_RESPONSES type knowledge base if you're storing Amazon Q
|
498
|
+
# Content resource to it.
|
499
|
+
# @return [String]
|
500
|
+
#
|
501
|
+
# @!attribute [rw] link_out_uri
|
502
|
+
# The URI of the content.
|
503
|
+
# @return [String]
|
504
|
+
#
|
505
|
+
# @!attribute [rw] metadata
|
506
|
+
# A key/value map to store attributes without affecting tagging or
|
507
|
+
# recommendations. For example, when synchronizing data between an
|
508
|
+
# external system and Amazon Q, you can store an external version
|
509
|
+
# identifier as metadata to utilize for determining drift.
|
510
|
+
# @return [Hash<String,String>]
|
511
|
+
#
|
512
|
+
# @!attribute [rw] name
|
513
|
+
# The name of the content.
|
514
|
+
# @return [String]
|
515
|
+
#
|
516
|
+
# @!attribute [rw] revision_id
|
517
|
+
# The identifier of the content revision.
|
518
|
+
# @return [String]
|
519
|
+
#
|
520
|
+
# @!attribute [rw] status
|
521
|
+
# The status of the content.
|
522
|
+
# @return [String]
|
523
|
+
#
|
524
|
+
# @!attribute [rw] tags
|
525
|
+
# The tags used to organize, track, or control access for this
|
526
|
+
# resource.
|
527
|
+
# @return [Hash<String,String>]
|
528
|
+
#
|
529
|
+
# @!attribute [rw] title
|
530
|
+
# The title of the content.
|
531
|
+
# @return [String]
|
532
|
+
#
|
533
|
+
# @!attribute [rw] url
|
534
|
+
# The URL of the content.
|
535
|
+
# @return [String]
|
536
|
+
#
|
537
|
+
# @!attribute [rw] url_expiry
|
538
|
+
# The expiration time of the URL as an epoch timestamp.
|
539
|
+
# @return [Time]
|
540
|
+
#
|
541
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ContentData AWS API Documentation
|
542
|
+
#
|
543
|
+
class ContentData < Struct.new(
|
544
|
+
:content_arn,
|
545
|
+
:content_id,
|
546
|
+
:content_type,
|
547
|
+
:knowledge_base_arn,
|
548
|
+
:knowledge_base_id,
|
549
|
+
:link_out_uri,
|
550
|
+
:metadata,
|
551
|
+
:name,
|
552
|
+
:revision_id,
|
553
|
+
:status,
|
554
|
+
:tags,
|
555
|
+
:title,
|
556
|
+
:url,
|
557
|
+
:url_expiry)
|
558
|
+
SENSITIVE = [:url]
|
559
|
+
include Aws::Structure
|
560
|
+
end
|
561
|
+
|
562
|
+
# Details about the content data.
|
563
|
+
#
|
564
|
+
# @!attribute [rw] ranking_data
|
565
|
+
# Details about the content ranking data.
|
566
|
+
# @return [Types::RankingData]
|
567
|
+
#
|
568
|
+
# @!attribute [rw] text_data
|
569
|
+
# Details about the content text data.
|
570
|
+
# @return [Types::TextData]
|
571
|
+
#
|
572
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ContentDataDetails AWS API Documentation
|
573
|
+
#
|
574
|
+
class ContentDataDetails < Struct.new(
|
575
|
+
:ranking_data,
|
576
|
+
:text_data)
|
577
|
+
SENSITIVE = []
|
578
|
+
include Aws::Structure
|
579
|
+
end
|
580
|
+
|
581
|
+
# Reference information about the content.
|
582
|
+
#
|
583
|
+
# @!attribute [rw] content_arn
|
584
|
+
# The Amazon Resource Name (ARN) of the content.
|
585
|
+
# @return [String]
|
586
|
+
#
|
587
|
+
# @!attribute [rw] content_id
|
588
|
+
# The identifier of the content.
|
589
|
+
# @return [String]
|
590
|
+
#
|
591
|
+
# @!attribute [rw] knowledge_base_arn
|
592
|
+
# The Amazon Resource Name (ARN) of the knowledge base.
|
593
|
+
# @return [String]
|
594
|
+
#
|
595
|
+
# @!attribute [rw] knowledge_base_id
|
596
|
+
# The identifier of the knowledge base. This should not be a
|
597
|
+
# QUICK\_RESPONSES type knowledge base if you're storing Amazon Q
|
598
|
+
# Content resource to it.
|
599
|
+
# @return [String]
|
600
|
+
#
|
601
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ContentReference AWS API Documentation
|
602
|
+
#
|
603
|
+
class ContentReference < Struct.new(
|
604
|
+
:content_arn,
|
605
|
+
:content_id,
|
606
|
+
:knowledge_base_arn,
|
607
|
+
:knowledge_base_id)
|
608
|
+
SENSITIVE = []
|
609
|
+
include Aws::Structure
|
610
|
+
end
|
611
|
+
|
612
|
+
# Summary information about the content.
|
613
|
+
#
|
614
|
+
# @!attribute [rw] content_arn
|
615
|
+
# The Amazon Resource Name (ARN) of the content.
|
616
|
+
# @return [String]
|
617
|
+
#
|
618
|
+
# @!attribute [rw] content_id
|
619
|
+
# The identifier of the content.
|
620
|
+
# @return [String]
|
621
|
+
#
|
622
|
+
# @!attribute [rw] content_type
|
623
|
+
# The media type of the content.
|
624
|
+
# @return [String]
|
625
|
+
#
|
626
|
+
# @!attribute [rw] knowledge_base_arn
|
627
|
+
# The Amazon Resource Name (ARN) of the knowledge base.
|
628
|
+
# @return [String]
|
629
|
+
#
|
630
|
+
# @!attribute [rw] knowledge_base_id
|
631
|
+
# The identifier of the knowledge base. This should not be a
|
632
|
+
# QUICK\_RESPONSES type knowledge base if you're storing Amazon Q
|
633
|
+
# Content resource to it.
|
634
|
+
# @return [String]
|
635
|
+
#
|
636
|
+
# @!attribute [rw] metadata
|
637
|
+
# A key/value map to store attributes without affecting tagging or
|
638
|
+
# recommendations. For example, when synchronizing data between an
|
639
|
+
# external system and Amazon Q, you can store an external version
|
640
|
+
# identifier as metadata to utilize for determining drift.
|
641
|
+
# @return [Hash<String,String>]
|
642
|
+
#
|
643
|
+
# @!attribute [rw] name
|
644
|
+
# The name of the content.
|
645
|
+
# @return [String]
|
646
|
+
#
|
647
|
+
# @!attribute [rw] revision_id
|
648
|
+
# The identifier of the revision of the content.
|
649
|
+
# @return [String]
|
650
|
+
#
|
651
|
+
# @!attribute [rw] status
|
652
|
+
# The status of the content.
|
653
|
+
# @return [String]
|
654
|
+
#
|
655
|
+
# @!attribute [rw] tags
|
656
|
+
# The tags used to organize, track, or control access for this
|
657
|
+
# resource.
|
658
|
+
# @return [Hash<String,String>]
|
659
|
+
#
|
660
|
+
# @!attribute [rw] title
|
661
|
+
# The title of the content.
|
662
|
+
# @return [String]
|
663
|
+
#
|
664
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ContentSummary AWS API Documentation
|
665
|
+
#
|
666
|
+
class ContentSummary < Struct.new(
|
667
|
+
:content_arn,
|
668
|
+
:content_id,
|
669
|
+
:content_type,
|
670
|
+
:knowledge_base_arn,
|
671
|
+
:knowledge_base_id,
|
672
|
+
:metadata,
|
673
|
+
:name,
|
674
|
+
:revision_id,
|
675
|
+
:status,
|
676
|
+
:tags,
|
677
|
+
:title)
|
678
|
+
SENSITIVE = []
|
679
|
+
include Aws::Structure
|
680
|
+
end
|
681
|
+
|
682
|
+
# @!attribute [rw] assistant_id
|
683
|
+
# The identifier of the Amazon Q assistant. Can be either the ID or
|
684
|
+
# the ARN. URLs cannot contain the ARN.
|
685
|
+
# @return [String]
|
686
|
+
#
|
687
|
+
# @!attribute [rw] association
|
688
|
+
# The identifier of the associated resource.
|
689
|
+
# @return [Types::AssistantAssociationInputData]
|
690
|
+
#
|
691
|
+
# @!attribute [rw] association_type
|
692
|
+
# The type of association.
|
693
|
+
# @return [String]
|
694
|
+
#
|
695
|
+
# @!attribute [rw] client_token
|
696
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
697
|
+
# idempotency of the request. If not provided, the Amazon Web Services
|
698
|
+
# SDK populates this field. For more information about idempotency,
|
699
|
+
# see [Making retries safe with idempotent APIs][1].
|
700
|
+
#
|
701
|
+
# **A suitable default value is auto-generated.** You should normally
|
702
|
+
# not need to pass this option.
|
703
|
+
#
|
704
|
+
#
|
705
|
+
#
|
706
|
+
# [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
707
|
+
# @return [String]
|
708
|
+
#
|
709
|
+
# @!attribute [rw] tags
|
710
|
+
# The tags used to organize, track, or control access for this
|
711
|
+
# resource.
|
712
|
+
# @return [Hash<String,String>]
|
713
|
+
#
|
714
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/CreateAssistantAssociationRequest AWS API Documentation
|
715
|
+
#
|
716
|
+
class CreateAssistantAssociationRequest < Struct.new(
|
717
|
+
:assistant_id,
|
718
|
+
:association,
|
719
|
+
:association_type,
|
720
|
+
:client_token,
|
721
|
+
:tags)
|
722
|
+
SENSITIVE = []
|
723
|
+
include Aws::Structure
|
724
|
+
end
|
725
|
+
|
726
|
+
# @!attribute [rw] assistant_association
|
727
|
+
# The assistant association.
|
728
|
+
# @return [Types::AssistantAssociationData]
|
729
|
+
#
|
730
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/CreateAssistantAssociationResponse AWS API Documentation
|
731
|
+
#
|
732
|
+
class CreateAssistantAssociationResponse < Struct.new(
|
733
|
+
:assistant_association)
|
734
|
+
SENSITIVE = []
|
735
|
+
include Aws::Structure
|
736
|
+
end
|
737
|
+
|
738
|
+
# @!attribute [rw] client_token
|
739
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
740
|
+
# idempotency of the request. If not provided, the Amazon Web Services
|
741
|
+
# SDK populates this field. For more information about idempotency,
|
742
|
+
# see [Making retries safe with idempotent APIs][1].
|
743
|
+
#
|
744
|
+
# **A suitable default value is auto-generated.** You should normally
|
745
|
+
# not need to pass this option.
|
746
|
+
#
|
747
|
+
#
|
748
|
+
#
|
749
|
+
# [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
750
|
+
# @return [String]
|
751
|
+
#
|
752
|
+
# @!attribute [rw] description
|
753
|
+
# The description of the assistant.
|
754
|
+
# @return [String]
|
755
|
+
#
|
756
|
+
# @!attribute [rw] name
|
757
|
+
# The name of the assistant.
|
758
|
+
# @return [String]
|
759
|
+
#
|
760
|
+
# @!attribute [rw] server_side_encryption_configuration
|
761
|
+
# The configuration information for the customer managed key used for
|
762
|
+
# encryption.
|
763
|
+
#
|
764
|
+
# The customer managed key must have a policy that allows
|
765
|
+
# `kms:CreateGrant`, ` kms:DescribeKey`, `kms:Decrypt`, and
|
766
|
+
# `kms:GenerateDataKey*` permissions to the IAM identity using the key
|
767
|
+
# to invoke Amazon Q. To use Amazon Q with chat, the key policy must
|
768
|
+
# also allow `kms:Decrypt`, `kms:GenerateDataKey*`, and
|
769
|
+
# `kms:DescribeKey` permissions to the `connect.amazonaws.com` service
|
770
|
+
# principal.
|
771
|
+
#
|
772
|
+
# For more information about setting up a customer managed key for
|
773
|
+
# Amazon Q, see [Enable Amazon Q in Connect for your instance][1].
|
774
|
+
#
|
775
|
+
#
|
776
|
+
#
|
777
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/enable-q.html
|
778
|
+
# @return [Types::ServerSideEncryptionConfiguration]
|
779
|
+
#
|
780
|
+
# @!attribute [rw] tags
|
781
|
+
# The tags used to organize, track, or control access for this
|
782
|
+
# resource.
|
783
|
+
# @return [Hash<String,String>]
|
784
|
+
#
|
785
|
+
# @!attribute [rw] type
|
786
|
+
# The type of assistant.
|
787
|
+
# @return [String]
|
788
|
+
#
|
789
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/CreateAssistantRequest AWS API Documentation
|
790
|
+
#
|
791
|
+
class CreateAssistantRequest < Struct.new(
|
792
|
+
:client_token,
|
793
|
+
:description,
|
794
|
+
:name,
|
795
|
+
:server_side_encryption_configuration,
|
796
|
+
:tags,
|
797
|
+
:type)
|
798
|
+
SENSITIVE = []
|
799
|
+
include Aws::Structure
|
800
|
+
end
|
801
|
+
|
802
|
+
# @!attribute [rw] assistant
|
803
|
+
# Information about the assistant.
|
804
|
+
# @return [Types::AssistantData]
|
805
|
+
#
|
806
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/CreateAssistantResponse AWS API Documentation
|
807
|
+
#
|
808
|
+
class CreateAssistantResponse < Struct.new(
|
809
|
+
:assistant)
|
810
|
+
SENSITIVE = []
|
811
|
+
include Aws::Structure
|
812
|
+
end
|
813
|
+
|
814
|
+
# @!attribute [rw] client_token
|
815
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
816
|
+
# idempotency of the request. If not provided, the Amazon Web Services
|
817
|
+
# SDK populates this field. For more information about idempotency,
|
818
|
+
# see [Making retries safe with idempotent APIs][1].
|
819
|
+
#
|
820
|
+
# **A suitable default value is auto-generated.** You should normally
|
821
|
+
# not need to pass this option.
|
822
|
+
#
|
823
|
+
#
|
824
|
+
#
|
825
|
+
# [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
826
|
+
# @return [String]
|
827
|
+
#
|
828
|
+
# @!attribute [rw] knowledge_base_id
|
829
|
+
# The identifier of the knowledge base. This should not be a
|
830
|
+
# QUICK\_RESPONSES type knowledge base if you're storing Amazon Q
|
831
|
+
# Content resource to it. Can be either the ID or the ARN. URLs cannot
|
832
|
+
# contain the ARN.
|
833
|
+
# @return [String]
|
834
|
+
#
|
835
|
+
# @!attribute [rw] metadata
|
836
|
+
# A key/value map to store attributes without affecting tagging or
|
837
|
+
# recommendations. For example, when synchronizing data between an
|
838
|
+
# external system and Amazon Q, you can store an external version
|
839
|
+
# identifier as metadata to utilize for determining drift.
|
840
|
+
# @return [Hash<String,String>]
|
841
|
+
#
|
842
|
+
# @!attribute [rw] name
|
843
|
+
# The name of the content. Each piece of content in a knowledge base
|
844
|
+
# must have a unique name. You can retrieve a piece of content using
|
845
|
+
# only its knowledge base and its name with the [SearchContent][1]
|
846
|
+
# API.
|
847
|
+
#
|
848
|
+
#
|
849
|
+
#
|
850
|
+
# [1]: https://docs.aws.amazon.com/amazon-q-connect/latest/APIReference/API_SearchContent.html
|
851
|
+
# @return [String]
|
852
|
+
#
|
853
|
+
# @!attribute [rw] override_link_out_uri
|
854
|
+
# The URI you want to use for the article. If the knowledge base has a
|
855
|
+
# templateUri, setting this argument overrides it for this piece of
|
856
|
+
# content.
|
857
|
+
# @return [String]
|
858
|
+
#
|
859
|
+
# @!attribute [rw] tags
|
860
|
+
# The tags used to organize, track, or control access for this
|
861
|
+
# resource.
|
862
|
+
# @return [Hash<String,String>]
|
863
|
+
#
|
864
|
+
# @!attribute [rw] title
|
865
|
+
# The title of the content. If not set, the title is equal to the
|
866
|
+
# name.
|
867
|
+
# @return [String]
|
868
|
+
#
|
869
|
+
# @!attribute [rw] upload_id
|
870
|
+
# A pointer to the uploaded asset. This value is returned by
|
871
|
+
# [StartContentUpload][1].
|
872
|
+
#
|
873
|
+
#
|
874
|
+
#
|
875
|
+
# [1]: https://docs.aws.amazon.com/amazon-q-connect/latest/APIReference/API_StartContentUpload.html
|
876
|
+
# @return [String]
|
877
|
+
#
|
878
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/CreateContentRequest AWS API Documentation
|
879
|
+
#
|
880
|
+
class CreateContentRequest < Struct.new(
|
881
|
+
:client_token,
|
882
|
+
:knowledge_base_id,
|
883
|
+
:metadata,
|
884
|
+
:name,
|
885
|
+
:override_link_out_uri,
|
886
|
+
:tags,
|
887
|
+
:title,
|
888
|
+
:upload_id)
|
889
|
+
SENSITIVE = []
|
890
|
+
include Aws::Structure
|
891
|
+
end
|
892
|
+
|
893
|
+
# @!attribute [rw] content
|
894
|
+
# The content.
|
895
|
+
# @return [Types::ContentData]
|
896
|
+
#
|
897
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/CreateContentResponse AWS API Documentation
|
898
|
+
#
|
899
|
+
class CreateContentResponse < Struct.new(
|
900
|
+
:content)
|
901
|
+
SENSITIVE = []
|
902
|
+
include Aws::Structure
|
903
|
+
end
|
904
|
+
|
905
|
+
# @!attribute [rw] client_token
|
906
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
907
|
+
# idempotency of the request. If not provided, the Amazon Web Services
|
908
|
+
# SDK populates this field. For more information about idempotency,
|
909
|
+
# see [Making retries safe with idempotent APIs][1].
|
910
|
+
#
|
911
|
+
# **A suitable default value is auto-generated.** You should normally
|
912
|
+
# not need to pass this option.
|
913
|
+
#
|
914
|
+
#
|
915
|
+
#
|
916
|
+
# [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
917
|
+
# @return [String]
|
918
|
+
#
|
919
|
+
# @!attribute [rw] description
|
920
|
+
# The description.
|
921
|
+
# @return [String]
|
922
|
+
#
|
923
|
+
# @!attribute [rw] knowledge_base_type
|
924
|
+
# The type of knowledge base. Only CUSTOM knowledge bases allow you to
|
925
|
+
# upload your own content. EXTERNAL knowledge bases support
|
926
|
+
# integrations with third-party systems whose content is synchronized
|
927
|
+
# automatically.
|
928
|
+
# @return [String]
|
929
|
+
#
|
930
|
+
# @!attribute [rw] name
|
931
|
+
# The name of the knowledge base.
|
932
|
+
# @return [String]
|
933
|
+
#
|
934
|
+
# @!attribute [rw] rendering_configuration
|
935
|
+
# Information about how to render the content.
|
936
|
+
# @return [Types::RenderingConfiguration]
|
937
|
+
#
|
938
|
+
# @!attribute [rw] server_side_encryption_configuration
|
939
|
+
# The configuration information for the customer managed key used for
|
940
|
+
# encryption.
|
941
|
+
#
|
942
|
+
# This KMS key must have a policy that allows `kms:CreateGrant`,
|
943
|
+
# `kms:DescribeKey`, `kms:Decrypt`, and `kms:GenerateDataKey*`
|
944
|
+
# permissions to the IAM identity using the key to invoke Amazon Q.
|
945
|
+
#
|
946
|
+
# For more information about setting up a customer managed key for
|
947
|
+
# Amazon Q, see [Enable Amazon Q in Connect for your instance][1].
|
948
|
+
#
|
949
|
+
#
|
950
|
+
#
|
951
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/enable-q.html
|
952
|
+
# @return [Types::ServerSideEncryptionConfiguration]
|
953
|
+
#
|
954
|
+
# @!attribute [rw] source_configuration
|
955
|
+
# The source of the knowledge base content. Only set this argument for
|
956
|
+
# EXTERNAL knowledge bases.
|
957
|
+
# @return [Types::SourceConfiguration]
|
958
|
+
#
|
959
|
+
# @!attribute [rw] tags
|
960
|
+
# The tags used to organize, track, or control access for this
|
961
|
+
# resource.
|
962
|
+
# @return [Hash<String,String>]
|
963
|
+
#
|
964
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/CreateKnowledgeBaseRequest AWS API Documentation
|
965
|
+
#
|
966
|
+
class CreateKnowledgeBaseRequest < Struct.new(
|
967
|
+
:client_token,
|
968
|
+
:description,
|
969
|
+
:knowledge_base_type,
|
970
|
+
:name,
|
971
|
+
:rendering_configuration,
|
972
|
+
:server_side_encryption_configuration,
|
973
|
+
:source_configuration,
|
974
|
+
:tags)
|
975
|
+
SENSITIVE = []
|
976
|
+
include Aws::Structure
|
977
|
+
end
|
978
|
+
|
979
|
+
# @!attribute [rw] knowledge_base
|
980
|
+
# The knowledge base.
|
981
|
+
# @return [Types::KnowledgeBaseData]
|
982
|
+
#
|
983
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/CreateKnowledgeBaseResponse AWS API Documentation
|
984
|
+
#
|
985
|
+
class CreateKnowledgeBaseResponse < Struct.new(
|
986
|
+
:knowledge_base)
|
987
|
+
SENSITIVE = []
|
988
|
+
include Aws::Structure
|
989
|
+
end
|
990
|
+
|
991
|
+
# @!attribute [rw] channels
|
992
|
+
# The Amazon Connect channels this quick response applies to.
|
993
|
+
# @return [Array<String>]
|
994
|
+
#
|
995
|
+
# @!attribute [rw] client_token
|
996
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
997
|
+
# idempotency of the request. If not provided, the Amazon Web Services
|
998
|
+
# SDK populates this field. For more information about idempotency,
|
999
|
+
# see [Making retries safe with idempotent APIs][1].
|
1000
|
+
#
|
1001
|
+
# **A suitable default value is auto-generated.** You should normally
|
1002
|
+
# not need to pass this option.
|
1003
|
+
#
|
1004
|
+
#
|
1005
|
+
#
|
1006
|
+
# [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
1007
|
+
# @return [String]
|
1008
|
+
#
|
1009
|
+
# @!attribute [rw] content
|
1010
|
+
# The content of the quick response.
|
1011
|
+
# @return [Types::QuickResponseDataProvider]
|
1012
|
+
#
|
1013
|
+
# @!attribute [rw] content_type
|
1014
|
+
# The media type of the quick response content.
|
1015
|
+
#
|
1016
|
+
# * Use `application/x.quickresponse;format=plain` for a quick
|
1017
|
+
# response written in plain text.
|
1018
|
+
#
|
1019
|
+
# * Use `application/x.quickresponse;format=markdown` for a quick
|
1020
|
+
# response written in richtext.
|
1021
|
+
# @return [String]
|
1022
|
+
#
|
1023
|
+
# @!attribute [rw] description
|
1024
|
+
# The description of the quick response.
|
1025
|
+
# @return [String]
|
1026
|
+
#
|
1027
|
+
# @!attribute [rw] grouping_configuration
|
1028
|
+
# The configuration information of the user groups that the quick
|
1029
|
+
# response is accessible to.
|
1030
|
+
# @return [Types::GroupingConfiguration]
|
1031
|
+
#
|
1032
|
+
# @!attribute [rw] is_active
|
1033
|
+
# Whether the quick response is active.
|
1034
|
+
# @return [Boolean]
|
1035
|
+
#
|
1036
|
+
# @!attribute [rw] knowledge_base_id
|
1037
|
+
# The identifier of the knowledge base. This should not be a
|
1038
|
+
# QUICK\_RESPONSES type knowledge base if you're storing Amazon Q
|
1039
|
+
# Content resource to it. Can be either the ID or the ARN. URLs cannot
|
1040
|
+
# contain the ARN.
|
1041
|
+
# @return [String]
|
1042
|
+
#
|
1043
|
+
# @!attribute [rw] language
|
1044
|
+
# The language code value for the language in which the quick response
|
1045
|
+
# is written. The supported language codes include `de_DE`, `en_US`,
|
1046
|
+
# `es_ES`, `fr_FR`, `id_ID`, `it_IT`, `ja_JP`, `ko_KR`, `pt_BR`,
|
1047
|
+
# `zh_CN`, `zh_TW`
|
1048
|
+
# @return [String]
|
1049
|
+
#
|
1050
|
+
# @!attribute [rw] name
|
1051
|
+
# The name of the quick response.
|
1052
|
+
# @return [String]
|
1053
|
+
#
|
1054
|
+
# @!attribute [rw] shortcut_key
|
1055
|
+
# The shortcut key of the quick response. The value should be unique
|
1056
|
+
# across the knowledge base.
|
1057
|
+
# @return [String]
|
1058
|
+
#
|
1059
|
+
# @!attribute [rw] tags
|
1060
|
+
# The tags used to organize, track, or control access for this
|
1061
|
+
# resource.
|
1062
|
+
# @return [Hash<String,String>]
|
1063
|
+
#
|
1064
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/CreateQuickResponseRequest AWS API Documentation
|
1065
|
+
#
|
1066
|
+
class CreateQuickResponseRequest < Struct.new(
|
1067
|
+
:channels,
|
1068
|
+
:client_token,
|
1069
|
+
:content,
|
1070
|
+
:content_type,
|
1071
|
+
:description,
|
1072
|
+
:grouping_configuration,
|
1073
|
+
:is_active,
|
1074
|
+
:knowledge_base_id,
|
1075
|
+
:language,
|
1076
|
+
:name,
|
1077
|
+
:shortcut_key,
|
1078
|
+
:tags)
|
1079
|
+
SENSITIVE = []
|
1080
|
+
include Aws::Structure
|
1081
|
+
end
|
1082
|
+
|
1083
|
+
# @!attribute [rw] quick_response
|
1084
|
+
# The quick response.
|
1085
|
+
# @return [Types::QuickResponseData]
|
1086
|
+
#
|
1087
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/CreateQuickResponseResponse AWS API Documentation
|
1088
|
+
#
|
1089
|
+
class CreateQuickResponseResponse < Struct.new(
|
1090
|
+
:quick_response)
|
1091
|
+
SENSITIVE = []
|
1092
|
+
include Aws::Structure
|
1093
|
+
end
|
1094
|
+
|
1095
|
+
# @!attribute [rw] assistant_id
|
1096
|
+
# The identifier of the Amazon Q assistant. Can be either the ID or
|
1097
|
+
# the ARN. URLs cannot contain the ARN.
|
1098
|
+
# @return [String]
|
1099
|
+
#
|
1100
|
+
# @!attribute [rw] client_token
|
1101
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
1102
|
+
# idempotency of the request. If not provided, the Amazon Web Services
|
1103
|
+
# SDK populates this field. For more information about idempotency,
|
1104
|
+
# see [Making retries safe with idempotent APIs][1].
|
1105
|
+
#
|
1106
|
+
# **A suitable default value is auto-generated.** You should normally
|
1107
|
+
# not need to pass this option.
|
1108
|
+
#
|
1109
|
+
#
|
1110
|
+
#
|
1111
|
+
# [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
1112
|
+
# @return [String]
|
1113
|
+
#
|
1114
|
+
# @!attribute [rw] description
|
1115
|
+
# The description.
|
1116
|
+
# @return [String]
|
1117
|
+
#
|
1118
|
+
# @!attribute [rw] name
|
1119
|
+
# The name of the session.
|
1120
|
+
# @return [String]
|
1121
|
+
#
|
1122
|
+
# @!attribute [rw] tags
|
1123
|
+
# The tags used to organize, track, or control access for this
|
1124
|
+
# resource.
|
1125
|
+
# @return [Hash<String,String>]
|
1126
|
+
#
|
1127
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/CreateSessionRequest AWS API Documentation
|
1128
|
+
#
|
1129
|
+
class CreateSessionRequest < Struct.new(
|
1130
|
+
:assistant_id,
|
1131
|
+
:client_token,
|
1132
|
+
:description,
|
1133
|
+
:name,
|
1134
|
+
:tags)
|
1135
|
+
SENSITIVE = []
|
1136
|
+
include Aws::Structure
|
1137
|
+
end
|
1138
|
+
|
1139
|
+
# @!attribute [rw] session
|
1140
|
+
# The session.
|
1141
|
+
# @return [Types::SessionData]
|
1142
|
+
#
|
1143
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/CreateSessionResponse AWS API Documentation
|
1144
|
+
#
|
1145
|
+
class CreateSessionResponse < Struct.new(
|
1146
|
+
:session)
|
1147
|
+
SENSITIVE = []
|
1148
|
+
include Aws::Structure
|
1149
|
+
end
|
1150
|
+
|
1151
|
+
# Details about the data.
|
1152
|
+
#
|
1153
|
+
# @note DataDetails is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of DataDetails corresponding to the set member.
|
1154
|
+
#
|
1155
|
+
# @!attribute [rw] content_data
|
1156
|
+
# Details about the content data.
|
1157
|
+
# @return [Types::ContentDataDetails]
|
1158
|
+
#
|
1159
|
+
# @!attribute [rw] generative_data
|
1160
|
+
# Details about the generative data.
|
1161
|
+
# @return [Types::GenerativeDataDetails]
|
1162
|
+
#
|
1163
|
+
# @!attribute [rw] source_content_data
|
1164
|
+
# Details about the content data.
|
1165
|
+
# @return [Types::SourceContentDataDetails]
|
1166
|
+
#
|
1167
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/DataDetails AWS API Documentation
|
1168
|
+
#
|
1169
|
+
class DataDetails < Struct.new(
|
1170
|
+
:content_data,
|
1171
|
+
:generative_data,
|
1172
|
+
:source_content_data,
|
1173
|
+
:unknown)
|
1174
|
+
SENSITIVE = []
|
1175
|
+
include Aws::Structure
|
1176
|
+
include Aws::Structure::Union
|
1177
|
+
|
1178
|
+
class ContentData < DataDetails; end
|
1179
|
+
class GenerativeData < DataDetails; end
|
1180
|
+
class SourceContentData < DataDetails; end
|
1181
|
+
class Unknown < DataDetails; end
|
1182
|
+
end
|
1183
|
+
|
1184
|
+
# Reference data.
|
1185
|
+
#
|
1186
|
+
# @note DataReference is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of DataReference corresponding to the set member.
|
1187
|
+
#
|
1188
|
+
# @!attribute [rw] content_reference
|
1189
|
+
# Reference information about the content.
|
1190
|
+
# @return [Types::ContentReference]
|
1191
|
+
#
|
1192
|
+
# @!attribute [rw] generative_reference
|
1193
|
+
# Reference information about the generative content.
|
1194
|
+
# @return [Types::GenerativeReference]
|
1195
|
+
#
|
1196
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/DataReference AWS API Documentation
|
1197
|
+
#
|
1198
|
+
class DataReference < Struct.new(
|
1199
|
+
:content_reference,
|
1200
|
+
:generative_reference,
|
1201
|
+
:unknown)
|
1202
|
+
SENSITIVE = []
|
1203
|
+
include Aws::Structure
|
1204
|
+
include Aws::Structure::Union
|
1205
|
+
|
1206
|
+
class ContentReference < DataReference; end
|
1207
|
+
class GenerativeReference < DataReference; end
|
1208
|
+
class Unknown < DataReference; end
|
1209
|
+
end
|
1210
|
+
|
1211
|
+
# Summary of the data.
|
1212
|
+
#
|
1213
|
+
# @!attribute [rw] details
|
1214
|
+
# Details about the data.
|
1215
|
+
# @return [Types::DataDetails]
|
1216
|
+
#
|
1217
|
+
# @!attribute [rw] reference
|
1218
|
+
# Reference information about the content.
|
1219
|
+
# @return [Types::DataReference]
|
1220
|
+
#
|
1221
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/DataSummary AWS API Documentation
|
1222
|
+
#
|
1223
|
+
class DataSummary < Struct.new(
|
1224
|
+
:details,
|
1225
|
+
:reference)
|
1226
|
+
SENSITIVE = []
|
1227
|
+
include Aws::Structure
|
1228
|
+
end
|
1229
|
+
|
1230
|
+
# @!attribute [rw] assistant_association_id
|
1231
|
+
# The identifier of the assistant association. Can be either the ID or
|
1232
|
+
# the ARN. URLs cannot contain the ARN.
|
1233
|
+
# @return [String]
|
1234
|
+
#
|
1235
|
+
# @!attribute [rw] assistant_id
|
1236
|
+
# The identifier of the Amazon Q assistant. Can be either the ID or
|
1237
|
+
# the ARN. URLs cannot contain the ARN.
|
1238
|
+
# @return [String]
|
1239
|
+
#
|
1240
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/DeleteAssistantAssociationRequest AWS API Documentation
|
1241
|
+
#
|
1242
|
+
class DeleteAssistantAssociationRequest < Struct.new(
|
1243
|
+
:assistant_association_id,
|
1244
|
+
:assistant_id)
|
1245
|
+
SENSITIVE = []
|
1246
|
+
include Aws::Structure
|
1247
|
+
end
|
1248
|
+
|
1249
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/DeleteAssistantAssociationResponse AWS API Documentation
|
1250
|
+
#
|
1251
|
+
class DeleteAssistantAssociationResponse < Aws::EmptyStructure; end
|
1252
|
+
|
1253
|
+
# @!attribute [rw] assistant_id
|
1254
|
+
# The identifier of the Amazon Q assistant. Can be either the ID or
|
1255
|
+
# the ARN. URLs cannot contain the ARN.
|
1256
|
+
# @return [String]
|
1257
|
+
#
|
1258
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/DeleteAssistantRequest AWS API Documentation
|
1259
|
+
#
|
1260
|
+
class DeleteAssistantRequest < Struct.new(
|
1261
|
+
:assistant_id)
|
1262
|
+
SENSITIVE = []
|
1263
|
+
include Aws::Structure
|
1264
|
+
end
|
1265
|
+
|
1266
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/DeleteAssistantResponse AWS API Documentation
|
1267
|
+
#
|
1268
|
+
class DeleteAssistantResponse < Aws::EmptyStructure; end
|
1269
|
+
|
1270
|
+
# @!attribute [rw] content_id
|
1271
|
+
# The identifier of the content. Can be either the ID or the ARN. URLs
|
1272
|
+
# cannot contain the ARN.
|
1273
|
+
# @return [String]
|
1274
|
+
#
|
1275
|
+
# @!attribute [rw] knowledge_base_id
|
1276
|
+
# The identifier of the knowledge base. This should not be a
|
1277
|
+
# QUICK\_RESPONSES type knowledge base if you're storing Amazon Q
|
1278
|
+
# Content resource to it. Can be either the ID or the ARN. URLs cannot
|
1279
|
+
# contain the ARN.
|
1280
|
+
# @return [String]
|
1281
|
+
#
|
1282
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/DeleteContentRequest AWS API Documentation
|
1283
|
+
#
|
1284
|
+
class DeleteContentRequest < Struct.new(
|
1285
|
+
:content_id,
|
1286
|
+
:knowledge_base_id)
|
1287
|
+
SENSITIVE = []
|
1288
|
+
include Aws::Structure
|
1289
|
+
end
|
1290
|
+
|
1291
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/DeleteContentResponse AWS API Documentation
|
1292
|
+
#
|
1293
|
+
class DeleteContentResponse < Aws::EmptyStructure; end
|
1294
|
+
|
1295
|
+
# @!attribute [rw] import_job_id
|
1296
|
+
# The identifier of the import job to be deleted.
|
1297
|
+
# @return [String]
|
1298
|
+
#
|
1299
|
+
# @!attribute [rw] knowledge_base_id
|
1300
|
+
# The identifier of the knowledge base. This should not be a
|
1301
|
+
# QUICK\_RESPONSES type knowledge base if you're storing Amazon Q
|
1302
|
+
# Content resource to it.
|
1303
|
+
# @return [String]
|
1304
|
+
#
|
1305
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/DeleteImportJobRequest AWS API Documentation
|
1306
|
+
#
|
1307
|
+
class DeleteImportJobRequest < Struct.new(
|
1308
|
+
:import_job_id,
|
1309
|
+
:knowledge_base_id)
|
1310
|
+
SENSITIVE = []
|
1311
|
+
include Aws::Structure
|
1312
|
+
end
|
1313
|
+
|
1314
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/DeleteImportJobResponse AWS API Documentation
|
1315
|
+
#
|
1316
|
+
class DeleteImportJobResponse < Aws::EmptyStructure; end
|
1317
|
+
|
1318
|
+
# @!attribute [rw] knowledge_base_id
|
1319
|
+
# The knowledge base to delete content from. Can be either the ID or
|
1320
|
+
# the ARN. URLs cannot contain the ARN.
|
1321
|
+
# @return [String]
|
1322
|
+
#
|
1323
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/DeleteKnowledgeBaseRequest AWS API Documentation
|
1324
|
+
#
|
1325
|
+
class DeleteKnowledgeBaseRequest < Struct.new(
|
1326
|
+
:knowledge_base_id)
|
1327
|
+
SENSITIVE = []
|
1328
|
+
include Aws::Structure
|
1329
|
+
end
|
1330
|
+
|
1331
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/DeleteKnowledgeBaseResponse AWS API Documentation
|
1332
|
+
#
|
1333
|
+
class DeleteKnowledgeBaseResponse < Aws::EmptyStructure; end
|
1334
|
+
|
1335
|
+
# @!attribute [rw] knowledge_base_id
|
1336
|
+
# The knowledge base from which the quick response is deleted. The
|
1337
|
+
# identifier of the knowledge base. This should not be a
|
1338
|
+
# QUICK\_RESPONSES type knowledge base if you're storing Amazon Q
|
1339
|
+
# Content resource to it.
|
1340
|
+
# @return [String]
|
1341
|
+
#
|
1342
|
+
# @!attribute [rw] quick_response_id
|
1343
|
+
# The identifier of the quick response to delete.
|
1344
|
+
# @return [String]
|
1345
|
+
#
|
1346
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/DeleteQuickResponseRequest AWS API Documentation
|
1347
|
+
#
|
1348
|
+
class DeleteQuickResponseRequest < Struct.new(
|
1349
|
+
:knowledge_base_id,
|
1350
|
+
:quick_response_id)
|
1351
|
+
SENSITIVE = []
|
1352
|
+
include Aws::Structure
|
1353
|
+
end
|
1354
|
+
|
1355
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/DeleteQuickResponseResponse AWS API Documentation
|
1356
|
+
#
|
1357
|
+
class DeleteQuickResponseResponse < Aws::EmptyStructure; end
|
1358
|
+
|
1359
|
+
# The document.
|
1360
|
+
#
|
1361
|
+
# @!attribute [rw] content_reference
|
1362
|
+
# A reference to the content resource.
|
1363
|
+
# @return [Types::ContentReference]
|
1364
|
+
#
|
1365
|
+
# @!attribute [rw] excerpt
|
1366
|
+
# The excerpt from the document.
|
1367
|
+
# @return [Types::DocumentText]
|
1368
|
+
#
|
1369
|
+
# @!attribute [rw] title
|
1370
|
+
# The title of the document.
|
1371
|
+
# @return [Types::DocumentText]
|
1372
|
+
#
|
1373
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/Document AWS API Documentation
|
1374
|
+
#
|
1375
|
+
class Document < Struct.new(
|
1376
|
+
:content_reference,
|
1377
|
+
:excerpt,
|
1378
|
+
:title)
|
1379
|
+
SENSITIVE = []
|
1380
|
+
include Aws::Structure
|
1381
|
+
end
|
1382
|
+
|
1383
|
+
# The text of the document.
|
1384
|
+
#
|
1385
|
+
# @!attribute [rw] highlights
|
1386
|
+
# Highlights in the document text.
|
1387
|
+
# @return [Array<Types::Highlight>]
|
1388
|
+
#
|
1389
|
+
# @!attribute [rw] text
|
1390
|
+
# Text in the document.
|
1391
|
+
# @return [String]
|
1392
|
+
#
|
1393
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/DocumentText AWS API Documentation
|
1394
|
+
#
|
1395
|
+
class DocumentText < Struct.new(
|
1396
|
+
:highlights,
|
1397
|
+
:text)
|
1398
|
+
SENSITIVE = [:text]
|
1399
|
+
include Aws::Structure
|
1400
|
+
end
|
1401
|
+
|
1402
|
+
# The configuration information of the external data source.
|
1403
|
+
#
|
1404
|
+
# @!attribute [rw] configuration
|
1405
|
+
# The configuration information of the external data source.
|
1406
|
+
# @return [Types::Configuration]
|
1407
|
+
#
|
1408
|
+
# @!attribute [rw] source
|
1409
|
+
# The type of the external data source.
|
1410
|
+
# @return [String]
|
1411
|
+
#
|
1412
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ExternalSourceConfiguration AWS API Documentation
|
1413
|
+
#
|
1414
|
+
class ExternalSourceConfiguration < Struct.new(
|
1415
|
+
:configuration,
|
1416
|
+
:source)
|
1417
|
+
SENSITIVE = []
|
1418
|
+
include Aws::Structure
|
1419
|
+
end
|
1420
|
+
|
1421
|
+
# A search filter.
|
1422
|
+
#
|
1423
|
+
# @!attribute [rw] field
|
1424
|
+
# The field on which to filter.
|
1425
|
+
# @return [String]
|
1426
|
+
#
|
1427
|
+
# @!attribute [rw] operator
|
1428
|
+
# The operator to use for comparing the field’s value with the
|
1429
|
+
# provided value.
|
1430
|
+
# @return [String]
|
1431
|
+
#
|
1432
|
+
# @!attribute [rw] value
|
1433
|
+
# The desired field value on which to filter.
|
1434
|
+
# @return [String]
|
1435
|
+
#
|
1436
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/Filter AWS API Documentation
|
1437
|
+
#
|
1438
|
+
class Filter < Struct.new(
|
1439
|
+
:field,
|
1440
|
+
:operator,
|
1441
|
+
:value)
|
1442
|
+
SENSITIVE = []
|
1443
|
+
include Aws::Structure
|
1444
|
+
end
|
1445
|
+
|
1446
|
+
# Details about generative data.
|
1447
|
+
#
|
1448
|
+
# @!attribute [rw] completion
|
1449
|
+
# The LLM response.
|
1450
|
+
# @return [String]
|
1451
|
+
#
|
1452
|
+
# @!attribute [rw] ranking_data
|
1453
|
+
# Details about the generative content ranking data.
|
1454
|
+
# @return [Types::RankingData]
|
1455
|
+
#
|
1456
|
+
# @!attribute [rw] references
|
1457
|
+
# The references used to generative the LLM response.
|
1458
|
+
# @return [Array<Types::DataSummary>]
|
1459
|
+
#
|
1460
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/GenerativeDataDetails AWS API Documentation
|
1461
|
+
#
|
1462
|
+
class GenerativeDataDetails < Struct.new(
|
1463
|
+
:completion,
|
1464
|
+
:ranking_data,
|
1465
|
+
:references)
|
1466
|
+
SENSITIVE = [:completion]
|
1467
|
+
include Aws::Structure
|
1468
|
+
end
|
1469
|
+
|
1470
|
+
# Reference information about generative content.
|
1471
|
+
#
|
1472
|
+
# @!attribute [rw] generation_id
|
1473
|
+
# The identifier of the LLM model.
|
1474
|
+
# @return [String]
|
1475
|
+
#
|
1476
|
+
# @!attribute [rw] model_id
|
1477
|
+
# The identifier of the LLM model.
|
1478
|
+
# @return [String]
|
1479
|
+
#
|
1480
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/GenerativeReference AWS API Documentation
|
1481
|
+
#
|
1482
|
+
class GenerativeReference < Struct.new(
|
1483
|
+
:generation_id,
|
1484
|
+
:model_id)
|
1485
|
+
SENSITIVE = []
|
1486
|
+
include Aws::Structure
|
1487
|
+
end
|
1488
|
+
|
1489
|
+
# @!attribute [rw] assistant_association_id
|
1490
|
+
# The identifier of the assistant association. Can be either the ID or
|
1491
|
+
# the ARN. URLs cannot contain the ARN.
|
1492
|
+
# @return [String]
|
1493
|
+
#
|
1494
|
+
# @!attribute [rw] assistant_id
|
1495
|
+
# The identifier of the Amazon Q assistant. Can be either the ID or
|
1496
|
+
# the ARN. URLs cannot contain the ARN.
|
1497
|
+
# @return [String]
|
1498
|
+
#
|
1499
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/GetAssistantAssociationRequest AWS API Documentation
|
1500
|
+
#
|
1501
|
+
class GetAssistantAssociationRequest < Struct.new(
|
1502
|
+
:assistant_association_id,
|
1503
|
+
:assistant_id)
|
1504
|
+
SENSITIVE = []
|
1505
|
+
include Aws::Structure
|
1506
|
+
end
|
1507
|
+
|
1508
|
+
# @!attribute [rw] assistant_association
|
1509
|
+
# The assistant association.
|
1510
|
+
# @return [Types::AssistantAssociationData]
|
1511
|
+
#
|
1512
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/GetAssistantAssociationResponse AWS API Documentation
|
1513
|
+
#
|
1514
|
+
class GetAssistantAssociationResponse < Struct.new(
|
1515
|
+
:assistant_association)
|
1516
|
+
SENSITIVE = []
|
1517
|
+
include Aws::Structure
|
1518
|
+
end
|
1519
|
+
|
1520
|
+
# @!attribute [rw] assistant_id
|
1521
|
+
# The identifier of the Amazon Q assistant. Can be either the ID or
|
1522
|
+
# the ARN. URLs cannot contain the ARN.
|
1523
|
+
# @return [String]
|
1524
|
+
#
|
1525
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/GetAssistantRequest AWS API Documentation
|
1526
|
+
#
|
1527
|
+
class GetAssistantRequest < Struct.new(
|
1528
|
+
:assistant_id)
|
1529
|
+
SENSITIVE = []
|
1530
|
+
include Aws::Structure
|
1531
|
+
end
|
1532
|
+
|
1533
|
+
# @!attribute [rw] assistant
|
1534
|
+
# Information about the assistant.
|
1535
|
+
# @return [Types::AssistantData]
|
1536
|
+
#
|
1537
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/GetAssistantResponse AWS API Documentation
|
1538
|
+
#
|
1539
|
+
class GetAssistantResponse < Struct.new(
|
1540
|
+
:assistant)
|
1541
|
+
SENSITIVE = []
|
1542
|
+
include Aws::Structure
|
1543
|
+
end
|
1544
|
+
|
1545
|
+
# @!attribute [rw] content_id
|
1546
|
+
# The identifier of the content. Can be either the ID or the ARN. URLs
|
1547
|
+
# cannot contain the ARN.
|
1548
|
+
# @return [String]
|
1549
|
+
#
|
1550
|
+
# @!attribute [rw] knowledge_base_id
|
1551
|
+
# The identifier of the knowledge base. This should not be a
|
1552
|
+
# QUICK\_RESPONSES type knowledge base if you're storing Amazon Q
|
1553
|
+
# Content resource to it. Can be either the ID or the ARN. URLs cannot
|
1554
|
+
# contain the ARN.
|
1555
|
+
# @return [String]
|
1556
|
+
#
|
1557
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/GetContentRequest AWS API Documentation
|
1558
|
+
#
|
1559
|
+
class GetContentRequest < Struct.new(
|
1560
|
+
:content_id,
|
1561
|
+
:knowledge_base_id)
|
1562
|
+
SENSITIVE = []
|
1563
|
+
include Aws::Structure
|
1564
|
+
end
|
1565
|
+
|
1566
|
+
# @!attribute [rw] content
|
1567
|
+
# The content.
|
1568
|
+
# @return [Types::ContentData]
|
1569
|
+
#
|
1570
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/GetContentResponse AWS API Documentation
|
1571
|
+
#
|
1572
|
+
class GetContentResponse < Struct.new(
|
1573
|
+
:content)
|
1574
|
+
SENSITIVE = []
|
1575
|
+
include Aws::Structure
|
1576
|
+
end
|
1577
|
+
|
1578
|
+
# @!attribute [rw] content_id
|
1579
|
+
# The identifier of the content. Can be either the ID or the ARN. URLs
|
1580
|
+
# cannot contain the ARN.
|
1581
|
+
# @return [String]
|
1582
|
+
#
|
1583
|
+
# @!attribute [rw] knowledge_base_id
|
1584
|
+
# The identifier of the knowledge base. This should not be a
|
1585
|
+
# QUICK\_RESPONSES type knowledge base if you're storing Amazon Q
|
1586
|
+
# Content resource to it. Can be either the ID or the ARN. URLs cannot
|
1587
|
+
# contain the ARN.
|
1588
|
+
# @return [String]
|
1589
|
+
#
|
1590
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/GetContentSummaryRequest AWS API Documentation
|
1591
|
+
#
|
1592
|
+
class GetContentSummaryRequest < Struct.new(
|
1593
|
+
:content_id,
|
1594
|
+
:knowledge_base_id)
|
1595
|
+
SENSITIVE = []
|
1596
|
+
include Aws::Structure
|
1597
|
+
end
|
1598
|
+
|
1599
|
+
# @!attribute [rw] content_summary
|
1600
|
+
# The content summary.
|
1601
|
+
# @return [Types::ContentSummary]
|
1602
|
+
#
|
1603
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/GetContentSummaryResponse AWS API Documentation
|
1604
|
+
#
|
1605
|
+
class GetContentSummaryResponse < Struct.new(
|
1606
|
+
:content_summary)
|
1607
|
+
SENSITIVE = []
|
1608
|
+
include Aws::Structure
|
1609
|
+
end
|
1610
|
+
|
1611
|
+
# @!attribute [rw] import_job_id
|
1612
|
+
# The identifier of the import job to retrieve.
|
1613
|
+
# @return [String]
|
1614
|
+
#
|
1615
|
+
# @!attribute [rw] knowledge_base_id
|
1616
|
+
# The identifier of the knowledge base that the import job belongs to.
|
1617
|
+
# @return [String]
|
1618
|
+
#
|
1619
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/GetImportJobRequest AWS API Documentation
|
1620
|
+
#
|
1621
|
+
class GetImportJobRequest < Struct.new(
|
1622
|
+
:import_job_id,
|
1623
|
+
:knowledge_base_id)
|
1624
|
+
SENSITIVE = []
|
1625
|
+
include Aws::Structure
|
1626
|
+
end
|
1627
|
+
|
1628
|
+
# @!attribute [rw] import_job
|
1629
|
+
# The import job.
|
1630
|
+
# @return [Types::ImportJobData]
|
1631
|
+
#
|
1632
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/GetImportJobResponse AWS API Documentation
|
1633
|
+
#
|
1634
|
+
class GetImportJobResponse < Struct.new(
|
1635
|
+
:import_job)
|
1636
|
+
SENSITIVE = []
|
1637
|
+
include Aws::Structure
|
1638
|
+
end
|
1639
|
+
|
1640
|
+
# @!attribute [rw] knowledge_base_id
|
1641
|
+
# The identifier of the knowledge base. This should not be a
|
1642
|
+
# QUICK\_RESPONSES type knowledge base if you're storing Amazon Q
|
1643
|
+
# Content resource to it. Can be either the ID or the ARN. URLs cannot
|
1644
|
+
# contain the ARN.
|
1645
|
+
# @return [String]
|
1646
|
+
#
|
1647
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/GetKnowledgeBaseRequest AWS API Documentation
|
1648
|
+
#
|
1649
|
+
class GetKnowledgeBaseRequest < Struct.new(
|
1650
|
+
:knowledge_base_id)
|
1651
|
+
SENSITIVE = []
|
1652
|
+
include Aws::Structure
|
1653
|
+
end
|
1654
|
+
|
1655
|
+
# @!attribute [rw] knowledge_base
|
1656
|
+
# The knowledge base.
|
1657
|
+
# @return [Types::KnowledgeBaseData]
|
1658
|
+
#
|
1659
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/GetKnowledgeBaseResponse AWS API Documentation
|
1660
|
+
#
|
1661
|
+
class GetKnowledgeBaseResponse < Struct.new(
|
1662
|
+
:knowledge_base)
|
1663
|
+
SENSITIVE = []
|
1664
|
+
include Aws::Structure
|
1665
|
+
end
|
1666
|
+
|
1667
|
+
# @!attribute [rw] knowledge_base_id
|
1668
|
+
# The identifier of the knowledge base. This should be a
|
1669
|
+
# QUICK\_RESPONSES type knowledge base.
|
1670
|
+
# @return [String]
|
1671
|
+
#
|
1672
|
+
# @!attribute [rw] quick_response_id
|
1673
|
+
# The identifier of the quick response.
|
1674
|
+
# @return [String]
|
1675
|
+
#
|
1676
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/GetQuickResponseRequest AWS API Documentation
|
1677
|
+
#
|
1678
|
+
class GetQuickResponseRequest < Struct.new(
|
1679
|
+
:knowledge_base_id,
|
1680
|
+
:quick_response_id)
|
1681
|
+
SENSITIVE = []
|
1682
|
+
include Aws::Structure
|
1683
|
+
end
|
1684
|
+
|
1685
|
+
# @!attribute [rw] quick_response
|
1686
|
+
# The quick response.
|
1687
|
+
# @return [Types::QuickResponseData]
|
1688
|
+
#
|
1689
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/GetQuickResponseResponse AWS API Documentation
|
1690
|
+
#
|
1691
|
+
class GetQuickResponseResponse < Struct.new(
|
1692
|
+
:quick_response)
|
1693
|
+
SENSITIVE = []
|
1694
|
+
include Aws::Structure
|
1695
|
+
end
|
1696
|
+
|
1697
|
+
# @!attribute [rw] assistant_id
|
1698
|
+
# The identifier of the Amazon Q assistant. Can be either the ID or
|
1699
|
+
# the ARN. URLs cannot contain the ARN.
|
1700
|
+
# @return [String]
|
1701
|
+
#
|
1702
|
+
# @!attribute [rw] max_results
|
1703
|
+
# The maximum number of results to return per page.
|
1704
|
+
# @return [Integer]
|
1705
|
+
#
|
1706
|
+
# @!attribute [rw] session_id
|
1707
|
+
# The identifier of the session. Can be either the ID or the ARN. URLs
|
1708
|
+
# cannot contain the ARN.
|
1709
|
+
# @return [String]
|
1710
|
+
#
|
1711
|
+
# @!attribute [rw] wait_time_seconds
|
1712
|
+
# The duration (in seconds) for which the call waits for a
|
1713
|
+
# recommendation to be made available before returning. If a
|
1714
|
+
# recommendation is available, the call returns sooner than
|
1715
|
+
# `WaitTimeSeconds`. If no messages are available and the wait time
|
1716
|
+
# expires, the call returns successfully with an empty list.
|
1717
|
+
# @return [Integer]
|
1718
|
+
#
|
1719
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/GetRecommendationsRequest AWS API Documentation
|
1720
|
+
#
|
1721
|
+
class GetRecommendationsRequest < Struct.new(
|
1722
|
+
:assistant_id,
|
1723
|
+
:max_results,
|
1724
|
+
:session_id,
|
1725
|
+
:wait_time_seconds)
|
1726
|
+
SENSITIVE = []
|
1727
|
+
include Aws::Structure
|
1728
|
+
end
|
1729
|
+
|
1730
|
+
# @!attribute [rw] recommendations
|
1731
|
+
# The recommendations.
|
1732
|
+
# @return [Array<Types::RecommendationData>]
|
1733
|
+
#
|
1734
|
+
# @!attribute [rw] triggers
|
1735
|
+
# The triggers corresponding to recommendations.
|
1736
|
+
# @return [Array<Types::RecommendationTrigger>]
|
1737
|
+
#
|
1738
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/GetRecommendationsResponse AWS API Documentation
|
1739
|
+
#
|
1740
|
+
class GetRecommendationsResponse < Struct.new(
|
1741
|
+
:recommendations,
|
1742
|
+
:triggers)
|
1743
|
+
SENSITIVE = []
|
1744
|
+
include Aws::Structure
|
1745
|
+
end
|
1746
|
+
|
1747
|
+
# @!attribute [rw] assistant_id
|
1748
|
+
# The identifier of the Amazon Q assistant. Can be either the ID or
|
1749
|
+
# the ARN. URLs cannot contain the ARN.
|
1750
|
+
# @return [String]
|
1751
|
+
#
|
1752
|
+
# @!attribute [rw] session_id
|
1753
|
+
# The identifier of the session. Can be either the ID or the ARN. URLs
|
1754
|
+
# cannot contain the ARN.
|
1755
|
+
# @return [String]
|
1756
|
+
#
|
1757
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/GetSessionRequest AWS API Documentation
|
1758
|
+
#
|
1759
|
+
class GetSessionRequest < Struct.new(
|
1760
|
+
:assistant_id,
|
1761
|
+
:session_id)
|
1762
|
+
SENSITIVE = []
|
1763
|
+
include Aws::Structure
|
1764
|
+
end
|
1765
|
+
|
1766
|
+
# @!attribute [rw] session
|
1767
|
+
# The session.
|
1768
|
+
# @return [Types::SessionData]
|
1769
|
+
#
|
1770
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/GetSessionResponse AWS API Documentation
|
1771
|
+
#
|
1772
|
+
class GetSessionResponse < Struct.new(
|
1773
|
+
:session)
|
1774
|
+
SENSITIVE = []
|
1775
|
+
include Aws::Structure
|
1776
|
+
end
|
1777
|
+
|
1778
|
+
# The configuration information of the grouping of Amazon Q users.
|
1779
|
+
#
|
1780
|
+
# @!attribute [rw] criteria
|
1781
|
+
# The criteria used for grouping Amazon Q users.
|
1782
|
+
#
|
1783
|
+
# The following is the list of supported criteria values.
|
1784
|
+
#
|
1785
|
+
# * `RoutingProfileArn`: Grouping the users by their [Amazon Connect
|
1786
|
+
# routing profile ARN][1]. User should have
|
1787
|
+
# [SearchRoutingProfile][2] and [DescribeRoutingProfile][3]
|
1788
|
+
# permissions when setting criteria to this value.
|
1789
|
+
#
|
1790
|
+
# ^
|
1791
|
+
#
|
1792
|
+
#
|
1793
|
+
#
|
1794
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/APIReference/API_RoutingProfile.html
|
1795
|
+
# [2]: https://docs.aws.amazon.com/connect/latest/APIReference/API_SearchRoutingProfiles.html
|
1796
|
+
# [3]: https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribeRoutingProfile.html
|
1797
|
+
# @return [String]
|
1798
|
+
#
|
1799
|
+
# @!attribute [rw] values
|
1800
|
+
# The list of values that define different groups of Amazon Q users.
|
1801
|
+
#
|
1802
|
+
# * When setting `criteria` to `RoutingProfileArn`, you need to
|
1803
|
+
# provide a list of ARNs of [Amazon Connect routing profiles][1] as
|
1804
|
+
# values of this parameter.
|
1805
|
+
#
|
1806
|
+
# ^
|
1807
|
+
#
|
1808
|
+
#
|
1809
|
+
#
|
1810
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/APIReference/API_RoutingProfile.html
|
1811
|
+
# @return [Array<String>]
|
1812
|
+
#
|
1813
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/GroupingConfiguration AWS API Documentation
|
1814
|
+
#
|
1815
|
+
class GroupingConfiguration < Struct.new(
|
1816
|
+
:criteria,
|
1817
|
+
:values)
|
1818
|
+
SENSITIVE = [:criteria]
|
1819
|
+
include Aws::Structure
|
1820
|
+
end
|
1821
|
+
|
1822
|
+
# Offset specification to describe highlighting of document excerpts for
|
1823
|
+
# rendering search results and recommendations.
|
1824
|
+
#
|
1825
|
+
# @!attribute [rw] begin_offset_inclusive
|
1826
|
+
# The offset for the start of the highlight.
|
1827
|
+
# @return [Integer]
|
1828
|
+
#
|
1829
|
+
# @!attribute [rw] end_offset_exclusive
|
1830
|
+
# The offset for the end of the highlight.
|
1831
|
+
# @return [Integer]
|
1832
|
+
#
|
1833
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/Highlight AWS API Documentation
|
1834
|
+
#
|
1835
|
+
class Highlight < Struct.new(
|
1836
|
+
:begin_offset_inclusive,
|
1837
|
+
:end_offset_exclusive)
|
1838
|
+
SENSITIVE = []
|
1839
|
+
include Aws::Structure
|
1840
|
+
end
|
1841
|
+
|
1842
|
+
# Summary information about the import job.
|
1843
|
+
#
|
1844
|
+
# @!attribute [rw] created_time
|
1845
|
+
# The timestamp when the import job was created.
|
1846
|
+
# @return [Time]
|
1847
|
+
#
|
1848
|
+
# @!attribute [rw] external_source_configuration
|
1849
|
+
# The configuration information of the external data source.
|
1850
|
+
# @return [Types::ExternalSourceConfiguration]
|
1851
|
+
#
|
1852
|
+
# @!attribute [rw] failed_record_report
|
1853
|
+
# The link to donwload the information of resource data that failed to
|
1854
|
+
# be imported.
|
1855
|
+
# @return [String]
|
1856
|
+
#
|
1857
|
+
# @!attribute [rw] import_job_id
|
1858
|
+
# The identifier of the import job.
|
1859
|
+
# @return [String]
|
1860
|
+
#
|
1861
|
+
# @!attribute [rw] import_job_type
|
1862
|
+
# The type of the import job.
|
1863
|
+
# @return [String]
|
1864
|
+
#
|
1865
|
+
# @!attribute [rw] knowledge_base_arn
|
1866
|
+
# The Amazon Resource Name (ARN) of the knowledge base.
|
1867
|
+
# @return [String]
|
1868
|
+
#
|
1869
|
+
# @!attribute [rw] knowledge_base_id
|
1870
|
+
# The identifier of the knowledge base. This should not be a
|
1871
|
+
# QUICK\_RESPONSES type knowledge base if you're storing Amazon Q
|
1872
|
+
# Content resource to it.
|
1873
|
+
# @return [String]
|
1874
|
+
#
|
1875
|
+
# @!attribute [rw] last_modified_time
|
1876
|
+
# The timestamp when the import job data was last modified.
|
1877
|
+
# @return [Time]
|
1878
|
+
#
|
1879
|
+
# @!attribute [rw] metadata
|
1880
|
+
# The metadata fields of the imported Amazon Q resources.
|
1881
|
+
# @return [Hash<String,String>]
|
1882
|
+
#
|
1883
|
+
# @!attribute [rw] status
|
1884
|
+
# The status of the import job.
|
1885
|
+
# @return [String]
|
1886
|
+
#
|
1887
|
+
# @!attribute [rw] upload_id
|
1888
|
+
# A pointer to the uploaded asset. This value is returned by
|
1889
|
+
# [StartContentUpload][1].
|
1890
|
+
#
|
1891
|
+
#
|
1892
|
+
#
|
1893
|
+
# [1]: https://docs.aws.amazon.com/wisdom/latest/APIReference/API_StartContentUpload.html
|
1894
|
+
# @return [String]
|
1895
|
+
#
|
1896
|
+
# @!attribute [rw] url
|
1897
|
+
# The download link to the resource file that is uploaded to the
|
1898
|
+
# import job.
|
1899
|
+
# @return [String]
|
1900
|
+
#
|
1901
|
+
# @!attribute [rw] url_expiry
|
1902
|
+
# The expiration time of the URL as an epoch timestamp.
|
1903
|
+
# @return [Time]
|
1904
|
+
#
|
1905
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ImportJobData AWS API Documentation
|
1906
|
+
#
|
1907
|
+
class ImportJobData < Struct.new(
|
1908
|
+
:created_time,
|
1909
|
+
:external_source_configuration,
|
1910
|
+
:failed_record_report,
|
1911
|
+
:import_job_id,
|
1912
|
+
:import_job_type,
|
1913
|
+
:knowledge_base_arn,
|
1914
|
+
:knowledge_base_id,
|
1915
|
+
:last_modified_time,
|
1916
|
+
:metadata,
|
1917
|
+
:status,
|
1918
|
+
:upload_id,
|
1919
|
+
:url,
|
1920
|
+
:url_expiry)
|
1921
|
+
SENSITIVE = [:failed_record_report, :url]
|
1922
|
+
include Aws::Structure
|
1923
|
+
end
|
1924
|
+
|
1925
|
+
# Summary information about the import job.
|
1926
|
+
#
|
1927
|
+
# @!attribute [rw] created_time
|
1928
|
+
# The timestamp when the import job was created.
|
1929
|
+
# @return [Time]
|
1930
|
+
#
|
1931
|
+
# @!attribute [rw] external_source_configuration
|
1932
|
+
# The configuration information of the external source that the
|
1933
|
+
# resource data are imported from.
|
1934
|
+
# @return [Types::ExternalSourceConfiguration]
|
1935
|
+
#
|
1936
|
+
# @!attribute [rw] import_job_id
|
1937
|
+
# The identifier of the import job.
|
1938
|
+
# @return [String]
|
1939
|
+
#
|
1940
|
+
# @!attribute [rw] import_job_type
|
1941
|
+
# The type of import job.
|
1942
|
+
# @return [String]
|
1943
|
+
#
|
1944
|
+
# @!attribute [rw] knowledge_base_arn
|
1945
|
+
# The Amazon Resource Name (ARN) of the knowledge base.
|
1946
|
+
# @return [String]
|
1947
|
+
#
|
1948
|
+
# @!attribute [rw] knowledge_base_id
|
1949
|
+
# The identifier of the knowledge base. This should not be a
|
1950
|
+
# QUICK\_RESPONSES type knowledge base if you're storing Amazon Q
|
1951
|
+
# Content resource to it.
|
1952
|
+
# @return [String]
|
1953
|
+
#
|
1954
|
+
# @!attribute [rw] last_modified_time
|
1955
|
+
# The timestamp when the import job was last modified.
|
1956
|
+
# @return [Time]
|
1957
|
+
#
|
1958
|
+
# @!attribute [rw] metadata
|
1959
|
+
# The metadata fields of the imported Amazon Q resources.
|
1960
|
+
# @return [Hash<String,String>]
|
1961
|
+
#
|
1962
|
+
# @!attribute [rw] status
|
1963
|
+
# The status of the import job.
|
1964
|
+
# @return [String]
|
1965
|
+
#
|
1966
|
+
# @!attribute [rw] upload_id
|
1967
|
+
# A pointer to the uploaded asset. This value is returned by
|
1968
|
+
# [StartContentUpload][1].
|
1969
|
+
#
|
1970
|
+
#
|
1971
|
+
#
|
1972
|
+
# [1]: https://docs.aws.amazon.com/wisdom/latest/APIReference/API_StartContentUpload.html
|
1973
|
+
# @return [String]
|
1974
|
+
#
|
1975
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ImportJobSummary AWS API Documentation
|
1976
|
+
#
|
1977
|
+
class ImportJobSummary < Struct.new(
|
1978
|
+
:created_time,
|
1979
|
+
:external_source_configuration,
|
1980
|
+
:import_job_id,
|
1981
|
+
:import_job_type,
|
1982
|
+
:knowledge_base_arn,
|
1983
|
+
:knowledge_base_id,
|
1984
|
+
:last_modified_time,
|
1985
|
+
:metadata,
|
1986
|
+
:status,
|
1987
|
+
:upload_id)
|
1988
|
+
SENSITIVE = []
|
1989
|
+
include Aws::Structure
|
1990
|
+
end
|
1991
|
+
|
1992
|
+
# Association information about the knowledge base.
|
1993
|
+
#
|
1994
|
+
# @!attribute [rw] knowledge_base_arn
|
1995
|
+
# The Amazon Resource Name (ARN) of the knowledge base.
|
1996
|
+
# @return [String]
|
1997
|
+
#
|
1998
|
+
# @!attribute [rw] knowledge_base_id
|
1999
|
+
# The identifier of the knowledge base. This should not be a
|
2000
|
+
# QUICK\_RESPONSES type knowledge base if you're storing Amazon Q
|
2001
|
+
# Content resource to it.
|
2002
|
+
# @return [String]
|
2003
|
+
#
|
2004
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/KnowledgeBaseAssociationData AWS API Documentation
|
2005
|
+
#
|
2006
|
+
class KnowledgeBaseAssociationData < Struct.new(
|
2007
|
+
:knowledge_base_arn,
|
2008
|
+
:knowledge_base_id)
|
2009
|
+
SENSITIVE = []
|
2010
|
+
include Aws::Structure
|
2011
|
+
end
|
2012
|
+
|
2013
|
+
# Information about the knowledge base.
|
2014
|
+
#
|
2015
|
+
# @!attribute [rw] description
|
2016
|
+
# The description.
|
2017
|
+
# @return [String]
|
2018
|
+
#
|
2019
|
+
# @!attribute [rw] knowledge_base_arn
|
2020
|
+
# The Amazon Resource Name (ARN) of the knowledge base.
|
2021
|
+
# @return [String]
|
2022
|
+
#
|
2023
|
+
# @!attribute [rw] knowledge_base_id
|
2024
|
+
# The identifier of the knowledge base. This should not be a
|
2025
|
+
# QUICK\_RESPONSES type knowledge base if you're storing Amazon Q
|
2026
|
+
# Content resource to it.
|
2027
|
+
# @return [String]
|
2028
|
+
#
|
2029
|
+
# @!attribute [rw] knowledge_base_type
|
2030
|
+
# The type of knowledge base.
|
2031
|
+
# @return [String]
|
2032
|
+
#
|
2033
|
+
# @!attribute [rw] last_content_modification_time
|
2034
|
+
# An epoch timestamp indicating the most recent content modification
|
2035
|
+
# inside the knowledge base. If no content exists in a knowledge base,
|
2036
|
+
# this value is unset.
|
2037
|
+
# @return [Time]
|
2038
|
+
#
|
2039
|
+
# @!attribute [rw] name
|
2040
|
+
# The name of the knowledge base.
|
2041
|
+
# @return [String]
|
2042
|
+
#
|
2043
|
+
# @!attribute [rw] rendering_configuration
|
2044
|
+
# Information about how to render the content.
|
2045
|
+
# @return [Types::RenderingConfiguration]
|
2046
|
+
#
|
2047
|
+
# @!attribute [rw] server_side_encryption_configuration
|
2048
|
+
# The configuration information for the customer managed key used for
|
2049
|
+
# encryption.
|
2050
|
+
#
|
2051
|
+
# This KMS key must have a policy that allows `kms:CreateGrant`,
|
2052
|
+
# `kms:DescribeKey`, `kms:Decrypt`, and `kms:GenerateDataKey*`
|
2053
|
+
# permissions to the IAM identity using the key to invoke Amazon Q.
|
2054
|
+
#
|
2055
|
+
# For more information about setting up a customer managed key for
|
2056
|
+
# Amazon Q, see [Enable Amazon Q in Connect for your instance][1].
|
2057
|
+
#
|
2058
|
+
#
|
2059
|
+
#
|
2060
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/enable-q.html
|
2061
|
+
# @return [Types::ServerSideEncryptionConfiguration]
|
2062
|
+
#
|
2063
|
+
# @!attribute [rw] source_configuration
|
2064
|
+
# Source configuration information about the knowledge base.
|
2065
|
+
# @return [Types::SourceConfiguration]
|
2066
|
+
#
|
2067
|
+
# @!attribute [rw] status
|
2068
|
+
# The status of the knowledge base.
|
2069
|
+
# @return [String]
|
2070
|
+
#
|
2071
|
+
# @!attribute [rw] tags
|
2072
|
+
# The tags used to organize, track, or control access for this
|
2073
|
+
# resource.
|
2074
|
+
# @return [Hash<String,String>]
|
2075
|
+
#
|
2076
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/KnowledgeBaseData AWS API Documentation
|
2077
|
+
#
|
2078
|
+
class KnowledgeBaseData < Struct.new(
|
2079
|
+
:description,
|
2080
|
+
:knowledge_base_arn,
|
2081
|
+
:knowledge_base_id,
|
2082
|
+
:knowledge_base_type,
|
2083
|
+
:last_content_modification_time,
|
2084
|
+
:name,
|
2085
|
+
:rendering_configuration,
|
2086
|
+
:server_side_encryption_configuration,
|
2087
|
+
:source_configuration,
|
2088
|
+
:status,
|
2089
|
+
:tags)
|
2090
|
+
SENSITIVE = []
|
2091
|
+
include Aws::Structure
|
2092
|
+
end
|
2093
|
+
|
2094
|
+
# Summary information about the knowledge base.
|
2095
|
+
#
|
2096
|
+
# @!attribute [rw] description
|
2097
|
+
# The description of the knowledge base.
|
2098
|
+
# @return [String]
|
2099
|
+
#
|
2100
|
+
# @!attribute [rw] knowledge_base_arn
|
2101
|
+
# The Amazon Resource Name (ARN) of the knowledge base.
|
2102
|
+
# @return [String]
|
2103
|
+
#
|
2104
|
+
# @!attribute [rw] knowledge_base_id
|
2105
|
+
# The identifier of the knowledge base. This should not be a
|
2106
|
+
# QUICK\_RESPONSES type knowledge base if you're storing Amazon Q
|
2107
|
+
# Content resource to it.
|
2108
|
+
# @return [String]
|
2109
|
+
#
|
2110
|
+
# @!attribute [rw] knowledge_base_type
|
2111
|
+
# The type of knowledge base.
|
2112
|
+
# @return [String]
|
2113
|
+
#
|
2114
|
+
# @!attribute [rw] name
|
2115
|
+
# The name of the knowledge base.
|
2116
|
+
# @return [String]
|
2117
|
+
#
|
2118
|
+
# @!attribute [rw] rendering_configuration
|
2119
|
+
# Information about how to render the content.
|
2120
|
+
# @return [Types::RenderingConfiguration]
|
2121
|
+
#
|
2122
|
+
# @!attribute [rw] server_side_encryption_configuration
|
2123
|
+
# The configuration information for the customer managed key used for
|
2124
|
+
# encryption.
|
2125
|
+
#
|
2126
|
+
# This KMS key must have a policy that allows `kms:CreateGrant`,
|
2127
|
+
# `kms:DescribeKey`, `kms:Decrypt`, and `kms:GenerateDataKey*`
|
2128
|
+
# permissions to the IAM identity using the key to invoke Amazon Q.
|
2129
|
+
#
|
2130
|
+
# For more information about setting up a customer managed key for
|
2131
|
+
# Amazon Q, see [Enable Amazon Q in Connect for your instance][1].
|
2132
|
+
#
|
2133
|
+
#
|
2134
|
+
#
|
2135
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/enable-q.html
|
2136
|
+
# @return [Types::ServerSideEncryptionConfiguration]
|
2137
|
+
#
|
2138
|
+
# @!attribute [rw] source_configuration
|
2139
|
+
# Configuration information about the external data source.
|
2140
|
+
# @return [Types::SourceConfiguration]
|
2141
|
+
#
|
2142
|
+
# @!attribute [rw] status
|
2143
|
+
# The status of the knowledge base summary.
|
2144
|
+
# @return [String]
|
2145
|
+
#
|
2146
|
+
# @!attribute [rw] tags
|
2147
|
+
# The tags used to organize, track, or control access for this
|
2148
|
+
# resource.
|
2149
|
+
# @return [Hash<String,String>]
|
2150
|
+
#
|
2151
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/KnowledgeBaseSummary AWS API Documentation
|
2152
|
+
#
|
2153
|
+
class KnowledgeBaseSummary < Struct.new(
|
2154
|
+
:description,
|
2155
|
+
:knowledge_base_arn,
|
2156
|
+
:knowledge_base_id,
|
2157
|
+
:knowledge_base_type,
|
2158
|
+
:name,
|
2159
|
+
:rendering_configuration,
|
2160
|
+
:server_side_encryption_configuration,
|
2161
|
+
:source_configuration,
|
2162
|
+
:status,
|
2163
|
+
:tags)
|
2164
|
+
SENSITIVE = []
|
2165
|
+
include Aws::Structure
|
2166
|
+
end
|
2167
|
+
|
2168
|
+
# @!attribute [rw] assistant_id
|
2169
|
+
# The identifier of the Amazon Q assistant. Can be either the ID or
|
2170
|
+
# the ARN. URLs cannot contain the ARN.
|
2171
|
+
# @return [String]
|
2172
|
+
#
|
2173
|
+
# @!attribute [rw] max_results
|
2174
|
+
# The maximum number of results to return per page.
|
2175
|
+
# @return [Integer]
|
2176
|
+
#
|
2177
|
+
# @!attribute [rw] next_token
|
2178
|
+
# The token for the next set of results. Use the value returned in the
|
2179
|
+
# previous response in the next request to retrieve the next set of
|
2180
|
+
# results.
|
2181
|
+
# @return [String]
|
2182
|
+
#
|
2183
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ListAssistantAssociationsRequest AWS API Documentation
|
2184
|
+
#
|
2185
|
+
class ListAssistantAssociationsRequest < Struct.new(
|
2186
|
+
:assistant_id,
|
2187
|
+
:max_results,
|
2188
|
+
:next_token)
|
2189
|
+
SENSITIVE = []
|
2190
|
+
include Aws::Structure
|
2191
|
+
end
|
2192
|
+
|
2193
|
+
# @!attribute [rw] assistant_association_summaries
|
2194
|
+
# Summary information about assistant associations.
|
2195
|
+
# @return [Array<Types::AssistantAssociationSummary>]
|
2196
|
+
#
|
2197
|
+
# @!attribute [rw] next_token
|
2198
|
+
# If there are additional results, this is the token for the next set
|
2199
|
+
# of results.
|
2200
|
+
# @return [String]
|
2201
|
+
#
|
2202
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ListAssistantAssociationsResponse AWS API Documentation
|
2203
|
+
#
|
2204
|
+
class ListAssistantAssociationsResponse < Struct.new(
|
2205
|
+
:assistant_association_summaries,
|
2206
|
+
:next_token)
|
2207
|
+
SENSITIVE = []
|
2208
|
+
include Aws::Structure
|
2209
|
+
end
|
2210
|
+
|
2211
|
+
# @!attribute [rw] max_results
|
2212
|
+
# The maximum number of results to return per page.
|
2213
|
+
# @return [Integer]
|
2214
|
+
#
|
2215
|
+
# @!attribute [rw] next_token
|
2216
|
+
# The token for the next set of results. Use the value returned in the
|
2217
|
+
# previous response in the next request to retrieve the next set of
|
2218
|
+
# results.
|
2219
|
+
# @return [String]
|
2220
|
+
#
|
2221
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ListAssistantsRequest AWS API Documentation
|
2222
|
+
#
|
2223
|
+
class ListAssistantsRequest < Struct.new(
|
2224
|
+
:max_results,
|
2225
|
+
:next_token)
|
2226
|
+
SENSITIVE = []
|
2227
|
+
include Aws::Structure
|
2228
|
+
end
|
2229
|
+
|
2230
|
+
# @!attribute [rw] assistant_summaries
|
2231
|
+
# Information about the assistants.
|
2232
|
+
# @return [Array<Types::AssistantSummary>]
|
2233
|
+
#
|
2234
|
+
# @!attribute [rw] next_token
|
2235
|
+
# If there are additional results, this is the token for the next set
|
2236
|
+
# of results.
|
2237
|
+
# @return [String]
|
2238
|
+
#
|
2239
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ListAssistantsResponse AWS API Documentation
|
2240
|
+
#
|
2241
|
+
class ListAssistantsResponse < Struct.new(
|
2242
|
+
:assistant_summaries,
|
2243
|
+
:next_token)
|
2244
|
+
SENSITIVE = []
|
2245
|
+
include Aws::Structure
|
2246
|
+
end
|
2247
|
+
|
2248
|
+
# @!attribute [rw] knowledge_base_id
|
2249
|
+
# The identifier of the knowledge base. This should not be a
|
2250
|
+
# QUICK\_RESPONSES type knowledge base if you're storing Amazon Q
|
2251
|
+
# Content resource to it. Can be either the ID or the ARN. URLs cannot
|
2252
|
+
# contain the ARN.
|
2253
|
+
# @return [String]
|
2254
|
+
#
|
2255
|
+
# @!attribute [rw] max_results
|
2256
|
+
# The maximum number of results to return per page.
|
2257
|
+
# @return [Integer]
|
2258
|
+
#
|
2259
|
+
# @!attribute [rw] next_token
|
2260
|
+
# The token for the next set of results. Use the value returned in the
|
2261
|
+
# previous response in the next request to retrieve the next set of
|
2262
|
+
# results.
|
2263
|
+
# @return [String]
|
2264
|
+
#
|
2265
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ListContentsRequest AWS API Documentation
|
2266
|
+
#
|
2267
|
+
class ListContentsRequest < Struct.new(
|
2268
|
+
:knowledge_base_id,
|
2269
|
+
:max_results,
|
2270
|
+
:next_token)
|
2271
|
+
SENSITIVE = []
|
2272
|
+
include Aws::Structure
|
2273
|
+
end
|
2274
|
+
|
2275
|
+
# @!attribute [rw] content_summaries
|
2276
|
+
# Information about the content.
|
2277
|
+
# @return [Array<Types::ContentSummary>]
|
2278
|
+
#
|
2279
|
+
# @!attribute [rw] next_token
|
2280
|
+
# If there are additional results, this is the token for the next set
|
2281
|
+
# of results.
|
2282
|
+
# @return [String]
|
2283
|
+
#
|
2284
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ListContentsResponse AWS API Documentation
|
2285
|
+
#
|
2286
|
+
class ListContentsResponse < Struct.new(
|
2287
|
+
:content_summaries,
|
2288
|
+
:next_token)
|
2289
|
+
SENSITIVE = []
|
2290
|
+
include Aws::Structure
|
2291
|
+
end
|
2292
|
+
|
2293
|
+
# @!attribute [rw] knowledge_base_id
|
2294
|
+
# The identifier of the knowledge base. This should not be a
|
2295
|
+
# QUICK\_RESPONSES type knowledge base if you're storing Amazon Q
|
2296
|
+
# Content resource to it. Can be either the ID or the ARN. URLs cannot
|
2297
|
+
# contain the ARN.
|
2298
|
+
# @return [String]
|
2299
|
+
#
|
2300
|
+
# @!attribute [rw] max_results
|
2301
|
+
# The maximum number of results to return per page.
|
2302
|
+
# @return [Integer]
|
2303
|
+
#
|
2304
|
+
# @!attribute [rw] next_token
|
2305
|
+
# The token for the next set of results. Use the value returned in the
|
2306
|
+
# previous response in the next request to retrieve the next set of
|
2307
|
+
# results.
|
2308
|
+
# @return [String]
|
2309
|
+
#
|
2310
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ListImportJobsRequest AWS API Documentation
|
2311
|
+
#
|
2312
|
+
class ListImportJobsRequest < Struct.new(
|
2313
|
+
:knowledge_base_id,
|
2314
|
+
:max_results,
|
2315
|
+
:next_token)
|
2316
|
+
SENSITIVE = []
|
2317
|
+
include Aws::Structure
|
2318
|
+
end
|
2319
|
+
|
2320
|
+
# @!attribute [rw] import_job_summaries
|
2321
|
+
# Summary information about the import jobs.
|
2322
|
+
# @return [Array<Types::ImportJobSummary>]
|
2323
|
+
#
|
2324
|
+
# @!attribute [rw] next_token
|
2325
|
+
# The token for the next set of results. Use the value returned in the
|
2326
|
+
# previous response in the next request to retrieve the next set of
|
2327
|
+
# results.
|
2328
|
+
# @return [String]
|
2329
|
+
#
|
2330
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ListImportJobsResponse AWS API Documentation
|
2331
|
+
#
|
2332
|
+
class ListImportJobsResponse < Struct.new(
|
2333
|
+
:import_job_summaries,
|
2334
|
+
:next_token)
|
2335
|
+
SENSITIVE = []
|
2336
|
+
include Aws::Structure
|
2337
|
+
end
|
2338
|
+
|
2339
|
+
# @!attribute [rw] max_results
|
2340
|
+
# The maximum number of results to return per page.
|
2341
|
+
# @return [Integer]
|
2342
|
+
#
|
2343
|
+
# @!attribute [rw] next_token
|
2344
|
+
# The token for the next set of results. Use the value returned in the
|
2345
|
+
# previous response in the next request to retrieve the next set of
|
2346
|
+
# results.
|
2347
|
+
# @return [String]
|
2348
|
+
#
|
2349
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ListKnowledgeBasesRequest AWS API Documentation
|
2350
|
+
#
|
2351
|
+
class ListKnowledgeBasesRequest < Struct.new(
|
2352
|
+
:max_results,
|
2353
|
+
:next_token)
|
2354
|
+
SENSITIVE = []
|
2355
|
+
include Aws::Structure
|
2356
|
+
end
|
2357
|
+
|
2358
|
+
# @!attribute [rw] knowledge_base_summaries
|
2359
|
+
# Information about the knowledge bases.
|
2360
|
+
# @return [Array<Types::KnowledgeBaseSummary>]
|
2361
|
+
#
|
2362
|
+
# @!attribute [rw] next_token
|
2363
|
+
# If there are additional results, this is the token for the next set
|
2364
|
+
# of results.
|
2365
|
+
# @return [String]
|
2366
|
+
#
|
2367
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ListKnowledgeBasesResponse AWS API Documentation
|
2368
|
+
#
|
2369
|
+
class ListKnowledgeBasesResponse < Struct.new(
|
2370
|
+
:knowledge_base_summaries,
|
2371
|
+
:next_token)
|
2372
|
+
SENSITIVE = []
|
2373
|
+
include Aws::Structure
|
2374
|
+
end
|
2375
|
+
|
2376
|
+
# @!attribute [rw] knowledge_base_id
|
2377
|
+
# The identifier of the knowledge base. This should not be a
|
2378
|
+
# QUICK\_RESPONSES type knowledge base if you're storing Amazon Q
|
2379
|
+
# Content resource to it. Can be either the ID or the ARN. URLs cannot
|
2380
|
+
# contain the ARN.
|
2381
|
+
# @return [String]
|
2382
|
+
#
|
2383
|
+
# @!attribute [rw] max_results
|
2384
|
+
# The maximum number of results to return per page.
|
2385
|
+
# @return [Integer]
|
2386
|
+
#
|
2387
|
+
# @!attribute [rw] next_token
|
2388
|
+
# The token for the next set of results. Use the value returned in the
|
2389
|
+
# previous response in the next request to retrieve the next set of
|
2390
|
+
# results.
|
2391
|
+
# @return [String]
|
2392
|
+
#
|
2393
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ListQuickResponsesRequest AWS API Documentation
|
2394
|
+
#
|
2395
|
+
class ListQuickResponsesRequest < Struct.new(
|
2396
|
+
:knowledge_base_id,
|
2397
|
+
:max_results,
|
2398
|
+
:next_token)
|
2399
|
+
SENSITIVE = []
|
2400
|
+
include Aws::Structure
|
2401
|
+
end
|
2402
|
+
|
2403
|
+
# @!attribute [rw] next_token
|
2404
|
+
# The token for the next set of results. Use the value returned in the
|
2405
|
+
# previous response in the next request to retrieve the next set of
|
2406
|
+
# results.
|
2407
|
+
# @return [String]
|
2408
|
+
#
|
2409
|
+
# @!attribute [rw] quick_response_summaries
|
2410
|
+
# Summary information about the quick responses.
|
2411
|
+
# @return [Array<Types::QuickResponseSummary>]
|
2412
|
+
#
|
2413
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ListQuickResponsesResponse AWS API Documentation
|
2414
|
+
#
|
2415
|
+
class ListQuickResponsesResponse < Struct.new(
|
2416
|
+
:next_token,
|
2417
|
+
:quick_response_summaries)
|
2418
|
+
SENSITIVE = []
|
2419
|
+
include Aws::Structure
|
2420
|
+
end
|
2421
|
+
|
2422
|
+
# @!attribute [rw] resource_arn
|
2423
|
+
# The Amazon Resource Name (ARN) of the resource.
|
2424
|
+
# @return [String]
|
2425
|
+
#
|
2426
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ListTagsForResourceRequest AWS API Documentation
|
2427
|
+
#
|
2428
|
+
class ListTagsForResourceRequest < Struct.new(
|
2429
|
+
:resource_arn)
|
2430
|
+
SENSITIVE = []
|
2431
|
+
include Aws::Structure
|
2432
|
+
end
|
2433
|
+
|
2434
|
+
# @!attribute [rw] tags
|
2435
|
+
# The tags used to organize, track, or control access for this
|
2436
|
+
# resource.
|
2437
|
+
# @return [Hash<String,String>]
|
2438
|
+
#
|
2439
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ListTagsForResourceResponse AWS API Documentation
|
2440
|
+
#
|
2441
|
+
class ListTagsForResourceResponse < Struct.new(
|
2442
|
+
:tags)
|
2443
|
+
SENSITIVE = []
|
2444
|
+
include Aws::Structure
|
2445
|
+
end
|
2446
|
+
|
2447
|
+
# An error occurred when creating a recommendation.
|
2448
|
+
#
|
2449
|
+
# @!attribute [rw] message
|
2450
|
+
# A recommendation is causing an error.
|
2451
|
+
# @return [String]
|
2452
|
+
#
|
2453
|
+
# @!attribute [rw] recommendation_id
|
2454
|
+
# The identifier of the recommendation that is in error.
|
2455
|
+
# @return [String]
|
2456
|
+
#
|
2457
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/NotifyRecommendationsReceivedError AWS API Documentation
|
2458
|
+
#
|
2459
|
+
class NotifyRecommendationsReceivedError < Struct.new(
|
2460
|
+
:message,
|
2461
|
+
:recommendation_id)
|
2462
|
+
SENSITIVE = []
|
2463
|
+
include Aws::Structure
|
2464
|
+
end
|
2465
|
+
|
2466
|
+
# @!attribute [rw] assistant_id
|
2467
|
+
# The identifier of the Amazon Q assistant. Can be either the ID or
|
2468
|
+
# the ARN. URLs cannot contain the ARN.
|
2469
|
+
# @return [String]
|
2470
|
+
#
|
2471
|
+
# @!attribute [rw] recommendation_ids
|
2472
|
+
# The identifiers of the recommendations.
|
2473
|
+
# @return [Array<String>]
|
2474
|
+
#
|
2475
|
+
# @!attribute [rw] session_id
|
2476
|
+
# The identifier of the session. Can be either the ID or the ARN. URLs
|
2477
|
+
# cannot contain the ARN.
|
2478
|
+
# @return [String]
|
2479
|
+
#
|
2480
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/NotifyRecommendationsReceivedRequest AWS API Documentation
|
2481
|
+
#
|
2482
|
+
class NotifyRecommendationsReceivedRequest < Struct.new(
|
2483
|
+
:assistant_id,
|
2484
|
+
:recommendation_ids,
|
2485
|
+
:session_id)
|
2486
|
+
SENSITIVE = []
|
2487
|
+
include Aws::Structure
|
2488
|
+
end
|
2489
|
+
|
2490
|
+
# @!attribute [rw] errors
|
2491
|
+
# The identifiers of recommendations that are causing errors.
|
2492
|
+
# @return [Array<Types::NotifyRecommendationsReceivedError>]
|
2493
|
+
#
|
2494
|
+
# @!attribute [rw] recommendation_ids
|
2495
|
+
# The identifiers of the recommendations.
|
2496
|
+
# @return [Array<String>]
|
2497
|
+
#
|
2498
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/NotifyRecommendationsReceivedResponse AWS API Documentation
|
2499
|
+
#
|
2500
|
+
class NotifyRecommendationsReceivedResponse < Struct.new(
|
2501
|
+
:errors,
|
2502
|
+
:recommendation_ids)
|
2503
|
+
SENSITIVE = []
|
2504
|
+
include Aws::Structure
|
2505
|
+
end
|
2506
|
+
|
2507
|
+
# The provided `revisionId` does not match, indicating the content has
|
2508
|
+
# been modified since it was last read.
|
2509
|
+
#
|
2510
|
+
# @!attribute [rw] message
|
2511
|
+
# @return [String]
|
2512
|
+
#
|
2513
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/PreconditionFailedException AWS API Documentation
|
2514
|
+
#
|
2515
|
+
class PreconditionFailedException < Struct.new(
|
2516
|
+
:message)
|
2517
|
+
SENSITIVE = []
|
2518
|
+
include Aws::Structure
|
2519
|
+
end
|
2520
|
+
|
2521
|
+
# @!attribute [rw] assistant_id
|
2522
|
+
# The identifier of the Amazon Q assistant. Can be either the ID or
|
2523
|
+
# the ARN. URLs cannot contain the ARN.
|
2524
|
+
# @return [String]
|
2525
|
+
#
|
2526
|
+
# @!attribute [rw] max_results
|
2527
|
+
# The maximum number of results to return per page.
|
2528
|
+
# @return [Integer]
|
2529
|
+
#
|
2530
|
+
# @!attribute [rw] next_token
|
2531
|
+
# The token for the next set of results. Use the value returned in the
|
2532
|
+
# previous response in the next request to retrieve the next set of
|
2533
|
+
# results.
|
2534
|
+
# @return [String]
|
2535
|
+
#
|
2536
|
+
# @!attribute [rw] query_condition
|
2537
|
+
# Information about how to query content.
|
2538
|
+
# @return [Array<Types::QueryCondition>]
|
2539
|
+
#
|
2540
|
+
# @!attribute [rw] query_text
|
2541
|
+
# The text to search for.
|
2542
|
+
# @return [String]
|
2543
|
+
#
|
2544
|
+
# @!attribute [rw] session_id
|
2545
|
+
# The identifier of the Amazon Q session. Can be either the ID or the
|
2546
|
+
# ARN. URLs cannot contain the ARN.
|
2547
|
+
# @return [String]
|
2548
|
+
#
|
2549
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/QueryAssistantRequest AWS API Documentation
|
2550
|
+
#
|
2551
|
+
class QueryAssistantRequest < Struct.new(
|
2552
|
+
:assistant_id,
|
2553
|
+
:max_results,
|
2554
|
+
:next_token,
|
2555
|
+
:query_condition,
|
2556
|
+
:query_text,
|
2557
|
+
:session_id)
|
2558
|
+
SENSITIVE = [:query_text]
|
2559
|
+
include Aws::Structure
|
2560
|
+
end
|
2561
|
+
|
2562
|
+
# @!attribute [rw] next_token
|
2563
|
+
# If there are additional results, this is the token for the next set
|
2564
|
+
# of results.
|
2565
|
+
# @return [String]
|
2566
|
+
#
|
2567
|
+
# @!attribute [rw] results
|
2568
|
+
# The results of the query.
|
2569
|
+
# @return [Array<Types::ResultData>]
|
2570
|
+
#
|
2571
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/QueryAssistantResponse AWS API Documentation
|
2572
|
+
#
|
2573
|
+
class QueryAssistantResponse < Struct.new(
|
2574
|
+
:next_token,
|
2575
|
+
:results)
|
2576
|
+
SENSITIVE = []
|
2577
|
+
include Aws::Structure
|
2578
|
+
end
|
2579
|
+
|
2580
|
+
# Information about how to query content.
|
2581
|
+
#
|
2582
|
+
# @note QueryCondition is a union - when making an API calls you must set exactly one of the members.
|
2583
|
+
#
|
2584
|
+
# @!attribute [rw] single
|
2585
|
+
# The condition for the query.
|
2586
|
+
# @return [Types::QueryConditionItem]
|
2587
|
+
#
|
2588
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/QueryCondition AWS API Documentation
|
2589
|
+
#
|
2590
|
+
class QueryCondition < Struct.new(
|
2591
|
+
:single,
|
2592
|
+
:unknown)
|
2593
|
+
SENSITIVE = []
|
2594
|
+
include Aws::Structure
|
2595
|
+
include Aws::Structure::Union
|
2596
|
+
|
2597
|
+
class Single < QueryCondition; end
|
2598
|
+
class Unknown < QueryCondition; end
|
2599
|
+
end
|
2600
|
+
|
2601
|
+
# The condition for the query.
|
2602
|
+
#
|
2603
|
+
# @!attribute [rw] comparator
|
2604
|
+
# The comparison operator for query condition to query on.
|
2605
|
+
# @return [String]
|
2606
|
+
#
|
2607
|
+
# @!attribute [rw] field
|
2608
|
+
# The name of the field for query condition to query on.
|
2609
|
+
# @return [String]
|
2610
|
+
#
|
2611
|
+
# @!attribute [rw] value
|
2612
|
+
# The value for the query condition to query on.
|
2613
|
+
# @return [String]
|
2614
|
+
#
|
2615
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/QueryConditionItem AWS API Documentation
|
2616
|
+
#
|
2617
|
+
class QueryConditionItem < Struct.new(
|
2618
|
+
:comparator,
|
2619
|
+
:field,
|
2620
|
+
:value)
|
2621
|
+
SENSITIVE = []
|
2622
|
+
include Aws::Structure
|
2623
|
+
end
|
2624
|
+
|
2625
|
+
# Data associated with the QUERY RecommendationTriggerType.
|
2626
|
+
#
|
2627
|
+
# @!attribute [rw] text
|
2628
|
+
# The text associated with the recommendation trigger.
|
2629
|
+
# @return [String]
|
2630
|
+
#
|
2631
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/QueryRecommendationTriggerData AWS API Documentation
|
2632
|
+
#
|
2633
|
+
class QueryRecommendationTriggerData < Struct.new(
|
2634
|
+
:text)
|
2635
|
+
SENSITIVE = [:text]
|
2636
|
+
include Aws::Structure
|
2637
|
+
end
|
2638
|
+
|
2639
|
+
# The container quick response content.
|
2640
|
+
#
|
2641
|
+
# @note QuickResponseContentProvider is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of QuickResponseContentProvider corresponding to the set member.
|
2642
|
+
#
|
2643
|
+
# @!attribute [rw] content
|
2644
|
+
# The content of the quick response.
|
2645
|
+
# @return [String]
|
2646
|
+
#
|
2647
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/QuickResponseContentProvider AWS API Documentation
|
2648
|
+
#
|
2649
|
+
class QuickResponseContentProvider < Struct.new(
|
2650
|
+
:content,
|
2651
|
+
:unknown)
|
2652
|
+
SENSITIVE = [:content]
|
2653
|
+
include Aws::Structure
|
2654
|
+
include Aws::Structure::Union
|
2655
|
+
|
2656
|
+
class Content < QuickResponseContentProvider; end
|
2657
|
+
class Unknown < QuickResponseContentProvider; end
|
2658
|
+
end
|
2659
|
+
|
2660
|
+
# The content of the quick response stored in different media types.
|
2661
|
+
#
|
2662
|
+
# @!attribute [rw] markdown
|
2663
|
+
# The container quick response content.
|
2664
|
+
# @return [Types::QuickResponseContentProvider]
|
2665
|
+
#
|
2666
|
+
# @!attribute [rw] plain_text
|
2667
|
+
# The container quick response content.
|
2668
|
+
# @return [Types::QuickResponseContentProvider]
|
2669
|
+
#
|
2670
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/QuickResponseContents AWS API Documentation
|
2671
|
+
#
|
2672
|
+
class QuickResponseContents < Struct.new(
|
2673
|
+
:markdown,
|
2674
|
+
:plain_text)
|
2675
|
+
SENSITIVE = []
|
2676
|
+
include Aws::Structure
|
2677
|
+
end
|
2678
|
+
|
2679
|
+
# Information about the quick response.
|
2680
|
+
#
|
2681
|
+
# @!attribute [rw] channels
|
2682
|
+
# The Amazon Connect contact channels this quick response applies to.
|
2683
|
+
# The supported contact channel types include `Chat`.
|
2684
|
+
# @return [Array<String>]
|
2685
|
+
#
|
2686
|
+
# @!attribute [rw] content_type
|
2687
|
+
# The media type of the quick response content.
|
2688
|
+
#
|
2689
|
+
# * Use `application/x.quickresponse;format=plain` for quick response
|
2690
|
+
# written in plain text.
|
2691
|
+
#
|
2692
|
+
# * Use `application/x.quickresponse;format=markdown` for quick
|
2693
|
+
# response written in richtext.
|
2694
|
+
# @return [String]
|
2695
|
+
#
|
2696
|
+
# @!attribute [rw] contents
|
2697
|
+
# The contents of the quick response.
|
2698
|
+
# @return [Types::QuickResponseContents]
|
2699
|
+
#
|
2700
|
+
# @!attribute [rw] created_time
|
2701
|
+
# The timestamp when the quick response was created.
|
2702
|
+
# @return [Time]
|
2703
|
+
#
|
2704
|
+
# @!attribute [rw] description
|
2705
|
+
# The description of the quick response.
|
2706
|
+
# @return [String]
|
2707
|
+
#
|
2708
|
+
# @!attribute [rw] grouping_configuration
|
2709
|
+
# The configuration information of the user groups that the quick
|
2710
|
+
# response is accessible to.
|
2711
|
+
# @return [Types::GroupingConfiguration]
|
2712
|
+
#
|
2713
|
+
# @!attribute [rw] is_active
|
2714
|
+
# Whether the quick response is active.
|
2715
|
+
# @return [Boolean]
|
2716
|
+
#
|
2717
|
+
# @!attribute [rw] knowledge_base_arn
|
2718
|
+
# The Amazon Resource Name (ARN) of the knowledge base.
|
2719
|
+
# @return [String]
|
2720
|
+
#
|
2721
|
+
# @!attribute [rw] knowledge_base_id
|
2722
|
+
# The identifier of the knowledge base. This should not be a
|
2723
|
+
# QUICK\_RESPONSES type knowledge base if you're storing Amazon Q
|
2724
|
+
# Content resource to it. Can be either the ID or the ARN. URLs cannot
|
2725
|
+
# contain the ARN.
|
2726
|
+
# @return [String]
|
2727
|
+
#
|
2728
|
+
# @!attribute [rw] language
|
2729
|
+
# The language code value for the language in which the quick response
|
2730
|
+
# is written.
|
2731
|
+
# @return [String]
|
2732
|
+
#
|
2733
|
+
# @!attribute [rw] last_modified_by
|
2734
|
+
# The Amazon Resource Name (ARN) of the user who last updated the
|
2735
|
+
# quick response data.
|
2736
|
+
# @return [String]
|
2737
|
+
#
|
2738
|
+
# @!attribute [rw] last_modified_time
|
2739
|
+
# The timestamp when the quick response data was last modified.
|
2740
|
+
# @return [Time]
|
2741
|
+
#
|
2742
|
+
# @!attribute [rw] name
|
2743
|
+
# The name of the quick response.
|
2744
|
+
# @return [String]
|
2745
|
+
#
|
2746
|
+
# @!attribute [rw] quick_response_arn
|
2747
|
+
# The Amazon Resource Name (ARN) of the quick response.
|
2748
|
+
# @return [String]
|
2749
|
+
#
|
2750
|
+
# @!attribute [rw] quick_response_id
|
2751
|
+
# The identifier of the quick response.
|
2752
|
+
# @return [String]
|
2753
|
+
#
|
2754
|
+
# @!attribute [rw] shortcut_key
|
2755
|
+
# The shortcut key of the quick response. The value should be unique
|
2756
|
+
# across the knowledge base.
|
2757
|
+
# @return [String]
|
2758
|
+
#
|
2759
|
+
# @!attribute [rw] status
|
2760
|
+
# The status of the quick response data.
|
2761
|
+
# @return [String]
|
2762
|
+
#
|
2763
|
+
# @!attribute [rw] tags
|
2764
|
+
# The tags used to organize, track, or control access for this
|
2765
|
+
# resource.
|
2766
|
+
# @return [Hash<String,String>]
|
2767
|
+
#
|
2768
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/QuickResponseData AWS API Documentation
|
2769
|
+
#
|
2770
|
+
class QuickResponseData < Struct.new(
|
2771
|
+
:channels,
|
2772
|
+
:content_type,
|
2773
|
+
:contents,
|
2774
|
+
:created_time,
|
2775
|
+
:description,
|
2776
|
+
:grouping_configuration,
|
2777
|
+
:is_active,
|
2778
|
+
:knowledge_base_arn,
|
2779
|
+
:knowledge_base_id,
|
2780
|
+
:language,
|
2781
|
+
:last_modified_by,
|
2782
|
+
:last_modified_time,
|
2783
|
+
:name,
|
2784
|
+
:quick_response_arn,
|
2785
|
+
:quick_response_id,
|
2786
|
+
:shortcut_key,
|
2787
|
+
:status,
|
2788
|
+
:tags)
|
2789
|
+
SENSITIVE = []
|
2790
|
+
include Aws::Structure
|
2791
|
+
end
|
2792
|
+
|
2793
|
+
# The container of quick response data.
|
2794
|
+
#
|
2795
|
+
# @note QuickResponseDataProvider is a union - when making an API calls you must set exactly one of the members.
|
2796
|
+
#
|
2797
|
+
# @!attribute [rw] content
|
2798
|
+
# The content of the quick response.
|
2799
|
+
# @return [String]
|
2800
|
+
#
|
2801
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/QuickResponseDataProvider AWS API Documentation
|
2802
|
+
#
|
2803
|
+
class QuickResponseDataProvider < Struct.new(
|
2804
|
+
:content,
|
2805
|
+
:unknown)
|
2806
|
+
SENSITIVE = [:content]
|
2807
|
+
include Aws::Structure
|
2808
|
+
include Aws::Structure::Union
|
2809
|
+
|
2810
|
+
class Content < QuickResponseDataProvider; end
|
2811
|
+
class Unknown < QuickResponseDataProvider; end
|
2812
|
+
end
|
2813
|
+
|
2814
|
+
# The quick response fields to filter the quick response query results
|
2815
|
+
# by.
|
2816
|
+
#
|
2817
|
+
# The following is the list of supported field names.
|
2818
|
+
#
|
2819
|
+
# * name
|
2820
|
+
#
|
2821
|
+
# * description
|
2822
|
+
#
|
2823
|
+
# * shortcutKey
|
2824
|
+
#
|
2825
|
+
# * isActive
|
2826
|
+
#
|
2827
|
+
# * channels
|
2828
|
+
#
|
2829
|
+
# * language
|
2830
|
+
#
|
2831
|
+
# * contentType
|
2832
|
+
#
|
2833
|
+
# * createdTime
|
2834
|
+
#
|
2835
|
+
# * lastModifiedTime
|
2836
|
+
#
|
2837
|
+
# * lastModifiedBy
|
2838
|
+
#
|
2839
|
+
# * groupingConfiguration.criteria
|
2840
|
+
#
|
2841
|
+
# * groupingConfiguration.values
|
2842
|
+
#
|
2843
|
+
# @!attribute [rw] include_no_existence
|
2844
|
+
# Whether to treat null value as a match for the attribute field.
|
2845
|
+
# @return [Boolean]
|
2846
|
+
#
|
2847
|
+
# @!attribute [rw] name
|
2848
|
+
# The name of the attribute field to filter the quick responses by.
|
2849
|
+
# @return [String]
|
2850
|
+
#
|
2851
|
+
# @!attribute [rw] operator
|
2852
|
+
# The operator to use for filtering.
|
2853
|
+
# @return [String]
|
2854
|
+
#
|
2855
|
+
# @!attribute [rw] values
|
2856
|
+
# The values of attribute field to filter the quick response by.
|
2857
|
+
# @return [Array<String>]
|
2858
|
+
#
|
2859
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/QuickResponseFilterField AWS API Documentation
|
2860
|
+
#
|
2861
|
+
class QuickResponseFilterField < Struct.new(
|
2862
|
+
:include_no_existence,
|
2863
|
+
:name,
|
2864
|
+
:operator,
|
2865
|
+
:values)
|
2866
|
+
SENSITIVE = []
|
2867
|
+
include Aws::Structure
|
2868
|
+
end
|
2869
|
+
|
2870
|
+
# The quick response fields to order the quick response query results
|
2871
|
+
# by.
|
2872
|
+
#
|
2873
|
+
# The following is the list of supported field names.
|
2874
|
+
#
|
2875
|
+
# * name
|
2876
|
+
#
|
2877
|
+
# * description
|
2878
|
+
#
|
2879
|
+
# * shortcutKey
|
2880
|
+
#
|
2881
|
+
# * isActive
|
2882
|
+
#
|
2883
|
+
# * channels
|
2884
|
+
#
|
2885
|
+
# * language
|
2886
|
+
#
|
2887
|
+
# * contentType
|
2888
|
+
#
|
2889
|
+
# * createdTime
|
2890
|
+
#
|
2891
|
+
# * lastModifiedTime
|
2892
|
+
#
|
2893
|
+
# * lastModifiedBy
|
2894
|
+
#
|
2895
|
+
# * groupingConfiguration.criteria
|
2896
|
+
#
|
2897
|
+
# * groupingConfiguration.values
|
2898
|
+
#
|
2899
|
+
# @!attribute [rw] name
|
2900
|
+
# The name of the attribute to order the quick response query results
|
2901
|
+
# by.
|
2902
|
+
# @return [String]
|
2903
|
+
#
|
2904
|
+
# @!attribute [rw] order
|
2905
|
+
# The order at which the quick responses are sorted by.
|
2906
|
+
# @return [String]
|
2907
|
+
#
|
2908
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/QuickResponseOrderField AWS API Documentation
|
2909
|
+
#
|
2910
|
+
class QuickResponseOrderField < Struct.new(
|
2911
|
+
:name,
|
2912
|
+
:order)
|
2913
|
+
SENSITIVE = []
|
2914
|
+
include Aws::Structure
|
2915
|
+
end
|
2916
|
+
|
2917
|
+
# The quick response fields to query quick responses by.
|
2918
|
+
#
|
2919
|
+
# The following is the list of supported field names.
|
2920
|
+
#
|
2921
|
+
# * content
|
2922
|
+
#
|
2923
|
+
# * name
|
2924
|
+
#
|
2925
|
+
# * description
|
2926
|
+
#
|
2927
|
+
# * shortcutKey
|
2928
|
+
#
|
2929
|
+
# @!attribute [rw] allow_fuzziness
|
2930
|
+
# Whether the query expects only exact matches on the attribute field
|
2931
|
+
# values. The results of the query will only include exact matches if
|
2932
|
+
# this parameter is set to false.
|
2933
|
+
# @return [Boolean]
|
2934
|
+
#
|
2935
|
+
# @!attribute [rw] name
|
2936
|
+
# The name of the attribute to query the quick responses by.
|
2937
|
+
# @return [String]
|
2938
|
+
#
|
2939
|
+
# @!attribute [rw] operator
|
2940
|
+
# The operator to use for matching attribute field values in the
|
2941
|
+
# query.
|
2942
|
+
# @return [String]
|
2943
|
+
#
|
2944
|
+
# @!attribute [rw] priority
|
2945
|
+
# The importance of the attribute field when calculating query result
|
2946
|
+
# relevancy scores. The value set for this parameter affects the
|
2947
|
+
# ordering of search results.
|
2948
|
+
# @return [String]
|
2949
|
+
#
|
2950
|
+
# @!attribute [rw] values
|
2951
|
+
# The values of the attribute to query the quick responses by.
|
2952
|
+
# @return [Array<String>]
|
2953
|
+
#
|
2954
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/QuickResponseQueryField AWS API Documentation
|
2955
|
+
#
|
2956
|
+
class QuickResponseQueryField < Struct.new(
|
2957
|
+
:allow_fuzziness,
|
2958
|
+
:name,
|
2959
|
+
:operator,
|
2960
|
+
:priority,
|
2961
|
+
:values)
|
2962
|
+
SENSITIVE = []
|
2963
|
+
include Aws::Structure
|
2964
|
+
end
|
2965
|
+
|
2966
|
+
# Information about the import job.
|
2967
|
+
#
|
2968
|
+
# @!attribute [rw] filters
|
2969
|
+
# The configuration of filtering rules applied to quick response query
|
2970
|
+
# results.
|
2971
|
+
# @return [Array<Types::QuickResponseFilterField>]
|
2972
|
+
#
|
2973
|
+
# @!attribute [rw] order_on_field
|
2974
|
+
# The quick response attribute fields on which the query results are
|
2975
|
+
# ordered.
|
2976
|
+
# @return [Types::QuickResponseOrderField]
|
2977
|
+
#
|
2978
|
+
# @!attribute [rw] queries
|
2979
|
+
# The quick response query expressions.
|
2980
|
+
# @return [Array<Types::QuickResponseQueryField>]
|
2981
|
+
#
|
2982
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/QuickResponseSearchExpression AWS API Documentation
|
2983
|
+
#
|
2984
|
+
class QuickResponseSearchExpression < Struct.new(
|
2985
|
+
:filters,
|
2986
|
+
:order_on_field,
|
2987
|
+
:queries)
|
2988
|
+
SENSITIVE = []
|
2989
|
+
include Aws::Structure
|
2990
|
+
end
|
2991
|
+
|
2992
|
+
# The result of quick response search.
|
2993
|
+
#
|
2994
|
+
# @!attribute [rw] attributes_interpolated
|
2995
|
+
# The user defined contact attributes that are resolved when the
|
2996
|
+
# search result is returned.
|
2997
|
+
# @return [Array<String>]
|
2998
|
+
#
|
2999
|
+
# @!attribute [rw] attributes_not_interpolated
|
3000
|
+
# The user defined contact attributes that are not resolved when the
|
3001
|
+
# search result is returned.
|
3002
|
+
# @return [Array<String>]
|
3003
|
+
#
|
3004
|
+
# @!attribute [rw] channels
|
3005
|
+
# The Amazon Connect contact channels this quick response applies to.
|
3006
|
+
# The supported contact channel types include `Chat`.
|
3007
|
+
# @return [Array<String>]
|
3008
|
+
#
|
3009
|
+
# @!attribute [rw] content_type
|
3010
|
+
# The media type of the quick response content.
|
3011
|
+
#
|
3012
|
+
# * Use `application/x.quickresponse;format=plain` for quick response
|
3013
|
+
# written in plain text.
|
3014
|
+
#
|
3015
|
+
# * Use `application/x.quickresponse;format=markdown` for quick
|
3016
|
+
# response written in richtext.
|
3017
|
+
# @return [String]
|
3018
|
+
#
|
3019
|
+
# @!attribute [rw] contents
|
3020
|
+
# The contents of the quick response.
|
3021
|
+
# @return [Types::QuickResponseContents]
|
3022
|
+
#
|
3023
|
+
# @!attribute [rw] created_time
|
3024
|
+
# The timestamp when the quick response was created.
|
3025
|
+
# @return [Time]
|
3026
|
+
#
|
3027
|
+
# @!attribute [rw] description
|
3028
|
+
# The description of the quick response.
|
3029
|
+
# @return [String]
|
3030
|
+
#
|
3031
|
+
# @!attribute [rw] grouping_configuration
|
3032
|
+
# The configuration information of the user groups that the quick
|
3033
|
+
# response is accessible to.
|
3034
|
+
# @return [Types::GroupingConfiguration]
|
3035
|
+
#
|
3036
|
+
# @!attribute [rw] is_active
|
3037
|
+
# Whether the quick response is active.
|
3038
|
+
# @return [Boolean]
|
3039
|
+
#
|
3040
|
+
# @!attribute [rw] knowledge_base_arn
|
3041
|
+
# The Amazon Resource Name (ARN) of the knowledge base.
|
3042
|
+
# @return [String]
|
3043
|
+
#
|
3044
|
+
# @!attribute [rw] knowledge_base_id
|
3045
|
+
# The identifier of the knowledge base. This should not be a
|
3046
|
+
# QUICK\_RESPONSES type knowledge base if you're storing Amazon Q
|
3047
|
+
# Content resource to it. Can be either the ID or the ARN. URLs cannot
|
3048
|
+
# contain the ARN.
|
3049
|
+
# @return [String]
|
3050
|
+
#
|
3051
|
+
# @!attribute [rw] language
|
3052
|
+
# The language code value for the language in which the quick response
|
3053
|
+
# is written.
|
3054
|
+
# @return [String]
|
3055
|
+
#
|
3056
|
+
# @!attribute [rw] last_modified_by
|
3057
|
+
# The Amazon Resource Name (ARN) of the user who last updated the
|
3058
|
+
# quick response search result data.
|
3059
|
+
# @return [String]
|
3060
|
+
#
|
3061
|
+
# @!attribute [rw] last_modified_time
|
3062
|
+
# The timestamp when the quick response search result data was last
|
3063
|
+
# modified.
|
3064
|
+
# @return [Time]
|
3065
|
+
#
|
3066
|
+
# @!attribute [rw] name
|
3067
|
+
# The name of the quick response.
|
3068
|
+
# @return [String]
|
3069
|
+
#
|
3070
|
+
# @!attribute [rw] quick_response_arn
|
3071
|
+
# The Amazon Resource Name (ARN) of the quick response.
|
3072
|
+
# @return [String]
|
3073
|
+
#
|
3074
|
+
# @!attribute [rw] quick_response_id
|
3075
|
+
# The identifier of the quick response.
|
3076
|
+
# @return [String]
|
3077
|
+
#
|
3078
|
+
# @!attribute [rw] shortcut_key
|
3079
|
+
# The shortcut key of the quick response. The value should be unique
|
3080
|
+
# across the knowledge base.
|
3081
|
+
# @return [String]
|
3082
|
+
#
|
3083
|
+
# @!attribute [rw] status
|
3084
|
+
# The resource status of the quick response.
|
3085
|
+
# @return [String]
|
3086
|
+
#
|
3087
|
+
# @!attribute [rw] tags
|
3088
|
+
# The tags used to organize, track, or control access for this
|
3089
|
+
# resource.
|
3090
|
+
# @return [Hash<String,String>]
|
3091
|
+
#
|
3092
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/QuickResponseSearchResultData AWS API Documentation
|
3093
|
+
#
|
3094
|
+
class QuickResponseSearchResultData < Struct.new(
|
3095
|
+
:attributes_interpolated,
|
3096
|
+
:attributes_not_interpolated,
|
3097
|
+
:channels,
|
3098
|
+
:content_type,
|
3099
|
+
:contents,
|
3100
|
+
:created_time,
|
3101
|
+
:description,
|
3102
|
+
:grouping_configuration,
|
3103
|
+
:is_active,
|
3104
|
+
:knowledge_base_arn,
|
3105
|
+
:knowledge_base_id,
|
3106
|
+
:language,
|
3107
|
+
:last_modified_by,
|
3108
|
+
:last_modified_time,
|
3109
|
+
:name,
|
3110
|
+
:quick_response_arn,
|
3111
|
+
:quick_response_id,
|
3112
|
+
:shortcut_key,
|
3113
|
+
:status,
|
3114
|
+
:tags)
|
3115
|
+
SENSITIVE = [:attributes_interpolated, :attributes_not_interpolated]
|
3116
|
+
include Aws::Structure
|
3117
|
+
end
|
3118
|
+
|
3119
|
+
# The summary information about the quick response.
|
3120
|
+
#
|
3121
|
+
# @!attribute [rw] channels
|
3122
|
+
# The Amazon Connect contact channels this quick response applies to.
|
3123
|
+
# The supported contact channel types include `Chat`.
|
3124
|
+
# @return [Array<String>]
|
3125
|
+
#
|
3126
|
+
# @!attribute [rw] content_type
|
3127
|
+
# The media type of the quick response content.
|
3128
|
+
#
|
3129
|
+
# * Use `application/x.quickresponse;format=plain` for quick response
|
3130
|
+
# written in plain text.
|
3131
|
+
#
|
3132
|
+
# * Use `application/x.quickresponse;format=markdown` for quick
|
3133
|
+
# response written in richtext.
|
3134
|
+
# @return [String]
|
3135
|
+
#
|
3136
|
+
# @!attribute [rw] created_time
|
3137
|
+
# The timestamp when the quick response was created.
|
3138
|
+
# @return [Time]
|
3139
|
+
#
|
3140
|
+
# @!attribute [rw] description
|
3141
|
+
# The description of the quick response.
|
3142
|
+
# @return [String]
|
3143
|
+
#
|
3144
|
+
# @!attribute [rw] is_active
|
3145
|
+
# Whether the quick response is active.
|
3146
|
+
# @return [Boolean]
|
3147
|
+
#
|
3148
|
+
# @!attribute [rw] knowledge_base_arn
|
3149
|
+
# The Amazon Resource Name (ARN) of the knowledge base.
|
3150
|
+
# @return [String]
|
3151
|
+
#
|
3152
|
+
# @!attribute [rw] knowledge_base_id
|
3153
|
+
# The identifier of the knowledge base. This should not be a
|
3154
|
+
# QUICK\_RESPONSES type knowledge base if you're storing Amazon Q
|
3155
|
+
# Content resource to it.
|
3156
|
+
# @return [String]
|
3157
|
+
#
|
3158
|
+
# @!attribute [rw] last_modified_by
|
3159
|
+
# The Amazon Resource Name (ARN) of the user who last updated the
|
3160
|
+
# quick response data.
|
3161
|
+
# @return [String]
|
3162
|
+
#
|
3163
|
+
# @!attribute [rw] last_modified_time
|
3164
|
+
# The timestamp when the quick response summary was last modified.
|
3165
|
+
# @return [Time]
|
3166
|
+
#
|
3167
|
+
# @!attribute [rw] name
|
3168
|
+
# The name of the quick response.
|
3169
|
+
# @return [String]
|
3170
|
+
#
|
3171
|
+
# @!attribute [rw] quick_response_arn
|
3172
|
+
# The Amazon Resource Name (ARN) of the quick response.
|
3173
|
+
# @return [String]
|
3174
|
+
#
|
3175
|
+
# @!attribute [rw] quick_response_id
|
3176
|
+
# The identifier of the quick response.
|
3177
|
+
# @return [String]
|
3178
|
+
#
|
3179
|
+
# @!attribute [rw] status
|
3180
|
+
# The resource status of the quick response.
|
3181
|
+
# @return [String]
|
3182
|
+
#
|
3183
|
+
# @!attribute [rw] tags
|
3184
|
+
# The tags used to organize, track, or control access for this
|
3185
|
+
# resource.
|
3186
|
+
# @return [Hash<String,String>]
|
3187
|
+
#
|
3188
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/QuickResponseSummary AWS API Documentation
|
3189
|
+
#
|
3190
|
+
class QuickResponseSummary < Struct.new(
|
3191
|
+
:channels,
|
3192
|
+
:content_type,
|
3193
|
+
:created_time,
|
3194
|
+
:description,
|
3195
|
+
:is_active,
|
3196
|
+
:knowledge_base_arn,
|
3197
|
+
:knowledge_base_id,
|
3198
|
+
:last_modified_by,
|
3199
|
+
:last_modified_time,
|
3200
|
+
:name,
|
3201
|
+
:quick_response_arn,
|
3202
|
+
:quick_response_id,
|
3203
|
+
:status,
|
3204
|
+
:tags)
|
3205
|
+
SENSITIVE = []
|
3206
|
+
include Aws::Structure
|
3207
|
+
end
|
3208
|
+
|
3209
|
+
# Details about the source content ranking data.
|
3210
|
+
#
|
3211
|
+
# @!attribute [rw] relevance_level
|
3212
|
+
# The relevance score of the content.
|
3213
|
+
# @return [String]
|
3214
|
+
#
|
3215
|
+
# @!attribute [rw] relevance_score
|
3216
|
+
# The relevance level of the recommendation.
|
3217
|
+
# @return [Float]
|
3218
|
+
#
|
3219
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/RankingData AWS API Documentation
|
3220
|
+
#
|
3221
|
+
class RankingData < Struct.new(
|
3222
|
+
:relevance_level,
|
3223
|
+
:relevance_score)
|
3224
|
+
SENSITIVE = []
|
3225
|
+
include Aws::Structure
|
3226
|
+
end
|
3227
|
+
|
3228
|
+
# Information about the recommendation.
|
3229
|
+
#
|
3230
|
+
# @!attribute [rw] data
|
3231
|
+
# Summary of the recommended content.
|
3232
|
+
# @return [Types::DataSummary]
|
3233
|
+
#
|
3234
|
+
# @!attribute [rw] document
|
3235
|
+
# The recommended document.
|
3236
|
+
# @return [Types::Document]
|
3237
|
+
#
|
3238
|
+
# @!attribute [rw] recommendation_id
|
3239
|
+
# The identifier of the recommendation.
|
3240
|
+
# @return [String]
|
3241
|
+
#
|
3242
|
+
# @!attribute [rw] relevance_level
|
3243
|
+
# The relevance level of the recommendation.
|
3244
|
+
# @return [String]
|
3245
|
+
#
|
3246
|
+
# @!attribute [rw] relevance_score
|
3247
|
+
# The relevance score of the recommendation.
|
3248
|
+
# @return [Float]
|
3249
|
+
#
|
3250
|
+
# @!attribute [rw] type
|
3251
|
+
# The type of recommendation.
|
3252
|
+
# @return [String]
|
3253
|
+
#
|
3254
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/RecommendationData AWS API Documentation
|
3255
|
+
#
|
3256
|
+
class RecommendationData < Struct.new(
|
3257
|
+
:data,
|
3258
|
+
:document,
|
3259
|
+
:recommendation_id,
|
3260
|
+
:relevance_level,
|
3261
|
+
:relevance_score,
|
3262
|
+
:type)
|
3263
|
+
SENSITIVE = []
|
3264
|
+
include Aws::Structure
|
3265
|
+
end
|
3266
|
+
|
3267
|
+
# A recommendation trigger provides context on the event that produced
|
3268
|
+
# the referenced recommendations. Recommendations are only referenced in
|
3269
|
+
# `recommendationIds` by a single RecommendationTrigger.
|
3270
|
+
#
|
3271
|
+
# @!attribute [rw] data
|
3272
|
+
# A union type containing information related to the trigger.
|
3273
|
+
# @return [Types::RecommendationTriggerData]
|
3274
|
+
#
|
3275
|
+
# @!attribute [rw] id
|
3276
|
+
# The identifier of the recommendation trigger.
|
3277
|
+
# @return [String]
|
3278
|
+
#
|
3279
|
+
# @!attribute [rw] recommendation_ids
|
3280
|
+
# The identifiers of the recommendations.
|
3281
|
+
# @return [Array<String>]
|
3282
|
+
#
|
3283
|
+
# @!attribute [rw] source
|
3284
|
+
# The source of the recommendation trigger.
|
3285
|
+
#
|
3286
|
+
# * ISSUE\_DETECTION: The corresponding recommendations were triggered
|
3287
|
+
# by a Contact Lens issue.
|
3288
|
+
#
|
3289
|
+
# * RULE\_EVALUATION: The corresponding recommendations were triggered
|
3290
|
+
# by a Contact Lens rule.
|
3291
|
+
# @return [String]
|
3292
|
+
#
|
3293
|
+
# @!attribute [rw] type
|
3294
|
+
# The type of recommendation trigger.
|
3295
|
+
# @return [String]
|
3296
|
+
#
|
3297
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/RecommendationTrigger AWS API Documentation
|
3298
|
+
#
|
3299
|
+
class RecommendationTrigger < Struct.new(
|
3300
|
+
:data,
|
3301
|
+
:id,
|
3302
|
+
:recommendation_ids,
|
3303
|
+
:source,
|
3304
|
+
:type)
|
3305
|
+
SENSITIVE = []
|
3306
|
+
include Aws::Structure
|
3307
|
+
end
|
3308
|
+
|
3309
|
+
# A union type containing information related to the trigger.
|
3310
|
+
#
|
3311
|
+
# @note RecommendationTriggerData is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of RecommendationTriggerData corresponding to the set member.
|
3312
|
+
#
|
3313
|
+
# @!attribute [rw] query
|
3314
|
+
# Data associated with the QUERY RecommendationTriggerType.
|
3315
|
+
# @return [Types::QueryRecommendationTriggerData]
|
3316
|
+
#
|
3317
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/RecommendationTriggerData AWS API Documentation
|
3318
|
+
#
|
3319
|
+
class RecommendationTriggerData < Struct.new(
|
3320
|
+
:query,
|
3321
|
+
:unknown)
|
3322
|
+
SENSITIVE = []
|
3323
|
+
include Aws::Structure
|
3324
|
+
include Aws::Structure::Union
|
3325
|
+
|
3326
|
+
class Query < RecommendationTriggerData; end
|
3327
|
+
class Unknown < RecommendationTriggerData; end
|
3328
|
+
end
|
3329
|
+
|
3330
|
+
# @!attribute [rw] knowledge_base_id
|
3331
|
+
# The identifier of the knowledge base. This should not be a
|
3332
|
+
# QUICK\_RESPONSES type knowledge base if you're storing Amazon Q
|
3333
|
+
# Content resource to it. Can be either the ID or the ARN. URLs cannot
|
3334
|
+
# contain the ARN.
|
3335
|
+
# @return [String]
|
3336
|
+
#
|
3337
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/RemoveKnowledgeBaseTemplateUriRequest AWS API Documentation
|
3338
|
+
#
|
3339
|
+
class RemoveKnowledgeBaseTemplateUriRequest < Struct.new(
|
3340
|
+
:knowledge_base_id)
|
3341
|
+
SENSITIVE = []
|
3342
|
+
include Aws::Structure
|
3343
|
+
end
|
3344
|
+
|
3345
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/RemoveKnowledgeBaseTemplateUriResponse AWS API Documentation
|
3346
|
+
#
|
3347
|
+
class RemoveKnowledgeBaseTemplateUriResponse < Aws::EmptyStructure; end
|
3348
|
+
|
3349
|
+
# Information about how to render the content.
|
3350
|
+
#
|
3351
|
+
# @!attribute [rw] template_uri
|
3352
|
+
# A URI template containing exactly one variable in `$\{variableName\}
|
3353
|
+
# `format. This can only be set for `EXTERNAL` knowledge bases. For
|
3354
|
+
# Salesforce, ServiceNow, and Zendesk, the variable must be one of the
|
3355
|
+
# following:
|
3356
|
+
#
|
3357
|
+
# * Salesforce: `Id`, `ArticleNumber`, `VersionNumber`, `Title`,
|
3358
|
+
# `PublishStatus`, or `IsDeleted`
|
3359
|
+
#
|
3360
|
+
# * ServiceNow: `number`, `short_description`, `sys_mod_count`,
|
3361
|
+
# `workflow_state`, or `active`
|
3362
|
+
#
|
3363
|
+
# * Zendesk: `id`, `title`, `updated_at`, or `draft`
|
3364
|
+
#
|
3365
|
+
# The variable is replaced with the actual value for a piece of
|
3366
|
+
# content when calling [GetContent][1].
|
3367
|
+
#
|
3368
|
+
#
|
3369
|
+
#
|
3370
|
+
# [1]: https://docs.aws.amazon.com/amazon-q-connect/latest/APIReference/API_GetContent.html
|
3371
|
+
# @return [String]
|
3372
|
+
#
|
3373
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/RenderingConfiguration AWS API Documentation
|
3374
|
+
#
|
3375
|
+
class RenderingConfiguration < Struct.new(
|
3376
|
+
:template_uri)
|
3377
|
+
SENSITIVE = []
|
3378
|
+
include Aws::Structure
|
3379
|
+
end
|
3380
|
+
|
3381
|
+
# The request reached the service more than 15 minutes after the date
|
3382
|
+
# stamp on the request or more than 15 minutes after the request
|
3383
|
+
# expiration date (such as for pre-signed URLs), or the date stamp on
|
3384
|
+
# the request is more than 15 minutes in the future.
|
3385
|
+
#
|
3386
|
+
# @!attribute [rw] message
|
3387
|
+
# @return [String]
|
3388
|
+
#
|
3389
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/RequestTimeoutException AWS API Documentation
|
3390
|
+
#
|
3391
|
+
class RequestTimeoutException < Struct.new(
|
3392
|
+
:message)
|
3393
|
+
SENSITIVE = []
|
3394
|
+
include Aws::Structure
|
3395
|
+
end
|
3396
|
+
|
3397
|
+
# The specified resource does not exist.
|
3398
|
+
#
|
3399
|
+
# @!attribute [rw] message
|
3400
|
+
# @return [String]
|
3401
|
+
#
|
3402
|
+
# @!attribute [rw] resource_name
|
3403
|
+
# The specified resource name.
|
3404
|
+
# @return [String]
|
3405
|
+
#
|
3406
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ResourceNotFoundException AWS API Documentation
|
3407
|
+
#
|
3408
|
+
class ResourceNotFoundException < Struct.new(
|
3409
|
+
:message,
|
3410
|
+
:resource_name)
|
3411
|
+
SENSITIVE = []
|
3412
|
+
include Aws::Structure
|
3413
|
+
end
|
3414
|
+
|
3415
|
+
# Information about the result.
|
3416
|
+
#
|
3417
|
+
# @!attribute [rw] data
|
3418
|
+
# Summary of the recommended content.
|
3419
|
+
# @return [Types::DataSummary]
|
3420
|
+
#
|
3421
|
+
# @!attribute [rw] document
|
3422
|
+
# The document.
|
3423
|
+
# @return [Types::Document]
|
3424
|
+
#
|
3425
|
+
# @!attribute [rw] relevance_score
|
3426
|
+
# The relevance score of the results.
|
3427
|
+
# @return [Float]
|
3428
|
+
#
|
3429
|
+
# @!attribute [rw] result_id
|
3430
|
+
# The identifier of the result data.
|
3431
|
+
# @return [String]
|
3432
|
+
#
|
3433
|
+
# @!attribute [rw] type
|
3434
|
+
# The type of the query result.
|
3435
|
+
# @return [String]
|
3436
|
+
#
|
3437
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ResultData AWS API Documentation
|
3438
|
+
#
|
3439
|
+
class ResultData < Struct.new(
|
3440
|
+
:data,
|
3441
|
+
:document,
|
3442
|
+
:relevance_score,
|
3443
|
+
:result_id,
|
3444
|
+
:type)
|
3445
|
+
SENSITIVE = []
|
3446
|
+
include Aws::Structure
|
3447
|
+
end
|
3448
|
+
|
3449
|
+
# @!attribute [rw] knowledge_base_id
|
3450
|
+
# The identifier of the knowledge base. This should not be a
|
3451
|
+
# QUICK\_RESPONSES type knowledge base if you're storing Amazon Q
|
3452
|
+
# Content resource to it. Can be either the ID or the ARN. URLs cannot
|
3453
|
+
# contain the ARN.
|
3454
|
+
# @return [String]
|
3455
|
+
#
|
3456
|
+
# @!attribute [rw] max_results
|
3457
|
+
# The maximum number of results to return per page.
|
3458
|
+
# @return [Integer]
|
3459
|
+
#
|
3460
|
+
# @!attribute [rw] next_token
|
3461
|
+
# The token for the next set of results. Use the value returned in the
|
3462
|
+
# previous response in the next request to retrieve the next set of
|
3463
|
+
# results.
|
3464
|
+
# @return [String]
|
3465
|
+
#
|
3466
|
+
# @!attribute [rw] search_expression
|
3467
|
+
# The search expression to filter results.
|
3468
|
+
# @return [Types::SearchExpression]
|
3469
|
+
#
|
3470
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/SearchContentRequest AWS API Documentation
|
3471
|
+
#
|
3472
|
+
class SearchContentRequest < Struct.new(
|
3473
|
+
:knowledge_base_id,
|
3474
|
+
:max_results,
|
3475
|
+
:next_token,
|
3476
|
+
:search_expression)
|
3477
|
+
SENSITIVE = []
|
3478
|
+
include Aws::Structure
|
3479
|
+
end
|
3480
|
+
|
3481
|
+
# @!attribute [rw] content_summaries
|
3482
|
+
# Summary information about the content.
|
3483
|
+
# @return [Array<Types::ContentSummary>]
|
3484
|
+
#
|
3485
|
+
# @!attribute [rw] next_token
|
3486
|
+
# If there are additional results, this is the token for the next set
|
3487
|
+
# of results.
|
3488
|
+
# @return [String]
|
3489
|
+
#
|
3490
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/SearchContentResponse AWS API Documentation
|
3491
|
+
#
|
3492
|
+
class SearchContentResponse < Struct.new(
|
3493
|
+
:content_summaries,
|
3494
|
+
:next_token)
|
3495
|
+
SENSITIVE = []
|
3496
|
+
include Aws::Structure
|
3497
|
+
end
|
3498
|
+
|
3499
|
+
# The search expression.
|
3500
|
+
#
|
3501
|
+
# @!attribute [rw] filters
|
3502
|
+
# The search expression filters.
|
3503
|
+
# @return [Array<Types::Filter>]
|
3504
|
+
#
|
3505
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/SearchExpression AWS API Documentation
|
3506
|
+
#
|
3507
|
+
class SearchExpression < Struct.new(
|
3508
|
+
:filters)
|
3509
|
+
SENSITIVE = []
|
3510
|
+
include Aws::Structure
|
3511
|
+
end
|
3512
|
+
|
3513
|
+
# @!attribute [rw] attributes
|
3514
|
+
# The [user-defined Amazon Connect contact attributes][1] to be
|
3515
|
+
# resolved when search results are returned.
|
3516
|
+
#
|
3517
|
+
#
|
3518
|
+
#
|
3519
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/connect-attrib-list.html#user-defined-attributes
|
3520
|
+
# @return [Hash<String,String>]
|
3521
|
+
#
|
3522
|
+
# @!attribute [rw] knowledge_base_id
|
3523
|
+
# The identifier of the knowledge base. This should be a
|
3524
|
+
# QUICK\_RESPONSES type knowledge base. Can be either the ID or the
|
3525
|
+
# ARN. URLs cannot contain the ARN.
|
3526
|
+
# @return [String]
|
3527
|
+
#
|
3528
|
+
# @!attribute [rw] max_results
|
3529
|
+
# The maximum number of results to return per page.
|
3530
|
+
# @return [Integer]
|
3531
|
+
#
|
3532
|
+
# @!attribute [rw] next_token
|
3533
|
+
# The token for the next set of results. Use the value returned in the
|
3534
|
+
# previous response in the next request to retrieve the next set of
|
3535
|
+
# results.
|
3536
|
+
# @return [String]
|
3537
|
+
#
|
3538
|
+
# @!attribute [rw] search_expression
|
3539
|
+
# The search expression for querying the quick response.
|
3540
|
+
# @return [Types::QuickResponseSearchExpression]
|
3541
|
+
#
|
3542
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/SearchQuickResponsesRequest AWS API Documentation
|
3543
|
+
#
|
3544
|
+
class SearchQuickResponsesRequest < Struct.new(
|
3545
|
+
:attributes,
|
3546
|
+
:knowledge_base_id,
|
3547
|
+
:max_results,
|
3548
|
+
:next_token,
|
3549
|
+
:search_expression)
|
3550
|
+
SENSITIVE = [:attributes]
|
3551
|
+
include Aws::Structure
|
3552
|
+
end
|
3553
|
+
|
3554
|
+
# @!attribute [rw] next_token
|
3555
|
+
# The token for the next set of results. Use the value returned in the
|
3556
|
+
# previous response in the next request to retrieve the next set of
|
3557
|
+
# results.
|
3558
|
+
# @return [String]
|
3559
|
+
#
|
3560
|
+
# @!attribute [rw] results
|
3561
|
+
# The results of the quick response search.
|
3562
|
+
# @return [Array<Types::QuickResponseSearchResultData>]
|
3563
|
+
#
|
3564
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/SearchQuickResponsesResponse AWS API Documentation
|
3565
|
+
#
|
3566
|
+
class SearchQuickResponsesResponse < Struct.new(
|
3567
|
+
:next_token,
|
3568
|
+
:results)
|
3569
|
+
SENSITIVE = []
|
3570
|
+
include Aws::Structure
|
3571
|
+
end
|
3572
|
+
|
3573
|
+
# @!attribute [rw] assistant_id
|
3574
|
+
# The identifier of the Amazon Q assistant. Can be either the ID or
|
3575
|
+
# the ARN. URLs cannot contain the ARN.
|
3576
|
+
# @return [String]
|
3577
|
+
#
|
3578
|
+
# @!attribute [rw] max_results
|
3579
|
+
# The maximum number of results to return per page.
|
3580
|
+
# @return [Integer]
|
3581
|
+
#
|
3582
|
+
# @!attribute [rw] next_token
|
3583
|
+
# The token for the next set of results. Use the value returned in the
|
3584
|
+
# previous response in the next request to retrieve the next set of
|
3585
|
+
# results.
|
3586
|
+
# @return [String]
|
3587
|
+
#
|
3588
|
+
# @!attribute [rw] search_expression
|
3589
|
+
# The search expression to filter results.
|
3590
|
+
# @return [Types::SearchExpression]
|
3591
|
+
#
|
3592
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/SearchSessionsRequest AWS API Documentation
|
3593
|
+
#
|
3594
|
+
class SearchSessionsRequest < Struct.new(
|
3595
|
+
:assistant_id,
|
3596
|
+
:max_results,
|
3597
|
+
:next_token,
|
3598
|
+
:search_expression)
|
3599
|
+
SENSITIVE = []
|
3600
|
+
include Aws::Structure
|
3601
|
+
end
|
3602
|
+
|
3603
|
+
# @!attribute [rw] next_token
|
3604
|
+
# If there are additional results, this is the token for the next set
|
3605
|
+
# of results.
|
3606
|
+
# @return [String]
|
3607
|
+
#
|
3608
|
+
# @!attribute [rw] session_summaries
|
3609
|
+
# Summary information about the sessions.
|
3610
|
+
# @return [Array<Types::SessionSummary>]
|
3611
|
+
#
|
3612
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/SearchSessionsResponse AWS API Documentation
|
3613
|
+
#
|
3614
|
+
class SearchSessionsResponse < Struct.new(
|
3615
|
+
:next_token,
|
3616
|
+
:session_summaries)
|
3617
|
+
SENSITIVE = []
|
3618
|
+
include Aws::Structure
|
3619
|
+
end
|
3620
|
+
|
3621
|
+
# The configuration information for the customer managed key used for
|
3622
|
+
# encryption.
|
3623
|
+
#
|
3624
|
+
# @!attribute [rw] kms_key_id
|
3625
|
+
# The customer managed key used for encryption. For more information
|
3626
|
+
# about setting up a customer managed key for Amazon Q, see [Enable
|
3627
|
+
# Amazon Q in Connect for your instance][1]. For information about
|
3628
|
+
# valid ID values, see [Key identifiers (KeyId)][2].
|
3629
|
+
#
|
3630
|
+
#
|
3631
|
+
#
|
3632
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/enable-q.html
|
3633
|
+
# [2]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id
|
3634
|
+
# @return [String]
|
3635
|
+
#
|
3636
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ServerSideEncryptionConfiguration AWS API Documentation
|
3637
|
+
#
|
3638
|
+
class ServerSideEncryptionConfiguration < Struct.new(
|
3639
|
+
:kms_key_id)
|
3640
|
+
SENSITIVE = []
|
3641
|
+
include Aws::Structure
|
3642
|
+
end
|
3643
|
+
|
3644
|
+
# You've exceeded your service quota. To perform the requested action,
|
3645
|
+
# remove some of the relevant resources, or use service quotas to
|
3646
|
+
# request a service quota increase.
|
3647
|
+
#
|
3648
|
+
# @!attribute [rw] message
|
3649
|
+
# @return [String]
|
3650
|
+
#
|
3651
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ServiceQuotaExceededException AWS API Documentation
|
3652
|
+
#
|
3653
|
+
class ServiceQuotaExceededException < Struct.new(
|
3654
|
+
:message)
|
3655
|
+
SENSITIVE = []
|
3656
|
+
include Aws::Structure
|
3657
|
+
end
|
3658
|
+
|
3659
|
+
# Information about the session.
|
3660
|
+
#
|
3661
|
+
# @!attribute [rw] description
|
3662
|
+
# The description of the session.
|
3663
|
+
# @return [String]
|
3664
|
+
#
|
3665
|
+
# @!attribute [rw] integration_configuration
|
3666
|
+
# The configuration information for the session integration.
|
3667
|
+
# @return [Types::SessionIntegrationConfiguration]
|
3668
|
+
#
|
3669
|
+
# @!attribute [rw] name
|
3670
|
+
# The name of the session.
|
3671
|
+
# @return [String]
|
3672
|
+
#
|
3673
|
+
# @!attribute [rw] session_arn
|
3674
|
+
# The Amazon Resource Name (ARN) of the session.
|
3675
|
+
# @return [String]
|
3676
|
+
#
|
3677
|
+
# @!attribute [rw] session_id
|
3678
|
+
# The identifier of the session.
|
3679
|
+
# @return [String]
|
3680
|
+
#
|
3681
|
+
# @!attribute [rw] tags
|
3682
|
+
# The tags used to organize, track, or control access for this
|
3683
|
+
# resource.
|
3684
|
+
# @return [Hash<String,String>]
|
3685
|
+
#
|
3686
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/SessionData AWS API Documentation
|
3687
|
+
#
|
3688
|
+
class SessionData < Struct.new(
|
3689
|
+
:description,
|
3690
|
+
:integration_configuration,
|
3691
|
+
:name,
|
3692
|
+
:session_arn,
|
3693
|
+
:session_id,
|
3694
|
+
:tags)
|
3695
|
+
SENSITIVE = []
|
3696
|
+
include Aws::Structure
|
3697
|
+
end
|
3698
|
+
|
3699
|
+
# The configuration information for the session integration.
|
3700
|
+
#
|
3701
|
+
# @!attribute [rw] topic_integration_arn
|
3702
|
+
# The Amazon Resource Name (ARN) of the integrated Amazon SNS topic
|
3703
|
+
# used for streaming chat messages.
|
3704
|
+
# @return [String]
|
3705
|
+
#
|
3706
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/SessionIntegrationConfiguration AWS API Documentation
|
3707
|
+
#
|
3708
|
+
class SessionIntegrationConfiguration < Struct.new(
|
3709
|
+
:topic_integration_arn)
|
3710
|
+
SENSITIVE = []
|
3711
|
+
include Aws::Structure
|
3712
|
+
end
|
3713
|
+
|
3714
|
+
# Summary information about the session.
|
3715
|
+
#
|
3716
|
+
# @!attribute [rw] assistant_arn
|
3717
|
+
# The Amazon Resource Name (ARN) of the Amazon Q assistant.
|
3718
|
+
# @return [String]
|
3719
|
+
#
|
3720
|
+
# @!attribute [rw] assistant_id
|
3721
|
+
# The identifier of the Amazon Q assistant.
|
3722
|
+
# @return [String]
|
3723
|
+
#
|
3724
|
+
# @!attribute [rw] session_arn
|
3725
|
+
# The Amazon Resource Name (ARN) of the session.
|
3726
|
+
# @return [String]
|
3727
|
+
#
|
3728
|
+
# @!attribute [rw] session_id
|
3729
|
+
# The identifier of the session.
|
3730
|
+
# @return [String]
|
3731
|
+
#
|
3732
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/SessionSummary AWS API Documentation
|
3733
|
+
#
|
3734
|
+
class SessionSummary < Struct.new(
|
3735
|
+
:assistant_arn,
|
3736
|
+
:assistant_id,
|
3737
|
+
:session_arn,
|
3738
|
+
:session_id)
|
3739
|
+
SENSITIVE = []
|
3740
|
+
include Aws::Structure
|
3741
|
+
end
|
3742
|
+
|
3743
|
+
# Configuration information about the external data source.
|
3744
|
+
#
|
3745
|
+
# @note SourceConfiguration is a union - when making an API calls you must set exactly one of the members.
|
3746
|
+
#
|
3747
|
+
# @note SourceConfiguration is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of SourceConfiguration corresponding to the set member.
|
3748
|
+
#
|
3749
|
+
# @!attribute [rw] app_integrations
|
3750
|
+
# Configuration information for Amazon AppIntegrations to
|
3751
|
+
# automatically ingest content.
|
3752
|
+
# @return [Types::AppIntegrationsConfiguration]
|
3753
|
+
#
|
3754
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/SourceConfiguration AWS API Documentation
|
3755
|
+
#
|
3756
|
+
class SourceConfiguration < Struct.new(
|
3757
|
+
:app_integrations,
|
3758
|
+
:unknown)
|
3759
|
+
SENSITIVE = []
|
3760
|
+
include Aws::Structure
|
3761
|
+
include Aws::Structure::Union
|
3762
|
+
|
3763
|
+
class AppIntegrations < SourceConfiguration; end
|
3764
|
+
class Unknown < SourceConfiguration; end
|
3765
|
+
end
|
3766
|
+
|
3767
|
+
# Details about the source content data.
|
3768
|
+
#
|
3769
|
+
# @!attribute [rw] id
|
3770
|
+
# The identifier of the source content.
|
3771
|
+
# @return [String]
|
3772
|
+
#
|
3773
|
+
# @!attribute [rw] ranking_data
|
3774
|
+
# Details about the source content ranking data.
|
3775
|
+
# @return [Types::RankingData]
|
3776
|
+
#
|
3777
|
+
# @!attribute [rw] text_data
|
3778
|
+
# Details about the source content text data.
|
3779
|
+
# @return [Types::TextData]
|
3780
|
+
#
|
3781
|
+
# @!attribute [rw] type
|
3782
|
+
# The type of the source content.
|
3783
|
+
# @return [String]
|
3784
|
+
#
|
3785
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/SourceContentDataDetails AWS API Documentation
|
3786
|
+
#
|
3787
|
+
class SourceContentDataDetails < Struct.new(
|
3788
|
+
:id,
|
3789
|
+
:ranking_data,
|
3790
|
+
:text_data,
|
3791
|
+
:type)
|
3792
|
+
SENSITIVE = []
|
3793
|
+
include Aws::Structure
|
3794
|
+
end
|
3795
|
+
|
3796
|
+
# @!attribute [rw] content_type
|
3797
|
+
# The type of content to upload.
|
3798
|
+
# @return [String]
|
3799
|
+
#
|
3800
|
+
# @!attribute [rw] knowledge_base_id
|
3801
|
+
# The identifier of the knowledge base. This should not be a
|
3802
|
+
# QUICK\_RESPONSES type knowledge base if you're storing Amazon Q
|
3803
|
+
# Content resource to it. Can be either the ID or the ARN. URLs cannot
|
3804
|
+
# contain the ARN.
|
3805
|
+
# @return [String]
|
3806
|
+
#
|
3807
|
+
# @!attribute [rw] presigned_url_time_to_live
|
3808
|
+
# The expected expiration time of the generated presigned URL,
|
3809
|
+
# specified in minutes.
|
3810
|
+
# @return [Integer]
|
3811
|
+
#
|
3812
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/StartContentUploadRequest AWS API Documentation
|
3813
|
+
#
|
3814
|
+
class StartContentUploadRequest < Struct.new(
|
3815
|
+
:content_type,
|
3816
|
+
:knowledge_base_id,
|
3817
|
+
:presigned_url_time_to_live)
|
3818
|
+
SENSITIVE = []
|
3819
|
+
include Aws::Structure
|
3820
|
+
end
|
3821
|
+
|
3822
|
+
# @!attribute [rw] headers_to_include
|
3823
|
+
# The headers to include in the upload.
|
3824
|
+
# @return [Hash<String,String>]
|
3825
|
+
#
|
3826
|
+
# @!attribute [rw] upload_id
|
3827
|
+
# The identifier of the upload.
|
3828
|
+
# @return [String]
|
3829
|
+
#
|
3830
|
+
# @!attribute [rw] url
|
3831
|
+
# The URL of the upload.
|
3832
|
+
# @return [String]
|
3833
|
+
#
|
3834
|
+
# @!attribute [rw] url_expiry
|
3835
|
+
# The expiration time of the URL as an epoch timestamp.
|
3836
|
+
# @return [Time]
|
3837
|
+
#
|
3838
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/StartContentUploadResponse AWS API Documentation
|
3839
|
+
#
|
3840
|
+
class StartContentUploadResponse < Struct.new(
|
3841
|
+
:headers_to_include,
|
3842
|
+
:upload_id,
|
3843
|
+
:url,
|
3844
|
+
:url_expiry)
|
3845
|
+
SENSITIVE = [:url]
|
3846
|
+
include Aws::Structure
|
3847
|
+
end
|
3848
|
+
|
3849
|
+
# @!attribute [rw] client_token
|
3850
|
+
# The tags used to organize, track, or control access for this
|
3851
|
+
# resource.
|
3852
|
+
#
|
3853
|
+
# **A suitable default value is auto-generated.** You should normally
|
3854
|
+
# not need to pass this option.
|
3855
|
+
# @return [String]
|
3856
|
+
#
|
3857
|
+
# @!attribute [rw] external_source_configuration
|
3858
|
+
# The configuration information of the external source that the
|
3859
|
+
# resource data are imported from.
|
3860
|
+
# @return [Types::ExternalSourceConfiguration]
|
3861
|
+
#
|
3862
|
+
# @!attribute [rw] import_job_type
|
3863
|
+
# The type of the import job.
|
3864
|
+
#
|
3865
|
+
# * For importing quick response resource, set the value to
|
3866
|
+
# `QUICK_RESPONSES`.
|
3867
|
+
#
|
3868
|
+
# ^
|
3869
|
+
# @return [String]
|
3870
|
+
#
|
3871
|
+
# @!attribute [rw] knowledge_base_id
|
3872
|
+
# The identifier of the knowledge base. This should not be a
|
3873
|
+
# QUICK\_RESPONSES type knowledge base if you're storing Amazon Q
|
3874
|
+
# Content resource to it. Can be either the ID or the ARN. URLs cannot
|
3875
|
+
# contain the ARN.
|
3876
|
+
#
|
3877
|
+
# * For importing Amazon Q quick responses, this should be a
|
3878
|
+
# `QUICK_RESPONSES` type knowledge base.
|
3879
|
+
#
|
3880
|
+
# ^
|
3881
|
+
# @return [String]
|
3882
|
+
#
|
3883
|
+
# @!attribute [rw] metadata
|
3884
|
+
# The metadata fields of the imported Amazon Q resources.
|
3885
|
+
# @return [Hash<String,String>]
|
3886
|
+
#
|
3887
|
+
# @!attribute [rw] upload_id
|
3888
|
+
# A pointer to the uploaded asset. This value is returned by
|
3889
|
+
# [StartContentUpload][1].
|
3890
|
+
#
|
3891
|
+
#
|
3892
|
+
#
|
3893
|
+
# [1]: https://docs.aws.amazon.com/wisdom/latest/APIReference/API_StartContentUpload.html
|
3894
|
+
# @return [String]
|
3895
|
+
#
|
3896
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/StartImportJobRequest AWS API Documentation
|
3897
|
+
#
|
3898
|
+
class StartImportJobRequest < Struct.new(
|
3899
|
+
:client_token,
|
3900
|
+
:external_source_configuration,
|
3901
|
+
:import_job_type,
|
3902
|
+
:knowledge_base_id,
|
3903
|
+
:metadata,
|
3904
|
+
:upload_id)
|
3905
|
+
SENSITIVE = []
|
3906
|
+
include Aws::Structure
|
3907
|
+
end
|
3908
|
+
|
3909
|
+
# @!attribute [rw] import_job
|
3910
|
+
# The import job.
|
3911
|
+
# @return [Types::ImportJobData]
|
3912
|
+
#
|
3913
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/StartImportJobResponse AWS API Documentation
|
3914
|
+
#
|
3915
|
+
class StartImportJobResponse < Struct.new(
|
3916
|
+
:import_job)
|
3917
|
+
SENSITIVE = []
|
3918
|
+
include Aws::Structure
|
3919
|
+
end
|
3920
|
+
|
3921
|
+
# @!attribute [rw] resource_arn
|
3922
|
+
# The Amazon Resource Name (ARN) of the resource.
|
3923
|
+
# @return [String]
|
3924
|
+
#
|
3925
|
+
# @!attribute [rw] tags
|
3926
|
+
# The tags used to organize, track, or control access for this
|
3927
|
+
# resource.
|
3928
|
+
# @return [Hash<String,String>]
|
3929
|
+
#
|
3930
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/TagResourceRequest AWS API Documentation
|
3931
|
+
#
|
3932
|
+
class TagResourceRequest < Struct.new(
|
3933
|
+
:resource_arn,
|
3934
|
+
:tags)
|
3935
|
+
SENSITIVE = []
|
3936
|
+
include Aws::Structure
|
3937
|
+
end
|
3938
|
+
|
3939
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/TagResourceResponse AWS API Documentation
|
3940
|
+
#
|
3941
|
+
class TagResourceResponse < Aws::EmptyStructure; end
|
3942
|
+
|
3943
|
+
# Details about the source content text data.
|
3944
|
+
#
|
3945
|
+
# @!attribute [rw] excerpt
|
3946
|
+
# The text of the document.
|
3947
|
+
# @return [Types::DocumentText]
|
3948
|
+
#
|
3949
|
+
# @!attribute [rw] title
|
3950
|
+
# The text of the document.
|
3951
|
+
# @return [Types::DocumentText]
|
3952
|
+
#
|
3953
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/TextData AWS API Documentation
|
3954
|
+
#
|
3955
|
+
class TextData < Struct.new(
|
3956
|
+
:excerpt,
|
3957
|
+
:title)
|
3958
|
+
SENSITIVE = []
|
3959
|
+
include Aws::Structure
|
3960
|
+
end
|
3961
|
+
|
3962
|
+
# Amazon Q in Connect throws this exception if you have too many tags in
|
3963
|
+
# your tag set.
|
3964
|
+
#
|
3965
|
+
# @!attribute [rw] message
|
3966
|
+
# @return [String]
|
3967
|
+
#
|
3968
|
+
# @!attribute [rw] resource_name
|
3969
|
+
# The specified resource name.
|
3970
|
+
# @return [String]
|
3971
|
+
#
|
3972
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/TooManyTagsException AWS API Documentation
|
3973
|
+
#
|
3974
|
+
class TooManyTagsException < Struct.new(
|
3975
|
+
:message,
|
3976
|
+
:resource_name)
|
3977
|
+
SENSITIVE = []
|
3978
|
+
include Aws::Structure
|
3979
|
+
end
|
3980
|
+
|
3981
|
+
# @!attribute [rw] resource_arn
|
3982
|
+
# The Amazon Resource Name (ARN) of the resource.
|
3983
|
+
# @return [String]
|
3984
|
+
#
|
3985
|
+
# @!attribute [rw] tag_keys
|
3986
|
+
# The tag keys.
|
3987
|
+
# @return [Array<String>]
|
3988
|
+
#
|
3989
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/UntagResourceRequest AWS API Documentation
|
3990
|
+
#
|
3991
|
+
class UntagResourceRequest < Struct.new(
|
3992
|
+
:resource_arn,
|
3993
|
+
:tag_keys)
|
3994
|
+
SENSITIVE = []
|
3995
|
+
include Aws::Structure
|
3996
|
+
end
|
3997
|
+
|
3998
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/UntagResourceResponse AWS API Documentation
|
3999
|
+
#
|
4000
|
+
class UntagResourceResponse < Aws::EmptyStructure; end
|
4001
|
+
|
4002
|
+
# @!attribute [rw] content_id
|
4003
|
+
# The identifier of the content. Can be either the ID or the ARN. URLs
|
4004
|
+
# cannot contain the ARN.
|
4005
|
+
# @return [String]
|
4006
|
+
#
|
4007
|
+
# @!attribute [rw] knowledge_base_id
|
4008
|
+
# The identifier of the knowledge base. This should not be a
|
4009
|
+
# QUICK\_RESPONSES type knowledge base if you're storing Amazon Q
|
4010
|
+
# Content resource to it. Can be either the ID or the ARN
|
4011
|
+
# @return [String]
|
4012
|
+
#
|
4013
|
+
# @!attribute [rw] metadata
|
4014
|
+
# A key/value map to store attributes without affecting tagging or
|
4015
|
+
# recommendations. For example, when synchronizing data between an
|
4016
|
+
# external system and Amazon Q, you can store an external version
|
4017
|
+
# identifier as metadata to utilize for determining drift.
|
4018
|
+
# @return [Hash<String,String>]
|
4019
|
+
#
|
4020
|
+
# @!attribute [rw] override_link_out_uri
|
4021
|
+
# The URI for the article. If the knowledge base has a templateUri,
|
4022
|
+
# setting this argument overrides it for this piece of content. To
|
4023
|
+
# remove an existing `overrideLinkOurUri`, exclude this argument and
|
4024
|
+
# set `removeOverrideLinkOutUri` to true.
|
4025
|
+
# @return [String]
|
4026
|
+
#
|
4027
|
+
# @!attribute [rw] remove_override_link_out_uri
|
4028
|
+
# Unset the existing `overrideLinkOutUri` if it exists.
|
4029
|
+
# @return [Boolean]
|
4030
|
+
#
|
4031
|
+
# @!attribute [rw] revision_id
|
4032
|
+
# The `revisionId` of the content resource to update, taken from an
|
4033
|
+
# earlier call to `GetContent`, `GetContentSummary`, `SearchContent`,
|
4034
|
+
# or `ListContents`. If included, this argument acts as an optimistic
|
4035
|
+
# lock to ensure content was not modified since it was last read. If
|
4036
|
+
# it has been modified, this API throws a
|
4037
|
+
# `PreconditionFailedException`.
|
4038
|
+
# @return [String]
|
4039
|
+
#
|
4040
|
+
# @!attribute [rw] title
|
4041
|
+
# The title of the content.
|
4042
|
+
# @return [String]
|
4043
|
+
#
|
4044
|
+
# @!attribute [rw] upload_id
|
4045
|
+
# A pointer to the uploaded asset. This value is returned by
|
4046
|
+
# [StartContentUpload][1].
|
4047
|
+
#
|
4048
|
+
#
|
4049
|
+
#
|
4050
|
+
# [1]: https://docs.aws.amazon.com/amazon-q-connect/latest/APIReference/API_StartContentUpload.html
|
4051
|
+
# @return [String]
|
4052
|
+
#
|
4053
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/UpdateContentRequest AWS API Documentation
|
4054
|
+
#
|
4055
|
+
class UpdateContentRequest < Struct.new(
|
4056
|
+
:content_id,
|
4057
|
+
:knowledge_base_id,
|
4058
|
+
:metadata,
|
4059
|
+
:override_link_out_uri,
|
4060
|
+
:remove_override_link_out_uri,
|
4061
|
+
:revision_id,
|
4062
|
+
:title,
|
4063
|
+
:upload_id)
|
4064
|
+
SENSITIVE = []
|
4065
|
+
include Aws::Structure
|
4066
|
+
end
|
4067
|
+
|
4068
|
+
# @!attribute [rw] content
|
4069
|
+
# The content.
|
4070
|
+
# @return [Types::ContentData]
|
4071
|
+
#
|
4072
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/UpdateContentResponse AWS API Documentation
|
4073
|
+
#
|
4074
|
+
class UpdateContentResponse < Struct.new(
|
4075
|
+
:content)
|
4076
|
+
SENSITIVE = []
|
4077
|
+
include Aws::Structure
|
4078
|
+
end
|
4079
|
+
|
4080
|
+
# @!attribute [rw] knowledge_base_id
|
4081
|
+
# The identifier of the knowledge base. This should not be a
|
4082
|
+
# QUICK\_RESPONSES type knowledge base if you're storing Amazon Q
|
4083
|
+
# Content resource to it. Can be either the ID or the ARN. URLs cannot
|
4084
|
+
# contain the ARN.
|
4085
|
+
# @return [String]
|
4086
|
+
#
|
4087
|
+
# @!attribute [rw] template_uri
|
4088
|
+
# The template URI to update.
|
4089
|
+
# @return [String]
|
4090
|
+
#
|
4091
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/UpdateKnowledgeBaseTemplateUriRequest AWS API Documentation
|
4092
|
+
#
|
4093
|
+
class UpdateKnowledgeBaseTemplateUriRequest < Struct.new(
|
4094
|
+
:knowledge_base_id,
|
4095
|
+
:template_uri)
|
4096
|
+
SENSITIVE = []
|
4097
|
+
include Aws::Structure
|
4098
|
+
end
|
4099
|
+
|
4100
|
+
# @!attribute [rw] knowledge_base
|
4101
|
+
# The knowledge base to update.
|
4102
|
+
# @return [Types::KnowledgeBaseData]
|
4103
|
+
#
|
4104
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/UpdateKnowledgeBaseTemplateUriResponse AWS API Documentation
|
4105
|
+
#
|
4106
|
+
class UpdateKnowledgeBaseTemplateUriResponse < Struct.new(
|
4107
|
+
:knowledge_base)
|
4108
|
+
SENSITIVE = []
|
4109
|
+
include Aws::Structure
|
4110
|
+
end
|
4111
|
+
|
4112
|
+
# @!attribute [rw] channels
|
4113
|
+
# The Amazon Connect contact channels this quick response applies to.
|
4114
|
+
# The supported contact channel types include `Chat`.
|
4115
|
+
# @return [Array<String>]
|
4116
|
+
#
|
4117
|
+
# @!attribute [rw] content
|
4118
|
+
# The updated content of the quick response.
|
4119
|
+
# @return [Types::QuickResponseDataProvider]
|
4120
|
+
#
|
4121
|
+
# @!attribute [rw] content_type
|
4122
|
+
# The media type of the quick response content.
|
4123
|
+
#
|
4124
|
+
# * Use `application/x.quickresponse;format=plain` for quick response
|
4125
|
+
# written in plain text.
|
4126
|
+
#
|
4127
|
+
# * Use `application/x.quickresponse;format=markdown` for quick
|
4128
|
+
# response written in richtext.
|
4129
|
+
# @return [String]
|
4130
|
+
#
|
4131
|
+
# @!attribute [rw] description
|
4132
|
+
# The updated description of the quick response.
|
4133
|
+
# @return [String]
|
4134
|
+
#
|
4135
|
+
# @!attribute [rw] grouping_configuration
|
4136
|
+
# The updated grouping configuration of the quick response.
|
4137
|
+
# @return [Types::GroupingConfiguration]
|
4138
|
+
#
|
4139
|
+
# @!attribute [rw] is_active
|
4140
|
+
# Whether the quick response is active.
|
4141
|
+
# @return [Boolean]
|
4142
|
+
#
|
4143
|
+
# @!attribute [rw] knowledge_base_id
|
4144
|
+
# The identifier of the knowledge base. This should not be a
|
4145
|
+
# QUICK\_RESPONSES type knowledge base if you're storing Amazon Q
|
4146
|
+
# Content resource to it. Can be either the ID or the ARN. URLs cannot
|
4147
|
+
# contain the ARN.
|
4148
|
+
# @return [String]
|
4149
|
+
#
|
4150
|
+
# @!attribute [rw] language
|
4151
|
+
# The language code value for the language in which the quick response
|
4152
|
+
# is written. The supported language codes include `de_DE`, `en_US`,
|
4153
|
+
# `es_ES`, `fr_FR`, `id_ID`, `it_IT`, `ja_JP`, `ko_KR`, `pt_BR`,
|
4154
|
+
# `zh_CN`, `zh_TW`
|
4155
|
+
# @return [String]
|
4156
|
+
#
|
4157
|
+
# @!attribute [rw] name
|
4158
|
+
# The name of the quick response.
|
4159
|
+
# @return [String]
|
4160
|
+
#
|
4161
|
+
# @!attribute [rw] quick_response_id
|
4162
|
+
# The identifier of the quick response.
|
4163
|
+
# @return [String]
|
4164
|
+
#
|
4165
|
+
# @!attribute [rw] remove_description
|
4166
|
+
# Whether to remove the description from the quick response.
|
4167
|
+
# @return [Boolean]
|
4168
|
+
#
|
4169
|
+
# @!attribute [rw] remove_grouping_configuration
|
4170
|
+
# Whether to remove the grouping configuration of the quick response.
|
4171
|
+
# @return [Boolean]
|
4172
|
+
#
|
4173
|
+
# @!attribute [rw] remove_shortcut_key
|
4174
|
+
# Whether to remove the shortcut key of the quick response.
|
4175
|
+
# @return [Boolean]
|
4176
|
+
#
|
4177
|
+
# @!attribute [rw] shortcut_key
|
4178
|
+
# The shortcut key of the quick response. The value should be unique
|
4179
|
+
# across the knowledge base.
|
4180
|
+
# @return [String]
|
4181
|
+
#
|
4182
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/UpdateQuickResponseRequest AWS API Documentation
|
4183
|
+
#
|
4184
|
+
class UpdateQuickResponseRequest < Struct.new(
|
4185
|
+
:channels,
|
4186
|
+
:content,
|
4187
|
+
:content_type,
|
4188
|
+
:description,
|
4189
|
+
:grouping_configuration,
|
4190
|
+
:is_active,
|
4191
|
+
:knowledge_base_id,
|
4192
|
+
:language,
|
4193
|
+
:name,
|
4194
|
+
:quick_response_id,
|
4195
|
+
:remove_description,
|
4196
|
+
:remove_grouping_configuration,
|
4197
|
+
:remove_shortcut_key,
|
4198
|
+
:shortcut_key)
|
4199
|
+
SENSITIVE = []
|
4200
|
+
include Aws::Structure
|
4201
|
+
end
|
4202
|
+
|
4203
|
+
# @!attribute [rw] quick_response
|
4204
|
+
# The quick response.
|
4205
|
+
# @return [Types::QuickResponseData]
|
4206
|
+
#
|
4207
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/UpdateQuickResponseResponse AWS API Documentation
|
4208
|
+
#
|
4209
|
+
class UpdateQuickResponseResponse < Struct.new(
|
4210
|
+
:quick_response)
|
4211
|
+
SENSITIVE = []
|
4212
|
+
include Aws::Structure
|
4213
|
+
end
|
4214
|
+
|
4215
|
+
# The input fails to satisfy the constraints specified by a service.
|
4216
|
+
#
|
4217
|
+
# @!attribute [rw] message
|
4218
|
+
# @return [String]
|
4219
|
+
#
|
4220
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ValidationException AWS API Documentation
|
4221
|
+
#
|
4222
|
+
class ValidationException < Struct.new(
|
4223
|
+
:message)
|
4224
|
+
SENSITIVE = []
|
4225
|
+
include Aws::Structure
|
4226
|
+
end
|
4227
|
+
|
4228
|
+
end
|
4229
|
+
end
|