@aws-sdk/client-bedrock-runtime 3.662.0 → 3.663.0

package/dist-cjs/index.js

@@ -41,6 +41,7 @@ __export(src_exports, {
   GuardrailAction: () => GuardrailAction,
   GuardrailContentBlock: () => GuardrailContentBlock,
   GuardrailContentFilterConfidence: () => GuardrailContentFilterConfidence,
+  GuardrailContentFilterStrength: () => GuardrailContentFilterStrength,
   GuardrailContentFilterType: () => GuardrailContentFilterType,
   GuardrailContentPolicyAction: () => GuardrailContentPolicyAction,
   GuardrailContentQualifier: () => GuardrailContentQualifier,
@@ -305,6 +306,12 @@ var GuardrailContentFilterConfidence = {
   MEDIUM: "MEDIUM",
   NONE: "NONE"
 };
+var GuardrailContentFilterStrength = {
+  HIGH: "HIGH",
+  LOW: "LOW",
+  MEDIUM: "MEDIUM",
+  NONE: "NONE"
+};
 var GuardrailContentFilterType = {
   HATE: "HATE",
   INSULTS: "INSULTS",
@@ -942,6 +949,7 @@ var de_ApplyGuardrailCommand = /* @__PURE__ */ __name(async (output, context) =>
   const doc = (0, import_smithy_client.take)(data, {
     action: import_smithy_client.expectString,
     assessments: (_) => de_GuardrailAssessmentList(_, context),
+    guardrailCoverage: import_smithy_client._json,
     outputs: import_smithy_client._json,
     usage: import_smithy_client._json
   });
@@ -1597,6 +1605,7 @@ var de_GuardrailAssessment = /* @__PURE__ */ __name((output, context) => {
   return (0, import_smithy_client.take)(output, {
     contentPolicy: import_smithy_client._json,
     contextualGroundingPolicy: (_) => de_GuardrailContextualGroundingPolicyAssessment(_, context),
+    invocationMetrics: import_smithy_client._json,
     sensitiveInformationPolicy: import_smithy_client._json,
     topicPolicy: import_smithy_client._json,
     wordPolicy: import_smithy_client._json
@@ -1859,6 +1868,7 @@ var BedrockRuntime = _BedrockRuntime;
   GuardrailAction,
   GuardrailContentPolicyAction,
   GuardrailContentFilterConfidence,
+  GuardrailContentFilterStrength,
   GuardrailContentFilterType,
   GuardrailContextualGroundingPolicyAction,
   GuardrailContextualGroundingFilterType,

package/dist-es/models/models_0.js

@@ -42,6 +42,12 @@ export const GuardrailContentFilterConfidence = {
     MEDIUM: "MEDIUM",
     NONE: "NONE",
 };
+export const GuardrailContentFilterStrength = {
+    HIGH: "HIGH",
+    LOW: "LOW",
+    MEDIUM: "MEDIUM",
+    NONE: "NONE",
+};
 export const GuardrailContentFilterType = {
     HATE: "HATE",
     INSULTS: "INSULTS",

package/dist-es/protocols/Aws_restJson1.js

@@ -106,6 +106,7 @@ export const de_ApplyGuardrailCommand = async (output, context) => {
     const doc = take(data, {
         action: __expectString,
         assessments: (_) => de_GuardrailAssessmentList(_, context),
+        guardrailCoverage: _json,
         outputs: _json,
         usage: _json,
     });
@@ -759,6 +760,7 @@ const de_GuardrailAssessment = (output, context) => {
     return take(output, {
         contentPolicy: _json,
         contextualGroundingPolicy: (_) => de_GuardrailContextualGroundingPolicyAssessment(_, context),
+        invocationMetrics: _json,
         sensitiveInformationPolicy: _json,
         topicPolicy: _json,
         wordPolicy: _json,

package/dist-types/commands/ApplyGuardrailCommand.d.ts

@@ -82,6 +82,7 @@ declare const ApplyGuardrailCommand_base: {
  * //           { // GuardrailContentFilter
  * //             type: "INSULTS" || "HATE" || "SEXUAL" || "VIOLENCE" || "MISCONDUCT" || "PROMPT_ATTACK", // required
  * //             confidence: "NONE" || "LOW" || "MEDIUM" || "HIGH", // required
+ * //             filterStrength: "NONE" || "LOW" || "MEDIUM" || "HIGH",
  * //             action: "BLOCKED", // required
  * //           },
  * //         ],
@@ -128,8 +129,31 @@ declare const ApplyGuardrailCommand_base: {
  * //           },
  * //         ],
  * //       },
+ * //       invocationMetrics: { // GuardrailInvocationMetrics
+ * //         guardrailProcessingLatency: Number("long"),
+ * //         usage: {
+ * //           topicPolicyUnits: Number("int"), // required
+ * //           contentPolicyUnits: Number("int"), // required
+ * //           wordPolicyUnits: Number("int"), // required
+ * //           sensitiveInformationPolicyUnits: Number("int"), // required
+ * //           sensitiveInformationPolicyFreeUnits: Number("int"), // required
+ * //           contextualGroundingPolicyUnits: Number("int"), // required
+ * //         },
+ * //         guardrailCoverage: { // GuardrailCoverage
+ * //           textCharacters: { // GuardrailTextCharactersCoverage
+ * //             guarded: Number("int"),
+ * //             total: Number("int"),
+ * //           },
+ * //         },
+ * //       },
  * //     },
  * //   ],
+ * //   guardrailCoverage: {
+ * //     textCharacters: {
+ * //       guarded: Number("int"),
+ * //       total: Number("int"),
+ * //     },
+ * //   },
  * // };
  *
  * ```

package/dist-types/commands/ConverseCommand.d.ts

@@ -251,6 +251,7 @@ declare const ConverseCommand_base: {
  * //               { // GuardrailContentFilter
  * //                 type: "INSULTS" || "HATE" || "SEXUAL" || "VIOLENCE" || "MISCONDUCT" || "PROMPT_ATTACK", // required
  * //                 confidence: "NONE" || "LOW" || "MEDIUM" || "HIGH", // required
+ * //                 filterStrength: "NONE" || "LOW" || "MEDIUM" || "HIGH",
  * //                 action: "BLOCKED", // required
  * //               },
  * //             ],
@@ -297,6 +298,23 @@ declare const ConverseCommand_base: {
  * //               },
  * //             ],
  * //           },
+ * //           invocationMetrics: { // GuardrailInvocationMetrics
+ * //             guardrailProcessingLatency: Number("long"),
+ * //             usage: { // GuardrailUsage
+ * //               topicPolicyUnits: Number("int"), // required
+ * //               contentPolicyUnits: Number("int"), // required
+ * //               wordPolicyUnits: Number("int"), // required
+ * //               sensitiveInformationPolicyUnits: Number("int"), // required
+ * //               sensitiveInformationPolicyFreeUnits: Number("int"), // required
+ * //               contextualGroundingPolicyUnits: Number("int"), // required
+ * //             },
+ * //             guardrailCoverage: { // GuardrailCoverage
+ * //               textCharacters: { // GuardrailTextCharactersCoverage
+ * //                 guarded: Number("int"),
+ * //                 total: Number("int"),
+ * //               },
+ * //             },
+ * //           },
  * //         },
  * //       },
  * //       outputAssessments: { // GuardrailAssessmentListMap
@@ -316,6 +334,7 @@ declare const ConverseCommand_base: {
  * //                 {
  * //                   type: "INSULTS" || "HATE" || "SEXUAL" || "VIOLENCE" || "MISCONDUCT" || "PROMPT_ATTACK", // required
  * //                   confidence: "NONE" || "LOW" || "MEDIUM" || "HIGH", // required
+ * //                   filterStrength: "NONE" || "LOW" || "MEDIUM" || "HIGH",
  * //                   action: "BLOCKED", // required
  * //                 },
  * //               ],
@@ -362,6 +381,23 @@ declare const ConverseCommand_base: {
  * //                 },
  * //               ],
  * //             },
+ * //             invocationMetrics: {
+ * //               guardrailProcessingLatency: Number("long"),
+ * //               usage: {
+ * //                 topicPolicyUnits: Number("int"), // required
+ * //                 contentPolicyUnits: Number("int"), // required
+ * //                 wordPolicyUnits: Number("int"), // required
+ * //                 sensitiveInformationPolicyUnits: Number("int"), // required
+ * //                 sensitiveInformationPolicyFreeUnits: Number("int"), // required
+ * //                 contextualGroundingPolicyUnits: Number("int"), // required
+ * //               },
+ * //               guardrailCoverage: {
+ * //                 textCharacters: {
+ * //                   guarded: Number("int"),
+ * //                   total: Number("int"),
+ * //                 },
+ * //               },
+ * //             },
  * //           },
  * //         ],
  * //       },

package/dist-types/commands/ConverseStreamCommand.d.ts

@@ -227,6 +227,7 @@ declare const ConverseStreamCommand_base: {
  * //                   { // GuardrailContentFilter
  * //                     type: "INSULTS" || "HATE" || "SEXUAL" || "VIOLENCE" || "MISCONDUCT" || "PROMPT_ATTACK", // required
  * //                     confidence: "NONE" || "LOW" || "MEDIUM" || "HIGH", // required
+ * //                     filterStrength: "NONE" || "LOW" || "MEDIUM" || "HIGH",
  * //                     action: "BLOCKED", // required
  * //                   },
  * //                 ],
@@ -273,6 +274,23 @@ declare const ConverseStreamCommand_base: {
  * //                   },
  * //                 ],
  * //               },
+ * //               invocationMetrics: { // GuardrailInvocationMetrics
+ * //                 guardrailProcessingLatency: Number("long"),
+ * //                 usage: { // GuardrailUsage
+ * //                   topicPolicyUnits: Number("int"), // required
+ * //                   contentPolicyUnits: Number("int"), // required
+ * //                   wordPolicyUnits: Number("int"), // required
+ * //                   sensitiveInformationPolicyUnits: Number("int"), // required
+ * //                   sensitiveInformationPolicyFreeUnits: Number("int"), // required
+ * //                   contextualGroundingPolicyUnits: Number("int"), // required
+ * //                 },
+ * //                 guardrailCoverage: { // GuardrailCoverage
+ * //                   textCharacters: { // GuardrailTextCharactersCoverage
+ * //                     guarded: Number("int"),
+ * //                     total: Number("int"),
+ * //                   },
+ * //                 },
+ * //               },
  * //             },
  * //           },
  * //           outputAssessments: { // GuardrailAssessmentListMap
@@ -292,6 +310,7 @@ declare const ConverseStreamCommand_base: {
  * //                     {
  * //                       type: "INSULTS" || "HATE" || "SEXUAL" || "VIOLENCE" || "MISCONDUCT" || "PROMPT_ATTACK", // required
  * //                       confidence: "NONE" || "LOW" || "MEDIUM" || "HIGH", // required
+ * //                       filterStrength: "NONE" || "LOW" || "MEDIUM" || "HIGH",
  * //                       action: "BLOCKED", // required
  * //                     },
  * //                   ],
@@ -338,6 +357,23 @@ declare const ConverseStreamCommand_base: {
  * //                     },
  * //                   ],
  * //                 },
+ * //                 invocationMetrics: {
+ * //                   guardrailProcessingLatency: Number("long"),
+ * //                   usage: {
+ * //                     topicPolicyUnits: Number("int"), // required
+ * //                     contentPolicyUnits: Number("int"), // required
+ * //                     wordPolicyUnits: Number("int"), // required
+ * //                     sensitiveInformationPolicyUnits: Number("int"), // required
+ * //                     sensitiveInformationPolicyFreeUnits: Number("int"), // required
+ * //                     contextualGroundingPolicyUnits: Number("int"), // required
+ * //                   },
+ * //                   guardrailCoverage: {
+ * //                     textCharacters: {
+ * //                       guarded: Number("int"),
+ * //                       total: Number("int"),
+ * //                     },
+ * //                   },
+ * //                 },
  * //               },
  * //             ],
  * //           },

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

@@ -146,6 +146,20 @@ export declare const GuardrailContentFilterConfidence: {
  * @public
  */
 export type GuardrailContentFilterConfidence = (typeof GuardrailContentFilterConfidence)[keyof typeof GuardrailContentFilterConfidence];
+/**
+ * @public
+ * @enum
+ */
+export declare const GuardrailContentFilterStrength: {
+    readonly HIGH: "HIGH";
+    readonly LOW: "LOW";
+    readonly MEDIUM: "MEDIUM";
+    readonly NONE: "NONE";
+};
+/**
+ * @public
+ */
+export type GuardrailContentFilterStrength = (typeof GuardrailContentFilterStrength)[keyof typeof GuardrailContentFilterStrength];
 /**
  * @public
  * @enum
@@ -177,6 +191,11 @@ export interface GuardrailContentFilter {
      * @public
      */
     confidence: GuardrailContentFilterConfidence | undefined;
+    /**
+     * <p>The filter strength setting for the guardrail content filter.</p>
+     * @public
+     */
+    filterStrength?: GuardrailContentFilterStrength;
     /**
      * <p>The guardrail action.</p>
      * @public
@@ -255,6 +274,90 @@ export interface GuardrailContextualGroundingPolicyAssessment {
      */
     filters?: GuardrailContextualGroundingFilter[];
 }
+/**
+ * <p>The guardrail coverage for the text characters.</p>
+ * @public
+ */
+export interface GuardrailTextCharactersCoverage {
+    /**
+     * <p>The text characters that were guarded by the guardrail coverage.</p>
+     * @public
+     */
+    guarded?: number;
+    /**
+     * <p>The total text characters by the guardrail coverage.</p>
+     * @public
+     */
+    total?: number;
+}
+/**
+ * <p>The action of the guardrail coverage details.</p>
+ * @public
+ */
+export interface GuardrailCoverage {
+    /**
+     * <p>The text characters of the guardrail coverage details.</p>
+     * @public
+     */
+    textCharacters?: GuardrailTextCharactersCoverage;
+}
+/**
+ * <p>The details on the use of the guardrail.</p>
+ * @public
+ */
+export interface GuardrailUsage {
+    /**
+     * <p>The topic policy units processed by the guardrail.</p>
+     * @public
+     */
+    topicPolicyUnits: number | undefined;
+    /**
+     * <p>The content policy units processed by the guardrail.</p>
+     * @public
+     */
+    contentPolicyUnits: number | undefined;
+    /**
+     * <p>The word policy units processed by the guardrail.</p>
+     * @public
+     */
+    wordPolicyUnits: number | undefined;
+    /**
+     * <p>The sensitive information policy units processed by the guardrail.</p>
+     * @public
+     */
+    sensitiveInformationPolicyUnits: number | undefined;
+    /**
+     * <p>The sensitive information policy free units processed by the guardrail.</p>
+     * @public
+     */
+    sensitiveInformationPolicyFreeUnits: number | undefined;
+    /**
+     * <p>The contextual grounding policy units processed by the guardrail.</p>
+     * @public
+     */
+    contextualGroundingPolicyUnits: number | undefined;
+}
+/**
+ * <p>The invocation metrics for the guardrail.</p>
+ * @public
+ */
+export interface GuardrailInvocationMetrics {
+    /**
+     * <p>The processing latency details for the guardrail invocation metrics.</p>
+     * @public
+     */
+    guardrailProcessingLatency?: number;
+    /**
+     * <p>The usage details for the guardrail invocation metrics.</p>
+     * @public
+     */
+    usage?: GuardrailUsage;
+    /**
+     * <p>The coverage details for the guardrail invocation metrics.</p>
+     * @public
+     */
+    guardrailCoverage?: GuardrailCoverage;
+}
 /**
  * @public
  * @enum
@@ -530,6 +633,11 @@ export interface GuardrailAssessment {
      * @public
      */
     contextualGroundingPolicy?: GuardrailContextualGroundingPolicyAssessment;
+    /**
+     * <p>The invocation metrics for the guardrail assessment.</p>
+     * @public
+     */
+    invocationMetrics?: GuardrailInvocationMetrics;
 }
 /**
  * <p>The output content produced by the guardrail.</p>
@@ -542,42 +650,6 @@ export interface GuardrailOutputContent {
      */
     text?: string;
 }
-/**
- * <p>The details on the use of the guardrail.</p>
- * @public
- */
-export interface GuardrailUsage {
-    /**
-     * <p>The topic policy units processed by the guardrail.</p>
-     * @public
-     */
-    topicPolicyUnits: number | undefined;
-    /**
-     * <p>The content policy units processed by the guardrail.</p>
-     * @public
-     */
-    contentPolicyUnits: number | undefined;
-    /**
-     * <p>The word policy units processed by the guardrail.</p>
-     * @public
-     */
-    wordPolicyUnits: number | undefined;
-    /**
-     * <p>The sensitive information policy units processed by the guardrail.</p>
-     * @public
-     */
-    sensitiveInformationPolicyUnits: number | undefined;
-    /**
-     * <p>The sensitive information policy free units processed by the guardrail.</p>
-     * @public
-     */
-    sensitiveInformationPolicyFreeUnits: number | undefined;
-    /**
-     * <p>The contextual grounding policy units processed by the guardrail.</p>
-     * @public
-     */
-    contextualGroundingPolicyUnits: number | undefined;
-}
 /**
  * @public
  */
@@ -602,6 +674,11 @@ export interface ApplyGuardrailResponse {
      * @public
      */
     assessments: GuardrailAssessment[] | undefined;
+    /**
+     * <p>The guardrail coverage details in the apply guardrail response.</p>
+     * @public
+     */
+    guardrailCoverage?: GuardrailCoverage;
 }
 /**
  * <p>An internal server error occurred. Retry your request.</p>

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

@@ -68,6 +68,14 @@ export declare const GuardrailContentFilterConfidence: {
 };
 export type GuardrailContentFilterConfidence =
   (typeof GuardrailContentFilterConfidence)[keyof typeof GuardrailContentFilterConfidence];
+export declare const GuardrailContentFilterStrength: {
+  readonly HIGH: "HIGH";
+  readonly LOW: "LOW";
+  readonly MEDIUM: "MEDIUM";
+  readonly NONE: "NONE";
+};
+export type GuardrailContentFilterStrength =
+  (typeof GuardrailContentFilterStrength)[keyof typeof GuardrailContentFilterStrength];
 export declare const GuardrailContentFilterType: {
   readonly HATE: "HATE";
   readonly INSULTS: "INSULTS";
@@ -81,6 +89,7 @@ export type GuardrailContentFilterType =
 export interface GuardrailContentFilter {
   type: GuardrailContentFilterType | undefined;
   confidence: GuardrailContentFilterConfidence | undefined;
+  filterStrength?: GuardrailContentFilterStrength;
   action: GuardrailContentPolicyAction | undefined;
 }
 export interface GuardrailContentPolicyAssessment {
@@ -107,6 +116,26 @@ export interface GuardrailContextualGroundingFilter {
 export interface GuardrailContextualGroundingPolicyAssessment {
   filters?: GuardrailContextualGroundingFilter[];
 }
+export interface GuardrailTextCharactersCoverage {
+  guarded?: number;
+  total?: number;
+}
+export interface GuardrailCoverage {
+  textCharacters?: GuardrailTextCharactersCoverage;
+}
+export interface GuardrailUsage {
+  topicPolicyUnits: number | undefined;
+  contentPolicyUnits: number | undefined;
+  wordPolicyUnits: number | undefined;
+  sensitiveInformationPolicyUnits: number | undefined;
+  sensitiveInformationPolicyFreeUnits: number | undefined;
+  contextualGroundingPolicyUnits: number | undefined;
+}
+export interface GuardrailInvocationMetrics {
+  guardrailProcessingLatency?: number;
+  usage?: GuardrailUsage;
+  guardrailCoverage?: GuardrailCoverage;
+}
 export declare const GuardrailSensitiveInformationPolicyAction: {
   readonly ANONYMIZED: "ANONYMIZED";
   readonly BLOCKED: "BLOCKED";
@@ -210,23 +239,17 @@ export interface GuardrailAssessment {
   wordPolicy?: GuardrailWordPolicyAssessment;
   sensitiveInformationPolicy?: GuardrailSensitiveInformationPolicyAssessment;
   contextualGroundingPolicy?: GuardrailContextualGroundingPolicyAssessment;
+  invocationMetrics?: GuardrailInvocationMetrics;
 }
 export interface GuardrailOutputContent {
   text?: string;
 }
-export interface GuardrailUsage {
-  topicPolicyUnits: number | undefined;
-  contentPolicyUnits: number | undefined;
-  wordPolicyUnits: number | undefined;
-  sensitiveInformationPolicyUnits: number | undefined;
-  sensitiveInformationPolicyFreeUnits: number | undefined;
-  contextualGroundingPolicyUnits: number | undefined;
-}
 export interface ApplyGuardrailResponse {
   usage: GuardrailUsage | undefined;
   action: GuardrailAction | undefined;
   outputs: GuardrailOutputContent[] | undefined;
   assessments: GuardrailAssessment[] | undefined;
+  guardrailCoverage?: GuardrailCoverage;
 }
 export declare class InternalServerException extends __BaseException {
   readonly name: "InternalServerException";

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.662.0",
+  "version": "3.663.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "node ../../scripts/compilation/inline client-bedrock-runtime",