@aws-sdk/client-bedrock-runtime 3.598.0 → 3.602.0

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

@@ -13,6 +13,39 @@ export declare class AccessDeniedException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
 }
+/**
+ * @public
+ * @enum
+ */
+export declare const GuardrailTrace: {
+    readonly DISABLED: "disabled";
+    readonly ENABLED: "enabled";
+};
+/**
+ * @public
+ */
+export type GuardrailTrace = (typeof GuardrailTrace)[keyof typeof GuardrailTrace];
+/**
+ * <p>Configuration information for a guardrail that you use with the <a>Converse</a> action.</p>
+ * @public
+ */
+export interface GuardrailConfiguration {
+    /**
+     * <p>The identifier for the guardrail.</p>
+     * @public
+     */
+    guardrailIdentifier: string | undefined;
+    /**
+     * <p>The version of the guardrail.</p>
+     * @public
+     */
+    guardrailVersion: string | undefined;
+    /**
+     * <p>The trace behavior for the guardrail.</p>
+     * @public
+     */
+    trace?: GuardrailTrace;
+}
 /**
  * <p>Base inference parameters to pass to a model in a call to <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_Converse.html">Converse</a> or <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_ConverseStream.html">ConverseStream</a>. For more information,
  *          see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html">Inference parameters for foundation models</a>.</p>
@@ -26,96 +59,7 @@ export interface InferenceConfiguration {
     /**
      * <p>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
-     *             <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html">Inference parameters for foundatio\{
-     *                 "messages": [
-     *                 \{
-     *                 "role": "user",
-     *                 "content": [
-     *                 \{
-     *                 "text": "what's the weather in Queens, NY and Austin, TX?"
-     *                 \}
-     *                 ]
-     *                 \},
-     *                 \{
-     *                 "role": "assistant",
-     *                 "content": [
-     *                 \{
-     *                 "toolUse": \{
-     *                 "toolUseId": "1",
-     *                 "name": "get_weather",
-     *                 "input": \{
-     *                 "city": "Queens",
-     *                 "state": "NY"
-     *                 \}
-     *                 \}
-     *                 \},
-     *                 \{
-     *                 "toolUse": \{
-     *                 "toolUseId": "2",
-     *                 "name": "get_weather",
-     *                 "input": \{
-     *                 "city": "Austin",
-     *                 "state": "TX"
-     *                 \}
-     *                 \}
-     *                 \}
-     *                 ]
-     *                 \},
-     *                 \{
-     *                 "role": "user",
-     *                 "content": [
-     *                 \{
-     *                 "toolResult": \{
-     *                 "toolUseId": "2",
-     *                 "content": [
-     *                 \{
-     *                 "json": \{
-     *                 "weather": "40"
-     *                 \}
-     *                 \}
-     *                 ]
-     *                 \}
-     *                 \},
-     *                 \{
-     *                 "text": "..."
-     *                 \},
-     *                 \{
-     *                 "toolResult": \{
-     *                 "toolUseId": "1",
-     *                 "content": [
-     *                 \{
-     *                 "text": "result text"
-     *                 \}
-     *                 ]
-     *                 \}
-     *                 \}
-     *                 ]
-     *                 \}
-     *                 ],
-     *                 "toolConfig": \{
-     *                 "tools": [
-     *                 \{
-     *                 "name": "get_weather",
-     *                 "description": "Get weather",
-     *                 "inputSchema": \{
-     *                 "type": "object",
-     *                 "properties": \{
-     *                 "city": \{
-     *                 "type": "string",
-     *                 "description": "City of location"
-     *                 \},
-     *                 "state": \{
-     *                 "type": "string",
-     *                 "description": "State of location"
-     *                 \}
-     *                 \},
-     *                 "required": ["city", "state"]
-     *                 \}
-     *                 \}
-     *                 ]
-     *                 \}
-     *                 \}
-     *                 n models</a>. </p>
+     *             <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html">Inference parameters for foundation models</a>. </p>
      * @public
      */
     maxTokens?: number;
@@ -146,6 +90,119 @@ export interface InferenceConfiguration {
      */
     stopSequences?: string[];
 }
+/**
+ * @public
+ * @enum
+ */
+export declare const DocumentFormat: {
+    readonly CSV: "csv";
+    readonly DOC: "doc";
+    readonly DOCX: "docx";
+    readonly HTML: "html";
+    readonly MD: "md";
+    readonly PDF: "pdf";
+    readonly TXT: "txt";
+    readonly XLS: "xls";
+    readonly XLSX: "xlsx";
+};
+/**
+ * @public
+ */
+export type DocumentFormat = (typeof DocumentFormat)[keyof typeof DocumentFormat];
+/**
+ * <p>Contains the content of the document included in a message when sending a <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_Converse.html">Converse</a> or <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_ConverseStream.html">ConverseStream</a> request or in the response.</p>
+ * @public
+ */
+export type DocumentSource = DocumentSource.BytesMember | DocumentSource.$UnknownMember;
+/**
+ * @public
+ */
+export declare namespace DocumentSource {
+    /**
+     * <p>A base64-encoded string of a UTF-8 encoded file, that is the document to include in the message.</p>
+     * @public
+     */
+    interface BytesMember {
+        bytes: Uint8Array;
+        $unknown?: never;
+    }
+    /**
+     * @public
+     */
+    interface $UnknownMember {
+        bytes?: never;
+        $unknown: [string, any];
+    }
+    interface Visitor<T> {
+        bytes: (value: Uint8Array) => T;
+        _: (name: string, value: any) => T;
+    }
+    const visit: <T>(value: DocumentSource, visitor: Visitor<T>) => T;
+}
+/**
+ * <p>A document to include in a message when sending a <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_Converse.html">Converse</a> or <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_ConverseStream.html">ConverseStream</a> request. You can include up to 5 documents in a request. The maximum document size is 50 MB.</p>
+ * @public
+ */
+export interface DocumentBlock {
+    /**
+     * <p>The format of a document, or its extension.</p>
+     * @public
+     */
+    format: DocumentFormat | undefined;
+    /**
+     * <p>A name for the document.</p>
+     * @public
+     */
+    name: string | undefined;
+    /**
+     * <p>Contains the content of the document.</p>
+     * @public
+     */
+    source: DocumentSource | undefined;
+}
+/**
+ * <p>A text block that contains text that you want to assess with a guardrail. For more information, see <a>GuardrailConverseContentBlock</a>.</p>
+ * @public
+ */
+export interface GuardrailConverseTextBlock {
+    /**
+     * <p>The text that you want to guard.</p>
+     * @public
+     */
+    text: string | undefined;
+}
+/**
+ * <p/>
+ *          <p>A content block for selective guarding with the Converse API (<a>Converse</a> and <a>ConverseStream</a>).
+ *       </p>
+ * @public
+ */
+export type GuardrailConverseContentBlock = GuardrailConverseContentBlock.TextMember | GuardrailConverseContentBlock.$UnknownMember;
+/**
+ * @public
+ */
+export declare namespace GuardrailConverseContentBlock {
+    /**
+     * <p>The text to guard.</p>
+     * @public
+     */
+    interface TextMember {
+        text: GuardrailConverseTextBlock;
+        $unknown?: never;
+    }
+    /**
+     * @public
+     */
+    interface $UnknownMember {
+        text?: never;
+        $unknown: [string, any];
+    }
+    interface Visitor<T> {
+        text: (value: GuardrailConverseTextBlock) => T;
+        _: (name: string, value: any) => T;
+    }
+    const visit: <T>(value: GuardrailConverseContentBlock, visitor: Visitor<T>) => T;
+}
 /**
  * @public
  * @enum
@@ -210,7 +267,7 @@ export interface ImageBlock {
  * <p>The tool result content block.</p>
  * @public
  */
-export type ToolResultContentBlock = ToolResultContentBlock.ImageMember | ToolResultContentBlock.JsonMember | ToolResultContentBlock.TextMember | ToolResultContentBlock.$UnknownMember;
+export type ToolResultContentBlock = ToolResultContentBlock.DocumentMember | ToolResultContentBlock.ImageMember | ToolResultContentBlock.JsonMember | ToolResultContentBlock.TextMember | ToolResultContentBlock.$UnknownMember;
 /**
  * @public
  */
@@ -223,6 +280,7 @@ export declare namespace ToolResultContentBlock {
         json: __DocumentType;
         text?: never;
         image?: never;
+        document?: never;
         $unknown?: never;
     }
     /**
@@ -233,6 +291,7 @@ export declare namespace ToolResultContentBlock {
         json?: never;
         text: string;
         image?: never;
+        document?: never;
         $unknown?: never;
     }
     /**
@@ -246,6 +305,18 @@ export declare namespace ToolResultContentBlock {
         json?: never;
         text?: never;
         image: ImageBlock;
+        document?: never;
+        $unknown?: never;
+    }
+    /**
+     * <p>A tool result that is a document.</p>
+     * @public
+     */
+    interface DocumentMember {
+        json?: never;
+        text?: never;
+        image?: never;
+        document: DocumentBlock;
         $unknown?: never;
     }
     /**
@@ -255,12 +326,14 @@ export declare namespace ToolResultContentBlock {
         json?: never;
         text?: never;
         image?: never;
+        document?: never;
         $unknown: [string, any];
     }
     interface Visitor<T> {
         json: (value: __DocumentType) => T;
         text: (value: string) => T;
         image: (value: ImageBlock) => T;
+        document: (value: DocumentBlock) => T;
         _: (name: string, value: any) => T;
     }
     const visit: <T>(value: ToolResultContentBlock, visitor: Visitor<T>) => T;
@@ -325,10 +398,10 @@ export interface ToolUseBlock {
     input: __DocumentType | undefined;
 }
 /**
- * <p>A block of content for a message.</p>
+ * <p>A block of content for a message that you pass to, or receive from, a model with the Converse API (<a>Converse</a> and <a>ConverseStream</a>).</p>
  * @public
  */
