Class: AWS.BedrockRuntime

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.

        • text — required — (String)

          The text that you want to guard.

        • qualifiers — (Array<String>)

          The qualifier details for the guardrails contextual grounding filter.

  • inferenceConfig — (map)

    Inference parameters to pass to the model. Converse supports a base set of inference parameters. If you need to pass additional parameters that the model supports, use the additionalModelRequestFields request field.

    • maxTokens — (Integer)

      The maximum number of tokens to allow in the generated response. The default value is the maximum allowed value for the model that you are using. For more information, see Inference parameters for foundation models.

    • temperature — (Float)

      The likelihood of the model selecting higher-probability options while generating a response. A lower value makes the model more likely to choose higher-probability options, while a higher value makes the model more likely to choose lower-probability options.

      The default value is the default value for the model that you are using. For more information, see Inference parameters for foundation models.

    • topP — (Float)

      The percentage of most-likely candidates that the model considers for the next token. For example, if you choose a value of 0.8 for topP, the model selects from the top 80% of the probability distribution of tokens that could be next in the sequence.

      The default value is the default value for the model that you are using. For more information, see Inference parameters for foundation models.

    • stopSequences — (Array<String>)

      A list of stop sequences. A stop sequence is a sequence of characters that causes the model to stop generating the response.

  • toolConfig — (map)

    Configuration information for the tools that the model can use when generating a response.

    Note: This field is only supported by Anthropic Claude 3, Cohere Command R, Cohere Command R+, and Mistral Large models.
    • tools — required — (Array<map>)

      An array of tools that you want to pass to a model.

      • toolSpec — (map)

        The specfication for the tool.

        • name — required — (String)

          The name for the tool.

        • description — (String)

          The description for the tool.

        • inputSchema — required — (map)

          The input schema for the tool in JSON format.

          • json — (map)

            The JSON schema for the tool. For more information, see JSON Schema Reference.

    • toolChoice — (map)

      If supported by model, forces the model to request a tool.

      • auto — (map)

        (Default). The Model automatically decides if a tool should be called or whether to generate text instead.

      • any — (map)

        The model must request at least one tool (no text is generated).

      • tool — (map)

        The Model must request the specified tool. Only supported by Anthropic Claude 3 models.

        • name — required — (String)

          The name of the tool that the model must request.

  • guardrailConfig — (map)

    Configuration information for a guardrail that you want to use in the request.

    • guardrailIdentifier — required — (String)

      The identifier for the guardrail.

    • guardrailVersion — required — (String)

      The version of the guardrail.

    • trace — (String)

      The trace behavior for the guardrail.

      Possible values include:
      • "enabled"
      • "disabled"
  • additionalModelRequestFields — (map)

    Additional inference parameters that the model supports, beyond the base set of inference parameters that Converse supports in the inferenceConfig field. For more information, see Model parameters.

  • additionalModelResponseFieldPaths — (Array<String>)

    Additional model parameters field paths to return in the response. Converse returns the requested fields as a JSON Pointer object in the additionalModelResponseFields field. The following is example JSON for additionalModelResponseFieldPaths.

    [ "/stop_sequence" ]

    For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation.

    Converse rejects an empty JSON Pointer or incorrectly structured JSON Pointer with a 400 error code. if the JSON Pointer is valid, but the requested field is not in the model response, it is ignored by Converse.

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:

    • output — (map)

      The result from the call to Converse.

      • message — (map)

        The message that the model generates.

        • 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.

    • stopReason — (String)

      The reason why the model stopped generating output.

      Possible values include:
      • "end_turn"
      • "tool_use"
      • "max_tokens"
      • "stop_sequence"
      • "guardrail_intervened"
      • "content_filtered"
    • usage — (map)

      The total number of tokens used in the call to Converse. The total includes the tokens input to the model and the tokens generated by the model.

      • inputTokens — required — (Integer)

        The number of tokens sent in the request to the model.

      • outputTokens — required — (Integer)

        The number of tokens that the model generated for the request.

      • totalTokens — required — (Integer)

        The total of input tokens and tokens generated by the model.

    • metrics — (map)

      Metrics for the call to Converse.

      • latencyMs — required — (Integer)

        The latency of the call to Converse, in milliseconds.

    • additionalModelResponseFields — (map)

      Additional fields in the response that are unique to the model.

    • trace — (map)

      A trace object that contains information about the Guardrail behavior.

      • guardrail — (map)

        The guardrail trace object.

        • modelOutput — (Array<String>)

          The output from the model.

        • inputAssessment — (map<map>)

          The input assessment.

          • 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"
        • outputAssessments — (map<Array<map>>)

          the output assessments.

          • 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.

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

  var eventStream = data.stream;

  eventStream.on('data', function(event) {
    // Check the top-level field to determine which event this is.
    if (event.messageStart) {
      // handle messageStart event
    } else if (event.contentBlockStart) {
      // handle contentBlockStart event
    } else if (event.contentBlockDelta) {
      // handle contentBlockDelta event
    } else if (event.contentBlockStop) {
      // handle contentBlockStop event
    } else if (event.messageStop) {
      // handle messageStop event
    } else if (event.metadata) {
      // handle metadata 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.serviceUnavailableException) {
      // handle serviceUnavailableException event
    }
  });
  eventStream.on('error', function(err) { /** Handle error events **/});
  eventStream.on('end', function() { /** Finished reading all events **/});
});

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

  var events = data.stream;

  for (var event of events) {
    // Check the top-level field to determine which event this is.
    if (event.messageStart) {
      // handle messageStart event
    } else if (event.contentBlockStart) {
      // handle contentBlockStart event
    } else if (event.contentBlockDelta) {
      // handle contentBlockDelta event
    } else if (event.contentBlockStop) {
      // handle contentBlockStop event
    } else if (event.messageStop) {
      // handle messageStop event
    } else if (event.metadata) {
      // handle metadata 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.serviceUnavailableException) {
      // handle serviceUnavailableException event
    }
  }
});

