@aws-sdk/client-bedrock-runtime 3.1068.0 → 3.1070.0

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

@@ -0,0 +1,164 @@
+import { Command as $Command } from "@smithy/core/client";
+import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import type { BedrockRuntimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BedrockRuntimeClient";
+import type { InvokeGuardrailChecksRequest, InvokeGuardrailChecksResponse } from "../models/models_0";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link InvokeGuardrailChecksCommand}.
+ */
+export interface InvokeGuardrailChecksCommandInput extends InvokeGuardrailChecksRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link InvokeGuardrailChecksCommand}.
+ */
+export interface InvokeGuardrailChecksCommandOutput extends InvokeGuardrailChecksResponse, __MetadataBearer {
+}
+declare const InvokeGuardrailChecksCommand_base: {
+    new (input: InvokeGuardrailChecksCommandInput): import("@smithy/core/client").CommandImpl<InvokeGuardrailChecksCommandInput, InvokeGuardrailChecksCommandOutput, BedrockRuntimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (input: InvokeGuardrailChecksCommandInput): import("@smithy/core/client").CommandImpl<InvokeGuardrailChecksCommandInput, InvokeGuardrailChecksCommandOutput, BedrockRuntimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): {
+        [x: string]: unknown;
+    };
+};
+/**
+ * <p>Evaluates messages against inline guardrail checks. You specify the check configurations directly in the request, and Amazon Bedrock returns per-check results with severity or confidence scores.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { BedrockRuntimeClient, InvokeGuardrailChecksCommand } from "@aws-sdk/client-bedrock-runtime"; // ES Modules import
+ * // const { BedrockRuntimeClient, InvokeGuardrailChecksCommand } = require("@aws-sdk/client-bedrock-runtime"); // CommonJS import
+ * // import type { BedrockRuntimeClientConfig } from "@aws-sdk/client-bedrock-runtime";
+ * const config = {}; // type is BedrockRuntimeClientConfig
+ * const client = new BedrockRuntimeClient(config);
+ * const input = { // InvokeGuardrailChecksRequest
+ *   messages: [ // GuardrailChecksMessageList // required
+ *     { // GuardrailChecksMessage
+ *       role: "user" || "assistant" || "system", // required
+ *       content: [ // GuardrailChecksContentBlockList // required
+ *         { // GuardrailChecksContentBlock Union: only one key present
+ *           text: "STRING_VALUE",
+ *         },
+ *       ],
+ *     },
+ *   ],
+ *   checks: { // GuardrailChecksConfig
+ *     contentFilter: { // GuardrailChecksContentFilterConfig
+ *       categories: [ // GuardrailChecksContentFilterCategoryConfigList // required
+ *         { // GuardrailChecksContentFilterCategoryConfig
+ *           category: "VIOLENCE" || "HATE" || "SEXUAL" || "MISCONDUCT" || "INSULTS", // required
+ *         },
+ *       ],
+ *     },
+ *     promptAttack: { // GuardrailChecksPromptAttackConfig
+ *       categories: [ // GuardrailChecksPromptAttackCategoryConfigList // required
+ *         { // GuardrailChecksPromptAttackCategoryConfig
+ *           category: "JAILBREAK" || "PROMPT_INJECTION" || "PROMPT_LEAKAGE", // required
+ *         },
+ *       ],
+ *     },
+ *     sensitiveInformation: { // GuardrailChecksSensitiveInformationConfig
+ *       entities: [ // GuardrailChecksSensitiveInformationEntityConfigList // required
+ *         { // GuardrailChecksSensitiveInformationEntityConfig
+ *           type: "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", // required
+ *         },
+ *       ],
+ *     },
+ *   },
+ * };
+ * const command = new InvokeGuardrailChecksCommand(input);
+ * const response = await client.send(command);
+ * // { // InvokeGuardrailChecksResponse
+ * //   results: { // GuardrailChecksResults
+ * //     contentFilter: { // GuardrailChecksContentFilterResult
+ * //       results: [ // GuardrailChecksContentFilterResultList // required
+ * //         { // GuardrailChecksContentFilterResultEntry
+ * //           category: "VIOLENCE" || "HATE" || "SEXUAL" || "MISCONDUCT" || "INSULTS", // required
+ * //           severityScore: Number("double"), // required
+ * //         },
+ * //       ],
+ * //     },
+ * //     promptAttack: { // GuardrailChecksPromptAttackResult
+ * //       results: [ // GuardrailChecksPromptAttackResultList // required
+ * //         { // GuardrailChecksPromptAttackResultEntry
+ * //           category: "JAILBREAK" || "PROMPT_INJECTION" || "PROMPT_LEAKAGE", // required
+ * //           severityScore: Number("double"), // required
+ * //         },
+ * //       ],
+ * //     },
+ * //     sensitiveInformation: { // GuardrailChecksSensitiveInformationResult
+ * //       results: [ // GuardrailChecksSensitiveInformationResultList // required
+ * //         { // GuardrailChecksSensitiveInformationResultEntry
+ * //           type: "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", // required
+ * //           confidenceScore: Number("double"), // required
+ * //           beginOffset: Number("int"), // required
+ * //           endOffset: Number("int"), // required
+ * //           messageIndex: Number("int"), // required
+ * //           contentIndex: Number("int"), // required
+ * //         },
+ * //       ],
+ * //       truncated: true || false,
+ * //     },
+ * //   },
+ * //   usage: { // GuardrailChecksUsageResults
+ * //     contentFilter: { // GuardrailChecksContentFilterUsage
+ * //       textUnits: Number("int"), // required
+ * //     },
+ * //     promptAttack: { // GuardrailChecksPromptAttackUsage
+ * //       textUnits: Number("int"), // required
+ * //     },
+ * //     sensitiveInformation: { // GuardrailChecksSensitiveInformationUsage
+ * //       textUnits: Number("int"), // required
+ * //     },
+ * //   },
+ * // };
+ *
+ * ```
+ *
+ * @param InvokeGuardrailChecksCommandInput - {@link InvokeGuardrailChecksCommandInput}
+ * @returns {@link InvokeGuardrailChecksCommandOutput}
+ * @see {@link InvokeGuardrailChecksCommandInput} for command's `input` shape.
+ * @see {@link InvokeGuardrailChecksCommandOutput} for command's `response` shape.
+ * @see {@link BedrockRuntimeClientResolvedConfig | config} for BedrockRuntimeClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>The request is denied because you do not have sufficient permissions to perform the requested action. For troubleshooting this error, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-access-denied">AccessDeniedException</a> in the Amazon Bedrock User Guide</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>An internal server error occurred. For troubleshooting this error, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-internal-failure">InternalFailure</a> in the Amazon Bedrock User Guide</p>
+ *
+ * @throws {@link ServiceUnavailableException} (server fault)
+ *  <p>The service isn't currently available. For troubleshooting this error, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-service-unavailable">ServiceUnavailable</a> in the Amazon Bedrock User Guide</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>Your request was denied due to exceeding the account quotas for <i>Amazon Bedrock</i>. For troubleshooting this error, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-throttling-exception">ThrottlingException</a> in the Amazon Bedrock User Guide</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>The input fails to satisfy the constraints specified by <i>Amazon Bedrock</i>. For troubleshooting this error, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-validation-error">ValidationError</a> in the Amazon Bedrock User Guide</p>
+ *
+ * @throws {@link BedrockRuntimeServiceException}
+ * <p>Base exception class for all service exceptions from BedrockRuntime service.</p>
+ *
+ *
+ * @public
+ */
+export declare class InvokeGuardrailChecksCommand extends InvokeGuardrailChecksCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: InvokeGuardrailChecksRequest;
+            output: InvokeGuardrailChecksResponse;
+        };
+        sdk: {
+            input: InvokeGuardrailChecksCommandInput;
+            output: InvokeGuardrailChecksCommandOutput;
+        };
+    };
+}

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

