feat(client-bedrock-agent-runtime): Adds multi-turn input support for an Agent node in an Amazon Bedrock Flow

Author: awstools

clients/client-bedrock-agent-runtime/src/commands/InvokeFlowCommand.ts

@@ -53,10 +53,11 @@ export interface InvokeFlowCommandOutput extends InvokeFlowResponse, __MetadataB
  *   inputs: [ // FlowInputs // required
  *     { // FlowInput
  *       nodeName: "STRING_VALUE", // required
- *       nodeOutputName: "STRING_VALUE", // required
+ *       nodeOutputName: "STRING_VALUE",
  *       content: { // FlowInputContent Union: only one key present
  *         document: "DOCUMENT_VALUE",
  *       },
+ *       nodeInputName: "STRING_VALUE",
  *     },
  *   ],
  *   enableTrace: true || false,
@@ -65,6 +66,7 @@ export interface InvokeFlowCommandOutput extends InvokeFlowResponse, __MetadataB
  *       latency: "standard" || "optimized",
  *     },
  *   },
+ *   executionId: "STRING_VALUE",
  * };
  * const command = new InvokeFlowCommand(input);
  * const response = await client.send(command);
@@ -78,7 +80,7 @@ export interface InvokeFlowCommandOutput extends InvokeFlowResponse, __MetadataB
  * //       },
  * //     },
  * //     flowCompletionEvent: { // FlowCompletionEvent
- * //       completionReason: "SUCCESS", // required
+ * //       completionReason: "SUCCESS" || "INPUT_REQUIRED", // required
  * //     },
  * //     flowTraceEvent: { // FlowTraceEvent
  * //       trace: { // FlowTrace Union: only one key present
@@ -146,7 +148,15 @@ export interface InvokeFlowCommandOutput extends InvokeFlowResponse, __MetadataB
  * //       message: "STRING_VALUE",
  * //       resourceName: "STRING_VALUE",
  * //     },
+ * //     flowMultiTurnInputRequestEvent: { // FlowMultiTurnInputRequestEvent
+ * //       nodeName: "STRING_VALUE", // required
+ * //       nodeType: "FlowInputNode" || "FlowOutputNode" || "LambdaFunctionNode" || "KnowledgeBaseNode" || "PromptNode" || "ConditionNode" || "LexNode", // required
+ * //       content: { // FlowMultiTurnInputContent Union: only one key present
+ * //         document: "DOCUMENT_VALUE",
+ * //       },
+ * //     },
  * //   },
