@aws-sdk/client-bedrock-agent-runtime 3.686.0 → 3.688.0

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

@@ -187,14 +187,6 @@ export declare class InternalServerException extends __BaseException {
 }
 /**
  * <p>Contains information about an input into the flow.</p>
- *          <p>This data type is used in the following API operations:</p>
- *          <ul>
- *             <li>
- *                <p>
- *                   <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeFlow.html#API_agent_InvokeFlow_RequestSyntax">InvokeFlow request</a>
- *                </p>
- *             </li>
- *          </ul>
  * @public
  */
 export type FlowInputContent = FlowInputContent.DocumentMember | FlowInputContent.$UnknownMember;
@@ -225,14 +217,6 @@ export declare namespace FlowInputContent {
 }
 /**
  * <p>Contains information about an input into the prompt flow and where to send it.</p>
- *          <p>This data type is used in the following API operations:</p>
- *          <ul>
- *             <li>
- *                <p>
- *                   <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeFlow.html#API_agent_InvokeFlow_RequestSyntax">InvokeFlow request</a>
- *                </p>
- *             </li>
- *          </ul>
  * @public
  */
 export interface FlowInput {
@@ -271,6 +255,11 @@ export interface InvokeFlowRequest {
      * @public
      */
     inputs: FlowInput[] | undefined;
+    /**
+     * <p>Specifies whether to return the trace for the flow or not. Traces track inputs and outputs for nodes in the flow. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/flows-trace.html">Track each step in your prompt flow by viewing its trace in Amazon Bedrock</a>.</p>
+     * @public
+     */
+    enableTrace?: boolean;
 }
 /**
  * @public
@@ -285,14 +274,6 @@ export declare const FlowCompletionReason: {
 export type FlowCompletionReason = (typeof FlowCompletionReason)[keyof typeof FlowCompletionReason];
 /**
  * <p>Contains information about why a flow completed.</p>
- *          <p>This data type is used in the following API operations:</p>
- *          <ul>
- *             <li>
- *                <p>
- *                   <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeFlow.html#API_agent_InvokeFlow_ResponseSyntax">InvokeFlow response</a>
- *                </p>
- *             </li>
- *          </ul>
  * @public
  */
 export interface FlowCompletionEvent {
@@ -304,14 +285,6 @@ export interface FlowCompletionEvent {
 }
 /**
  * <p>Contains information about the content in an output from prompt flow invocation.</p>
- *          <p>This data type is used in the following API operations:</p>
- *          <ul>
- *             <li>
- *                <p>
- *                   <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeFlow.html#API_agent_InvokeFlow_RequestSyntax">InvokeFlow request</a>
- *                </p>
- *             </li>
- *          </ul>
  * @public
  */
 export type FlowOutputContent = FlowOutputContent.DocumentMember | FlowOutputContent.$UnknownMember;
@@ -359,14 +332,6 @@ export declare const NodeType: {
 export type NodeType = (typeof NodeType)[keyof typeof NodeType];
 /**
  * <p>Contains information about an output from prompt flow invoction.</p>
- *          <p>This data type is used in the following API operations:</p>
- *          <ul>
- *             <li>
- *                <p>
- *                   <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeFlow.html#API_agent_InvokeFlow_ResponseSyntax">InvokeFlow response</a>
- *                </p>
- *             </li>
- *          </ul>
  * @public
  */
 export interface FlowOutputEvent {
@@ -386,6 +351,239 @@ export interface FlowOutputEvent {
      */
     content: FlowOutputContent | undefined;
 }
+/**
+ * <p>Contains information about a condition that was satisfied. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/flows-trace.html">Track each step in your prompt flow by viewing its trace in Amazon Bedrock</a>.</p>
+ * @public
+ */
+export interface FlowTraceCondition {
+    /**
+     * <p>The name of the condition.</p>
+     * @public
+     */
+    conditionName: string | undefined;
+}
+/**
+ * <p>Contains information about an output from a condition node. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/flows-trace.html">Track each step in your prompt flow by viewing its trace in Amazon Bedrock</a>.</p>
+ * @public
+ */
+export interface FlowTraceConditionNodeResultEvent {
+    /**
+     * <p>The name of the condition node.</p>
+     * @public
+     */
+    nodeName: string | undefined;
+    /**
+     * <p>The date and time that the trace was returned.</p>
+     * @public
+     */
+    timestamp: Date | undefined;
+    /**
+     * <p>An array of objects containing information about the conditions that were satisfied.</p>
+     * @public
+     */
+    satisfiedConditions: FlowTraceCondition[] | undefined;
+}
+/**
+ * <p>Contains the content of the node input. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/flows-trace.html">Track each step in your prompt flow by viewing its trace in Amazon Bedrock</a>.</p>
+ * @public
+ */
+export type FlowTraceNodeInputContent = FlowTraceNodeInputContent.DocumentMember | FlowTraceNodeInputContent.$UnknownMember;
+/**
+ * @public
+ */
+export declare namespace FlowTraceNodeInputContent {
+    /**
+     * <p>The content of the node input.</p>
+     * @public
+     */
+    interface DocumentMember {
+        document: __DocumentType;
+        $unknown?: never;
+    }
+    /**
+     * @public
+     */
+    interface $UnknownMember {
+        document?: never;
+        $unknown: [string, any];
+    }
+    interface Visitor<T> {
+        document: (value: __DocumentType) => T;
+        _: (name: string, value: any) => T;
+    }
+    const visit: <T>(value: FlowTraceNodeInputContent, visitor: Visitor<T>) => T;
+}
+/**
+ * <p>Contains information about a field in the input into a node. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/flows-trace.html">Track each step in your prompt flow by viewing its trace in Amazon Bedrock</a>.</p>
+ * @public
+ */
+export interface FlowTraceNodeInputField {
+    /**
+     * <p>The name of the node input.</p>
+     * @public
+     */
+    nodeInputName: string | undefined;
+    /**
+     * <p>The content of the node input.</p>
+     * @public
+     */
+    content: FlowTraceNodeInputContent | undefined;
+}
+/**
+ * <p>Contains information about the input into a node. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/flows-trace.html">Track each step in your prompt flow by viewing its trace in Amazon Bedrock</a>.</p>
+ * @public
+ */
+export interface FlowTraceNodeInputEvent {
+    /**
+     * <p>The name of the node that received the input.</p>
+     * @public
+     */
+    nodeName: string | undefined;
+    /**
+     * <p>The date and time that the trace was returned.</p>
+     * @public
+     */
+    timestamp: Date | undefined;
+    /**
+     * <p>An array of objects containing information about each field in the input.</p>
+     * @public
+     */
+    fields: FlowTraceNodeInputField[] | undefined;
+}
+/**
+ * <p>Contains the content of the node output. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/flows-trace.html">Track each step in your prompt flow by viewing its trace in Amazon Bedrock</a>.</p>
+ * @public
+ */
+export type FlowTraceNodeOutputContent = FlowTraceNodeOutputContent.DocumentMember | FlowTraceNodeOutputContent.$UnknownMember;
+/**
+ * @public
+ */
+export declare namespace FlowTraceNodeOutputContent {
+    /**
+     * <p>The content of the node output.</p>
+     * @public
+     */
+    interface DocumentMember {
+        document: __DocumentType;
+        $unknown?: never;
+    }
+    /**
+     * @public
+     */
+    interface $UnknownMember {
+        document?: never;
+        $unknown: [string, any];
+    }
+    interface Visitor<T> {
+        document: (value: __DocumentType) => T;
+        _: (name: string, value: any) => T;
+    }
+    const visit: <T>(value: FlowTraceNodeOutputContent, visitor: Visitor<T>) => T;
+}
+/**
+ * <p>Contains information about a field in the output from a node. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/flows-trace.html">Track each step in your prompt flow by viewing its trace in Amazon Bedrock</a>.</p>
+ * @public
+ */
+export interface FlowTraceNodeOutputField {
+    /**
+     * <p>The name of the node output.</p>
+     * @public
+     */
+    nodeOutputName: string | undefined;
+    /**
+     * <p>The content of the node output.</p>
+     * @public
+     */
+    content: FlowTraceNodeOutputContent | undefined;
+}
+/**
+ * <p>Contains information about the output from a node. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/flows-trace.html">Track each step in your prompt flow by viewing its trace in Amazon Bedrock</a>.</p>
+ * @public
+ */
+export interface FlowTraceNodeOutputEvent {
+    /**
+     * <p>The name of the node that yielded the output.</p>
+     * @public
+     */
+    nodeName: string | undefined;
+    /**
+     * <p>The date and time that the trace was returned.</p>
+     * @public
+     */
+    timestamp: Date | undefined;
+    /**
+     * <p>An array of objects containing information about each field in the output.</p>
+     * @public
+     */
+    fields: FlowTraceNodeOutputField[] | undefined;
+}
+/**
+ * <p>Contains information about an input or output for a node in the flow. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/flows-trace.html">Track each step in your prompt flow by viewing its trace in Amazon Bedrock</a>.</p>
+ * @public
+ */
+export type FlowTrace = FlowTrace.ConditionNodeResultTraceMember | FlowTrace.NodeInputTraceMember | FlowTrace.NodeOutputTraceMember | FlowTrace.$UnknownMember;
+/**
+ * @public
+ */
+export declare namespace FlowTrace {
+    /**
+     * <p>Contains information about the input into a node.</p>
+     * @public
+     */
+    interface NodeInputTraceMember {
+        nodeInputTrace: FlowTraceNodeInputEvent;
+        nodeOutputTrace?: never;
+        conditionNodeResultTrace?: never;
+        $unknown?: never;
+    }
+    /**
+     * <p>Contains information about the output from a node.</p>
+     * @public
+     */
+    interface NodeOutputTraceMember {
+        nodeInputTrace?: never;
+        nodeOutputTrace: FlowTraceNodeOutputEvent;
+        conditionNodeResultTrace?: never;
+        $unknown?: never;
+    }
+    /**
+     * <p>Contains information about an output from a condition node.</p>
+     * @public
+     */
+    interface ConditionNodeResultTraceMember {
+        nodeInputTrace?: never;
+        nodeOutputTrace?: never;
+        conditionNodeResultTrace: FlowTraceConditionNodeResultEvent;
+        $unknown?: never;
+    }
+    /**
+     * @public
+     */
+    interface $UnknownMember {
+        nodeInputTrace?: never;
+        nodeOutputTrace?: never;
+        conditionNodeResultTrace?: never;
+        $unknown: [string, any];
+    }
+    interface Visitor<T> {
+        nodeInputTrace: (value: FlowTraceNodeInputEvent) => T;
+        nodeOutputTrace: (value: FlowTraceNodeOutputEvent) => T;
+        conditionNodeResultTrace: (value: FlowTraceConditionNodeResultEvent) => T;
+        _: (name: string, value: any) => T;
+    }
+    const visit: <T>(value: FlowTrace, visitor: Visitor<T>) => T;
+}
+/**
+ * <p>Contains information about a trace, which tracks an input or output for a node in the flow. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/flows-trace.html">Track each step in your prompt flow by viewing its trace in Amazon Bedrock</a>.</p>
+ * @public
+ */
+export interface FlowTraceEvent {
+    /**
+     * <p>The trace object containing information about an input or output for a node in the flow.</p>
+     * @public
+     */
+    trace: FlowTrace | undefined;
+}
 /**
  * <p>The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.</p>
  * @public
@@ -436,17 +634,9 @@ export declare class ValidationException extends __BaseException {
 }
 /**
  * <p>The output of the flow.</p>
- *          <p>This data type is used in the following API operations:</p>
- *          <ul>
- *             <li>
- *                <p>
- *                   <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeFlow.html#API_agent_InvokeFlow_ResponseSyntax">InvokeFlow response</a>
- *                </p>
- *             </li>
- *          </ul>
  * @public
  */
-export type FlowResponseStream = FlowResponseStream.AccessDeniedExceptionMember | FlowResponseStream.BadGatewayExceptionMember | FlowResponseStream.ConflictExceptionMember | FlowResponseStream.DependencyFailedExceptionMember | FlowResponseStream.FlowCompletionEventMember | FlowResponseStream.FlowOutputEventMember | FlowResponseStream.InternalServerExceptionMember | FlowResponseStream.ResourceNotFoundExceptionMember | FlowResponseStream.ServiceQuotaExceededExceptionMember | FlowResponseStream.ThrottlingExceptionMember | FlowResponseStream.ValidationExceptionMember | FlowResponseStream.$UnknownMember;
+export type FlowResponseStream = FlowResponseStream.AccessDeniedExceptionMember | FlowResponseStream.BadGatewayExceptionMember | FlowResponseStream.ConflictExceptionMember | FlowResponseStream.DependencyFailedExceptionMember | FlowResponseStream.FlowCompletionEventMember | FlowResponseStream.FlowOutputEventMember | FlowResponseStream.FlowTraceEventMember | FlowResponseStream.InternalServerExceptionMember | FlowResponseStream.ResourceNotFoundExceptionMember | FlowResponseStream.ServiceQuotaExceededExceptionMember | FlowResponseStream.ThrottlingExceptionMember | FlowResponseStream.ValidationExceptionMember | FlowResponseStream.$UnknownMember;
 /**
  * @public
  */
@@ -458,6 +648,7 @@ export declare namespace FlowResponseStream {
     interface FlowOutputEventMember {
         flowOutputEvent: FlowOutputEvent;
         flowCompletionEvent?: never;
+        flowTraceEvent?: never;
         internalServerException?: never;
         validationException?: never;
         resourceNotFoundException?: never;
@@ -476,6 +667,26 @@ export declare namespace FlowResponseStream {
     interface FlowCompletionEventMember {
         flowOutputEvent?: never;
         flowCompletionEvent: FlowCompletionEvent;
+        flowTraceEvent?: never;
+        internalServerException?: never;
+        validationException?: never;
+        resourceNotFoundException?: never;
+        serviceQuotaExceededException?: never;
+        throttlingException?: never;
+        accessDeniedException?: never;
+        conflictException?: never;
+        dependencyFailedException?: never;
+        badGatewayException?: never;
+        $unknown?: never;
+    }
+    /**
+     * <p>Contains information about a trace, which tracks an input or output for a node in the flow.</p>
+     * @public
+     */
+    interface FlowTraceEventMember {
+        flowOutputEvent?: never;
+        flowCompletionEvent?: never;
+        flowTraceEvent: FlowTraceEvent;
         internalServerException?: never;
         validationException?: never;
         resourceNotFoundException?: never;
@@ -494,6 +705,7 @@ export declare namespace FlowResponseStream {
     interface InternalServerExceptionMember {
         flowOutputEvent?: never;
         flowCompletionEvent?: never;
+        flowTraceEvent?: never;
         internalServerException: InternalServerException;
         validationException?: never;
         resourceNotFoundException?: never;
@@ -512,6 +724,7 @@ export declare namespace FlowResponseStream {
     interface ValidationExceptionMember {
         flowOutputEvent?: never;
         flowCompletionEvent?: never;
+        flowTraceEvent?: never;
         internalServerException?: never;
         validationException: ValidationException;
         resourceNotFoundException?: never;
@@ -530,6 +743,7 @@ export declare namespace FlowResponseStream {
     interface ResourceNotFoundExceptionMember {
         flowOutputEvent?: never;
         flowCompletionEvent?: never;
+        flowTraceEvent?: never;
         internalServerException?: never;
         validationException?: never;
         resourceNotFoundException: ResourceNotFoundException;
@@ -548,6 +762,7 @@ export declare namespace FlowResponseStream {
     interface ServiceQuotaExceededExceptionMember {
         flowOutputEvent?: never;
         flowCompletionEvent?: never;
+        flowTraceEvent?: never;
         internalServerException?: never;
         validationException?: never;
         resourceNotFoundException?: never;
@@ -566,6 +781,7 @@ export declare namespace FlowResponseStream {
     interface ThrottlingExceptionMember {
         flowOutputEvent?: never;
         flowCompletionEvent?: never;
+        flowTraceEvent?: never;
         internalServerException?: never;
         validationException?: never;
         resourceNotFoundException?: never;
@@ -584,6 +800,7 @@ export declare namespace FlowResponseStream {
     interface AccessDeniedExceptionMember {
         flowOutputEvent?: never;
         flowCompletionEvent?: never;
+        flowTraceEvent?: never;
         internalServerException?: never;
         validationException?: never;
         resourceNotFoundException?: never;
@@ -602,6 +819,7 @@ export declare namespace FlowResponseStream {
     interface ConflictExceptionMember {
         flowOutputEvent?: never;
         flowCompletionEvent?: never;
+        flowTraceEvent?: never;
         internalServerException?: never;
         validationException?: never;
         resourceNotFoundException?: never;
@@ -620,6 +838,7 @@ export declare namespace FlowResponseStream {
     interface DependencyFailedExceptionMember {
         flowOutputEvent?: never;
         flowCompletionEvent?: never;
+        flowTraceEvent?: never;
         internalServerException?: never;
         validationException?: never;
         resourceNotFoundException?: never;
@@ -638,6 +857,7 @@ export declare namespace FlowResponseStream {
     interface BadGatewayExceptionMember {
         flowOutputEvent?: never;
         flowCompletionEvent?: never;
+        flowTraceEvent?: never;
         internalServerException?: never;
         validationException?: never;
         resourceNotFoundException?: never;
@@ -655,6 +875,7 @@ export declare namespace FlowResponseStream {
     interface $UnknownMember {
         flowOutputEvent?: never;
         flowCompletionEvent?: never;
+        flowTraceEvent?: never;
         internalServerException?: never;
         validationException?: never;
         resourceNotFoundException?: never;
@@ -669,6 +890,7 @@ export declare namespace FlowResponseStream {
     interface Visitor<T> {
         flowOutputEvent: (value: FlowOutputEvent) => T;
         flowCompletionEvent: (value: FlowCompletionEvent) => T;
+        flowTraceEvent: (value: FlowTraceEvent) => T;
         internalServerException: (value: InternalServerException) => T;
         validationException: (value: ValidationException) => T;
         resourceNotFoundException: (value: ResourceNotFoundException) => T;
@@ -2154,11 +2376,6 @@ export interface ModelInvocationInput {
      * @public
      */
     type?: PromptType;
-    /**
-     * <p>Specifications about the inference parameters that were provided alongside the prompt. These are specified in the <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_PromptOverrideConfiguration.html">PromptOverrideConfiguration</a> object that was set when the agent was created or updated. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html">Inference parameters for foundation models</a>.</p>
-     * @public
-     */
-    inferenceConfiguration?: InferenceConfiguration;
     /**
      * <p>The ARN of the Lambda function to use when parsing the raw foundation model output in parts of the agent sequence.</p>
      * @public
@@ -2169,6 +2386,11 @@ export interface ModelInvocationInput {
      * @public
      */
     promptCreationMode?: CreationMode;
+    /**
+     * <p>Specifications about the inference parameters that were provided alongside the prompt. These are specified in the <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_PromptOverrideConfiguration.html">PromptOverrideConfiguration</a> object that was set when the agent was created or updated. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html">Inference parameters for foundation models</a>.</p>
+     * @public
+     */
+    inferenceConfiguration?: InferenceConfiguration;
     /**
      * <p>Specifies whether to override the default parser Lambda function when parsing the raw foundation model output in the part of the agent sequence defined by the <code>promptType</code>.</p>
      * @public
@@ -3543,7 +3765,7 @@ export interface ExternalSourcesRetrieveAndGenerateConfiguration {
  */
 export interface GenerationConfiguration {
     /**
-     * <p>Contains the template for the prompt that's sent to the model for response generation.</p>
+     * <p>Contains the template for the prompt that's sent to the model for response generation. Generation prompts must include the <code>$search_results$</code> variable. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-placeholders.html">Use placeholder variables</a> in the user guide.</p>
      * @public
      */
     promptTemplate?: PromptTemplate;
@@ -3592,7 +3814,7 @@ export interface QueryTransformationConfiguration {
  */
 export interface OrchestrationConfiguration {
     /**
-     * <p>Contains the template for the prompt that's sent to the model for response generation.</p>
+     * <p>Contains the template for the prompt that's sent to the model. Orchestration prompts must include the <code>$conversation_history$</code> and <code>$output_format_instructions$</code> variables. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-placeholders.html">Use placeholder variables</a> in the user guide.</p>
      * @public
      */
     promptTemplate?: PromptTemplate;
@@ -4444,6 +4666,42 @@ export declare const FlowCompletionEventFilterSensitiveLog: (obj: FlowCompletion
  * @internal
  */
 export declare const FlowOutputEventFilterSensitiveLog: (obj: FlowOutputEvent) => any;
+/**
+ * @internal
+ */
+export declare const FlowTraceConditionFilterSensitiveLog: (obj: FlowTraceCondition) => any;
+/**
+ * @internal
+ */
+export declare const FlowTraceConditionNodeResultEventFilterSensitiveLog: (obj: FlowTraceConditionNodeResultEvent) => any;
+/**
+ * @internal
+ */
+export declare const FlowTraceNodeInputContentFilterSensitiveLog: (obj: FlowTraceNodeInputContent) => any;
+/**
+ * @internal
+ */
+export declare const FlowTraceNodeInputFieldFilterSensitiveLog: (obj: FlowTraceNodeInputField) => any;
+/**
+ * @internal
+ */
+export declare const FlowTraceNodeInputEventFilterSensitiveLog: (obj: FlowTraceNodeInputEvent) => any;
+/**
+ * @internal
+ */
+export declare const FlowTraceNodeOutputFieldFilterSensitiveLog: (obj: FlowTraceNodeOutputField) => any;
+/**
+ * @internal
+ */
+export declare const FlowTraceNodeOutputEventFilterSensitiveLog: (obj: FlowTraceNodeOutputEvent) => any;
+/**
+ * @internal
+ */
+export declare const FlowTraceFilterSensitiveLog: (obj: FlowTrace) => any;
+/**
+ * @internal
+ */
+export declare const FlowTraceEventFilterSensitiveLog: (obj: FlowTraceEvent) => any;
 /**
  * @internal
  */