aws-sdk-qbusiness 1.45.0 → 1.47.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-qbusiness/async_client.rb +4 -1
- data/lib/aws-sdk-qbusiness/client.rb +81 -6
- data/lib/aws-sdk-qbusiness/client_api.rb +32 -1
- data/lib/aws-sdk-qbusiness/types.rb +119 -6
- data/lib/aws-sdk-qbusiness.rb +1 -1
- data/sig/client.rbs +15 -0
- data/sig/types.rbs +18 -0
- metadata +1 -1
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: d473c6cf856405f21dd50dccba2da7bdf8f1434e98cb86f4fcd48c46dc33d5be
|
4
|
+
data.tar.gz: 3bb9dfd2f8567be8011aadde90d2b7dec844cc19e13689b10ed5f0022deea1ac
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: d176450b72edea7f18be2af69ef8e0a763d1569eed51aa26dd10c84780c8fbe058741ab8fe42579ae4f433d01de2aac0d4887d2c15e661cc3792d973af5970f7
|
7
|
+
data.tar.gz: 16646aad4b1241f6408180e4f6bc19ac81db7532497638a633eb74d5fd7e74af2e6b3ab63685bb3c17ac3d2d6197eb902b7972c075c376d6813d7f05eff9507f
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,16 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.47.0 (2025-08-25)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - The Amazon Q Business GetDocumentContent operation now supports retrieval of the extracted text content in JSON format.
|
8
|
+
|
9
|
+
1.46.0 (2025-08-06)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - Amazon Q Business now supports the GetDocumentContent() API that enables customers to securely access the source documents through clickable citation links at query time
|
13
|
+
|
4
14
|
1.45.0 (2025-08-04)
|
5
15
|
------------------
|
6
16
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.47.0
|
@@ -600,6 +600,9 @@ module Aws::QBusiness
|
|
600
600
|
# event.source_attributions[0].text_message_segments[0].source_details.video_source_details.start_time_milliseconds #=> Integer
|
601
601
|
# event.source_attributions[0].text_message_segments[0].source_details.video_source_details.end_time_milliseconds #=> Integer
|
602
602
|
# event.source_attributions[0].text_message_segments[0].source_details.video_source_details.video_extraction_type #=> String, one of "TRANSCRIPT", "SUMMARY"
|
603
|
+
# event.source_attributions[0].document_id #=> String
|
604
|
+
# event.source_attributions[0].index_id #=> String
|
605
|
+
# event.source_attributions[0].datasource_id #=> String
|
603
606
|
# event.final_text_message #=> String
|
604
607
|
#
|
605
608
|
# # For :action_review_event event available at #on_action_review_event_event callback and response eventstream enumerator:
|
@@ -680,7 +683,7 @@ module Aws::QBusiness
|
|
680
683
|
tracer: tracer
|
681
684
|
)
|
682
685
|
context[:gem_name] = 'aws-sdk-qbusiness'
|
683
|
-
context[:gem_version] = '1.
|
686
|
+
context[:gem_version] = '1.47.0'
|
684
687
|
Seahorse::Client::Request.new(handlers, context)
|
685
688
|
end
|
686
689
|
|
@@ -624,6 +624,10 @@ module Aws::QBusiness
|
|
624
624
|
# @option params [required, Array<Types::Document>] :documents
|
625
625
|
# One or more documents to add to the index.
|
626
626
|
#
|
627
|
+
# Ensure that the name of your document doesn't contain any
|
628
|
+
# confidential information. Amazon Q Business returns document names in
|
629
|
+
# chat responses and citations when relevant.
|
630
|
+
#
|
627
631
|
# @option params [String] :role_arn
|
628
632
|
# The Amazon Resource Name (ARN) of an IAM role with permission to
|
629
633
|
# access your S3 bucket.
|
@@ -1073,6 +1077,9 @@ module Aws::QBusiness
|
|
1073
1077
|
# resp.source_attributions[0].text_message_segments[0].source_details.video_source_details.start_time_milliseconds #=> Integer
|
1074
1078
|
# resp.source_attributions[0].text_message_segments[0].source_details.video_source_details.end_time_milliseconds #=> Integer
|
1075
1079
|
# resp.source_attributions[0].text_message_segments[0].source_details.video_source_details.video_extraction_type #=> String, one of "TRANSCRIPT", "SUMMARY"
|
1080
|
+
# resp.source_attributions[0].document_id #=> String
|
1081
|
+
# resp.source_attributions[0].index_id #=> String
|
1082
|
+
# resp.source_attributions[0].datasource_id #=> String
|
1076
1083
|
# resp.failed_attachments #=> Array
|
1077
1084
|
# resp.failed_attachments[0].name #=> String
|
1078
1085
|
# resp.failed_attachments[0].status #=> String, one of "FAILED", "SUCCESS"
|
@@ -1696,7 +1703,9 @@ module Aws::QBusiness
|
|
1696
1703
|
#
|
1697
1704
|
# @option params [String] :role_arn
|
1698
1705
|
# The Amazon Resource Name (ARN) of an IAM role with permission to
|
1699
|
-
# access the data source and required resources.
|
1706
|
+
# access the data source and required resources. This field is required
|
1707
|
+
# for all connector types except custom connectors, where it is
|
1708
|
+
# optional.
|
1700
1709
|
#
|
1701
1710
|
# @option params [String] :client_token
|
1702
1711
|
# A token you provide to identify a request to create a data source
|
@@ -2125,9 +2134,15 @@ module Aws::QBusiness
|
|
2125
2134
|
# user. For more information on subscriptions and pricing tiers, see
|
2126
2135
|
# [Amazon Q Business pricing][1].
|
2127
2136
|
#
|
2137
|
+
# <note markdown="1"> For an example IAM role policy for assigning subscriptions, see [Set
|
2138
|
+
# up required permissions][2] in the Amazon Q Business User Guide.
|
2139
|
+
#
|
2140
|
+
# </note>
|
2141
|
+
#
|
2128
2142
|
#
|
2129
2143
|
#
|
2130
2144
|
# [1]: https://aws.amazon.com/q/business/pricing/
|
2145
|
+
# [2]: https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/setting-up.html#permissions
|
2131
2146
|
#
|
2132
2147
|
# @option params [required, String] :application_id
|
2133
2148
|
# The identifier of the Amazon Q Business application the subscription
|
@@ -2263,10 +2278,9 @@ module Aws::QBusiness
|
|
2263
2278
|
# The Amazon Resource Name (ARN) of the service role attached to your
|
2264
2279
|
# web experience.
|
2265
2280
|
#
|
2266
|
-
# <note markdown="1">
|
2267
|
-
#
|
2268
|
-
#
|
2269
|
-
# this value.
|
2281
|
+
# <note markdown="1"> The `roleArn` parameter is required when your Amazon Q Business
|
2282
|
+
# application is created with IAM Identity Center. It is not required
|
2283
|
+
# for SAML-based applications.
|
2270
2284
|
#
|
2271
2285
|
# </note>
|
2272
2286
|
#
|
@@ -3216,6 +3230,64 @@ module Aws::QBusiness
|
|
3216
3230
|
req.send_request(options)
|
3217
3231
|
end
|
3218
3232
|
|
3233
|
+
# Retrieves the content of a document that was ingested into Amazon Q
|
3234
|
+
# Business. This API validates user authorization against document ACLs
|
3235
|
+
# before returning a pre-signed URL for secure document access. You can
|
3236
|
+
# download or view source documents referenced in chat responses through
|
3237
|
+
# the URL.
|
3238
|
+
#
|
3239
|
+
# @option params [required, String] :application_id
|
3240
|
+
# The unique identifier of the Amazon Q Business application containing
|
3241
|
+
# the document. This ensures the request is scoped to the correct
|
3242
|
+
# application environment and its associated security policies.
|
3243
|
+
#
|
3244
|
+
# @option params [required, String] :index_id
|
3245
|
+
# The identifier of the index where documents are indexed.
|
3246
|
+
#
|
3247
|
+
# @option params [String] :data_source_id
|
3248
|
+
# The identifier of the data source from which the document was
|
3249
|
+
# ingested. This field is not present if the document is ingested by
|
3250
|
+
# directly calling the BatchPutDocument API. If the document is from a
|
3251
|
+
# file-upload data source, the datasource will be
|
3252
|
+
# "uploaded-docs-file-stat-datasourceid".
|
3253
|
+
#
|
3254
|
+
# @option params [required, String] :document_id
|
3255
|
+
# The unique identifier of the document that is indexed via
|
3256
|
+
# BatchPutDocument API or file-upload or connector sync. It is also
|
3257
|
+
# found in chat or chatSync response.
|
3258
|
+
#
|
3259
|
+
# @option params [String] :output_format
|
3260
|
+
# Document outputFormat. Defaults to RAW if not selected.
|
3261
|
+
#
|
3262
|
+
# @return [Types::GetDocumentContentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3263
|
+
#
|
3264
|
+
# * {Types::GetDocumentContentResponse#presigned_url #presigned_url} => String
|
3265
|
+
# * {Types::GetDocumentContentResponse#mime_type #mime_type} => String
|
3266
|
+
#
|
3267
|
+
# @example Request syntax with placeholder values
|
3268
|
+
#
|
3269
|
+
# resp = client.get_document_content({
|
3270
|
+
# application_id: "ApplicationId", # required
|
3271
|
+
# index_id: "IndexId", # required
|
3272
|
+
# data_source_id: "DataSourceId",
|
3273
|
+
# document_id: "DocumentId", # required
|
3274
|
+
# output_format: "RAW", # accepts RAW, EXTRACTED
|
3275
|
+
# })
|
3276
|
+
#
|
3277
|
+
# @example Response structure
|
3278
|
+
#
|
3279
|
+
# resp.presigned_url #=> String
|
3280
|
+
# resp.mime_type #=> String
|
3281
|
+
#
|
3282
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/GetDocumentContent AWS API Documentation
|
3283
|
+
#
|
3284
|
+
# @overload get_document_content(params = {})
|
3285
|
+
# @param [Hash] params ({})
|
3286
|
+
def get_document_content(params = {}, options = {})
|
3287
|
+
req = build_request(:get_document_content, params)
|
3288
|
+
req.send_request(options)
|
3289
|
+
end
|
3290
|
+
|
3219
3291
|
# Describes a group by group name.
|
3220
3292
|
#
|
3221
3293
|
# @option params [required, String] :application_id
|
@@ -4316,6 +4388,9 @@ module Aws::QBusiness
|
|
4316
4388
|
# resp.messages[0].source_attribution[0].text_message_segments[0].source_details.video_source_details.start_time_milliseconds #=> Integer
|
4317
4389
|
# resp.messages[0].source_attribution[0].text_message_segments[0].source_details.video_source_details.end_time_milliseconds #=> Integer
|
4318
4390
|
# resp.messages[0].source_attribution[0].text_message_segments[0].source_details.video_source_details.video_extraction_type #=> String, one of "TRANSCRIPT", "SUMMARY"
|
4391
|
+
# resp.messages[0].source_attribution[0].document_id #=> String
|
4392
|
+
# resp.messages[0].source_attribution[0].index_id #=> String
|
4393
|
+
# resp.messages[0].source_attribution[0].datasource_id #=> String
|
4319
4394
|
# resp.messages[0].action_review.plugin_id #=> String
|
4320
4395
|
# resp.messages[0].action_review.plugin_type #=> String, one of "SERVICE_NOW", "SALESFORCE", "JIRA", "ZENDESK", "CUSTOM", "QUICKSIGHT", "SERVICENOW_NOW_PLATFORM", "JIRA_CLOUD", "SALESFORCE_CRM", "ZENDESK_SUITE", "ATLASSIAN_CONFLUENCE", "GOOGLE_CALENDAR", "MICROSOFT_TEAMS", "MICROSOFT_EXCHANGE", "PAGERDUTY_ADVANCE", "SMARTSHEET", "ASANA"
|
4321
4396
|
# resp.messages[0].action_review.payload #=> Hash
|
@@ -6180,7 +6255,7 @@ module Aws::QBusiness
|
|
6180
6255
|
tracer: tracer
|
6181
6256
|
)
|
6182
6257
|
context[:gem_name] = 'aws-sdk-qbusiness'
|
6183
|
-
context[:gem_version] = '1.
|
6258
|
+
context[:gem_version] = '1.47.0'
|
6184
6259
|
Seahorse::Client::Request.new(handlers, context)
|
6185
6260
|
end
|
6186
6261
|
|
@@ -278,6 +278,8 @@ module Aws::QBusiness
|
|
278
278
|
GetDataAccessorResponse = Shapes::StructureShape.new(name: 'GetDataAccessorResponse')
|
279
279
|
GetDataSourceRequest = Shapes::StructureShape.new(name: 'GetDataSourceRequest')
|
280
280
|
GetDataSourceResponse = Shapes::StructureShape.new(name: 'GetDataSourceResponse')
|
281
|
+
GetDocumentContentRequest = Shapes::StructureShape.new(name: 'GetDocumentContentRequest')
|
282
|
+
GetDocumentContentResponse = Shapes::StructureShape.new(name: 'GetDocumentContentResponse')
|
281
283
|
GetGroupRequest = Shapes::StructureShape.new(name: 'GetGroupRequest')
|
282
284
|
GetGroupResponse = Shapes::StructureShape.new(name: 'GetGroupResponse')
|
283
285
|
GetIndexRequest = Shapes::StructureShape.new(name: 'GetIndexRequest')
|
@@ -429,6 +431,7 @@ module Aws::QBusiness
|
|
429
431
|
OrchestrationConfiguration = Shapes::StructureShape.new(name: 'OrchestrationConfiguration')
|
430
432
|
OrchestrationControl = Shapes::StringShape.new(name: 'OrchestrationControl')
|
431
433
|
Origin = Shapes::StringShape.new(name: 'Origin')
|
434
|
+
OutputFormat = Shapes::StringShape.new(name: 'OutputFormat')
|
432
435
|
Payload = Shapes::StringShape.new(name: 'Payload')
|
433
436
|
PermissionCondition = Shapes::StructureShape.new(name: 'PermissionCondition')
|
434
437
|
PermissionConditionKey = Shapes::StringShape.new(name: 'PermissionConditionKey')
|
@@ -1560,6 +1563,17 @@ module Aws::QBusiness
|
|
1560
1563
|
GetDataSourceResponse.add_member(:media_extraction_configuration, Shapes::ShapeRef.new(shape: MediaExtractionConfiguration, location_name: "mediaExtractionConfiguration"))
|
1561
1564
|
GetDataSourceResponse.struct_class = Types::GetDataSourceResponse
|
1562
1565
|
|
1566
|
+
GetDocumentContentRequest.add_member(:application_id, Shapes::ShapeRef.new(shape: ApplicationId, required: true, location: "uri", location_name: "applicationId"))
|
1567
|
+
GetDocumentContentRequest.add_member(:index_id, Shapes::ShapeRef.new(shape: IndexId, required: true, location: "uri", location_name: "indexId"))
|
1568
|
+
GetDocumentContentRequest.add_member(:data_source_id, Shapes::ShapeRef.new(shape: DataSourceId, location: "querystring", location_name: "dataSourceId"))
|
1569
|
+
GetDocumentContentRequest.add_member(:document_id, Shapes::ShapeRef.new(shape: DocumentId, required: true, location: "uri", location_name: "documentId"))
|
1570
|
+
GetDocumentContentRequest.add_member(:output_format, Shapes::ShapeRef.new(shape: OutputFormat, location: "querystring", location_name: "outputFormat"))
|
1571
|
+
GetDocumentContentRequest.struct_class = Types::GetDocumentContentRequest
|
1572
|
+
|
1573
|
+
GetDocumentContentResponse.add_member(:presigned_url, Shapes::ShapeRef.new(shape: String, required: true, location_name: "presignedUrl"))
|
1574
|
+
GetDocumentContentResponse.add_member(:mime_type, Shapes::ShapeRef.new(shape: String, required: true, location_name: "mimeType"))
|
1575
|
+
GetDocumentContentResponse.struct_class = Types::GetDocumentContentResponse
|
1576
|
+
|
1563
1577
|
GetGroupRequest.add_member(:application_id, Shapes::ShapeRef.new(shape: ApplicationId, required: true, location: "uri", location_name: "applicationId"))
|
1564
1578
|
GetGroupRequest.add_member(:index_id, Shapes::ShapeRef.new(shape: IndexId, required: true, location: "uri", location_name: "indexId"))
|
1565
1579
|
GetGroupRequest.add_member(:group_name, Shapes::ShapeRef.new(shape: GroupName, required: true, location: "uri", location_name: "groupName"))
|
@@ -2178,7 +2192,7 @@ module Aws::QBusiness
|
|
2178
2192
|
SearchRelevantContentRequest.add_member(:query_text, Shapes::ShapeRef.new(shape: QueryText, required: true, location_name: "queryText"))
|
2179
2193
|
SearchRelevantContentRequest.add_member(:content_source, Shapes::ShapeRef.new(shape: ContentSource, required: true, location_name: "contentSource"))
|
2180
2194
|
SearchRelevantContentRequest.add_member(:attribute_filter, Shapes::ShapeRef.new(shape: AttributeFilter, location_name: "attributeFilter"))
|
2181
|
-
SearchRelevantContentRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResults, location_name: "maxResults"))
|
2195
|
+
SearchRelevantContentRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResults, location_name: "maxResults", metadata: {"box" => true}))
|
2182
2196
|
SearchRelevantContentRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "nextToken"))
|
2183
2197
|
SearchRelevantContentRequest.struct_class = Types::SearchRelevantContentRequest
|
2184
2198
|
|
@@ -2202,6 +2216,9 @@ module Aws::QBusiness
|
|
2202
2216
|
SourceAttribution.add_member(:citation_number, Shapes::ShapeRef.new(shape: Integer, location_name: "citationNumber"))
|
2203
2217
|
SourceAttribution.add_member(:updated_at, Shapes::ShapeRef.new(shape: Timestamp, location_name: "updatedAt"))
|
2204
2218
|
SourceAttribution.add_member(:text_message_segments, Shapes::ShapeRef.new(shape: TextSegmentList, location_name: "textMessageSegments"))
|
2219
|
+
SourceAttribution.add_member(:document_id, Shapes::ShapeRef.new(shape: String, location_name: "documentId"))
|
2220
|
+
SourceAttribution.add_member(:index_id, Shapes::ShapeRef.new(shape: String, location_name: "indexId"))
|
2221
|
+
SourceAttribution.add_member(:datasource_id, Shapes::ShapeRef.new(shape: String, location_name: "datasourceId"))
|
2205
2222
|
SourceAttribution.struct_class = Types::SourceAttribution
|
2206
2223
|
|
2207
2224
|
SourceAttributions.member = Shapes::ShapeRef.new(shape: SourceAttribution)
|
@@ -2846,6 +2863,7 @@ module Aws::QBusiness
|
|
2846
2863
|
o.output = Shapes::ShapeRef.new(shape: DeleteConversationResponse)
|
2847
2864
|
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
2848
2865
|
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
2866
|
+
o.errors << Shapes::ShapeRef.new(shape: ConflictException)
|
2849
2867
|
o.errors << Shapes::ShapeRef.new(shape: LicenseNotFoundException)
|
2850
2868
|
o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
|
2851
2869
|
o.errors << Shapes::ShapeRef.new(shape: ValidationException)
|
@@ -3049,6 +3067,19 @@ module Aws::QBusiness
|
|
3049
3067
|
o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
|
3050
3068
|
end)
|
3051
3069
|
|
3070
|
+
api.add_operation(:get_document_content, Seahorse::Model::Operation.new.tap do |o|
|
3071
|
+
o.name = "GetDocumentContent"
|
3072
|
+
o.http_method = "GET"
|
3073
|
+
o.http_request_uri = "/applications/{applicationId}/index/{indexId}/documents/{documentId}/content"
|
3074
|
+
o.input = Shapes::ShapeRef.new(shape: GetDocumentContentRequest)
|
3075
|
+
o.output = Shapes::ShapeRef.new(shape: GetDocumentContentResponse)
|
3076
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
3077
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
3078
|
+
o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
|
3079
|
+
o.errors << Shapes::ShapeRef.new(shape: ValidationException)
|
3080
|
+
o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
|
3081
|
+
end)
|
3082
|
+
|
3052
3083
|
api.add_operation(:get_group, Seahorse::Model::Operation.new.tap do |o|
|
3053
3084
|
o.name = "GetGroup"
|
3054
3085
|
o.http_method = "GET"
|
@@ -1106,6 +1106,10 @@ module Aws::QBusiness
|
|
1106
1106
|
#
|
1107
1107
|
# @!attribute [rw] documents
|
1108
1108
|
# One or more documents to add to the index.
|
1109
|
+
#
|
1110
|
+
# Ensure that the name of your document doesn't contain any
|
1111
|
+
# confidential information. Amazon Q Business returns document names
|
1112
|
+
# in chat responses and citations when relevant.
|
1109
1113
|
# @return [Array<Types::Document>]
|
1110
1114
|
#
|
1111
1115
|
# @!attribute [rw] role_arn
|
@@ -1151,6 +1155,11 @@ module Aws::QBusiness
|
|
1151
1155
|
# @!attribute [rw] blocked_phrases
|
1152
1156
|
# A list of phrases blocked from a Amazon Q Business web experience
|
1153
1157
|
# chat.
|
1158
|
+
#
|
1159
|
+
# <note markdown="1"> Each phrase can contain a maximum of 36 characters. The list can
|
1160
|
+
# contain a maximum of 20 phrases.
|
1161
|
+
#
|
1162
|
+
# </note>
|
1154
1163
|
# @return [Array<String>]
|
1155
1164
|
#
|
1156
1165
|
# @!attribute [rw] system_message_override
|
@@ -2281,7 +2290,9 @@ module Aws::QBusiness
|
|
2281
2290
|
#
|
2282
2291
|
# @!attribute [rw] role_arn
|
2283
2292
|
# The Amazon Resource Name (ARN) of an IAM role with permission to
|
2284
|
-
# access the data source and required resources.
|
2293
|
+
# access the data source and required resources. This field is
|
2294
|
+
# required for all connector types except custom connectors, where it
|
2295
|
+
# is optional.
|
2285
2296
|
# @return [String]
|
2286
2297
|
#
|
2287
2298
|
# @!attribute [rw] client_token
|
@@ -2703,10 +2714,9 @@ module Aws::QBusiness
|
|
2703
2714
|
# The Amazon Resource Name (ARN) of the service role attached to your
|
2704
2715
|
# web experience.
|
2705
2716
|
#
|
2706
|
-
# <note markdown="1">
|
2707
|
-
#
|
2708
|
-
#
|
2709
|
-
# provide this value.
|
2717
|
+
# <note markdown="1"> The `roleArn` parameter is required when your Amazon Q Business
|
2718
|
+
# application is created with IAM Identity Center. It is not required
|
2719
|
+
# for SAML-based applications.
|
2710
2720
|
#
|
2711
2721
|
# </note>
|
2712
2722
|
# @return [String]
|
@@ -4028,6 +4038,17 @@ module Aws::QBusiness
|
|
4028
4038
|
|
4029
4039
|
# The contents of a document.
|
4030
4040
|
#
|
4041
|
+
# <note markdown="1"> Documents have size limitations. The maximum file size for a document
|
4042
|
+
# is 50 MB. The maximum amount of text that can be extracted from a
|
4043
|
+
# single document is 5 MB. For more information, see [Supported document
|
4044
|
+
# formats in Amazon Q Business][1].
|
4045
|
+
#
|
4046
|
+
# </note>
|
4047
|
+
#
|
4048
|
+
#
|
4049
|
+
#
|
4050
|
+
# [1]: https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/doc-types.html
|
4051
|
+
#
|
4031
4052
|
# @note DocumentContent is a union - when making an API calls you must set exactly one of the members.
|
4032
4053
|
#
|
4033
4054
|
# @!attribute [rw] blob
|
@@ -4797,6 +4818,72 @@ module Aws::QBusiness
|
|
4797
4818
|
include Aws::Structure
|
4798
4819
|
end
|
4799
4820
|
|
4821
|
+
# @!attribute [rw] application_id
|
4822
|
+
# The unique identifier of the Amazon Q Business application
|
4823
|
+
# containing the document. This ensures the request is scoped to the
|
4824
|
+
# correct application environment and its associated security
|
4825
|
+
# policies.
|
4826
|
+
# @return [String]
|
4827
|
+
#
|
4828
|
+
# @!attribute [rw] index_id
|
4829
|
+
# The identifier of the index where documents are indexed.
|
4830
|
+
# @return [String]
|
4831
|
+
#
|
4832
|
+
# @!attribute [rw] data_source_id
|
4833
|
+
# The identifier of the data source from which the document was
|
4834
|
+
# ingested. This field is not present if the document is ingested by
|
4835
|
+
# directly calling the BatchPutDocument API. If the document is from a
|
4836
|
+
# file-upload data source, the datasource will be
|
4837
|
+
# "uploaded-docs-file-stat-datasourceid".
|
4838
|
+
# @return [String]
|
4839
|
+
#
|
4840
|
+
# @!attribute [rw] document_id
|
4841
|
+
# The unique identifier of the document that is indexed via
|
4842
|
+
# BatchPutDocument API or file-upload or connector sync. It is also
|
4843
|
+
# found in chat or chatSync response.
|
4844
|
+
# @return [String]
|
4845
|
+
#
|
4846
|
+
# @!attribute [rw] output_format
|
4847
|
+
# Document outputFormat. Defaults to RAW if not selected.
|
4848
|
+
# @return [String]
|
4849
|
+
#
|
4850
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/GetDocumentContentRequest AWS API Documentation
|
4851
|
+
#
|
4852
|
+
class GetDocumentContentRequest < Struct.new(
|
4853
|
+
:application_id,
|
4854
|
+
:index_id,
|
4855
|
+
:data_source_id,
|
4856
|
+
:document_id,
|
4857
|
+
:output_format)
|
4858
|
+
SENSITIVE = []
|
4859
|
+
include Aws::Structure
|
4860
|
+
end
|
4861
|
+
|
4862
|
+
# @!attribute [rw] presigned_url
|
4863
|
+
# A pre-signed URL that provides temporary access to download the
|
4864
|
+
# document content directly from Amazon Q Business. The URL expires
|
4865
|
+
# after 5 minutes for security purposes. This URL is generated only
|
4866
|
+
# after successful ACL validation.
|
4867
|
+
# @return [String]
|
4868
|
+
#
|
4869
|
+
# @!attribute [rw] mime_type
|
4870
|
+
# The MIME type of the document content. When outputFormat is RAW,
|
4871
|
+
# this corresponds to the original document's MIME type (e.g.,
|
4872
|
+
# application/pdf, text/plain,
|
4873
|
+
# application/vnd.openxmlformats-officedocument.wordprocessingml.document).
|
4874
|
+
# When outputFormat is EXTRACTED, the MIME type is always
|
4875
|
+
# application/json.
|
4876
|
+
# @return [String]
|
4877
|
+
#
|
4878
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/GetDocumentContentResponse AWS API Documentation
|
4879
|
+
#
|
4880
|
+
class GetDocumentContentResponse < Struct.new(
|
4881
|
+
:presigned_url,
|
4882
|
+
:mime_type)
|
4883
|
+
SENSITIVE = []
|
4884
|
+
include Aws::Structure
|
4885
|
+
end
|
4886
|
+
|
4800
4887
|
# @!attribute [rw] application_id
|
4801
4888
|
# The identifier of the application id the group is attached to.
|
4802
4889
|
# @return [String]
|
@@ -8018,6 +8105,29 @@ module Aws::QBusiness
|
|
8018
8105
|
# attribution.
|
8019
8106
|
# @return [Array<Types::TextSegment>]
|
8020
8107
|
#
|
8108
|
+
# @!attribute [rw] document_id
|
8109
|
+
# The unique identifier of the source document used in the citation,
|
8110
|
+
# obtained from the Amazon Q Business index during chat response
|
8111
|
+
# generation. This ID is used as input to the `GetDocumentContent` API
|
8112
|
+
# to retrieve the actual document content for user verification.
|
8113
|
+
# @return [String]
|
8114
|
+
#
|
8115
|
+
# @!attribute [rw] index_id
|
8116
|
+
# The identifier of the index containing the source document's
|
8117
|
+
# metadata and access control information. This links the citation
|
8118
|
+
# back to the specific Amazon Q Business index where the document's
|
8119
|
+
# searchable content and permissions are stored.
|
8120
|
+
# @return [String]
|
8121
|
+
#
|
8122
|
+
# @!attribute [rw] datasource_id
|
8123
|
+
# The identifier of the data source from which the document was
|
8124
|
+
# ingested. This field is not present if the document is ingested by
|
8125
|
+
# directly calling the BatchPutDocument API (similar to
|
8126
|
+
# checkDocumentAccess). If the document is from a file-upload data
|
8127
|
+
# source, the datasource will be
|
8128
|
+
# "uploaded-docs-file-stat-datasourceid".
|
8129
|
+
# @return [String]
|
8130
|
+
#
|
8021
8131
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/SourceAttribution AWS API Documentation
|
8022
8132
|
#
|
8023
8133
|
class SourceAttribution < Struct.new(
|
@@ -8026,7 +8136,10 @@ module Aws::QBusiness
|
|
8026
8136
|
:url,
|
8027
8137
|
:citation_number,
|
8028
8138
|
:updated_at,
|
8029
|
-
:text_message_segments
|
8139
|
+
:text_message_segments,
|
8140
|
+
:document_id,
|
8141
|
+
:index_id,
|
8142
|
+
:datasource_id)
|
8030
8143
|
SENSITIVE = []
|
8031
8144
|
include Aws::Structure
|
8032
8145
|
end
|
data/lib/aws-sdk-qbusiness.rb
CHANGED
data/sig/client.rbs
CHANGED
@@ -1141,6 +1141,21 @@ module Aws
|
|
1141
1141
|
) -> _GetDataSourceResponseSuccess
|
1142
1142
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetDataSourceResponseSuccess
|
1143
1143
|
|
1144
|
+
interface _GetDocumentContentResponseSuccess
|
1145
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::GetDocumentContentResponse]
|
1146
|
+
def presigned_url: () -> ::String
|
1147
|
+
def mime_type: () -> ::String
|
1148
|
+
end
|
1149
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QBusiness/Client.html#get_document_content-instance_method
|
1150
|
+
def get_document_content: (
|
1151
|
+
application_id: ::String,
|
1152
|
+
index_id: ::String,
|
1153
|
+
?data_source_id: ::String,
|
1154
|
+
document_id: ::String,
|
1155
|
+
?output_format: ("RAW" | "EXTRACTED")
|
1156
|
+
) -> _GetDocumentContentResponseSuccess
|
1157
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetDocumentContentResponseSuccess
|
1158
|
+
|
1144
1159
|
interface _GetGroupResponseSuccess
|
1145
1160
|
include ::Seahorse::Client::_ResponseSuccess[Types::GetGroupResponse]
|
1146
1161
|
def status: () -> Types::GroupStatusDetail
|
data/sig/types.rbs
CHANGED
@@ -1201,6 +1201,21 @@ module Aws::QBusiness
|
|
1201
1201
|
SENSITIVE: []
|
1202
1202
|
end
|
1203
1203
|
|
1204
|
+
class GetDocumentContentRequest
|
1205
|
+
attr_accessor application_id: ::String
|
1206
|
+
attr_accessor index_id: ::String
|
1207
|
+
attr_accessor data_source_id: ::String
|
1208
|
+
attr_accessor document_id: ::String
|
1209
|
+
attr_accessor output_format: ("RAW" | "EXTRACTED")
|
1210
|
+
SENSITIVE: []
|
1211
|
+
end
|
1212
|
+
|
1213
|
+
class GetDocumentContentResponse
|
1214
|
+
attr_accessor presigned_url: ::String
|
1215
|
+
attr_accessor mime_type: ::String
|
1216
|
+
SENSITIVE: []
|
1217
|
+
end
|
1218
|
+
|
1204
1219
|
class GetGroupRequest
|
1205
1220
|
attr_accessor application_id: ::String
|
1206
1221
|
attr_accessor index_id: ::String
|
@@ -2056,6 +2071,9 @@ module Aws::QBusiness
|
|
2056
2071
|
attr_accessor citation_number: ::Integer
|
2057
2072
|
attr_accessor updated_at: ::Time
|
2058
2073
|
attr_accessor text_message_segments: ::Array[Types::TextSegment]
|
2074
|
+
attr_accessor document_id: ::String
|
2075
|
+
attr_accessor index_id: ::String
|
2076
|
+
attr_accessor datasource_id: ::String
|
2059
2077
|
SENSITIVE: []
|
2060
2078
|
end
|
2061
2079
|
|