feat(client-qconnect): This release adds a new QiC public API updateS…

…ession and updates an existing QiC public API createSession
aws · Apr 10, 2024 · 63be40d · 63be40d
1 parent fe4fa7f
commit 63be40d
Show file tree

Hide file tree

Showing 21 changed files with 1,030 additions and 342 deletions.
diff --git a/clients/client-qconnect/README.md b/clients/client-qconnect/README.md
@@ -9,18 +9,18 @@ AWS SDK for JavaScript QConnect Client for Node.js, Browser and React Native.
 <note>
 <p>
 <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
-detection</a>. Because Amazon Q in Connect is built on Amazon Bedrock, users can take full
-advantage of the controls implemented in Amazon Bedrock to enforce safety, security, and the
-responsible use of artificial intelligence (AI).</p>
+detection</a>. Because Amazon Q in Connect is built on Amazon Bedrock, users can take full advantage of
+the controls implemented in Amazon Bedrock to enforce safety, security, and the responsible use of
+artificial intelligence (AI).</p>
 </note>
-<p>Amazon Q in Connect is a generative AI customer service assistant. It is an LLM-enhanced evolution
-of Amazon Connect Wisdom that delivers real-time recommendations to help contact center
-agents resolve customer issues quickly and accurately.</p>
-<p>Amazon Q automatically detects customer intent during calls and chats using
-conversational analytics and natural language understanding (NLU). It then provides agents
-with immediate, real-time generative responses and suggested actions, and links to relevant
-documents and articles. Agents can also query Amazon Q directly using natural language or
-keywords to answer customer requests.</p>
+<p>Amazon Q in Connect is a generative AI customer service assistant. It is an LLM-enhanced
+evolution of Amazon Connect Wisdom that delivers real-time recommendations to help contact
+center agents resolve customer issues quickly and accurately.</p>
+<p>Amazon Q in Connect automatically detects customer intent during calls and chats using conversational
+analytics and natural language understanding (NLU). It then provides agents with immediate,
+real-time generative responses and suggested actions, and links to relevant documents and
+articles. Agents can also query Amazon Q in Connect directly using natural language or keywords to answer
+customer requests.</p>
 <p>Use the Amazon Q in Connect APIs to create an assistant and a knowledge base, for example, or
 manage content by uploading custom files.</p>
 <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
 [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/)
 
 </details>
+<details>
+<summary>
+UpdateSession
+</summary>
+
+[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/)
+
+</details>
diff --git a/clients/client-qconnect/src/QConnect.ts b/clients/client-qconnect/src/QConnect.ts
@@ -196,6 +196,11 @@ import {
   UpdateQuickResponseCommandInput,
   UpdateQuickResponseCommandOutput,
 } from "./commands/UpdateQuickResponseCommand";
