feat(client-qbusiness): Adds functionality to enable/disable a new Q Business Chat orchestration feature. If enabled, Q Business can orchestrate over datasources and plugins without the need for customers to select specific chat modes.

awstools · awstools · commit 2859d8bfe9d4 · 2025-02-04T19:49:04.000Z
diff --git a/clients/client-qbusiness/src/commands/GetChatControlsConfigurationCommand.ts b/clients/client-qbusiness/src/commands/GetChatControlsConfigurationCommand.ts
@@ -33,7 +33,7 @@ export interface GetChatControlsConfigurationCommandOutput
     __MetadataBearer {}
 
 /**
- * <p>Gets information about an chat controls configured for an existing Amazon Q Business
+ * <p>Gets information about chat controls configured for an existing Amazon Q Business
  *             application.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -50,6 +50,9 @@ export interface GetChatControlsConfigurationCommandOutput
  * const response = await client.send(command);
  * // { // GetChatControlsConfigurationResponse
  * //   responseScope: "ENTERPRISE_CONTENT_ONLY" || "EXTENDED_KNOWLEDGE_ENABLED",
+ * //   orchestrationConfiguration: { // AppliedOrchestrationConfiguration
+ * //     control: "ENABLED" || "DISABLED", // required
+ * //   },
  * //   blockedPhrases: { // BlockedPhrasesConfiguration
  * //     blockedPhrases: [ // BlockedPhrases
  * //       "STRING_VALUE",
diff --git a/clients/client-qbusiness/src/commands/PutFeedbackCommand.ts b/clients/client-qbusiness/src/commands/PutFeedbackCommand.ts
@@ -5,7 +5,7 @@ import { Command as $Command } from "@smithy/smithy-client";
 import { MetadataBearer as __MetadataBearer } from "@smithy/types";
 
 import { commonParams } from "../endpoint/EndpointParameters";
-import { PutFeedbackRequest } from "../models/models_0";
+import { PutFeedbackRequest } from "../models/models_1";
 import { de_PutFeedbackCommand, se_PutFeedbackCommand } from "../protocols/Aws_restJson1";
 import { QBusinessClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QBusinessClient";
 
diff --git a/clients/client-qbusiness/src/commands/UpdateChatControlsConfigurationCommand.ts b/clients/client-qbusiness/src/commands/UpdateChatControlsConfigurationCommand.ts
@@ -33,7 +33,7 @@ export interface UpdateChatControlsConfigurationCommandOutput
     __MetadataBearer {}
 
 /**
- * <p>Updates an set of chat controls configured for an existing Amazon Q Business
+ * <p>Updates a set of chat controls configured for an existing Amazon Q Business
  *             application.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -45,6 +45,9 @@ export interface UpdateChatControlsConfigurationCommandOutput
  *   applicationId: "STRING_VALUE", // required
  *   clientToken: "STRING_VALUE",
  *   responseScope: "ENTERPRISE_CONTENT_ONLY" || "EXTENDED_KNOWLEDGE_ENABLED",
+ *   orchestrationConfiguration: { // OrchestrationConfiguration
+ *     control: "ENABLED" || "DISABLED", // required
+ *   },
  *   blockedPhrasesConfigurationUpdate: { // BlockedPhrasesConfigurationUpdate
  *     blockedPhrasesToCreateOrUpdate: [ // BlockedPhrases
  *       "STRING_VALUE",
diff --git a/clients/client-qbusiness/src/models/models_0.ts b/clients/client-qbusiness/src/models/models_0.ts
@@ -5165,6 +5165,36 @@ export interface AppliedCreatorModeConfiguration {
   creatorModeControl: CreatorModeControl | undefined;
 }
 
+/**
+ * @public
+ * @enum
+ */
+export const OrchestrationControl = {
+  DISABLED: "DISABLED",
+  ENABLED: "ENABLED",
+} as const;
+
+/**
+ * @public
+ */
+export type OrchestrationControl = (typeof OrchestrationControl)[keyof typeof OrchestrationControl];
+
+/**
+ * <p>The chat orchestration specific admin controls configured for an Amazon Q Business
+ *             application. Determines whether Amazon Q Business automatically routes chat requests across
+ *             configured plugins and data sources in your Amazon Q Business application.</p>
+ *          <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>
+ * @public
+ */
+export interface AppliedOrchestrationConfiguration {
+  /**
+   * <p> Information about whether chat orchestration is enabled or disabled for an
+   *             Amazon Q Business application. </p>
+   * @public
+   */
+  control: OrchestrationControl | undefined;
+}
+
 /**
  * @public
  */
