Skip to content

Commit 8fe8537

Browse files
author
awstools
committed
feat(client-qbusiness): This release adds the metadata-boosting feature, which allows customers to easily fine-tune the underlying ranking of retrieved RAG passages in order to optimize Q&A answer relevance. It also adds new feedback reasons for the PutFeedback API.
1 parent 424f63d commit 8fe8537

File tree

12 files changed

+975
-38
lines changed

12 files changed

+975
-38
lines changed

‎clients/client-qbusiness/README.md

+81
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,89 @@
66

77
AWS SDK for JavaScript QBusiness Client for Node.js, Browser and React Native.
88

9+
<note>
10+
<p>Amazon Q is in preview release and is subject to change.</p>
11+
</note>
12+
<p>This is the <i>Amazon Q (for business use)</i> API Reference.
13+
Amazon Q is a fully managed, generative-AI powered enterprise chat assistant that
14+
you can deploy within your organization. Amazon Q enhances employee productivity by
15+
supporting key tasks such as question-answering, knowledge discovery, writing email
16+
messages, summarizing text, drafting document outlines, and brainstorming ideas. Users
17+
ask questions of Amazon Q and get answers that are presented in a conversational
18+
manner. For an introduction to the service, see the <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/what-is.html">
19+
<i>Amazon Q (for business use) Developer
20+
Guide</i>
21+
</a>.</p>
22+
<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>
23+
<p>For information about the IAM access control permissions you need to
24+
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
25+
<i>Amazon Q (for business use) Developer Guide</i>.</p>
26+
<p>You can use the following AWS SDKs to access Amazon Q APIs:</p>
27+
<ul>
28+
<li>
929
<p>
30+
<a href="https://docs.aws.amazon.com/sdk-for-cpp">AWS SDK for C++</a>
1031
</p>
32+
</li>
33+
<li>
34+
<p>
35+
<a href="https://docs.aws.amazon.com/sdk-for-go">AWS SDK for Go</a>
36+
</p>
37+
</li>
38+
<li>
39+
<p>
40+
<a href="https://docs.aws.amazon.com/sdk-for-java">AWS SDK for Java</a>
41+
</p>
42+
</li>
43+
<li>
44+
<p>
45+
<a href="https://docs.aws.amazon.com/sdk-for-javascript">AWS SDK for
46+
JavaScript</a>
47+
</p>
48+
</li>
49+
<li>
50+
<p>
51+
<a href="https://docs.aws.amazon.com/sdk-for-net">AWS SDK for .NET</a>
52+
</p>
53+
</li>
54+
<li>
55+
<p>
56+
<a href="https://docs.aws.amazon.com/pythonsdk">AWS SDK for Python
57+
(Boto3)</a>
58+
</p>
59+
</li>
60+
<li>
61+
<p>
62+
<a href="https://docs.aws.amazon.com/sdk-for-ruby">AWS SDK for Ruby</a>
63+
</p>
64+
</li>
65+
</ul>
66+
<p>The following resources provide additional information about using the Amazon Q
67+
API:</p>
68+
<ul>
69+
<li>
70+
<p>
71+
<i>
72+
<a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/setting-up.html">Setting up for
73+
Amazon Q</a>
74+
</i>
75+
</p>
76+
</li>
77+
<li>
78+
<p>
79+
<i>
80+
<a href="https://awscli.amazonaws.com/v2/documentation/api/latest/reference/qbusiness/index.html">Amazon Q CLI Reference</a>
81+
</i>
82+
</p>
83+
</li>
84+
<li>
85+
<p>
86+
<i>
87+
<a href="https://docs.aws.amazon.com/general/latest/gr/amazonq.html">Amazon Web Services General Reference</a>
88+
</i>
89+
</p>
90+
</li>
91+
</ul>
1192

1293
## Installing
1394

‎clients/client-qbusiness/src/QBusiness.ts

