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

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

@@ -8,12 +8,47 @@ export declare class AccessDeniedException extends __BaseException {
     opts: __ExceptionOptionType<AccessDeniedException, __BaseException>
   );
 }
+export declare const GuardrailTrace: {
+  readonly DISABLED: "disabled";
+  readonly ENABLED: "enabled";
+};
+export type GuardrailTrace =
+  (typeof GuardrailTrace)[keyof typeof GuardrailTrace];
+export interface GuardrailConfiguration {
+  guardrailIdentifier: string | undefined;
+  guardrailVersion: string | undefined;
+  trace?: GuardrailTrace;
+}
 export interface InferenceConfiguration {
   maxTokens?: number;
   temperature?: number;
   topP?: number;
   stopSequences?: string[];
 }
+export interface GuardrailConverseTextBlock {
+  text: string | undefined;
+}
+export type GuardrailConverseContentBlock =
+  | GuardrailConverseContentBlock.TextMember
+  | GuardrailConverseContentBlock.$UnknownMember;
+export declare namespace GuardrailConverseContentBlock {
+  interface TextMember {
+    text: GuardrailConverseTextBlock;
+    $unknown?: never;
+  }
+  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;
+}
 export declare const ImageFormat: {
   readonly GIF: "gif";
   readonly JPEG: "jpeg";
@@ -96,6 +131,7 @@ export interface ToolUseBlock {
   input: __DocumentType | undefined;
 }
 export type ContentBlock =
+  | ContentBlock.GuardContentMember
   | ContentBlock.ImageMember
   | ContentBlock.TextMember
   | ContentBlock.ToolResultMember
@@ -107,6 +143,7 @@ export declare namespace ContentBlock {
     image?: never;
     toolUse?: never;
     toolResult?: never;
+    guardContent?: never;
     $unknown?: never;
   }
   interface ImageMember {
@@ -114,6 +151,7 @@ export declare namespace ContentBlock {
     image: ImageBlock;
     toolUse?: never;
     toolResult?: never;
+    guardContent?: never;
     $unknown?: never;
   }
   interface ToolUseMember {
@@ -121,6 +159,7 @@ export declare namespace ContentBlock {
     image?: never;
     toolUse: ToolUseBlock;
     toolResult?: never;
+    guardContent?: never;
     $unknown?: never;
   }
   interface ToolResultMember {
@@ -128,6 +167,15 @@ export declare namespace ContentBlock {
     image?: never;
     toolUse?: never;
     toolResult: ToolResultBlock;
+    guardContent?: never;
+    $unknown?: never;
+  }
+  interface GuardContentMember {
+    text?: never;
+    image?: never;
+    toolUse?: never;
+    toolResult?: never;
+    guardContent: GuardrailConverseContentBlock;
     $unknown?: never;
   }
   interface $UnknownMember {
@@ -135,6 +183,7 @@ export declare namespace ContentBlock {
     image?: never;
     toolUse?: never;
     toolResult?: never;
+    guardContent?: never;
     $unknown: [string, any];
   }
   interface Visitor<T> {
@@ -142,6 +191,7 @@ export declare namespace ContentBlock {
     image: (value: ImageBlock) => 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;
@@ -157,19 +207,28 @@ export interface Message {
   content: ContentBlock[] | undefined;
 }
 export type SystemContentBlock =
+  | SystemContentBlock.GuardContentMember
   | SystemContentBlock.TextMember
   | SystemContentBlock.$UnknownMember;
 export declare namespace SystemContentBlock {
   interface TextMember {
     text: string;
+    guardContent?: never;
+    $unknown?: never;
+  }
+  interface GuardContentMember {
+    text?: never;
+    guardContent: GuardrailConverseContentBlock;
     $unknown?: never;
   }
   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;
@@ -266,6 +325,7 @@ export interface ConverseRequest {
   system?: SystemContentBlock[];
   inferenceConfig?: InferenceConfiguration;
   toolConfig?: ToolConfiguration;
+  guardrailConfig?: GuardrailConfiguration;
   additionalModelRequestFields?: __DocumentType;
   additionalModelResponseFieldPaths?: string[];
 }
@@ -293,11 +353,154 @@ 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";
 };
 export type StopReason = (typeof StopReason)[keyof typeof StopReason];
+export declare const GuardrailContentPolicyAction: {
+  readonly BLOCKED: "BLOCKED";
+};
+export type GuardrailContentPolicyAction =
+  (typeof GuardrailContentPolicyAction)[keyof typeof GuardrailContentPolicyAction];
+export declare const GuardrailContentFilterConfidence: {
+  readonly HIGH: "HIGH";
+  readonly LOW: "LOW";
+  readonly MEDIUM: "MEDIUM";
+  readonly NONE: "NONE";
+};
+export type GuardrailContentFilterConfidence =
+  (typeof GuardrailContentFilterConfidence)[keyof typeof GuardrailContentFilterConfidence];
+export declare const GuardrailContentFilterType: {
+  readonly HATE: "HATE";
+  readonly INSULTS: "INSULTS";
+  readonly MISCONDUCT: "MISCONDUCT";
+  readonly PROMPT_ATTACK: "PROMPT_ATTACK";
+  readonly SEXUAL: "SEXUAL";
+  readonly VIOLENCE: "VIOLENCE";
+};
+export type GuardrailContentFilterType =
+  (typeof GuardrailContentFilterType)[keyof typeof GuardrailContentFilterType];
+export interface GuardrailContentFilter {
+  type: GuardrailContentFilterType | undefined;
+  confidence: GuardrailContentFilterConfidence | undefined;
+  action: GuardrailContentPolicyAction | undefined;
+}
+export interface GuardrailContentPolicyAssessment {
+  filters: GuardrailContentFilter[] | undefined;
+}
+export declare const GuardrailSensitiveInformationPolicyAction: {
+  readonly ANONYMIZED: "ANONYMIZED";
+  readonly BLOCKED: "BLOCKED";
+};
+export type GuardrailSensitiveInformationPolicyAction =
+  (typeof GuardrailSensitiveInformationPolicyAction)[keyof typeof GuardrailSensitiveInformationPolicyAction];
+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";
+};
+export type GuardrailPiiEntityType =
+  (typeof GuardrailPiiEntityType)[keyof typeof GuardrailPiiEntityType];
+export interface GuardrailPiiEntityFilter {
+  match: string | undefined;
+  type: GuardrailPiiEntityType | undefined;
+  action: GuardrailSensitiveInformationPolicyAction | undefined;
+}
+export interface GuardrailRegexFilter {
+  name?: string;
+  match?: string;
+  regex?: string;
+  action: GuardrailSensitiveInformationPolicyAction | undefined;
+}
+export interface GuardrailSensitiveInformationPolicyAssessment {
+  piiEntities: GuardrailPiiEntityFilter[] | undefined;
+  regexes: GuardrailRegexFilter[] | undefined;
+}
+export declare const GuardrailTopicPolicyAction: {
+  readonly BLOCKED: "BLOCKED";
+};
+export type GuardrailTopicPolicyAction =
+  (typeof GuardrailTopicPolicyAction)[keyof typeof GuardrailTopicPolicyAction];
+export declare const GuardrailTopicType: {
+  readonly DENY: "DENY";
+};
+export type GuardrailTopicType =
+  (typeof GuardrailTopicType)[keyof typeof GuardrailTopicType];
+export interface GuardrailTopic {
+  name: string | undefined;
+  type: GuardrailTopicType | undefined;
+  action: GuardrailTopicPolicyAction | undefined;
+}
+export interface GuardrailTopicPolicyAssessment {
+  topics: GuardrailTopic[] | undefined;
+}
+export declare const GuardrailWordPolicyAction: {
+  readonly BLOCKED: "BLOCKED";
+};
+export type GuardrailWordPolicyAction =
+  (typeof GuardrailWordPolicyAction)[keyof typeof GuardrailWordPolicyAction];
+export interface GuardrailCustomWord {
+  match: string | undefined;
+  action: GuardrailWordPolicyAction | undefined;
+}
+export declare const GuardrailManagedWordType: {
+  readonly PROFANITY: "PROFANITY";
+};
+export type GuardrailManagedWordType =
+  (typeof GuardrailManagedWordType)[keyof typeof GuardrailManagedWordType];
+export interface GuardrailManagedWord {
+  match: string | undefined;
+  type: GuardrailManagedWordType | undefined;
+  action: GuardrailWordPolicyAction | undefined;
+}
+export interface GuardrailWordPolicyAssessment {
+  customWords: GuardrailCustomWord[] | undefined;
+  managedWordLists: GuardrailManagedWord[] | undefined;
+}
+export interface GuardrailAssessment {
+  topicPolicy?: GuardrailTopicPolicyAssessment;
+  contentPolicy?: GuardrailContentPolicyAssessment;
+  wordPolicy?: GuardrailWordPolicyAssessment;
+  sensitiveInformationPolicy?: GuardrailSensitiveInformationPolicyAssessment;
+}
+export interface GuardrailTraceAssessment {
+  modelOutput?: string[];
+  inputAssessment?: Record<string, GuardrailAssessment>;
+  outputAssessments?: Record<string, GuardrailAssessment[]>;
+}
+export interface ConverseTrace {
+  guardrail?: GuardrailTraceAssessment;
+}
 export interface TokenUsage {
   inputTokens: number | undefined;
   outputTokens: number | undefined;
@@ -309,6 +512,7 @@ export interface ConverseResponse {
   usage: TokenUsage | undefined;
   metrics: ConverseMetrics | undefined;
   additionalModelResponseFields?: __DocumentType;
+  trace?: ConverseTrace;
 }
 export declare class InternalServerException extends __BaseException {
   readonly name: "InternalServerException";
@@ -361,12 +565,25 @@ export declare class ValidationException extends __BaseException {
     opts: __ExceptionOptionType<ValidationException, __BaseException>
   );
 }
+export declare const GuardrailStreamProcessingMode: {
+  readonly ASYNC: "async";
+  readonly SYNC: "sync";
+};
+export type GuardrailStreamProcessingMode =
+  (typeof GuardrailStreamProcessingMode)[keyof typeof GuardrailStreamProcessingMode];
+export interface GuardrailStreamConfiguration {
+  guardrailIdentifier: string | undefined;
+  guardrailVersion: string | undefined;
+  trace?: GuardrailTrace;
+  streamProcessingMode?: GuardrailStreamProcessingMode;
+}
 export interface ConverseStreamRequest {
   modelId: string | undefined;
   messages: Message[] | undefined;
   system?: SystemContentBlock[];
   inferenceConfig?: InferenceConfiguration;
   toolConfig?: ToolConfiguration;
+  guardrailConfig?: GuardrailStreamConfiguration;
   additionalModelRequestFields?: __DocumentType;
   additionalModelResponseFieldPaths?: string[];
 }
@@ -443,9 +660,13 @@ export interface MessageStopEvent {
 export interface ConverseStreamMetrics {
   latencyMs: number | undefined;
 }
+export interface ConverseStreamTrace {
+  guardrail?: GuardrailTraceAssessment;
+}
 export interface ConverseStreamMetadataEvent {
   usage: TokenUsage | undefined;
   metrics: ConverseStreamMetrics | undefined;
+  trace?: ConverseStreamTrace;
 }
 export declare class ModelStreamErrorException extends __BaseException {
   readonly name: "ModelStreamErrorException";

package/package.json

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