+import {
+  UpdateSessionCommand,
+  UpdateSessionCommandInput,
+  UpdateSessionCommandOutput,
+} from "./commands/UpdateSessionCommand";
 import { QConnectClient, QConnectClientConfig } from "./QConnectClient";
 
 const commands = {
@@ -241,6 +246,7 @@ const commands = {
   UpdateContentCommand,
   UpdateKnowledgeBaseTemplateUriCommand,
   UpdateQuickResponseCommand,
+  UpdateSessionCommand,
 };
 
 export interface QConnect {
@@ -857,24 +863,35 @@ export interface QConnect {
     options: __HttpHandlerOptions,
     cb: (err: any, data?: UpdateQuickResponseCommandOutput) => void
   ): void;
+
+  /**
+   * @see {@link UpdateSessionCommand}
+   */
+  updateSession(args: UpdateSessionCommandInput, options?: __HttpHandlerOptions): Promise<UpdateSessionCommandOutput>;
+  updateSession(args: UpdateSessionCommandInput, cb: (err: any, data?: UpdateSessionCommandOutput) => void): void;
+  updateSession(
+    args: UpdateSessionCommandInput,
+    options: __HttpHandlerOptions,
+    cb: (err: any, data?: UpdateSessionCommandOutput) => void
+  ): void;
 }
 
 /**
  * <note>
  *             <p>
  *                <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
- *       detection</a>. Because Amazon Q in Connect is built on Amazon Bedrock, users can take full
- *       advantage of the controls implemented in Amazon Bedrock to enforce safety, security, and the
- *       responsible use of artificial intelligence (AI).</p>
+ *           detection</a>. Because Amazon Q in Connect is built on Amazon Bedrock, users can take full advantage of
+ *         the controls implemented in Amazon Bedrock to enforce safety, security, and the responsible use of
+ *         artificial intelligence (AI).</p>
  *          </note>
- *          <p>Amazon Q in Connect is a generative AI customer service assistant. It is an LLM-enhanced evolution
- *       of Amazon Connect Wisdom that delivers real-time recommendations to help contact center
- *       agents resolve customer issues quickly and accurately.</p>
- *          <p>Amazon Q automatically detects customer intent during calls and chats using
- *       conversational analytics and natural language understanding (NLU). It then provides agents
- *       with immediate, real-time generative responses and suggested actions, and links to relevant
- *       documents and articles. Agents can also query Amazon Q directly using natural language or
- *       keywords to answer customer requests.</p>
+ *          <p>Amazon Q in Connect is a generative AI customer service assistant. It is an LLM-enhanced
+ *       evolution of Amazon Connect Wisdom that delivers real-time recommendations to help contact
+ *       center agents resolve customer issues quickly and accurately.</p>
+ *          <p>Amazon Q in Connect automatically detects customer intent during calls and chats using conversational
+ *       analytics and natural language understanding (NLU). It then provides agents with immediate,
+ *       real-time generative responses and suggested actions, and links to relevant documents and
+ *       articles. Agents can also query Amazon Q in Connect directly using natural language or keywords to answer
+ *       customer requests.</p>
  *          <p>Use the Amazon Q in Connect APIs to create an assistant and a knowledge base, for example, or
  *       manage content by uploading custom files.</p>
  *          <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

diff --git a/clients/client-qconnect/src/QConnectClient.ts b/clients/client-qconnect/src/QConnectClient.ts
@@ -137,6 +137,7 @@ import {
   UpdateQuickResponseCommandInput,
   UpdateQuickResponseCommandOutput,
 } from "./commands/UpdateQuickResponseCommand";
+import { UpdateSessionCommandInput, UpdateSessionCommandOutput } from "./commands/UpdateSessionCommand";
 import {
   ClientInputEndpointParameters,
   ClientResolvedEndpointParameters,
@@ -193,7 +194,8 @@ export type ServiceInputTypes =
   | UntagResourceCommandInput
   | UpdateContentCommandInput
   | UpdateKnowledgeBaseTemplateUriCommandInput
-  | UpdateQuickResponseCommandInput;
+  | UpdateQuickResponseCommandInput
+  | UpdateSessionCommandInput;
 
 /**
  * @public
@@ -240,7 +242,8 @@ export type ServiceOutputTypes =
   | UntagResourceCommandOutput
   | UpdateContentCommandOutput
   | UpdateKnowledgeBaseTemplateUriCommandOutput
-  | UpdateQuickResponseCommandOutput;
+  | UpdateQuickResponseCommandOutput
+  | UpdateSessionCommandOutput;
 
 /**
  * @public
@@ -417,18 +420,18 @@ export interface QConnectClientResolvedConfig extends QConnectClientResolvedConf
  * <note>
  *             <p>
  *                <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
- *       detection</a>. Because Amazon Q in Connect is built on Amazon Bedrock, users can take full
- *       advantage of the controls implemented in Amazon Bedrock to enforce safety, security, and the
- *       responsible use of artificial intelligence (AI).</p>
+ *           detection</a>. Because Amazon Q in Connect is built on Amazon Bedrock, users can take full advantage of
+ *         the controls implemented in Amazon Bedrock to enforce safety, security, and the responsible use of
+ *         artificial intelligence (AI).</p>
  *          </note>
- *          <p>Amazon Q in Connect is a generative AI customer service assistant. It is an LLM-enhanced evolution
- *       of Amazon Connect Wisdom that delivers real-time recommendations to help contact center
- *       agents resolve customer issues quickly and accurately.</p>
- *          <p>Amazon Q automatically detects customer intent during calls and chats using
- *       conversational analytics and natural language understanding (NLU). It then provides agents
- *       with immediate, real-time generative responses and suggested actions, and links to relevant
- *       documents and articles. Agents can also query Amazon Q directly using natural language or
- *       keywords to answer customer requests.</p>
+ *          <p>Amazon Q in Connect is a generative AI customer service assistant. It is an LLM-enhanced
+ *       evolution of Amazon Connect Wisdom that delivers real-time recommendations to help contact
+ *       center agents resolve customer issues quickly and accurately.</p>
+ *          <p>Amazon Q in Connect automatically detects customer intent during calls and chats using conversational
+ *       analytics and natural language understanding (NLU). It then provides agents with immediate,
+ *       real-time generative responses and suggested actions, and links to relevant documents and
+ *       articles. Agents can also query Amazon Q in Connect directly using natural language or keywords to answer
+ *       customer requests.</p>
  *          <p>Use the Amazon Q in Connect APIs to create an assistant and a knowledge base, for example, or
  *       manage content by uploading custom files.</p>
  *          <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

diff --git a/clients/client-qconnect/src/commands/CreateContentCommand.ts b/clients/client-qconnect/src/commands/CreateContentCommand.ts
@@ -31,8 +31,7 @@ export interface CreateContentCommandInput extends CreateContentRequest {}
 export interface CreateContentCommandOutput extends CreateContentResponse, __MetadataBearer {}
 
 /**
- * <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
- *       upload an asset.</p>
+ * <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>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

diff --git a/clients/client-qconnect/src/commands/CreateQuickResponseCommand.ts b/clients/client-qconnect/src/commands/CreateQuickResponseCommand.ts
@@ -32,7 +32,7 @@ export interface CreateQuickResponseCommandInput extends CreateQuickResponseRequ
 export interface CreateQuickResponseCommandOutput extends CreateQuickResponseResponse, __MetadataBearer {}
 
 /**
- * <p>Creates an Amazon Q quick response.</p>
+ * <p>Creates an Amazon Q in Connect quick response.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

diff --git a/clients/client-qconnect/src/commands/CreateSessionCommand.ts b/clients/client-qconnect/src/commands/CreateSessionCommand.ts
@@ -28,8 +28,8 @@ export interface CreateSessionCommandOutput extends CreateSessionResponse, __Met
 
 /**
  * <p>Creates a session. A session is a contextual container used for generating
- *       recommendations. Amazon Connect creates a new Amazon Q session for each contact on which
- *       Amazon Q is enabled.</p>
+ *       recommendations. Amazon Connect creates a new Amazon Q in Connect session for each contact on which
+ *       Amazon Q in Connect is enabled.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -44,6 +44,26 @@ export interface CreateSessionCommandOutput extends CreateSessionResponse, __Met
  *   tags: { // Tags
  *     "<keys>": "STRING_VALUE",
  *   },
+ *   tagFilter: { // TagFilter Union: only one key present
+ *     tagCondition: { // TagCondition
+ *       key: "STRING_VALUE", // required
+ *       value: "STRING_VALUE",
+ *     },
+ *     andConditions: [ // AndConditions
+ *       {
+ *         key: "STRING_VALUE", // required
+ *         value: "STRING_VALUE",
+ *       },
+ *     ],
+ *     orConditions: [ // OrConditions
+ *       { // OrCondition Union: only one key present
+ *         andConditions: [
+ *           "<TagCondition>",
+ *         ],
+ *         tagCondition: "<TagCondition>",
+ *       },
+ *     ],
+ *   },
  * };
  * const command = new CreateSessionCommand(input);
  * const response = await client.send(command);
@@ -59,6 +79,26 @@ export interface CreateSessionCommandOutput extends CreateSessionResponse, __Met
  * //     integrationConfiguration: { // SessionIntegrationConfiguration
  * //       topicIntegrationArn: "STRING_VALUE",
  * //     },
+ * //     tagFilter: { // TagFilter Union: only one key present
+ * //       tagCondition: { // TagCondition
+ * //         key: "STRING_VALUE", // required
+ * //         value: "STRING_VALUE",
+ * //       },
+ * //       andConditions: [ // AndConditions
+ * //         {
+ * //           key: "STRING_VALUE", // required
+ * //           value: "STRING_VALUE",
+ * //         },
+ * //       ],
+ * //       orConditions: [ // OrConditions
+ * //         { // OrCondition Union: only one key present
+ * //           andConditions: [
+ * //             "<TagCondition>",
+ * //           ],
+ * //           tagCondition: "<TagCondition>",
+ * //         },
+ * //       ],
+ * //     },
  * //   },
  * // };
  *
@@ -70,6 +110,9 @@ export interface CreateSessionCommandOutput extends CreateSessionResponse, __Met
  * @see {@link CreateSessionCommandOutput} for command's `response` shape.
  * @see {@link QConnectClientResolvedConfig | config} for QConnectClient's `config` shape.
  *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>You do not have sufficient access to perform this action.</p>
+ *
  * @throws {@link ConflictException} (client fault)
  *  <p>The request could not be processed because of conflict in the current state of the
  *       resource. For example, if you're using a <code>Create</code> API (such as

diff --git a/clients/client-qconnect/src/commands/GetRecommendationsCommand.ts b/clients/client-qconnect/src/commands/GetRecommendationsCommand.ts
@@ -31,7 +31,13 @@ export interface GetRecommendationsCommandInput extends GetRecommendationsReques
 export interface GetRecommendationsCommandOutput extends GetRecommendationsResponse, __MetadataBearer {}
 
 /**
- * <p>Retrieves recommendations for the specified session. To avoid retrieving the same
+ * <important>
+ *             <p>This 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 Amazon Connect
+ *         console and integrate the Amazon Q in Connect JavaScript library (amazon-q-connectjs) into
+ *         your applications.</p>
+ *          </important>
+ *          <p>Retrieves recommendations for the specified session. To avoid retrieving the same
  *       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
  *         <code>waitTimeSeconds</code> parameter. Short poll is the default behavior and only returns
  *       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>

diff --git a/clients/client-qconnect/src/commands/GetSessionCommand.ts b/clients/client-qconnect/src/commands/GetSessionCommand.ts
@@ -52,6 +52,26 @@ export interface GetSessionCommandOutput extends GetSessionResponse, __MetadataB
  * //     integrationConfiguration: { // SessionIntegrationConfiguration
  * //       topicIntegrationArn: "STRING_VALUE",
  * //     },
+ * //     tagFilter: { // TagFilter Union: only one key present
+ * //       tagCondition: { // TagCondition
+ * //         key: "STRING_VALUE", // required
+ * //         value: "STRING_VALUE",
+ * //       },
+ * //       andConditions: [ // AndConditions
+ * //         {
+ * //           key: "STRING_VALUE", // required
+ * //           value: "STRING_VALUE",
+ * //         },
+ * //       ],
+ * //       orConditions: [ // OrConditions
+ * //         { // OrCondition Union: only one key present
+ * //           andConditions: [
+ * //             "<TagCondition>",
+ * //           ],
+ * //           tagCondition: "<TagCondition>",
+ * //         },
+ * //       ],
+ * //     },
  * //   },
  * // };
  *

diff --git a/clients/client-qconnect/src/commands/PutFeedbackCommand.ts b/clients/client-qconnect/src/commands/PutFeedbackCommand.ts
@@ -27,7 +27,8 @@ export interface PutFeedbackCommandInput extends PutFeedbackRequest {}
 export interface PutFeedbackCommandOutput extends PutFeedbackResponse, __MetadataBearer {}
 
 /**
- * <p>Provides feedback against the specified assistant for the specified target. This API only supports generative targets.</p>
+ * <p>Provides feedback against the specified assistant for the specified target. This API only
+ *       supports generative targets.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

diff --git a/clients/client-qconnect/src/commands/QueryAssistantCommand.ts b/clients/client-qconnect/src/commands/QueryAssistantCommand.ts
@@ -32,9 +32,14 @@ export interface QueryAssistantCommandInput extends QueryAssistantRequest {}
 export interface QueryAssistantCommandOutput extends QueryAssistantResponse, __MetadataBearer {}
 
 /**
- * <p>Performs a manual search against the specified assistant. To retrieve recommendations for
- *       an assistant, use <a href="https://docs.aws.amazon.com/amazon-q-connect/latest/APIReference/API_GetRecommendations.html">GetRecommendations</a>.
- *     </p>
+ * <important>
+ *             <p>This 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 Amazon Connect
+ *         console and integrate the Amazon Q in Connect JavaScript library (amazon-q-connectjs) into
+ *         your applications.</p>
+ *          </important>
+ *          <p>Performs a manual search against the specified assistant. To retrieve recommendations for
+ *       an assistant, use <a href="https://docs.aws.amazon.com/amazon-q-connect/latest/APIReference/API_GetRecommendations.html">GetRecommendations</a>. </p>
  *
  * @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.
  * @example

diff --git a/clients/client-qconnect/src/commands/SearchQuickResponsesCommand.ts b/clients/client-qconnect/src/commands/SearchQuickResponsesCommand.ts
@@ -32,7 +32,7 @@ export interface SearchQuickResponsesCommandInput extends SearchQuickResponsesRe
 export interface SearchQuickResponsesCommandOutput extends SearchQuickResponsesResponse, __MetadataBearer {}
 
 /**
- * <p>Searches existing Amazon Q quick responses in an Amazon Q knowledge base.</p>
+ * <p>Searches existing Amazon Q in Connect quick responses in an Amazon Q in Connect knowledge base.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript