@aws-sdk/client-bedrock-runtime 3.554.0 → 3.561.0

package/README.md

@@ -6,7 +6,7 @@
 
 AWS SDK for JavaScript BedrockRuntime Client for Node.js, Browser and React Native.
 
-<p>Describes the API operations for running inference using Bedrock models.</p>
+<p>Describes the API operations for running inference using Amazon Bedrock models.</p>
 
 ## Installing
 

package/dist-cjs/index.js

@@ -42,6 +42,7 @@ __export(src_exports, {
   ResponseStreamFilterSensitiveLog: () => ResponseStreamFilterSensitiveLog,
   ServiceQuotaExceededException: () => ServiceQuotaExceededException,
   ThrottlingException: () => ThrottlingException,
+  Trace: () => Trace,
   ValidationException: () => ValidationException,
   __Client: () => import_smithy_client.Client
 });
@@ -253,6 +254,10 @@ var _InternalServerException = class _InternalServerException extends BedrockRun
 };
 __name(_InternalServerException, "InternalServerException");
 var InternalServerException = _InternalServerException;
+var Trace = {
+  DISABLED: "DISABLED",
+  ENABLED: "ENABLED"
+};
 var _ModelErrorException = class _ModelErrorException extends BedrockRuntimeServiceException {
   /**
    * @internal
@@ -456,7 +461,10 @@ var se_InvokeModelCommand = /* @__PURE__ */ __name(async (input, context) => {
   const b = (0, import_core.requestBuilder)(input, context);
   const headers = (0, import_smithy_client.map)({}, isSerializableHeaderValue, {
     [_ct]: input[_cT] || "application/octet-stream",
-    [_a]: input[_a]
+    [_a]: input[_a],
+    [_xabt]: input[_t],
+    [_xabg]: input[_gI],
+    [_xabg_]: input[_gV]
   });
   b.bp("/model/{modelId}/invoke");
   b.p("modelId", () => input.modelId, "{modelId}", false);
@@ -471,7 +479,10 @@ var se_InvokeModelWithResponseStreamCommand = /* @__PURE__ */ __name(async (inpu
   const b = (0, import_core.requestBuilder)(input, context);
   const headers = (0, import_smithy_client.map)({}, isSerializableHeaderValue, {
     [_ct]: input[_cT] || "application/octet-stream",
-    [_xaba]: input[_a]
+    [_xaba]: input[_a],
+    [_xabt]: input[_t],
+    [_xabg]: input[_gI],
+    [_xabg_]: input[_gV]
   });
   b.bp("/model/{modelId}/invoke-with-response-stream");
   b.p("modelId", () => input.modelId, "{modelId}", false);
@@ -781,8 +792,14 @@ var isSerializableHeaderValue = /* @__PURE__ */ __name((value) => value !== void
 var _a = "accept";
 var _cT = "contentType";
 var _ct = "content-type";
+var _gI = "guardrailIdentifier";
+var _gV = "guardrailVersion";
+var _t = "trace";
 var _xaba = "x-amzn-bedrock-accept";
 var _xabct = "x-amzn-bedrock-content-type";
+var _xabg = "x-amzn-bedrock-guardrailidentifier";
+var _xabg_ = "x-amzn-bedrock-guardrailversion";
+var _xabt = "x-amzn-bedrock-trace";
 
 // src/commands/InvokeModelCommand.ts
 var _InvokeModelCommand = class _InvokeModelCommand extends import_smithy_client.Command.classBuilder().ep({
@@ -843,6 +860,7 @@ var BedrockRuntime = _BedrockRuntime;
   InvokeModelWithResponseStreamCommand,
   AccessDeniedException,
   InternalServerException,
+  Trace,
   ModelErrorException,
   ModelNotReadyException,
   ModelTimeoutException,

package/dist-es/models/models_0.js

@@ -24,6 +24,10 @@ export class InternalServerException extends __BaseException {
         Object.setPrototypeOf(this, InternalServerException.prototype);
     }
 }
+export const Trace = {
+    DISABLED: "DISABLED",
+    ENABLED: "ENABLED",
+};
 export class ModelErrorException extends __BaseException {
     constructor(opts) {
         super({

package/dist-es/protocols/Aws_restJson1.js

@@ -8,6 +8,9 @@ export const se_InvokeModelCommand = async (input, context) => {
     const headers = map({}, isSerializableHeaderValue, {
         [_ct]: input[_cT] || "application/octet-stream",
         [_a]: input[_a],
+        [_xabt]: input[_t],
+        [_xabg]: input[_gI],
+        [_xabg_]: input[_gV],
     });
     b.bp("/model/{modelId}/invoke");
     b.p("modelId", () => input.modelId, "{modelId}", false);
@@ -23,6 +26,9 @@ export const se_InvokeModelWithResponseStreamCommand = async (input, context) =>
     const headers = map({}, isSerializableHeaderValue, {
         [_ct]: input[_cT] || "application/octet-stream",
         [_xaba]: input[_a],
+        [_xabt]: input[_t],
+        [_xabg]: input[_gI],
+        [_xabg_]: input[_gV],
     });
     b.bp("/model/{modelId}/invoke-with-response-stream");
     b.p("modelId", () => input.modelId, "{modelId}", false);
@@ -334,5 +340,11 @@ const isSerializableHeaderValue = (value) => value !== undefined &&
 const _a = "accept";
 const _cT = "contentType";
 const _ct = "content-type";
+const _gI = "guardrailIdentifier";
+const _gV = "guardrailVersion";
+const _t = "trace";
 const _xaba = "x-amzn-bedrock-accept";
 const _xabct = "x-amzn-bedrock-content-type";
+const _xabg = "x-amzn-bedrock-guardrailidentifier";
+const _xabg_ = "x-amzn-bedrock-guardrailversion";
+const _xabt = "x-amzn-bedrock-trace";

package/dist-types/BedrockRuntime.d.ts

@@ -17,7 +17,7 @@ export interface BedrockRuntime {
     invokeModelWithResponseStream(args: InvokeModelWithResponseStreamCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: InvokeModelWithResponseStreamCommandOutput) => void): void;
 }
 /**
- * <p>Describes the API operations for running inference using Bedrock models.</p>
+ * <p>Describes the API operations for running inference using Amazon Bedrock models.</p>
  * @public
  */
 export declare class BedrockRuntime extends BedrockRuntimeClient implements BedrockRuntime {

package/dist-types/BedrockRuntimeClient.d.ts

@@ -158,7 +158,7 @@ export type BedrockRuntimeClientResolvedConfigType = __SmithyResolvedConfigurati
 export interface BedrockRuntimeClientResolvedConfig extends BedrockRuntimeClientResolvedConfigType {
 }
 /**
- * <p>Describes the API operations for running inference using Bedrock models.</p>
+ * <p>Describes the API operations for running inference using Amazon Bedrock models.</p>
  * @public
  */
 export declare class BedrockRuntimeClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, BedrockRuntimeClientResolvedConfig> {

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

@@ -39,10 +39,11 @@ declare const InvokeModelCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>Invokes the specified Bedrock model to run inference using the input provided in the request body.
- *          You use InvokeModel to run inference for text models, image models, and embedding models.</p>
- *          <p>For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/api-methods-run.html">Run inference</a> in the Bedrock User Guide.</p>
- *          <p>For example requests, see Examples (after the Errors section).</p>
+ * <p>Invokes the specified Amazon Bedrock model to run inference using the prompt and inference parameters provided in the request body.
+ *          You use model inference to generate text, images, and embeddings.</p>
+ *          <p>For example code, see <i>Invoke model code examples</i> in the <i>Amazon Bedrock User Guide</i>.
+ *       </p>
+ *          <p>This operation requires permission for the <code>bedrock:InvokeModel</code> action.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -54,6 +55,9 @@ declare const InvokeModelCommand_base: {
  *   contentType: "STRING_VALUE",
  *   accept: "STRING_VALUE",
  *   modelId: "STRING_VALUE", // required
+ *   trace: "ENABLED" || "DISABLED",
+ *   guardrailIdentifier: "STRING_VALUE",
+ *   guardrailVersion: "STRING_VALUE",
  * };
  * const command = new InvokeModelCommand(input);
  * const response = await client.send(command);

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

@@ -32,10 +32,16 @@ declare const InvokeModelWithResponseStreamCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>Invoke the specified Bedrock model to run inference using the input provided.
- *       Return the response in a stream.</p>
- *          <p>For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/api-methods-run.html">Run inference</a> in the Bedrock User Guide.</p>
- *          <p>For an example request and response, see Examples (after the Errors section).</p>
+ * <p>Invoke the specified Amazon Bedrock model to run inference using the prompt and inference parameters provided in the request body. The response is returned in a stream.</p>
+ *          <p>To see if a model supports streaming, call <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_GetFoundationModel.html">GetFoundationModel</a>
+ *          and check the <code>responseStreamingSupported</code> field in the response.</p>
+ *          <note>
+ *             <p>The CLI doesn't support <code>InvokeModelWithResponseStream</code>.</p>
+ *          </note>
+ *          <p>For example code, see <i>Invoke model with streaming code
+ *          example</i> in the <i>Amazon Bedrock User Guide</i>.
+ *       </p>
+ *          <p>This operation requires permissions to perform the <code>bedrock:InvokeModelWithResponseStream</code> action. </p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -47,6 +53,9 @@ declare const InvokeModelWithResponseStreamCommand_base: {
  *   contentType: "STRING_VALUE",
  *   accept: "STRING_VALUE",
  *   modelId: "STRING_VALUE", // required
+ *   trace: "ENABLED" || "DISABLED",
+ *   guardrailIdentifier: "STRING_VALUE",
+ *   guardrailVersion: "STRING_VALUE",
  * };
  * const command = new InvokeModelWithResponseStreamCommand(input);
  * const response = await client.send(command);
@@ -97,7 +106,7 @@ declare const InvokeModelWithResponseStreamCommand_base: {
  *  <p>The model specified in the request is not ready to serve inference requests.</p>
  *
  * @throws {@link ModelStreamErrorException} (client fault)
- *  <p>An error occurred while streaming the response.</p>
+ *  <p>An error occurred while streaming the response. Retry your request.</p>
  *
  * @throws {@link ModelTimeoutException} (client fault)
  *  <p>The request took too long to process. Processing time exceeded the model timeout length.</p>

package/dist-types/index.d.ts

@@ -1,5 +1,5 @@
 /**
- * <p>Describes the API operations for running inference using Bedrock models.</p>
+ * <p>Describes the API operations for running inference using Amazon Bedrock models.</p>
  *
  * @packageDocumentation
  */

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

@@ -24,12 +24,24 @@ export declare class InternalServerException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
 }
+/**
+ * @public
+ * @enum
+ */
+export declare const Trace: {
+    readonly DISABLED: "DISABLED";
+    readonly ENABLED: "ENABLED";
+};
+/**
+ * @public
+ */
+export type Trace = (typeof Trace)[keyof typeof Trace];
 /**
  * @public
  */
 export interface InvokeModelRequest {
     /**
-     * <p>Input data in the format specified in the content-type request header. To see the format and content of this field for different models, refer to <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html">Inference parameters</a>.</p>
+     * <p>The prompt and inference parameters in the format specified in the <code>contentType</code> in the header. To see the format and content of the request and response bodies for different models, refer to <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html">Inference parameters</a>. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/api-methods-run.html">Run inference</a> in the Bedrock User Guide.</p>
      * @public
      */
     body: Uint8Array | undefined;
@@ -40,23 +52,62 @@ export interface InvokeModelRequest {
      */
     contentType?: string;
     /**
-     * <p>The desired MIME type of the inference body in the response. The default value is
-     *             <code>application/json</code>.</p>
+     * <p>The desired MIME type of the inference body in the response. The default value is <code>application/json</code>.</p>
      * @public
      */
     accept?: string;
     /**
-     * <p>Identifier of the model. </p>
+     * <p>The unique identifier of the model to invoke to run inference.</p>
+     *          <p>The <code>modelId</code> to provide depends on the type of model that you use:</p>
+     *          <ul>
+     *             <li>
+     *                <p>If you use a base model, specify the model ID or its ARN. For a list of model IDs for base models, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-ids.html#model-ids-arns">Amazon Bedrock base model IDs (on-demand throughput)</a> in the Amazon Bedrock User Guide.</p>
+     *             </li>
+     *             <li>
+     *                <p>If you use a provisioned model, specify the ARN of the Provisioned Throughput. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/prov-thru-use.html">Run inference using a Provisioned Throughput</a> in the Amazon Bedrock User Guide.</p>
+     *             </li>
+     *             <li>
+     *                <p>If you use a custom model, first purchase Provisioned Throughput for it. Then specify the ARN of the resulting provisioned model. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-customization-use.html">Use a custom model in Amazon Bedrock</a> in the Amazon Bedrock User Guide.</p>
+     *             </li>
+     *          </ul>
      * @public
      */
     modelId: string | undefined;
+    /**
+     * <p>Specifies whether to enable or disable the Bedrock trace. If enabled, you can see the full Bedrock trace.</p>
+     * @public
+     */
+    trace?: Trace;
+    /**
+     * <p>The unique identifier of the guardrail that you want to use. If you don't provide a value, no guardrail is applied
+     *             to the invocation.</p>
+     *          <p>An error will be thrown in the following situations.</p>
+     *          <ul>
+     *             <li>
+     *                <p>You don't provide a guardrail identifier but you specify the <code>amazon-bedrock-guardrailConfig</code> field in the request body.</p>
+     *             </li>
+     *             <li>
+     *                <p>You enable the guardrail but the <code>contentType</code> isn't <code>application/json</code>.</p>
+     *             </li>
+     *             <li>
+     *                <p>You provide a guardrail identifier, but <code>guardrailVersion</code> isn't specified.</p>
+     *             </li>
+     *          </ul>
+     * @public
+     */
+    guardrailIdentifier?: string;
+    /**
+     * <p>The version number for the guardrail. The value can also be <code>DRAFT</code>.</p>
+     * @public
+     */
+    guardrailVersion?: string;
 }
 /**
  * @public
  */
 export interface InvokeModelResponse {
     /**
-     * <p>Inference response from the model in the format specified in the content-type header field. To see the format and content of this field for different models, refer to <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html">Inference parameters</a>.</p>
+     * <p>Inference response from the model in the format specified in the <code>contentType</code> header. To see the format and content of the request and response bodies for different models, refer to <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html">Inference parameters</a>.</p>
      * @public
      */
     body: Uint8Array | undefined;
@@ -165,8 +216,7 @@ export declare class ValidationException extends __BaseException {
  */
 export interface InvokeModelWithResponseStreamRequest {
     /**
-     * <p>Inference input in the format specified by the
-     *          content-type. To see the format and content of this field for different models, refer to <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html">Inference parameters</a>.</p>
+     * <p>The prompt and inference parameters in the format specified in the <code>contentType</code> in the header. To see the format and content of the request and response bodies for different models, refer to <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html">Inference parameters</a>. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/api-methods-run.html">Run inference</a> in the Bedrock User Guide.</p>
      * @public
      */
     body: Uint8Array | undefined;
@@ -183,10 +233,50 @@ export interface InvokeModelWithResponseStreamRequest {
      */
     accept?: string;
     /**
-     * <p>Id of the model to invoke using the streaming request.</p>
+     * <p>The unique identifier of the model to invoke to run inference.</p>
+     *          <p>The <code>modelId</code> to provide depends on the type of model that you use:</p>
+     *          <ul>
+     *             <li>
+     *                <p>If you use a base model, specify the model ID or its ARN. For a list of model IDs for base models, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-ids.html#model-ids-arns">Amazon Bedrock base model IDs (on-demand throughput)</a> in the Amazon Bedrock User Guide.</p>
+     *             </li>
+     *             <li>
+     *                <p>If you use a provisioned model, specify the ARN of the Provisioned Throughput. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/prov-thru-use.html">Run inference using a Provisioned Throughput</a> in the Amazon Bedrock User Guide.</p>
+     *             </li>
+     *             <li>
+     *                <p>If you use a custom model, first purchase Provisioned Throughput for it. Then specify the ARN of the resulting provisioned model. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-customization-use.html">Use a custom model in Amazon Bedrock</a> in the Amazon Bedrock User Guide.</p>
+     *             </li>
+     *          </ul>
      * @public
      */
     modelId: string | undefined;
+    /**
+     * <p>Specifies whether to enable or disable the Bedrock trace. If enabled, you can see the full Bedrock trace.</p>
+     * @public
+     */
+    trace?: Trace;
+    /**
+     * <p>The unique identifier of the guardrail that you want to use. If you don't provide a value, no guardrail is applied
+     *             to the invocation.</p>
+     *          <p>An error is thrown in the following situations.</p>
+     *          <ul>
+     *             <li>
+     *                <p>You don't provide a guardrail identifier but you specify the <code>amazon-bedrock-guardrailConfig</code> field in the request body.</p>
+     *             </li>
+     *             <li>
+     *                <p>You enable the guardrail but the <code>contentType</code> isn't <code>application/json</code>.</p>
+     *             </li>
+     *             <li>
+     *                <p>You provide a guardrail identifier, but <code>guardrailVersion</code> isn't specified.</p>
+     *             </li>
+     *          </ul>
+     * @public
+     */
+    guardrailIdentifier?: string;
+    /**
+     * <p>The version number for the guardrail. The value can also be <code>DRAFT</code>.</p>
+     * @public
+     */
+    guardrailVersion?: string;
 }
 /**
  * <p>Payload content included in the response.</p>
@@ -200,7 +290,7 @@ export interface PayloadPart {
     bytes?: Uint8Array;
 }
 /**
- * <p>An error occurred while streaming the response.</p>
+ * <p>An error occurred while streaming the response. Retry your request.</p>
  * @public
  */
 export declare class ModelStreamErrorException extends __BaseException {
@@ -257,7 +347,7 @@ export declare namespace ResponseStream {
         $unknown?: never;
     }
     /**
-     * <p>An error occurred while streaming the response.</p>
+     * <p>An error occurred while streaming the response. Retry your request.</p>
      * @public
      */
     interface ModelStreamErrorExceptionMember {
@@ -283,7 +373,7 @@ export declare namespace ResponseStream {
         $unknown?: never;
     }
     /**
-     * <p>The number of requests exceeds the limit. Resubmit your request later.</p>
+     * <p>The number or frequency of requests exceeds the limit. Resubmit your request later.</p>
      * @public
      */
     interface ThrottlingExceptionMember {
@@ -336,7 +426,7 @@ export declare namespace ResponseStream {
  */
 export interface InvokeModelWithResponseStreamResponse {
     /**
-     * <p>Inference response from the model in the format specified by Content-Type. To see the format and content of this field for different models, refer to <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html">Inference parameters</a>.</p>
+     * <p>Inference response from the model in the format specified by the <code>contentType</code> header. To see the format and content of this field for different models, refer to <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html">Inference parameters</a>.</p>
      * @public
      */
     body: AsyncIterable<ResponseStream> | undefined;

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

@@ -14,11 +14,19 @@ export declare class InternalServerException extends __BaseException {
     opts: __ExceptionOptionType<InternalServerException, __BaseException>
   );
 }
+export declare const Trace: {
+  readonly DISABLED: "DISABLED";
+  readonly ENABLED: "ENABLED";
+};
+export type Trace = (typeof Trace)[keyof typeof Trace];
 export interface InvokeModelRequest {
   body: Uint8Array | undefined;
   contentType?: string;
   accept?: string;
   modelId: string | undefined;
+  trace?: Trace;
+  guardrailIdentifier?: string;
+  guardrailVersion?: string;
 }
 export interface InvokeModelResponse {
   body: Uint8Array | undefined;
@@ -80,6 +88,9 @@ export interface InvokeModelWithResponseStreamRequest {
   contentType?: string;
   accept?: string;
   modelId: string | undefined;
+  trace?: Trace;
+  guardrailIdentifier?: string;
+  guardrailVersion?: string;
 }
 export interface PayloadPart {
   bytes?: Uint8Array;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@aws-sdk/client-bedrock-runtime",
   "description": "AWS SDK for JavaScript Bedrock Runtime Client for Node.js, Browser and React Native",
-  "version": "3.554.0",
+  "version": "3.561.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "node ../../scripts/compilation/inline client-bedrock-runtime",
@@ -20,9 +20,9 @@
   "dependencies": {
     "@aws-crypto/sha256-browser": "3.0.0",
     "@aws-crypto/sha256-js": "3.0.0",
-    "@aws-sdk/client-sts": "3.554.0",
-    "@aws-sdk/core": "3.554.0",
-    "@aws-sdk/credential-provider-node": "3.554.0",
+    "@aws-sdk/client-sts": "3.556.0",
+    "@aws-sdk/core": "3.556.0",
+    "@aws-sdk/credential-provider-node": "3.556.0",
     "@aws-sdk/middleware-host-header": "3.535.0",
     "@aws-sdk/middleware-logger": "3.535.0",
     "@aws-sdk/middleware-recursion-detection": "3.535.0",