We announced the upcoming end-of-support for AWS SDK for JavaScript v2.

We recommend that you migrate to AWS SDK for JavaScript v3. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

Class: AWS.BedrockRuntime

Inherits:

AWS.Service

Object
AWS.Service
AWS.BedrockRuntime

show all

Identifier:: bedrockruntime

API Version:: 2023-09-30

Defined in:: (unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

Describes the API operations for running inference using Amazon Bedrock models.

Sending a Request Using BedrockRuntime

var bedrockruntime = new AWS.BedrockRuntime();
bedrockruntime.invokeModel(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the BedrockRuntime object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var bedrockruntime = new AWS.BedrockRuntime({apiVersion: '2023-09-30'});

You can also set the API version globally in AWS.config.apiVersions using the bedrockruntime service identifier:

AWS.config.apiVersions = {
  bedrockruntime: '2023-09-30',
  // other service API versions
};

var bedrockruntime = new AWS.BedrockRuntime();

Version:

2023-09-30

Constructor Summary collapse

new AWS.BedrockRuntime(options = {}) ⇒ Object constructor
Constructs a service object.

Property Summary collapse

endpoint ⇒ AWS.Endpoint readwrite
An Endpoint object representing the endpoint URL for service requests.

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

invokeModel(params = {}, callback) ⇒ AWS.Request
Invokes the specified Amazon Bedrock model to run inference using the prompt and inference parameters provided in the request body.
invokeModelWithResponseStream(params = {}, callback) ⇒ AWS.Request
Invoke the specified Amazon Bedrock model to run inference using the prompt and inference parameters provided in the request body.
waitFor(state, params = {}, callback) ⇒ AWS.Request
Waits for a given BedrockRuntime resource.

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, setupRequestListeners, defineService

Constructor Details

new AWS.BedrockRuntime(options = {}) ⇒ `Object`

Constructs a service object. This object has one method for each API operation.

Examples:

Constructing a BedrockRuntime object

var bedrockruntime = new AWS.BedrockRuntime({apiVersion: '2023-09-30'});

Options Hash (options):

params (map) —
An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.
endpoint (String|AWS.Endpoint) —
The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com' or an Endpoint object.
accessKeyId (String) —
your AWS access key ID.
secretAccessKey (String) —
your AWS secret access key.
sessionToken (AWS.Credentials) —
the optional AWS session token to sign requests with.
credentials (AWS.Credentials) —
the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.
credentialProvider (AWS.CredentialProviderChain) —
the provider chain used to resolve credentials if no static credentials property is set.
region (String) —
the region to send service requests to. See AWS.BedrockRuntime.region for more information.
maxRetries (Integer) —
the maximum amount of retries to attempt with a request. See AWS.BedrockRuntime.maxRetries for more information.
maxRedirects (Integer) —
the maximum amount of redirects to follow with a request. See AWS.BedrockRuntime.maxRedirects for more information.
sslEnabled (Boolean) —
whether to enable SSL for requests.
paramValidation (Boolean|map) —
whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:
- min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
- max [Boolean] — Validates that a value meets the max constraint.
- pattern [Boolean] — Validates that a string value matches a regular expression.
- enum [Boolean] — Validates that a string value matches one of the allowable enum values.
computeChecksums (Boolean) —
whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)
convertResponseTypes (Boolean) —
whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.
correctClockSkew (Boolean) —
whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.
s3ForcePathStyle (Boolean) —
whether to force path style URLs for S3 objects.
s3BucketEndpoint (Boolean) —
whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.
s3DisableBodySigning (Boolean) —
whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.
s3UsEast1RegionalEndpoint ('legacy'|'regional') —
when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to legacy
s3UseArnRegion (Boolean) —
whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to true
retryDelayOptions (map) —
A set of options to configure the retry delay on retryable errors. Currently supported options are:
- base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
- customBackoff [function] — A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied. The function is only called for retryable errors.
httpOptions (map) —
A set of options to pass to the low-level HTTP request. Currently supported options are:
- proxy [String] — the URL to proxy requests through
- agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
- connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
- timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
- xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
- xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
apiVersion (String, Date) —
a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.
apiVersions (map<String, String|Date>) —
a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.
logger (#write, #log) —
an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests
systemClockOffset (Number) —
an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.
signatureVersion (String) —
the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.
signatureCache (Boolean) —
whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.
dynamoDbCrc32 (Boolean) —
whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.
useAccelerateEndpoint (Boolean) —
Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.
clientSideMonitoring (Boolean) —
whether to collect and publish this client's performance metrics of all its API requests.
endpointDiscoveryEnabled (Boolean|undefined) —
whether to call operations with endpoints given by service dynamically. Setting this
endpointCacheSize (Number) —
the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000
hostPrefixEnabled (Boolean) —
whether to marshal request parameters to the prefix of hostname. Defaults to true.
stsRegionalEndpoints ('legacy'|'regional') —
whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.
useFipsEndpoint (Boolean) —
Enables FIPS compatible endpoints. Defaults to false.
useDualstackEndpoint (Boolean) —
Enables IPv6 dualstack endpoint. Defaults to false.

Property Details

endpoint ⇒ `AWS.Endpoint` (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

(AWS.Endpoint) —
an Endpoint object representing the endpoint URL for service requests.

Method Details

invokeModel(params = {}, callback) ⇒ `AWS.Request`

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.

For example code, see Invoke model code examples in the Amazon Bedrock User Guide.

This operation requires permission for the bedrock:InvokeModel action.

Service Reference:

InvokeModel

Examples:

Calling the invokeModel operation

var params = {
  body: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */, /* required */
  modelId: 'STRING_VALUE', /* required */
  accept: 'STRING_VALUE',
  contentType: 'STRING_VALUE',
  guardrailIdentifier: 'STRING_VALUE',
  guardrailVersion: 'STRING_VALUE',
  trace: ENABLED | DISABLED
};
bedrockruntime.invokeModel(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- body — (Buffer, Typed Array, Blob, String)
  The prompt and inference parameters in the format specified in the contentType in the header. To see the format and content of the request and response bodies for different models, refer to Inference parameters. For more information, see Run inference in the Bedrock User Guide.
- contentType — (String)
  The MIME type of the input data in the request. The default value is application/json.
- accept — (String)
  The desired MIME type of the inference body in the response. The default value is application/json.
- modelId — (String)
  The unique identifier of the model to invoke to run inference.
  
  The modelId to provide depends on the type of model that you use:
  - If you use a base model, specify the model ID or its ARN. For a list of model IDs for base models, see Amazon Bedrock base model IDs (on-demand throughput) in the Amazon Bedrock User Guide.
  - If you use a provisioned model, specify the ARN of the Provisioned Throughput. For more information, see Run inference using a Provisioned Throughput in the Amazon Bedrock User Guide.
  - 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 Use a custom model in Amazon Bedrock in the Amazon Bedrock User Guide.
- trace — (String)
  Specifies whether to enable or disable the Bedrock trace. If enabled, you can see the full Bedrock trace.
  Possible values include:
  - "ENABLED"
  - "DISABLED"
- guardrailIdentifier — (String)
  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.
  
  An error will be thrown in the following situations.
  - You don't provide a guardrail identifier but you specify the amazon-bedrock-guardrailConfig field in the request body.
  - You enable the guardrail but the contentType isn't application/json.
  - You provide a guardrail identifier, but guardrailVersion isn't specified.
- guardrailVersion — (String)
  The version number for the guardrail. The value can also be DRAFT.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - body — (Buffer(Node.js), Typed Array(Browser))
    Inference response from the model in the format specified in the contentType header. To see the format and content of the request and response bodies for different models, refer to Inference parameters.
  - contentType — (String)
    The MIME type of the inference result.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

invokeModelWithResponseStream(params = {}, callback) ⇒ `AWS.Request`

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.

To see if a model supports streaming, call GetFoundationModel and check the responseStreamingSupported field in the response.

Note: The CLI doesn't support InvokeModelWithResponseStream.

For example code, see Invoke model with streaming code example in the Amazon Bedrock User Guide.

This operation requires permissions to perform the bedrock:InvokeModelWithResponseStream action.

Service Reference:

InvokeModelWithResponseStream

Examples:

Node.js EventStream Example

// In Node.js, events are streamed and can be read as they arrive.
bedrockruntime.invokeModelWithResponseStream({/** params **/}, function(err, data) {
  if (err) {
    // handle error
    return console.error(err);
  }

  var eventStream = data.body;

  eventStream.on('data', function(event) {
    // Check the top-level field to determine which event this is.
    if (event.chunk) {
      // handle chunk event
    } else if (event.internalServerException) {
      // handle internalServerException event
    } else if (event.modelStreamErrorException) {
      // handle modelStreamErrorException event
    } else if (event.validationException) {
      // handle validationException event
    } else if (event.throttlingException) {
      // handle throttlingException event
    } else if (event.modelTimeoutException) {
      // handle modelTimeoutException event
    }
  });
  eventStream.on('error', function(err) { /** Handle error events **/});
  eventStream.on('end', function() { /** Finished reading all events **/});
});

Browser EventStream Example

// In browsers, events aren't processed until the response is fully buffered.
// Events will be accessible as an array.
bedrockruntime.invokeModelWithResponseStream({/** params **/}, function(err, data) {
  if (err) {
    // handle error
    return console.error(err);
  }

  var events = data.body;

  for (var event of events) {
    // Check the top-level field to determine which event this is.
    if (event.chunk) {
      // handle chunk event
    } else if (event.internalServerException) {
      // handle internalServerException event
    } else if (event.modelStreamErrorException) {
      // handle modelStreamErrorException event
    } else if (event.validationException) {
      // handle validationException event
    } else if (event.throttlingException) {
      // handle throttlingException event
    } else if (event.modelTimeoutException) {
      // handle modelTimeoutException event
    }
  }
});

Async Iterator EventStream Example (Experimental)

// In Node.js v10.x, Readable streams have experimental support for async iteration.
// Instead of listening to the event stream's 'data' event, you can use a for...await loop.
async function example() {
  try {
    const result = await bedrockruntime.invokeModelWithResponseStream({/** params **/}).promise();

    const events = result.body;

    for await (const event of events) {
      // Check the top-level field to determine which event this is.
      if (event.chunk) {
        // handle chunk event
      } else if (event.internalServerException) {
        // handle internalServerException event
      } else if (event.modelStreamErrorException) {
        // handle modelStreamErrorException event
      } else if (event.validationException) {
        // handle validationException event
      } else if (event.throttlingException) {
        // handle throttlingException event
      } else if (event.modelTimeoutException) {
        // handle modelTimeoutException event
      }
    }
  } catch (err) {
    // handle error
  }
}

Calling the invokeModelWithResponseStream operation

var params = {
  body: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */, /* required */
  modelId: 'STRING_VALUE', /* required */
  accept: 'STRING_VALUE',
  contentType: 'STRING_VALUE',
  guardrailIdentifier: 'STRING_VALUE',
  guardrailVersion: 'STRING_VALUE',
  trace: ENABLED | DISABLED
};
bedrockruntime.invokeModelWithResponseStream(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- body — (Buffer, Typed Array, Blob, String)
  The prompt and inference parameters in the format specified in the contentType in the header. To see the format and content of the request and response bodies for different models, refer to Inference parameters. For more information, see Run inference in the Bedrock User Guide.
- contentType — (String)
  The MIME type of the input data in the request. The default value is application/json.
- accept — (String)
  The desired MIME type of the inference body in the response. The default value is application/json.
- modelId — (String)
  The unique identifier of the model to invoke to run inference.
  
  The modelId to provide depends on the type of model that you use:
  - If you use a base model, specify the model ID or its ARN. For a list of model IDs for base models, see Amazon Bedrock base model IDs (on-demand throughput) in the Amazon Bedrock User Guide.
  - If you use a provisioned model, specify the ARN of the Provisioned Throughput. For more information, see Run inference using a Provisioned Throughput in the Amazon Bedrock User Guide.
  - 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 Use a custom model in Amazon Bedrock in the Amazon Bedrock User Guide.
- trace — (String)
  Specifies whether to enable or disable the Bedrock trace. If enabled, you can see the full Bedrock trace.
  Possible values include:
  - "ENABLED"
  - "DISABLED"
- guardrailIdentifier — (String)
  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.
  
  An error is thrown in the following situations.
  - You don't provide a guardrail identifier but you specify the amazon-bedrock-guardrailConfig field in the request body.
  - You enable the guardrail but the contentType isn't application/json.
  - You provide a guardrail identifier, but guardrailVersion isn't specified.
- guardrailVersion — (String)
  The version number for the guardrail. The value can also be DRAFT.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - body — (ReadableStream<Events> | Array<Events>)
    Inference response from the model in the format specified by the contentType header. To see the format and content of this field for different models, refer to Inference parameters.
    body is an object-mode Readable stream in Node.js v0.10.x and higher. Attach a listener to the data event to receive events. body is an array of events in browsers. The possible events that may be returned are listed below. Note that the top-level field in each event matches the event name.
    
    chunk — (map)
    Content included in the response.
    
    bytes — (Buffer, Typed Array, Blob, String)
    Base64-encoded bytes of payload data.
    
    internalServerException — (map)
    An internal server error occurred. Retry your request.
    
    message — (String)
    
    modelStreamErrorException — (map)
    An error occurred while streaming the response. Retry your request.
    
    message — (String)
    
    originalStatusCode — (Integer)
    The original status code.
    
    originalMessage — (String)
    The original message.
    
    validationException — (map)
    Input validation failed. Check your request parameters and retry the request.
    
    message — (String)
    
    throttlingException — (map)
    The number or frequency of requests exceeds the limit. Resubmit your request later.
    
    message — (String)
    
    modelTimeoutException — (map)
    The request took too long to process. Processing time exceeded the model timeout length.
    
    message — (String)
  - contentType — (String)
    The MIME type of the inference result.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

waitFor(state, params = {}, callback) ⇒ `AWS.Request`

Waits for a given BedrockRuntime resource. The final callback or 'complete' event will be fired only when the resource is either in its final state or the waiter has timed out and stopped polling for the final state.

Parameters:

state (String) —
the resource state to wait for. Available states for this service are listed in "Waiter Resource States" below.
params (map) (defaults to: {}) —
a list of parameters for the given state. See each waiter resource state for required parameters.

Callback (callback):

function(err, data) { ... }

Callback containing error and data information. See the respective resource state for the expected error or data information.

If the waiter times out its requests, it will return a ResourceNotReady error.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

Class: AWS.BedrockRuntime

Overview

Service Description

Sending a Request Using BedrockRuntime

Locking the API Version

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

Method Summary collapse

Methods inherited from AWS.Service

Constructor Details

new AWS.BedrockRuntime(options = {}) ⇒ Object

Property Details

endpoint ⇒ AWS.Endpoint (readwrite)

Method Details

invokeModel(params = {}, callback) ⇒ AWS.Request

invokeModelWithResponseStream(params = {}, callback) ⇒ AWS.Request

waitFor(state, params = {}, callback) ⇒ AWS.Request

new AWS.BedrockRuntime(options = {}) ⇒ `Object`

endpoint ⇒ `AWS.Endpoint` (readwrite)

invokeModel(params = {}, callback) ⇒ `AWS.Request`

invokeModelWithResponseStream(params = {}, callback) ⇒ `AWS.Request`

waitFor(state, params = {}, callback) ⇒ `AWS.Request`