Skip to content

Commit 63be40d

Browse files
author
awstools
committed
feat(client-qconnect): This release adds a new QiC public API updateSession and updates an existing QiC public API createSession
1 parent fe4fa7f commit 63be40d

21 files changed

+1030
-342
lines changed

‎clients/client-qconnect/README.md‎

Lines changed: 19 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -9,18 +9,18 @@ AWS SDK for JavaScript QConnect Client for Node.js, Browser and React Native.
99
<note>
1010
<p>
1111
<b>Powered by Amazon Bedrock</b>: Amazon Web Services implements <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/abuse-detection.html">automated abuse
12-
detection</a>. Because Amazon Q in Connect is built on Amazon Bedrock, users can take full
13-
advantage of the controls implemented in Amazon Bedrock to enforce safety, security, and the
14-
responsible use of artificial intelligence (AI).</p>
12+
detection</a>. Because Amazon Q in Connect is built on Amazon Bedrock, users can take full advantage of
13+
the controls implemented in Amazon Bedrock to enforce safety, security, and the responsible use of
14+
artificial intelligence (AI).</p>
1515
</note>
16-
<p>Amazon Q in Connect is a generative AI customer service assistant. It is an LLM-enhanced evolution
17-
of Amazon Connect Wisdom that delivers real-time recommendations to help contact center
18-
agents resolve customer issues quickly and accurately.</p>
19-
<p>Amazon Q automatically detects customer intent during calls and chats using
20-
conversational analytics and natural language understanding (NLU). It then provides agents
21-
with immediate, real-time generative responses and suggested actions, and links to relevant
22-
documents and articles. Agents can also query Amazon Q directly using natural language or
23-
keywords to answer customer requests.</p>
16+
<p>Amazon Q in Connect is a generative AI customer service assistant. It is an LLM-enhanced
17+
evolution of Amazon Connect Wisdom that delivers real-time recommendations to help contact
18+
center agents resolve customer issues quickly and accurately.</p>
19+
<p>Amazon Q in Connect automatically detects customer intent during calls and chats using conversational
20+
analytics and natural language understanding (NLU). It then provides agents with immediate,
21+
real-time generative responses and suggested actions, and links to relevant documents and
22+
articles. Agents can also query Amazon Q in Connect directly using natural language or keywords to answer
23+
customer requests.</p>
2424
<p>Use the Amazon Q in Connect APIs to create an assistant and a knowledge base, for example, or
2525
manage content by uploading custom files.</p>
2626
<p>For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/amazon-q-connect.html">Use Amazon Q in Connect for generative AI
@@ -558,3 +558,11 @@ UpdateQuickResponse
558558
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/qconnect/command/UpdateQuickResponseCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-qconnect/Interface/UpdateQuickResponseCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-qconnect/Interface/UpdateQuickResponseCommandOutput/)
559559

560560
</details>
561+
<details>
562+
<summary>
563+
UpdateSession
564+
</summary>
565+
566+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/qconnect/command/UpdateSessionCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-qconnect/Interface/UpdateSessionCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-qconnect/Interface/UpdateSessionCommandOutput/)
567+
568+
</details>

‎clients/client-qconnect/src/QConnect.ts‎

Lines changed: 28 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -196,6 +196,11 @@ import {
196196
UpdateQuickResponseCommandInput,
197197
UpdateQuickResponseCommandOutput,
198198
} from "./commands/UpdateQuickResponseCommand";
199+
import {
200+
UpdateSessionCommand,
201+
UpdateSessionCommandInput,
202+
UpdateSessionCommandOutput,
203+
} from "./commands/UpdateSessionCommand";
199204
import { QConnectClient, QConnectClientConfig } from "./QConnectClient";
200205