// 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.converseStream({/** params **/}).promise();

    const events = result.stream;

    for await (const event of events) {
      // Check the top-level field to determine which event this is.
      if (event.messageStart) {
        // handle messageStart event
      } else if (event.contentBlockStart) {
        // handle contentBlockStart event
      } else if (event.contentBlockDelta) {
        // handle contentBlockDelta event
      } else if (event.contentBlockStop) {
        // handle contentBlockStop event
      } else if (event.messageStop) {
        // handle messageStop event
      } else if (event.metadata) {
        // handle metadata 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.serviceUnavailableException) {
        // handle serviceUnavailableException event
      }
    }
  } catch (err) {
    // handle error
  }
}

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 */
    streamProcessingMode: sync | async,
    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.converseStream(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 ID for the model.

    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 send 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.

        • text — required — (String)

          The text that you want to guard.

        • qualifiers — (Array<String>)

          The qualifier details for the guardrails contextual grounding filter.

  • inferenceConfig — (map)

    Inference parameters to pass to the model. ConverseStream supports a base set of inference parameters. If you need to pass additional parameters that the model supports, use the additionalModelRequestFields request field.

    • maxTokens — (Integer)

      The maximum number of tokens to allow in the generated response. The default value is the maximum allowed value for the model that you are using. For more information, see Inference parameters for foundation models.

    • temperature — (Float)

      The likelihood of the model selecting higher-probability options while generating a response. A lower value makes the model more likely to choose higher-probability options, while a higher value makes the model more likely to choose lower-probability options.

      The default value is the default value for the model that you are using. For more information, see Inference parameters for foundation models.

    • topP — (Float)

      The percentage of most-likely candidates that the model considers for the next token. For example, if you choose a value of 0.8 for topP, the model selects from the top 80% of the probability distribution of tokens that could be next in the sequence.

      The default value is the default value for the model that you are using. For more information, see Inference parameters for foundation models.

    • stopSequences — (Array<String>)

      A list of stop sequences. A stop sequence is a sequence of characters that causes the model to stop generating the response.

  • toolConfig — (map)

    Configuration information for the tools that the model can use when generating a response.

    Note: This field is only supported by Anthropic Claude 3 models.
    • tools — required — (Array<map>)

      An array of tools that you want to pass to a model.

      • toolSpec — (map)

        The specfication for the tool.

        • name — required — (String)

          The name for the tool.

        • description — (String)

          The description for the tool.

        • inputSchema — required — (map)

          The input schema for the tool in JSON format.

          • json — (map)

            The JSON schema for the tool. For more information, see JSON Schema Reference.

    • toolChoice — (map)

      If supported by model, forces the model to request a tool.

      • auto — (map)

        (Default). The Model automatically decides if a tool should be called or whether to generate text instead.

      • any — (map)

        The model must request at least one tool (no text is generated).

      • tool — (map)

        The Model must request the specified tool. Only supported by Anthropic Claude 3 models.

        • name — required — (String)

          The name of the tool that the model must request.

  • guardrailConfig — (map)

    Configuration information for a guardrail that you want to use in the request.

    • guardrailIdentifier — required — (String)

      The identifier for the guardrail.

    • guardrailVersion — required — (String)

      The version of the guardrail.

    • trace — (String)

      The trace behavior for the guardrail.

      Possible values include:
      • "enabled"
      • "disabled"
    • streamProcessingMode — (String)

      The processing mode.

      The processing mode. For more information, see Configure streaming response behavior in the Amazon Bedrock User Guide.

      Possible values include:
      • "sync"
      • "async"
  • additionalModelRequestFields — (map)

    Additional inference parameters that the model supports, beyond the base set of inference parameters that ConverseStream supports in the inferenceConfig field.

  • additionalModelResponseFieldPaths — (Array<String>)

    Additional model parameters field paths to return in the response. ConverseStream returns the requested fields as a JSON Pointer object in the additionalModelResponseFields field. The following is example JSON for additionalModelResponseFieldPaths.

    [ "/stop_sequence" ]

    For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation.

    ConverseStream rejects an empty JSON Pointer or incorrectly structured JSON Pointer with a 400 error code. if the JSON Pointer is valid, but the requested field is not in the model response, it is ignored by ConverseStream.

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:

    • stream — (ReadableStream<Events> | Array<Events>)

      The output stream that the model generated.

      stream is an object-mode Readable stream in Node.js v0.10.x and higher. Attach a listener to the data event to receive events. stream 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.
      • messageStart — (map)

        Message start information.

        • role — required — (String)

          The role for the message.

          Possible values include:
          • "user"
          • "assistant"
      • contentBlockStart — (map)

        Start information for a content block.

        • start — required — (map)

          Start information about a content block start event.

          • toolUse — (map)

            Information about a tool that the model is requesting to use.

            • toolUseId — required — (String)

              The ID for the tool request.

            • name — required — (String)

              The name of the tool that the model is requesting to use.

        • contentBlockIndex — required — (Integer)

          The index for a content block start event.

      • contentBlockDelta — (map)

        The messages output content block delta.

        • delta — required — (map)

          The delta for a content block delta event.

          • text — (String)

            The content text.

          • toolUse — (map)

            Information about a tool that the model is requesting to use.

            • input — required — (String)

              The input for a requested tool.

        • contentBlockIndex — required — (Integer)

          The block index for a content block delta event.

      • contentBlockStop — (map)

        Stop information for a content block.

        • contentBlockIndex — required — (Integer)

          The index for a content block.

      • messageStop — (map)

        Message stop information.

        • stopReason — required — (String)

          The reason why the model stopped generating output.

          Possible values include:
          • "end_turn"
          • "tool_use"
          • "max_tokens"
          • "stop_sequence"
          • "guardrail_intervened"
          • "content_filtered"
        • additionalModelResponseFields — (map)

          The additional model response fields.

      • metadata — (map)

        Metadata for the converse output stream.

        • usage — required — (map)

          Usage information for the conversation stream event.

          • inputTokens — required — (Integer)

            The number of tokens sent in the request to the model.

          • outputTokens — required — (Integer)

            The number of tokens that the model generated for the request.

          • totalTokens — required — (Integer)

            The total of input tokens and tokens generated by the model.

        • metrics — required — (map)

          The metrics for the conversation stream metadata event.

          • latencyMs — required — (Integer)

            The latency for the streaming request, in milliseconds.

        • trace — (map)

          The trace object in the response from ConverseStream that contains information about the guardrail behavior.

          • guardrail — (map)

            The guardrail trace object.

            • modelOutput — (Array<String>)

              The output from the model.

            • inputAssessment — (map<map>)

              The input assessment.

              • 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"
            • outputAssessments — (map<Array<map>>)

              the output assessments.

              • 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"
      • internalServerException — (map)

        An internal server error occurred. Retry your request.

        • message — (String)
      • modelStreamErrorException — (map)

        A streaming error occurred. 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 of requests exceeds the limit. Resubmit your request later.

        • message — (String)
      • serviceUnavailableException — (map)

        The service isn't currently available. Try again later.

        • message — (String)

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

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. You must provide the body in JSON format. 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. You must specify 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.

    • If you use an imported model, specify the ARN of the imported model. You can get the model ARN from a successful call to CreateModelImportJob or from the Imported models page in the Amazon Bedrock console.

  • 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.

// 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
    } else if (event.serviceUnavailableException) {
      // handle serviceUnavailableException event
    }
  });
  eventStream.on('error', function(err) { /** Handle error events **/});
  eventStream.on('end', function() { /** Finished reading all events **/});
});

// 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
    } else if (event.serviceUnavailableException) {
      // handle serviceUnavailableException event
    }
  }
});

// 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
      } else if (event.serviceUnavailableException) {
        // handle serviceUnavailableException event
      }
    }
  } catch (err) {
    // handle error
  }
}

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. You must provide the body in JSON format. 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. You must specify 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.

    • If you use an imported model, specify the ARN of the imported model. You can get the model ARN from a successful call to CreateModelImportJob or from the Imported models page in the Amazon Bedrock console.

  • 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)

        Your request was throttled because of service-wide limitations. Resubmit your request later or in a different region. You can also purchase Provisioned Throughput to increase the rate or number of tokens you can process.

        • message — (String)
      • modelTimeoutException — (map)

        The request took too long to process. Processing time exceeded the model timeout length.

        • message — (String)
      • serviceUnavailableException — (map)

        The service isn't currently available. Try again later.

        • 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.

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.