@aws-sdk/client-qbusiness 3.511.0 → 3.514.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 (37) hide show
  1. package/README.md +81 -0
  2. package/dist-cjs/auth/httpAuthExtensionConfiguration.js +1 -0
  3. package/dist-cjs/auth/httpAuthSchemeProvider.js +47 -0
  4. package/dist-cjs/index.js +193 -92
  5. package/dist-cjs/runtimeConfig.shared.js +10 -0
  6. package/dist-es/QBusinessClient.js +17 -4
  7. package/dist-es/auth/httpAuthExtensionConfiguration.js +38 -0
  8. package/dist-es/auth/httpAuthSchemeProvider.js +41 -0
  9. package/dist-es/models/models_0.js +35 -0
  10. package/dist-es/runtimeConfig.shared.js +10 -0
  11. package/dist-es/runtimeExtensions.js +3 -0
  12. package/dist-types/QBusiness.d.ts +83 -2
  13. package/dist-types/QBusinessClient.d.ts +96 -13
  14. package/dist-types/auth/httpAuthExtensionConfiguration.d.ts +29 -0
  15. package/dist-types/auth/httpAuthSchemeProvider.d.ts +61 -0
  16. package/dist-types/commands/CreateIndexCommand.d.ts +2 -2
  17. package/dist-types/commands/CreateRetrieverCommand.d.ts +21 -0
  18. package/dist-types/commands/GetRetrieverCommand.d.ts +21 -0
  19. package/dist-types/commands/PutFeedbackCommand.d.ts +1 -1
  20. package/dist-types/commands/UpdateRetrieverCommand.d.ts +21 -0
  21. package/dist-types/extensionConfiguration.d.ts +2 -1
  22. package/dist-types/index.d.ts +83 -2
  23. package/dist-types/models/models_0.d.ts +239 -19
  24. package/dist-types/runtimeConfig.browser.d.ts +5 -3
  25. package/dist-types/runtimeConfig.d.ts +4 -2
  26. package/dist-types/runtimeConfig.native.d.ts +6 -4
  27. package/dist-types/runtimeConfig.shared.d.ts +2 -0
  28. package/dist-types/ts3.4/QBusinessClient.d.ts +11 -9
  29. package/dist-types/ts3.4/auth/httpAuthExtensionConfiguration.d.ts +32 -0
  30. package/dist-types/ts3.4/auth/httpAuthSchemeProvider.d.ts +44 -0
  31. package/dist-types/ts3.4/extensionConfiguration.d.ts +3 -1
  32. package/dist-types/ts3.4/models/models_0.d.ts +99 -0
  33. package/dist-types/ts3.4/runtimeConfig.browser.d.ts +5 -5
  34. package/dist-types/ts3.4/runtimeConfig.d.ts +4 -4
  35. package/dist-types/ts3.4/runtimeConfig.native.d.ts +8 -8
  36. package/dist-types/ts3.4/runtimeConfig.shared.d.ts +2 -0
  37. package/package.json +7 -7