201206
const commands = {
@@ -241,6 +246,7 @@ const commands = {
241246
UpdateContentCommand,
242247
UpdateKnowledgeBaseTemplateUriCommand,
243248
UpdateQuickResponseCommand,
249+
UpdateSessionCommand,
244250
};
245251

246252
export interface QConnect {
@@ -857,24 +863,35 @@ export interface QConnect {
857863
options: __HttpHandlerOptions,
858864
cb: (err: any, data?: UpdateQuickResponseCommandOutput) => void
859865
): void;
866+
867+
/**
868+
* @see {@link UpdateSessionCommand}
869+
*/
870+
updateSession(args: UpdateSessionCommandInput, options?: __HttpHandlerOptions): Promise<UpdateSessionCommandOutput>;
871+
updateSession(args: UpdateSessionCommandInput, cb: (err: any, data?: UpdateSessionCommandOutput) => void): void;
872+
updateSession(
873+
args: UpdateSessionCommandInput,
874+
options: __HttpHandlerOptions,
875+
cb: (err: any, data?: UpdateSessionCommandOutput) => void
876+
): void;
860877
}
861878

862879
/**
863880
* <note>
864881
* <p>
865882
* <b>Powered by Amazon Bedrock</b>: Amazon Web Services implements <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/abuse-detection.html">automated abuse
866-
* detection</a>. Because Amazon Q in Connect is built on Amazon Bedrock, users can take full
867-
* advantage of the controls implemented in Amazon Bedrock to enforce safety, security, and the
868-
* responsible use of artificial intelligence (AI).</p>
883+
* detection</a>. Because Amazon Q in Connect is built on Amazon Bedrock, users can take full advantage of
884+
* the controls implemented in Amazon Bedrock to enforce safety, security, and the responsible use of
885+
* artificial intelligence (AI).</p>
869886
* </note>
870-
* <p>Amazon Q in Connect is a generative AI customer service assistant. It is an LLM-enhanced evolution
871-
* of Amazon Connect Wisdom that delivers real-time recommendations to help contact center
872-
* agents resolve customer issues quickly and accurately.</p>
873-
* <p>Amazon Q automatically detects customer intent during calls and chats using
874-
* conversational analytics and natural language understanding (NLU). It then provides agents
875-
* with immediate, real-time generative responses and suggested actions, and links to relevant
876-
* documents and articles. Agents can also query Amazon Q directly using natural language or
877-
* keywords to answer customer requests.</p>
887+
* <p>Amazon Q in Connect is a generative AI customer service assistant. It is an LLM-enhanced
888+
* evolution of Amazon Connect Wisdom that delivers real-time recommendations to help contact
889+
* center agents resolve customer issues quickly and accurately.</p>
890+
* <p>Amazon Q in Connect automatically detects customer intent during calls and chats using conversational
891+
* analytics and natural language understanding (NLU). It then provides agents with immediate,
892+
* real-time generative responses and suggested actions, and links to relevant documents and
893+
* articles. Agents can also query Amazon Q in Connect directly using natural language or keywords to answer
894+
* customer requests.</p>
878895
* <p>Use the Amazon Q in Connect APIs to create an assistant and a knowledge base, for example, or
879896
* manage content by uploading custom files.</p>
880897
* <p>For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/amazon-q-connect.html">Use Amazon Q in Connect for generative AI

‎clients/client-qconnect/src/QConnectClient.ts‎

Lines changed: 16 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -137,6 +137,7 @@ import {
137137
UpdateQuickResponseCommandInput,
138138
UpdateQuickResponseCommandOutput,
139139
} from "./commands/UpdateQuickResponseCommand";
140+
import { UpdateSessionCommandInput, UpdateSessionCommandOutput } from "./commands/UpdateSessionCommand";
140141
import {
141142
ClientInputEndpointParameters,
142143
ClientResolvedEndpointParameters,
@@ -193,7 +194,8 @@ export type ServiceInputTypes =
193194
| UntagResourceCommandInput
194195
| UpdateContentCommandInput
195196
| UpdateKnowledgeBaseTemplateUriCommandInput
196-
| UpdateQuickResponseCommandInput;
197+
| UpdateQuickResponseCommandInput
198+
| UpdateSessionCommandInput;
197199

198200
/**
199201
* @public
@@ -240,7 +242,8 @@ export type ServiceOutputTypes =
240242
| UntagResourceCommandOutput
241243
| UpdateContentCommandOutput
242244
| UpdateKnowledgeBaseTemplateUriCommandOutput
243-
| UpdateQuickResponseCommandOutput;
245+
| UpdateQuickResponseCommandOutput
246+
| UpdateSessionCommandOutput;
244247

245248
/**
246249
* @public
@@ -417,18 +420,18 @@ export interface QConnectClientResolvedConfig extends QConnectClientResolvedConf
417420
* <note>
418421
* <p>
419422
* <b>Powered by Amazon Bedrock</b>: Amazon Web Services implements <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/abuse-detection.html">automated abuse
420-
* detection</a>. Because Amazon Q in Connect is built on Amazon Bedrock, users can take full
421-
* advantage of the controls implemented in Amazon Bedrock to enforce safety, security, and the
422-
* responsible use of artificial intelligence (AI).</p>
423+
* detection</a>. Because Amazon Q in Connect is built on Amazon Bedrock, users can take full advantage of
424+
* the controls implemented in Amazon Bedrock to enforce safety, security, and the responsible use of
425+
* artificial intelligence (AI).</p>
423426
* </note>
424-
* <p>Amazon Q in Connect is a generative AI customer service assistant. It is an LLM-enhanced evolution
425-
* of Amazon Connect Wisdom that delivers real-time recommendations to help contact center
426-
* agents resolve customer issues quickly and accurately.</p>
427-
* <p>Amazon Q automatically detects customer intent during calls and chats using
428-
* conversational analytics and natural language understanding (NLU). It then provides agents
429-
* with immediate, real-time generative responses and suggested actions, and links to relevant
430-
* documents and articles. Agents can also query Amazon Q directly using natural language or
431-
* keywords to answer customer requests.</p>
427+
* <p>Amazon Q in Connect is a generative AI customer service assistant. It is an LLM-enhanced
428+
* evolution of Amazon Connect Wisdom that delivers real-time recommendations to help contact
429+
* center agents resolve customer issues quickly and accurately.</p>
430+
* <p>Amazon Q in Connect automatically detects customer intent during calls and chats using conversational
431+
* analytics and natural language understanding (NLU). It then provides agents with immediate,
432+
* real-time generative responses and suggested actions, and links to relevant documents and
433+
* articles. Agents can also query Amazon Q in Connect directly using natural language or keywords to answer
434+
* customer requests.</p>
432435
* <p>Use the Amazon Q in Connect APIs to create an assistant and a knowledge base, for example, or
433436
* manage content by uploading custom files.</p>
434437
* <p>For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/amazon-q-connect.html">Use Amazon Q in Connect for generative AI

‎clients/client-qconnect/src/commands/CreateContentCommand.ts‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,7 @@ export interface CreateContentCommandInput extends CreateContentRequest {}
3131
export interface CreateContentCommandOutput extends CreateContentResponse, __MetadataBearer {}
3232

3333
/**
34-
* <p>Creates Amazon Q content. Before to calling this API, use <a href="https://docs.aws.amazon.com/amazon-q-connect/latest/APIReference/API_StartContentUpload.html">StartContentUpload</a> to
35-
* upload an asset.</p>
34+
* <p>Creates Amazon Q in Connect content. Before to calling this API, use <a href="https://docs.aws.amazon.com/amazon-q-connect/latest/APIReference/API_StartContentUpload.html">StartContentUpload</a> to upload an asset.</p>
3635
* @example
3736
* Use a bare-bones client and the command you need to make an API call.
3837
* ```javascript

‎clients/client-qconnect/src/commands/CreateQuickResponseCommand.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ export interface CreateQuickResponseCommandInput extends CreateQuickResponseRequ
3232
export interface CreateQuickResponseCommandOutput extends CreateQuickResponseResponse, __MetadataBearer {}
3333

3434
/**
35-
* <p>Creates an Amazon Q quick response.</p>
35+
* <p>Creates an Amazon Q in Connect quick response.</p>
3636
* @example
3737
* Use a bare-bones client and the command you need to make an API call.
3838
* ```javascript

‎clients/client-qconnect/src/commands/CreateSessionCommand.ts‎

Lines changed: 45 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,8 @@ export interface CreateSessionCommandOutput extends CreateSessionResponse, __Met
2828

2929
/**
3030
* <p>Creates a session. A session is a contextual container used for generating
31-
* recommendations. Amazon Connect creates a new Amazon Q session for each contact on which
32-
* Amazon Q is enabled.</p>
31+
* recommendations. Amazon Connect creates a new Amazon Q in Connect session for each contact on which
32+
* Amazon Q in Connect is enabled.</p>
3333
* @example
3434
* Use a bare-bones client and the command you need to make an API call.
3535
* ```javascript
@@ -44,6 +44,26 @@ export interface CreateSessionCommandOutput extends CreateSessionResponse, __Met
4444
* tags: { // Tags
4545
* "<keys>": "STRING_VALUE",
4646
* },
47+
* tagFilter: { // TagFilter Union: only one key present
48+
* tagCondition: { // TagCondition
49+
* key: "STRING_VALUE", // required
50+
* value: "STRING_VALUE",
51+
* },
52+
* andConditions: [ // AndConditions
53+
* {
54+
* key: "STRING_VALUE", // required
55+
* value: "STRING_VALUE",
56+
* },
57+
* ],
58+
* orConditions: [ // OrConditions
59+
* { // OrCondition Union: only one key present
60+
* andConditions: [
61+
* "<TagCondition>",
62+
* ],
63+
* tagCondition: "<TagCondition>",
64+
* },
65+
* ],
66+
* },
4767
* };
4868
* const command = new CreateSessionCommand(input);
4969
* const response = await client.send(command);
@@ -59,6 +79,26 @@ export interface CreateSessionCommandOutput extends CreateSessionResponse, __Met
5979
* // integrationConfiguration: { // SessionIntegrationConfiguration
6080
* // topicIntegrationArn: "STRING_VALUE",
6181
* // },
82+
* // tagFilter: { // TagFilter Union: only one key present
83+
* // tagCondition: { // TagCondition
84+
* // key: "STRING_VALUE", // required
85+
* // value: "STRING_VALUE",
86+
* // },
87+
* // andConditions: [ // AndConditions
88+
* // {
89+
* // key: "STRING_VALUE", // required
90+
* // value: "STRING_VALUE",
91+
* // },
92+
* // ],
93+
* // orConditions: [ // OrConditions
94+
* // { // OrCondition Union: only one key present
95+
* // andConditions: [
96+
* // "<TagCondition>",
97+
* // ],
98+
* // tagCondition: "<TagCondition>",
99+
* // },
100+
* // ],
101+
* // },
62102
* // },
63103
* // };
64104
*
@@ -70,6 +110,9 @@ export interface CreateSessionCommandOutput extends CreateSessionResponse, __Met
70110
* @see {@link CreateSessionCommandOutput} for command's `response` shape.
71111
* @see {@link QConnectClientResolvedConfig | config} for QConnectClient's `config` shape.
72112
*
113+
* @throws {@link AccessDeniedException} (client fault)
114+
* <p>You do not have sufficient access to perform this action.</p>
115+
*
73116
* @throws {@link ConflictException} (client fault)
74117
* <p>The request could not be processed because of conflict in the current state of the
75118
* resource. For example, if you're using a <code>Create</code> API (such as

‎clients/client-qconnect/src/commands/GetRecommendationsCommand.ts‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,13 @@ export interface GetRecommendationsCommandInput extends GetRecommendationsReques
3131
export interface GetRecommendationsCommandOutput extends GetRecommendationsResponse, __MetadataBearer {}
3232

3333
/**
34-
* <p>Retrieves recommendations for the specified session. To avoid retrieving the same
34+
* <important>
35+
* <p>This API will be discontinued starting June 1, 2024. To receive generative responses
36+
* after March 1, 2024, you will need to create a new Assistant in the Amazon Connect
37+
* console and integrate the Amazon Q in Connect JavaScript library (amazon-q-connectjs) into
38+
* your applications.</p>
39+
* </important>
40+
* <p>Retrieves recommendations for the specified session. To avoid retrieving the same
3541
* recommendations in subsequent calls, use <a href="https://docs.aws.amazon.com/amazon-q-connect/latest/APIReference/API_NotifyRecommendationsReceived.html">NotifyRecommendationsReceived</a>. This API supports long-polling behavior with the
3642
* <code>waitTimeSeconds</code> parameter. Short poll is the default behavior and only returns
3743
* recommendations already available. To perform a manual query against an assistant, use <a href="https://docs.aws.amazon.com/amazon-q-connect/latest/APIReference/API_QueryAssistant.html">QueryAssistant</a>.</p>

‎clients/client-qconnect/src/commands/GetSessionCommand.ts‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,26 @@ export interface GetSessionCommandOutput extends GetSessionResponse, __MetadataB
5252
* // integrationConfiguration: { // SessionIntegrationConfiguration
5353
* // topicIntegrationArn: "STRING_VALUE",
5454
* // },
55+
* // tagFilter: { // TagFilter Union: only one key present
56+
* // tagCondition: { // TagCondition
57+
* // key: "STRING_VALUE", // required
58+
* // value: "STRING_VALUE",
59+
* // },
60+
* // andConditions: [ // AndConditions
61+
* // {
62+
* // key: "STRING_VALUE", // required
63+
* // value: "STRING_VALUE",
64+
* // },
65+
* // ],
66+
* // orConditions: [ // OrConditions
67+
* // { // OrCondition Union: only one key present
68+
* // andConditions: [
69+
* // "<TagCondition>",
70+
* // ],
71+
* // tagCondition: "<TagCondition>",
72+
* // },
73+
* // ],
74+
* // },
5575
* // },
5676
* // };
5777
*

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,8 @@ export interface PutFeedbackCommandInput extends PutFeedbackRequest {}
2727
export interface PutFeedbackCommandOutput extends PutFeedbackResponse, __MetadataBearer {}
2828

2929
/**
30-
* <p>Provides feedback against the specified assistant for the specified target. This API only supports generative targets.</p>
30+
* <p>Provides feedback against the specified assistant for the specified target. This API only
31+
* supports generative targets.</p>
3132
* @example
3233
* Use a bare-bones client and the command you need to make an API call.
3334
* ```javascript

‎clients/client-qconnect/src/commands/QueryAssistantCommand.ts‎

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,9 +32,14 @@ export interface QueryAssistantCommandInput extends QueryAssistantRequest {}
3232
export interface QueryAssistantCommandOutput extends QueryAssistantResponse, __MetadataBearer {}
3333

3434
/**
35-
* <p>Performs a manual search against the specified assistant. To retrieve recommendations for
36-
* an assistant, use <a href="https://docs.aws.amazon.com/amazon-q-connect/latest/APIReference/API_GetRecommendations.html">GetRecommendations</a>.
37-
* </p>
35+
* <important>
36+
* <p>This API will be discontinued starting June 1, 2024. To receive generative responses
37+
* after March 1, 2024, you will need to create a new Assistant in the Amazon Connect
38+
* console and integrate the Amazon Q in Connect JavaScript library (amazon-q-connectjs) into
39+
* your applications.</p>
40+
* </important>
41+
* <p>Performs a manual search against the specified assistant. To retrieve recommendations for
42+
* an assistant, use <a href="https://docs.aws.amazon.com/amazon-q-connect/latest/APIReference/API_GetRecommendations.html">GetRecommendations</a>. </p>
3843
*
3944
* @deprecated QueryAssistant API will be discontinued starting June 1, 2024. To receive generative responses after March 1, 2024 you will need to create a new Assistant in the Connect console and integrate the Amazon Q in Connect JavaScript library (amazon-q-connectjs) into your applications.
4045
* @example

0 commit comments

Comments
 (0)