-export type ContentBlock = ContentBlock.ImageMember | ContentBlock.TextMember | ContentBlock.ToolResultMember | ContentBlock.ToolUseMember | ContentBlock.$UnknownMember;
+export type ContentBlock = ContentBlock.DocumentMember | ContentBlock.GuardContentMember | ContentBlock.ImageMember | ContentBlock.TextMember | ContentBlock.ToolResultMember | ContentBlock.ToolUseMember | ContentBlock.$UnknownMember;
 /**
  * @public
  */
@@ -340,8 +413,10 @@ export declare namespace ContentBlock {
     interface TextMember {
         text: string;
         image?: never;
+        document?: never;
         toolUse?: never;
         toolResult?: never;
+        guardContent?: never;
         $unknown?: never;
     }
     /**
@@ -354,8 +429,23 @@ export declare namespace ContentBlock {
     interface ImageMember {
         text?: never;
         image: ImageBlock;
+        document?: never;
         toolUse?: never;
         toolResult?: never;
+        guardContent?: never;
+        $unknown?: never;
+    }
+    /**
+     * <p>A document to include in the message.</p>
+     * @public
+     */
+    interface DocumentMember {
+        text?: never;
+        image?: never;
+        document: DocumentBlock;
+        toolUse?: never;
+        toolResult?: never;
+        guardContent?: never;
         $unknown?: never;
     }
     /**
@@ -365,8 +455,10 @@ export declare namespace ContentBlock {
     interface ToolUseMember {
         text?: never;
         image?: never;
+        document?: never;
         toolUse: ToolUseBlock;
         toolResult?: never;
+        guardContent?: never;
         $unknown?: never;
     }
     /**
@@ -376,8 +468,28 @@ export declare namespace ContentBlock {
     interface ToolResultMember {
         text?: never;
         image?: never;
+        document?: never;
         toolUse?: never;
         toolResult: ToolResultBlock;
+        guardContent?: never;
+        $unknown?: never;
+    }
+    /**
+     * <p>Contains the content to assess with the guardrail. If you don't specify
+     *             <code>guardContent</code> in a call to the Converse API, the guardrail (if passed in the
+     *          Converse API) assesses the entire message.</p>
+     *          <p>For more information, see  <i>Use a guardrail with the Converse API</i> in the <i>Amazon Bedrock User Guide</i>.
+     *
+     *       </p>
+     * @public
+     */
+    interface GuardContentMember {
+        text?: never;
+        image?: never;
+        document?: never;
+        toolUse?: never;
+        toolResult?: never;
+        guardContent: GuardrailConverseContentBlock;
         $unknown?: never;
     }
     /**
@@ -386,15 +498,19 @@ export declare namespace ContentBlock {
     interface $UnknownMember {
         text?: never;
         image?: never;
+        document?: never;
         toolUse?: never;
         toolResult?: never;
+        guardContent?: never;
         $unknown: [string, any];
     }
     interface Visitor<T> {
         text: (value: string) => T;
         image: (value: ImageBlock) => T;
+        document: (value: DocumentBlock) => T;
         toolUse: (value: ToolUseBlock) => T;
         toolResult: (value: ToolResultBlock) => T;
+        guardContent: (value: GuardrailConverseContentBlock) => T;
         _: (name: string, value: any) => T;
     }
     const visit: <T>(value: ContentBlock, visitor: Visitor<T>) => T;
@@ -412,8 +528,7 @@ export declare const ConversationRole: {
  */
 export type ConversationRole = (typeof ConversationRole)[keyof typeof ConversationRole];
 /**
- * <p>A message in the <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_Message.html">Message</a> field. Use to send a message in a call to
- *          <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_Converse.html">Converse</a>. </p>
+ * <p>A message input, or returned from, a call to <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_Converse.html">Converse</a> or <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_ConverseStream.html">ConverseStream</a>.</p>
  * @public
  */
 export interface Message {
@@ -429,10 +544,10 @@ export interface Message {
     content: ContentBlock[] | undefined;
 }
 /**
- * <p>A system content block</p>
+ * <p>A system content block.</p>
  * @public
  */
-export type SystemContentBlock = SystemContentBlock.TextMember | SystemContentBlock.$UnknownMember;
+export type SystemContentBlock = SystemContentBlock.GuardContentMember | SystemContentBlock.TextMember | SystemContentBlock.$UnknownMember;
 /**
  * @public
  */
@@ -443,6 +558,18 @@ export declare namespace SystemContentBlock {
      */
     interface TextMember {
         text: string;
+        guardContent?: never;
+        $unknown?: never;
+    }
+    /**
+     * <p>A content block to assess with the guardrail. Use with the Converse API (<a>Converse</a> and <a>ConverseStream</a>). </p>
+     *          <p>For more information, see <i>Use a guardrail with the Converse
+     *             API</i> in the <i>Amazon Bedrock User Guide</i>.</p>
+     * @public
+     */
+    interface GuardContentMember {
+        text?: never;
+        guardContent: GuardrailConverseContentBlock;
         $unknown?: never;
     }
     /**
@@ -450,28 +577,31 @@ export declare namespace SystemContentBlock {
      */
     interface $UnknownMember {
         text?: never;
+        guardContent?: never;
         $unknown: [string, any];
     }
     interface Visitor<T> {
         text: (value: string) => T;
+        guardContent: (value: GuardrailConverseContentBlock) => T;
         _: (name: string, value: any) => T;
     }
     const visit: <T>(value: SystemContentBlock, visitor: Visitor<T>) => T;
 }
 /**
- * <p>The model must request at least one tool (no text is generated).</p>
+ * <p>The model must request at least one tool (no text is generated). For example, <code>\{"any" : \{\}\}</code>.</p>
  * @public
  */
 export interface AnyToolChoice {
 }
 /**
- * <p>The Model automatically decides if a tool should be called or to whether to generate text instead.</p>
+ * <p>The Model automatically decides if a tool should be called or whether to generate text instead.
+ *          For example, <code>\{"auto" : \{\}\}</code>.</p>
  * @public
  */
 export interface AutoToolChoice {
 }
 /**
- * <p>The model must request a specific tool.</p>
+ * <p>The model must request a specific tool.  For example, <code>\{"tool" : \{"name" : "Your tool name"\}\}</code>.</p>
  *          <note>
  *             <p>This field is only supported by Anthropic Claude 3 models.</p>
  *          </note>
@@ -485,7 +615,9 @@ export interface SpecificToolChoice {
     name: string | undefined;
 }
 /**
- * <p>Forces a model to use a tool.</p>
+ * <p>Determines which tools the model should request in a call to <code>Converse</code> or <code>ConverseStream</code>.
+ *          <code>ToolChoice</code> is only supported by
+ *       Anthropic Claude 3 models and by Mistral AI Mistral Large.</p>
  * @public
  */
 export type ToolChoice = ToolChoice.AnyMember | ToolChoice.AutoMember | ToolChoice.ToolMember | ToolChoice.$UnknownMember;
@@ -494,7 +626,7 @@ export type ToolChoice = ToolChoice.AnyMember | ToolChoice.AutoMember | ToolChoi
  */
 export declare namespace ToolChoice {
     /**
-     * <p>The Model automatically decides if a tool should be called or to whether to generate text instead.</p>
+     * <p>(Default). The Model automatically decides if a tool should be called or whether to generate text instead. </p>
      * @public
      */
     interface AutoMember {
@@ -514,7 +646,7 @@ export declare namespace ToolChoice {
         $unknown?: never;
     }
     /**
-     * <p>The Model must request the specified tool.</p>
+     * <p>The Model must request the specified tool.  Only supported by Anthropic Claude 3 models. </p>
      * @public
      */
     interface ToolMember {
@@ -686,6 +818,11 @@ export interface ConverseRequest {
      * @public
      */
     toolConfig?: ToolConfiguration;
+    /**
+     * <p>Configuration information for a guardrail that you want to use in the request. </p>
+     * @public
+     */
+    guardrailConfig?: GuardrailConfiguration;
     /**
      * <p>Additional inference parameters that the model supports, beyond the
      *          base set of inference parameters that <code>Converse</code> supports in the <code>inferenceConfig</code>
@@ -696,7 +833,7 @@ export interface ConverseRequest {
     /**
      * <p>Additional model parameters field paths to return in the
      *          response. <code>Converse</code> returns the requested fields as a JSON Pointer object in the
-     *          <code>additionalModelResultFields</code> field. The following is example JSON for <code>additionalModelResponseFieldPaths</code>.</p>
+     *          <code>additionalModelResponseFields</code> field. The following is example JSON for <code>additionalModelResponseFieldPaths</code>.</p>
      *          <p>
      *             <code>[
      *          "/stop_sequence"
@@ -761,6 +898,7 @@ export declare namespace ConverseOutput {
 export declare const StopReason: {
     readonly CONTENT_FILTERED: "content_filtered";
     readonly END_TURN: "end_turn";
+    readonly GUARDRAIL_INTERVENED: "guardrail_intervened";
     readonly MAX_TOKENS: "max_tokens";
     readonly STOP_SEQUENCE: "stop_sequence";
     readonly TOOL_USE: "tool_use";
@@ -769,6 +907,382 @@ export declare const StopReason: {
  * @public
  */
 export type StopReason = (typeof StopReason)[keyof typeof StopReason];
+/**
+ * @public
+ * @enum
+ */
+export declare const GuardrailContentPolicyAction: {
+    readonly BLOCKED: "BLOCKED";
+};
+/**
+ * @public
+ */
+export type GuardrailContentPolicyAction = (typeof GuardrailContentPolicyAction)[keyof typeof GuardrailContentPolicyAction];
+/**
+ * @public
+ * @enum
+ */
+export declare const GuardrailContentFilterConfidence: {
+    readonly HIGH: "HIGH";
+    readonly LOW: "LOW";
+    readonly MEDIUM: "MEDIUM";
+    readonly NONE: "NONE";
+};
+/**
+ * @public
+ */
+export type GuardrailContentFilterConfidence = (typeof GuardrailContentFilterConfidence)[keyof typeof GuardrailContentFilterConfidence];
+/**
+ * @public
+ * @enum
+ */
+export declare const GuardrailContentFilterType: {
+    readonly HATE: "HATE";
+    readonly INSULTS: "INSULTS";
+    readonly MISCONDUCT: "MISCONDUCT";
+    readonly PROMPT_ATTACK: "PROMPT_ATTACK";
+    readonly SEXUAL: "SEXUAL";
+    readonly VIOLENCE: "VIOLENCE";
+};
+/**
+ * @public
+ */
+export type GuardrailContentFilterType = (typeof GuardrailContentFilterType)[keyof typeof GuardrailContentFilterType];
+/**
+ * <p>The content filter for a guardrail.</p>
+ * @public
+ */
+export interface GuardrailContentFilter {
+    /**
+     * <p>The guardrail type.</p>
+     * @public
+     */
+    type: GuardrailContentFilterType | undefined;
+    /**
+     * <p>The guardrail confidence.</p>
+     * @public
+     */
+    confidence: GuardrailContentFilterConfidence | undefined;
+    /**
+     * <p>The guardrail action.</p>
+     * @public
+     */
+    action: GuardrailContentPolicyAction | undefined;
+}
+/**
+ * <p>An assessment of a content policy for a guardrail.</p>
+ * @public
+ */
+export interface GuardrailContentPolicyAssessment {
+    /**
+     * <p>The content policy filters.</p>
+     * @public
+     */
+    filters: GuardrailContentFilter[] | undefined;
+}
+/**
+ * @public
+ * @enum
+ */
+export declare const GuardrailSensitiveInformationPolicyAction: {
+    readonly ANONYMIZED: "ANONYMIZED";
+    readonly BLOCKED: "BLOCKED";
+};
+/**
+ * @public
+ */
+export type GuardrailSensitiveInformationPolicyAction = (typeof GuardrailSensitiveInformationPolicyAction)[keyof typeof GuardrailSensitiveInformationPolicyAction];
+/**
+ * @public
+ * @enum
+ */
+export declare const GuardrailPiiEntityType: {
+    readonly ADDRESS: "ADDRESS";
+    readonly AGE: "AGE";
+    readonly AWS_ACCESS_KEY: "AWS_ACCESS_KEY";
+    readonly AWS_SECRET_KEY: "AWS_SECRET_KEY";
+    readonly CA_HEALTH_NUMBER: "CA_HEALTH_NUMBER";
+    readonly CA_SOCIAL_INSURANCE_NUMBER: "CA_SOCIAL_INSURANCE_NUMBER";
+    readonly CREDIT_DEBIT_CARD_CVV: "CREDIT_DEBIT_CARD_CVV";
+    readonly CREDIT_DEBIT_CARD_EXPIRY: "CREDIT_DEBIT_CARD_EXPIRY";
+    readonly CREDIT_DEBIT_CARD_NUMBER: "CREDIT_DEBIT_CARD_NUMBER";
+    readonly DRIVER_ID: "DRIVER_ID";
+    readonly EMAIL: "EMAIL";
+    readonly INTERNATIONAL_BANK_ACCOUNT_NUMBER: "INTERNATIONAL_BANK_ACCOUNT_NUMBER";
+    readonly IP_ADDRESS: "IP_ADDRESS";
+    readonly LICENSE_PLATE: "LICENSE_PLATE";
+    readonly MAC_ADDRESS: "MAC_ADDRESS";
+    readonly NAME: "NAME";
+    readonly PASSWORD: "PASSWORD";
+    readonly PHONE: "PHONE";
+    readonly PIN: "PIN";
+    readonly SWIFT_CODE: "SWIFT_CODE";
+    readonly UK_NATIONAL_HEALTH_SERVICE_NUMBER: "UK_NATIONAL_HEALTH_SERVICE_NUMBER";
+    readonly UK_NATIONAL_INSURANCE_NUMBER: "UK_NATIONAL_INSURANCE_NUMBER";
+    readonly UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER: "UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER";
+    readonly URL: "URL";
+    readonly USERNAME: "USERNAME";
+    readonly US_BANK_ACCOUNT_NUMBER: "US_BANK_ACCOUNT_NUMBER";
+    readonly US_BANK_ROUTING_NUMBER: "US_BANK_ROUTING_NUMBER";
+    readonly US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER: "US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER";
+    readonly US_PASSPORT_NUMBER: "US_PASSPORT_NUMBER";
+    readonly US_SOCIAL_SECURITY_NUMBER: "US_SOCIAL_SECURITY_NUMBER";
+    readonly VEHICLE_IDENTIFICATION_NUMBER: "VEHICLE_IDENTIFICATION_NUMBER";
+};
+/**
+ * @public
+ */
+export type GuardrailPiiEntityType = (typeof GuardrailPiiEntityType)[keyof typeof GuardrailPiiEntityType];
+/**
+ * <p>A Personally Identifiable Information (PII) entity configured in a guardrail.</p>
+ * @public
+ */
+export interface GuardrailPiiEntityFilter {
+    /**
+     * <p>The PII entity filter match.</p>
+     * @public
+     */
+    match: string | undefined;
+    /**
+     * <p>The PII entity filter type.</p>
+     * @public
+     */
+    type: GuardrailPiiEntityType | undefined;
+    /**
+     * <p>The PII entity filter action.</p>
+     * @public
+     */
+    action: GuardrailSensitiveInformationPolicyAction | undefined;
+}
+/**
+ * <p>A Regex filter configured in a guardrail.</p>
+ * @public
+ */
+export interface GuardrailRegexFilter {
+    /**
+     * <p>The regex filter name.</p>
+     * @public
+     */
+    name?: string;
+    /**
+     * <p>The regesx filter match.</p>
+     * @public
+     */
+    match?: string;
+    /**
+     * <p>The regex query.</p>
+     * @public
+     */
+    regex?: string;
+    /**
+     * <p>The region filter action.</p>
+     * @public
+     */
+    action: GuardrailSensitiveInformationPolicyAction | undefined;
+}
+/**
+ * <p>The assessment for aPersonally Identifiable Information (PII) policy. </p>
+ * @public
+ */
+export interface GuardrailSensitiveInformationPolicyAssessment {
+    /**
+     * <p>The PII entities in the assessment.</p>
+     * @public
+     */
+    piiEntities: GuardrailPiiEntityFilter[] | undefined;
+    /**
+     * <p>The regex queries in the assessment.</p>
+     * @public
+     */
+    regexes: GuardrailRegexFilter[] | undefined;
+}
+/**
+ * @public
+ * @enum
+ */
+export declare const GuardrailTopicPolicyAction: {
+    readonly BLOCKED: "BLOCKED";
+};
+/**
+ * @public
+ */
+export type GuardrailTopicPolicyAction = (typeof GuardrailTopicPolicyAction)[keyof typeof GuardrailTopicPolicyAction];
+/**
+ * @public
+ * @enum
+ */
+export declare const GuardrailTopicType: {
+    readonly DENY: "DENY";
+};
+/**
+ * @public
+ */
+export type GuardrailTopicType = (typeof GuardrailTopicType)[keyof typeof GuardrailTopicType];
+/**
+ * <p>Information about a topic guardrail.</p>
+ * @public
+ */
+export interface GuardrailTopic {
+    /**
+     * <p>The name for the guardrail.</p>
+     * @public
+     */
+    name: string | undefined;
+    /**
+     * <p>The type behavior that the guardrail should perform when the model detects the topic.</p>
+     * @public
+     */
+    type: GuardrailTopicType | undefined;
+    /**
+     * <p>The action the guardrail should take when it intervenes on a topic.</p>
+     * @public
+     */
+    action: GuardrailTopicPolicyAction | undefined;
+}
+/**
+ * <p>A behavior assessment of a topic policy.</p>
+ * @public
+ */
+export interface GuardrailTopicPolicyAssessment {
+    /**
+     * <p>The topics in the assessment.</p>
+     * @public
+     */
+    topics: GuardrailTopic[] | undefined;
+}
+/**
+ * @public
+ * @enum
+ */
+export declare const GuardrailWordPolicyAction: {
+    readonly BLOCKED: "BLOCKED";
+};
+/**
+ * @public
+ */
+export type GuardrailWordPolicyAction = (typeof GuardrailWordPolicyAction)[keyof typeof GuardrailWordPolicyAction];
+/**
+ * <p>A custom word configured in a guardrail.</p>
+ * @public
+ */
+export interface GuardrailCustomWord {
+    /**
+     * <p>The match for the custom word.</p>
+     * @public
+     */
+    match: string | undefined;
+    /**
+     * <p>The action for the custom word.</p>
+     * @public
+     */
+    action: GuardrailWordPolicyAction | undefined;
+}
+/**
+ * @public
+ * @enum
+ */
+export declare const GuardrailManagedWordType: {
+    readonly PROFANITY: "PROFANITY";
+};
+/**
+ * @public
+ */
+export type GuardrailManagedWordType = (typeof GuardrailManagedWordType)[keyof typeof GuardrailManagedWordType];
+/**
+ * <p>A managed word configured in a guardrail.</p>
+ * @public
+ */
+export interface GuardrailManagedWord {
+    /**
+     * <p>The match for the managed word.</p>
+     * @public
+     */
+    match: string | undefined;
+    /**
+     * <p>The type for the managed word.</p>
+     * @public
+     */
+    type: GuardrailManagedWordType | undefined;
+    /**
+     * <p>The action for the managed word.</p>
+     * @public
+     */
+    action: GuardrailWordPolicyAction | undefined;
+}
+/**
+ * <p>The word policy assessment.</p>
+ * @public
+ */
+export interface GuardrailWordPolicyAssessment {
+    /**
+     * <p>Custom words in the assessment.</p>
+     * @public
+     */
+    customWords: GuardrailCustomWord[] | undefined;
+    /**
+     * <p>Managed word lists in the assessment.</p>
+     * @public
+     */
+    managedWordLists: GuardrailManagedWord[] | undefined;
+}
+/**
+ * <p>A behavior assessment of the guardrail policies used in a call to the Converse API. </p>
+ * @public
+ */
+export interface GuardrailAssessment {
+    /**
+     * <p>The topic policy.</p>
+     * @public
+     */
+    topicPolicy?: GuardrailTopicPolicyAssessment;
+    /**
+     * <p>The content policy.</p>
+     * @public
+     */
+    contentPolicy?: GuardrailContentPolicyAssessment;
+    /**
+     * <p>The word policy.</p>
+     * @public
+     */
+    wordPolicy?: GuardrailWordPolicyAssessment;
+    /**
+     * <p>The sensitive information policy.</p>
+     * @public
+     */
+    sensitiveInformationPolicy?: GuardrailSensitiveInformationPolicyAssessment;
+}
+/**
+ * <p>A Top level guardrail trace object. For more information, see <a>ConverseTrace</a>.</p>
+ * @public
+ */
+export interface GuardrailTraceAssessment {
+    /**
+     * <p>The output from the model.</p>
+     * @public
+     */
+    modelOutput?: string[];
+    /**
+     * <p>The input assessment.</p>
+     * @public
+     */
+    inputAssessment?: Record<string, GuardrailAssessment>;
+    /**
+     * <p>the output assessments.</p>
+     * @public
+     */
+    outputAssessments?: Record<string, GuardrailAssessment[]>;
+}
+/**
+ * <p>The trace object in a response from <a>Converse</a>. Currently, you can only trace guardrails.</p>
+ * @public
+ */
+export interface ConverseTrace {
+    /**
+     * <p>The guardrail trace object. </p>
+     * @public
+     */
+    guardrail?: GuardrailTraceAssessment;
+}
 /**
  * <p>The tokens used in a message API inference call. </p>
  * @public
@@ -820,6 +1334,11 @@ export interface ConverseResponse {
      * @public
      */
     additionalModelResponseFields?: __DocumentType;
+    /**
+     * <p>A trace object that contains information about the Guardrail behavior.</p>
+     * @public
+     */
+    trace?: ConverseTrace;
 }
 /**
  * <p>An internal server error occurred. Retry your request.</p>
@@ -915,6 +1434,47 @@ export declare class ValidationException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
 }
+/**
+ * @public
+ * @enum
+ */
+export declare const GuardrailStreamProcessingMode: {
+    readonly ASYNC: "async";
+    readonly SYNC: "sync";
+};
+/**
+ * @public
+ */
+export type GuardrailStreamProcessingMode = (typeof GuardrailStreamProcessingMode)[keyof typeof GuardrailStreamProcessingMode];
+/**
+ * <p>Configuration information for a guardrail that you use with the <a>ConverseStream</a> action.
+ *             </p>
+ * @public
+ */
+export interface GuardrailStreamConfiguration {
+    /**
+     * <p>The identifier for the guardrail.</p>
+     * @public
+     */
+    guardrailIdentifier: string | undefined;
+    /**
+     * <p>The version of the guardrail.</p>
+     * @public
+     */
+    guardrailVersion: string | undefined;
+    /**
+     * <p>The trace behavior for the guardrail.</p>
+     * @public
+     */
+    trace?: GuardrailTrace;
+    /**
+     * <p>The processing mode. </p>
+     *          <p>The processing mode. For more information, see <i>Configure streaming response behavior</i> in the <i>Amazon Bedrock User Guide</i>.
+     *       </p>
+     * @public
+     */
+    streamProcessingMode?: GuardrailStreamProcessingMode;
+}
 /**
  * @public
  */
@@ -961,6 +1521,11 @@ export interface ConverseStreamRequest {
      * @public
      */
     toolConfig?: ToolConfiguration;
+    /**
+     * <p>Configuration information for a guardrail that you want to use in the request. </p>
+     * @public
+     */
+    guardrailConfig?: GuardrailStreamConfiguration;
     /**
      * <p>Additional inference parameters that the model supports, beyond the
      *          base set of inference parameters that <code>ConverseStream</code> supports in the <code>inferenceConfig</code>
@@ -971,7 +1536,7 @@ export interface ConverseStreamRequest {
     /**
      * <p>Additional model parameters field paths to return in the
      *          response. <code>ConverseStream</code> returns the requested fields as a JSON Pointer object in the
-     *          <code>additionalModelResultFields</code> field. The following is example JSON for <code>additionalModelResponseFieldPaths</code>.</p>
+     *          <code>additionalModelResponseFields</code> field. The following is example JSON for <code>additionalModelResponseFieldPaths</code>.</p>
      *          <p>
      *             <code>[
      *          "/stop_sequence"
@@ -1167,6 +1732,17 @@ export interface ConverseStreamMetrics {
      */
     latencyMs: number | undefined;
 }
+/**
+ * <p>The trace object in a response from <a>ConverseStream</a>. Currently, you can only trace guardrails.</p>
+ * @public
+ */
+export interface ConverseStreamTrace {
+    /**
+     * <p>The guardrail trace object. </p>
+     * @public
+     */
+    guardrail?: GuardrailTraceAssessment;
+}
 /**
  * <p>A conversation stream metadata event.</p>
  * @public
@@ -1182,6 +1758,11 @@ export interface ConverseStreamMetadataEvent {
      * @public
      */
     metrics: ConverseStreamMetrics | undefined;
+    /**
+     * <p>The trace object in the response from <a>ConverseStream</a> that contains information about the guardrail behavior.</p>
+     * @public
+     */
+    trace?: ConverseStreamTrace;
 }
 /**
  * <p>An error occurred while streaming the response. Retry your request.</p>
@@ -1442,12 +2023,12 @@ export type Trace = (typeof Trace)[keyof typeof Trace];
  */
 export interface InvokeModelRequest {
     /**
-     * <p>The prompt and inference parameters in the format specified in the <code>contentType</code> in the header. To see the format and content of the request and response bodies for different models, refer to <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html">Inference parameters</a>. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/api-methods-run.html">Run inference</a> in the Bedrock User Guide.</p>
+     * <p>The prompt and inference parameters in the format specified in the <code>contentType</code> 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 <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html">Inference parameters</a>. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/api-methods-run.html">Run inference</a> in the Bedrock User Guide.</p>
      * @public
      */
     body: Uint8Array | undefined;
     /**
-     * <p>The MIME type of the input data in the request. The default value is
+     * <p>The MIME type of the input data in the request. You must specify
      *             <code>application/json</code>.</p>
      * @public
      */
@@ -1535,12 +2116,12 @@ export declare class ServiceQuotaExceededException extends __BaseException {
  */
 export interface InvokeModelWithResponseStreamRequest {
     /**
-     * <p>The prompt and inference parameters in the format specified in the <code>contentType</code> in the header. To see the format and content of the request and response bodies for different models, refer to <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html">Inference parameters</a>. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/api-methods-run.html">Run inference</a> in the Bedrock User Guide.</p>
+     * <p>The prompt and inference parameters in the format specified in the <code>contentType</code> 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 <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html">Inference parameters</a>. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/api-methods-run.html">Run inference</a> in the Bedrock User Guide.</p>
      * @public
      */
     body: Uint8Array | undefined;
     /**
-     * <p>The MIME type of the input data in the request. The default value is
+     * <p>The MIME type of the input data in the request. You must specify
      *             <code>application/json</code>.</p>
      * @public
      */