@aws-sdk/client-bedrock-agent-runtime 3.624.0 → 3.625.0

package/dist-cjs/index.js

@@ -108,9 +108,11 @@ __export(src_exports, {
   KnowledgeBaseVectorSearchConfigurationFilterSensitiveLog: () => KnowledgeBaseVectorSearchConfigurationFilterSensitiveLog,
   Memory: () => Memory,
   MemoryType: () => MemoryType,
+  MetadataFilterSensitiveLog: () => MetadataFilterSensitiveLog,
   ModelInvocationInputFilterSensitiveLog: () => ModelInvocationInputFilterSensitiveLog,
   NodeType: () => NodeType,
   ObservationFilterSensitiveLog: () => ObservationFilterSensitiveLog,
+  OrchestrationModelInvocationOutputFilterSensitiveLog: () => OrchestrationModelInvocationOutputFilterSensitiveLog,
   OrchestrationTrace: () => OrchestrationTrace,
   OrchestrationTraceFilterSensitiveLog: () => OrchestrationTraceFilterSensitiveLog,
   OutputFileFilterSensitiveLog: () => OutputFileFilterSensitiveLog,
@@ -127,6 +129,7 @@ __export(src_exports, {
   PromptType: () => PromptType,
   QueryTransformationType: () => QueryTransformationType,
   RationaleFilterSensitiveLog: () => RationaleFilterSensitiveLog,
+  RawResponseFilterSensitiveLog: () => RawResponseFilterSensitiveLog,
   RepromptResponseFilterSensitiveLog: () => RepromptResponseFilterSensitiveLog,
   ResourceNotFoundException: () => ResourceNotFoundException,
   ResponseState: () => ResponseState,
@@ -159,6 +162,7 @@ __export(src_exports, {
   TraceFilterSensitiveLog: () => TraceFilterSensitiveLog,
   TracePartFilterSensitiveLog: () => TracePartFilterSensitiveLog,
   Type: () => Type,
+  UsageFilterSensitiveLog: () => UsageFilterSensitiveLog,
   ValidationException: () => ValidationException,
   __Client: () => import_smithy_client.Client,
   paginateGetAgentMemory: () => paginateGetAgentMemory,
@@ -701,6 +705,8 @@ var OrchestrationTrace;
       return visitor.observation(value.observation);
     if (value.modelInvocationInput !== void 0)
       return visitor.modelInvocationInput(value.modelInvocationInput);
+    if (value.modelInvocationOutput !== void 0)
+      return visitor.modelInvocationOutput(value.modelInvocationOutput);
     return visitor._(value.$unknown[0], value.$unknown[1]);
   }, "visit");
 })(OrchestrationTrace || (OrchestrationTrace = {}));
@@ -1049,6 +1055,21 @@ var ModelInvocationInputFilterSensitiveLog = /* @__PURE__ */ __name((obj) => ({
   ...obj,
   ...obj.text && { text: import_smithy_client.SENSITIVE_STRING }
 }), "ModelInvocationInputFilterSensitiveLog");
+var UsageFilterSensitiveLog = /* @__PURE__ */ __name((obj) => ({
+  ...obj
+}), "UsageFilterSensitiveLog");
+var MetadataFilterSensitiveLog = /* @__PURE__ */ __name((obj) => ({
+  ...obj,
+  ...obj.usage && { usage: import_smithy_client.SENSITIVE_STRING }
+}), "MetadataFilterSensitiveLog");
+var RawResponseFilterSensitiveLog = /* @__PURE__ */ __name((obj) => ({
+  ...obj
+}), "RawResponseFilterSensitiveLog");
+var OrchestrationModelInvocationOutputFilterSensitiveLog = /* @__PURE__ */ __name((obj) => ({
+  ...obj,
+  ...obj.rawResponse && { rawResponse: import_smithy_client.SENSITIVE_STRING },
+  ...obj.metadata && { metadata: import_smithy_client.SENSITIVE_STRING }
+}), "OrchestrationModelInvocationOutputFilterSensitiveLog");
 var FinalResponseFilterSensitiveLog = /* @__PURE__ */ __name((obj) => ({
   ...obj,
   ...obj.text && { text: import_smithy_client.SENSITIVE_STRING }
@@ -1087,6 +1108,8 @@ var OrchestrationTraceFilterSensitiveLog = /* @__PURE__ */ __name((obj) => {
     return { observation: import_smithy_client.SENSITIVE_STRING };
   if (obj.modelInvocationInput !== void 0)
     return { modelInvocationInput: import_smithy_client.SENSITIVE_STRING };
+  if (obj.modelInvocationOutput !== void 0)
+    return { modelInvocationOutput: import_smithy_client.SENSITIVE_STRING };
   if (obj.$unknown !== void 0)
     return { [obj.$unknown[0]]: "UNKNOWN" };
 }, "OrchestrationTraceFilterSensitiveLog");
@@ -2242,6 +2265,11 @@ var de_OrchestrationTrace = /* @__PURE__ */ __name((output, context) => {
       modelInvocationInput: de_ModelInvocationInput(output.modelInvocationInput, context)
     };
   }
+  if (output.modelInvocationOutput != null) {
+    return {
+      modelInvocationOutput: (0, import_smithy_client._json)(output.modelInvocationOutput)
+    };
+  }
   if (output.observation != null) {
     return {
       observation: de_Observation(output.observation, context)
@@ -2617,6 +2645,10 @@ var paginateRetrieve = (0, import_core.createPaginator)(BedrockAgentRuntimeClien
   KnowledgeBaseLookupInputFilterSensitiveLog,
   InvocationInputFilterSensitiveLog,
   ModelInvocationInputFilterSensitiveLog,
+  UsageFilterSensitiveLog,
+  MetadataFilterSensitiveLog,
+  RawResponseFilterSensitiveLog,
+  OrchestrationModelInvocationOutputFilterSensitiveLog,
   FinalResponseFilterSensitiveLog,
   KnowledgeBaseLookupOutputFilterSensitiveLog,
   RepromptResponseFilterSensitiveLog,

package/dist-es/models/models_0.js

@@ -322,6 +322,8 @@ export var OrchestrationTrace;
             return visitor.observation(value.observation);
         if (value.modelInvocationInput !== undefined)
             return visitor.modelInvocationInput(value.modelInvocationInput);
+        if (value.modelInvocationOutput !== undefined)
+            return visitor.modelInvocationOutput(value.modelInvocationOutput);
         return visitor._(value.$unknown[0], value.$unknown[1]);
     };
 })(OrchestrationTrace || (OrchestrationTrace = {}));
@@ -670,6 +672,21 @@ export const ModelInvocationInputFilterSensitiveLog = (obj) => ({
     ...obj,
     ...(obj.text && { text: SENSITIVE_STRING }),
 });
+export const UsageFilterSensitiveLog = (obj) => ({
+    ...obj,
+});
+export const MetadataFilterSensitiveLog = (obj) => ({
+    ...obj,
+    ...(obj.usage && { usage: SENSITIVE_STRING }),
+});
+export const RawResponseFilterSensitiveLog = (obj) => ({
+    ...obj,
+});
+export const OrchestrationModelInvocationOutputFilterSensitiveLog = (obj) => ({
+    ...obj,
+    ...(obj.rawResponse && { rawResponse: SENSITIVE_STRING }),
+    ...(obj.metadata && { metadata: SENSITIVE_STRING }),
+});
 export const FinalResponseFilterSensitiveLog = (obj) => ({
     ...obj,
     ...(obj.text && { text: SENSITIVE_STRING }),
@@ -708,6 +725,8 @@ export const OrchestrationTraceFilterSensitiveLog = (obj) => {
         return { observation: SENSITIVE_STRING };
     if (obj.modelInvocationInput !== undefined)
         return { modelInvocationInput: SENSITIVE_STRING };
+    if (obj.modelInvocationOutput !== undefined)
+        return { modelInvocationOutput: SENSITIVE_STRING };
     if (obj.$unknown !== undefined)
         return { [obj.$unknown[0]]: "UNKNOWN" };
 };

package/dist-es/protocols/Aws_restJson1.js

@@ -904,6 +904,11 @@ const de_OrchestrationTrace = (output, context) => {
             modelInvocationInput: de_ModelInvocationInput(output.modelInvocationInput, context),
         };
     }
+    if (output.modelInvocationOutput != null) {
+        return {
+            modelInvocationOutput: _json(output.modelInvocationOutput),
+        };
+    }
     if (output.observation != null) {
         return {
             observation: de_Observation(output.observation, context),

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

@@ -497,6 +497,18 @@ declare const InvokeAgentCommand_base: {
  * //             promptCreationMode: "DEFAULT" || "OVERRIDDEN",
  * //             parserMode: "DEFAULT" || "OVERRIDDEN",
  * //           },
+ * //           modelInvocationOutput: { // OrchestrationModelInvocationOutput
+ * //             traceId: "STRING_VALUE",
+ * //             rawResponse: { // RawResponse
+ * //               content: "STRING_VALUE",
+ * //             },
+ * //             metadata: { // Metadata
+ * //               usage: { // Usage
+ * //                 inputTokens: Number("int"),
+ * //                 outputTokens: Number("int"),
+ * //               },
+ * //             },
+ * //           },
  * //         },
  * //         postProcessingTrace: { // PostProcessingTrace Union: only one key present
  * //           modelInvocationInput: {

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

@@ -28,6 +28,9 @@ declare const InvokeFlowCommand_base: {
 };
 /**
  * <p>Invokes an alias of a flow to run the inputs that you specify and return the output of each node as a stream. If there's an error, the error is returned. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/flows-test.html">Test a flow in Amazon Bedrock</a> in the Amazon Bedrock User Guide.</p>
+ *          <note>
+ *             <p>The CLI doesn't support streaming operations in Amazon Bedrock, including <code>InvokeFlow</code>.</p>
+ *          </note>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -190,7 +190,7 @@ export type FlowInputContent = FlowInputContent.DocumentMember | FlowInputConten
  */
 export declare namespace FlowInputContent {
     /**
-     * <p>The input for the flow input node.</p>
+     * <p>The input to send to the prompt flow input node.</p>
      * @public
      */
     interface DocumentMember {
@@ -211,7 +211,7 @@ export declare namespace FlowInputContent {
     const visit: <T>(value: FlowInputContent, visitor: Visitor<T>) => T;
 }
 /**
- * <p>Contains information about an input into the flow and what to do with it.</p>
+ * <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>
@@ -224,17 +224,17 @@ export declare namespace FlowInputContent {
  */
 export interface FlowInput {
     /**
-     * <p>A name for the input of the flow input node.</p>
+     * <p>The name of the flow input node that begins the prompt flow.</p>
      * @public
      */
     nodeName: string | undefined;
     /**
-     * <p>A name for the output of the flow input node.</p>
+     * <p>The name of the output from the flow input node that begins the prompt flow.</p>
      * @public
      */
     nodeOutputName: string | undefined;
     /**
-     * <p>Contains information about an input into the flow.</p>
+     * <p>Contains information about an input into the prompt flow.</p>
      * @public
      */
     content: FlowInputContent | undefined;
@@ -290,7 +290,7 @@ export interface FlowCompletionEvent {
     completionReason: FlowCompletionReason | undefined;
 }
 /**
- * <p>Contains information about the output node.</p>
+ * <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>
@@ -307,7 +307,7 @@ export type FlowOutputContent = FlowOutputContent.DocumentMember | FlowOutputCon
  */
 export declare namespace FlowOutputContent {
     /**
-     * <p>A name for the output of the flow.</p>
+     * <p>The content in the output.</p>
      * @public
      */
     interface DocumentMember {
@@ -345,7 +345,7 @@ export declare const NodeType: {
  */
 export type NodeType = (typeof NodeType)[keyof typeof NodeType];
 /**
- * <p>Contains information about an output from flow invoction.</p>
+ * <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>
@@ -358,17 +358,17 @@ export type NodeType = (typeof NodeType)[keyof typeof NodeType];
  */
 export interface FlowOutputEvent {
     /**
-     * <p>The name of the node to which input was provided.</p>
+     * <p>The name of the flow output node that the output is from.</p>
      * @public
      */
     nodeName: string | undefined;
     /**
-     * <p>The type of node to which input was provided.</p>
+     * <p>The type of the node that the output is from.</p>
      * @public
      */
     nodeType: NodeType | undefined;
     /**
-     * <p>The output of the node.</p>
+     * <p>The content in the output.</p>
      * @public
      */
     content: FlowOutputContent | undefined;
@@ -2032,7 +2032,7 @@ export interface InferenceConfiguration {
      */
     temperature?: number;
     /**
-     * <p>While generating a response, the model determines the probability of the following token at each point of generation. The value that you set for <code>Top P</code> determines the number of most-likely candidates from which the model chooses the next token in the sequence. For example, if you set <code>topP</code> to 80, the model only selects the next token from the top 80% of the probability distribution of next tokens.</p>
+     * <p>While generating a response, the model determines the probability of the following token at each point of generation. The value that you set for <code>Top P</code> determines the number of most-likely candidates from which the model chooses the next token in the sequence. For example, if you set <code>topP</code> to 0.8, the model only selects the next token from the top 80% of the probability distribution of next tokens.</p>
      * @public
      */
     topP?: number;
@@ -2130,6 +2130,65 @@ export interface ModelInvocationInput {
      */
     parserMode?: CreationMode;
 }
+/**
+ * <p>Contains information of the usage of the foundation model.</p>
+ * @public
+ */
+export interface Usage {
+    /**
+     * <p>Contains information about the input tokens from the foundation model usage.</p>
+     * @public
+     */
+    inputTokens?: number;
+    /**
+     * <p>Contains information about the output tokens from the foundation model usage.</p>
+     * @public
+     */
+    outputTokens?: number;
+}
+/**
+ * <p>Provides details of the foundation model.</p>
+ * @public
+ */
+export interface Metadata {
+    /**
+     * <p>Contains details of the foundation model usage.</p>
+     * @public
+     */
+    usage?: Usage;
+}
+/**
+ * <p>Contains the raw output from the foundation model.</p>
+ * @public
+ */
+export interface RawResponse {
+    /**
+     * <p>The foundation model's raw output content.</p>
+     * @public
+     */
+    content?: string;
+}
+/**
+ * <p>The foundation model output from the orchestration step.</p>
+ * @public
+ */
+export interface OrchestrationModelInvocationOutput {
+    /**
+     * <p>The unique identifier of the trace.</p>
+     * @public
+     */
+    traceId?: string;
+    /**
+     * <p>Contains details of the raw response from the foundation model output.</p>
+     * @public
+     */
+    rawResponse?: RawResponse;
+    /**
+     * <p>Contains information about the foundation model output.</p>
+     * @public
+     */
+    metadata?: Metadata;
+}
 /**
  * <p>Contains the JSON-formatted string returned by the API invoked by the code interpreter.</p>
  * @public
@@ -2305,7 +2364,7 @@ export interface Rationale {
  * <p>Details about the orchestration step, in which the agent determines the order in which actions are executed and which knowledge bases are retrieved.</p>
  * @public
  */
-export type OrchestrationTrace = OrchestrationTrace.InvocationInputMember | OrchestrationTrace.ModelInvocationInputMember | OrchestrationTrace.ObservationMember | OrchestrationTrace.RationaleMember | OrchestrationTrace.$UnknownMember;
+export type OrchestrationTrace = OrchestrationTrace.InvocationInputMember | OrchestrationTrace.ModelInvocationInputMember | OrchestrationTrace.ModelInvocationOutputMember | OrchestrationTrace.ObservationMember | OrchestrationTrace.RationaleMember | OrchestrationTrace.$UnknownMember;
 /**
  * @public
  */
@@ -2319,6 +2378,7 @@ export declare namespace OrchestrationTrace {
         invocationInput?: never;
         observation?: never;
         modelInvocationInput?: never;
+        modelInvocationOutput?: never;
         $unknown?: never;
     }
     /**
@@ -2330,6 +2390,7 @@ export declare namespace OrchestrationTrace {
         invocationInput: InvocationInput;
         observation?: never;
         modelInvocationInput?: never;
+        modelInvocationOutput?: never;
         $unknown?: never;
     }
     /**
@@ -2341,6 +2402,7 @@ export declare namespace OrchestrationTrace {
         invocationInput?: never;
         observation: Observation;
         modelInvocationInput?: never;
+        modelInvocationOutput?: never;
         $unknown?: never;
     }
     /**
@@ -2363,6 +2425,19 @@ export declare namespace OrchestrationTrace {
         invocationInput?: never;
         observation?: never;
         modelInvocationInput: ModelInvocationInput;
+        modelInvocationOutput?: never;
+        $unknown?: never;
+    }
+    /**
+     * <p>Contains information pertaining to the output from the foundation model that is being invoked.</p>
+     * @public
+     */
+    interface ModelInvocationOutputMember {
+        rationale?: never;
+        invocationInput?: never;
+        observation?: never;
+        modelInvocationInput?: never;
+        modelInvocationOutput: OrchestrationModelInvocationOutput;
         $unknown?: never;
     }
     /**
@@ -2373,6 +2448,7 @@ export declare namespace OrchestrationTrace {
         invocationInput?: never;
         observation?: never;
         modelInvocationInput?: never;
+        modelInvocationOutput?: never;
         $unknown: [string, any];
     }
     interface Visitor<T> {
@@ -2380,6 +2456,7 @@ export declare namespace OrchestrationTrace {
         invocationInput: (value: InvocationInput) => T;
         observation: (value: Observation) => T;
         modelInvocationInput: (value: ModelInvocationInput) => T;
+        modelInvocationOutput: (value: OrchestrationModelInvocationOutput) => T;
         _: (name: string, value: any) => T;
     }
     const visit: <T>(value: OrchestrationTrace, visitor: Visitor<T>) => T;
@@ -4422,6 +4499,22 @@ export declare const InvocationInputFilterSensitiveLog: (obj: InvocationInput) =
  * @internal
  */
 export declare const ModelInvocationInputFilterSensitiveLog: (obj: ModelInvocationInput) => any;
+/**
+ * @internal
+ */
+export declare const UsageFilterSensitiveLog: (obj: Usage) => any;
+/**
+ * @internal
+ */
+export declare const MetadataFilterSensitiveLog: (obj: Metadata) => any;
+/**
+ * @internal
+ */
+export declare const RawResponseFilterSensitiveLog: (obj: RawResponse) => any;
+/**
+ * @internal
+ */
+export declare const OrchestrationModelInvocationOutputFilterSensitiveLog: (obj: OrchestrationModelInvocationOutput) => any;
 /**
  * @internal
  */

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

@@ -776,6 +776,21 @@ export interface ModelInvocationInput {
   promptCreationMode?: CreationMode;
   parserMode?: CreationMode;
 }
+export interface Usage {
+  inputTokens?: number;
+  outputTokens?: number;
+}
+export interface Metadata {
+  usage?: Usage;
+}
+export interface RawResponse {
+  content?: string;
+}
+export interface OrchestrationModelInvocationOutput {
+  traceId?: string;
+  rawResponse?: RawResponse;
+  metadata?: Metadata;
+}
 export interface CodeInterpreterInvocationOutput {
   executionOutput?: string;
   executionError?: string;
@@ -822,6 +837,7 @@ export interface Rationale {
 export type OrchestrationTrace =
   | OrchestrationTrace.InvocationInputMember
   | OrchestrationTrace.ModelInvocationInputMember
+  | OrchestrationTrace.ModelInvocationOutputMember
   | OrchestrationTrace.ObservationMember
   | OrchestrationTrace.RationaleMember
   | OrchestrationTrace.$UnknownMember;
@@ -831,6 +847,7 @@ export declare namespace OrchestrationTrace {
     invocationInput?: never;
     observation?: never;
     modelInvocationInput?: never;
+    modelInvocationOutput?: never;
     $unknown?: never;
   }
   interface InvocationInputMember {
@@ -838,6 +855,7 @@ export declare namespace OrchestrationTrace {
     invocationInput: InvocationInput;
     observation?: never;
     modelInvocationInput?: never;
+    modelInvocationOutput?: never;
     $unknown?: never;
   }
   interface ObservationMember {
@@ -845,6 +863,7 @@ export declare namespace OrchestrationTrace {
     invocationInput?: never;
     observation: Observation;
     modelInvocationInput?: never;
+    modelInvocationOutput?: never;
     $unknown?: never;
   }
   interface ModelInvocationInputMember {
@@ -852,6 +871,15 @@ export declare namespace OrchestrationTrace {
     invocationInput?: never;
     observation?: never;
     modelInvocationInput: ModelInvocationInput;
+    modelInvocationOutput?: never;
+    $unknown?: never;
+  }
+  interface ModelInvocationOutputMember {
+    rationale?: never;
+    invocationInput?: never;
+    observation?: never;
+    modelInvocationInput?: never;
+    modelInvocationOutput: OrchestrationModelInvocationOutput;
     $unknown?: never;
   }
   interface $UnknownMember {
@@ -859,6 +887,7 @@ export declare namespace OrchestrationTrace {
     invocationInput?: never;
     observation?: never;
     modelInvocationInput?: never;
+    modelInvocationOutput?: never;
     $unknown: [string, any];
   }
   interface Visitor<T> {
@@ -866,6 +895,7 @@ export declare namespace OrchestrationTrace {
     invocationInput: (value: InvocationInput) => T;
     observation: (value: Observation) => T;
     modelInvocationInput: (value: ModelInvocationInput) => T;
+    modelInvocationOutput: (value: OrchestrationModelInvocationOutput) => T;
     _: (name: string, value: any) => T;
   }
   const visit: <T>(value: OrchestrationTrace, visitor: Visitor<T>) => T;
@@ -1847,6 +1877,12 @@ export declare const InvocationInputFilterSensitiveLog: (
 export declare const ModelInvocationInputFilterSensitiveLog: (
   obj: ModelInvocationInput
 ) => any;
+export declare const UsageFilterSensitiveLog: (obj: Usage) => any;
+export declare const MetadataFilterSensitiveLog: (obj: Metadata) => any;
+export declare const RawResponseFilterSensitiveLog: (obj: RawResponse) => any;
+export declare const OrchestrationModelInvocationOutputFilterSensitiveLog: (
+  obj: OrchestrationModelInvocationOutput
+) => any;
 export declare const FinalResponseFilterSensitiveLog: (
   obj: FinalResponse
 ) => any;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@aws-sdk/client-bedrock-agent-runtime",
   "description": "AWS SDK for JavaScript Bedrock Agent Runtime Client for Node.js, Browser and React Native",
-  "version": "3.624.0",
+  "version": "3.625.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "node ../../scripts/compilation/inline client-bedrock-agent-runtime",