@aws-sdk/client-qconnect 3.1135.0 → 3.1137.0

package/dist-types/commands/ListAIAgentVersionsCommand.d.ts

@@ -216,7 +216,7 @@ declare const ListAIAgentVersionsCommand_base: {
  * //             ],
  * //           },
  * //           orchestrationAIAgentConfiguration: { // OrchestrationAIAgentConfiguration
- * //             orchestrationAIPromptId: "STRING_VALUE", // required
+ * //             orchestrationAIPromptId: "STRING_VALUE",
  * //             orchestrationAIGuardrailId: "STRING_VALUE",
  * //             toolConfigurations: [ // ToolConfigurationList
  * //               { // ToolConfiguration
@@ -262,8 +262,44 @@ declare const ListAIAgentVersionsCommand_base: {
  * //                 },
  * //               },
  * //             ],
+ * //             multiAgentConfigurations: [ // MultiAgentConfigurationList
+ * //               { // MultiAgentConfiguration Union: only one key present
+ * //                 delegateAgentConfiguration: { // DelegateAgentConfiguration
+ * //                   agentTarget: { // AgentTarget Union: only one key present
+ * //                     aiAgentId: "STRING_VALUE",
+ * //                     applicationId: "STRING_VALUE",
+ * //                   },
+ * //                   instruction: { // MultiAgentInstruction
+ * //                     instruction: "STRING_VALUE",
+ * //                     examples: [ // MultiAgentExampleList
+ * //                       "STRING_VALUE",
+ * //                     ],
+ * //                   },
+ * //                 },
+ * //                 handoffAgentConfiguration: { // HandoffAgentConfiguration
+ * //                   agentTarget: {//  Union: only one key present
+ * //                     aiAgentId: "STRING_VALUE",
+ * //                     applicationId: "STRING_VALUE",
+ * //                   },
+ * //                   instruction: {
+ * //                     instruction: "STRING_VALUE",
+ * //                     examples: [
+ * //                       "STRING_VALUE",
+ * //                     ],
+ * //                   },
+ * //                   audioStreamingEnabled: true || false,
+ * //                   immediateHandoff: true || false,
+ * //                 },
+ * //               },
+ * //             ],
  * //             connectInstanceArn: "STRING_VALUE",
  * //             locale: "STRING_VALUE",
+ * //             inputSchemas: [ // JSONDocumentList
+ * //               "DOCUMENT_VALUE",
+ * //             ],
+ * //             outputSchemas: [
+ * //               "DOCUMENT_VALUE",
+ * //             ],
  * //           },
  * //           noteTakingAIAgentConfiguration: { // NoteTakingAIAgentConfiguration
  * //             noteTakingAIPromptId: "STRING_VALUE",

package/dist-types/commands/ListAIAgentsCommand.d.ts

@@ -214,7 +214,7 @@ declare const ListAIAgentsCommand_base: {
  * //           ],
  * //         },
  * //         orchestrationAIAgentConfiguration: { // OrchestrationAIAgentConfiguration
- * //           orchestrationAIPromptId: "STRING_VALUE", // required
+ * //           orchestrationAIPromptId: "STRING_VALUE",
  * //           orchestrationAIGuardrailId: "STRING_VALUE",
  * //           toolConfigurations: [ // ToolConfigurationList
  * //             { // ToolConfiguration
@@ -260,8 +260,44 @@ declare const ListAIAgentsCommand_base: {
  * //               },
  * //             },
  * //           ],
+ * //           multiAgentConfigurations: [ // MultiAgentConfigurationList
+ * //             { // MultiAgentConfiguration Union: only one key present
+ * //               delegateAgentConfiguration: { // DelegateAgentConfiguration
+ * //                 agentTarget: { // AgentTarget Union: only one key present
+ * //                   aiAgentId: "STRING_VALUE",
+ * //                   applicationId: "STRING_VALUE",
+ * //                 },
+ * //                 instruction: { // MultiAgentInstruction
+ * //                   instruction: "STRING_VALUE",
+ * //                   examples: [ // MultiAgentExampleList
+ * //                     "STRING_VALUE",
+ * //                   ],
+ * //                 },
+ * //               },
+ * //               handoffAgentConfiguration: { // HandoffAgentConfiguration
+ * //                 agentTarget: {//  Union: only one key present
+ * //                   aiAgentId: "STRING_VALUE",
+ * //                   applicationId: "STRING_VALUE",
+ * //                 },
+ * //                 instruction: {
+ * //                   instruction: "STRING_VALUE",
+ * //                   examples: [
+ * //                     "STRING_VALUE",
+ * //                   ],
+ * //                 },
+ * //                 audioStreamingEnabled: true || false,
+ * //                 immediateHandoff: true || false,
+ * //               },
+ * //             },
+ * //           ],
  * //           connectInstanceArn: "STRING_VALUE",
  * //           locale: "STRING_VALUE",
+ * //           inputSchemas: [ // JSONDocumentList
+ * //             "DOCUMENT_VALUE",
+ * //           ],
+ * //           outputSchemas: [
+ * //             "DOCUMENT_VALUE",
+ * //           ],
  * //         },
  * //         noteTakingAIAgentConfiguration: { // NoteTakingAIAgentConfiguration
  * //           noteTakingAIPromptId: "STRING_VALUE",

package/dist-types/commands/ListContentAssociationsCommand.d.ts

@@ -24,7 +24,7 @@ declare const ListContentAssociationsCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
 };
 /**
- * <p>Lists the content associations.</p> <p>For more information about content associations--what they are and when they are used--see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/integrate-q-with-guides.html">Integrate Amazon Q in Connect with step-by-step guides</a> in the <i>Amazon Connect Administrator Guide</i>.</p>
+ * <p>Lists the content associations.</p> <p>For more information about content associations--what they are and when they are used--see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/integrate-q-with-guides.html">Integrate Amazon Q in Connect with step-by-step guides</a> in the <i>Connect Customer Administrator Guide</i>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/ListMessagesCommand.d.ts

@@ -71,6 +71,7 @@ declare const ListMessagesCommand_base: {
  * //           toolResult: "DOCUMENT_VALUE", // required
  * //           inputSchema: "DOCUMENT_VALUE",
  * //         },
+ * //         data: "DOCUMENT_VALUE",
  * //       },
  * //       messageId: "STRING_VALUE", // required
  * //       participant: "STRING_VALUE", // required

package/dist-types/commands/ListSpansCommand.d.ts

@@ -73,6 +73,9 @@ declare const ListSpansCommand_base: {
  * //         aiAgentVersion: Number("int"),
  * //         aiAgentInvoker: "STRING_VALUE",
  * //         aiAgentOrchestratorUseCase: "STRING_VALUE",
+ * //         interactionMode: "STRING_VALUE",
+ * //         targetAgentId: "STRING_VALUE",
+ * //         returnReason: "STRING_VALUE",
  * //         requestModel: "STRING_VALUE",
  * //         requestMaxTokens: Number("int"),
  * //         temperature: Number("float"),

package/dist-types/commands/QueryAssistantCommand.d.ts

@@ -25,7 +25,7 @@ declare const QueryAssistantCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
 };
 /**
- * <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>
+ * <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 Connect Customer 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

package/dist-types/commands/SendMessageCommand.d.ts

@@ -64,6 +64,7 @@ declare const SendMessageCommand_base: {
  *         toolResult: "DOCUMENT_VALUE", // required
  *         inputSchema: "DOCUMENT_VALUE",
  *       },
+ *       data: "DOCUMENT_VALUE",
  *     },
  *   },
  *   aiAgentId: "STRING_VALUE",

package/dist-types/commands/UpdateAIAgentCommand.d.ts

@@ -200,7 +200,7 @@ declare const UpdateAIAgentCommand_base: {
  *       ],
  *     },
  *     orchestrationAIAgentConfiguration: { // OrchestrationAIAgentConfiguration
- *       orchestrationAIPromptId: "STRING_VALUE", // required
+ *       orchestrationAIPromptId: "STRING_VALUE",
  *       orchestrationAIGuardrailId: "STRING_VALUE",
  *       toolConfigurations: [ // ToolConfigurationList
  *         { // ToolConfiguration
@@ -246,8 +246,44 @@ declare const UpdateAIAgentCommand_base: {
  *           },
  *         },
  *       ],
+ *       multiAgentConfigurations: [ // MultiAgentConfigurationList
+ *         { // MultiAgentConfiguration Union: only one key present
+ *           delegateAgentConfiguration: { // DelegateAgentConfiguration
+ *             agentTarget: { // AgentTarget Union: only one key present
+ *               aiAgentId: "STRING_VALUE",
+ *               applicationId: "STRING_VALUE",
+ *             },
+ *             instruction: { // MultiAgentInstruction
+ *               instruction: "STRING_VALUE",
+ *               examples: [ // MultiAgentExampleList
+ *                 "STRING_VALUE",
+ *               ],
+ *             },
+ *           },
+ *           handoffAgentConfiguration: { // HandoffAgentConfiguration
+ *             agentTarget: {//  Union: only one key present
+ *               aiAgentId: "STRING_VALUE",
+ *               applicationId: "STRING_VALUE",
+ *             },
+ *             instruction: {
+ *               instruction: "STRING_VALUE",
+ *               examples: [
+ *                 "STRING_VALUE",
+ *               ],
+ *             },
+ *             audioStreamingEnabled: true || false,
+ *             immediateHandoff: true || false,
+ *           },
+ *         },
+ *       ],
  *       connectInstanceArn: "STRING_VALUE",
  *       locale: "STRING_VALUE",
+ *       inputSchemas: [ // JSONDocumentList
+ *         "DOCUMENT_VALUE",
+ *       ],
+ *       outputSchemas: [
+ *         "DOCUMENT_VALUE",
+ *       ],
  *     },
  *     noteTakingAIAgentConfiguration: { // NoteTakingAIAgentConfiguration
  *       noteTakingAIPromptId: "STRING_VALUE",
@@ -434,7 +470,7 @@ declare const UpdateAIAgentCommand_base: {
  * //         ],
  * //       },
  * //       orchestrationAIAgentConfiguration: { // OrchestrationAIAgentConfiguration
- * //         orchestrationAIPromptId: "STRING_VALUE", // required
+ * //         orchestrationAIPromptId: "STRING_VALUE",
  * //         orchestrationAIGuardrailId: "STRING_VALUE",
  * //         toolConfigurations: [ // ToolConfigurationList
  * //           { // ToolConfiguration
@@ -480,8 +516,44 @@ declare const UpdateAIAgentCommand_base: {
  * //             },
  * //           },
  * //         ],
+ * //         multiAgentConfigurations: [ // MultiAgentConfigurationList
+ * //           { // MultiAgentConfiguration Union: only one key present
+ * //             delegateAgentConfiguration: { // DelegateAgentConfiguration
+ * //               agentTarget: { // AgentTarget Union: only one key present
+ * //                 aiAgentId: "STRING_VALUE",
+ * //                 applicationId: "STRING_VALUE",
+ * //               },
+ * //               instruction: { // MultiAgentInstruction
+ * //                 instruction: "STRING_VALUE",
+ * //                 examples: [ // MultiAgentExampleList
+ * //                   "STRING_VALUE",
+ * //                 ],
+ * //               },
+ * //             },
+ * //             handoffAgentConfiguration: { // HandoffAgentConfiguration
+ * //               agentTarget: {//  Union: only one key present
+ * //                 aiAgentId: "STRING_VALUE",
+ * //                 applicationId: "STRING_VALUE",
+ * //               },
+ * //               instruction: {
+ * //                 instruction: "STRING_VALUE",
+ * //                 examples: [
+ * //                   "STRING_VALUE",
+ * //                 ],
+ * //               },
+ * //               audioStreamingEnabled: true || false,
+ * //               immediateHandoff: true || false,
+ * //             },
+ * //           },
+ * //         ],
  * //         connectInstanceArn: "STRING_VALUE",
  * //         locale: "STRING_VALUE",
+ * //         inputSchemas: [ // JSONDocumentList
+ * //           "DOCUMENT_VALUE",
+ * //         ],
+ * //         outputSchemas: [
+ * //           "DOCUMENT_VALUE",
+ * //         ],
  * //       },
  * //       noteTakingAIAgentConfiguration: { // NoteTakingAIAgentConfiguration
  * //         noteTakingAIPromptId: "STRING_VALUE",

package/dist-types/commands/UpdateSessionCommand.d.ts

@@ -24,7 +24,7 @@ declare const UpdateSessionCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
 };
 /**
- * <p>Updates a session. A session is a contextual container used for generating recommendations. Amazon Connect updates the existing Amazon Q in Connect session for each contact on which Amazon Q in Connect is enabled.</p>
+ * <p>Updates a session. A session is a contextual container used for generating recommendations. Connect Customer updates the existing 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

package/dist-types/index.d.ts

@@ -1,5 +1,5 @@
 /**
- * <ul> <li> <p> <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_Operations_Amazon_Q_Connect.html">Amazon Q actions</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_Types_Amazon_Q_Connect.html">Amazon Q data types</a> </p> </li> </ul> <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> </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 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 powered agent assistance in real-time</a> in the <i>Amazon Connect Administrator Guide</i>.</p>
+ * <ul> <li> <p> <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_Operations_Amazon_Q_Connect.html">Amazon Q actions</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_Types_Amazon_Q_Connect.html">Amazon Q data types</a> </p> </li> </ul> <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> </note> <p>Amazon Q in Connect is a generative AI customer service assistant. It is an LLM-enhanced evolution of Connect Customer 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 powered agent assistance in real-time</a> in the <i>Connect Customer Administrator Guide</i>.</p>
  *
  * @packageDocumentation
  */

package/dist-types/models/enums.d.ts

@@ -579,6 +579,7 @@ export type Participant = (typeof Participant)[keyof typeof Participant];
  * @enum
  */
 export declare const MessageType: {
+    readonly DATA: "DATA";
     readonly TEXT: "TEXT";
     readonly TOOL_USE_RESULT: "TOOL_USE_RESULT";
 };
@@ -639,6 +640,32 @@ export declare const GuardrailSource: {
  * @public
  */
 export type GuardrailSource = (typeof GuardrailSource)[keyof typeof GuardrailSource];
+/**
+ * @public
+ * @enum
+ */
+export declare const InteractionMode: {
+    readonly DELEGATE: "DELEGATE";
+    readonly HANDOFF: "HANDOFF";
+};
+/**
+ * @public
+ */
+export type InteractionMode = (typeof InteractionMode)[keyof typeof InteractionMode];
+/**
+ * @public
+ * @enum
+ */
+export declare const ReturnReason: {
+    readonly COMPLETE: "COMPLETE";
+    readonly COMPLETE_WITH_ERROR: "COMPLETE_WITH_ERROR";
+    readonly ESCALATE: "ESCALATE";
+    readonly OUT_OF_DOMAIN: "OUT_OF_DOMAIN";
+};
+/**
+ * @public
+ */
+export type ReturnReason = (typeof ReturnReason)[keyof typeof ReturnReason];
 /**
  * @public
  * @enum