+ * //   executionId: "STRING_VALUE",
  * // };
  *
  * ```

clients/client-bedrock-agent-runtime/src/models/models_0.ts

@@ -1325,13 +1325,19 @@ export interface FlowInput {
    * <p>The name of the output from the flow input node that begins the prompt flow.</p>
    * @public
    */
-  nodeOutputName: string | undefined;
+  nodeOutputName?: string | undefined;
 
   /**
    * <p>Contains information about an input into the prompt flow.</p>
    * @public
    */
   content: FlowInputContent | undefined;
+
+  /**
+   * <p>The name of the input from the flow input node.</p>
+   * @public
+   */
+  nodeInputName?: string | undefined;
 }
 
 /**
@@ -1405,13 +1411,20 @@ export interface InvokeFlowRequest {
    * @public
    */
   modelPerformanceConfiguration?: ModelPerformanceConfiguration | undefined;
+
+  /**
+   * <p>The unique identifier for the current flow execution. If you don't provide a value, Amazon Bedrock creates the identifier for you.  </p>
+   * @public
+   */
+  executionId?: string | undefined;
 }
 
 /**
  * @public
  * @enum
  */
 export const FlowCompletionReason = {
+  INPUT_REQUIRED: "INPUT_REQUIRED",
   SUCCESS: "SUCCESS",
 } as const;
 
@@ -1433,17 +1446,19 @@ export interface FlowCompletionEvent {
 }
 
 /**
- * <p>Contains information about the content in an output from prompt flow invocation.</p>
+ * <p>The content structure containing input information for multi-turn flow interactions.</p>
  * @public
  */
-export type FlowOutputContent = FlowOutputContent.DocumentMember | FlowOutputContent.$UnknownMember;
+export type FlowMultiTurnInputContent =
+  | FlowMultiTurnInputContent.DocumentMember
+  | FlowMultiTurnInputContent.$UnknownMember;
 
 /**
  * @public
  */
-export namespace FlowOutputContent {
+export namespace FlowMultiTurnInputContent {
   /**
-   * <p>The content in the output.</p>
+   * <p>The requested additional input to send back to the multi-turn flow node.</p>
    * @public
    */
   export interface DocumentMember {
@@ -1464,7 +1479,7 @@ export namespace FlowOutputContent {
     _: (name: string, value: any) => T;
   }
 
-  export const visit = <T>(value: FlowOutputContent, visitor: Visitor<T>): T => {
+  export const visit = <T>(value: FlowMultiTurnInputContent, visitor: Visitor<T>): T => {
     if (value.document !== undefined) return visitor.document(value.document);
     return visitor._(value.$unknown[0], value.$unknown[1]);
   };
@@ -1489,6 +1504,68 @@ export const NodeType = {
  */
 export type NodeType = (typeof NodeType)[keyof typeof NodeType];
 
+/**
+ * <p>Response object from the flow multi-turn node requesting additional information.</p>
+ * @public
+ */
+export interface FlowMultiTurnInputRequestEvent {
+  /**
+   * <p>The name of the node in the flow that is requesting the input.</p>
+   * @public
+   */
+  nodeName: string | undefined;
+
+  /**
+   * <p>The type of the node in the flow that is requesting the input.</p>
+   * @public
+   */
+  nodeType: NodeType | undefined;
+
+  /**
+   * <p>The content payload containing the input request details for the multi-turn interaction.</p>
+   * @public
+   */
+  content: FlowMultiTurnInputContent | undefined;
+}
+
+/**
+ * <p>Contains information about the content in an output from prompt flow invocation.</p>
+ * @public
+ */
+export type FlowOutputContent = FlowOutputContent.DocumentMember | FlowOutputContent.$UnknownMember;
+
+/**
+ * @public
+ */
+export namespace FlowOutputContent {
+  /**
+   * <p>The content in the output.</p>
+   * @public
+   */
+  export interface DocumentMember {
+    document: __DocumentType;
+    $unknown?: never;
+  }
+
+  /**
+   * @public
+   */
+  export interface $UnknownMember {
+    document?: never;
+    $unknown: [string, any];
+  }
+
+  export interface Visitor<T> {
+    document: (value: __DocumentType) => T;
+    _: (name: string, value: any) => T;
+  }
+
+  export const visit = <T>(value: FlowOutputContent, visitor: Visitor<T>): T => {
+    if (value.document !== undefined) return visitor.document(value.document);
+    return visitor._(value.$unknown[0], value.$unknown[1]);
+  };
+}
+
 /**
  * <p>Contains information about an output from prompt flow invoction.</p>
  * @public
@@ -1888,6 +1965,7 @@ export type FlowResponseStream =
   | FlowResponseStream.ConflictExceptionMember
   | FlowResponseStream.DependencyFailedExceptionMember
   | FlowResponseStream.FlowCompletionEventMember
+  | FlowResponseStream.FlowMultiTurnInputRequestEventMember
   | FlowResponseStream.FlowOutputEventMember
   | FlowResponseStream.FlowTraceEventMember
   | FlowResponseStream.InternalServerExceptionMember
@@ -1918,6 +1996,7 @@ export namespace FlowResponseStream {
     conflictException?: never;
     dependencyFailedException?: never;
     badGatewayException?: never;
+    flowMultiTurnInputRequestEvent?: never;
     $unknown?: never;
   }
 
@@ -1938,6 +2017,7 @@ export namespace FlowResponseStream {
     conflictException?: never;
     dependencyFailedException?: never;
     badGatewayException?: never;
+    flowMultiTurnInputRequestEvent?: never;
     $unknown?: never;
   }
 
@@ -1958,6 +2038,7 @@ export namespace FlowResponseStream {
     conflictException?: never;
     dependencyFailedException?: never;
     badGatewayException?: never;
+    flowMultiTurnInputRequestEvent?: never;
     $unknown?: never;
   }
 
@@ -1978,6 +2059,7 @@ export namespace FlowResponseStream {
     conflictException?: never;
     dependencyFailedException?: never;
     badGatewayException?: never;
+    flowMultiTurnInputRequestEvent?: never;
     $unknown?: never;
   }
 
@@ -1998,6 +2080,7 @@ export namespace FlowResponseStream {
     conflictException?: never;
     dependencyFailedException?: never;
     badGatewayException?: never;
+    flowMultiTurnInputRequestEvent?: never;
     $unknown?: never;
   }
 
@@ -2018,6 +2101,7 @@ export namespace FlowResponseStream {
     conflictException?: never;
     dependencyFailedException?: never;
     badGatewayException?: never;
+    flowMultiTurnInputRequestEvent?: never;
     $unknown?: never;
   }
 
@@ -2038,6 +2122,7 @@ export namespace FlowResponseStream {
     conflictException?: never;
     dependencyFailedException?: never;
     badGatewayException?: never;
+    flowMultiTurnInputRequestEvent?: never;
     $unknown?: never;
   }
 
@@ -2058,6 +2143,7 @@ export namespace FlowResponseStream {
     conflictException?: never;
     dependencyFailedException?: never;
     badGatewayException?: never;
+    flowMultiTurnInputRequestEvent?: never;
     $unknown?: never;
   }
 
@@ -2078,6 +2164,7 @@ export namespace FlowResponseStream {
     conflictException?: never;
     dependencyFailedException?: never;
     badGatewayException?: never;
+    flowMultiTurnInputRequestEvent?: never;
     $unknown?: never;
   }
 
@@ -2098,6 +2185,7 @@ export namespace FlowResponseStream {
     conflictException: ConflictException;
     dependencyFailedException?: never;
     badGatewayException?: never;
+    flowMultiTurnInputRequestEvent?: never;
     $unknown?: never;
   }
 
@@ -2118,6 +2206,7 @@ export namespace FlowResponseStream {
     conflictException?: never;
     dependencyFailedException: DependencyFailedException;
     badGatewayException?: never;
+    flowMultiTurnInputRequestEvent?: never;
     $unknown?: never;
   }
 
@@ -2138,6 +2227,28 @@ export namespace FlowResponseStream {
     conflictException?: never;
     dependencyFailedException?: never;
     badGatewayException: BadGatewayException;
+    flowMultiTurnInputRequestEvent?: never;
+    $unknown?: never;
+  }
+
+  /**
+   * <p>The event stream containing the multi-turn input request information from the flow.</p>
+   * @public
+   */
+  export interface FlowMultiTurnInputRequestEventMember {
+    flowOutputEvent?: never;
+    flowCompletionEvent?: never;
+    flowTraceEvent?: never;
+    internalServerException?: never;
+    validationException?: never;
+    resourceNotFoundException?: never;
+    serviceQuotaExceededException?: never;
+    throttlingException?: never;
+    accessDeniedException?: never;
+    conflictException?: never;
+    dependencyFailedException?: never;
+    badGatewayException?: never;
+    flowMultiTurnInputRequestEvent: FlowMultiTurnInputRequestEvent;
     $unknown?: never;
   }
 
@@ -2157,6 +2268,7 @@ export namespace FlowResponseStream {
     conflictException?: never;
     dependencyFailedException?: never;
     badGatewayException?: never;
+    flowMultiTurnInputRequestEvent?: never;
     $unknown: [string, any];
   }
 
@@ -2173,6 +2285,7 @@ export namespace FlowResponseStream {
     conflictException: (value: ConflictException) => T;
     dependencyFailedException: (value: DependencyFailedException) => T;
     badGatewayException: (value: BadGatewayException) => T;
+    flowMultiTurnInputRequestEvent: (value: FlowMultiTurnInputRequestEvent) => T;
     _: (name: string, value: any) => T;
   }
 
@@ -2193,6 +2306,8 @@ export namespace FlowResponseStream {
     if (value.dependencyFailedException !== undefined)
       return visitor.dependencyFailedException(value.dependencyFailedException);
     if (value.badGatewayException !== undefined) return visitor.badGatewayException(value.badGatewayException);
+    if (value.flowMultiTurnInputRequestEvent !== undefined)
+      return visitor.flowMultiTurnInputRequestEvent(value.flowMultiTurnInputRequestEvent);
     return visitor._(value.$unknown[0], value.$unknown[1]);
   };
 }
@@ -2206,6 +2321,12 @@ export interface InvokeFlowResponse {
    * @public
    */
   responseStream: AsyncIterable<FlowResponseStream> | undefined;
+
+  /**
+   * <p>The unique identifier for the current flow execution.</p>
+   * @public
+   */
+  executionId?: string | undefined;
 }
 
 /**
@@ -9045,6 +9166,14 @@ export const FlowCompletionEventFilterSensitiveLog = (obj: FlowCompletionEvent):
   ...obj,
 });
 
+/**
+ * @internal
+ */
+export const FlowMultiTurnInputRequestEventFilterSensitiveLog = (obj: FlowMultiTurnInputRequestEvent): any => ({
+  ...obj,
+  ...(obj.content && { content: obj.content }),
+});
+
 /**
  * @internal
  */
@@ -9143,6 +9272,7 @@ export const FlowResponseStreamFilterSensitiveLog = (obj: FlowResponseStream): a
   if (obj.conflictException !== undefined) return { conflictException: obj.conflictException };
   if (obj.dependencyFailedException !== undefined) return { dependencyFailedException: obj.dependencyFailedException };
   if (obj.badGatewayException !== undefined) return { badGatewayException: obj.badGatewayException };
+  if (obj.flowMultiTurnInputRequestEvent !== undefined) return { flowMultiTurnInputRequestEvent: SENSITIVE_STRING };
   if (obj.$unknown !== undefined) return { [obj.$unknown[0]]: "UNKNOWN" };
 };