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: aws-sdk-dotnet-automation

generator/ServiceModels/qbusiness/qbusiness-2023-11-27.api.json

@@ -1363,6 +1363,7 @@
       "errors":[
         {"shape":"ResourceNotFoundException"},
         {"shape":"InternalServerException"},
+        {"shape":"ConflictException"},
         {"shape":"ThrottlingException"},
         {"shape":"ValidationException"},
         {"shape":"AccessDeniedException"},
@@ -3506,7 +3507,8 @@
         "blockedPhrases":{"shape":"BlockedPhrasesConfiguration"},
         "topicConfigurations":{"shape":"TopicConfigurations"},
         "creatorModeConfiguration":{"shape":"AppliedCreatorModeConfiguration"},
-        "nextToken":{"shape":"NextToken"}
+        "nextToken":{"shape":"NextToken"},
+        "hallucinationReductionConfiguration":{"shape":"HallucinationReductionConfiguration"}
       }
     },
     "GetDataAccessorRequest":{
@@ -3911,6 +3913,19 @@
       "type":"list",
       "member":{"shape":"GroupSummary"}
     },
+    "HallucinationReductionConfiguration":{
+      "type":"structure",
+      "members":{
+        "hallucinationReductionControl":{"shape":"HallucinationReductionControl"}
+      }
+    },
+    "HallucinationReductionControl":{
+      "type":"string",
+      "enum":[
+        "ENABLED",
+        "DISABLED"
+      ]
+    },
     "HookConfiguration":{
       "type":"structure",
       "members":{
@@ -5852,6 +5867,13 @@
       "min":0,
       "pattern":"\\P{C}*"
     },
+    "SystemMessageType":{
+      "type":"string",
+      "enum":[
+        "RESPONSE",
+        "GROUNDED_RESPONSE"
+      ]
+    },
     "Tag":{
       "type":"structure",
       "required":[
@@ -5923,6 +5945,7 @@
     "TextOutputEvent":{
       "type":"structure",
       "members":{
+        "systemMessageType":{"shape":"SystemMessageType"},
         "conversationId":{"shape":"ConversationId"},
         "userMessageId":{"shape":"MessageId"},
         "systemMessageId":{"shape":"MessageId"},
@@ -6070,7 +6093,8 @@
         "blockedPhrasesConfigurationUpdate":{"shape":"BlockedPhrasesConfigurationUpdate"},
         "topicConfigurationsToCreateOrUpdate":{"shape":"TopicConfigurations"},
         "topicConfigurationsToDelete":{"shape":"TopicConfigurations"},
-        "creatorModeConfiguration":{"shape":"CreatorModeConfiguration"}
+        "creatorModeConfiguration":{"shape":"CreatorModeConfiguration"},
+        "hallucinationReductionConfiguration":{"shape":"HallucinationReductionConfiguration"}
       }
     },
     "UpdateChatControlsConfigurationResponse":{

generator/ServiceModels/qbusiness/qbusiness-2023-11-27.docs.json

@@ -1773,6 +1773,19 @@
         "ListGroupsResponse$items": "<p>Summary information for list of groups that are mapped to users.</p>"
       }
     },
+    "HallucinationReductionConfiguration": {
+      "base": "<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>",
+      "refs": {
+        "GetChatControlsConfigurationResponse$hallucinationReductionConfiguration": "<p> The hallucination reduction settings for your application.</p>",
+        "UpdateChatControlsConfigurationRequest$hallucinationReductionConfiguration": "<p> The hallucination reduction settings for your application.</p>"
+      }
+    },
+    "HallucinationReductionControl": {
+      "base": null,
+      "refs": {
+        "HallucinationReductionConfiguration$hallucinationReductionControl": "<p>Controls whether hallucination reduction has been enabled or disabled for your application. The default status is <code>DISABLED</code>. </p>"
+      }
+    },
     "HookConfiguration": {
       "base": "<p>Provides the configuration information for invoking a Lambda function in Lambda to alter document metadata and content when ingesting documents into Amazon Q Business.</p> <p>You can configure your Lambda function using the <code>PreExtractionHookConfiguration</code> parameter if you want to apply advanced alterations on the original or raw documents.</p> <p>If you want to apply advanced alterations on the Amazon Q Business structured documents, you must configure your Lambda function using <code>PostExtractionHookConfiguration</code>.</p> <p>You can only invoke one Lambda function. However, this function can invoke other functions it requires.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/amazonq/latest/business-use-dg/custom-document-enrichment.html\">Custom document enrichment</a>. </p>",
       "refs": {
@@ -3268,6 +3281,12 @@
         "ContentBlockerRule$systemMessageOverride": "<p>The configured custom message displayed to an end user informing them that they've used a blocked phrase during chat.</p>"
       }
     },
+    "SystemMessageType": {
+      "base": null,
+      "refs": {
+        "TextOutputEvent$systemMessageType": "<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>"
+      }
+    },
     "Tag": {
       "base": "<p>A list of key/value pairs that identify an index, FAQ, or data source. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.</p>",
       "refs": {

generator/ServiceModels/qbusiness/qbusiness-2023-11-27.normal.json

@@ -1436,6 +1436,7 @@
       "errors":[
         {"shape":"ResourceNotFoundException"},
         {"shape":"InternalServerException"},
+        {"shape":"ConflictException"},
         {"shape":"ThrottlingException"},
         {"shape":"ValidationException"},
         {"shape":"AccessDeniedException"},
@@ -4738,6 +4739,10 @@
         "nextToken":{
           "shape":"NextToken",
           "documentation":"<p>If the <code>maxResults</code> response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q Business chat controls configured.</p>"
+        },
+        "hallucinationReductionConfiguration":{
+          "shape":"HallucinationReductionConfiguration",
+          "documentation":"<p> The hallucination reduction settings for your application.</p>"
         }
       }
     },
@@ -5432,6 +5437,23 @@
       "type":"list",
       "member":{"shape":"GroupSummary"}
     },
+    "HallucinationReductionConfiguration":{
+      "type":"structure",
+      "members":{
+        "hallucinationReductionControl":{
+          "shape":"HallucinationReductionControl",
+          "documentation":"<p>Controls whether hallucination reduction has been enabled or disabled for your application. The default status is <code>DISABLED</code>. </p>"
+        }
+      },
+      "documentation":"<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>"
+    },
+    "HallucinationReductionControl":{
+      "type":"string",
+      "enum":[
+        "ENABLED",
+        "DISABLED"
+      ]
+    },
     "HookConfiguration":{
       "type":"structure",
       "members":{
@@ -8048,6 +8070,13 @@
       "min":0,
       "pattern":"\\P{C}*"
     },
+    "SystemMessageType":{
+      "type":"string",
+      "enum":[
+        "RESPONSE",
+        "GROUNDED_RESPONSE"
+      ]
+    },
     "Tag":{
       "type":"structure",
       "required":[
@@ -8141,6 +8170,10 @@
     "TextOutputEvent":{
       "type":"structure",
       "members":{
+        "systemMessageType":{
+          "shape":"SystemMessageType",
+          "documentation":"<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>"
+        },
         "conversationId":{
           "shape":"ConversationId",
           "documentation":"<p>The identifier of the conversation with which the text output event is associated.</p>"
@@ -8377,6 +8410,10 @@
         "creatorModeConfiguration":{
           "shape":"CreatorModeConfiguration",
           "documentation":"<p>The configuration details for <code>CREATOR_MODE</code>.</p>"
+        },
+        "hallucinationReductionConfiguration":{
+          "shape":"HallucinationReductionConfiguration",
+          "documentation":"<p> The hallucination reduction settings for your application.</p>"
         }
       }
     },

sdk/src/Services/QBusiness/Generated/Model/GetChatControlsConfigurationResponse.cs

@@ -36,6 +36,7 @@ public partial class GetChatControlsConfigurationResponse : AmazonWebServiceResp
     {
         private BlockedPhrasesConfiguration _blockedPhrases;
         private AppliedCreatorModeConfiguration _creatorModeConfiguration;
+        private HallucinationReductionConfiguration _hallucinationReductionConfiguration;
         private string _nextToken;
         private AppliedOrchestrationConfiguration _orchestrationConfiguration;
         private ResponseScope _responseScope;
@@ -77,6 +78,24 @@ internal bool IsSetCreatorModeConfiguration()
             return this._creatorModeConfiguration != null;
         }
 
+        /// <summary>
+        /// Gets and sets the property HallucinationReductionConfiguration. 
+        /// <para>
+        ///  The hallucination reduction settings for your application.
+        /// </para>
+        /// </summary>
+        public HallucinationReductionConfiguration HallucinationReductionConfiguration
+        {
+            get { return this._hallucinationReductionConfiguration; }
+            set { this._hallucinationReductionConfiguration = value; }
+        }
+
+        // Check to see if HallucinationReductionConfiguration property is set
+        internal bool IsSetHallucinationReductionConfiguration()
+        {
+            return this._hallucinationReductionConfiguration != null;
+        }
+
         /// <summary>
         /// Gets and sets the property NextToken. 
         /// <para>

sdk/src/Services/QBusiness/Generated/Model/HallucinationReductionConfiguration.cs

@@ -0,0 +1,68 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * 
+ * Licensed under the Apache License, Version 2.0 (the "License").
+ * You may not use this file except in compliance with the License.
+ * A copy of the License is located at
+ * 
+ *  http://aws.amazon.com/apache2.0
+ * 
+ * or in the "license" file accompanying this file. This file is distributed
+ * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
+ * express or implied. See the License for the specific language governing
+ * permissions and limitations under the License.
+ */
+
+/*
+ * Do not modify this file. This file is generated from the qbusiness-2023-11-27.normal.json service model.
+ */
+using System;
+using System.Collections.Generic;
+using System.Xml.Serialization;
+using System.Text;
+using System.IO;
+using System.Net;
+
+using Amazon.Runtime;
+using Amazon.Runtime.Internal;
+
+#pragma warning disable CS0612,CS0618,CS1570
+namespace Amazon.QBusiness.Model
+{
+    /// <summary>
+    /// Configuration information required to setup hallucination reduction. For more information,
+    /// see <a href="amazonq/latest/qbusiness-ug/hallucination-reduction.html">hallucination
+    /// reduction</a>.
+    /// 
+    ///  <note> 
+    /// <para>
+    /// The hallucination reduction feature won't work if chat orchestration controls are
+    /// enabled for your application.
+    /// </para>
+    ///  </note>
+    /// </summary>
+    public partial class HallucinationReductionConfiguration
+    {
+        private HallucinationReductionControl _hallucinationReductionControl;
+
+        /// <summary>
+        /// Gets and sets the property HallucinationReductionControl. 
+        /// <para>
+        /// Controls whether hallucination reduction has been enabled or disabled for your application.
+        /// The default status is <c>DISABLED</c>. 
+        /// </para>
+        /// </summary>
+        public HallucinationReductionControl HallucinationReductionControl
+        {
+            get { return this._hallucinationReductionControl; }
+            set { this._hallucinationReductionControl = value; }
+        }
+
+        // Check to see if HallucinationReductionControl property is set
+        internal bool IsSetHallucinationReductionControl()
+        {
+            return this._hallucinationReductionControl != null;
+        }
+
+    }
+}

sdk/src/Services/QBusiness/Generated/Model/Internal/MarshallTransformations/GetChatControlsConfigurationResponseUnmarshaller.cs

@@ -64,6 +64,12 @@ public override AmazonWebServiceResponse Unmarshall(JsonUnmarshallerContext cont
                     response.CreatorModeConfiguration = unmarshaller.Unmarshall(context);
                     continue;
                 }
+                if (context.TestExpression("hallucinationReductionConfiguration", targetDepth))
+                {
+                    var unmarshaller = HallucinationReductionConfigurationUnmarshaller.Instance;
+                    response.HallucinationReductionConfiguration = unmarshaller.Unmarshall(context);
+                    continue;
+                }
                 if (context.TestExpression("nextToken", targetDepth))
                 {
                     var unmarshaller = StringUnmarshaller.Instance;

sdk/src/Services/QBusiness/Generated/Model/Internal/MarshallTransformations/HallucinationReductionConfigurationMarshaller.cs

@@ -0,0 +1,65 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * 
+ * Licensed under the Apache License, Version 2.0 (the "License").
+ * You may not use this file except in compliance with the License.
+ * A copy of the License is located at
+ * 
+ *  http://aws.amazon.com/apache2.0
+ * 
+ * or in the "license" file accompanying this file. This file is distributed
+ * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
+ * express or implied. See the License for the specific language governing
+ * permissions and limitations under the License.
+ */
+
+/*
+ * Do not modify this file. This file is generated from the qbusiness-2023-11-27.normal.json service model.
+ */
+using System;
+using System.Collections.Generic;
+using System.Globalization;
+using System.IO;
+using System.Text;
+using System.Xml.Serialization;
+
+using Amazon.QBusiness.Model;
+using Amazon.Runtime;
+using Amazon.Runtime.Internal;
+using Amazon.Runtime.Internal.Transform;
+using Amazon.Runtime.Internal.Util;
+using ThirdParty.Json.LitJson;
+
+#pragma warning disable CS0612,CS0618
+namespace Amazon.QBusiness.Model.Internal.MarshallTransformations
+{
+    /// <summary>
+    /// HallucinationReductionConfiguration Marshaller
+    /// </summary>
+    public class HallucinationReductionConfigurationMarshaller : IRequestMarshaller<HallucinationReductionConfiguration, JsonMarshallerContext> 
+    {
+        /// <summary>
+        /// Unmarshaller the response from the service to the response class.
+        /// </summary>  
+        /// <param name="requestObject"></param>
+        /// <param name="context"></param>
+        /// <returns></returns>
+        public void Marshall(HallucinationReductionConfiguration requestObject, JsonMarshallerContext context)
+        {
+            if(requestObject == null)
+                return;
+            if(requestObject.IsSetHallucinationReductionControl())
+            {
+                context.Writer.WritePropertyName("hallucinationReductionControl");
+                context.Writer.Write(requestObject.HallucinationReductionControl);
+            }
+
+        }
+
+        /// <summary>
+        /// Singleton Marshaller.
+        /// </summary>
+        public readonly static HallucinationReductionConfigurationMarshaller Instance = new HallucinationReductionConfigurationMarshaller();
+
+    }
+}