@@ -3,6 +3,7 @@ export * from "./ConverseCommand";
 export * from "./ConverseStreamCommand";
 export * from "./CountTokensCommand";
 export * from "./GetAsyncInvokeCommand";
+export * from "./InvokeGuardrailChecksCommand";
 export * from "./InvokeModelCommand";
 export * from "./InvokeModelWithBidirectionalStreamCommand";
 export * from "./InvokeModelWithResponseStreamCommand";

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

@@ -312,6 +312,88 @@ export declare const GuardrailManagedWordType: {
  * @public
  */
 export type GuardrailManagedWordType = (typeof GuardrailManagedWordType)[keyof typeof GuardrailManagedWordType];
+/**
+ * @public
+ * @enum
+ */
+export declare const GuardrailChecksContentFilterCategory: {
+    readonly HATE: "HATE";
+    readonly INSULTS: "INSULTS";
+    readonly MISCONDUCT: "MISCONDUCT";
+    readonly SEXUAL: "SEXUAL";
+    readonly VIOLENCE: "VIOLENCE";
+};
+/**
+ * @public
+ */
+export type GuardrailChecksContentFilterCategory = (typeof GuardrailChecksContentFilterCategory)[keyof typeof GuardrailChecksContentFilterCategory];
+/**
+ * @public
+ * @enum
+ */
+export declare const GuardrailChecksPromptAttackCategory: {
+    readonly JAILBREAK: "JAILBREAK";
+    readonly PROMPT_INJECTION: "PROMPT_INJECTION";
+    readonly PROMPT_LEAKAGE: "PROMPT_LEAKAGE";
+};
+/**
+ * @public
+ */
+export type GuardrailChecksPromptAttackCategory = (typeof GuardrailChecksPromptAttackCategory)[keyof typeof GuardrailChecksPromptAttackCategory];
+/**
+ * @public
+ * @enum
+ */
+export declare const GuardrailChecksSensitiveInformationEntityType: {
+    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 GuardrailChecksSensitiveInformationEntityType = (typeof GuardrailChecksSensitiveInformationEntityType)[keyof typeof GuardrailChecksSensitiveInformationEntityType];
+/**
+ * @public
+ * @enum
+ */
+export declare const GuardrailChecksRole: {
+    readonly ASSISTANT: "assistant";
+    readonly SYSTEM: "system";
+    readonly USER: "user";
+};
+/**
+ * @public
+ */
+export type GuardrailChecksRole = (typeof GuardrailChecksRole)[keyof typeof GuardrailChecksRole];
 /**
  * @public
  * @enum

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

@@ -1,5 +1,5 @@
 import type { DocumentType as __DocumentType } from "@smithy/types";
-import type { AsyncInvokeStatus, AudioFormat, CachePointType, CacheTTL, ConversationRole, DocumentFormat, GuardrailAction, GuardrailAutomatedReasoningLogicWarningType, GuardrailContentFilterConfidence, GuardrailContentFilterStrength, GuardrailContentFilterType, GuardrailContentPolicyAction, GuardrailContentQualifier, GuardrailContentSource, GuardrailContextualGroundingFilterType, GuardrailContextualGroundingPolicyAction, GuardrailConverseContentQualifier, GuardrailConverseImageFormat, GuardrailImageFormat, GuardrailManagedWordType, GuardrailOrigin, GuardrailOutputScope, GuardrailOwnership, GuardrailPiiEntityType, GuardrailSensitiveInformationPolicyAction, GuardrailStreamProcessingMode, GuardrailTopicPolicyAction, GuardrailTopicType, GuardrailTrace, GuardrailWordPolicyAction, ImageFormat, OutputFormatType, PerformanceConfigLatency, ServiceTierType, SortAsyncInvocationBy, SortOrder, StopReason, ToolResultStatus, ToolUseType, Trace, VideoFormat } from "./enums";
+import type { AsyncInvokeStatus, AudioFormat, CachePointType, CacheTTL, ConversationRole, DocumentFormat, GuardrailAction, GuardrailAutomatedReasoningLogicWarningType, GuardrailChecksContentFilterCategory, GuardrailChecksPromptAttackCategory, GuardrailChecksRole, GuardrailChecksSensitiveInformationEntityType, GuardrailContentFilterConfidence, GuardrailContentFilterStrength, GuardrailContentFilterType, GuardrailContentPolicyAction, GuardrailContentQualifier, GuardrailContentSource, GuardrailContextualGroundingFilterType, GuardrailContextualGroundingPolicyAction, GuardrailConverseContentQualifier, GuardrailConverseImageFormat, GuardrailImageFormat, GuardrailManagedWordType, GuardrailOrigin, GuardrailOutputScope, GuardrailOwnership, GuardrailPiiEntityType, GuardrailSensitiveInformationPolicyAction, GuardrailStreamProcessingMode, GuardrailTopicPolicyAction, GuardrailTopicType, GuardrailTrace, GuardrailWordPolicyAction, ImageFormat, OutputFormatType, PerformanceConfigLatency, ServiceTierType, SortAsyncInvocationBy, SortOrder, StopReason, ToolResultStatus, ToolUseType, Trace, VideoFormat } from "./enums";
 import type { InternalServerException, ModelStreamErrorException, ModelTimeoutException, ServiceUnavailableException, ThrottlingException, ValidationException } from "./errors";
 /**
  * @public
@@ -1302,6 +1302,353 @@ export interface ApplyGuardrailResponse {
      */
     guardrailCoverage?: GuardrailCoverage | undefined;
 }
+/**
+ * <p>The configuration for a single content filter category to evaluate.</p>
+ * @public
+ */
+export interface GuardrailChecksContentFilterCategoryConfig {
+    /**
+     * <p>The content filter category to evaluate.</p>
+     * @public
+     */
+    category: GuardrailChecksContentFilterCategory | undefined;
+}
+/**
+ * <p>The configuration for the content filter check, specifying which categories to evaluate.</p>
+ * @public
+ */
+export interface GuardrailChecksContentFilterConfig {
+    /**
+     * <p>The content filter categories to evaluate.</p>
+     * @public
+     */
+    categories: GuardrailChecksContentFilterCategoryConfig[] | undefined;
+}
+/**
+ * <p>The configuration for a single prompt attack category to evaluate.</p>
+ * @public
+ */
+export interface GuardrailChecksPromptAttackCategoryConfig {
+    /**
+     * <p>The prompt attack category to evaluate.</p>
+     * @public
+     */
+    category: GuardrailChecksPromptAttackCategory | undefined;
+}
+/**
+ * <p>The configuration for the prompt attack check, specifying which categories to evaluate.</p>
+ * @public
+ */
+export interface GuardrailChecksPromptAttackConfig {
+    /**
+     * <p>The prompt attack categories to evaluate.</p>
+     * @public
+     */
+    categories: GuardrailChecksPromptAttackCategoryConfig[] | undefined;
+}
+/**
+ * <p>The configuration for a single sensitive information entity type to detect.</p>
+ * @public
+ */
+export interface GuardrailChecksSensitiveInformationEntityConfig {
+    /**
+     * <p>The PII entity type to detect.</p>
+     * @public
+     */
+    type: GuardrailChecksSensitiveInformationEntityType | undefined;
+}
+/**
+ * <p>The configuration for the sensitive information check, specifying which entity types to detect.</p>
+ * @public
+ */
+export interface GuardrailChecksSensitiveInformationConfig {
+    /**
+     * <p>The sensitive information entity types to detect.</p>
+     * @public
+     */
+    entities: GuardrailChecksSensitiveInformationEntityConfig[] | undefined;
+}
+/**
+ * <p>The configuration for inline guardrail checks. Specify one or more check types to run against the messages.</p>
+ * @public
+ */
+export interface GuardrailChecksConfig {
+    /**
+     * <p>The content filter check configuration.</p>
+     * @public
+     */
+    contentFilter?: GuardrailChecksContentFilterConfig | undefined;
+    /**
+     * <p>The prompt attack check configuration.</p>
+     * @public
+     */
+    promptAttack?: GuardrailChecksPromptAttackConfig | undefined;
+    /**
+     * <p>The sensitive information check configuration.</p>
+     * @public
+     */
+    sensitiveInformation?: GuardrailChecksSensitiveInformationConfig | undefined;
+}
+/**
+ * <p>A content block within a message to evaluate.</p>
+ * @public
+ */
+export type GuardrailChecksContentBlock = GuardrailChecksContentBlock.TextMember | GuardrailChecksContentBlock.$UnknownMember;
+/**
+ * @public
+ */
+export declare namespace GuardrailChecksContentBlock {
+    /**
+     * <p>The text content to evaluate.</p>
+     * @public
+     */
+    interface TextMember {
+        text: string;
+        $unknown?: never;
+    }
+    /**
+     * @public
+     */
+    interface $UnknownMember {
+        text?: never;
+        $unknown: [string, any];
+    }
+    /**
+     * @deprecated unused in schema-serde mode.
+     *
+     */
+    interface Visitor<T> {
+        text: (value: string) => T;
+        _: (name: string, value: any) => T;
+    }
+}
+/**
+ * <p>A message to evaluate against guardrail checks, containing a role and content blocks.</p>
+ * @public
+ */
+export interface GuardrailChecksMessage {
+    /**
+     * <p>The role of the message sender.</p>
+     * @public
+     */
+    role: GuardrailChecksRole | undefined;
+    /**
+     * <p>The content blocks for the message.</p>
+     * @public
+     */
+    content: GuardrailChecksContentBlock[] | undefined;
+}
+/**
+ * @public
+ */
+export interface InvokeGuardrailChecksRequest {
+    /**
+     * <p>The messages to evaluate against the specified guardrail checks. Each message includes a role and one or more content blocks.</p>
+     * @public
+     */
+    messages: GuardrailChecksMessage[] | undefined;
+    /**
+     * <p>The inline check configurations that specify which guardrail checks to run against the messages.</p>
+     * @public
+     */
+    checks: GuardrailChecksConfig | undefined;
+}
+/**
+ * <p>The evaluation result for a single content filter category.</p>
+ * @public
+ */
+export interface GuardrailChecksContentFilterResultEntry {
+    /**
+     * <p>The content filter category that was evaluated.</p>
+     * @public
+     */
+    category: GuardrailChecksContentFilterCategory | undefined;
+    /**
+     * <p>The severity score for the category, ranging from 0.0 to 1.0. Higher values indicate greater severity.</p>
+     * @public
+     */
+    severityScore: number | undefined;
+}
+/**
+ * <p>The content filter check results.</p>
+ * @public
+ */
+export interface GuardrailChecksContentFilterResult {
+    /**
+     * <p>The per-category content filter results.</p>
+     * @public
+     */
+    results: GuardrailChecksContentFilterResultEntry[] | undefined;
+}
+/**
+ * <p>The evaluation result for a single prompt attack category.</p>
+ * @public
+ */
+export interface GuardrailChecksPromptAttackResultEntry {
+    /**
+     * <p>The prompt attack category that was evaluated.</p>
+     * @public
+     */
+    category: GuardrailChecksPromptAttackCategory | undefined;
+    /**
+     * <p>The severity score for the category, ranging from 0.0 to 1.0. Higher values indicate greater severity.</p>
+     * @public
+     */
+    severityScore: number | undefined;
+}
+/**
+ * <p>The prompt attack check results.</p>
+ * @public
+ */
+export interface GuardrailChecksPromptAttackResult {
+    /**
+     * <p>The per-category prompt attack results.</p>
+     * @public
+     */
+    results: GuardrailChecksPromptAttackResultEntry[] | undefined;
+}
+/**
+ * <p>The detection result for a single sensitive information entity found in the evaluated messages.</p>
+ * @public
+ */
+export interface GuardrailChecksSensitiveInformationResultEntry {
+    /**
+     * <p>The PII entity type that was detected.</p>
+     * @public
+     */
+    type: GuardrailChecksSensitiveInformationEntityType | undefined;
+    /**
+     * <p>The confidence score for the detection, ranging from 0.0 to 1.0. Higher values indicate greater confidence.</p>
+     * @public
+     */
+    confidenceScore: number | undefined;
+    /**
+     * <p>The start character offset of the detected entity within the content block.</p>
+     * @public
+     */
+    beginOffset: number | undefined;
+    /**
+     * <p>The end character offset of the detected entity within the content block.</p>
+     * @public
+     */
+    endOffset: number | undefined;
+    /**
+     * <p>The zero-based index of the message in the input messages array where the entity was detected.</p>
+     * @public
+     */
+    messageIndex: number | undefined;
+    /**
+     * <p>The zero-based index of the content block within the message where the entity was detected.</p>
+     * @public
+     */
+    contentIndex: number | undefined;
+}
+/**
+ * <p>The sensitive information check results.</p>
+ * @public
+ */
+export interface GuardrailChecksSensitiveInformationResult {
+    /**
+     * <p>The detected sensitive information entities.</p>
+     * @public
+     */
+    results: GuardrailChecksSensitiveInformationResultEntry[] | undefined;
+    /**
+     * <p>Specifies whether the results were truncated because the number of detected entities exceeded the maximum limit.</p>
+     * @public
+     */
+    truncated?: boolean | undefined;
+}
+/**
+ * <p>The results from the guardrail checks evaluation, organized by check type.</p>
+ * @public
+ */
+export interface GuardrailChecksResults {
+    /**
+     * <p>The content filter check results.</p>
+     * @public
+     */
+    contentFilter?: GuardrailChecksContentFilterResult | undefined;
+    /**
+     * <p>The prompt attack check results.</p>
+     * @public
+     */
+    promptAttack?: GuardrailChecksPromptAttackResult | undefined;
+    /**
+     * <p>The sensitive information check results.</p>
+     * @public
+     */
+    sensitiveInformation?: GuardrailChecksSensitiveInformationResult | undefined;
+}
+/**
+ * <p>The text unit usage for the content filter check.</p>
+ * @public
+ */
+export interface GuardrailChecksContentFilterUsage {
+    /**
+     * <p>The number of text units consumed by the content filter check.</p>
+     * @public
+     */
+    textUnits: number | undefined;
+}
+/**
+ * <p>The text unit usage for the prompt attack check.</p>
+ * @public
+ */
+export interface GuardrailChecksPromptAttackUsage {
+    /**
+     * <p>The number of text units consumed by the prompt attack check.</p>
+     * @public
+     */
+    textUnits: number | undefined;
+}
+/**
+ * <p>The text unit usage for the sensitive information check.</p>
+ * @public
+ */
+export interface GuardrailChecksSensitiveInformationUsage {
+    /**
+     * <p>The number of text units consumed by the sensitive information check.</p>
+     * @public
+     */
+    textUnits: number | undefined;
+}
+/**
+ * <p>The text unit usage for the guardrail checks evaluation, organized by check type.</p>
+ * @public
+ */
+export interface GuardrailChecksUsageResults {
+    /**
+     * <p>The text unit usage for the content filter check.</p>
+     * @public
+     */
+    contentFilter?: GuardrailChecksContentFilterUsage | undefined;
+    /**
+     * <p>The text unit usage for the prompt attack check.</p>
+     * @public
+     */
+    promptAttack?: GuardrailChecksPromptAttackUsage | undefined;
+    /**
+     * <p>The text unit usage for the sensitive information check.</p>
+     * @public
+     */
+    sensitiveInformation?: GuardrailChecksSensitiveInformationUsage | undefined;
+}
+/**
+ * @public
+ */
+export interface InvokeGuardrailChecksResponse {
+    /**
+     * <p>The per-check results containing findings from the guardrail evaluation.</p>
+     * @public
+     */
+    results: GuardrailChecksResults | undefined;
+    /**
+     * <p>The per-check text unit consumption for the guardrail evaluation.</p>
+     * @public
+     */
+    usage: GuardrailChecksUsageResults | undefined;
+}
 /**
  * <p>Configuration information for a guardrail that you use with the <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_Converse.html">Converse</a> operation.</p>
  * @public

package/dist-types/schemas/schemas_0.d.ts

@@ -74,6 +74,25 @@ export declare var GuardrailAutomatedReasoningTranslation$: StaticStructureSchem
 export declare var GuardrailAutomatedReasoningTranslationAmbiguousFinding$: StaticStructureSchema;
 export declare var GuardrailAutomatedReasoningTranslationOption$: StaticStructureSchema;
 export declare var GuardrailAutomatedReasoningValidFinding$: StaticStructureSchema;
+export declare var GuardrailChecksConfig$: StaticStructureSchema;
+export declare var GuardrailChecksContentFilterCategoryConfig$: StaticStructureSchema;
+export declare var GuardrailChecksContentFilterConfig$: StaticStructureSchema;
+export declare var GuardrailChecksContentFilterResult$: StaticStructureSchema;
+export declare var GuardrailChecksContentFilterResultEntry$: StaticStructureSchema;
+export declare var GuardrailChecksContentFilterUsage$: StaticStructureSchema;
+export declare var GuardrailChecksMessage$: StaticStructureSchema;
+export declare var GuardrailChecksPromptAttackCategoryConfig$: StaticStructureSchema;
+export declare var GuardrailChecksPromptAttackConfig$: StaticStructureSchema;
+export declare var GuardrailChecksPromptAttackResult$: StaticStructureSchema;
+export declare var GuardrailChecksPromptAttackResultEntry$: StaticStructureSchema;
+export declare var GuardrailChecksPromptAttackUsage$: StaticStructureSchema;
+export declare var GuardrailChecksResults$: StaticStructureSchema;
+export declare var GuardrailChecksSensitiveInformationConfig$: StaticStructureSchema;
+export declare var GuardrailChecksSensitiveInformationEntityConfig$: StaticStructureSchema;
+export declare var GuardrailChecksSensitiveInformationResult$: StaticStructureSchema;
+export declare var GuardrailChecksSensitiveInformationResultEntry$: StaticStructureSchema;
+export declare var GuardrailChecksSensitiveInformationUsage$: StaticStructureSchema;
+export declare var GuardrailChecksUsageResults$: StaticStructureSchema;
 export declare var GuardrailConfiguration$: StaticStructureSchema;
 export declare var GuardrailContentFilter$: StaticStructureSchema;
 export declare var GuardrailContentPolicyAssessment$: StaticStructureSchema;
@@ -103,6 +122,8 @@ export declare var ImageBlock$: StaticStructureSchema;
 export declare var ImageBlockDelta$: StaticStructureSchema;
 export declare var ImageBlockStart$: StaticStructureSchema;
 export declare var InferenceConfiguration$: StaticStructureSchema;
+export declare var InvokeGuardrailChecksRequest$: StaticStructureSchema;
+export declare var InvokeGuardrailChecksResponse$: StaticStructureSchema;
 export declare var InvokeModelRequest$: StaticStructureSchema;
 export declare var InvokeModelResponse$: StaticStructureSchema;
 export declare var InvokeModelTokensRequest$: StaticStructureSchema;
@@ -156,6 +177,7 @@ export declare var CountTokensInput$: StaticUnionSchema;
 export declare var DocumentContentBlock$: StaticUnionSchema;
 export declare var DocumentSource$: StaticUnionSchema;
 export declare var GuardrailAutomatedReasoningFinding$: StaticUnionSchema;
+export declare var GuardrailChecksContentBlock$: StaticUnionSchema;
 export declare var GuardrailContentBlock$: StaticUnionSchema;
 export declare var GuardrailConverseContentBlock$: StaticUnionSchema;
 export declare var GuardrailConverseImageSource$: StaticUnionSchema;
@@ -180,6 +202,7 @@ export declare var Converse$: StaticOperationSchema;
 export declare var ConverseStream$: StaticOperationSchema;
 export declare var CountTokens$: StaticOperationSchema;
 export declare var GetAsyncInvoke$: StaticOperationSchema;
+export declare var InvokeGuardrailChecks$: StaticOperationSchema;
 export declare var InvokeModel$: StaticOperationSchema;
 export declare var InvokeModelWithBidirectionalStream$: StaticOperationSchema;
 export declare var InvokeModelWithResponseStream$: StaticOperationSchema;