+83-2
Original file line numberDiff line numberDiff line change
@@ -1030,8 +1030,89 @@ export interface QBusiness {
10301030

10311031
/**
10321032
* @public
1033-
* <p>
1034-
* </p>
1033+
* <note>
1034+
* <p>Amazon Q is in preview release and is subject to change.</p>
1035+
* </note>
1036+
* <p>This is the <i>Amazon Q (for business use)</i> API Reference.
1037+
* Amazon Q is a fully managed, generative-AI powered enterprise chat assistant that
1038+
* you can deploy within your organization. Amazon Q enhances employee productivity by
1039+
* supporting key tasks such as question-answering, knowledge discovery, writing email
1040+
* messages, summarizing text, drafting document outlines, and brainstorming ideas. Users
1041+
* ask questions of Amazon Q and get answers that are presented in a conversational
1042+
* manner. For an introduction to the service, see the <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/what-is.html">
1043+
* <i>Amazon Q (for business use) Developer
1044+
* Guide</i>
1045+
* </a>.</p>
1046+
* <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>
1047+
* <p>For information about the IAM access control permissions you need to
1048+
* 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
1049+
* <i>Amazon Q (for business use) Developer Guide</i>.</p>
1050+
* <p>You can use the following AWS SDKs to access Amazon Q APIs:</p>
1051+
* <ul>
1052+
* <li>
1053+
* <p>
1054+
* <a href="https://docs.aws.amazon.com/sdk-for-cpp">AWS SDK for C++</a>
1055+
* </p>
1056+
* </li>
1057+
* <li>
1058+
* <p>
1059+
* <a href="https://docs.aws.amazon.com/sdk-for-go">AWS SDK for Go</a>
1060+
* </p>
1061+
* </li>
1062+
* <li>
1063+
* <p>
1064+
* <a href="https://docs.aws.amazon.com/sdk-for-java">AWS SDK for Java</a>
1065+
* </p>
1066+
* </li>
1067+
* <li>
1068+
* <p>
1069+
* <a href="https://docs.aws.amazon.com/sdk-for-javascript">AWS SDK for
1070+
* JavaScript</a>
1071+
* </p>
1072+
* </li>
1073+
* <li>
1074+
* <p>
1075+
* <a href="https://docs.aws.amazon.com/sdk-for-net">AWS SDK for .NET</a>
1076+
* </p>
1077+
* </li>
1078+
* <li>
1079+
* <p>
1080+
* <a href="https://docs.aws.amazon.com/pythonsdk">AWS SDK for Python
1081+
* (Boto3)</a>
1082+
* </p>
1083+
* </li>
1084+
* <li>
1085+
* <p>
1086+
* <a href="https://docs.aws.amazon.com/sdk-for-ruby">AWS SDK for Ruby</a>
1087+
* </p>
1088+
* </li>
1089+
* </ul>
1090+
* <p>The following resources provide additional information about using the Amazon Q
1091+
* API:</p>
1092+
* <ul>
1093+
* <li>
1094+
* <p>
1095+
* <i>
1096+
* <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/setting-up.html">Setting up for
1097+
* Amazon Q</a>
1098+
* </i>
1099+
* </p>
1100+
* </li>
1101+
* <li>
1102+
* <p>
1103+
* <i>
1104+
* <a href="https://awscli.amazonaws.com/v2/documentation/api/latest/reference/qbusiness/index.html">Amazon Q CLI Reference</a>
1105+
* </i>
1106+
* </p>
1107+
* </li>
1108+
* <li>
1109+
* <p>
1110+
* <i>
1111+
* <a href="https://docs.aws.amazon.com/general/latest/gr/amazonq.html">Amazon Web Services General Reference</a>
1112+
* </i>
1113+
* </p>
1114+
* </li>
1115+
* </ul>
10351116
*/
10361117
export class QBusiness extends QBusinessClient implements QBusiness {}
10371118
createAggregatedClient(commands, QBusiness);

‎clients/client-qbusiness/src/QBusinessClient.ts

+83-2
Original file line numberDiff line numberDiff line change
@@ -445,8 +445,89 @@ export interface QBusinessClientResolvedConfig extends QBusinessClientResolvedCo
445445

446446
/**
447447
* @public
448-
* <p>
449-
* </p>
448+
* <note>
449+
* <p>Amazon Q is in preview release and is subject to change.</p>
450+
* </note>
451+
* <p>This is the <i>Amazon Q (for business use)</i> API Reference.
452+
* Amazon Q is a fully managed, generative-AI powered enterprise chat assistant that
453+
* you can deploy within your organization. Amazon Q enhances employee productivity by
454+
* supporting key tasks such as question-answering, knowledge discovery, writing email
455+
* messages, summarizing text, drafting document outlines, and brainstorming ideas. Users
456+
* ask questions of Amazon Q and get answers that are presented in a conversational
457+
* manner. For an introduction to the service, see the <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/what-is.html">
458+
* <i>Amazon Q (for business use) Developer
459+
* Guide</i>
460+
* </a>.</p>
461+
* <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>
462+
* <p>For information about the IAM access control permissions you need to
463+
* 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
464+
* <i>Amazon Q (for business use) Developer Guide</i>.</p>
465+
* <p>You can use the following AWS SDKs to access Amazon Q APIs:</p>
466+
* <ul>
467+
* <li>
468+
* <p>
469+
* <a href="https://docs.aws.amazon.com/sdk-for-cpp">AWS SDK for C++</a>
470+
* </p>
471+
* </li>
472+
* <li>
473+
* <p>
474+
* <a href="https://docs.aws.amazon.com/sdk-for-go">AWS SDK for Go</a>
475+
* </p>
476+
* </li>
477+
* <li>
478+
* <p>
479+
* <a href="https://docs.aws.amazon.com/sdk-for-java">AWS SDK for Java</a>
480+
* </p>
481+
* </li>
482+
* <li>
483+
* <p>
484+
* <a href="https://docs.aws.amazon.com/sdk-for-javascript">AWS SDK for
485+
* JavaScript</a>
486+
* </p>
487+
* </li>
488+
* <li>
489+
* <p>
490+
* <a href="https://docs.aws.amazon.com/sdk-for-net">AWS SDK for .NET</a>
491+
* </p>
492+
* </li>
493+
* <li>
494+
* <p>
495+
* <a href="https://docs.aws.amazon.com/pythonsdk">AWS SDK for Python
496+
* (Boto3)</a>
497+
* </p>
498+
* </li>
499+
* <li>
500+
* <p>
501+
* <a href="https://docs.aws.amazon.com/sdk-for-ruby">AWS SDK for Ruby</a>
502+
* </p>
503+
* </li>
504+
* </ul>
505+
* <p>The following resources provide additional information about using the Amazon Q
506+
* API:</p>
507+
* <ul>
508+
* <li>
509+
* <p>
510+
* <i>
511+
* <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/setting-up.html">Setting up for
512+
* Amazon Q</a>
513+
* </i>
514+
* </p>
515+
* </li>
516+
* <li>
517+
* <p>
518+
* <i>
519+
* <a href="https://awscli.amazonaws.com/v2/documentation/api/latest/reference/qbusiness/index.html">Amazon Q CLI Reference</a>
520+
* </i>
521+
* </p>
522+
* </li>
523+
* <li>
524+
* <p>
525+
* <i>
526+
* <a href="https://docs.aws.amazon.com/general/latest/gr/amazonq.html">Amazon Web Services General Reference</a>
527+
* </i>
528+
* </p>
529+
* </li>
530+
* </ul>
450531
*/
451532
export class QBusinessClient extends __Client<
452533
__HttpHandlerOptions,

‎clients/client-qbusiness/src/commands/CreateIndexCommand.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -32,9 +32,9 @@ export interface CreateIndexCommandOutput extends CreateIndexResponse, __Metadat
3232
* <p>To determine if index creation has completed, check the <code>Status</code> field
3333
* returned from a call to <code>DescribeIndex</code>. The <code>Status</code> field is set
3434
* to <code>ACTIVE</code> when the index is ready to use.</p>
35-
* <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">
35+
* <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">
3636
* <code>BatchPutDocument</code>
37-
* </a> API or the <a href="https://docs.aws.amazon.com/enterpriseq/latest/APIReference/API_CreateDataSource.html">
37+
* </a> API or the <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_CreateDataSource.html">
3838
* <code>CreateDataSource</code>
3939
* </a> API.</p>
4040
* @example

‎clients/client-qbusiness/src/commands/CreateRetrieverCommand.ts

+21
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,27 @@ export interface CreateRetrieverCommandOutput extends CreateRetrieverResponse, _
4242
* configuration: { // RetrieverConfiguration Union: only one key present
4343
* nativeIndexConfiguration: { // NativeIndexConfiguration
4444
* indexId: "STRING_VALUE", // required
45+
* boostingOverride: { // DocumentAttributeBoostingOverrideMap
46+
* "<keys>": { // DocumentAttributeBoostingConfiguration Union: only one key present
47+
* numberConfiguration: { // NumberAttributeBoostingConfiguration
48+
* boostingLevel: "NONE" || "LOW" || "MEDIUM" || "HIGH" || "VERY_HIGH", // required
49+
* boostingType: "PRIORITIZE_LARGER_VALUES" || "PRIORITIZE_SMALLER_VALUES",
50+
* },
51+
* stringConfiguration: { // StringAttributeBoostingConfiguration
52+
* boostingLevel: "NONE" || "LOW" || "MEDIUM" || "HIGH" || "VERY_HIGH", // required
53+
* attributeValueBoosting: { // StringAttributeValueBoosting
54+
* "<keys>": "LOW" || "MEDIUM" || "HIGH" || "VERY_HIGH",
55+
* },
56+
* },
57+
* dateConfiguration: { // DateAttributeBoostingConfiguration
58+
* boostingLevel: "NONE" || "LOW" || "MEDIUM" || "HIGH" || "VERY_HIGH", // required
59+
* boostingDurationInSeconds: Number("long"),
60+
* },
61+
* stringListConfiguration: { // StringListAttributeBoostingConfiguration
62+
* boostingLevel: "NONE" || "LOW" || "MEDIUM" || "HIGH" || "VERY_HIGH", // required
63+
* },
64+
* },
65+
* },
4566
* },
4667
* kendraIndexConfiguration: { // KendraIndexConfiguration
4768
* indexId: "STRING_VALUE", // required

‎clients/client-qbusiness/src/commands/GetRetrieverCommand.ts

+21
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,27 @@ export interface GetRetrieverCommandOutput extends GetRetrieverResponse, __Metad
5252
* // configuration: { // RetrieverConfiguration Union: only one key present
5353
* // nativeIndexConfiguration: { // NativeIndexConfiguration
5454
* // indexId: "STRING_VALUE", // required
55+
* // boostingOverride: { // DocumentAttributeBoostingOverrideMap
56+
* // "<keys>": { // DocumentAttributeBoostingConfiguration Union: only one key present
57+
* // numberConfiguration: { // NumberAttributeBoostingConfiguration
58+
* // boostingLevel: "NONE" || "LOW" || "MEDIUM" || "HIGH" || "VERY_HIGH", // required
59+
* // boostingType: "PRIORITIZE_LARGER_VALUES" || "PRIORITIZE_SMALLER_VALUES",
60+
* // },
61+
* // stringConfiguration: { // StringAttributeBoostingConfiguration
62+
* // boostingLevel: "NONE" || "LOW" || "MEDIUM" || "HIGH" || "VERY_HIGH", // required
63+
* // attributeValueBoosting: { // StringAttributeValueBoosting
64+
* // "<keys>": "LOW" || "MEDIUM" || "HIGH" || "VERY_HIGH",
65+
* // },
66+
* // },
67+
* // dateConfiguration: { // DateAttributeBoostingConfiguration
68+
* // boostingLevel: "NONE" || "LOW" || "MEDIUM" || "HIGH" || "VERY_HIGH", // required
69+
* // boostingDurationInSeconds: Number("long"),
70+
* // },
71+
* // stringListConfiguration: { // StringListAttributeBoostingConfiguration
72+
* // boostingLevel: "NONE" || "LOW" || "MEDIUM" || "HIGH" || "VERY_HIGH", // required
73+
* // },
74+
* // },
75+
* // },
5576
* // },
5677
* // kendraIndexConfiguration: { // KendraIndexConfiguration
5778
* // indexId: "STRING_VALUE", // required

‎clients/client-qbusiness/src/commands/PutFeedbackCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ export interface PutFeedbackCommandOutput extends __MetadataBearer {}
4444
* messageCopiedAt: new Date("TIMESTAMP"),
4545
* messageUsefulness: { // MessageUsefulnessFeedback
4646
* usefulness: "USEFUL" || "NOT_USEFUL", // required
47-
* reason: "NOT_FACTUALLY_CORRECT" || "HARMFUL_OR_UNSAFE" || "INCORRECT_OR_MISSING_SOURCES" || "NOT_HELPFUL" || "FACTUALLY_CORRECT" || "COMPLETE" || "RELEVANT_SOURCES" || "HELPFUL",
47+
* 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",
4848
* comment: "STRING_VALUE",
4949
* submittedAt: new Date("TIMESTAMP"), // required
5050
* },

‎clients/client-qbusiness/src/commands/UpdateRetrieverCommand.ts

+21
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,27 @@ export interface UpdateRetrieverCommandOutput extends UpdateRetrieverResponse, _
4141
* configuration: { // RetrieverConfiguration Union: only one key present
4242
* nativeIndexConfiguration: { // NativeIndexConfiguration
4343
* indexId: "STRING_VALUE", // required
44+
* boostingOverride: { // DocumentAttributeBoostingOverrideMap
45+
* "<keys>": { // DocumentAttributeBoostingConfiguration Union: only one key present
46+
* numberConfiguration: { // NumberAttributeBoostingConfiguration
47+
* boostingLevel: "NONE" || "LOW" || "MEDIUM" || "HIGH" || "VERY_HIGH", // required
48+
* boostingType: "PRIORITIZE_LARGER_VALUES" || "PRIORITIZE_SMALLER_VALUES",
49+
* },
50+
* stringConfiguration: { // StringAttributeBoostingConfiguration
51+
* boostingLevel: "NONE" || "LOW" || "MEDIUM" || "HIGH" || "VERY_HIGH", // required
52+
* attributeValueBoosting: { // StringAttributeValueBoosting
53+
* "<keys>": "LOW" || "MEDIUM" || "HIGH" || "VERY_HIGH",
54+
* },
55+
* },
56+
* dateConfiguration: { // DateAttributeBoostingConfiguration
57+
* boostingLevel: "NONE" || "LOW" || "MEDIUM" || "HIGH" || "VERY_HIGH", // required
58+
* boostingDurationInSeconds: Number("long"),
59+
* },
60+
* stringListConfiguration: { // StringListAttributeBoostingConfiguration
61+
* boostingLevel: "NONE" || "LOW" || "MEDIUM" || "HIGH" || "VERY_HIGH", // required
62+
* },
63+
* },
64+
* },
4465
* },
4566
* kendraIndexConfiguration: { // KendraIndexConfiguration
4667
* indexId: "STRING_VALUE", // required

0 commit comments

Comments
 (0)