@aws-sdk/client-qconnect 3.549.0 → 3.553.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 (33) hide show
  1. package/README.md +19 -11
  2. package/dist-cjs/index.js +80 -1
  3. package/dist-es/QConnect.js +2 -0
  4. package/dist-es/commands/UpdateSessionCommand.js +24 -0
  5. package/dist-es/commands/index.js +1 -0
  6. package/dist-es/models/models_0.js +22 -0
  7. package/dist-es/protocols/Aws_restJson1.js +31 -0
  8. package/dist-types/QConnect.d.ts +18 -11
  9. package/dist-types/QConnectClient.d.ts +14 -13
  10. package/dist-types/commands/CreateContentCommand.d.ts +1 -2
  11. package/dist-types/commands/CreateQuickResponseCommand.d.ts +1 -1
  12. package/dist-types/commands/CreateSessionCommand.d.ts +45 -2
  13. package/dist-types/commands/GetRecommendationsCommand.d.ts +7 -1
  14. package/dist-types/commands/GetSessionCommand.d.ts +20 -0
  15. package/dist-types/commands/PutFeedbackCommand.d.ts +2 -1
  16. package/dist-types/commands/QueryAssistantCommand.d.ts +8 -3
  17. package/dist-types/commands/SearchQuickResponsesCommand.d.ts +1 -1
  18. package/dist-types/commands/StartContentUploadCommand.d.ts +4 -2
  19. package/dist-types/commands/StartImportJobCommand.d.ts +5 -2
  20. package/dist-types/commands/UpdateKnowledgeBaseTemplateUriCommand.d.ts +1 -1
  21. package/dist-types/commands/UpdateQuickResponseCommand.d.ts +1 -1
  22. package/dist-types/commands/UpdateSessionCommand.d.ts +123 -0
  23. package/dist-types/commands/index.d.ts +1 -0
  24. package/dist-types/index.d.ts +11 -11
  25. package/dist-types/models/models_0.d.ts +316 -158
  26. package/dist-types/protocols/Aws_restJson1.d.ts +9 -0
  27. package/dist-types/ts3.4/QConnect.d.ts +17 -0
  28. package/dist-types/ts3.4/QConnectClient.d.ts +8 -2
  29. package/dist-types/ts3.4/commands/UpdateSessionCommand.d.ts +38 -0
  30. package/dist-types/ts3.4/commands/index.d.ts +1 -0
  31. package/dist-types/ts3.4/models/models_0.d.ts +80 -0
  32. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +12 -0
  33. package/package.json +10 -10
@@ -26,11 +26,14 @@ declare const StartImportJobCommand_base: {
26
26
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
27
27
  };
