@aws-sdk/client-bedrock-runtime 3.613.0 → 3.616.0

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

@@ -0,0 +1,167 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { BedrockRuntimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BedrockRuntimeClient";
+import { ApplyGuardrailRequest, ApplyGuardrailResponse } from "../models/models_0";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link ApplyGuardrailCommand}.
+ */
+export interface ApplyGuardrailCommandInput extends ApplyGuardrailRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link ApplyGuardrailCommand}.
+ */
+export interface ApplyGuardrailCommandOutput extends ApplyGuardrailResponse, __MetadataBearer {
+}
+declare const ApplyGuardrailCommand_base: {
+    new (input: ApplyGuardrailCommandInput): import("@smithy/smithy-client").CommandImpl<ApplyGuardrailCommandInput, ApplyGuardrailCommandOutput, BedrockRuntimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: ApplyGuardrailCommandInput): import("@smithy/smithy-client").CommandImpl<ApplyGuardrailCommandInput, ApplyGuardrailCommandOutput, BedrockRuntimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>The action to apply a guardrail.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { BedrockRuntimeClient, ApplyGuardrailCommand } from "@aws-sdk/client-bedrock-runtime"; // ES Modules import
+ * // const { BedrockRuntimeClient, ApplyGuardrailCommand } = require("@aws-sdk/client-bedrock-runtime"); // CommonJS import
+ * const client = new BedrockRuntimeClient(config);
+ * const input = { // ApplyGuardrailRequest
+ *   guardrailIdentifier: "STRING_VALUE", // required
+ *   guardrailVersion: "STRING_VALUE", // required
+ *   source: "INPUT" || "OUTPUT", // required
+ *   content: [ // GuardrailContentBlockList // required
+ *     { // GuardrailContentBlock Union: only one key present
+ *       text: { // GuardrailTextBlock
+ *         text: "STRING_VALUE", // required
+ *         qualifiers: [ // GuardrailContentQualifierList
+ *           "grounding_source" || "query" || "guard_content",
+ *         ],
+ *       },
+ *     },
+ *   ],
+ * };
+ * const command = new ApplyGuardrailCommand(input);
+ * const response = await client.send(command);
+ * // { // ApplyGuardrailResponse
+ * //   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
+ * //   },
+ * //   action: "NONE" || "GUARDRAIL_INTERVENED", // required
+ * //   outputs: [ // GuardrailOutputContentList // required
+ * //     { // GuardrailOutputContent
+ * //       text: "STRING_VALUE",
+ * //     },
+ * //   ],
+ * //   assessments: [ // GuardrailAssessmentList // required
+ * //     { // GuardrailAssessment
+ * //       topicPolicy: { // GuardrailTopicPolicyAssessment
+ * //         topics: [ // GuardrailTopicList // required
+ * //           { // GuardrailTopic
+ * //             name: "STRING_VALUE", // required
+ * //             type: "DENY", // required
+ * //             action: "BLOCKED", // required
+ * //           },
+ * //         ],
+ * //       },
+ * //       contentPolicy: { // GuardrailContentPolicyAssessment
+ * //         filters: [ // GuardrailContentFilterList // required
+ * //           { // GuardrailContentFilter
+ * //             type: "INSULTS" || "HATE" || "SEXUAL" || "VIOLENCE" || "MISCONDUCT" || "PROMPT_ATTACK", // required
+ * //             confidence: "NONE" || "LOW" || "MEDIUM" || "HIGH", // required
+ * //             action: "BLOCKED", // required
+ * //           },
+ * //         ],
+ * //       },
+ * //       wordPolicy: { // GuardrailWordPolicyAssessment
+ * //         customWords: [ // GuardrailCustomWordList // required
+ * //           { // GuardrailCustomWord
+ * //             match: "STRING_VALUE", // required
+ * //             action: "BLOCKED", // required
+ * //           },
+ * //         ],
+ * //         managedWordLists: [ // GuardrailManagedWordList // required
+ * //           { // GuardrailManagedWord
+ * //             match: "STRING_VALUE", // required
+ * //             type: "PROFANITY", // required
+ * //             action: "BLOCKED", // required
+ * //           },
+ * //         ],
+ * //       },
+ * //       sensitiveInformationPolicy: { // GuardrailSensitiveInformationPolicyAssessment
+ * //         piiEntities: [ // GuardrailPiiEntityFilterList // required
+ * //           { // GuardrailPiiEntityFilter
+ * //             match: "STRING_VALUE", // required
+ * //             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
+ * //             action: "ANONYMIZED" || "BLOCKED", // required
+ * //           },
+ * //         ],
+ * //         regexes: [ // GuardrailRegexFilterList // required
+ * //           { // GuardrailRegexFilter
+ * //             name: "STRING_VALUE",
+ * //             match: "STRING_VALUE",
+ * //             regex: "STRING_VALUE",
+ * //             action: "ANONYMIZED" || "BLOCKED", // required
+ * //           },
+ * //         ],
+ * //       },
+ * //       contextualGroundingPolicy: { // GuardrailContextualGroundingPolicyAssessment
+ * //         filters: [ // GuardrailContextualGroundingFilters
+ * //           { // GuardrailContextualGroundingFilter
+ * //             type: "GROUNDING" || "RELEVANCE", // required
+ * //             threshold: Number("double"), // required
+ * //             score: Number("double"), // required
+ * //             action: "BLOCKED" || "NONE", // required
+ * //           },
+ * //         ],
+ * //       },
+ * //     },
+ * //   ],
+ * // };
+ *
+ * ```
+ *
+ * @param ApplyGuardrailCommandInput - {@link ApplyGuardrailCommandInput}
+ * @returns {@link ApplyGuardrailCommandOutput}
+ * @see {@link ApplyGuardrailCommandInput} for command's `input` shape.
+ * @see {@link ApplyGuardrailCommandOutput} 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 of missing access permissions.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>An internal server error occurred. Retry your request.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The specified resource ARN was not found. Check the ARN and try your request again.</p>
+ *
+ * @throws {@link ServiceQuotaExceededException} (client fault)
+ *  <p>The number of requests exceeds the service quota. Resubmit your request later.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>The number of requests exceeds the limit. Resubmit your request later.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>Input validation failed. Check your request parameters and retry the request.</p>
+ *
+ * @throws {@link BedrockRuntimeServiceException}
+ * <p>Base exception class for all service exceptions from BedrockRuntime service.</p>
+ *
+ * @public
+ */
+export declare class ApplyGuardrailCommand extends ApplyGuardrailCommand_base {
+}

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

@@ -97,6 +97,9 @@ declare const ConverseCommand_base: {
  *           guardContent: { // GuardrailConverseContentBlock Union: only one key present
  *             text: { // GuardrailConverseTextBlock
  *               text: "STRING_VALUE", // required
+ *               qualifiers: [ // GuardrailConverseContentQualifierList
+ *                 "grounding_source" || "query" || "guard_content",
+ *               ],
  *             },
  *           },
  *         },
@@ -109,6 +112,9 @@ declare const ConverseCommand_base: {
  *       guardContent: {//  Union: only one key present
  *         text: {
  *           text: "STRING_VALUE", // required
+ *           qualifiers: [
+ *             "grounding_source" || "query" || "guard_content",
+ *           ],
  *         },
  *       },
  *     },
@@ -204,6 +210,9 @@ declare const ConverseCommand_base: {
  * //           guardContent: { // GuardrailConverseContentBlock Union: only one key present
  * //             text: { // GuardrailConverseTextBlock
  * //               text: "STRING_VALUE", // required
+ * //               qualifiers: [ // GuardrailConverseContentQualifierList
+ * //                 "grounding_source" || "query" || "guard_content",
+ * //               ],
  * //             },
  * //           },
  * //         },
@@ -277,6 +286,16 @@ declare const ConverseCommand_base: {
  * //               },
  * //             ],
  * //           },
+ * //           contextualGroundingPolicy: { // GuardrailContextualGroundingPolicyAssessment
+ * //             filters: [ // GuardrailContextualGroundingFilters
+ * //               { // GuardrailContextualGroundingFilter
+ * //                 type: "GROUNDING" || "RELEVANCE", // required
+ * //                 threshold: Number("double"), // required
+ * //                 score: Number("double"), // required
+ * //                 action: "BLOCKED" || "NONE", // required
+ * //               },
+ * //             ],
+ * //           },
  * //         },
  * //       },
  * //       outputAssessments: { // GuardrailAssessmentListMap
@@ -332,6 +351,16 @@ declare const ConverseCommand_base: {
  * //                 },
  * //               ],
  * //             },
+ * //             contextualGroundingPolicy: {
+ * //               filters: [
+ * //                 {
+ * //                   type: "GROUNDING" || "RELEVANCE", // required
+ * //                   threshold: Number("double"), // required
+ * //                   score: Number("double"), // required
+ * //                   action: "BLOCKED" || "NONE", // required
+ * //                 },
+ * //               ],
+ * //             },
  * //           },
  * //         ],
  * //       },

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

@@ -100,6 +100,9 @@ declare const ConverseStreamCommand_base: {
  *           guardContent: { // GuardrailConverseContentBlock Union: only one key present
  *             text: { // GuardrailConverseTextBlock
  *               text: "STRING_VALUE", // required
+ *               qualifiers: [ // GuardrailConverseContentQualifierList
+ *                 "grounding_source" || "query" || "guard_content",
+ *               ],
  *             },
  *           },
  *         },
@@ -112,6 +115,9 @@ declare const ConverseStreamCommand_base: {
  *       guardContent: {//  Union: only one key present
  *         text: {
  *           text: "STRING_VALUE", // required
+ *           qualifiers: [
+ *             "grounding_source" || "query" || "guard_content",
+ *           ],
  *         },
  *       },
  *     },
@@ -253,6 +259,16 @@ declare const ConverseStreamCommand_base: {
  * //                   },
  * //                 ],
  * //               },
+ * //               contextualGroundingPolicy: { // GuardrailContextualGroundingPolicyAssessment
+ * //                 filters: [ // GuardrailContextualGroundingFilters
+ * //                   { // GuardrailContextualGroundingFilter
+ * //                     type: "GROUNDING" || "RELEVANCE", // required
+ * //                     threshold: Number("double"), // required
+ * //                     score: Number("double"), // required
+ * //                     action: "BLOCKED" || "NONE", // required
+ * //                   },
+ * //                 ],
+ * //               },
  * //             },
  * //           },
  * //           outputAssessments: { // GuardrailAssessmentListMap
@@ -308,6 +324,16 @@ declare const ConverseStreamCommand_base: {
  * //                     },
  * //                   ],
  * //                 },
+ * //                 contextualGroundingPolicy: {
+ * //                   filters: [
+ * //                     {
+ * //                       type: "GROUNDING" || "RELEVANCE", // required
+ * //                       threshold: Number("double"), // required
+ * //                       score: Number("double"), // required
+ * //                       action: "BLOCKED" || "NONE", // required
+ * //                     },
+ * //                   ],
+ * //                 },
  * //               },
  * //             ],
  * //           },

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

@@ -1,3 +1,4 @@
+export * from "./ApplyGuardrailCommand";
 export * from "./ConverseCommand";
 export * from "./ConverseStreamCommand";
 export * from "./InvokeModelCommand";