@@ -7179,6 +7209,16 @@ export interface GetChatControlsConfigurationResponse {
    */
   responseScope?: ResponseScope | undefined;
 
+  /**
+   * <p> The chat response orchestration settings for your application.</p>
+   *          <note>
+   *             <p>Chat orchestration is optimized to work for English language content. For more
+   *                 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>
+   *          </note>
+   * @public
+   */
+  orchestrationConfiguration?: AppliedOrchestrationConfiguration | undefined;
+
   /**
    * <p>The phrases blocked from chat by your chat control configuration.</p>
    * @public
@@ -8196,65 +8236,6 @@ export interface MessageUsefulnessFeedback {
   submittedAt: Date | undefined;
 }
 
-/**
- * @public
- */
-export interface PutFeedbackRequest {
-  /**
-   * <p>The identifier of the application associated with the feedback.</p>
-   * @public
-   */
-  applicationId: string | undefined;
-
-  /**
-   * <p>The identifier of the user giving the feedback.</p>
-   * @public
-   */
-  userId?: string | undefined;
-
-  /**
-   * <p>The identifier of the conversation the feedback is attached to.</p>
-   * @public
-   */
-  conversationId: string | undefined;
-
-  /**
-   * <p>The identifier of the chat message that the feedback was given for.</p>
-   * @public
-   */
-  messageId: string | undefined;
-
-  /**
-   * <p>The timestamp for when the feedback was recorded.</p>
-   * @public
-   */
-  messageCopiedAt?: Date | undefined;
-
-  /**
-   * <p>The feedback usefulness value given by the user to the chat message.</p>
-   * @public
-   */
-  messageUsefulness?: MessageUsefulnessFeedback | undefined;
-}
-
-/**
- * <p>The sub groups that belong to a group.</p>
- * @public
- */
-export interface MemberGroup {
-  /**
-   * <p>The name of the sub group.</p>
-   * @public
-   */
-  groupName: string | undefined;
-
-  /**
-   * <p>The type of the sub group.</p>
-   * @public
-   */
-  type?: MembershipType | undefined;
-}
-
 /**
  * @internal
  */
diff --git a/clients/client-qbusiness/src/models/models_1.ts b/clients/client-qbusiness/src/models/models_1.ts
@@ -15,8 +15,9 @@ import {
   CreatorModeConfiguration,
   DocumentAttribute,
   EndOfInputEvent,
-  MemberGroup,
   MembershipType,
+  MessageUsefulnessFeedback,
+  OrchestrationControl,
   ResponseScope,
   S3,
   SubscriptionDetails,
@@ -27,6 +28,65 @@ import {
   UserAlias,
 } from "./models_0";
 
+/**
+ * @public
+ */
+export interface PutFeedbackRequest {
+  /**
+   * <p>The identifier of the application associated with the feedback.</p>
+   * @public
+   */
+  applicationId: string | undefined;
+
+  /**
+   * <p>The identifier of the user giving the feedback.</p>
+   * @public
+   */
+  userId?: string | undefined;
+
+  /**
+   * <p>The identifier of the conversation the feedback is attached to.</p>
+   * @public
+   */
+  conversationId: string | undefined;
+
+  /**
+   * <p>The identifier of the chat message that the feedback was given for.</p>
+   * @public
+   */
+  messageId: string | undefined;
+
+  /**
+   * <p>The timestamp for when the feedback was recorded.</p>
+   * @public
+   */
+  messageCopiedAt?: Date | undefined;
+
+  /**
+   * <p>The feedback usefulness value given by the user to the chat message.</p>
+   * @public
+   */
+  messageUsefulness?: MessageUsefulnessFeedback | undefined;
+}
+
+/**
+ * <p>The sub groups that belong to a group.</p>
+ * @public
+ */
+export interface MemberGroup {
+  /**
+   * <p>The name of the sub group.</p>
+   * @public
+   */
+  groupName: string | undefined;
+
+  /**
+   * <p>The type of the sub group.</p>
+   * @public
+   */
+  type?: MembershipType | undefined;
+}
+
 /**
  * <p>The users that belong to a group.</p>
  * @public
@@ -333,6 +393,24 @@ export interface UntagResourceRequest {
  */
 export interface UntagResourceResponse {}
 
+/**
+ * <p>Configuration information required to enable chat orchestration for your Amazon Q Business
+ *             application.</p>
+ *          <note>
+ *             <p>Chat orchestration is optimized to work for English language content. For more
+ *                 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>
+ *          </note>
+ * @public
+ */
+export interface OrchestrationConfiguration {
+  /**
+   * <p> Status information about whether chat orchestration is activated or deactivated for
+   *             your Amazon Q Business application.</p>
+   * @public
+   */
+  control: OrchestrationControl | undefined;
+}
+
 /**
  * @public
  */
@@ -359,6 +437,12 @@ export interface UpdateChatControlsConfigurationRequest {
    */
   responseScope?: ResponseScope | undefined;
 
+  /**
+   * <p> The chat response orchestration settings for your application.</p>
+   * @public
+   */
+  orchestrationConfiguration?: OrchestrationConfiguration | undefined;
+
   /**
    * <p>The phrases blocked from chat by your chat control configuration.</p>
    * @public
diff --git a/clients/client-qbusiness/src/protocols/Aws_restJson1.ts b/clients/client-qbusiness/src/protocols/Aws_restJson1.ts
@@ -230,7 +230,6 @@ import {
   LicenseNotFoundException,
   MediaExtractionConfiguration,
   MediaTooLargeException,
-  MemberGroup,
   Message,
   MessageUsefulnessFeedback,
   MetadataEvent,
@@ -280,7 +279,9 @@ import {
   ChatInputStream,
   ConfigurationEvent,
   GroupMembers,
+  MemberGroup,
   MemberUser,
+  OrchestrationConfiguration,
   RelevantContent,
 } from "../models/models_1";
 import { QBusinessServiceException as __BaseException } from "../models/QBusinessServiceException";
@@ -1713,6 +1714,7 @@ export const se_UpdateChatControlsConfigurationCommand = async (
       blockedPhrasesConfigurationUpdate: (_) => _json(_),
       clientToken: [true, (_) => _ ?? generateIdempotencyToken()],
       creatorModeConfiguration: (_) => _json(_),
+      orchestrationConfiguration: (_) => _json(_),
       responseScope: [],
       topicConfigurationsToCreateOrUpdate: (_) => _json(_),
       topicConfigurationsToDelete: (_) => _json(_),
@@ -2532,6 +2534,7 @@ export const de_GetChatControlsConfigurationCommand = async (
     blockedPhrases: _json,
     creatorModeConfiguration: _json,
     nextToken: __expectString,
+    orchestrationConfiguration: _json,
     responseScope: __expectString,
     topicConfigurations: _json,
   });
@@ -4360,6 +4363,8 @@ const se_MessageUsefulnessFeedback = (input: MessageUsefulnessFeedback, context:
 
 // se_OpenIDConnectProviderConfiguration omitted.
 
+// se_OrchestrationConfiguration omitted.
+
 // se_PersonalizationConfiguration omitted.
 
 // se_PluginAuthConfiguration omitted.
@@ -4638,6 +4643,8 @@ const de_Applications = (output: any, context: __SerdeContext): Application[] =>
 
 // de_AppliedCreatorModeConfiguration omitted.
 
+// de_AppliedOrchestrationConfiguration omitted.
+
 /**
  * deserializeAws_restJson1Attachment
  */
diff --git a/codegen/sdk-codegen/aws-models/qbusiness.json b/codegen/sdk-codegen/aws-models/qbusiness.json
