The AWS SDK for JavaScript v2 has reached end-of-support.

We recommend that you migrate to AWS SDK for JavaScript v3. For additional details and information on how to migrate, please refer to the 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.applyGuardrail(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

applyGuardrail(params = {}, callback) ⇒ AWS.Request
The action to apply a guardrail.

.
converse(params = {}, callback) ⇒ AWS.Request
Sends messages to the specified Amazon Bedrock model.
converseStream(params = {}, callback) ⇒ AWS.Request
Sends messages to the specified Amazon Bedrock model and returns the response in a stream.
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

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

The action to apply a guardrail.

Service Reference:

ApplyGuardrail

Examples:

Calling the applyGuardrail operation

var params = {
  content: [ /* required */
    {
      text: {
        text: 'STRING_VALUE', /* required */
        qualifiers: [
          grounding_source | query | guard_content,
          /* more items */
        ]
      }
    },
    /* more items */
  ],
  guardrailIdentifier: 'STRING_VALUE', /* required */
  guardrailVersion: 'STRING_VALUE', /* required */
  source: INPUT | OUTPUT /* required */
};
bedrockruntime.applyGuardrail(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: {}) —
- guardrailIdentifier — (String)
  The guardrail identifier used in the request to apply the guardrail.
- guardrailVersion — (String)
  The guardrail version used in the request to apply the guardrail.
- source — (String)
  The source of data used in the request to apply the guardrail.
  Possible values include:
  - "INPUT"
  - "OUTPUT"
- content — (Array<map>)
  The content details used in the request to apply the guardrail.
  - text — (map)
    Text within content block to be evaluated by the guardrail.
    - text — required — (String)
      The input text details to be evaluated by the guardrail.
    - qualifiers — (Array<String>)
      The qualifiers describing the text block.

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:
  - usage — (map)
    The usage details in the response from the guardrail.
    
    topicPolicyUnits — required — (Integer)
    The topic policy units processed by the guardrail.
    
    contentPolicyUnits — required — (Integer)
    The content policy units processed by the guardrail.
    
    wordPolicyUnits — required — (Integer)
    The word policy units processed by the guardrail.
    
    sensitiveInformationPolicyUnits — required — (Integer)
    The sensitive information policy units processed by the guardrail.
    
    sensitiveInformationPolicyFreeUnits — required — (Integer)
    The sensitive information policy free units processed by the guardrail.
    
    contextualGroundingPolicyUnits — required — (Integer)
    The contextual grounding policy units processed by the guardrail.
  - action — (String)
    The action taken in the response from the guardrail.
    Possible values include:
    
    "NONE"
    
    "GUARDRAIL_INTERVENED"
  - outputs — (Array<map>)
    The output details in the response from the guardrail.
    
    text — (String)
    The specific text for the output content produced by the guardrail.
  - assessments — (Array<map>)
    The assessment details in the response from the guardrail.
    
    topicPolicy — (map)
    The topic policy.
    
    topics — required — (Array<map>)
    The topics in the assessment.
    
    name — required — (String)
    The name for the guardrail.
    
    type — required — (String)
    The type behavior that the guardrail should perform when the model detects the topic.
    Possible values include:
    
    "DENY"
    
    action — required — (String)
    The action the guardrail should take when it intervenes on a topic.
    Possible values include:
    
    "BLOCKED"
    
    contentPolicy — (map)
    The content policy.
    
    filters — required — (Array<map>)
    The content policy filters.
    
    type — required — (String)
    The guardrail type.
    Possible values include:
    
    "INSULTS"
    
    "HATE"
    
    "SEXUAL"
    
    "VIOLENCE"
    
    "MISCONDUCT"
    
    "PROMPT_ATTACK"
    
    confidence — required — (String)
    The guardrail confidence.
    Possible values include:
    
    "NONE"
    
    "LOW"
    
    "MEDIUM"
    
    "HIGH"
    
    action — required — (String)
    The guardrail action.
    Possible values include:
    
    "BLOCKED"
    
    wordPolicy — (map)
    The word policy.
    
    customWords — required — (Array<map>)
    Custom words in the assessment.
    
    match — required — (String)
    The match for the custom word.
    
    action — required — (String)
    The action for the custom word.
    Possible values include:
    
    "BLOCKED"
    
    managedWordLists — required — (Array<map>)
    Managed word lists in the assessment.
    
    match — required — (String)
    The match for the managed word.
    
    type — required — (String)
    The type for the managed word.
    Possible values include:
    
    "PROFANITY"
    
    action — required — (String)
    The action for the managed word.
    Possible values include:
    
    "BLOCKED"
    
    sensitiveInformationPolicy — (map)
    The sensitive information policy.
    
    piiEntities — required — (Array<map>)
    The PII entities in the assessment.
    
    match — required — (String)
    The PII entity filter match.
    
    type — required — (String)
    The PII entity filter type.
    Possible values include:
    
    "ADDRESS"
    
    "AGE"
    
    "AWS_ACCESS_KEY"
    
    "AWS_SECRET_KEY"
    
    "CA_HEALTH_NUMBER"
    
    "CA_SOCIAL_INSURANCE_NUMBER"
    
    "CREDIT_DEBIT_CARD_CVV"
    
    "CREDIT_DEBIT_CARD_EXPIRY"
    
    "CREDIT_DEBIT_CARD_NUMBER"
    
    "DRIVER_ID"
    
    "EMAIL"
    
    "INTERNATIONAL_BANK_ACCOUNT_NUMBER"
    
    "IP_ADDRESS"
    
    "LICENSE_PLATE"
    
    "MAC_ADDRESS"
    
    "NAME"
    
    "PASSWORD"
    
    "PHONE"
    
    "PIN"
    
    "SWIFT_CODE"
    
    "UK_NATIONAL_HEALTH_SERVICE_NUMBER"
    
    "UK_NATIONAL_INSURANCE_NUMBER"
    
    "UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER"
    
    "URL"
    
    "USERNAME"
    
    "US_BANK_ACCOUNT_NUMBER"
    
    "US_BANK_ROUTING_NUMBER"
    
    "US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER"
    
    "US_PASSPORT_NUMBER"
    
    "US_SOCIAL_SECURITY_NUMBER"
    
    "VEHICLE_IDENTIFICATION_NUMBER"
    
    action — required — (String)
    The PII entity filter action.
    Possible values include:
    
    "ANONYMIZED"
    
    "BLOCKED"
    
    regexes — required — (Array<map>)
    The regex queries in the assessment.
    
    name — (String)
    The regex filter name.
    
    match — (String)
    The regesx filter match.
    
    regex — (String)
    The regex query.
    
    action — required — (String)
    The region filter action.
    Possible values include:
    
    "ANONYMIZED"
    
    "BLOCKED"
    
    contextualGroundingPolicy — (map)
    The contextual grounding policy used for the guardrail assessment.
    
    filters — (Array<map>)
    The filter details for the guardrails contextual grounding filter.
    
    type — required — (String)
    The contextual grounding filter type.
    Possible values include:
    
    "GROUNDING"
    
    "RELEVANCE"
    
    threshold — required — (Float)
    The threshold used by contextual grounding filter to determine whether the content is grounded or not.
    
    score — required — (Float)
    The score generated by contextual grounding filter.
    
    action — required — (String)
    The action performed by the guardrails contextual grounding filter.
    Possible values include:
    
    "BLOCKED"
    
    "NONE"

Returns:

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

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

Sends messages to the specified Amazon Bedrock model. Converse provides a consistent interface that works with all models that support messages. This allows you to write code once and use it with different models. If a model has unique inference parameters, you can also pass those unique parameters to the model.

Amazon Bedrock doesn't store any text, images, or documents that you provide as content. The data is only used to generate the response.

For information about the Converse API, see Use the Converse API in the Amazon Bedrock User Guide. To use a guardrail, see Use a guardrail with the Converse API in the Amazon Bedrock User Guide. To use a tool with a model, see Tool use (Function calling) in the Amazon Bedrock User Guide

For example code, see Converse API examples in the Amazon Bedrock User Guide.

This operation requires permission for the bedrock:InvokeModel action.

Service Reference:

Converse

Examples:

Calling the converse operation

var params = {
  messages: [ /* required */
    {
      content: [ /* required */
        {
          document: {
            format: pdf | csv | doc | docx | xls | xlsx | html | txt | md, /* required */
            name: 'STRING_VALUE', /* required */
            source: { /* required */
              bytes: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */
            }
          },
          guardContent: {
            text: {
              text: 'STRING_VALUE', /* required */
              qualifiers: [
                grounding_source | query | guard_content,
                /* more items */
              ]
            }
          },
          image: {
            format: png | jpeg | gif | webp, /* required */
            source: { /* required */
              bytes: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */
            }
          },
          text: 'STRING_VALUE',
          toolResult: {
            content: [ /* required */
              {
                document: {
                  format: pdf | csv | doc | docx | xls | xlsx | html | txt | md, /* required */
                  name: 'STRING_VALUE', /* required */
                  source: { /* required */
                    bytes: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */
                  }
                },
                image: {
                  format: png | jpeg | gif | webp, /* required */
                  source: { /* required */
                    bytes: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */
                  }
                },
                json: {
                },
                text: 'STRING_VALUE'
              },
              /* more items */
            ],
            toolUseId: 'STRING_VALUE', /* required */
            status: success | error
          },
          toolUse: {
            input: { /* required */
            },
            name: 'STRING_VALUE', /* required */
            toolUseId: 'STRING_VALUE' /* required */
          }
        },
        /* more items */
      ],
      role: user | assistant /* required */
    },
    /* more items */
  ],
  modelId: 'STRING_VALUE', /* required */
  additionalModelRequestFields: {
  },
  additionalModelResponseFieldPaths: [
    'STRING_VALUE',
    /* more items */
  ],
  guardrailConfig: {
    guardrailIdentifier: 'STRING_VALUE', /* required */
    guardrailVersion: 'STRING_VALUE', /* required */
    trace: enabled | disabled
  },
  inferenceConfig: {
    maxTokens: 'NUMBER_VALUE',
    stopSequences: [
      'STRING_VALUE',
      /* more items */
    ],
    temperature: 'NUMBER_VALUE',
    topP: 'NUMBER_VALUE'
  },
  system: [
    {
      guardContent: {
        text: {
          text: 'STRING_VALUE', /* required */
          qualifiers: [
            grounding_source | query | guard_content,
            /* more items */
          ]
        }
      },
      text: 'STRING_VALUE'
    },
    /* more items */
  ],
  toolConfig: {
    tools: [ /* required */
      {
        toolSpec: {
          inputSchema: { /* required */
            json: {
            }
          },
          name: 'STRING_VALUE', /* required */
          description: 'STRING_VALUE'
        }
      },
      /* more items */
    ],
    toolChoice: {
      any: {
      },
      auto: {
      },
      tool: {
        name: 'STRING_VALUE' /* required */
      }
    }
  }
};
bedrockruntime.converse(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: {}) —
- modelId — (String)
  The identifier for the model that you want to call.
  
  The modelId to provide depends on the type of model or throughput 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 an inference profile, specify the inference profile ID or its ARN. For a list of inference profile IDs, see Supported Regions and models for cross-region inference 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.
  The Converse API doesn't support imported models.
- messages — (Array<map>)
  The messages that you want to send to the model.
  - role — required — (String)
    The role that the message plays in the message.
    Possible values include:
    - "user"
    - "assistant"
  - content — required — (Array<map>)
    The message content. Note the following restrictions:
    - You can include up to 20 images. Each image's size, height, and width must be no more than 3.75 MB, 8000 px, and 8000 px, respectively.
    - You can include up to five documents. Each document's size must be no more than 4.5 MB.
    - If you include a ContentBlock with a document field in the array, you must also include a ContentBlock with a text field.
    - You can only include images and documents if the role is user.
    - text — (String)
      Text to include in the message.
    - image — (map)
      Image to include in the message.
      
      Note: This field is only supported by Anthropic Claude 3 models.
      
      format — required — (String)
      The format of the image.
      Possible values include:
      
      "png"
      
      "jpeg"
      
      "gif"
      
      "webp"
      
      source — required — (map)
      The source for the image.
      
      bytes — (Buffer, Typed Array, Blob, String)
      The raw image bytes for the image. If you use an AWS SDK, you don't need to encode the image bytes in base64.
    - document — (map)
      A document to include in the message.
      
      format — required — (String)
      The format of a document, or its extension.
      Possible values include:
      
      "pdf"
      
      "csv"
      
      "doc"
      
      "docx"
      
      "xls"
      
      "xlsx"
      
      "html"
      
      "txt"
      
      "md"
      
      name — required — (String)
      A name for the document. The name can only contain the following characters:
      
      Alphanumeric characters
      
      Whitespace characters (no more than one in a row)
      
      Hyphens
      
      Parentheses
      
      Square brackets
      
      Note: This field is vulnerable to prompt injections, because the model might inadvertently interpret it as instructions. Therefore, we recommend that you specify a neutral name.
      
      source — required — (map)
      Contains the content of the document.
      
      bytes — (Buffer, Typed Array, Blob, String)
      The raw bytes for the document. If you use an Amazon Web Services SDK, you don't need to encode the bytes in base64.
    - toolUse — (map)
      Information about a tool use request from a model.
      
      toolUseId — required — (String)
      The ID for the tool request.
      
      name — required — (String)
      The name of the tool that the model wants to use.
      
      input — required — (map)
      The input to pass to the tool.
    - toolResult — (map)
      The result for a tool request that a model makes.
      
      toolUseId — required — (String)
      The ID of the tool request that this is the result for.
      
      content — required — (Array<map>)
      The content for tool result content block.
      
      json — (map)
      A tool result that is JSON format data.
      
      text — (String)
      A tool result that is text.
      
      image — (map)
      A tool result that is an image.
      
      Note: This field is only supported by Anthropic Claude 3 models.
      
      format — required — (String)
      The format of the image.
      Possible values include:
      
      "png"
      
      "jpeg"
      
      "gif"
      
      "webp"
      
      source — required — (map)
      The source for the image.
      
      bytes — (Buffer, Typed Array, Blob, String)
      The raw image bytes for the image. If you use an AWS SDK, you don't need to encode the image bytes in base64.
      
      document — (map)
      A tool result that is a document.
      
      format — required — (String)
      The format of a document, or its extension.
      Possible values include:
      
      "pdf"
      
      "csv"
      
      "doc"
      
      "docx"
      
      "xls"
      
      "xlsx"
      
      "html"
      
      "txt"
      
      "md"
      
      name — required — (String)
      A name for the document. The name can only contain the following characters:
      
      Alphanumeric characters
      
      Whitespace characters (no more than one in a row)
      
      Hyphens
      
      Parentheses
      
      Square brackets
      
      Note: This field is vulnerable to prompt injections, because the model might inadvertently interpret it as instructions. Therefore, we recommend that you specify a neutral name.
      
      source — required — (map)
      Contains the content of the document.
      
      bytes — (Buffer, Typed Array, Blob, String)
      The raw bytes for the document. If you use an Amazon Web Services SDK, you don't need to encode the bytes in base64.
      
      status — (String)
      The status for the tool result content block.
      
      Note: This field is only supported Anthropic Claude 3 models.
      Possible values include:
      
      "success"
      
      "error"
    - guardContent — (map)
      Contains the content to assess with the guardrail. If you don't specify guardContent in a call to the Converse API, the guardrail (if passed in the Converse API) assesses the entire message.
      
      For more information, see Use a guardrail with the Converse API in the Amazon Bedrock User Guide.
      </p>
      
      text — (map)
      The text to guard.
      
      text — required — (String)
      The text that you want to guard.
      
      qualifiers — (Array<String>)
      The qualifier details for the guardrails contextual grounding filter.
- system — (Array<map>)
  A system prompt to pass to the model.
  - text — (String)
    A system prompt for the model.
  - guardContent — (map)
    A content block to assess with the guardrail. Use with the Converse or ConverseStream API operations.
    
    For more information, see Use a guardrail with the Converse API in the Amazon Bedrock User Guide.
    - text — (map)
      The text to guard.

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

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

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

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

endpoint ⇒ `AWS.Endpoint` (readwrite)

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

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