@@ -50,6 +50,27 @@ declare const GetRetrieverCommand_base: {
50
50
  * // configuration: { // RetrieverConfiguration Union: only one key present
51
51
  * // nativeIndexConfiguration: { // NativeIndexConfiguration
52
52
  * // indexId: "STRING_VALUE", // required
53
+ * // boostingOverride: { // DocumentAttributeBoostingOverrideMap
54
+ * // "<keys>": { // DocumentAttributeBoostingConfiguration Union: only one key present
55
+ * // numberConfiguration: { // NumberAttributeBoostingConfiguration
56
+ * // boostingLevel: "NONE" || "LOW" || "MEDIUM" || "HIGH" || "VERY_HIGH", // required
57
+ * // boostingType: "PRIORITIZE_LARGER_VALUES" || "PRIORITIZE_SMALLER_VALUES",
58
+ * // },
59
+ * // stringConfiguration: { // StringAttributeBoostingConfiguration
60
+ * // boostingLevel: "NONE" || "LOW" || "MEDIUM" || "HIGH" || "VERY_HIGH", // required
61
+ * // attributeValueBoosting: { // StringAttributeValueBoosting
62
+ * // "<keys>": "LOW" || "MEDIUM" || "HIGH" || "VERY_HIGH",
63
+ * // },
64
+ * // },
65
+ * // dateConfiguration: { // DateAttributeBoostingConfiguration
66
+ * // boostingLevel: "NONE" || "LOW" || "MEDIUM" || "HIGH" || "VERY_HIGH", // required
67
+ * // boostingDurationInSeconds: Number("long"),
68
+ * // },
69
+ * // stringListConfiguration: { // StringListAttributeBoostingConfiguration
70
+ * // boostingLevel: "NONE" || "LOW" || "MEDIUM" || "HIGH" || "VERY_HIGH", // required
71
+ * // },
72
+ * // },
73
+ * // },
53
74
  * // },
54
75
  * // kendraIndexConfiguration: { // KendraIndexConfiguration
55
76
  * // indexId: "STRING_VALUE", // required
@@ -42,7 +42,7 @@ declare const PutFeedbackCommand_base: {
42
42
  * messageCopiedAt: new Date("TIMESTAMP"),
43
43
  * messageUsefulness: { // MessageUsefulnessFeedback
44
44
  * usefulness: "USEFUL" || "NOT_USEFUL", // required
45
- * reason: "NOT_FACTUALLY_CORRECT" || "HARMFUL_OR_UNSAFE" || "INCORRECT_OR_MISSING_SOURCES" || "NOT_HELPFUL" || "FACTUALLY_CORRECT" || "COMPLETE" || "RELEVANT_SOURCES" || "HELPFUL",
45
+ * 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",
46
46
  * comment: "STRING_VALUE",
47
47
  * submittedAt: new Date("TIMESTAMP"), // required
48
48
  * },
@@ -39,6 +39,27 @@ declare const UpdateRetrieverCommand_base: {
39
39
  * configuration: { // RetrieverConfiguration Union: only one key present
40
40
  * nativeIndexConfiguration: { // NativeIndexConfiguration
41
41
  * indexId: "STRING_VALUE", // required
42
+ * boostingOverride: { // DocumentAttributeBoostingOverrideMap
43
+ * "<keys>": { // DocumentAttributeBoostingConfiguration Union: only one key present
44
+ * numberConfiguration: { // NumberAttributeBoostingConfiguration
45
+ * boostingLevel: "NONE" || "LOW" || "MEDIUM" || "HIGH" || "VERY_HIGH", // required
46
+ * boostingType: "PRIORITIZE_LARGER_VALUES" || "PRIORITIZE_SMALLER_VALUES",
47
+ * },
48
+ * stringConfiguration: { // StringAttributeBoostingConfiguration
49
+ * boostingLevel: "NONE" || "LOW" || "MEDIUM" || "HIGH" || "VERY_HIGH", // required
50
+ * attributeValueBoosting: { // StringAttributeValueBoosting
51
+ * "<keys>": "LOW" || "MEDIUM" || "HIGH" || "VERY_HIGH",
52
+ * },
53
+ * },
54
+ * dateConfiguration: { // DateAttributeBoostingConfiguration
55
+ * boostingLevel: "NONE" || "LOW" || "MEDIUM" || "HIGH" || "VERY_HIGH", // required
56
+ * boostingDurationInSeconds: Number("long"),
57
+ * },
58
+ * stringListConfiguration: { // StringListAttributeBoostingConfiguration
59
+ * boostingLevel: "NONE" || "LOW" || "MEDIUM" || "HIGH" || "VERY_HIGH", // required
60
+ * },
61
+ * },
62
+ * },
42
63
  * },
43
64
  * kendraIndexConfiguration: { // KendraIndexConfiguration
44
65
  * indexId: "STRING_VALUE", // required
@@ -1,8 +1,9 @@
1
1
  import { AwsRegionExtensionConfiguration } from "@aws-sdk/types";
2
2
  import { HttpHandlerExtensionConfiguration } from "@smithy/protocol-http";
3
3
  import { DefaultExtensionConfiguration } from "@smithy/types";
4
+ import { HttpAuthExtensionConfiguration } from "./auth/httpAuthExtensionConfiguration";
4
5
  /**
5
6
  * @internal
6
7
  */
7
- export interface QBusinessExtensionConfiguration extends HttpHandlerExtensionConfiguration, DefaultExtensionConfiguration, AwsRegionExtensionConfiguration {
8
+ export interface QBusinessExtensionConfiguration extends HttpHandlerExtensionConfiguration, DefaultExtensionConfiguration, AwsRegionExtensionConfiguration, HttpAuthExtensionConfiguration {
8
9
  }
@@ -1,6 +1,87 @@
1
1
  /**
2
- * <p>
3
- * </p>
2
+ * <note>
3
+ * <p>Amazon Q is in preview release and is subject to change.</p>
4
+ * </note>
5
+ * <p>This is the <i>Amazon Q (for business use)</i> API Reference.
6
+ * Amazon Q is a fully managed, generative-AI powered enterprise chat assistant that
7
+ * you can deploy within your organization. Amazon Q enhances employee productivity by
8
+ * supporting key tasks such as question-answering, knowledge discovery, writing email
9
+ * messages, summarizing text, drafting document outlines, and brainstorming ideas. Users
10
+ * ask questions of Amazon Q and get answers that are presented in a conversational
11
+ * manner. For an introduction to the service, see the <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/what-is.html">
12
+ * <i>Amazon Q (for business use) Developer
13
+ * Guide</i>
14
+ * </a>.</p>
15
+ * <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>
16
+ * <p>For information about the IAM access control permissions you need to
17
+ * 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
18
+ * <i>Amazon Q (for business use) Developer Guide</i>.</p>
19
+ * <p>You can use the following AWS SDKs to access Amazon Q APIs:</p>
20
+ * <ul>
21
+ * <li>
22
+ * <p>
23
+ * <a href="https://docs.aws.amazon.com/sdk-for-cpp">AWS SDK for C++</a>
24
+ * </p>
25
+ * </li>
26
+ * <li>
27
+ * <p>
28
+ * <a href="https://docs.aws.amazon.com/sdk-for-go">AWS SDK for Go</a>
29
+ * </p>
30
+ * </li>
31
+ * <li>
32
+ * <p>
33
+ * <a href="https://docs.aws.amazon.com/sdk-for-java">AWS SDK for Java</a>
34
+ * </p>
35
+ * </li>
36
+ * <li>
37
+ * <p>
38
+ * <a href="https://docs.aws.amazon.com/sdk-for-javascript">AWS SDK for
39
+ * JavaScript</a>
40
+ * </p>
41
+ * </li>
42
+ * <li>
43
+ * <p>
44
+ * <a href="https://docs.aws.amazon.com/sdk-for-net">AWS SDK for .NET</a>
45
+ * </p>
46
+ * </li>
47
+ * <li>
48
+ * <p>
49
+ * <a href="https://docs.aws.amazon.com/pythonsdk">AWS SDK for Python
50
+ * (Boto3)</a>
51
+ * </p>
52
+ * </li>
53
+ * <li>
54
+ * <p>
55
+ * <a href="https://docs.aws.amazon.com/sdk-for-ruby">AWS SDK for Ruby</a>
56
+ * </p>
57
+ * </li>
58
+ * </ul>
59
+ * <p>The following resources provide additional information about using the Amazon Q
60
+ * API:</p>
61
+ * <ul>
62
+ * <li>
63
+ * <p>
64
+ * <i>
65
+ * <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/setting-up.html">Setting up for
66
+ * Amazon Q</a>
67
+ * </i>
68
+ * </p>
69
+ * </li>
70
+ * <li>
71
+ * <p>
72
+ * <i>
73
+ * <a href="https://awscli.amazonaws.com/v2/documentation/api/latest/reference/qbusiness/index.html">Amazon Q CLI Reference</a>
74
+ * </i>
75
+ * </p>
76
+ * </li>
77
+ * <li>
78
+ * <p>
79
+ * <i>
80
+ * <a href="https://docs.aws.amazon.com/general/latest/gr/amazonq.html">Amazon Web Services General Reference</a>
81
+ * </i>
82
+ * </p>
83
+ * </li>
84
+ * </ul>
4
85
  *
5
86
  * @packageDocumentation
6
87
  */
@@ -930,7 +930,7 @@ export declare namespace DocumentAttributeValue {
930
930
  /**
931
931
  * @public
932
932
  * <p>The condition used for the target document attribute or metadata field when ingesting
933
- * documents into Amazon Q. You use this with <a href="https://docs.aws.amazon.com/enterpriseq/latest/APIReference/API_DocumentAttributeTarget.html">
933
+ * documents into Amazon Q. You use this with <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeTarget.html">
934
934
  * <code>DocumentAttributeTarget</code>
935
935
  * </a> to apply the condition.</p>
936
936
  * <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
1002
1002
  * information from each document's metadata.</p>
1003
1003
  * <p>Amazon Q can't create a target field if it has not already been created as an
1004
1004
  * index field. After you create your index field, you can create a document metadata field
1005
- * using <a href="https://docs.aws.amazon.com/enterpriseq/latest/APIReference/API_DocumentAttributeTarget.html">
1005
+ * using <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeTarget.html">
1006
1006
  * <code>DocumentAttributeTarget</code>
1007
1007
  * </a>. Amazon Q
1008
1008
  * will then map your newly created document attribute to your index field.</p>
1009
- * <p>You can also use this with <a href="https://docs.aws.amazon.com/enterpriseq/latest/APIReference/API_DocumentAttributeCondition.html">
1009
+ * <p>You can also use this with <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeCondition.html">
1010
1010
  * <code>DocumentAttributeCondition</code>
1011
1011
  * </a>.</p>
1012
1012
  */
@@ -1037,7 +1037,7 @@ export interface DocumentAttributeTarget {
1037
1037
  * @public
1038
1038
  * <p>Provides the configuration information for applying basic logic to alter document
1039
1039
  * metadata and content when ingesting documents into Amazon Q.</p>
1040
- * <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">
1040
+ * <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">
1041
1041
  * <code>HookConfiguration</code>
1042
1042
  * </a>.</p>
1043
1043
  * <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 {
1046
1046
  /**
1047
1047
  * @public
1048
1048
  * <p>The condition used for the target document attribute or metadata field when ingesting
1049
- * documents into Amazon Q. You use this with <a href="https://docs.aws.amazon.com/enterpriseq/latest/APIReference/API_DocumentAttributeTarget.html">
1049
+ * documents into Amazon Q. You use this with <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeTarget.html">
1050
1050
  * <code>DocumentAttributeTarget</code>
1051
1051
  * </a> to apply the condition.</p>
1052
1052
  * <p>For example, you can create the 'Department' target field and have it prefill
@@ -1071,11 +1071,11 @@ export interface InlineDocumentEnrichmentConfiguration {
1071
1071
  * information from each document's metadata.</p>
1072
1072
  * <p>Amazon Q can't create a target field if it has not already been created as an
1073
1073
  * index field. After you create your index field, you can create a document metadata field
1074
- * using <a href="https://docs.aws.amazon.com/enterpriseq/latest/APIReference/API_DocumentAttributeTarget.html">
1074
+ * using <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeTarget.html">
1075
1075
  * <code>DocumentAttributeTarget</code>
1076
1076
  * </a>. Amazon Q
1077
1077
  * will then map your newly created document attribute to your index field.</p>
1078
- * <p>You can also use this with <a href="https://docs.aws.amazon.com/enterpriseq/latest/APIReference/API_DocumentAttributeCondition.html">
1078
+ * <p>You can also use this with <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeCondition.html">
1079
1079
  * <code>DocumentAttributeCondition</code>
1080
1080
  * </a>.</p>
1081
1081
  */
@@ -1093,10 +1093,10 @@ export interface InlineDocumentEnrichmentConfiguration {
1093
1093
  * <p>Provides the configuration information for invoking a Lambda function in
1094
1094
  * Lambda to alter document metadata and content when ingesting
1095
1095
  * documents into Amazon Q.</p>
1096
- * <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
1096
+ * <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
1097
1097
  * the original or raw documents.</p>
1098
1098
  * <p>If you want to apply advanced alterations on the Amazon Q structured documents,
1099
- * you must configure your Lambda function using <a href="https://docs.aws.amazon.com/enterpriseq/latest/APIReference/API_CustomDocumentEnrichmentConfiguration.html">PostExtractionHookConfiguration</a>.</p>
1099
+ * you must configure your Lambda function using <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentEnrichmentConfiguration.html">PostExtractionHookConfiguration</a>.</p>
1100
1100
  * <p>You can only invoke one Lambda function. However, this function can invoke
1101
1101
  * other functions it requires.</p>
1102
1102
  * <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 {
1112
1112
  /**
1113
1113
  * @public
1114
1114
  * <p>The Amazon Resource Name (ARN) of a role with permission to run a Lambda
1115
- * 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
1116
- * Document Enrichment (CDE)</a>.</p>
1115
+ * 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
1116
+ * Custom Document Enrichment (CDE)</a>.</p>
1117
1117
  */
1118
1118
  lambdaArn?: string;
1119
1119
  /**
@@ -1150,10 +1150,10 @@ export interface DocumentEnrichmentConfiguration {
1150
1150
  * <p>Provides the configuration information for invoking a Lambda function in
1151
1151
  * Lambda to alter document metadata and content when ingesting
1152
1152
  * documents into Amazon Q.</p>
1153
- * <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
1153
+ * <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
1154
1154
  * the original or raw documents.</p>
1155
1155
  * <p>If you want to apply advanced alterations on the Amazon Q structured documents,
1156
- * you must configure your Lambda function using <a href="https://docs.aws.amazon.com/enterpriseq/latest/APIReference/API_CustomDocumentEnrichmentConfiguration.html">PostExtractionHookConfiguration</a>.</p>
1156
+ * you must configure your Lambda function using <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentEnrichmentConfiguration.html">PostExtractionHookConfiguration</a>.</p>
1157
1157
  * <p>You can only invoke one Lambda function. However, this function can invoke
1158
1158
  * other functions it requires.</p>
1159
1159
  * <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 {
1164
1164
  * <p>Provides the configuration information for invoking a Lambda function in
1165
1165
  * Lambda to alter document metadata and content when ingesting
1166
1166
  * documents into Amazon Q.</p>
1167
- * <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
1167
+ * <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
1168
1168
  * the original or raw documents.</p>
1169
1169
  * <p>If you want to apply advanced alterations on the Amazon Q structured documents,
1170
- * you must configure your Lambda function using <a href="https://docs.aws.amazon.com/enterpriseq/latest/APIReference/API_CustomDocumentEnrichmentConfiguration.html">PostExtractionHookConfiguration</a>.</p>
1170
+ * you must configure your Lambda function using <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentEnrichmentConfiguration.html">PostExtractionHookConfiguration</a>.</p>
1171
1171
  * <p>You can only invoke one Lambda function. However, this function can invoke
1172
1172
  * other functions it requires.</p>
1173
1173
  * <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 {
2315
2315
  */
2316
2316
  indexId: string | undefined;
2317
2317
  }
2318
+ /**
2319
+ * @public
2320
+ * @enum
2321
+ */
2322
+ export declare const DocumentAttributeBoostingLevel: {
2323
+ readonly HIGH: "HIGH";
2324
+ readonly LOW: "LOW";
2325
+ readonly MEDIUM: "MEDIUM";
2326
+ readonly NONE: "NONE";
2327
+ readonly VERY_HIGH: "VERY_HIGH";
2328
+ };
2329
+ /**
2330
+ * @public
2331
+ */
2332
+ export type DocumentAttributeBoostingLevel = (typeof DocumentAttributeBoostingLevel)[keyof typeof DocumentAttributeBoostingLevel];
2333
+ /**
2334
+ * @public
2335
+ * <p>Provides information on boosting <code>DATE</code> type document attributes.</p>
2336
+ * <p>For more information on how boosting document attributes work in Amazon Q, see
2337
+ * <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/metadata-boosting.html">Boosting using document attributes</a>.</p>
2338
+ */
2339
+ export interface DateAttributeBoostingConfiguration {
2340
+ /**
2341
+ * @public
2342
+ * <p>Specifies how much a document attribute is boosted.</p>
2343
+ */
2344
+ boostingLevel: DocumentAttributeBoostingLevel | undefined;
2345
+ /**
2346
+ * @public
2347
+ * <p>Specifies the duration, in seconds, of a boost applies to a <code>DATE</code> type
2348
+ * document attribute.</p>
2349
+ */
2350
+ boostingDurationInSeconds?: number;
2351
+ }
2352
+ /**
2353
+ * @public
2354
+ * @enum
2355
+ */
2356
+ export declare const NumberAttributeBoostingType: {
2357
+ readonly PRIORITIZE_LARGER_VALUES: "PRIORITIZE_LARGER_VALUES";
2358
+ readonly PRIORITIZE_SMALLER_VALUES: "PRIORITIZE_SMALLER_VALUES";
2359
+ };
2360
+ /**
2361
+ * @public
2362
+ */
2363
+ export type NumberAttributeBoostingType = (typeof NumberAttributeBoostingType)[keyof typeof NumberAttributeBoostingType];
2364
+ /**
2365
+ * @public
2366
+ * <p>Provides information on boosting <code>NUMBER</code> type document attributes.</p>
2367
+ * <p>For more information on how boosting document attributes work in Amazon Q, see
2368
+ * <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/metadata-boosting.html">Boosting using document attributes</a>.</p>
2369
+ */
2370
+ export interface NumberAttributeBoostingConfiguration {
2371
+ /**
2372
+ * @public
2373
+ * <p>Specifies the duration, in seconds, of a boost applies to a <code>NUMBER</code> type
2374
+ * document attribute.</p>
2375
+ */
2376
+ boostingLevel: DocumentAttributeBoostingLevel | undefined;
2377
+ /**
2378
+ * @public
2379
+ * <p>Specifies how much a document attribute is boosted.</p>
2380
+ */
2381
+ boostingType?: NumberAttributeBoostingType;
2382
+ }
2383
+ /**
2384
+ * @public
2385
+ * @enum
2386
+ */
2387
+ export declare const StringAttributeValueBoostingLevel: {
2388
+ readonly HIGH: "HIGH";
2389
+ readonly LOW: "LOW";
2390
+ readonly MEDIUM: "MEDIUM";
2391
+ readonly VERY_HIGH: "VERY_HIGH";
2392
+ };
2393
+ /**
2394
+ * @public
2395
+ */
2396
+ export type StringAttributeValueBoostingLevel = (typeof StringAttributeValueBoostingLevel)[keyof typeof StringAttributeValueBoostingLevel];
2397
+ /**
2398
+ * @public
2399
+ * <p>Provides information on boosting <code>STRING</code> type document attributes.</p>
2400
+ * <note>
2401
+ * <p>For <code>STRING</code> and <code>STRING_LIST</code> type document attributes to
2402
+ * be used for boosting on the console and the API, they must be enabled for search
2403
+ * 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,
2404
+ * you can't boost attributes of these data types on either the console or the
2405
+ * API.</p>
2406
+ * </note>
2407
+ * <p>For more information on how boosting document attributes work in Amazon Q, see
2408
+ * <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/metadata-boosting.html">Boosting using document attributes</a>.</p>
2409
+ */
2410
+ export interface StringAttributeBoostingConfiguration {
2411
+ /**
2412
+ * @public
2413
+ * <p>Specifies how much a document attribute is boosted.</p>
2414
+ */
2415
+ boostingLevel: DocumentAttributeBoostingLevel | undefined;
2416
+ /**
2417
+ * @public
2418
+ * <p>Specifies specific values of a <code>STRING</code> type document attribute being
2419
+ * boosted.</p>
2420
+ */
2421
+ attributeValueBoosting?: Record<string, StringAttributeValueBoostingLevel>;
2422
+ }
2423
+ /**
2424
+ * @public
2425
+ * <p>Provides information on boosting <code>STRING_LIST</code> type document
2426
+ * attributes.</p>
2427
+ * <note>
2428
+ * <p>For <code>STRING</code> and <code>STRING_LIST</code> type document attributes to
2429
+ * be used for boosting on the console and the API, they must be enabled for search
2430
+ * 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,
2431
+ * you can't boost attributes of these data types on either the console or the
2432
+ * API.</p>
2433
+ * </note>
2434
+ * <p>For more information on how boosting document attributes work in Amazon Q, see
2435
+ * <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/metadata-boosting.html">Boosting using document attributes</a>.</p>
2436
+ */
2437
+ export interface StringListAttributeBoostingConfiguration {
2438
+ /**
2439
+ * @public
2440
+ * <p>Specifies how much a document attribute is boosted.</p>
2441
+ */
2442
+ boostingLevel: DocumentAttributeBoostingLevel | undefined;
2443
+ }
2444
+ /**
2445
+ * @public
2446
+ * <p>Provides information on boosting supported Amazon Q document attribute types.
2447
+ * When an end user chat query matches document attributes that have been boosted,
2448
+ * Amazon Q prioritizes generating responses from content that matches the boosted
2449
+ * document attributes.</p>
2450
+ * <note>
2451
+ * <p>For <code>STRING</code> and <code>STRING_LIST</code> type document attributes to
2452
+ * be used for boosting on the console and the API, they must be enabled for search
2453
+ * 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,
2454
+ * you can't boost attributes of these data types on either the console or the
2455
+ * API.</p>
2456
+ * </note>
2457
+ * <p>For more information on how boosting document attributes work in Amazon Q, see
2458
+ * <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/metadata-boosting.html">Boosting using document attributes</a>.</p>
2459
+ */
2460
+ export type DocumentAttributeBoostingConfiguration = DocumentAttributeBoostingConfiguration.DateConfigurationMember | DocumentAttributeBoostingConfiguration.NumberConfigurationMember | DocumentAttributeBoostingConfiguration.StringConfigurationMember | DocumentAttributeBoostingConfiguration.StringListConfigurationMember | DocumentAttributeBoostingConfiguration.$UnknownMember;
2461
+ /**
2462
+ * @public
2463
+ */
2464
+ export declare namespace DocumentAttributeBoostingConfiguration {
2465
+ /**
2466
+ * @public
2467
+ * <p>Provides information on boosting <code>NUMBER</code> type document attributes.</p>
2468
+ */
2469
+ interface NumberConfigurationMember {
2470
+ numberConfiguration: NumberAttributeBoostingConfiguration;
2471
+ stringConfiguration?: never;
2472
+ dateConfiguration?: never;
2473
+ stringListConfiguration?: never;
2474
+ $unknown?: never;
2475
+ }
2476
+ /**
2477
+ * @public
2478
+ * <p>Provides information on boosting <code>STRING</code> type document attributes.</p>
2479
+ */
2480
+ interface StringConfigurationMember {
2481
+ numberConfiguration?: never;
2482
+ stringConfiguration: StringAttributeBoostingConfiguration;
2483
+ dateConfiguration?: never;
2484
+ stringListConfiguration?: never;
2485
+ $unknown?: never;
2486
+ }
2487
+ /**
2488
+ * @public
2489
+ * <p>Provides information on boosting <code>DATE</code> type document attributes.</p>
2490
+ */
2491
+ interface DateConfigurationMember {
2492
+ numberConfiguration?: never;
2493
+ stringConfiguration?: never;
2494
+ dateConfiguration: DateAttributeBoostingConfiguration;
2495
+ stringListConfiguration?: never;
2496
+ $unknown?: never;
2497
+ }
2498
+ /**
2499
+ * @public
2500
+ * <p>Provides information on boosting <code>STRING_LIST</code> type document
2501
+ * attributes.</p>
2502
+ */
2503
+ interface StringListConfigurationMember {
2504
+ numberConfiguration?: never;
2505
+ stringConfiguration?: never;
2506
+ dateConfiguration?: never;
2507
+ stringListConfiguration: StringListAttributeBoostingConfiguration;
2508
+ $unknown?: never;
2509
+ }
2510
+ /**
2511
+ * @public
2512
+ */
2513
+ interface $UnknownMember {
2514
+ numberConfiguration?: never;
2515
+ stringConfiguration?: never;
2516
+ dateConfiguration?: never;
2517
+ stringListConfiguration?: never;
2518
+ $unknown: [string, any];
2519
+ }
2520
+ interface Visitor<T> {
2521
+ numberConfiguration: (value: NumberAttributeBoostingConfiguration) => T;
2522
+ stringConfiguration: (value: StringAttributeBoostingConfiguration) => T;
2523
+ dateConfiguration: (value: DateAttributeBoostingConfiguration) => T;
2524
+ stringListConfiguration: (value: StringListAttributeBoostingConfiguration) => T;
2525
+ _: (name: string, value: any) => T;
2526
+ }
2527
+ const visit: <T>(value: DocumentAttributeBoostingConfiguration, visitor: Visitor<T>) => T;
2528
+ }
2318
2529
  /**
2319
2530
  * @public
2320
2531
  * <p>Configuration information for an Amazon Q index.</p>
@@ -2325,6 +2536,12 @@ export interface NativeIndexConfiguration {
2325
2536
  * <p>The identifier for the Amazon Q index.</p>
2326
2537
  */
2327
2538
  indexId: string | undefined;
2539
+ /**
2540
+ * @public
2541
+ * <p>Overrides the default boosts applied by Amazon Q to supported document attribute
2542
+ * data types.</p>
2543
+ */
2544
+ boostingOverride?: Record<string, DocumentAttributeBoostingConfiguration>;
2328
2545
  }
2329
2546
  /**
2330
2547
  * @public
@@ -4032,7 +4249,7 @@ export interface Rule {
4032
4249
  excludedUsersAndGroups?: UsersAndGroups;
4033
4250
  /**
4034
4251
  * @public
4035
- * <p>The type fo rule.</p>
4252
+ * <p>The type of rule.</p>
4036
4253
  */
4037
4254
  ruleType: RuleType | undefined;
4038
4255
  /**
@@ -4053,7 +4270,7 @@ export interface TopicConfiguration {
4053
4270
  name: string | undefined;
4054
4271
  /**
4055
4272
  * @public
4056
- * <p>A description for your topic control configuration. Use this outline how the large
4273
+ * <p>A description for your topic control configuration. Use this to outline how the large
4057
4274
  * language model (LLM) should use this topic control configuration.</p>
4058
4275
  */
4059
4276
  description?: string;
@@ -4566,8 +4783,12 @@ export declare const MessageUsefulnessReason: {
4566
4783
  readonly HARMFUL_OR_UNSAFE: "HARMFUL_OR_UNSAFE";
4567
4784
  readonly HELPFUL: "HELPFUL";
4568
4785
  readonly INCORRECT_OR_MISSING_SOURCES: "INCORRECT_OR_MISSING_SOURCES";
4786
+ readonly NOT_BASED_ON_DOCUMENTS: "NOT_BASED_ON_DOCUMENTS";
4787
+ readonly NOT_COMPLETE: "NOT_COMPLETE";
4788
+ readonly NOT_CONCISE: "NOT_CONCISE";
4569
4789
  readonly NOT_FACTUALLY_CORRECT: "NOT_FACTUALLY_CORRECT";
4570
4790
  readonly NOT_HELPFUL: "NOT_HELPFUL";
4791
+ readonly OTHER: "OTHER";
4571
4792
  readonly RELEVANT_SOURCES: "RELEVANT_SOURCES";
4572
4793
  };
4573
4794
  /**
@@ -4942,8 +5163,7 @@ export interface UpdateUserResponse {
4942
5163
  }
4943
5164
  /**
4944
5165
  * @public
4945
- * <p>Enables filtering of Amazon Q web experience responses based on document
4946
- * attributes or metadata fields.</p>
5166
+ * <p>Enables filtering of responses based on document attributes or metadata fields.</p>
4947
5167
  */
4948
5168
  export interface AttributeFilter {
4949
5169
  /**
@@ -7,7 +7,7 @@ export declare const getRuntimeConfig: (config: QBusinessClientConfig) => {
7
7
  runtime: string;
8
8
  defaultsMode: import("@smithy/types").Provider<import("@smithy/smithy-client").ResolvedDefaultsMode>;
9
9
  bodyLengthChecker: import("@smithy/types").BodyLengthCalculator;
10
- credentialDefaultProvider: (input: any) => import("@smithy/types").Provider<import("@aws-sdk/types").Credentials>;
10
+ credentialDefaultProvider: (input: any) => import("@smithy/types").AwsCredentialIdentityProvider;
11
11
  defaultUserAgentProvider: import("@smithy/types").Provider<import("@smithy/types").UserAgent>;
12
12
  maxAttempts: number | import("@smithy/types").Provider<number>;
13
13
  region: string | import("@smithy/types").Provider<any>;
@@ -36,11 +36,13 @@ export declare const getRuntimeConfig: (config: QBusinessClientConfig) => {
36
36
  }) => import("@smithy/types").EndpointV2;
37
37
  tls?: boolean | undefined;
38
38
  retryStrategy?: import("@smithy/types").RetryStrategy | import("@smithy/types").RetryStrategyV2 | undefined;
39
- credentials?: import("@smithy/types").AwsCredentialIdentity | import("@smithy/types").Provider<import("@smithy/types").AwsCredentialIdentity> | undefined;
39
+ customUserAgent?: string | import("@smithy/types").UserAgent | undefined;
40
+ httpAuthSchemes: import("@smithy/types").HttpAuthScheme[];
41
+ httpAuthSchemeProvider: import("./auth/httpAuthSchemeProvider").QBusinessHttpAuthSchemeProvider;
42
+ credentials?: import("@smithy/types").AwsCredentialIdentity | import("@smithy/types").AwsCredentialIdentityProvider | undefined;
40
43
  signer?: import("@smithy/types").RequestSigner | ((authScheme?: import("@smithy/types").AuthScheme | undefined) => Promise<import("@smithy/types").RequestSigner>) | undefined;
41
44
  signingEscapePath?: boolean | undefined;
42
45
  systemClockOffset?: number | undefined;
43
46
  signingRegion?: string | undefined;
44
47
  signerConstructor?: (new (options: import("@smithy/signature-v4").SignatureV4Init & import("@smithy/signature-v4").SignatureV4CryptoInit) => import("@smithy/types").RequestSigner) | undefined;
45
- customUserAgent?: string | import("@smithy/types").UserAgent | undefined;
46
48
  };
@@ -36,11 +36,13 @@ export declare const getRuntimeConfig: (config: QBusinessClientConfig) => {
36
36
  }) => import("@smithy/types").EndpointV2;
37
37
  tls?: boolean | undefined;
38
38
  retryStrategy?: import("@smithy/types").RetryStrategy | import("@smithy/types").RetryStrategyV2 | undefined;
39
- credentials?: import("@smithy/types").AwsCredentialIdentity | import("@smithy/types").Provider<import("@smithy/types").AwsCredentialIdentity> | undefined;
39
+ customUserAgent?: string | import("@smithy/types").UserAgent | undefined;
40
+ httpAuthSchemes: import("@smithy/types").HttpAuthScheme[];
41
+ httpAuthSchemeProvider: import("./auth/httpAuthSchemeProvider").QBusinessHttpAuthSchemeProvider;
42
+ credentials?: import("@smithy/types").AwsCredentialIdentity | import("@smithy/types").AwsCredentialIdentityProvider | undefined;
40
43
  signer?: import("@smithy/types").RequestSigner | ((authScheme?: import("@smithy/types").AuthScheme | undefined) => Promise<import("@smithy/types").RequestSigner>) | undefined;
41
44
  signingEscapePath?: boolean | undefined;
42
45
  systemClockOffset?: number | undefined;
43
46
  signingRegion?: string | undefined;
44
47
  signerConstructor?: (new (options: import("@smithy/signature-v4").SignatureV4Init & import("@smithy/signature-v4").SignatureV4CryptoInit) => import("@smithy/types").RequestSigner) | undefined;
45
- customUserAgent?: string | import("@smithy/types").UserAgent | undefined;
46
48
  };
@@ -21,9 +21,9 @@ export declare const getRuntimeConfig: (config: QBusinessClientConfig) => {
21
21
  serviceId: string;
22
22
  useDualstackEndpoint: boolean | import("@smithy/types").Provider<boolean>;
23
23
  useFipsEndpoint: boolean | import("@smithy/types").Provider<boolean>;
24
- region: string | import("@smithy/types").Provider<any>;
25
- credentialDefaultProvider: (input: any) => import("@smithy/types").Provider<import("@aws-sdk/types").Credentials>;
26
24
  defaultUserAgentProvider: import("@smithy/types").Provider<import("@smithy/types").UserAgent>;
25
+ region: string | import("@smithy/types").Provider<any>;
26
+ credentialDefaultProvider: (input: any) => import("@smithy/types").AwsCredentialIdentityProvider;
27
27
  maxAttempts: number | import("@smithy/types").Provider<number>;
28
28
  retryMode: string | import("@smithy/types").Provider<string>;
29
29
  logger: import("@smithy/types").Logger;
@@ -35,11 +35,13 @@ export declare const getRuntimeConfig: (config: QBusinessClientConfig) => {
35
35
  }) => import("@smithy/types").EndpointV2;
36
36
  tls?: boolean | undefined;
37
37
  retryStrategy?: import("@smithy/types").RetryStrategy | import("@smithy/types").RetryStrategyV2 | undefined;
38
- credentials?: import("@smithy/types").AwsCredentialIdentity | import("@smithy/types").Provider<import("@smithy/types").AwsCredentialIdentity> | undefined;
38
+ customUserAgent?: string | import("@smithy/types").UserAgent | undefined;
39
+ httpAuthSchemes: import("@smithy/types").HttpAuthScheme[];
40
+ httpAuthSchemeProvider: import("./auth/httpAuthSchemeProvider").QBusinessHttpAuthSchemeProvider;
41
+ credentials?: import("@smithy/types").AwsCredentialIdentity | import("@smithy/types").AwsCredentialIdentityProvider | undefined;
39
42
  signer?: import("@smithy/types").RequestSigner | ((authScheme?: import("@smithy/types").AuthScheme | undefined) => Promise<import("@smithy/types").RequestSigner>) | undefined;
40
43
  signingEscapePath?: boolean | undefined;
41
44
  systemClockOffset?: number | undefined;
42
45
  signingRegion?: string | undefined;
43
46
  signerConstructor?: (new (options: import("@smithy/signature-v4").SignatureV4Init & import("@smithy/signature-v4").SignatureV4CryptoInit) => import("@smithy/types").RequestSigner) | undefined;
44
- customUserAgent?: string | import("@smithy/types").UserAgent | undefined;
45
47
  };
@@ -11,6 +11,8 @@ export declare const getRuntimeConfig: (config: QBusinessClientConfig) => {
11
11
  logger?: import("@smithy/types").Logger | undefined;
12
12
  }) => import("@smithy/types").EndpointV2;
13
13
  extensions: import("./runtimeExtensions").RuntimeExtension[];
14
+ httpAuthSchemeProvider: import("./auth/httpAuthSchemeProvider").QBusinessHttpAuthSchemeProvider;
15
+ httpAuthSchemes: import("@smithy/types").HttpAuthScheme[];
14
16
  logger: import("@smithy/types").Logger;
15
17
  serviceId: string;
16
18
  urlParser: import("@smithy/types").UrlParser;