28
28
  /**
29
- * <p>Start an asynchronous job to import Amazon Q resources from an uploaded source file. Before calling this API, use <a href="https://docs.aws.amazon.com/wisdom/latest/APIReference/API_StartContentUpload.html">StartContentUpload</a> to
29
+ * <p>Start an asynchronous job to import Amazon Q in Connect resources from an uploaded source file.
30
+ * Before calling this API, use <a href="https://docs.aws.amazon.com/wisdom/latest/APIReference/API_StartContentUpload.html">StartContentUpload</a> to
30
31
  * upload an asset that contains the resource data.</p>
31
32
  * <ul>
32
33
  * <li>
33
- * <p>For importing Amazon Q quick responses, you need to upload a csv file including the quick responses. For information about how to format the csv file for importing quick responses, see <a href="https://docs.aws.amazon.com/console/connect/quick-responses/add-data">Import quick responses</a>.</p>
34
+ * <p>For importing Amazon Q in Connect quick responses, you need to upload a csv file including the
35
+ * quick responses. For information about how to format the csv file for importing quick
36
+ * responses, see <a href="https://docs.aws.amazon.com/console/connect/quick-responses/add-data">Import quick responses</a>.</p>
34
37
  * </li>
35
38
  * </ul>
36
39
  * @example
@@ -28,7 +28,7 @@ declare const UpdateKnowledgeBaseTemplateUriCommand_base: {
28
28
  /**
29
29
  * <p>Updates the template URI of a knowledge base. This is only supported for knowledge bases
30
30
  * of type EXTERNAL. Include a single variable in <code>$\{variable\}</code> format; this
31
- * interpolated by Amazon Q using ingested content. For example, if you ingest a Salesforce
31
+ * interpolated by Amazon Q in Connect using ingested content. For example, if you ingest a Salesforce
32
32
  * article, it has an <code>Id</code> value, and you can set the template URI to
33
33
  * <code>https://myInstanceName.lightning.force.com/lightning/r/Knowledge__kav/*$\{Id\}*\/view</code>.
34
34
  * </p>
@@ -26,7 +26,7 @@ declare const UpdateQuickResponseCommand_base: {
26
26
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
27
27
  };
28
28
  /**
29
- * <p>Updates an existing Amazon Q quick response.</p>
29
+ * <p>Updates an existing Amazon Q in Connect quick response.</p>
30
30
  * @example
31
31
  * Use a bare-bones client and the command you need to make an API call.
32
32
  * ```javascript
@@ -0,0 +1,123 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import { UpdateSessionRequest, UpdateSessionResponse } from "../models/models_0";
4
+ import { QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QConnectClient";
5
+ /**
6
+ * @public
7
+ */
8
+ export { __MetadataBearer, $Command };
9
+ /**
10
+ * @public
11
+ *
12
+ * The input for {@link UpdateSessionCommand}.
13
+ */
14
+ export interface UpdateSessionCommandInput extends UpdateSessionRequest {
15
+ }
16
+ /**
17
+ * @public
18
+ *
19
+ * The output of {@link UpdateSessionCommand}.
20
+ */
21
+ export interface UpdateSessionCommandOutput extends UpdateSessionResponse, __MetadataBearer {
22
+ }
23
+ declare const UpdateSessionCommand_base: {
24
+ new (input: UpdateSessionCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateSessionCommandInput, UpdateSessionCommandOutput, QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
25
+ new (__0_0: UpdateSessionCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateSessionCommandInput, UpdateSessionCommandOutput, QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
27
+ };
28
+ /**
29
+ * <p>Updates a session. A session is a contextual container used for generating recommendations.
30
+ * Amazon Connect updates the existing Amazon Q in Connect session for each contact on which Amazon Q in Connect
31
+ * is enabled.</p>
32
+ * @example
33
+ * Use a bare-bones client and the command you need to make an API call.
34
+ * ```javascript
35
+ * import { QConnectClient, UpdateSessionCommand } from "@aws-sdk/client-qconnect"; // ES Modules import
36
+ * // const { QConnectClient, UpdateSessionCommand } = require("@aws-sdk/client-qconnect"); // CommonJS import
37
+ * const client = new QConnectClient(config);
38
+ * const input = { // UpdateSessionRequest
39
+ * assistantId: "STRING_VALUE", // required
40
+ * sessionId: "STRING_VALUE", // required
41
+ * description: "STRING_VALUE",
42
+ * tagFilter: { // TagFilter Union: only one key present
43
+ * tagCondition: { // TagCondition
44
+ * key: "STRING_VALUE", // required
45
+ * value: "STRING_VALUE",
46
+ * },
47
+ * andConditions: [ // AndConditions
48
+ * {
49
+ * key: "STRING_VALUE", // required
50
+ * value: "STRING_VALUE",
51
+ * },
52
+ * ],
53
+ * orConditions: [ // OrConditions
54
+ * { // OrCondition Union: only one key present
55
+ * andConditions: [
56
+ * "<TagCondition>",
57
+ * ],
58
+ * tagCondition: "<TagCondition>",
59
+ * },
60
+ * ],
61
+ * },
62
+ * };
63
+ * const command = new UpdateSessionCommand(input);
64
+ * const response = await client.send(command);
65
+ * // { // UpdateSessionResponse
66
+ * // session: { // SessionData
67
+ * // sessionArn: "STRING_VALUE", // required
68
+ * // sessionId: "STRING_VALUE", // required
69
+ * // name: "STRING_VALUE", // required
70
+ * // description: "STRING_VALUE",
71
+ * // tags: { // Tags
72
+ * // "<keys>": "STRING_VALUE",
73
+ * // },
74
+ * // integrationConfiguration: { // SessionIntegrationConfiguration
75
+ * // topicIntegrationArn: "STRING_VALUE",
76
+ * // },
77
+ * // tagFilter: { // TagFilter Union: only one key present
78
+ * // tagCondition: { // TagCondition
79
+ * // key: "STRING_VALUE", // required
80
+ * // value: "STRING_VALUE",
81
+ * // },
82
+ * // andConditions: [ // AndConditions
83
+ * // {
84
+ * // key: "STRING_VALUE", // required
85
+ * // value: "STRING_VALUE",
86
+ * // },
87
+ * // ],
88
+ * // orConditions: [ // OrConditions
89
+ * // { // OrCondition Union: only one key present
90
+ * // andConditions: [
91
+ * // "<TagCondition>",
92
+ * // ],
93
+ * // tagCondition: "<TagCondition>",
94
+ * // },
95
+ * // ],
96
+ * // },
97
+ * // },
98
+ * // };
99
+ *
100
+ * ```
101
+ *
102
+ * @param UpdateSessionCommandInput - {@link UpdateSessionCommandInput}
103
+ * @returns {@link UpdateSessionCommandOutput}
104
+ * @see {@link UpdateSessionCommandInput} for command's `input` shape.
105
+ * @see {@link UpdateSessionCommandOutput} for command's `response` shape.
106
+ * @see {@link QConnectClientResolvedConfig | config} for QConnectClient's `config` shape.
107
+ *
108
+ * @throws {@link AccessDeniedException} (client fault)
109
+ * <p>You do not have sufficient access to perform this action.</p>
110
+ *
111
+ * @throws {@link ResourceNotFoundException} (client fault)
112
+ * <p>The specified resource does not exist.</p>
113
+ *
114
+ * @throws {@link ValidationException} (client fault)
115
+ * <p>The input fails to satisfy the constraints specified by a service.</p>
116
+ *
117
+ * @throws {@link QConnectServiceException}
118
+ * <p>Base exception class for all service exceptions from QConnect service.</p>
119
+ *
120
+ * @public
121
+ */
122
+ export declare class UpdateSessionCommand extends UpdateSessionCommand_base {
123
+ }
@@ -40,3 +40,4 @@ export * from "./UntagResourceCommand";
40
40
  export * from "./UpdateContentCommand";
41
41
  export * from "./UpdateKnowledgeBaseTemplateUriCommand";
42
42
  export * from "./UpdateQuickResponseCommand";
43
+ export * from "./UpdateSessionCommand";
@@ -2,18 +2,18 @@
2
2
  * <note>
3
3
  * <p>
4
4
  * <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
5
- * detection</a>. Because Amazon Q in Connect is built on Amazon Bedrock, users can take full
6
- * advantage of the controls implemented in Amazon Bedrock to enforce safety, security, and the
7
- * responsible use of artificial intelligence (AI).</p>
5
+ * detection</a>. Because Amazon Q in Connect is built on Amazon Bedrock, users can take full advantage of
6
+ * the controls implemented in Amazon Bedrock to enforce safety, security, and the responsible use of
7
+ * artificial intelligence (AI).</p>
8
8
  * </note>
9
- * <p>Amazon Q in Connect is a generative AI customer service assistant. It is an LLM-enhanced evolution
10
- * of Amazon Connect Wisdom that delivers real-time recommendations to help contact center
11
- * agents resolve customer issues quickly and accurately.</p>
12
- * <p>Amazon Q automatically detects customer intent during calls and chats using
13
- * conversational analytics and natural language understanding (NLU). It then provides agents
14
- * with immediate, real-time generative responses and suggested actions, and links to relevant
15
- * documents and articles. Agents can also query Amazon Q directly using natural language or
16
- * keywords to answer customer requests.</p>
9
+ * <p>Amazon Q in Connect is a generative AI customer service assistant. It is an LLM-enhanced
10
+ * evolution of Amazon Connect Wisdom that delivers real-time recommendations to help contact
11
+ * center agents resolve customer issues quickly and accurately.</p>
12
+ * <p>Amazon Q in Connect automatically detects customer intent during calls and chats using conversational
13
+ * analytics and natural language understanding (NLU). It then provides agents with immediate,
14
+ * real-time generative responses and suggested actions, and links to relevant documents and
15
+ * articles. Agents can also query Amazon Q in Connect directly using natural language or keywords to answer
16
+ * customer requests.</p>
17
17
  * <p>Use the Amazon Q in Connect APIs to create an assistant and a knowledge base, for example, or
18
18
  * manage content by uploading custom files.</p>
19
19
  * <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