npm - @aws-sdk/client-qbusiness - Versions diffs - 3.513.0 → 3.515.0 - Mend

@aws-sdk/client-qbusiness 3.513.0 → 3.515.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.

Files changed (14) hide show

package/README.md +81 -0
package/dist-cjs/index.js +43 -0
package/dist-es/models/models_0.js +35 -0
package/dist-types/QBusiness.d.ts +83 -2
package/dist-types/QBusinessClient.d.ts +83 -2
package/dist-types/commands/CreateIndexCommand.d.ts +2 -2
package/dist-types/commands/CreateRetrieverCommand.d.ts +21 -0
package/dist-types/commands/GetRetrieverCommand.d.ts +21 -0
package/dist-types/commands/PutFeedbackCommand.d.ts +1 -1
package/dist-types/commands/UpdateRetrieverCommand.d.ts +21 -0
package/dist-types/index.d.ts +83 -2
package/dist-types/models/models_0.d.ts +239 -19
package/dist-types/ts3.4/models/models_0.d.ts +99 -0
package/package.json +14 -14

package/README.md CHANGED Viewed

@@ -6,8 +6,89 @@
 AWS SDK for JavaScript QBusiness Client for Node.js, Browser and React Native.
+<note>
+<p>Amazon Q is in preview release and is subject to change.</p>
+</note>
+<p>This is the <i>Amazon Q (for business use)</i> API Reference.
+Amazon Q is a fully managed, generative-AI powered enterprise chat assistant that
+you can deploy within your organization. Amazon Q enhances employee productivity by
+supporting key tasks such as question-answering, knowledge discovery, writing email
+messages, summarizing text, drafting document outlines, and brainstorming ideas. Users
+ask questions of Amazon Q and get answers that are presented in a conversational
+manner. For an introduction to the service, see the <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/what-is.html">
+<i>Amazon Q (for business use) Developer
+Guide</i>
+</a>.</p>
+<p>For an overview of the Amazon Q APIs, see <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/api-ref.html#api-overview">Overview of Amazon Q API operations</a>.</p>
+<p>For information about the IAM access control permissions you need to
+use this API, see <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/iam-roles.html">IAM roles for Amazon Q</a> in the
+<i>Amazon Q (for business use) Developer Guide</i>.</p>
+<p>You can use the following AWS SDKs to access Amazon Q APIs:</p>
+<ul>
+<li>
 <p>
+<a href="https://docs.aws.amazon.com/sdk-for-cpp">AWS SDK for C++</a>
 </p>
+</li>
+<li>
+<p>
+<a href="https://docs.aws.amazon.com/sdk-for-go">AWS SDK for Go</a>
+</p>
+</li>
+<li>
+<p>
+<a href="https://docs.aws.amazon.com/sdk-for-java">AWS SDK for Java</a>
+</p>
+</li>
+<li>
+<p>
+<a href="https://docs.aws.amazon.com/sdk-for-javascript">AWS SDK for
+JavaScript</a>
+</p>
+</li>
+<li>
+<p>
+<a href="https://docs.aws.amazon.com/sdk-for-net">AWS SDK for .NET</a>
+</p>
+</li>
+<li>
+<p>
+<a href="https://docs.aws.amazon.com/pythonsdk">AWS SDK for Python
+(Boto3)</a>
+</p>
+</li>
+<li>
+<p>
+<a href="https://docs.aws.amazon.com/sdk-for-ruby">AWS SDK for Ruby</a>
+</p>
+</li>
+</ul>
+<p>The following resources provide additional information about using the Amazon Q
+API:</p>
+<ul>
+<li>
+<p>
+<i>
+<a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/setting-up.html">Setting up for
+Amazon Q</a>
+</i>
+</p>
+</li>
+<li>
+<p>
+<i>
+<a href="https://awscli.amazonaws.com/v2/documentation/api/latest/reference/qbusiness/index.html">Amazon Q CLI Reference</a>
+</i>
+</p>
+</li>
+<li>
+<p>
+<i>
+<a href="https://docs.aws.amazon.com/general/latest/gr/amazonq.html">Amazon Web Services General Reference</a>
+</i>
+</p>
+</li>
+</ul>
 ## Installing

package/dist-cjs/index.js CHANGED Viewed

