@aws-sdk/client-qbusiness 3.858.0 → 3.862.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.
- package/README.md +8 -0
- package/dist-cjs/index.js +57 -0
- package/dist-es/QBusiness.js +2 -0
- package/dist-es/commands/GetDocumentContentCommand.js +22 -0
- package/dist-es/commands/index.js +1 -0
- package/dist-es/models/models_1.js +3 -0
- package/dist-es/protocols/Aws_restJson1.js +34 -0
- package/dist-types/QBusiness.d.ts +7 -0
- package/dist-types/QBusinessClient.d.ts +3 -2
- package/dist-types/commands/ChatCommand.d.ts +3 -0
- package/dist-types/commands/ChatSyncCommand.d.ts +3 -0
- package/dist-types/commands/CreateSubscriptionCommand.d.ts +1 -1
- package/dist-types/commands/GetDocumentContentCommand.d.ts +92 -0
- package/dist-types/commands/ListMessagesCommand.d.ts +3 -0
- package/dist-types/commands/index.d.ts +1 -0
- package/dist-types/models/models_0.d.ts +16 -1
- package/dist-types/models/models_1.d.ts +56 -0
- package/dist-types/protocols/Aws_restJson1.d.ts +9 -0
- package/dist-types/ts3.4/QBusiness.d.ts +17 -0
- package/dist-types/ts3.4/QBusinessClient.d.ts +6 -0
- package/dist-types/ts3.4/commands/GetDocumentContentCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/index.d.ts +1 -0
- package/dist-types/ts3.4/models/models_0.d.ts +3 -0
- package/dist-types/ts3.4/models/models_1.d.ts +15 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +12 -0
- package/package.json +38 -38
package/README.md
CHANGED
|
@@ -498,6 +498,14 @@ GetDataSource
|
|
|
498
498
|
|
|
499
499
|
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/qbusiness/command/GetDataSourceCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-qbusiness/Interface/GetDataSourceCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-qbusiness/Interface/GetDataSourceCommandOutput/)
|
|
500
500
|
|
|
501
|
+
</details>
|
|
502
|
+
<details>
|
|
503
|
+
<summary>
|
|
504
|
+
GetDocumentContent
|
|
505
|
+
</summary>
|
|
506
|
+
|
|
507
|
+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/qbusiness/command/GetDocumentContentCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-qbusiness/Interface/GetDocumentContentCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-qbusiness/Interface/GetDocumentContentCommandOutput/)
|
|
508
|
+
|
|
501
509
|
</details>
|
|
502
510
|
<details>
|
|
503
511
|
<summary>
|
package/dist-cjs/index.js
CHANGED
|
@@ -107,6 +107,7 @@ __export(index_exports, {
|
|
|
107
107
|
GetDataAccessorCommand: () => GetDataAccessorCommand,
|
|
108
108
|
GetDataAccessorResponseFilterSensitiveLog: () => GetDataAccessorResponseFilterSensitiveLog,
|
|
109
109
|
GetDataSourceCommand: () => GetDataSourceCommand,
|
|
110
|
+
GetDocumentContentCommand: () => GetDocumentContentCommand,
|
|
110
111
|
GetGroupCommand: () => GetGroupCommand,
|
|
111
112
|
GetIndexCommand: () => GetIndexCommand,
|
|
112
113
|
GetMediaCommand: () => GetMediaCommand,
|
|
@@ -153,6 +154,7 @@ __export(index_exports, {
|
|
|
153
154
|
MessageUsefulnessReason: () => MessageUsefulnessReason,
|
|
154
155
|
NumberAttributeBoostingType: () => NumberAttributeBoostingType,
|
|
155
156
|
OrchestrationControl: () => OrchestrationControl,
|
|
157
|
+
OutputFormat: () => OutputFormat,
|
|
156
158
|
PermissionConditionOperator: () => PermissionConditionOperator,
|
|
157
159
|
PersonalizationControlMode: () => PersonalizationControlMode,
|
|
158
160
|
PluginAuthConfiguration: () => PluginAuthConfiguration,
|
|
@@ -1134,6 +1136,9 @@ var ChatOutputFilterSensitiveLog = /* @__PURE__ */ __name((obj) => ({
|
|
|
1134
1136
|
|
|
1135
1137
|
// src/models/models_1.ts
|
|
1136
1138
|
|
|
1139
|
+
var OutputFormat = {
|
|
1140
|
+
RAW: "RAW"
|
|
1141
|
+
};
|
|
1137
1142
|
var GroupStatus = {
|
|
1138
1143
|
DELETED: "DELETED",
|
|
1139
1144
|
DELETING: "DELETING",
|
|
@@ -1814,6 +1819,21 @@ var se_GetDataSourceCommand = /* @__PURE__ */ __name(async (input, context) => {
|
|
|
1814
1819
|
b.m("GET").h(headers).b(body);
|
|
1815
1820
|
return b.build();
|
|
1816
1821
|
}, "se_GetDataSourceCommand");
|
|
1822
|
+
var se_GetDocumentContentCommand = /* @__PURE__ */ __name(async (input, context) => {
|
|
1823
|
+
const b = (0, import_core.requestBuilder)(input, context);
|
|
1824
|
+
const headers = {};
|
|
1825
|
+
b.bp("/applications/{applicationId}/index/{indexId}/documents/{documentId}/content");
|
|
1826
|
+
b.p("applicationId", () => input.applicationId, "{applicationId}", false);
|
|
1827
|
+
b.p("indexId", () => input.indexId, "{indexId}", false);
|
|
1828
|
+
b.p("documentId", () => input.documentId, "{documentId}", false);
|
|
1829
|
+
const query = (0, import_smithy_client.map)({
|
|
1830
|
+
[_dSI]: [, input[_dSI]],
|
|
1831
|
+
[_oF]: [, input[_oF]]
|
|
1832
|
+
});
|
|
1833
|
+
let body;
|
|
1834
|
+
b.m("GET").h(headers).q(query).b(body);
|
|
1835
|
+
return b.build();
|
|
1836
|
+
}, "se_GetDocumentContentCommand");
|
|
1817
1837
|
var se_GetGroupCommand = /* @__PURE__ */ __name(async (input, context) => {
|
|
1818
1838
|
const b = (0, import_core.requestBuilder)(input, context);
|
|
1819
1839
|
const headers = {};
|
|
@@ -3037,6 +3057,21 @@ var de_GetDataSourceCommand = /* @__PURE__ */ __name(async (output, context) =>
|
|
|
3037
3057
|
Object.assign(contents, doc);
|
|
3038
3058
|
return contents;
|
|
3039
3059
|
}, "de_GetDataSourceCommand");
|
|
3060
|
+
var de_GetDocumentContentCommand = /* @__PURE__ */ __name(async (output, context) => {
|
|
3061
|
+
if (output.statusCode !== 200 && output.statusCode >= 300) {
|
|
3062
|
+
return de_CommandError(output, context);
|
|
3063
|
+
}
|
|
3064
|
+
const contents = (0, import_smithy_client.map)({
|
|
3065
|
+
$metadata: deserializeMetadata(output)
|
|
3066
|
+
});
|
|
3067
|
+
const data = (0, import_smithy_client.expectNonNull)((0, import_smithy_client.expectObject)(await (0, import_core2.parseJsonBody)(output.body, context)), "body");
|
|
3068
|
+
const doc = (0, import_smithy_client.take)(data, {
|
|
3069
|
+
mimeType: import_smithy_client.expectString,
|
|
3070
|
+
presignedUrl: import_smithy_client.expectString
|
|
3071
|
+
});
|
|
3072
|
+
Object.assign(contents, doc);
|
|
3073
|
+
return contents;
|
|
3074
|
+
}, "de_GetDocumentContentCommand");
|
|
3040
3075
|
var de_GetGroupCommand = /* @__PURE__ */ __name(async (output, context) => {
|
|
3041
3076
|
if (output.statusCode !== 200 && output.statusCode >= 300) {
|
|
3042
3077
|
return de_CommandError(output, context);
|
|
@@ -4627,6 +4662,9 @@ var de_RelevantContentList = /* @__PURE__ */ __name((output, context) => {
|
|
|
4627
4662
|
var de_SourceAttribution = /* @__PURE__ */ __name((output, context) => {
|
|
4628
4663
|
return (0, import_smithy_client.take)(output, {
|
|
4629
4664
|
citationNumber: import_smithy_client.expectInt32,
|
|
4665
|
+
datasourceId: import_smithy_client.expectString,
|
|
4666
|
+
documentId: import_smithy_client.expectString,
|
|
4667
|
+
indexId: import_smithy_client.expectString,
|
|
4630
4668
|
snippet: import_smithy_client.expectString,
|
|
4631
4669
|
textMessageSegments: import_smithy_client._json,
|
|
4632
4670
|
title: import_smithy_client.expectString,
|
|
@@ -4671,6 +4709,7 @@ var _dSIa = "dataSourceIds";
|
|
|
4671
4709
|
var _eT = "endTime";
|
|
4672
4710
|
var _mR = "maxResults";
|
|
4673
4711
|
var _nT = "nextToken";
|
|
4712
|
+
var _oF = "outputFormat";
|
|
4674
4713
|
var _pMI = "parentMessageId";
|
|
4675
4714
|
var _s = "sync";
|
|
4676
4715
|
var _sF = "statusFilter";
|
|
@@ -5243,6 +5282,21 @@ var GetDataSourceCommand = class extends import_smithy_client.Command.classBuild
|
|
|
5243
5282
|
}
|
|
5244
5283
|
};
|
|
5245
5284
|
|
|
5285
|
+
// src/commands/GetDocumentContentCommand.ts
|
|
5286
|
+
|
|
5287
|
+
|
|
5288
|
+
|
|
5289
|
+
var GetDocumentContentCommand = class extends import_smithy_client.Command.classBuilder().ep(commonParams).m(function(Command, cs, config, o) {
|
|
5290
|
+
return [
|
|
5291
|
+
(0, import_middleware_serde.getSerdePlugin)(config, this.serialize, this.deserialize),
|
|
5292
|
+
(0, import_middleware_endpoint.getEndpointPlugin)(config, Command.getEndpointParameterInstructions())
|
|
5293
|
+
];
|
|
5294
|
+
}).s("ExpertQ", "GetDocumentContent", {}).n("QBusinessClient", "GetDocumentContentCommand").f(void 0, void 0).ser(se_GetDocumentContentCommand).de(de_GetDocumentContentCommand).build() {
|
|
5295
|
+
static {
|
|
5296
|
+
__name(this, "GetDocumentContentCommand");
|
|
5297
|
+
}
|
|
5298
|
+
};
|
|
5299
|
+
|
|
5246
5300
|
// src/commands/GetGroupCommand.ts
|
|
5247
5301
|
|
|
5248
5302
|
|
|
@@ -5957,6 +6011,7 @@ var commands = {
|
|
|
5957
6011
|
GetChatResponseConfigurationCommand,
|
|
5958
6012
|
GetDataAccessorCommand,
|
|
5959
6013
|
GetDataSourceCommand,
|
|
6014
|
+
GetDocumentContentCommand,
|
|
5960
6015
|
GetGroupCommand,
|
|
5961
6016
|
GetIndexCommand,
|
|
5962
6017
|
GetMediaCommand,
|
|
@@ -6134,6 +6189,7 @@ var paginateSearchRelevantContent = (0, import_core.createPaginator)(QBusinessCl
|
|
|
6134
6189
|
GetChatResponseConfigurationCommand,
|
|
6135
6190
|
GetDataAccessorCommand,
|
|
6136
6191
|
GetDataSourceCommand,
|
|
6192
|
+
GetDocumentContentCommand,
|
|
6137
6193
|
GetGroupCommand,
|
|
6138
6194
|
GetIndexCommand,
|
|
6139
6195
|
GetMediaCommand,
|
|
@@ -6290,6 +6346,7 @@ var paginateSearchRelevantContent = (0, import_core.createPaginator)(QBusinessCl
|
|
|
6290
6346
|
UpdatePluginRequestFilterSensitiveLog,
|
|
6291
6347
|
ChatOutputStreamFilterSensitiveLog,
|
|
6292
6348
|
ChatOutputFilterSensitiveLog,
|
|
6349
|
+
OutputFormat,
|
|
6293
6350
|
GroupStatus,
|
|
6294
6351
|
MediaTooLargeException,
|
|
6295
6352
|
MessageType,
|
package/dist-es/QBusiness.js
CHANGED
|
@@ -36,6 +36,7 @@ import { GetChatControlsConfigurationCommand, } from "./commands/GetChatControls
|
|
|
36
36
|
import { GetChatResponseConfigurationCommand, } from "./commands/GetChatResponseConfigurationCommand";
|
|
37
37
|
import { GetDataAccessorCommand, } from "./commands/GetDataAccessorCommand";
|
|
38
38
|
import { GetDataSourceCommand, } from "./commands/GetDataSourceCommand";
|
|
39
|
+
import { GetDocumentContentCommand, } from "./commands/GetDocumentContentCommand";
|
|
39
40
|
import { GetGroupCommand } from "./commands/GetGroupCommand";
|
|
40
41
|
import { GetIndexCommand } from "./commands/GetIndexCommand";
|
|
41
42
|
import { GetMediaCommand } from "./commands/GetMediaCommand";
|
|
@@ -120,6 +121,7 @@ const commands = {
|
|
|
120
121
|
GetChatResponseConfigurationCommand,
|
|
121
122
|
GetDataAccessorCommand,
|
|
122
123
|
GetDataSourceCommand,
|
|
124
|
+
GetDocumentContentCommand,
|
|
123
125
|
GetGroupCommand,
|
|
124
126
|
GetIndexCommand,
|
|
125
127
|
GetMediaCommand,
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
import { getEndpointPlugin } from "@smithy/middleware-endpoint";
|
|
2
|
+
import { getSerdePlugin } from "@smithy/middleware-serde";
|
|
3
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
4
|
+
import { commonParams } from "../endpoint/EndpointParameters";
|
|
5
|
+
import { de_GetDocumentContentCommand, se_GetDocumentContentCommand } from "../protocols/Aws_restJson1";
|
|
6
|
+
export { $Command };
|
|
7
|
+
export class GetDocumentContentCommand extends $Command
|
|
8
|
+
.classBuilder()
|
|
9
|
+
.ep(commonParams)
|
|
10
|
+
.m(function (Command, cs, config, o) {
|
|
11
|
+
return [
|
|
12
|
+
getSerdePlugin(config, this.serialize, this.deserialize),
|
|
13
|
+
getEndpointPlugin(config, Command.getEndpointParameterInstructions()),
|
|
14
|
+
];
|
|
15
|
+
})
|
|
16
|
+
.s("ExpertQ", "GetDocumentContent", {})
|
|
17
|
+
.n("QBusinessClient", "GetDocumentContentCommand")
|
|
18
|
+
.f(void 0, void 0)
|
|
19
|
+
.ser(se_GetDocumentContentCommand)
|
|
20
|
+
.de(de_GetDocumentContentCommand)
|
|
21
|
+
.build() {
|
|
22
|
+
}
|
|
@@ -35,6 +35,7 @@ export * from "./GetChatControlsConfigurationCommand";
|
|
|
35
35
|
export * from "./GetChatResponseConfigurationCommand";
|
|
36
36
|
export * from "./GetDataAccessorCommand";
|
|
37
37
|
export * from "./GetDataSourceCommand";
|
|
38
|
+
export * from "./GetDocumentContentCommand";
|
|
38
39
|
export * from "./GetGroupCommand";
|
|
39
40
|
export * from "./GetIndexCommand";
|
|
40
41
|
export * from "./GetMediaCommand";
|
|
@@ -1,5 +1,8 @@
|
|
|
1
1
|
import { SENSITIVE_STRING } from "@smithy/smithy-client";
|
|
2
2
|
import { QBusinessServiceException as __BaseException } from "./QBusinessServiceException";
|
|
3
|
+
export const OutputFormat = {
|
|
4
|
+
RAW: "RAW",
|
|
5
|
+
};
|
|
3
6
|
export const GroupStatus = {
|
|
4
7
|
DELETED: "DELETED",
|
|
5
8
|
DELETING: "DELETING",
|
|
@@ -547,6 +547,21 @@ export const se_GetDataSourceCommand = async (input, context) => {
|
|
|
547
547
|
b.m("GET").h(headers).b(body);
|
|
548
548
|
return b.build();
|
|
549
549
|
};
|
|
550
|
+
export const se_GetDocumentContentCommand = async (input, context) => {
|
|
551
|
+
const b = rb(input, context);
|
|
552
|
+
const headers = {};
|
|
553
|
+
b.bp("/applications/{applicationId}/index/{indexId}/documents/{documentId}/content");
|
|
554
|
+
b.p("applicationId", () => input.applicationId, "{applicationId}", false);
|
|
555
|
+
b.p("indexId", () => input.indexId, "{indexId}", false);
|
|
556
|
+
b.p("documentId", () => input.documentId, "{documentId}", false);
|
|
557
|
+
const query = map({
|
|
558
|
+
[_dSI]: [, input[_dSI]],
|
|
559
|
+
[_oF]: [, input[_oF]],
|
|
560
|
+
});
|
|
561
|
+
let body;
|
|
562
|
+
b.m("GET").h(headers).q(query).b(body);
|
|
563
|
+
return b.build();
|
|
564
|
+
};
|
|
550
565
|
export const se_GetGroupCommand = async (input, context) => {
|
|
551
566
|
const b = rb(input, context);
|
|
552
567
|
const headers = {};
|
|
@@ -1740,6 +1755,21 @@ export const de_GetDataSourceCommand = async (output, context) => {
|
|
|
1740
1755
|
Object.assign(contents, doc);
|
|
1741
1756
|
return contents;
|
|
1742
1757
|
};
|
|
1758
|
+
export const de_GetDocumentContentCommand = async (output, context) => {
|
|
1759
|
+
if (output.statusCode !== 200 && output.statusCode >= 300) {
|
|
1760
|
+
return de_CommandError(output, context);
|
|
1761
|
+
}
|
|
1762
|
+
const contents = map({
|
|
1763
|
+
$metadata: deserializeMetadata(output),
|
|
1764
|
+
});
|
|
1765
|
+
const data = __expectNonNull(__expectObject(await parseBody(output.body, context)), "body");
|
|
1766
|
+
const doc = take(data, {
|
|
1767
|
+
mimeType: __expectString,
|
|
1768
|
+
presignedUrl: __expectString,
|
|
1769
|
+
});
|
|
1770
|
+
Object.assign(contents, doc);
|
|
1771
|
+
return contents;
|
|
1772
|
+
};
|
|
1743
1773
|
export const de_GetGroupCommand = async (output, context) => {
|
|
1744
1774
|
if (output.statusCode !== 200 && output.statusCode >= 300) {
|
|
1745
1775
|
return de_CommandError(output, context);
|
|
@@ -3372,6 +3402,9 @@ const de_RelevantContentList = (output, context) => {
|
|
|
3372
3402
|
const de_SourceAttribution = (output, context) => {
|
|
3373
3403
|
return take(output, {
|
|
3374
3404
|
citationNumber: __expectInt32,
|
|
3405
|
+
datasourceId: __expectString,
|
|
3406
|
+
documentId: __expectString,
|
|
3407
|
+
indexId: __expectString,
|
|
3375
3408
|
snippet: __expectString,
|
|
3376
3409
|
textMessageSegments: _json,
|
|
3377
3410
|
title: __expectString,
|
|
@@ -3419,6 +3452,7 @@ const _dSIa = "dataSourceIds";
|
|
|
3419
3452
|
const _eT = "endTime";
|
|
3420
3453
|
const _mR = "maxResults";
|
|
3421
3454
|
const _nT = "nextToken";
|
|
3455
|
+
const _oF = "outputFormat";
|
|
3422
3456
|
const _pMI = "parentMessageId";
|
|
3423
3457
|
const _s = "sync";
|
|
3424
3458
|
const _sF = "statusFilter";
|
|
@@ -36,6 +36,7 @@ import { GetChatControlsConfigurationCommandInput, GetChatControlsConfigurationC
|
|
|
36
36
|
import { GetChatResponseConfigurationCommandInput, GetChatResponseConfigurationCommandOutput } from "./commands/GetChatResponseConfigurationCommand";
|
|
37
37
|
import { GetDataAccessorCommandInput, GetDataAccessorCommandOutput } from "./commands/GetDataAccessorCommand";
|
|
38
38
|
import { GetDataSourceCommandInput, GetDataSourceCommandOutput } from "./commands/GetDataSourceCommand";
|
|
39
|
+
import { GetDocumentContentCommandInput, GetDocumentContentCommandOutput } from "./commands/GetDocumentContentCommand";
|
|
39
40
|
import { GetGroupCommandInput, GetGroupCommandOutput } from "./commands/GetGroupCommand";
|
|
40
41
|
import { GetIndexCommandInput, GetIndexCommandOutput } from "./commands/GetIndexCommand";
|
|
41
42
|
import { GetMediaCommandInput, GetMediaCommandOutput } from "./commands/GetMediaCommand";
|
|
@@ -305,6 +306,12 @@ export interface QBusiness {
|
|
|
305
306
|
getDataSource(args: GetDataSourceCommandInput, options?: __HttpHandlerOptions): Promise<GetDataSourceCommandOutput>;
|
|
306
307
|
getDataSource(args: GetDataSourceCommandInput, cb: (err: any, data?: GetDataSourceCommandOutput) => void): void;
|
|
307
308
|
getDataSource(args: GetDataSourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDataSourceCommandOutput) => void): void;
|
|
309
|
+
/**
|
|
310
|
+
* @see {@link GetDocumentContentCommand}
|
|
311
|
+
*/
|
|
312
|
+
getDocumentContent(args: GetDocumentContentCommandInput, options?: __HttpHandlerOptions): Promise<GetDocumentContentCommandOutput>;
|
|
313
|
+
getDocumentContent(args: GetDocumentContentCommandInput, cb: (err: any, data?: GetDocumentContentCommandOutput) => void): void;
|
|
314
|
+
getDocumentContent(args: GetDocumentContentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDocumentContentCommandOutput) => void): void;
|
|
308
315
|
/**
|
|
309
316
|
* @see {@link GetGroupCommand}
|
|
310
317
|
*/
|
|
@@ -47,6 +47,7 @@ import { GetChatControlsConfigurationCommandInput, GetChatControlsConfigurationC
|
|
|
47
47
|
import { GetChatResponseConfigurationCommandInput, GetChatResponseConfigurationCommandOutput } from "./commands/GetChatResponseConfigurationCommand";
|
|
48
48
|
import { GetDataAccessorCommandInput, GetDataAccessorCommandOutput } from "./commands/GetDataAccessorCommand";
|
|
49
49
|
import { GetDataSourceCommandInput, GetDataSourceCommandOutput } from "./commands/GetDataSourceCommand";
|
|
50
|
+
import { GetDocumentContentCommandInput, GetDocumentContentCommandOutput } from "./commands/GetDocumentContentCommand";
|
|
50
51
|
import { GetGroupCommandInput, GetGroupCommandOutput } from "./commands/GetGroupCommand";
|
|
51
52
|
import { GetIndexCommandInput, GetIndexCommandOutput } from "./commands/GetIndexCommand";
|
|
52
53
|
import { GetMediaCommandInput, GetMediaCommandOutput } from "./commands/GetMediaCommand";
|
|
@@ -98,11 +99,11 @@ export { __Client };
|
|
|
98
99
|
/**
|
|
99
100
|
* @public
|
|
100
101
|
*/
|
|
101
|
-
export type ServiceInputTypes = AssociatePermissionCommandInput | BatchDeleteDocumentCommandInput | BatchPutDocumentCommandInput | CancelSubscriptionCommandInput | ChatCommandInput | ChatSyncCommandInput | CheckDocumentAccessCommandInput | CreateAnonymousWebExperienceUrlCommandInput | CreateApplicationCommandInput | CreateChatResponseConfigurationCommandInput | CreateDataAccessorCommandInput | CreateDataSourceCommandInput | CreateIndexCommandInput | CreatePluginCommandInput | CreateRetrieverCommandInput | CreateSubscriptionCommandInput | CreateUserCommandInput | CreateWebExperienceCommandInput | DeleteApplicationCommandInput | DeleteAttachmentCommandInput | DeleteChatControlsConfigurationCommandInput | DeleteChatResponseConfigurationCommandInput | DeleteConversationCommandInput | DeleteDataAccessorCommandInput | DeleteDataSourceCommandInput | DeleteGroupCommandInput | DeleteIndexCommandInput | DeletePluginCommandInput | DeleteRetrieverCommandInput | DeleteUserCommandInput | DeleteWebExperienceCommandInput | DisassociatePermissionCommandInput | GetApplicationCommandInput | GetChatControlsConfigurationCommandInput | GetChatResponseConfigurationCommandInput | GetDataAccessorCommandInput | GetDataSourceCommandInput | GetGroupCommandInput | GetIndexCommandInput | GetMediaCommandInput | GetPluginCommandInput | GetPolicyCommandInput | GetRetrieverCommandInput | GetUserCommandInput | GetWebExperienceCommandInput | ListApplicationsCommandInput | ListAttachmentsCommandInput | ListChatResponseConfigurationsCommandInput | ListConversationsCommandInput | ListDataAccessorsCommandInput | ListDataSourceSyncJobsCommandInput | ListDataSourcesCommandInput | ListDocumentsCommandInput | ListGroupsCommandInput | ListIndicesCommandInput | ListMessagesCommandInput | ListPluginActionsCommandInput | ListPluginTypeActionsCommandInput | ListPluginTypeMetadataCommandInput | ListPluginsCommandInput | ListRetrieversCommandInput | ListSubscriptionsCommandInput | ListTagsForResourceCommandInput | ListWebExperiencesCommandInput | PutFeedbackCommandInput | PutGroupCommandInput | SearchRelevantContentCommandInput | StartDataSourceSyncJobCommandInput | StopDataSourceSyncJobCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateApplicationCommandInput | UpdateChatControlsConfigurationCommandInput | UpdateChatResponseConfigurationCommandInput | UpdateDataAccessorCommandInput | UpdateDataSourceCommandInput | UpdateIndexCommandInput | UpdatePluginCommandInput | UpdateRetrieverCommandInput | UpdateSubscriptionCommandInput | UpdateUserCommandInput | UpdateWebExperienceCommandInput;
|
|
102
|
+
export type ServiceInputTypes = AssociatePermissionCommandInput | BatchDeleteDocumentCommandInput | BatchPutDocumentCommandInput | CancelSubscriptionCommandInput | ChatCommandInput | ChatSyncCommandInput | CheckDocumentAccessCommandInput | CreateAnonymousWebExperienceUrlCommandInput | CreateApplicationCommandInput | CreateChatResponseConfigurationCommandInput | CreateDataAccessorCommandInput | CreateDataSourceCommandInput | CreateIndexCommandInput | CreatePluginCommandInput | CreateRetrieverCommandInput | CreateSubscriptionCommandInput | CreateUserCommandInput | CreateWebExperienceCommandInput | DeleteApplicationCommandInput | DeleteAttachmentCommandInput | DeleteChatControlsConfigurationCommandInput | DeleteChatResponseConfigurationCommandInput | DeleteConversationCommandInput | DeleteDataAccessorCommandInput | DeleteDataSourceCommandInput | DeleteGroupCommandInput | DeleteIndexCommandInput | DeletePluginCommandInput | DeleteRetrieverCommandInput | DeleteUserCommandInput | DeleteWebExperienceCommandInput | DisassociatePermissionCommandInput | GetApplicationCommandInput | GetChatControlsConfigurationCommandInput | GetChatResponseConfigurationCommandInput | GetDataAccessorCommandInput | GetDataSourceCommandInput | GetDocumentContentCommandInput | GetGroupCommandInput | GetIndexCommandInput | GetMediaCommandInput | GetPluginCommandInput | GetPolicyCommandInput | GetRetrieverCommandInput | GetUserCommandInput | GetWebExperienceCommandInput | ListApplicationsCommandInput | ListAttachmentsCommandInput | ListChatResponseConfigurationsCommandInput | ListConversationsCommandInput | ListDataAccessorsCommandInput | ListDataSourceSyncJobsCommandInput | ListDataSourcesCommandInput | ListDocumentsCommandInput | ListGroupsCommandInput | ListIndicesCommandInput | ListMessagesCommandInput | ListPluginActionsCommandInput | ListPluginTypeActionsCommandInput | ListPluginTypeMetadataCommandInput | ListPluginsCommandInput | ListRetrieversCommandInput | ListSubscriptionsCommandInput | ListTagsForResourceCommandInput | ListWebExperiencesCommandInput | PutFeedbackCommandInput | PutGroupCommandInput | SearchRelevantContentCommandInput | StartDataSourceSyncJobCommandInput | StopDataSourceSyncJobCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateApplicationCommandInput | UpdateChatControlsConfigurationCommandInput | UpdateChatResponseConfigurationCommandInput | UpdateDataAccessorCommandInput | UpdateDataSourceCommandInput | UpdateIndexCommandInput | UpdatePluginCommandInput | UpdateRetrieverCommandInput | UpdateSubscriptionCommandInput | UpdateUserCommandInput | UpdateWebExperienceCommandInput;
|
|
102
103
|
/**
|
|
103
104
|
* @public
|
|
104
105
|
*/
|
|
105
|
-
export type ServiceOutputTypes = AssociatePermissionCommandOutput | BatchDeleteDocumentCommandOutput | BatchPutDocumentCommandOutput | CancelSubscriptionCommandOutput | ChatCommandOutput | ChatSyncCommandOutput | CheckDocumentAccessCommandOutput | CreateAnonymousWebExperienceUrlCommandOutput | CreateApplicationCommandOutput | CreateChatResponseConfigurationCommandOutput | CreateDataAccessorCommandOutput | CreateDataSourceCommandOutput | CreateIndexCommandOutput | CreatePluginCommandOutput | CreateRetrieverCommandOutput | CreateSubscriptionCommandOutput | CreateUserCommandOutput | CreateWebExperienceCommandOutput | DeleteApplicationCommandOutput | DeleteAttachmentCommandOutput | DeleteChatControlsConfigurationCommandOutput | DeleteChatResponseConfigurationCommandOutput | DeleteConversationCommandOutput | DeleteDataAccessorCommandOutput | DeleteDataSourceCommandOutput | DeleteGroupCommandOutput | DeleteIndexCommandOutput | DeletePluginCommandOutput | DeleteRetrieverCommandOutput | DeleteUserCommandOutput | DeleteWebExperienceCommandOutput | DisassociatePermissionCommandOutput | GetApplicationCommandOutput | GetChatControlsConfigurationCommandOutput | GetChatResponseConfigurationCommandOutput | GetDataAccessorCommandOutput | GetDataSourceCommandOutput | GetGroupCommandOutput | GetIndexCommandOutput | GetMediaCommandOutput | GetPluginCommandOutput | GetPolicyCommandOutput | GetRetrieverCommandOutput | GetUserCommandOutput | GetWebExperienceCommandOutput | ListApplicationsCommandOutput | ListAttachmentsCommandOutput | ListChatResponseConfigurationsCommandOutput | ListConversationsCommandOutput | ListDataAccessorsCommandOutput | ListDataSourceSyncJobsCommandOutput | ListDataSourcesCommandOutput | ListDocumentsCommandOutput | ListGroupsCommandOutput | ListIndicesCommandOutput | ListMessagesCommandOutput | ListPluginActionsCommandOutput | ListPluginTypeActionsCommandOutput | ListPluginTypeMetadataCommandOutput | ListPluginsCommandOutput | ListRetrieversCommandOutput | ListSubscriptionsCommandOutput | ListTagsForResourceCommandOutput | ListWebExperiencesCommandOutput | PutFeedbackCommandOutput | PutGroupCommandOutput | SearchRelevantContentCommandOutput | StartDataSourceSyncJobCommandOutput | StopDataSourceSyncJobCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateApplicationCommandOutput | UpdateChatControlsConfigurationCommandOutput | UpdateChatResponseConfigurationCommandOutput | UpdateDataAccessorCommandOutput | UpdateDataSourceCommandOutput | UpdateIndexCommandOutput | UpdatePluginCommandOutput | UpdateRetrieverCommandOutput | UpdateSubscriptionCommandOutput | UpdateUserCommandOutput | UpdateWebExperienceCommandOutput;
|
|
106
|
+
export type ServiceOutputTypes = AssociatePermissionCommandOutput | BatchDeleteDocumentCommandOutput | BatchPutDocumentCommandOutput | CancelSubscriptionCommandOutput | ChatCommandOutput | ChatSyncCommandOutput | CheckDocumentAccessCommandOutput | CreateAnonymousWebExperienceUrlCommandOutput | CreateApplicationCommandOutput | CreateChatResponseConfigurationCommandOutput | CreateDataAccessorCommandOutput | CreateDataSourceCommandOutput | CreateIndexCommandOutput | CreatePluginCommandOutput | CreateRetrieverCommandOutput | CreateSubscriptionCommandOutput | CreateUserCommandOutput | CreateWebExperienceCommandOutput | DeleteApplicationCommandOutput | DeleteAttachmentCommandOutput | DeleteChatControlsConfigurationCommandOutput | DeleteChatResponseConfigurationCommandOutput | DeleteConversationCommandOutput | DeleteDataAccessorCommandOutput | DeleteDataSourceCommandOutput | DeleteGroupCommandOutput | DeleteIndexCommandOutput | DeletePluginCommandOutput | DeleteRetrieverCommandOutput | DeleteUserCommandOutput | DeleteWebExperienceCommandOutput | DisassociatePermissionCommandOutput | GetApplicationCommandOutput | GetChatControlsConfigurationCommandOutput | GetChatResponseConfigurationCommandOutput | GetDataAccessorCommandOutput | GetDataSourceCommandOutput | GetDocumentContentCommandOutput | GetGroupCommandOutput | GetIndexCommandOutput | GetMediaCommandOutput | GetPluginCommandOutput | GetPolicyCommandOutput | GetRetrieverCommandOutput | GetUserCommandOutput | GetWebExperienceCommandOutput | ListApplicationsCommandOutput | ListAttachmentsCommandOutput | ListChatResponseConfigurationsCommandOutput | ListConversationsCommandOutput | ListDataAccessorsCommandOutput | ListDataSourceSyncJobsCommandOutput | ListDataSourcesCommandOutput | ListDocumentsCommandOutput | ListGroupsCommandOutput | ListIndicesCommandOutput | ListMessagesCommandOutput | ListPluginActionsCommandOutput | ListPluginTypeActionsCommandOutput | ListPluginTypeMetadataCommandOutput | ListPluginsCommandOutput | ListRetrieversCommandOutput | ListSubscriptionsCommandOutput | ListTagsForResourceCommandOutput | ListWebExperiencesCommandOutput | PutFeedbackCommandOutput | PutGroupCommandOutput | SearchRelevantContentCommandOutput | StartDataSourceSyncJobCommandOutput | StopDataSourceSyncJobCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateApplicationCommandOutput | UpdateChatControlsConfigurationCommandOutput | UpdateChatResponseConfigurationCommandOutput | UpdateDataAccessorCommandOutput | UpdateDataSourceCommandOutput | UpdateIndexCommandOutput | UpdatePluginCommandOutput | UpdateRetrieverCommandOutput | UpdateSubscriptionCommandOutput | UpdateUserCommandOutput | UpdateWebExperienceCommandOutput;
|
|
106
107
|
/**
|
|
107
108
|
* @public
|
|
108
109
|
*/
|
|
@@ -230,6 +230,9 @@ declare const ChatSyncCommand_base: {
|
|
|
230
230
|
* // },
|
|
231
231
|
* // },
|
|
232
232
|
* // ],
|
|
233
|
+
* // documentId: "STRING_VALUE",
|
|
234
|
+
* // indexId: "STRING_VALUE",
|
|
235
|
+
* // datasourceId: "STRING_VALUE",
|
|
233
236
|
* // },
|
|
234
237
|
* // ],
|
|
235
238
|
* // failedAttachments: [ // AttachmentsOutput
|
|
@@ -27,7 +27,7 @@ declare const CreateSubscriptionCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Subscribes an IAM Identity Center user or a group to a pricing tier for an Amazon Q Business application.</p> <p>Amazon Q Business offers two subscription tiers: <code>Q_LITE</code> and <code>Q_BUSINESS</code>. Subscription tier determines feature access for the user. For more information on subscriptions and pricing tiers, see <a href="https://aws.amazon.com/q/business/pricing/">Amazon Q Business pricing</a>.</p>
|
|
30
|
+
* <p>Subscribes an IAM Identity Center user or a group to a pricing tier for an Amazon Q Business application.</p> <p>Amazon Q Business offers two subscription tiers: <code>Q_LITE</code> and <code>Q_BUSINESS</code>. Subscription tier determines feature access for the user. For more information on subscriptions and pricing tiers, see <a href="https://aws.amazon.com/q/business/pricing/">Amazon Q Business pricing</a>.</p> <note> <p>For an example IAM role policy for assigning subscriptions, see <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/setting-up.html#permissions">Set up required permissions</a> in the Amazon Q Business User Guide.</p> </note>
|
|
31
31
|
* @example
|
|
32
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
33
|
* ```javascript
|
|
@@ -0,0 +1,92 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { GetDocumentContentRequest, GetDocumentContentResponse } from "../models/models_1";
|
|
4
|
+
import { QBusinessClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QBusinessClient";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link GetDocumentContentCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetDocumentContentCommandInput extends GetDocumentContentRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetDocumentContentCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetDocumentContentCommandOutput extends GetDocumentContentResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const GetDocumentContentCommand_base: {
|
|
25
|
+
new (input: GetDocumentContentCommandInput): import("@smithy/smithy-client").CommandImpl<GetDocumentContentCommandInput, GetDocumentContentCommandOutput, QBusinessClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: GetDocumentContentCommandInput): import("@smithy/smithy-client").CommandImpl<GetDocumentContentCommandInput, GetDocumentContentCommandOutput, QBusinessClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Retrieves the content of a document that was ingested into Amazon Q Business. This API validates user authorization against document ACLs before returning a pre-signed URL for secure document access. You can download or view source documents referenced in chat responses through the URL.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { QBusinessClient, GetDocumentContentCommand } from "@aws-sdk/client-qbusiness"; // ES Modules import
|
|
35
|
+
* // const { QBusinessClient, GetDocumentContentCommand } = require("@aws-sdk/client-qbusiness"); // CommonJS import
|
|
36
|
+
* const client = new QBusinessClient(config);
|
|
37
|
+
* const input = { // GetDocumentContentRequest
|
|
38
|
+
* applicationId: "STRING_VALUE", // required
|
|
39
|
+
* indexId: "STRING_VALUE", // required
|
|
40
|
+
* dataSourceId: "STRING_VALUE",
|
|
41
|
+
* documentId: "STRING_VALUE", // required
|
|
42
|
+
* outputFormat: "RAW",
|
|
43
|
+
* };
|
|
44
|
+
* const command = new GetDocumentContentCommand(input);
|
|
45
|
+
* const response = await client.send(command);
|
|
46
|
+
* // { // GetDocumentContentResponse
|
|
47
|
+
* // presignedUrl: "STRING_VALUE", // required
|
|
48
|
+
* // mimeType: "STRING_VALUE", // required
|
|
49
|
+
* // };
|
|
50
|
+
*
|
|
51
|
+
* ```
|
|
52
|
+
*
|
|
53
|
+
* @param GetDocumentContentCommandInput - {@link GetDocumentContentCommandInput}
|
|
54
|
+
* @returns {@link GetDocumentContentCommandOutput}
|
|
55
|
+
* @see {@link GetDocumentContentCommandInput} for command's `input` shape.
|
|
56
|
+
* @see {@link GetDocumentContentCommandOutput} for command's `response` shape.
|
|
57
|
+
* @see {@link QBusinessClientResolvedConfig | config} for QBusinessClient's `config` shape.
|
|
58
|
+
*
|
|
59
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
60
|
+
* <p> You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.</p>
|
|
61
|
+
*
|
|
62
|
+
* @throws {@link InternalServerException} (server fault)
|
|
63
|
+
* <p>An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
|
|
64
|
+
*
|
|
65
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
66
|
+
* <p>The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.</p>
|
|
67
|
+
*
|
|
68
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
69
|
+
* <p>The request was denied due to throttling. Reduce the number of requests and try again.</p>
|
|
70
|
+
*
|
|
71
|
+
* @throws {@link ValidationException} (client fault)
|
|
72
|
+
* <p>The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.</p>
|
|
73
|
+
*
|
|
74
|
+
* @throws {@link QBusinessServiceException}
|
|
75
|
+
* <p>Base exception class for all service exceptions from QBusiness service.</p>
|
|
76
|
+
*
|
|
77
|
+
*
|
|
78
|
+
* @public
|
|
79
|
+
*/
|
|
80
|
+
export declare class GetDocumentContentCommand extends GetDocumentContentCommand_base {
|
|
81
|
+
/** @internal type navigation helper, not in runtime. */
|
|
82
|
+
protected static __types: {
|
|
83
|
+
api: {
|
|
84
|
+
input: GetDocumentContentRequest;
|
|
85
|
+
output: GetDocumentContentResponse;
|
|
86
|
+
};
|
|
87
|
+
sdk: {
|
|
88
|
+
input: GetDocumentContentCommandInput;
|
|
89
|
+
output: GetDocumentContentCommandOutput;
|
|
90
|
+
};
|
|
91
|
+
};
|
|
92
|
+
}
|
|
@@ -100,6 +100,9 @@ declare const ListMessagesCommand_base: {
|
|
|
100
100
|
* // },
|
|
101
101
|
* // },
|
|
102
102
|
* // ],
|
|
103
|
+
* // documentId: "STRING_VALUE",
|
|
104
|
+
* // indexId: "STRING_VALUE",
|
|
105
|
+
* // datasourceId: "STRING_VALUE",
|
|
103
106
|
* // },
|
|
104
107
|
* // ],
|
|
105
108
|
* // actionReview: { // ActionReview
|
|
@@ -35,6 +35,7 @@ export * from "./GetChatControlsConfigurationCommand";
|
|
|
35
35
|
export * from "./GetChatResponseConfigurationCommand";
|
|
36
36
|
export * from "./GetDataAccessorCommand";
|
|
37
37
|
export * from "./GetDataSourceCommand";
|
|
38
|
+
export * from "./GetDocumentContentCommand";
|
|
38
39
|
export * from "./GetGroupCommand";
|
|
39
40
|
export * from "./GetIndexCommand";
|
|
40
41
|
export * from "./GetMediaCommand";
|
|
@@ -4534,7 +4534,7 @@ export interface BatchDeleteDocumentResponse {
|
|
|
4534
4534
|
failedDocuments?: FailedDocument[] | undefined;
|
|
4535
4535
|
}
|
|
4536
4536
|
/**
|
|
4537
|
-
* <p>The contents of a document.</p>
|
|
4537
|
+
* <p>The contents of a document.</p> <note> <p>Documents have size limitations. The maximum file size for a document is 50 MB. The maximum amount of text that can be extracted from a single document is 5 MB. For more information, see <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/doc-types.html">Supported document formats in Amazon Q Business</a>.</p> </note>
|
|
4538
4538
|
* @public
|
|
4539
4539
|
*/
|
|
4540
4540
|
export type DocumentContent = DocumentContent.BlobMember | DocumentContent.S3Member | DocumentContent.$UnknownMember;
|
|
@@ -5064,6 +5064,21 @@ export interface SourceAttribution {
|
|
|
5064
5064
|
* @public
|
|
5065
5065
|
*/
|
|
5066
5066
|
textMessageSegments?: TextSegment[] | undefined;
|
|
5067
|
+
/**
|
|
5068
|
+
* <p>The unique identifier of the source document used in the citation, obtained from the Amazon Q Business index during chat response generation. This ID is used as input to the <code>GetDocumentContent</code> API to retrieve the actual document content for user verification.</p>
|
|
5069
|
+
* @public
|
|
5070
|
+
*/
|
|
5071
|
+
documentId?: string | undefined;
|
|
5072
|
+
/**
|
|
5073
|
+
* <p>The identifier of the index containing the source document's metadata and access control information. This links the citation back to the specific Amazon Q Business index where the document's searchable content and permissions are stored.</p>
|
|
5074
|
+
* @public
|
|
5075
|
+
*/
|
|
5076
|
+
indexId?: string | undefined;
|
|
5077
|
+
/**
|
|
5078
|
+
* <p>The identifier of the data source from which the document was ingested. This field is not present if the document is ingested by directly calling the BatchPutDocument API (similar to checkDocumentAccess). If the document is from a file-upload data source, the datasource will be "uploaded-docs-file-stat-datasourceid".</p>
|
|
5079
|
+
* @public
|
|
5080
|
+
*/
|
|
5081
|
+
datasourceId?: string | undefined;
|
|
5067
5082
|
}
|
|
5068
5083
|
/**
|
|
5069
5084
|
* <p>A metadata event for a AI-generated text output message in a Amazon Q Business conversation, containing associated metadata generated.</p>
|
|
@@ -51,6 +51,62 @@ export interface GetChatResponseConfigurationResponse {
|
|
|
51
51
|
*/
|
|
52
52
|
lastUpdateConfiguration?: ChatResponseConfigurationDetail | undefined;
|
|
53
53
|
}
|
|
54
|
+
/**
|
|
55
|
+
* @public
|
|
56
|
+
* @enum
|
|
57
|
+
*/
|
|
58
|
+
export declare const OutputFormat: {
|
|
59
|
+
readonly RAW: "RAW";
|
|
60
|
+
};
|
|
61
|
+
/**
|
|
62
|
+
* @public
|
|
63
|
+
*/
|
|
64
|
+
export type OutputFormat = (typeof OutputFormat)[keyof typeof OutputFormat];
|
|
65
|
+
/**
|
|
66
|
+
* @public
|
|
67
|
+
*/
|
|
68
|
+
export interface GetDocumentContentRequest {
|
|
69
|
+
/**
|
|
70
|
+
* <p>The unique identifier of the Amazon Q Business application containing the document. This ensures the request is scoped to the correct application environment and its associated security policies.</p>
|
|
71
|
+
* @public
|
|
72
|
+
*/
|
|
73
|
+
applicationId: string | undefined;
|
|
74
|
+
/**
|
|
75
|
+
* <p>The identifier of the index where documents are indexed.</p>
|
|
76
|
+
* @public
|
|
77
|
+
*/
|
|
78
|
+
indexId: string | undefined;
|
|
79
|
+
/**
|
|
80
|
+
* <p>The identifier of the data source from which the document was ingested. This field is not present if the document is ingested by directly calling the BatchPutDocument API. If the document is from a file-upload data source, the datasource will be "uploaded-docs-file-stat-datasourceid".</p>
|
|
81
|
+
* @public
|
|
82
|
+
*/
|
|
83
|
+
dataSourceId?: string | undefined;
|
|
84
|
+
/**
|
|
85
|
+
* <p>The unique identifier of the document that is indexed via BatchPutDocument API or file-upload or connector sync. It is also found in chat or chatSync response.</p>
|
|
86
|
+
* @public
|
|
87
|
+
*/
|
|
88
|
+
documentId: string | undefined;
|
|
89
|
+
/**
|
|
90
|
+
* <p>Raw document outputFormat.</p>
|
|
91
|
+
* @public
|
|
92
|
+
*/
|
|
93
|
+
outputFormat?: OutputFormat | undefined;
|
|
94
|
+
}
|
|
95
|
+
/**
|
|
96
|
+
* @public
|
|
97
|
+
*/
|
|
98
|
+
export interface GetDocumentContentResponse {
|
|
99
|
+
/**
|
|
100
|
+
* <p>A pre-signed URL that provides temporary access to download the document content directly from Amazon Q Business. The URL expires after 5 minutes for security purposes. This URL is generated only after successful ACL validation.</p>
|
|
101
|
+
* @public
|
|
102
|
+
*/
|
|
103
|
+
presignedUrl: string | undefined;
|
|
104
|
+
/**
|
|
105
|
+
* <p>The MIME type of the document content (e.g., application/pdf, text/plain, application/vnd.openxmlformats-officedocument.wordprocessingml.document).</p>
|
|
106
|
+
* @public
|
|
107
|
+
*/
|
|
108
|
+
mimeType: string | undefined;
|
|
109
|
+
}
|
|
54
110
|
/**
|
|
55
111
|
* @public
|
|
56
112
|
*/
|
|
@@ -37,6 +37,7 @@ import { GetChatControlsConfigurationCommandInput, GetChatControlsConfigurationC
|
|
|
37
37
|
import { GetChatResponseConfigurationCommandInput, GetChatResponseConfigurationCommandOutput } from "../commands/GetChatResponseConfigurationCommand";
|
|
38
38
|
import { GetDataAccessorCommandInput, GetDataAccessorCommandOutput } from "../commands/GetDataAccessorCommand";
|
|
39
39
|
import { GetDataSourceCommandInput, GetDataSourceCommandOutput } from "../commands/GetDataSourceCommand";
|
|
40
|
+
import { GetDocumentContentCommandInput, GetDocumentContentCommandOutput } from "../commands/GetDocumentContentCommand";
|
|
40
41
|
import { GetGroupCommandInput, GetGroupCommandOutput } from "../commands/GetGroupCommand";
|
|
41
42
|
import { GetIndexCommandInput, GetIndexCommandOutput } from "../commands/GetIndexCommand";
|
|
42
43
|
import { GetMediaCommandInput, GetMediaCommandOutput } from "../commands/GetMediaCommand";
|
|
@@ -230,6 +231,10 @@ export declare const se_GetDataAccessorCommand: (input: GetDataAccessorCommandIn
|
|
|
230
231
|
* serializeAws_restJson1GetDataSourceCommand
|
|
231
232
|
*/
|
|
232
233
|
export declare const se_GetDataSourceCommand: (input: GetDataSourceCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
234
|
+
/**
|
|
235
|
+
* serializeAws_restJson1GetDocumentContentCommand
|
|
236
|
+
*/
|
|
237
|
+
export declare const se_GetDocumentContentCommand: (input: GetDocumentContentCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
233
238
|
/**
|
|
234
239
|
* serializeAws_restJson1GetGroupCommand
|
|
235
240
|
*/
|
|
@@ -558,6 +563,10 @@ export declare const de_GetDataAccessorCommand: (output: __HttpResponse, context
|
|
|
558
563
|
* deserializeAws_restJson1GetDataSourceCommand
|
|
559
564
|
*/
|
|
560
565
|
export declare const de_GetDataSourceCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<GetDataSourceCommandOutput>;
|
|
566
|
+
/**
|
|
567
|
+
* deserializeAws_restJson1GetDocumentContentCommand
|
|
568
|
+
*/
|
|
569
|
+
export declare const de_GetDocumentContentCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<GetDocumentContentCommandOutput>;
|
|
561
570
|
/**
|
|
562
571
|
* deserializeAws_restJson1GetGroupCommand
|
|
563
572
|
*/
|
|
@@ -144,6 +144,10 @@ import {
|
|
|
144
144
|
GetDataSourceCommandInput,
|
|
145
145
|
GetDataSourceCommandOutput,
|
|
146
146
|
} from "./commands/GetDataSourceCommand";
|
|
147
|
+
import {
|
|
148
|
+
GetDocumentContentCommandInput,
|
|
149
|
+
GetDocumentContentCommandOutput,
|
|
150
|
+
} from "./commands/GetDocumentContentCommand";
|
|
147
151
|
import {
|
|
148
152
|
GetGroupCommandInput,
|
|
149
153
|
GetGroupCommandOutput,
|
|
@@ -807,6 +811,19 @@ export interface QBusiness {
|
|
|
807
811
|
options: __HttpHandlerOptions,
|
|
808
812
|
cb: (err: any, data?: GetDataSourceCommandOutput) => void
|
|
809
813
|
): void;
|
|
814
|
+
getDocumentContent(
|
|
815
|
+
args: GetDocumentContentCommandInput,
|
|
816
|
+
options?: __HttpHandlerOptions
|
|
817
|
+
): Promise<GetDocumentContentCommandOutput>;
|
|
818
|
+
getDocumentContent(
|
|
819
|
+
args: GetDocumentContentCommandInput,
|
|
820
|
+
cb: (err: any, data?: GetDocumentContentCommandOutput) => void
|
|
821
|
+
): void;
|
|
822
|
+
getDocumentContent(
|
|
823
|
+
args: GetDocumentContentCommandInput,
|
|
824
|
+
options: __HttpHandlerOptions,
|
|
825
|
+
cb: (err: any, data?: GetDocumentContentCommandOutput) => void
|
|
826
|
+
): void;
|
|
810
827
|
getGroup(
|
|
811
828
|
args: GetGroupCommandInput,
|
|
812
829
|
options?: __HttpHandlerOptions
|
|
@@ -200,6 +200,10 @@ import {
|
|
|
200
200
|
GetDataSourceCommandInput,
|
|
201
201
|
GetDataSourceCommandOutput,
|
|
202
202
|
} from "./commands/GetDataSourceCommand";
|
|
203
|
+
import {
|
|
204
|
+
GetDocumentContentCommandInput,
|
|
205
|
+
GetDocumentContentCommandOutput,
|
|
206
|
+
} from "./commands/GetDocumentContentCommand";
|
|
203
207
|
import {
|
|
204
208
|
GetGroupCommandInput,
|
|
205
209
|
GetGroupCommandOutput,
|
|
@@ -425,6 +429,7 @@ export type ServiceInputTypes =
|
|
|
425
429
|
| GetChatResponseConfigurationCommandInput
|
|
426
430
|
| GetDataAccessorCommandInput
|
|
427
431
|
| GetDataSourceCommandInput
|
|
432
|
+
| GetDocumentContentCommandInput
|
|
428
433
|
| GetGroupCommandInput
|
|
429
434
|
| GetIndexCommandInput
|
|
430
435
|
| GetMediaCommandInput
|
|
@@ -508,6 +513,7 @@ export type ServiceOutputTypes =
|
|
|
508
513
|
| GetChatResponseConfigurationCommandOutput
|
|
509
514
|
| GetDataAccessorCommandOutput
|
|
510
515
|
| GetDataSourceCommandOutput
|
|
516
|
+
| GetDocumentContentCommandOutput
|
|
511
517
|
| GetGroupCommandOutput
|
|
512
518
|
| GetIndexCommandOutput
|
|
513
519
|
| GetMediaCommandOutput
|
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import {
|
|
4
|
+
GetDocumentContentRequest,
|
|
5
|
+
GetDocumentContentResponse,
|
|
6
|
+
} from "../models/models_1";
|
|
7
|
+
import {
|
|
8
|
+
QBusinessClientResolvedConfig,
|
|
9
|
+
ServiceInputTypes,
|
|
10
|
+
ServiceOutputTypes,
|
|
11
|
+
} from "../QBusinessClient";
|
|
12
|
+
export { __MetadataBearer };
|
|
13
|
+
export { $Command };
|
|
14
|
+
export interface GetDocumentContentCommandInput
|
|
15
|
+
extends GetDocumentContentRequest {}
|
|
16
|
+
export interface GetDocumentContentCommandOutput
|
|
17
|
+
extends GetDocumentContentResponse,
|
|
18
|
+
__MetadataBearer {}
|
|
19
|
+
declare const GetDocumentContentCommand_base: {
|
|
20
|
+
new (
|
|
21
|
+
input: GetDocumentContentCommandInput
|
|
22
|
+
): import("@smithy/smithy-client").CommandImpl<
|
|
23
|
+
GetDocumentContentCommandInput,
|
|
24
|
+
GetDocumentContentCommandOutput,
|
|
25
|
+
QBusinessClientResolvedConfig,
|
|
26
|
+
ServiceInputTypes,
|
|
27
|
+
ServiceOutputTypes
|
|
28
|
+
>;
|
|
29
|
+
new (
|
|
30
|
+
input: GetDocumentContentCommandInput
|
|
31
|
+
): import("@smithy/smithy-client").CommandImpl<
|
|
32
|
+
GetDocumentContentCommandInput,
|
|
33
|
+
GetDocumentContentCommandOutput,
|
|
34
|
+
QBusinessClientResolvedConfig,
|
|
35
|
+
ServiceInputTypes,
|
|
36
|
+
ServiceOutputTypes
|
|
37
|
+
>;
|
|
38
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
39
|
+
};
|
|
40
|
+
export declare class GetDocumentContentCommand extends GetDocumentContentCommand_base {
|
|
41
|
+
protected static __types: {
|
|
42
|
+
api: {
|
|
43
|
+
input: GetDocumentContentRequest;
|
|
44
|
+
output: GetDocumentContentResponse;
|
|
45
|
+
};
|
|
46
|
+
sdk: {
|
|
47
|
+
input: GetDocumentContentCommandInput;
|
|
48
|
+
output: GetDocumentContentCommandOutput;
|
|
49
|
+
};
|
|
50
|
+
};
|
|
51
|
+
}
|
|
@@ -35,6 +35,7 @@ export * from "./GetChatControlsConfigurationCommand";
|
|
|
35
35
|
export * from "./GetChatResponseConfigurationCommand";
|
|
36
36
|
export * from "./GetDataAccessorCommand";
|
|
37
37
|
export * from "./GetDataSourceCommand";
|
|
38
|
+
export * from "./GetDocumentContentCommand";
|
|
38
39
|
export * from "./GetGroupCommand";
|
|
39
40
|
export * from "./GetIndexCommand";
|
|
40
41
|
export * from "./GetMediaCommand";
|
|
@@ -1690,6 +1690,9 @@ export interface SourceAttribution {
|
|
|
1690
1690
|
citationNumber?: number | undefined;
|
|
1691
1691
|
updatedAt?: Date | undefined;
|
|
1692
1692
|
textMessageSegments?: TextSegment[] | undefined;
|
|
1693
|
+
documentId?: string | undefined;
|
|
1694
|
+
indexId?: string | undefined;
|
|
1695
|
+
datasourceId?: string | undefined;
|
|
1693
1696
|
}
|
|
1694
1697
|
export interface MetadataEvent {
|
|
1695
1698
|
conversationId?: string | undefined;
|
|
@@ -55,6 +55,21 @@ export interface GetChatResponseConfigurationResponse {
|
|
|
55
55
|
inUseConfiguration?: ChatResponseConfigurationDetail | undefined;
|
|
56
56
|
lastUpdateConfiguration?: ChatResponseConfigurationDetail | undefined;
|
|
57
57
|
}
|
|
58
|
+
export declare const OutputFormat: {
|
|
59
|
+
readonly RAW: "RAW";
|
|
60
|
+
};
|
|
61
|
+
export type OutputFormat = (typeof OutputFormat)[keyof typeof OutputFormat];
|
|
62
|
+
export interface GetDocumentContentRequest {
|
|
63
|
+
applicationId: string | undefined;
|
|
64
|
+
indexId: string | undefined;
|
|
65
|
+
dataSourceId?: string | undefined;
|
|
66
|
+
documentId: string | undefined;
|
|
67
|
+
outputFormat?: OutputFormat | undefined;
|
|
68
|
+
}
|
|
69
|
+
export interface GetDocumentContentResponse {
|
|
70
|
+
presignedUrl: string | undefined;
|
|
71
|
+
mimeType: string | undefined;
|
|
72
|
+
}
|
|
58
73
|
export interface GetGroupRequest {
|
|
59
74
|
applicationId: string | undefined;
|
|
60
75
|
indexId: string | undefined;
|
|
@@ -151,6 +151,10 @@ import {
|
|
|
151
151
|
GetDataSourceCommandInput,
|
|
152
152
|
GetDataSourceCommandOutput,
|
|
153
153
|
} from "../commands/GetDataSourceCommand";
|
|
154
|
+
import {
|
|
155
|
+
GetDocumentContentCommandInput,
|
|
156
|
+
GetDocumentContentCommandOutput,
|
|
157
|
+
} from "../commands/GetDocumentContentCommand";
|
|
154
158
|
import {
|
|
155
159
|
GetGroupCommandInput,
|
|
156
160
|
GetGroupCommandOutput,
|
|
@@ -479,6 +483,10 @@ export declare const se_GetDataSourceCommand: (
|
|
|
479
483
|
input: GetDataSourceCommandInput,
|
|
480
484
|
context: __SerdeContext
|
|
481
485
|
) => Promise<__HttpRequest>;
|
|
486
|
+
export declare const se_GetDocumentContentCommand: (
|
|
487
|
+
input: GetDocumentContentCommandInput,
|
|
488
|
+
context: __SerdeContext
|
|
489
|
+
) => Promise<__HttpRequest>;
|
|
482
490
|
export declare const se_GetGroupCommand: (
|
|
483
491
|
input: GetGroupCommandInput,
|
|
484
492
|
context: __SerdeContext
|
|
@@ -807,6 +815,10 @@ export declare const de_GetDataSourceCommand: (
|
|
|
807
815
|
output: __HttpResponse,
|
|
808
816
|
context: __SerdeContext
|
|
809
817
|
) => Promise<GetDataSourceCommandOutput>;
|
|
818
|
+
export declare const de_GetDocumentContentCommand: (
|
|
819
|
+
output: __HttpResponse,
|
|
820
|
+
context: __SerdeContext
|
|
821
|
+
) => Promise<GetDocumentContentCommandOutput>;
|
|
810
822
|
export declare const de_GetGroupCommand: (
|
|
811
823
|
output: __HttpResponse,
|
|
812
824
|
context: __SerdeContext
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@aws-sdk/client-qbusiness",
|
|
3
3
|
"description": "AWS SDK for JavaScript Qbusiness Client for Node.js, Browser and React Native",
|
|
4
|
-
"version": "3.
|
|
4
|
+
"version": "3.862.0",
|
|
5
5
|
"scripts": {
|
|
6
6
|
"build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
|
|
7
7
|
"build:cjs": "node ../../scripts/compilation/inline client-qbusiness",
|
|
@@ -20,46 +20,46 @@
|
|
|
20
20
|
"dependencies": {
|
|
21
21
|
"@aws-crypto/sha256-browser": "5.2.0",
|
|
22
22
|
"@aws-crypto/sha256-js": "5.2.0",
|
|
23
|
-
"@aws-sdk/core": "3.
|
|
24
|
-
"@aws-sdk/credential-provider-node": "3.
|
|
25
|
-
"@aws-sdk/eventstream-handler-node": "3.
|
|
26
|
-
"@aws-sdk/middleware-eventstream": "3.
|
|
27
|
-
"@aws-sdk/middleware-host-header": "3.
|
|
28
|
-
"@aws-sdk/middleware-logger": "3.
|
|
29
|
-
"@aws-sdk/middleware-recursion-detection": "3.
|
|
30
|
-
"@aws-sdk/middleware-user-agent": "3.
|
|
31
|
-
"@aws-sdk/region-config-resolver": "3.
|
|
32
|
-
"@aws-sdk/types": "3.
|
|
33
|
-
"@aws-sdk/util-endpoints": "3.
|
|
34
|
-
"@aws-sdk/util-user-agent-browser": "3.
|
|
35
|
-
"@aws-sdk/util-user-agent-node": "3.
|
|
36
|
-
"@smithy/config-resolver": "^4.1.
|
|
37
|
-
"@smithy/core": "^3.
|
|
38
|
-
"@smithy/eventstream-serde-browser": "^4.0.
|
|
39
|
-
"@smithy/eventstream-serde-config-resolver": "^4.1.
|
|
40
|
-
"@smithy/eventstream-serde-node": "^4.0.
|
|
41
|
-
"@smithy/fetch-http-handler": "^5.1.
|
|
42
|
-
"@smithy/hash-node": "^4.0.
|
|
43
|
-
"@smithy/invalid-dependency": "^4.0.
|
|
44
|
-
"@smithy/middleware-content-length": "^4.0.
|
|
45
|
-
"@smithy/middleware-endpoint": "^4.1.
|
|
46
|
-
"@smithy/middleware-retry": "^4.1.
|
|
47
|
-
"@smithy/middleware-serde": "^4.0.
|
|
48
|
-
"@smithy/middleware-stack": "^4.0.
|
|
49
|
-
"@smithy/node-config-provider": "^4.1.
|
|
50
|
-
"@smithy/node-http-handler": "^4.1.
|
|
51
|
-
"@smithy/protocol-http": "^5.1.
|
|
52
|
-
"@smithy/smithy-client": "^4.4.
|
|
53
|
-
"@smithy/types": "^4.3.
|
|
54
|
-
"@smithy/url-parser": "^4.0.
|
|
23
|
+
"@aws-sdk/core": "3.862.0",
|
|
24
|
+
"@aws-sdk/credential-provider-node": "3.862.0",
|
|
25
|
+
"@aws-sdk/eventstream-handler-node": "3.862.0",
|
|
26
|
+
"@aws-sdk/middleware-eventstream": "3.862.0",
|
|
27
|
+
"@aws-sdk/middleware-host-header": "3.862.0",
|
|
28
|
+
"@aws-sdk/middleware-logger": "3.862.0",
|
|
29
|
+
"@aws-sdk/middleware-recursion-detection": "3.862.0",
|
|
30
|
+
"@aws-sdk/middleware-user-agent": "3.862.0",
|
|
31
|
+
"@aws-sdk/region-config-resolver": "3.862.0",
|
|
32
|
+
"@aws-sdk/types": "3.862.0",
|
|
33
|
+
"@aws-sdk/util-endpoints": "3.862.0",
|
|
34
|
+
"@aws-sdk/util-user-agent-browser": "3.862.0",
|
|
35
|
+
"@aws-sdk/util-user-agent-node": "3.862.0",
|
|
36
|
+
"@smithy/config-resolver": "^4.1.5",
|
|
37
|
+
"@smithy/core": "^3.8.0",
|
|
38
|
+
"@smithy/eventstream-serde-browser": "^4.0.5",
|
|
39
|
+
"@smithy/eventstream-serde-config-resolver": "^4.1.3",
|
|
40
|
+
"@smithy/eventstream-serde-node": "^4.0.5",
|
|
41
|
+
"@smithy/fetch-http-handler": "^5.1.1",
|
|
42
|
+
"@smithy/hash-node": "^4.0.5",
|
|
43
|
+
"@smithy/invalid-dependency": "^4.0.5",
|
|
44
|
+
"@smithy/middleware-content-length": "^4.0.5",
|
|
45
|
+
"@smithy/middleware-endpoint": "^4.1.18",
|
|
46
|
+
"@smithy/middleware-retry": "^4.1.19",
|
|
47
|
+
"@smithy/middleware-serde": "^4.0.9",
|
|
48
|
+
"@smithy/middleware-stack": "^4.0.5",
|
|
49
|
+
"@smithy/node-config-provider": "^4.1.4",
|
|
50
|
+
"@smithy/node-http-handler": "^4.1.1",
|
|
51
|
+
"@smithy/protocol-http": "^5.1.3",
|
|
52
|
+
"@smithy/smithy-client": "^4.4.10",
|
|
53
|
+
"@smithy/types": "^4.3.2",
|
|
54
|
+
"@smithy/url-parser": "^4.0.5",
|
|
55
55
|
"@smithy/util-base64": "^4.0.0",
|
|
56
56
|
"@smithy/util-body-length-browser": "^4.0.0",
|
|
57
57
|
"@smithy/util-body-length-node": "^4.0.0",
|
|
58
|
-
"@smithy/util-defaults-mode-browser": "^4.0.
|
|
59
|
-
"@smithy/util-defaults-mode-node": "^4.0.
|
|
60
|
-
"@smithy/util-endpoints": "^3.0.
|
|
61
|
-
"@smithy/util-middleware": "^4.0.
|
|
62
|
-
"@smithy/util-retry": "^4.0.
|
|
58
|
+
"@smithy/util-defaults-mode-browser": "^4.0.26",
|
|
59
|
+
"@smithy/util-defaults-mode-node": "^4.0.26",
|
|
60
|
+
"@smithy/util-endpoints": "^3.0.7",
|
|
61
|
+
"@smithy/util-middleware": "^4.0.5",
|
|
62
|
+
"@smithy/util-retry": "^4.0.7",
|
|
63
63
|
"@smithy/util-utf8": "^4.0.0",
|
|
64
64
|
"@types/uuid": "^9.0.1",
|
|
65
65
|
"tslib": "^2.6.2",
|