feat(client-qbusiness): Adds functionality to enable/disable a new Q Business Hallucination Reduction feature. If enabled, Q Business will detect and attempt to remove Hallucinations from certain Chat requests.

Author: awstools

clients/client-qbusiness/src/commands/ChatCommand.ts

@@ -173,6 +173,7 @@ export interface ChatCommandOutput extends ChatOutput, __MetadataBearer {}
  * // { // ChatOutput
  * //   outputStream: { // ChatOutputStream Union: only one key present
  * //     textEvent: { // TextOutputEvent
+ * //       systemMessageType: "RESPONSE" || "GROUNDED_RESPONSE",
  * //       conversationId: "STRING_VALUE",
  * //       userMessageId: "STRING_VALUE",
  * //       systemMessageId: "STRING_VALUE",

clients/client-qbusiness/src/commands/GetChatControlsConfigurationCommand.ts

@@ -106,6 +106,9 @@ export interface GetChatControlsConfigurationCommandOutput
  * //     creatorModeControl: "ENABLED" || "DISABLED", // required
  * //   },
  * //   nextToken: "STRING_VALUE",
+ * //   hallucinationReductionConfiguration: { // HallucinationReductionConfiguration
+ * //     hallucinationReductionControl: "ENABLED" || "DISABLED",
+ * //   },
  * // };
  *
  * ```

clients/client-qbusiness/src/commands/ListPluginActionsCommand.ts

@@ -5,7 +5,8 @@ import { Command as $Command } from "@smithy/smithy-client";
 import { MetadataBearer as __MetadataBearer } from "@smithy/types";
 
 import { commonParams } from "../endpoint/EndpointParameters";
-import { ListPluginActionsRequest, ListPluginActionsResponse } from "../models/models_0";
+import { ListPluginActionsRequest } from "../models/models_0";
+import { ListPluginActionsResponse } from "../models/models_1";
 import { de_ListPluginActionsCommand, se_ListPluginActionsCommand } from "../protocols/Aws_restJson1";
 import { QBusinessClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QBusinessClient";
 

clients/client-qbusiness/src/commands/ListPluginTypeActionsCommand.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 { ListPluginTypeActionsRequest, ListPluginTypeActionsResponse } from "../models/models_0";
+import { ListPluginTypeActionsRequest, ListPluginTypeActionsResponse } from "../models/models_1";
 import { de_ListPluginTypeActionsCommand, se_ListPluginTypeActionsCommand } from "../protocols/Aws_restJson1";
 import { QBusinessClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QBusinessClient";
 

clients/client-qbusiness/src/commands/UpdateChatControlsConfigurationCommand.ts

@@ -146,6 +146,9 @@ export interface UpdateChatControlsConfigurationCommandOutput
  *   creatorModeConfiguration: { // CreatorModeConfiguration
  *     creatorModeControl: "ENABLED" || "DISABLED", // required
  *   },
+ *   hallucinationReductionConfiguration: { // HallucinationReductionConfiguration
+ *     hallucinationReductionControl: "ENABLED" || "DISABLED",
+ *   },
  * };
  * const command = new UpdateChatControlsConfigurationCommand(input);
  * const response = await client.send(command);

clients/client-qbusiness/src/commands/UpdateUserCommand.ts

@@ -91,6 +91,10 @@ export interface UpdateUserCommandOutput extends UpdateUserResponse, __MetadataB
  *  <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>
  *
+ * @throws {@link ConflictException} (client fault)
+ *  <p>You are trying to perform an action that conflicts with the current status of your
+ *             resource. Fix any inconsistencies with your resources and try again.</p>
+ *
  * @throws {@link InternalServerException} (server fault)
  *  <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>

clients/client-qbusiness/src/models/models_0.ts

@@ -6391,12 +6391,46 @@ export interface MetadataEvent {
   finalTextMessage?: string | undefined;
 }
 
+/**
+ * @public
+ * @enum
+ */
+export const SystemMessageType = {
+  GROUNDED_RESPONSE: "GROUNDED_RESPONSE",
+  RESPONSE: "RESPONSE",
+} as const;
+
+/**
+ * @public
+ */
+export type SystemMessageType = (typeof SystemMessageType)[keyof typeof SystemMessageType];
+
 /**
  * <p>An output event for an AI-generated response in an Amazon Q Business web
  *             experience.</p>
  * @public
  */
 export interface TextOutputEvent {
+  /**
+   * <p>The type of AI-generated message in a <code>TextOutputEvent</code>. Amazon Q Business
+   *             currently supports two types of messages:</p>
+   *          <ul>
+   *             <li>
+   *                <p>
+   *                   <code>RESPONSE</code> - The Amazon Q Business system response.</p>
+   *             </li>
+   *             <li>
+   *                <p>
+   *                   <code>GROUNDED_RESPONSE</code> - The corrected, hallucination-reduced,
+   *                     response returned by Amazon Q Business. Available only if hallucination reduction is
+   *                     supported and configured for the application and detected in the end user chat
+   *                     query by Amazon Q Business.</p>
+   *             </li>
+   *          </ul>
+   * @public
+   */
+  systemMessageType?: SystemMessageType | undefined;
+
   /**
    * <p>The identifier of the conversation with which the text output event is
    *             associated.</p>
@@ -7327,6 +7361,39 @@ export interface GetChatControlsConfigurationRequest {
   nextToken?: string | undefined;
 }
 
+/**
+ * @public
+ * @enum
+ */
+export const HallucinationReductionControl = {
+  DISABLED: "DISABLED",
+  ENABLED: "ENABLED",
+} as const;
+
+/**
+ * @public
+ */
+export type HallucinationReductionControl =
+  (typeof HallucinationReductionControl)[keyof typeof HallucinationReductionControl];
+
+/**
+ * <p>Configuration information required to setup hallucination reduction. For more
+ *             information, see <a href="amazonq/latest/qbusiness-ug/hallucination-reduction.html">hallucination reduction</a>.</p>
+ *          <note>
+ *             <p>The hallucination reduction feature won't work if chat orchestration controls are
+ *                 enabled for your application.</p>
+ *          </note>
+ * @public
+ */
+export interface HallucinationReductionConfiguration {
+  /**
+   * <p>Controls whether hallucination reduction has been enabled or disabled for your
+   *             application. The default status is <code>DISABLED</code>. </p>
+   * @public
+   */
+  hallucinationReductionControl?: HallucinationReductionControl | undefined;
+}
+
 /**
  * @public
  * @enum
@@ -7543,6 +7610,12 @@ export interface GetChatControlsConfigurationResponse {
    * @public
    */
   nextToken?: string | undefined;
+
+  /**
+   * <p> The hallucination reduction settings for your application.</p>
+   * @public
+   */
+  hallucinationReductionConfiguration?: HallucinationReductionConfiguration | undefined;
 }
 
 /**
@@ -8216,66 +8289,6 @@ export interface ListPluginActionsRequest {
   maxResults?: number | undefined;
 }
 
-/**
- * @public
- */
-export interface ListPluginActionsResponse {
-  /**
-   * <p>If the response is truncated, Amazon Q Business returns this token, which you
-   *             can use in a later request to list the next set of plugin actions.</p>
-   * @public
-   */
-  nextToken?: string | undefined;
-
-  /**
-   * <p>An array of information on one or more plugin actions.</p>
-   * @public
-   */
-  items?: ActionSummary[] | undefined;
-}
-
-/**
- * @public
- */
-export interface ListPluginTypeActionsRequest {
-  /**
-   * <p>The type of the plugin.</p>
-   * @public
-   */
-  pluginType: PluginType | undefined;
-
-  /**
-   * <p>If the number of plugins returned exceeds <code>maxResults</code>, Amazon Q Business returns a next token as a pagination token to retrieve the next set
-   *             of plugins.</p>
-   * @public
-   */
-  nextToken?: string | undefined;
-
-  /**
-   * <p>The maximum number of plugins to return.</p>
-   * @public
-   */
-  maxResults?: number | undefined;
-}
-
-/**
- * @public
- */
-export interface ListPluginTypeActionsResponse {
-  /**
-   * <p>If the response is truncated, Amazon Q Business returns this token, which you
-   *             can use in a later request to list the next set of plugins.</p>
-   * @public
-   */
-  nextToken?: string | undefined;
-
-  /**
-   * <p>An array of information on one or more plugins.</p>
-   * @public
-   */
-  items?: ActionSummary[] | undefined;
-}
-
 /**
  * @internal
  */

clients/client-qbusiness/src/models/models_1.ts

@@ -4,6 +4,7 @@ import { SENSITIVE_STRING } from "@smithy/smithy-client";
 import {
   ActionExecution,
   ActionExecutionEvent,
+  ActionSummary,
   AttachmentInput,
   AttachmentInputEvent,
   AuthChallengeResponse,
@@ -15,6 +16,7 @@ import {
   CreatorModeConfiguration,
   DocumentAttribute,
   EndOfInputEvent,
+  HallucinationReductionConfiguration,
   MembershipType,
   OrchestrationControl,
   PluginType,
@@ -29,6 +31,66 @@ import {
   UserAlias,
 } from "./models_0";
 
+/**
+ * @public
+ */
+export interface ListPluginActionsResponse {
+  /**
+   * <p>If the response is truncated, Amazon Q Business returns this token, which you
+   *             can use in a later request to list the next set of plugin actions.</p>
+   * @public
+   */
+  nextToken?: string | undefined;
+
+  /**
+   * <p>An array of information on one or more plugin actions.</p>
+   * @public
+   */
+  items?: ActionSummary[] | undefined;
+}
+
+/**
+ * @public
+ */
+export interface ListPluginTypeActionsRequest {
+  /**
+   * <p>The type of the plugin.</p>
+   * @public
+   */
+  pluginType: PluginType | undefined;
+
+  /**
+   * <p>If the number of plugins returned exceeds <code>maxResults</code>, Amazon Q Business returns a next token as a pagination token to retrieve the next set
+   *             of plugins.</p>
+   * @public
+   */
+  nextToken?: string | undefined;
+
+  /**
+   * <p>The maximum number of plugins to return.</p>
+   * @public
+   */
+  maxResults?: number | undefined;
+}
+
+/**
+ * @public
+ */
+export interface ListPluginTypeActionsResponse {
+  /**
+   * <p>If the response is truncated, Amazon Q Business returns this token, which you
+   *             can use in a later request to list the next set of plugins.</p>
+   * @public
+   */
+  nextToken?: string | undefined;
+
+  /**
+   * <p>An array of information on one or more plugins.</p>
+   * @public
+   */
+  items?: ActionSummary[] | undefined;
+}
+
 /**
  * @public
  */
@@ -725,6 +787,12 @@ export interface UpdateChatControlsConfigurationRequest {
    * @public
    */
   creatorModeConfiguration?: CreatorModeConfiguration | undefined;
+
+  /**
+   * <p> The hallucination reduction settings for your application.</p>
+   * @public
+   */
+  hallucinationReductionConfiguration?: HallucinationReductionConfiguration | undefined;
 }
 
 /**

clients/client-qbusiness/src/protocols/Aws_restJson1.ts

@@ -220,6 +220,7 @@ import {
   ExternalResourceException,
   FailedAttachmentEvent,
   GroupStatusDetail,
+  HallucinationReductionConfiguration,
   HookConfiguration,
   IdcAuthConfiguration,
   IdentityProviderConfiguration,
@@ -1738,6 +1739,7 @@ export const se_UpdateChatControlsConfigurationCommand = async (
       blockedPhrasesConfigurationUpdate: (_) => _json(_),
       clientToken: [true, (_) => _ ?? generateIdempotencyToken()],
       creatorModeConfiguration: (_) => _json(_),
+      hallucinationReductionConfiguration: (_) => _json(_),
       orchestrationConfiguration: (_) => _json(_),
       responseScope: [],
       topicConfigurationsToCreateOrUpdate: (_) => _json(_),
@@ -2574,6 +2576,7 @@ export const de_GetChatControlsConfigurationCommand = async (
   const doc = take(data, {
     blockedPhrases: _json,
     creatorModeConfiguration: _json,
+    hallucinationReductionConfiguration: _json,
     nextToken: __expectString,
     orchestrationConfiguration: _json,
     responseScope: __expectString,
@@ -4324,6 +4327,8 @@ const se_Documents = (input: Document[], context: __SerdeContext): any => {
 
 // se_GroupMembers omitted.
 
+// se_HallucinationReductionConfiguration omitted.
+
 /**
  * serializeAws_restJson1HookConfiguration
  */
@@ -5060,6 +5065,8 @@ const de_GroupStatusDetails = (output: any, context: __SerdeContext): GroupStatu
 
 // de_GroupSummaryList omitted.
 
+// de_HallucinationReductionConfiguration omitted.
+
 /**
  * deserializeAws_restJson1HookConfiguration
  */