@aws-sdk/client-qbusiness 3.741.0 → 3.742.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/dist-cjs/index.js CHANGED
@@ -139,6 +139,7 @@ __export(src_exports, {
139
139
  MessageUsefulness: () => MessageUsefulness,
140
140
  MessageUsefulnessReason: () => MessageUsefulnessReason,
141
141
  NumberAttributeBoostingType: () => NumberAttributeBoostingType,
142
+ OrchestrationControl: () => OrchestrationControl,
142
143
  PersonalizationControlMode: () => PersonalizationControlMode,
143
144
  PluginAuthConfiguration: () => PluginAuthConfiguration,
144
145
  PluginBuildStatus: () => PluginBuildStatus,
@@ -847,6 +848,10 @@ var CreatorModeControl = {
847
848
  DISABLED: "DISABLED",
848
849
  ENABLED: "ENABLED"
849
850
  };
851
+ var OrchestrationControl = {
852
+ DISABLED: "DISABLED",
853
+ ENABLED: "ENABLED"
854
+ };
850
855
  var CopyFromSource;
851
856
  ((CopyFromSource3) => {
852
857
  CopyFromSource3.visit = /* @__PURE__ */ __name((value, visitor) => {
@@ -2164,6 +2169,7 @@ var se_UpdateChatControlsConfigurationCommand = /* @__PURE__ */ __name(async (in
2164
2169
  blockedPhrasesConfigurationUpdate: (_) => (0, import_smithy_client._json)(_),
2165
2170
  clientToken: [true, (_) => _ ?? (0, import_uuid.v4)()],
2166
2171
  creatorModeConfiguration: (_) => (0, import_smithy_client._json)(_),
2172
+ orchestrationConfiguration: (_) => (0, import_smithy_client._json)(_),
2167
2173
  responseScope: [],
2168
2174
  topicConfigurationsToCreateOrUpdate: (_) => (0, import_smithy_client._json)(_),
2169
2175
  topicConfigurationsToDelete: (_) => (0, import_smithy_client._json)(_)
@@ -2724,6 +2730,7 @@ var de_GetChatControlsConfigurationCommand = /* @__PURE__ */ __name(async (outpu
2724
2730
  blockedPhrases: import_smithy_client._json,
2725
2731
  creatorModeConfiguration: import_smithy_client._json,
2726
2732
  nextToken: import_smithy_client.expectString,
2733
+ orchestrationConfiguration: import_smithy_client._json,
2727
2734
  responseScope: import_smithy_client.expectString,
2728
2735
  topicConfigurations: import_smithy_client._json
2729
2736
  });
@@ -5801,6 +5808,7 @@ var paginateSearchRelevantContent = (0, import_core.createPaginator)(QBusinessCl
5801
5808
  WebExperienceAuthConfiguration,
5802
5809
  WebExperienceStatus,
5803
5810
  CreatorModeControl,
5811
+ OrchestrationControl,
5804
5812
  CopyFromSource,
5805
5813
  AttachmentStatus,
5806
5814
  DocumentContent,
@@ -384,6 +384,10 @@ export const CreatorModeControl = {
384
384
  DISABLED: "DISABLED",
385
385
  ENABLED: "ENABLED",
386
386
  };
387
+ export const OrchestrationControl = {
388
+ DISABLED: "DISABLED",
389
+ ENABLED: "ENABLED",
390
+ };
387
391
  export var CopyFromSource;
388
392
  (function (CopyFromSource) {
389
393
  CopyFromSource.visit = (value, visitor) => {
@@ -935,6 +935,7 @@ export const se_UpdateChatControlsConfigurationCommand = async (input, context)
935
935
  blockedPhrasesConfigurationUpdate: (_) => _json(_),
936
936
  clientToken: [true, (_) => _ ?? generateIdempotencyToken()],
937
937
  creatorModeConfiguration: (_) => _json(_),
938
+ orchestrationConfiguration: (_) => _json(_),
938
939
  responseScope: [],
939
940
  topicConfigurationsToCreateOrUpdate: (_) => _json(_),
940
941
  topicConfigurationsToDelete: (_) => _json(_),
@@ -1478,6 +1479,7 @@ export const de_GetChatControlsConfigurationCommand = async (output, context) =>
1478
1479
  blockedPhrases: _json,
1479
1480
  creatorModeConfiguration: _json,
1480
1481
  nextToken: __expectString,
1482
+ orchestrationConfiguration: _json,
1481
1483
  responseScope: __expectString,
1482
1484
  topicConfigurations: _json,
1483
1485
  });
@@ -27,7 +27,7 @@ declare const GetChatControlsConfigurationCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Gets information about an chat controls configured for an existing Amazon Q Business
30
+ * <p>Gets information about chat controls configured for an existing Amazon Q Business
31
31
  * application.</p>
32
32
  * @example
33
33
  * Use a bare-bones client and the command you need to make an API call.
@@ -44,6 +44,9 @@ declare const GetChatControlsConfigurationCommand_base: {
44
44
  * const response = await client.send(command);
45
45
  * // { // GetChatControlsConfigurationResponse
46
46
  * // responseScope: "ENTERPRISE_CONTENT_ONLY" || "EXTENDED_KNOWLEDGE_ENABLED",
47
+ * // orchestrationConfiguration: { // AppliedOrchestrationConfiguration
48
+ * // control: "ENABLED" || "DISABLED", // required
49
+ * // },
47
50
  * // blockedPhrases: { // BlockedPhrasesConfiguration
48
51
  * // blockedPhrases: [ // BlockedPhrases
49
52
  * // "STRING_VALUE",
@@ -1,6 +1,6 @@
1
1
  import { Command as $Command } from "@smithy/smithy-client";
2
2
  import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
- import { PutFeedbackRequest } from "../models/models_0";
3
+ import { PutFeedbackRequest } from "../models/models_1";
4
4
  import { QBusinessClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QBusinessClient";
5
5
  /**
6
6
  * @public
@@ -27,7 +27,7 @@ declare const UpdateChatControlsConfigurationCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Updates an set of chat controls configured for an existing Amazon Q Business
30
+ * <p>Updates a set of chat controls configured for an existing Amazon Q Business
31
31
  * application.</p>
32
32
  * @example
33
33
  * Use a bare-bones client and the command you need to make an API call.
@@ -39,6 +39,9 @@ declare const UpdateChatControlsConfigurationCommand_base: {
39
39
  * applicationId: "STRING_VALUE", // required
40
40
  * clientToken: "STRING_VALUE",
41
41
  * responseScope: "ENTERPRISE_CONTENT_ONLY" || "EXTENDED_KNOWLEDGE_ENABLED",
42
+ * orchestrationConfiguration: { // OrchestrationConfiguration
43
+ * control: "ENABLED" || "DISABLED", // required
44
+ * },
42
45
  * blockedPhrasesConfigurationUpdate: { // BlockedPhrasesConfigurationUpdate
43
46
  * blockedPhrasesToCreateOrUpdate: [ // BlockedPhrases
44
47
  * "STRING_VALUE",
@@ -4453,6 +4453,33 @@ export interface AppliedCreatorModeConfiguration {
4453
4453
  */
4454
4454
  creatorModeControl: CreatorModeControl | undefined;
4455
4455
  }
4456
+ /**
4457
+ * @public
4458
+ * @enum
4459
+ */
4460
+ export declare const OrchestrationControl: {
4461
+ readonly DISABLED: "DISABLED";
4462
+ readonly ENABLED: "ENABLED";
4463
+ };
4464
+ /**
4465
+ * @public
4466
+ */
4467
+ export type OrchestrationControl = (typeof OrchestrationControl)[keyof typeof OrchestrationControl];
4468
+ /**
4469
+ * <p>The chat orchestration specific admin controls configured for an Amazon Q Business
4470
+ * application. Determines whether Amazon Q Business automatically routes chat requests across
4471
+ * configured plugins and data sources in your Amazon Q Business application.</p>
4472
+ * <p>For more information, see <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/guardrails-global-controls.html#guardrails-global-orchestration">Chat orchestration settings</a>.</p>
4473
+ * @public
4474
+ */
4475
+ export interface AppliedOrchestrationConfiguration {
4476
+ /**
4477
+ * <p> Information about whether chat orchestration is enabled or disabled for an
4478
+ * Amazon Q Business application. </p>
4479
+ * @public
4480
+ */
4481
+ control: OrchestrationControl | undefined;
4482
+ }
4456
4483
  /**
4457
4484
  * @public
4458
4485
  */
@@ -6185,6 +6212,15 @@ export interface GetChatControlsConfigurationResponse {
6185
6212
  * @public
6186
6213
  */
6187
6214
  responseScope?: ResponseScope | undefined;
6215
+ /**
6216
+ * <p> The chat response orchestration settings for your application.</p>
6217
+ * <note>
6218
+ * <p>Chat orchestration is optimized to work for English language content. For more
6219
+ * details on language support in Amazon Q Business, see <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/supported-languages.html">Supported languages</a>.</p>
6220
+ * </note>
6221
+ * @public
6222
+ */
6223
+ orchestrationConfiguration?: AppliedOrchestrationConfiguration | undefined;
6188
6224
  /**
6189
6225
  * <p>The phrases blocked from chat by your chat control configuration.</p>
6190
6226
  * @public
@@ -7072,57 +7108,6 @@ export interface MessageUsefulnessFeedback {
7072
7108
  */
7073
7109
  submittedAt: Date | undefined;
7074
7110
  }
7075
- /**
7076
- * @public
7077
- */
7078
- export interface PutFeedbackRequest {
7079
- /**
7080
- * <p>The identifier of the application associated with the feedback.</p>
7081
- * @public
7082
- */
7083
- applicationId: string | undefined;
7084
- /**
7085
- * <p>The identifier of the user giving the feedback.</p>
7086
- * @public
7087
- */
7088
- userId?: string | undefined;
7089
- /**
7090
- * <p>The identifier of the conversation the feedback is attached to.</p>
7091
- * @public
7092
- */
7093
- conversationId: string | undefined;
7094
- /**
7095
- * <p>The identifier of the chat message that the feedback was given for.</p>
7096
- * @public
7097
- */
7098
- messageId: string | undefined;
7099
- /**
7100
- * <p>The timestamp for when the feedback was recorded.</p>
7101
- * @public
7102
- */
7103
- messageCopiedAt?: Date | undefined;
7104
- /**
7105
- * <p>The feedback usefulness value given by the user to the chat message.</p>
7106
- * @public
7107
- */
7108
- messageUsefulness?: MessageUsefulnessFeedback | undefined;
7109
- }
7110
- /**
7111
- * <p>The sub groups that belong to a group.</p>
7112
- * @public
7113
- */
7114
- export interface MemberGroup {
7115
- /**
7116
- * <p>The name of the sub group.</p>
7117
- * @public
7118
- */
7119
- groupName: string | undefined;
7120
- /**
7121
- * <p>The type of the sub group.</p>
7122
- * @public
7123
- */
7124
- type?: MembershipType | undefined;
7125
- }
7126
7111
  /**
7127
7112
  * @internal
7128
7113
  */
@@ -1,4 +1,55 @@
1
- import { ActionExecution, ActionExecutionEvent, AttachmentInput, AttachmentInputEvent, AuthChallengeResponse, AuthChallengeResponseEvent, BlockedPhrasesConfigurationUpdate, ChatMode, ChatModeConfiguration, ContentSource, CreatorModeConfiguration, DocumentAttribute, EndOfInputEvent, MemberGroup, MembershipType, ResponseScope, S3, SubscriptionDetails, SubscriptionType, Tag, TextInputEvent, TopicConfiguration, UserAlias } from "./models_0";
1
+ import { ActionExecution, ActionExecutionEvent, AttachmentInput, AttachmentInputEvent, AuthChallengeResponse, AuthChallengeResponseEvent, BlockedPhrasesConfigurationUpdate, ChatMode, ChatModeConfiguration, ContentSource, CreatorModeConfiguration, DocumentAttribute, EndOfInputEvent, MembershipType, MessageUsefulnessFeedback, OrchestrationControl, ResponseScope, S3, SubscriptionDetails, SubscriptionType, Tag, TextInputEvent, TopicConfiguration, UserAlias } from "./models_0";
2
+ /**
3
+ * @public
4
+ */
5
+ export interface PutFeedbackRequest {
6
+ /**
7
+ * <p>The identifier of the application associated with the feedback.</p>
8
+ * @public
9
+ */
10
+ applicationId: string | undefined;
11
+ /**
12
+ * <p>The identifier of the user giving the feedback.</p>
13
+ * @public
14
+ */
15
+ userId?: string | undefined;
16
+ /**
17
+ * <p>The identifier of the conversation the feedback is attached to.</p>
18
+ * @public
19
+ */
20
+ conversationId: string | undefined;
21
+ /**
22
+ * <p>The identifier of the chat message that the feedback was given for.</p>
23
+ * @public
24
+ */
25
+ messageId: string | undefined;
26
+ /**
27
+ * <p>The timestamp for when the feedback was recorded.</p>
28
+ * @public
29
+ */
30
+ messageCopiedAt?: Date | undefined;
31
+ /**
32
+ * <p>The feedback usefulness value given by the user to the chat message.</p>
33
+ * @public
34
+ */
35
+ messageUsefulness?: MessageUsefulnessFeedback | undefined;
36
+ }
37
+ /**
38
+ * <p>The sub groups that belong to a group.</p>
39
+ * @public
40
+ */
41
+ export interface MemberGroup {
42
+ /**
43
+ * <p>The name of the sub group.</p>
44
+ * @public
45
+ */
46
+ groupName: string | undefined;
47
+ /**
48
+ * <p>The type of the sub group.</p>
49
+ * @public
50
+ */
51
+ type?: MembershipType | undefined;
52
+ }
2
53
  /**
3
54
  * <p>The users that belong to a group.</p>
4
55
  * @public
@@ -271,6 +322,23 @@ export interface UntagResourceRequest {
271
322
  */
272
323
  export interface UntagResourceResponse {
273
324
  }
325
+ /**
326
+ * <p>Configuration information required to enable chat orchestration for your Amazon Q Business
327
+ * application.</p>
328
+ * <note>
329
+ * <p>Chat orchestration is optimized to work for English language content. For more
330
+ * details on language support in Amazon Q Business, see <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/supported-languages.html">Supported languages</a>.</p>
331
+ * </note>
332
+ * @public
333
+ */
334
+ export interface OrchestrationConfiguration {
335
+ /**
336
+ * <p> Status information about whether chat orchestration is activated or deactivated for
337
+ * your Amazon Q Business application.</p>
338
+ * @public
339
+ */
340
+ control: OrchestrationControl | undefined;
341
+ }
274
342
  /**
275
343
  * @public
276
344
  */
@@ -294,6 +362,11 @@ export interface UpdateChatControlsConfigurationRequest {
294
362
  * @public
295
363
  */
296
364
  responseScope?: ResponseScope | undefined;
365
+ /**
366
+ * <p> The chat response orchestration settings for your application.</p>
367
+ * @public
368
+ */
369
+ orchestrationConfiguration?: OrchestrationConfiguration | undefined;
297
370
  /**
298
371
  * <p>The phrases blocked from chat by your chat control configuration.</p>
299
372
  * @public
@@ -1,6 +1,6 @@
1
1
  import { Command as $Command } from "@smithy/smithy-client";
2
2
  import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
- import { PutFeedbackRequest } from "../models/models_0";
3
+ import { PutFeedbackRequest } from "../models/models_1";
4
4
  import {
5
5
  QBusinessClientResolvedConfig,
6
6
  ServiceInputTypes,
@@ -1294,6 +1294,15 @@ export type CreatorModeControl =
1294
1294
  export interface AppliedCreatorModeConfiguration {
1295
1295
  creatorModeControl: CreatorModeControl | undefined;
1296
1296
  }
1297
+ export declare const OrchestrationControl: {
1298
+ readonly DISABLED: "DISABLED";
1299
+ readonly ENABLED: "ENABLED";
1300
+ };
1301
+ export type OrchestrationControl =
1302
+ (typeof OrchestrationControl)[keyof typeof OrchestrationControl];
1303
+ export interface AppliedOrchestrationConfiguration {
1304
+ control: OrchestrationControl | undefined;
1305
+ }
1297
1306
  export interface AssociatePermissionRequest {
1298
1307
  applicationId: string | undefined;
1299
1308
  statementId: string | undefined;
@@ -1854,6 +1863,7 @@ export interface TopicConfiguration {
1854
1863
  }
1855
1864
  export interface GetChatControlsConfigurationResponse {
1856
1865
  responseScope?: ResponseScope | undefined;
1866
+ orchestrationConfiguration?: AppliedOrchestrationConfiguration | undefined;
1857
1867
  blockedPhrases?: BlockedPhrasesConfiguration | undefined;
1858
1868
  topicConfigurations?: TopicConfiguration[] | undefined;
1859
1869
  creatorModeConfiguration?: AppliedCreatorModeConfiguration | undefined;
@@ -2090,18 +2100,6 @@ export interface MessageUsefulnessFeedback {
2090
2100
  comment?: string | undefined;
2091
2101
  submittedAt: Date | undefined;
2092
2102
  }
2093
- export interface PutFeedbackRequest {
2094
- applicationId: string | undefined;
2095
- userId?: string | undefined;
2096
- conversationId: string | undefined;
2097
- messageId: string | undefined;
2098
- messageCopiedAt?: Date | undefined;
2099
- messageUsefulness?: MessageUsefulnessFeedback | undefined;
2100
- }
2101
- export interface MemberGroup {
2102
- groupName: string | undefined;
2103
- type?: MembershipType | undefined;
2104
- }
2105
2103
  export declare const APISchemaFilterSensitiveLog: (obj: APISchema) => any;
2106
2104
  export declare const EncryptionConfigurationFilterSensitiveLog: (
2107
2105
  obj: EncryptionConfiguration
@@ -12,8 +12,9 @@ import {
12
12
  CreatorModeConfiguration,
13
13
  DocumentAttribute,
14
14
  EndOfInputEvent,
15
- MemberGroup,
16
15
  MembershipType,
16
+ MessageUsefulnessFeedback,
17
+ OrchestrationControl,
17
18
  ResponseScope,
18
19
  S3,
19
20
  SubscriptionDetails,
@@ -23,6 +24,18 @@ import {
23
24
  TopicConfiguration,
24
25
  UserAlias,
25
26
  } from "./models_0";
27
+ export interface PutFeedbackRequest {
28
+ applicationId: string | undefined;
29
+ userId?: string | undefined;
30
+ conversationId: string | undefined;
31
+ messageId: string | undefined;
32
+ messageCopiedAt?: Date | undefined;
33
+ messageUsefulness?: MessageUsefulnessFeedback | undefined;
34
+ }
35
+ export interface MemberGroup {
36
+ groupName: string | undefined;
37
+ type?: MembershipType | undefined;
38
+ }
26
39
  export interface MemberUser {
27
40
  userId: string | undefined;
28
41
  type?: MembershipType | undefined;
@@ -90,10 +103,14 @@ export interface UntagResourceRequest {
90
103
  tagKeys: string[] | undefined;
91
104
  }
92
105
  export interface UntagResourceResponse {}
106
+ export interface OrchestrationConfiguration {
107
+ control: OrchestrationControl | undefined;
108
+ }
93
109
  export interface UpdateChatControlsConfigurationRequest {
94
110
  applicationId: string | undefined;
95
111
  clientToken?: string | undefined;
96
112
  responseScope?: ResponseScope | undefined;
113
+ orchestrationConfiguration?: OrchestrationConfiguration | undefined;
97
114
  blockedPhrasesConfigurationUpdate?:
98
115
  | BlockedPhrasesConfigurationUpdate
99
116
  | undefined;
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.741.0",
4
+ "version": "3.742.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",