@@ -53,6 +53,8 @@ __export(src_exports, {
   DeleteRetrieverCommand: () => DeleteRetrieverCommand,
   DeleteUserCommand: () => DeleteUserCommand,
   DeleteWebExperienceCommand: () => DeleteWebExperienceCommand,
+  DocumentAttributeBoostingConfiguration: () => DocumentAttributeBoostingConfiguration,
+  DocumentAttributeBoostingLevel: () => DocumentAttributeBoostingLevel,
   DocumentAttributeValue: () => DocumentAttributeValue,
   DocumentContent: () => DocumentContent,
   DocumentContentOperator: () => DocumentContentOperator,
@@ -91,6 +93,7 @@ __export(src_exports, {
   MessageType: () => MessageType,
   MessageUsefulness: () => MessageUsefulness,
   MessageUsefulnessReason: () => MessageUsefulnessReason,
+  NumberAttributeBoostingType: () => NumberAttributeBoostingType,
   PluginAuthConfiguration: () => PluginAuthConfiguration,
   PluginState: () => PluginState,
   PluginType: () => PluginType,
@@ -112,6 +115,7 @@ __export(src_exports, {
   StartDataSourceSyncJobCommand: () => StartDataSourceSyncJobCommand,
   Status: () => Status,
   StopDataSourceSyncJobCommand: () => StopDataSourceSyncJobCommand,
+  StringAttributeValueBoostingLevel: () => StringAttributeValueBoostingLevel,
   TagResourceCommand: () => TagResourceCommand,
   ThrottlingException: () => ThrottlingException,
   UntagResourceCommand: () => UntagResourceCommand,
@@ -573,6 +577,37 @@ var PluginState = {
   DISABLED: "DISABLED",
   ENABLED: "ENABLED"
 };
+var DocumentAttributeBoostingLevel = {
+  HIGH: "HIGH",
+  LOW: "LOW",
+  MEDIUM: "MEDIUM",
+  NONE: "NONE",
+  VERY_HIGH: "VERY_HIGH"
+};
+var NumberAttributeBoostingType = {
+  PRIORITIZE_LARGER_VALUES: "PRIORITIZE_LARGER_VALUES",
+  PRIORITIZE_SMALLER_VALUES: "PRIORITIZE_SMALLER_VALUES"
+};
+var StringAttributeValueBoostingLevel = {
+  HIGH: "HIGH",
+  LOW: "LOW",
+  MEDIUM: "MEDIUM",
+  VERY_HIGH: "VERY_HIGH"
+};
+var DocumentAttributeBoostingConfiguration;
+((DocumentAttributeBoostingConfiguration3) => {
+  DocumentAttributeBoostingConfiguration3.visit = /* @__PURE__ */ __name((value, visitor) => {
+    if (value.numberConfiguration !== void 0)
+      return visitor.numberConfiguration(value.numberConfiguration);
+    if (value.stringConfiguration !== void 0)
+      return visitor.stringConfiguration(value.stringConfiguration);
+    if (value.dateConfiguration !== void 0)
+      return visitor.dateConfiguration(value.dateConfiguration);
+    if (value.stringListConfiguration !== void 0)
+      return visitor.stringListConfiguration(value.stringListConfiguration);
+    return visitor._(value.$unknown[0], value.$unknown[1]);
+  }, "visit");
+})(DocumentAttributeBoostingConfiguration || (DocumentAttributeBoostingConfiguration = {}));
 var RetrieverConfiguration;
 ((RetrieverConfiguration3) => {
   RetrieverConfiguration3.visit = /* @__PURE__ */ __name((value, visitor) => {
@@ -710,8 +745,12 @@ var MessageUsefulnessReason = {
   HARMFUL_OR_UNSAFE: "HARMFUL_OR_UNSAFE",
   HELPFUL: "HELPFUL",
   INCORRECT_OR_MISSING_SOURCES: "INCORRECT_OR_MISSING_SOURCES",
+  NOT_BASED_ON_DOCUMENTS: "NOT_BASED_ON_DOCUMENTS",
+  NOT_COMPLETE: "NOT_COMPLETE",
+  NOT_CONCISE: "NOT_CONCISE",
   NOT_FACTUALLY_CORRECT: "NOT_FACTUALLY_CORRECT",
   NOT_HELPFUL: "NOT_HELPFUL",
+  OTHER: "OTHER",
   RELEVANT_SOURCES: "RELEVANT_SOURCES"
 };
 var MessageUsefulness = {
@@ -4160,6 +4199,10 @@ var import_util_endpoints = require("@aws-sdk/util-endpoints");
   IndexStatus,
   PluginAuthConfiguration,
   PluginState,
+  DocumentAttributeBoostingLevel,
+  NumberAttributeBoostingType,
+  StringAttributeValueBoostingLevel,
+  DocumentAttributeBoostingConfiguration,
   RetrieverConfiguration,
   RetrieverType,
   RetrieverStatus,

package/dist-es/models/models_0.js CHANGED Viewed

@@ -220,6 +220,37 @@ export const PluginState = {
     DISABLED: "DISABLED",
     ENABLED: "ENABLED",
 };
+export const DocumentAttributeBoostingLevel = {
+    HIGH: "HIGH",
+    LOW: "LOW",
+    MEDIUM: "MEDIUM",
+    NONE: "NONE",
+    VERY_HIGH: "VERY_HIGH",
+};
+export const NumberAttributeBoostingType = {
+    PRIORITIZE_LARGER_VALUES: "PRIORITIZE_LARGER_VALUES",
+    PRIORITIZE_SMALLER_VALUES: "PRIORITIZE_SMALLER_VALUES",
+};
+export const StringAttributeValueBoostingLevel = {
+    HIGH: "HIGH",
+    LOW: "LOW",
+    MEDIUM: "MEDIUM",
+    VERY_HIGH: "VERY_HIGH",
+};
+export var DocumentAttributeBoostingConfiguration;
+(function (DocumentAttributeBoostingConfiguration) {
+    DocumentAttributeBoostingConfiguration.visit = (value, visitor) => {
+        if (value.numberConfiguration !== undefined)
+            return visitor.numberConfiguration(value.numberConfiguration);
+        if (value.stringConfiguration !== undefined)
+            return visitor.stringConfiguration(value.stringConfiguration);
+        if (value.dateConfiguration !== undefined)
+            return visitor.dateConfiguration(value.dateConfiguration);
+        if (value.stringListConfiguration !== undefined)
+            return visitor.stringListConfiguration(value.stringListConfiguration);
+        return visitor._(value.$unknown[0], value.$unknown[1]);
+    };
+})(DocumentAttributeBoostingConfiguration || (DocumentAttributeBoostingConfiguration = {}));
 export var RetrieverConfiguration;
 (function (RetrieverConfiguration) {
     RetrieverConfiguration.visit = (value, visitor) => {
@@ -352,8 +383,12 @@ export const MessageUsefulnessReason = {
     HARMFUL_OR_UNSAFE: "HARMFUL_OR_UNSAFE",
     HELPFUL: "HELPFUL",
     INCORRECT_OR_MISSING_SOURCES: "INCORRECT_OR_MISSING_SOURCES",
+    NOT_BASED_ON_DOCUMENTS: "NOT_BASED_ON_DOCUMENTS",
+    NOT_COMPLETE: "NOT_COMPLETE",
+    NOT_CONCISE: "NOT_CONCISE",
     NOT_FACTUALLY_CORRECT: "NOT_FACTUALLY_CORRECT",
     NOT_HELPFUL: "NOT_HELPFUL",
+    OTHER: "OTHER",
     RELEVANT_SOURCES: "RELEVANT_SOURCES",
 };
 export const MessageUsefulness = {

package/dist-types/QBusiness.d.ts CHANGED Viewed

@@ -389,8 +389,89 @@ export interface QBusiness {
 }
 /**
  * @public
- * <p>
- *         </p>
+ * <note>
+ *             <p>Amazon Q is in preview release and is subject to change.</p>
+ *          </note>
+ *          <p>This is the <i>Amazon Q (for business use)</i> API Reference.
+ *             Amazon Q is a fully managed, generative-AI powered enterprise chat assistant that
+ *             you can deploy within your organization. Amazon Q enhances employee productivity by
+ *             supporting key tasks such as question-answering, knowledge discovery, writing email
+ *             messages, summarizing text, drafting document outlines, and brainstorming ideas. Users
+ *             ask questions of Amazon Q and get answers that are presented in a conversational
+ *             manner. For an introduction to the service, see the <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/what-is.html">
+ *                <i>Amazon Q (for business use) Developer
+ *             Guide</i>
+ *             </a>.</p>
+ *          <p>For an overview of the Amazon Q APIs, see <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/api-ref.html#api-overview">Overview of Amazon Q API operations</a>.</p>
+ *          <p>For information about the IAM access control permissions you need to
+ *             use this API, see <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/iam-roles.html">IAM roles for Amazon Q</a> in the
+ *                 <i>Amazon Q (for business use) Developer Guide</i>.</p>
+ *          <p>You can use the following AWS SDKs to access Amazon Q APIs:</p>
+ *          <ul>
+ *             <li>
+ *                <p>
+ *                   <a href="https://docs.aws.amazon.com/sdk-for-cpp">AWS SDK for C++</a>
+ *                </p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <a href="https://docs.aws.amazon.com/sdk-for-go">AWS SDK for Go</a>
+ *                </p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <a href="https://docs.aws.amazon.com/sdk-for-java">AWS SDK for Java</a>
+ *                </p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <a href="https://docs.aws.amazon.com/sdk-for-javascript">AWS SDK for
+ *                         JavaScript</a>
+ *                </p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <a href="https://docs.aws.amazon.com/sdk-for-net">AWS SDK for .NET</a>
+ *                </p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <a href="https://docs.aws.amazon.com/pythonsdk">AWS SDK for Python
+ *                     (Boto3)</a>
+ *                </p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <a href="https://docs.aws.amazon.com/sdk-for-ruby">AWS SDK for Ruby</a>
+ *                </p>
+ *             </li>
+ *          </ul>
+ *          <p>The following resources provide additional information about using the Amazon Q
+ *             API:</p>
+ *          <ul>
+ *             <li>
+ *                <p>
+ *                   <i>
+ *                      <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/setting-up.html">Setting up for
+ *                             Amazon Q</a>
+ *                   </i>
+ *                </p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <i>
+ *                      <a href="https://awscli.amazonaws.com/v2/documentation/api/latest/reference/qbusiness/index.html">Amazon Q CLI Reference</a>
+ *                   </i>
+ *                </p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <i>
+ *                      <a href="https://docs.aws.amazon.com/general/latest/gr/amazonq.html">Amazon Web Services General Reference</a>
+ *                   </i>
+ *                </p>
+ *             </li>
+ *          </ul>
  */
 export declare class QBusiness extends QBusinessClient implements QBusiness {
 }

package/dist-types/QBusinessClient.d.ts CHANGED Viewed

@@ -207,8 +207,89 @@ export interface QBusinessClientResolvedConfig extends QBusinessClientResolvedCo
 }
 /**
  * @public
- * <p>
- *         </p>
+ * <note>
+ *             <p>Amazon Q is in preview release and is subject to change.</p>
+ *          </note>
+ *          <p>This is the <i>Amazon Q (for business use)</i> API Reference.
+ *             Amazon Q is a fully managed, generative-AI powered enterprise chat assistant that
+ *             you can deploy within your organization. Amazon Q enhances employee productivity by
+ *             supporting key tasks such as question-answering, knowledge discovery, writing email
+ *             messages, summarizing text, drafting document outlines, and brainstorming ideas. Users
+ *             ask questions of Amazon Q and get answers that are presented in a conversational
+ *             manner. For an introduction to the service, see the <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/what-is.html">
+ *                <i>Amazon Q (for business use) Developer
+ *             Guide</i>
+ *             </a>.</p>
+ *          <p>For an overview of the Amazon Q APIs, see <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/api-ref.html#api-overview">Overview of Amazon Q API operations</a>.</p>
+ *          <p>For information about the IAM access control permissions you need to
+ *             use this API, see <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/iam-roles.html">IAM roles for Amazon Q</a> in the
+ *                 <i>Amazon Q (for business use) Developer Guide</i>.</p>
+ *          <p>You can use the following AWS SDKs to access Amazon Q APIs:</p>
+ *          <ul>
+ *             <li>
+ *                <p>
+ *                   <a href="https://docs.aws.amazon.com/sdk-for-cpp">AWS SDK for C++</a>
+ *                </p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <a href="https://docs.aws.amazon.com/sdk-for-go">AWS SDK for Go</a>
+ *                </p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <a href="https://docs.aws.amazon.com/sdk-for-java">AWS SDK for Java</a>
+ *                </p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <a href="https://docs.aws.amazon.com/sdk-for-javascript">AWS SDK for
+ *                         JavaScript</a>
+ *                </p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <a href="https://docs.aws.amazon.com/sdk-for-net">AWS SDK for .NET</a>
+ *                </p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <a href="https://docs.aws.amazon.com/pythonsdk">AWS SDK for Python
+ *                     (Boto3)</a>
+ *                </p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <a href="https://docs.aws.amazon.com/sdk-for-ruby">AWS SDK for Ruby</a>
+ *                </p>
+ *             </li>
+ *          </ul>
+ *          <p>The following resources provide additional information about using the Amazon Q
+ *             API:</p>
+ *          <ul>
+ *             <li>
+ *                <p>
+ *                   <i>
+ *                      <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/setting-up.html">Setting up for
+ *                             Amazon Q</a>
+ *                   </i>
+ *                </p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <i>
+ *                      <a href="https://awscli.amazonaws.com/v2/documentation/api/latest/reference/qbusiness/index.html">Amazon Q CLI Reference</a>
+ *                   </i>
+ *                </p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <i>
+ *                      <a href="https://docs.aws.amazon.com/general/latest/gr/amazonq.html">Amazon Web Services General Reference</a>
+ *                   </i>
+ *                </p>
+ *             </li>
+ *          </ul>
  */
 export declare class QBusinessClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, QBusinessClientResolvedConfig> {
     /**

package/dist-types/commands/CreateIndexCommand.d.ts CHANGED Viewed

@@ -30,9 +30,9 @@ declare const CreateIndexCommand_base: {
  *          <p>To determine if index creation has completed, check the <code>Status</code> field
  *             returned from a call to <code>DescribeIndex</code>. The <code>Status</code> field is set
  *             to <code>ACTIVE</code> when the index is ready to use.</p>
- *          <p>Once the index is active, you can index your documents using the <a href="https://docs.aws.amazon.com/enterpriseq/latest/APIReference/API_BatchPutDocument.html">
+ *          <p>Once the index is active, you can index your documents using the <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_BatchPutDocument.html">
  *                <code>BatchPutDocument</code>
- *             </a> API or the <a href="https://docs.aws.amazon.com/enterpriseq/latest/APIReference/API_CreateDataSource.html">
+ *             </a> API or the <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_CreateDataSource.html">
  *                <code>CreateDataSource</code>
  *             </a> API.</p>
  * @example

package/dist-types/commands/CreateRetrieverCommand.d.ts CHANGED Viewed

@@ -40,6 +40,27 @@ declare const CreateRetrieverCommand_base: {
  *   configuration: { // RetrieverConfiguration Union: only one key present
  *     nativeIndexConfiguration: { // NativeIndexConfiguration
  *       indexId: "STRING_VALUE", // required
+ *       boostingOverride: { // DocumentAttributeBoostingOverrideMap
+ *         "<keys>": { // DocumentAttributeBoostingConfiguration Union: only one key present
+ *           numberConfiguration: { // NumberAttributeBoostingConfiguration
+ *             boostingLevel: "NONE" || "LOW" || "MEDIUM" || "HIGH" || "VERY_HIGH", // required
+ *             boostingType: "PRIORITIZE_LARGER_VALUES" || "PRIORITIZE_SMALLER_VALUES",
+ *           },
+ *           stringConfiguration: { // StringAttributeBoostingConfiguration
+ *             boostingLevel: "NONE" || "LOW" || "MEDIUM" || "HIGH" || "VERY_HIGH", // required
+ *             attributeValueBoosting: { // StringAttributeValueBoosting
+ *               "<keys>": "LOW" || "MEDIUM" || "HIGH" || "VERY_HIGH",
+ *             },
+ *           },
+ *           dateConfiguration: { // DateAttributeBoostingConfiguration
+ *             boostingLevel: "NONE" || "LOW" || "MEDIUM" || "HIGH" || "VERY_HIGH", // required
+ *             boostingDurationInSeconds: Number("long"),
+ *           },
+ *           stringListConfiguration: { // StringListAttributeBoostingConfiguration
+ *             boostingLevel: "NONE" || "LOW" || "MEDIUM" || "HIGH" || "VERY_HIGH", // required
+ *           },
+ *         },
+ *       },
  *     },
  *     kendraIndexConfiguration: { // KendraIndexConfiguration
  *       indexId: "STRING_VALUE", // required

package/dist-types/commands/GetRetrieverCommand.d.ts CHANGED Viewed

@@ -50,6 +50,27 @@ declare const GetRetrieverCommand_base: {
  * //   configuration: { // RetrieverConfiguration Union: only one key present
  * //     nativeIndexConfiguration: { // NativeIndexConfiguration
  * //       indexId: "STRING_VALUE", // required
+ * //       boostingOverride: { // DocumentAttributeBoostingOverrideMap
+ * //         "<keys>": { // DocumentAttributeBoostingConfiguration Union: only one key present
+ * //           numberConfiguration: { // NumberAttributeBoostingConfiguration
+ * //             boostingLevel: "NONE" || "LOW" || "MEDIUM" || "HIGH" || "VERY_HIGH", // required
+ * //             boostingType: "PRIORITIZE_LARGER_VALUES" || "PRIORITIZE_SMALLER_VALUES",
+ * //           },
+ * //           stringConfiguration: { // StringAttributeBoostingConfiguration
+ * //             boostingLevel: "NONE" || "LOW" || "MEDIUM" || "HIGH" || "VERY_HIGH", // required
+ * //             attributeValueBoosting: { // StringAttributeValueBoosting
+ * //               "<keys>": "LOW" || "MEDIUM" || "HIGH" || "VERY_HIGH",
+ * //             },
+ * //           },
+ * //           dateConfiguration: { // DateAttributeBoostingConfiguration
+ * //             boostingLevel: "NONE" || "LOW" || "MEDIUM" || "HIGH" || "VERY_HIGH", // required
+ * //             boostingDurationInSeconds: Number("long"),
+ * //           },
+ * //           stringListConfiguration: { // StringListAttributeBoostingConfiguration
+ * //             boostingLevel: "NONE" || "LOW" || "MEDIUM" || "HIGH" || "VERY_HIGH", // required
+ * //           },
+ * //         },
+ * //       },
  * //     },
  * //     kendraIndexConfiguration: { // KendraIndexConfiguration
  * //       indexId: "STRING_VALUE", // required

package/dist-types/commands/PutFeedbackCommand.d.ts CHANGED Viewed

@@ -42,7 +42,7 @@ declare const PutFeedbackCommand_base: {
  *   messageCopiedAt: new Date("TIMESTAMP"),
  *   messageUsefulness: { // MessageUsefulnessFeedback
  *     usefulness: "USEFUL" || "NOT_USEFUL", // required
- *     reason: "NOT_FACTUALLY_CORRECT" || "HARMFUL_OR_UNSAFE" || "INCORRECT_OR_MISSING_SOURCES" || "NOT_HELPFUL" || "FACTUALLY_CORRECT" || "COMPLETE" || "RELEVANT_SOURCES" || "HELPFUL",
+ *     reason: "NOT_FACTUALLY_CORRECT" || "HARMFUL_OR_UNSAFE" || "INCORRECT_OR_MISSING_SOURCES" || "NOT_HELPFUL" || "FACTUALLY_CORRECT" || "COMPLETE" || "RELEVANT_SOURCES" || "HELPFUL" || "NOT_BASED_ON_DOCUMENTS" || "NOT_COMPLETE" || "NOT_CONCISE" || "OTHER",
  *     comment: "STRING_VALUE",
  *     submittedAt: new Date("TIMESTAMP"), // required
  *   },

package/dist-types/commands/UpdateRetrieverCommand.d.ts CHANGED Viewed

@@ -39,6 +39,27 @@ declare const UpdateRetrieverCommand_base: {
  *   configuration: { // RetrieverConfiguration Union: only one key present
  *     nativeIndexConfiguration: { // NativeIndexConfiguration
  *       indexId: "STRING_VALUE", // required
+ *       boostingOverride: { // DocumentAttributeBoostingOverrideMap
+ *         "<keys>": { // DocumentAttributeBoostingConfiguration Union: only one key present
+ *           numberConfiguration: { // NumberAttributeBoostingConfiguration
+ *             boostingLevel: "NONE" || "LOW" || "MEDIUM" || "HIGH" || "VERY_HIGH", // required
+ *             boostingType: "PRIORITIZE_LARGER_VALUES" || "PRIORITIZE_SMALLER_VALUES",
+ *           },
+ *           stringConfiguration: { // StringAttributeBoostingConfiguration
+ *             boostingLevel: "NONE" || "LOW" || "MEDIUM" || "HIGH" || "VERY_HIGH", // required
+ *             attributeValueBoosting: { // StringAttributeValueBoosting
+ *               "<keys>": "LOW" || "MEDIUM" || "HIGH" || "VERY_HIGH",
+ *             },
+ *           },
+ *           dateConfiguration: { // DateAttributeBoostingConfiguration
+ *             boostingLevel: "NONE" || "LOW" || "MEDIUM" || "HIGH" || "VERY_HIGH", // required
+ *             boostingDurationInSeconds: Number("long"),
+ *           },
+ *           stringListConfiguration: { // StringListAttributeBoostingConfiguration
+ *             boostingLevel: "NONE" || "LOW" || "MEDIUM" || "HIGH" || "VERY_HIGH", // required
+ *           },
+ *         },
+ *       },
  *     },
  *     kendraIndexConfiguration: { // KendraIndexConfiguration
  *       indexId: "STRING_VALUE", // required

package/dist-types/index.d.ts CHANGED Viewed

@@ -1,6 +1,87 @@
 /**
- * <p>
- *         </p>
+ * <note>
+ *             <p>Amazon Q is in preview release and is subject to change.</p>
+ *          </note>
+ *          <p>This is the <i>Amazon Q (for business use)</i> API Reference.
+ *             Amazon Q is a fully managed, generative-AI powered enterprise chat assistant that
+ *             you can deploy within your organization. Amazon Q enhances employee productivity by
+ *             supporting key tasks such as question-answering, knowledge discovery, writing email
+ *             messages, summarizing text, drafting document outlines, and brainstorming ideas. Users
+ *             ask questions of Amazon Q and get answers that are presented in a conversational
+ *             manner. For an introduction to the service, see the <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/what-is.html">
+ *                <i>Amazon Q (for business use) Developer
+ *             Guide</i>
+ *             </a>.</p>
+ *          <p>For an overview of the Amazon Q APIs, see <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/api-ref.html#api-overview">Overview of Amazon Q API operations</a>.</p>
+ *          <p>For information about the IAM access control permissions you need to
+ *             use this API, see <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/iam-roles.html">IAM roles for Amazon Q</a> in the
+ *                 <i>Amazon Q (for business use) Developer Guide</i>.</p>
+ *          <p>You can use the following AWS SDKs to access Amazon Q APIs:</p>
+ *          <ul>
+ *             <li>
+ *                <p>
+ *                   <a href="https://docs.aws.amazon.com/sdk-for-cpp">AWS SDK for C++</a>
+ *                </p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <a href="https://docs.aws.amazon.com/sdk-for-go">AWS SDK for Go</a>
+ *                </p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <a href="https://docs.aws.amazon.com/sdk-for-java">AWS SDK for Java</a>
+ *                </p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <a href="https://docs.aws.amazon.com/sdk-for-javascript">AWS SDK for
+ *                         JavaScript</a>
+ *                </p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <a href="https://docs.aws.amazon.com/sdk-for-net">AWS SDK for .NET</a>
+ *                </p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <a href="https://docs.aws.amazon.com/pythonsdk">AWS SDK for Python
+ *                     (Boto3)</a>
+ *                </p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <a href="https://docs.aws.amazon.com/sdk-for-ruby">AWS SDK for Ruby</a>
+ *                </p>
+ *             </li>
+ *          </ul>
+ *          <p>The following resources provide additional information about using the Amazon Q
+ *             API:</p>
+ *          <ul>
+ *             <li>
+ *                <p>
+ *                   <i>
+ *                      <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/setting-up.html">Setting up for
+ *                             Amazon Q</a>
+ *                   </i>
+ *                </p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <i>
+ *                      <a href="https://awscli.amazonaws.com/v2/documentation/api/latest/reference/qbusiness/index.html">Amazon Q CLI Reference</a>
+ *                   </i>
+ *                </p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <i>
+ *                      <a href="https://docs.aws.amazon.com/general/latest/gr/amazonq.html">Amazon Web Services General Reference</a>
+ *                   </i>
+ *                </p>
+ *             </li>
+ *          </ul>
  *
  * @packageDocumentation
  */

package/dist-types/models/models_0.d.ts CHANGED Viewed

@@ -930,7 +930,7 @@ export declare namespace DocumentAttributeValue {
 /**
  * @public
  * <p>The condition used for the target document attribute or metadata field when ingesting
- *             documents into Amazon Q. You use this with <a href="https://docs.aws.amazon.com/enterpriseq/latest/APIReference/API_DocumentAttributeTarget.html">
+ *             documents into Amazon Q. You use this with <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeTarget.html">
  *                <code>DocumentAttributeTarget</code>
  *             </a> to apply the condition.</p>
  *          <p>For example, you can create the 'Department' target field and have it prefill
@@ -1002,11 +1002,11 @@ export type AttributeValueOperator = (typeof AttributeValueOperator)[keyof typeo
  *             information from each document's metadata.</p>
  *          <p>Amazon Q can't create a target field if it has not already been created as an
  *             index field. After you create your index field, you can create a document metadata field
- *             using <a href="https://docs.aws.amazon.com/enterpriseq/latest/APIReference/API_DocumentAttributeTarget.html">
+ *             using <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeTarget.html">
  *                <code>DocumentAttributeTarget</code>
  *             </a>. Amazon Q
  *             will then map your newly created document attribute to your index field.</p>
- *          <p>You can also use this with <a href="https://docs.aws.amazon.com/enterpriseq/latest/APIReference/API_DocumentAttributeCondition.html">
+ *          <p>You can also use this with <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeCondition.html">
  *                <code>DocumentAttributeCondition</code>
  *             </a>.</p>
  */
@@ -1037,7 +1037,7 @@ export interface DocumentAttributeTarget {
  * @public
  * <p>Provides the configuration information for applying basic logic to alter document
  *             metadata and content when ingesting documents into Amazon Q.</p>
- *          <p>To apply advanced logic, to go beyond what you can do with basic logic, see <a href="https://docs.aws.amazon.com/enterpriseq/latest/APIReference/API_HookConfiguration.html">
+ *          <p>To apply advanced logic, to go beyond what you can do with basic logic, see <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_HookConfiguration.html">
  *                <code>HookConfiguration</code>
  *             </a>.</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>
@@ -1046,7 +1046,7 @@ export interface InlineDocumentEnrichmentConfiguration {
     /**
      * @public
      * <p>The condition used for the target document attribute or metadata field when ingesting
-     *             documents into Amazon Q. You use this with <a href="https://docs.aws.amazon.com/enterpriseq/latest/APIReference/API_DocumentAttributeTarget.html">
+     *             documents into Amazon Q. You use this with <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeTarget.html">
      *                <code>DocumentAttributeTarget</code>
      *             </a> to apply the condition.</p>
      *          <p>For example, you can create the 'Department' target field and have it prefill
@@ -1071,11 +1071,11 @@ export interface InlineDocumentEnrichmentConfiguration {
      *             information from each document's metadata.</p>
      *          <p>Amazon Q can't create a target field if it has not already been created as an
      *             index field. After you create your index field, you can create a document metadata field
-     *             using <a href="https://docs.aws.amazon.com/enterpriseq/latest/APIReference/API_DocumentAttributeTarget.html">
+     *             using <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeTarget.html">
      *                <code>DocumentAttributeTarget</code>
      *             </a>. Amazon Q
      *             will then map your newly created document attribute to your index field.</p>
-     *          <p>You can also use this with <a href="https://docs.aws.amazon.com/enterpriseq/latest/APIReference/API_DocumentAttributeCondition.html">
+     *          <p>You can also use this with <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeCondition.html">
      *                <code>DocumentAttributeCondition</code>
      *             </a>.</p>
      */
@@ -1093,10 +1093,10 @@ export interface InlineDocumentEnrichmentConfiguration {
  * <p>Provides the configuration information for invoking a Lambda function in
  *                 Lambda to alter document metadata and content when ingesting
  *             documents into Amazon Q.</p>
- *          <p>You can configure your Lambda function using <a href="https://docs.aws.amazon.com/enterpriseq/latest/APIReference/API_CustomDocumentEnrichmentConfiguration.html">PreExtractionHookConfiguration</a> if you want to apply advanced alterations on
+ *          <p>You can configure your Lambda function using <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentEnrichmentConfiguration.html">PreExtractionHookConfiguration</a> 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 structured documents,
- *             you must configure your Lambda function using <a href="https://docs.aws.amazon.com/enterpriseq/latest/APIReference/API_CustomDocumentEnrichmentConfiguration.html">PostExtractionHookConfiguration</a>.</p>
+ *             you must configure your Lambda function using <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentEnrichmentConfiguration.html">PostExtractionHookConfiguration</a>.</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>
@@ -1112,8 +1112,8 @@ export interface HookConfiguration {
     /**
      * @public
      * <p>The Amazon Resource Name (ARN) of a role with permission to run a Lambda
-     *             function during ingestion. For more information, see <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/iam-roles.html#cde-iam-role">IAM roles for Custom
-     *                 Document Enrichment (CDE)</a>.</p>
+     *             function during ingestion. For more information, see <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/iam-roles.html#cde-iam-role">IAM roles for
+     *                 Custom Document Enrichment (CDE)</a>.</p>
      */
     lambdaArn?: string;
     /**
@@ -1150,10 +1150,10 @@ export interface DocumentEnrichmentConfiguration {
      * <p>Provides the configuration information for invoking a Lambda function in
      *                 Lambda to alter document metadata and content when ingesting
      *             documents into Amazon Q.</p>
-     *          <p>You can configure your Lambda function using <a href="https://docs.aws.amazon.com/enterpriseq/latest/APIReference/API_CustomDocumentEnrichmentConfiguration.html">PreExtractionHookConfiguration</a> if you want to apply advanced alterations on
+     *          <p>You can configure your Lambda function using <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentEnrichmentConfiguration.html">PreExtractionHookConfiguration</a> 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 structured documents,
-     *             you must configure your Lambda function using <a href="https://docs.aws.amazon.com/enterpriseq/latest/APIReference/API_CustomDocumentEnrichmentConfiguration.html">PostExtractionHookConfiguration</a>.</p>
+     *             you must configure your Lambda function using <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentEnrichmentConfiguration.html">PostExtractionHookConfiguration</a>.</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>
@@ -1164,10 +1164,10 @@ export interface DocumentEnrichmentConfiguration {
      * <p>Provides the configuration information for invoking a Lambda function in
      *                 Lambda to alter document metadata and content when ingesting
      *             documents into Amazon Q.</p>
-     *          <p>You can configure your Lambda function using <a href="https://docs.aws.amazon.com/enterpriseq/latest/APIReference/API_CustomDocumentEnrichmentConfiguration.html">PreExtractionHookConfiguration</a> if you want to apply advanced alterations on
+     *          <p>You can configure your Lambda function using <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentEnrichmentConfiguration.html">PreExtractionHookConfiguration</a> 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 structured documents,
-     *             you must configure your Lambda function using <a href="https://docs.aws.amazon.com/enterpriseq/latest/APIReference/API_CustomDocumentEnrichmentConfiguration.html">PostExtractionHookConfiguration</a>.</p>
+     *             you must configure your Lambda function using <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentEnrichmentConfiguration.html">PostExtractionHookConfiguration</a>.</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>
@@ -2315,6 +2315,217 @@ export interface KendraIndexConfiguration {
      */
     indexId: string | undefined;
 }
+/**
+ * @public
+ * @enum
+ */
+export declare const DocumentAttributeBoostingLevel: {
+    readonly HIGH: "HIGH";
+    readonly LOW: "LOW";
+    readonly MEDIUM: "MEDIUM";
+    readonly NONE: "NONE";
+    readonly VERY_HIGH: "VERY_HIGH";
+};
+/**
+ * @public
+ */
+export type DocumentAttributeBoostingLevel = (typeof DocumentAttributeBoostingLevel)[keyof typeof DocumentAttributeBoostingLevel];
+/**
+ * @public
+ * <p>Provides information on boosting <code>DATE</code> type document attributes.</p>
+ *          <p>For more information on how boosting document attributes work in Amazon Q, see
+ *                 <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/metadata-boosting.html">Boosting using document attributes</a>.</p>
+ */
+export interface DateAttributeBoostingConfiguration {
+    /**
+     * @public
+     * <p>Specifies how much a document attribute is boosted.</p>
+     */
+    boostingLevel: DocumentAttributeBoostingLevel | undefined;
+    /**
+     * @public
+     * <p>Specifies the duration, in seconds, of a boost applies to a <code>DATE</code> type
+     *             document attribute.</p>
+     */
+    boostingDurationInSeconds?: number;
+}
+/**
+ * @public
+ * @enum
+ */
+export declare const NumberAttributeBoostingType: {
+    readonly PRIORITIZE_LARGER_VALUES: "PRIORITIZE_LARGER_VALUES";
+    readonly PRIORITIZE_SMALLER_VALUES: "PRIORITIZE_SMALLER_VALUES";
+};
+/**
+ * @public
+ */
+export type NumberAttributeBoostingType = (typeof NumberAttributeBoostingType)[keyof typeof NumberAttributeBoostingType];
+/**
+ * @public
+ * <p>Provides information on boosting <code>NUMBER</code> type document attributes.</p>
+ *          <p>For more information on how boosting document attributes work in Amazon Q, see
+ *                 <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/metadata-boosting.html">Boosting using document attributes</a>.</p>
+ */
+export interface NumberAttributeBoostingConfiguration {
+    /**
+     * @public
+     * <p>Specifies the duration, in seconds, of a boost applies to a <code>NUMBER</code> type
+     *             document attribute.</p>
+     */
+    boostingLevel: DocumentAttributeBoostingLevel | undefined;
+    /**
+     * @public
+     * <p>Specifies how much a document attribute is boosted.</p>
+     */
+    boostingType?: NumberAttributeBoostingType;
+}
+/**
+ * @public
+ * @enum
+ */
+export declare const StringAttributeValueBoostingLevel: {
+    readonly HIGH: "HIGH";
+    readonly LOW: "LOW";
+    readonly MEDIUM: "MEDIUM";
+    readonly VERY_HIGH: "VERY_HIGH";
+};
+/**
+ * @public
+ */
+export type StringAttributeValueBoostingLevel = (typeof StringAttributeValueBoostingLevel)[keyof typeof StringAttributeValueBoostingLevel];
+/**
+ * @public
+ * <p>Provides information on boosting <code>STRING</code> type document attributes.</p>
+ *          <note>
+ *             <p>For <code>STRING</code> and <code>STRING_LIST</code> type document attributes to
+ *                 be used for boosting on the console and the API, they must be enabled for search
+ *                 using the <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeConfiguration.html">DocumentAttributeConfiguration</a> object of the <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_UpdateIndex.html">UpdateIndex</a> API. If you haven't enabled searching on these attributes,
+ *                 you can't boost attributes of these data types on either the console or the
+ *                 API.</p>
+ *          </note>
+ *          <p>For more information on how boosting document attributes work in Amazon Q, see
+ *                 <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/metadata-boosting.html">Boosting using document attributes</a>.</p>
+ */
+export interface StringAttributeBoostingConfiguration {
+    /**
+     * @public
+     * <p>Specifies how much a document attribute is boosted.</p>
+     */
+    boostingLevel: DocumentAttributeBoostingLevel | undefined;
+    /**
+     * @public
+     * <p>Specifies specific values of a <code>STRING</code> type document attribute being
+     *             boosted.</p>
+     */
+    attributeValueBoosting?: Record<string, StringAttributeValueBoostingLevel>;
+}
+/**
+ * @public
+ * <p>Provides information on boosting <code>STRING_LIST</code> type document
+ *             attributes.</p>
+ *          <note>
+ *             <p>For <code>STRING</code> and <code>STRING_LIST</code> type document attributes to
+ *                 be used for boosting on the console and the API, they must be enabled for search
+ *                 using the <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeConfiguration.html">DocumentAttributeConfiguration</a> object of the <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_UpdateIndex.html">UpdateIndex</a> API. If you haven't enabled searching on these attributes,
+ *                 you can't boost attributes of these data types on either the console or the
+ *                 API.</p>
+ *          </note>
+ *          <p>For more information on how boosting document attributes work in Amazon Q, see
+ *                 <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/metadata-boosting.html">Boosting using document attributes</a>.</p>
+ */
+export interface StringListAttributeBoostingConfiguration {
+    /**
+     * @public
+     * <p>Specifies how much a document attribute is boosted.</p>
+     */
+    boostingLevel: DocumentAttributeBoostingLevel | undefined;
+}
+/**
+ * @public
+ * <p>Provides information on boosting supported Amazon Q document attribute types.
+ *             When an end user chat query matches document attributes that have been boosted,
+ *             Amazon Q prioritizes generating responses from content that matches the boosted
+ *             document attributes.</p>
+ *          <note>
+ *             <p>For <code>STRING</code> and <code>STRING_LIST</code> type document attributes to
+ *                 be used for boosting on the console and the API, they must be enabled for search
+ *                 using the <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeConfiguration.html">DocumentAttributeConfiguration</a> object of the <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_UpdateIndex.html">UpdateIndex</a> API. If you haven't enabled searching on these attributes,
+ *                 you can't boost attributes of these data types on either the console or the
+ *                 API.</p>
+ *          </note>
+ *          <p>For more information on how boosting document attributes work in Amazon Q, see
+ *                 <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/metadata-boosting.html">Boosting using document attributes</a>.</p>
+ */
+export type DocumentAttributeBoostingConfiguration = DocumentAttributeBoostingConfiguration.DateConfigurationMember | DocumentAttributeBoostingConfiguration.NumberConfigurationMember | DocumentAttributeBoostingConfiguration.StringConfigurationMember | DocumentAttributeBoostingConfiguration.StringListConfigurationMember | DocumentAttributeBoostingConfiguration.$UnknownMember;
+/**
+ * @public
+ */
+export declare namespace DocumentAttributeBoostingConfiguration {
+    /**
+     * @public
+     * <p>Provides information on boosting <code>NUMBER</code> type document attributes.</p>
+     */
+    interface NumberConfigurationMember {
+        numberConfiguration: NumberAttributeBoostingConfiguration;
+        stringConfiguration?: never;
+        dateConfiguration?: never;
+        stringListConfiguration?: never;
+        $unknown?: never;
+    }
+    /**
+     * @public
+     * <p>Provides information on boosting <code>STRING</code> type document attributes.</p>
+     */
+    interface StringConfigurationMember {
+        numberConfiguration?: never;
+        stringConfiguration: StringAttributeBoostingConfiguration;
+        dateConfiguration?: never;
+        stringListConfiguration?: never;
+        $unknown?: never;
+    }
+    /**
+     * @public
+     * <p>Provides information on boosting <code>DATE</code> type document attributes.</p>
+     */
+    interface DateConfigurationMember {
+        numberConfiguration?: never;
+        stringConfiguration?: never;
+        dateConfiguration: DateAttributeBoostingConfiguration;
+        stringListConfiguration?: never;
+        $unknown?: never;
+    }
+    /**
+     * @public
+     * <p>Provides information on boosting <code>STRING_LIST</code> type document
+     *             attributes.</p>
+     */
+    interface StringListConfigurationMember {
+        numberConfiguration?: never;
+        stringConfiguration?: never;
+        dateConfiguration?: never;
+        stringListConfiguration: StringListAttributeBoostingConfiguration;
+        $unknown?: never;
+    }
+    /**
+     * @public
+     */
+    interface $UnknownMember {
+        numberConfiguration?: never;
+        stringConfiguration?: never;
+        dateConfiguration?: never;
+        stringListConfiguration?: never;
+        $unknown: [string, any];
+    }
+    interface Visitor<T> {
+        numberConfiguration: (value: NumberAttributeBoostingConfiguration) => T;
+        stringConfiguration: (value: StringAttributeBoostingConfiguration) => T;
+        dateConfiguration: (value: DateAttributeBoostingConfiguration) => T;
+        stringListConfiguration: (value: StringListAttributeBoostingConfiguration) => T;
+        _: (name: string, value: any) => T;
+    }
+    const visit: <T>(value: DocumentAttributeBoostingConfiguration, visitor: Visitor<T>) => T;
+}
 /**
  * @public
  * <p>Configuration information for an Amazon Q index.</p>
@@ -2325,6 +2536,12 @@ export interface NativeIndexConfiguration {
      * <p>The identifier for the Amazon Q index.</p>
      */
     indexId: string | undefined;
+    /**
+     * @public
+     * <p>Overrides the default boosts applied by Amazon Q to supported document attribute
+     *             data types.</p>
+     */
+    boostingOverride?: Record<string, DocumentAttributeBoostingConfiguration>;
 }
 /**
  * @public
@@ -4032,7 +4249,7 @@ export interface Rule {
     excludedUsersAndGroups?: UsersAndGroups;
     /**
      * @public
-     * <p>The type fo rule.</p>
+     * <p>The type of rule.</p>
      */
     ruleType: RuleType | undefined;
     /**
@@ -4053,7 +4270,7 @@ export interface TopicConfiguration {
     name: string | undefined;
     /**
      * @public
-     * <p>A description for your topic control configuration. Use this outline how the large
+     * <p>A description for your topic control configuration. Use this to outline how the large
      *             language model (LLM) should use this topic control configuration.</p>
      */
     description?: string;
@@ -4566,8 +4783,12 @@ export declare const MessageUsefulnessReason: {
     readonly HARMFUL_OR_UNSAFE: "HARMFUL_OR_UNSAFE";
     readonly HELPFUL: "HELPFUL";
     readonly INCORRECT_OR_MISSING_SOURCES: "INCORRECT_OR_MISSING_SOURCES";
+    readonly NOT_BASED_ON_DOCUMENTS: "NOT_BASED_ON_DOCUMENTS";
+    readonly NOT_COMPLETE: "NOT_COMPLETE";
+    readonly NOT_CONCISE: "NOT_CONCISE";
     readonly NOT_FACTUALLY_CORRECT: "NOT_FACTUALLY_CORRECT";
     readonly NOT_HELPFUL: "NOT_HELPFUL";
+    readonly OTHER: "OTHER";
     readonly RELEVANT_SOURCES: "RELEVANT_SOURCES";
 };
 /**
@@ -4942,8 +5163,7 @@ export interface UpdateUserResponse {
 }
 /**
  * @public
- * <p>Enables filtering of Amazon Q web experience responses based on document
- *             attributes or metadata fields.</p>
+ * <p>Enables filtering of responses based on document attributes or metadata fields.</p>
  */
 export interface AttributeFilter {
     /**

package/dist-types/ts3.4/models/models_0.d.ts CHANGED Viewed

@@ -652,8 +652,103 @@ export interface UpdatePluginResponse {}
 export interface KendraIndexConfiguration {
   indexId: string | undefined;
 }
+export declare const DocumentAttributeBoostingLevel: {
+  readonly HIGH: "HIGH";
+  readonly LOW: "LOW";
+  readonly MEDIUM: "MEDIUM";
+  readonly NONE: "NONE";
+  readonly VERY_HIGH: "VERY_HIGH";
+};
+export type DocumentAttributeBoostingLevel =
+  (typeof DocumentAttributeBoostingLevel)[keyof typeof DocumentAttributeBoostingLevel];
+export interface DateAttributeBoostingConfiguration {
+  boostingLevel: DocumentAttributeBoostingLevel | undefined;
+  boostingDurationInSeconds?: number;
+}
+export declare const NumberAttributeBoostingType: {
+  readonly PRIORITIZE_LARGER_VALUES: "PRIORITIZE_LARGER_VALUES";
+  readonly PRIORITIZE_SMALLER_VALUES: "PRIORITIZE_SMALLER_VALUES";
+};
+export type NumberAttributeBoostingType =
+  (typeof NumberAttributeBoostingType)[keyof typeof NumberAttributeBoostingType];
+export interface NumberAttributeBoostingConfiguration {
+  boostingLevel: DocumentAttributeBoostingLevel | undefined;
+  boostingType?: NumberAttributeBoostingType;
+}
+export declare const StringAttributeValueBoostingLevel: {
+  readonly HIGH: "HIGH";
+  readonly LOW: "LOW";
+  readonly MEDIUM: "MEDIUM";
+  readonly VERY_HIGH: "VERY_HIGH";
+};
+export type StringAttributeValueBoostingLevel =
+  (typeof StringAttributeValueBoostingLevel)[keyof typeof StringAttributeValueBoostingLevel];
+export interface StringAttributeBoostingConfiguration {
+  boostingLevel: DocumentAttributeBoostingLevel | undefined;
+  attributeValueBoosting?: Record<string, StringAttributeValueBoostingLevel>;
+}
+export interface StringListAttributeBoostingConfiguration {
+  boostingLevel: DocumentAttributeBoostingLevel | undefined;
+}
+export type DocumentAttributeBoostingConfiguration =
+  | DocumentAttributeBoostingConfiguration.DateConfigurationMember
+  | DocumentAttributeBoostingConfiguration.NumberConfigurationMember
+  | DocumentAttributeBoostingConfiguration.StringConfigurationMember
+  | DocumentAttributeBoostingConfiguration.StringListConfigurationMember
+  | DocumentAttributeBoostingConfiguration.$UnknownMember;
+export declare namespace DocumentAttributeBoostingConfiguration {
+  interface NumberConfigurationMember {
+    numberConfiguration: NumberAttributeBoostingConfiguration;
+    stringConfiguration?: never;
+    dateConfiguration?: never;
+    stringListConfiguration?: never;
+    $unknown?: never;
+  }
+  interface StringConfigurationMember {
+    numberConfiguration?: never;
+    stringConfiguration: StringAttributeBoostingConfiguration;
+    dateConfiguration?: never;
+    stringListConfiguration?: never;
+    $unknown?: never;
+  }
+  interface DateConfigurationMember {
+    numberConfiguration?: never;
+    stringConfiguration?: never;
+    dateConfiguration: DateAttributeBoostingConfiguration;
+    stringListConfiguration?: never;
+    $unknown?: never;
+  }
+  interface StringListConfigurationMember {
+    numberConfiguration?: never;
+    stringConfiguration?: never;
+    dateConfiguration?: never;
+    stringListConfiguration: StringListAttributeBoostingConfiguration;
+    $unknown?: never;
+  }
+  interface $UnknownMember {
+    numberConfiguration?: never;
+    stringConfiguration?: never;
+    dateConfiguration?: never;
+    stringListConfiguration?: never;
+    $unknown: [string, any];
+  }
+  interface Visitor<T> {
+    numberConfiguration: (value: NumberAttributeBoostingConfiguration) => T;
+    stringConfiguration: (value: StringAttributeBoostingConfiguration) => T;
+    dateConfiguration: (value: DateAttributeBoostingConfiguration) => T;
+    stringListConfiguration: (
+      value: StringListAttributeBoostingConfiguration
+    ) => T;
+    _: (name: string, value: any) => T;
+  }
+  const visit: <T>(
+    value: DocumentAttributeBoostingConfiguration,
+    visitor: Visitor<T>
+  ) => T;
+}
 export interface NativeIndexConfiguration {
   indexId: string | undefined;
+  boostingOverride?: Record<string, DocumentAttributeBoostingConfiguration>;
 }
 export type RetrieverConfiguration =
   | RetrieverConfiguration.KendraIndexConfigurationMember
@@ -1280,8 +1375,12 @@ export declare const MessageUsefulnessReason: {
   readonly HARMFUL_OR_UNSAFE: "HARMFUL_OR_UNSAFE";
   readonly HELPFUL: "HELPFUL";
   readonly INCORRECT_OR_MISSING_SOURCES: "INCORRECT_OR_MISSING_SOURCES";
+  readonly NOT_BASED_ON_DOCUMENTS: "NOT_BASED_ON_DOCUMENTS";
+  readonly NOT_COMPLETE: "NOT_COMPLETE";
+  readonly NOT_CONCISE: "NOT_CONCISE";
   readonly NOT_FACTUALLY_CORRECT: "NOT_FACTUALLY_CORRECT";
   readonly NOT_HELPFUL: "NOT_HELPFUL";
+  readonly OTHER: "OTHER";
   readonly RELEVANT_SOURCES: "RELEVANT_SOURCES";
 };
 export type MessageUsefulnessReason =

package/package.json CHANGED Viewed

@@ -1,7 +1,7 @@
 {
   "name": "@aws-sdk/client-qbusiness",
   "description": "AWS SDK for JavaScript Qbusiness Client for Node.js, Browser and React Native",
-  "version": "3.513.0",
+  "version": "3.515.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "node ../../scripts/compilation/inline client-qbusiness",
@@ -20,18 +20,18 @@
   "dependencies": {
     "@aws-crypto/sha256-browser": "3.0.0",
     "@aws-crypto/sha256-js": "3.0.0",
-    "@aws-sdk/client-sts": "3.513.0",
+    "@aws-sdk/client-sts": "3.515.0",
     "@aws-sdk/core": "3.513.0",
-    "@aws-sdk/credential-provider-node": "3.513.0",
-    "@aws-sdk/middleware-host-header": "3.511.0",
-    "@aws-sdk/middleware-logger": "3.511.0",
-    "@aws-sdk/middleware-recursion-detection": "3.511.0",
-    "@aws-sdk/middleware-user-agent": "3.511.0",
-    "@aws-sdk/region-config-resolver": "3.511.0",
-    "@aws-sdk/types": "3.511.0",
-    "@aws-sdk/util-endpoints": "3.511.0",
-    "@aws-sdk/util-user-agent-browser": "3.511.0",
-    "@aws-sdk/util-user-agent-node": "3.511.0",
+    "@aws-sdk/credential-provider-node": "3.515.0",
+    "@aws-sdk/middleware-host-header": "3.515.0",
+    "@aws-sdk/middleware-logger": "3.515.0",
+    "@aws-sdk/middleware-recursion-detection": "3.515.0",
+    "@aws-sdk/middleware-user-agent": "3.515.0",
+    "@aws-sdk/region-config-resolver": "3.515.0",
+    "@aws-sdk/types": "3.515.0",
+    "@aws-sdk/util-endpoints": "3.515.0",
+    "@aws-sdk/util-user-agent-browser": "3.515.0",
+    "@aws-sdk/util-user-agent-node": "3.515.0",
     "@smithy/config-resolver": "^2.1.1",
     "@smithy/core": "^1.3.2",
     "@smithy/fetch-http-handler": "^2.4.1",
@@ -58,13 +58,13 @@
     "@smithy/util-retry": "^2.1.1",
     "@smithy/util-utf8": "^2.1.1",
     "tslib": "^2.5.0",
-    "uuid": "^8.3.2"
+    "uuid": "^9.0.1"
   },
   "devDependencies": {
     "@smithy/service-client-documentation-generator": "^2.1.1",
     "@tsconfig/node14": "1.0.3",
     "@types/node": "^14.14.31",
-    "@types/uuid": "^8.3.0",
+    "@types/uuid": "^9.0.4",
     "concurrently": "7.0.0",
     "downlevel-dts": "0.10.1",
     "rimraf": "3.0.2",