@aws-amplify/graphql-api-construct 1.18.2 → 1.18.3-ai-next.0

package/node_modules/@aws-sdk/client-bedrock-runtime/dist-types/models/models_0.d.ts

@@ -40,7 +40,7 @@ export interface GuardrailTextBlock {
      * <p>The qualifiers describing the text block.</p>
      * @public
      */
-    qualifiers?: GuardrailContentQualifier[];
+    qualifiers?: GuardrailContentQualifier[] | undefined;
 }
 /**
  * <p>The content block to be evaluated by the guardrail.</p>
@@ -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 | undefined;
     /**
      * <p>The guardrail action.</p>
      * @public
@@ -253,7 +272,91 @@ export interface GuardrailContextualGroundingPolicyAssessment {
      * <p>The filter details for the guardrails contextual grounding filter.</p>
      * @public
      */
-    filters?: GuardrailContextualGroundingFilter[];
+    filters?: GuardrailContextualGroundingFilter[] | undefined;
+}
+/**
+ * <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 | undefined;
+    /**
+     * <p>The total text characters by the guardrail coverage.</p>
+     * @public
+     */
+    total?: number | undefined;
+}
+/**
+ * <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 | undefined;
+}
+/**
+ * <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 | undefined;
+    /**
+     * <p>The usage details for the guardrail invocation metrics.</p>
+     * @public
+     */
+    usage?: GuardrailUsage | undefined;
+    /**
+     * <p>The coverage details for the guardrail invocation metrics.</p>
+     * @public
+     */
+    guardrailCoverage?: GuardrailCoverage | undefined;
 }
 /**
  * @public
@@ -338,17 +441,17 @@ export interface GuardrailRegexFilter {
      * <p>The regex filter name.</p>
      * @public
      */
-    name?: string;
+    name?: string | undefined;
     /**
      * <p>The regesx filter match.</p>
      * @public
      */
-    match?: string;
+    match?: string | undefined;
     /**
      * <p>The regex query.</p>
      * @public
      */
-    regex?: string;
+    regex?: string | undefined;
     /**
      * <p>The region filter action.</p>
      * @public
@@ -509,74 +612,43 @@ export interface GuardrailAssessment {
      * <p>The topic policy.</p>
      * @public
      */
-    topicPolicy?: GuardrailTopicPolicyAssessment;
+    topicPolicy?: GuardrailTopicPolicyAssessment | undefined;
     /**
      * <p>The content policy.</p>
      * @public
      */
-    contentPolicy?: GuardrailContentPolicyAssessment;
+    contentPolicy?: GuardrailContentPolicyAssessment | undefined;
     /**
      * <p>The word policy.</p>
      * @public
      */
-    wordPolicy?: GuardrailWordPolicyAssessment;
+    wordPolicy?: GuardrailWordPolicyAssessment | undefined;
     /**
      * <p>The sensitive information policy.</p>
      * @public
      */
-    sensitiveInformationPolicy?: GuardrailSensitiveInformationPolicyAssessment;
+    sensitiveInformationPolicy?: GuardrailSensitiveInformationPolicyAssessment | undefined;
     /**
      * <p>The contextual grounding policy used for the guardrail assessment.</p>
      * @public
      */
-    contextualGroundingPolicy?: GuardrailContextualGroundingPolicyAssessment;
-}
-/**
- * <p>The output content produced by the guardrail.</p>
- * @public
- */
-export interface GuardrailOutputContent {
+    contextualGroundingPolicy?: GuardrailContextualGroundingPolicyAssessment | undefined;
     /**
-     * <p>The specific text for the output content produced by the guardrail.</p>
+     * <p>The invocation metrics for the guardrail assessment.</p>
      * @public
      */
-    text?: string;
+    invocationMetrics?: GuardrailInvocationMetrics | undefined;
 }
 /**
- * <p>The details on the use of the guardrail.</p>
+ * <p>The output content produced by 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;
+export interface GuardrailOutputContent {
     /**
-     * <p>The contextual grounding policy units processed by the guardrail.</p>
+     * <p>The specific text for the output content produced by the guardrail.</p>
      * @public
      */
-    contextualGroundingPolicyUnits: number | undefined;
+    text?: string | 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 | undefined;
 }
 /**
  * <p>An internal server error occurred. Retry your request.</p>
@@ -694,7 +771,7 @@ export interface GuardrailConfiguration {
      * <p>The trace behavior for the guardrail.</p>
      * @public
      */
-    trace?: GuardrailTrace;
+    trace?: GuardrailTrace | undefined;
 }
 /**
  * <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,
@@ -712,7 +789,7 @@ export interface InferenceConfiguration {
      *             <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html">Inference parameters for foundation models</a>. </p>
      * @public
      */
-    maxTokens?: number;
+    maxTokens?: number | undefined;
     /**
      * <p>The likelihood of the model selecting higher-probability options while generating a
      *          response. A lower value makes the model more likely to choose higher-probability options,
@@ -723,7 +800,7 @@ export interface InferenceConfiguration {
      *             models</a>. </p>
      * @public
      */
-    temperature?: number;
+    temperature?: number | undefined;
     /**
      * <p>The percentage of most-likely candidates that the model considers for the next token. For
      *          example, if you choose a value of 0.8 for <code>topP</code>, the model selects from the top 80% of the
@@ -732,13 +809,13 @@ export interface InferenceConfiguration {
      *          <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html">Inference parameters for foundation models</a>. </p>
      * @public
      */
-    topP?: number;
+    topP?: number | undefined;
     /**
      * <p>A list of stop sequences. A stop sequence is a sequence of characters that causes the
      *          model to stop generating the response. </p>
      * @public
      */
-    stopSequences?: string[];
+    stopSequences?: string[] | undefined;
 }
 /**
  * @public
@@ -857,7 +934,7 @@ export interface GuardrailConverseTextBlock {
      * <p>The qualifier details for the guardrails contextual grounding filter.</p>
      * @public
      */
-    qualifiers?: GuardrailConverseContentQualifier[];
+    qualifiers?: GuardrailConverseContentQualifier[] | undefined;
 }
 /**
  * <p/>
@@ -1061,7 +1138,7 @@ export interface ToolResultBlock {
      *          </note>
      * @public
      */
-    status?: ToolResultStatus;
+    status?: ToolResultStatus | undefined;
 }
 /**
  * <p>A tool use content block. Contains information about a tool that the model
@@ -1245,6 +1322,36 @@ export interface Message {
      */
     content: ContentBlock[] | undefined;
 }
+/**
+ * <p>Contains a map of variables in a prompt from Prompt management to an object containing the values to fill in for them when running model invocation. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management-how.html">How Prompt management works</a>.</p>
+ * @public
+ */
+export type PromptVariableValues = PromptVariableValues.TextMember | PromptVariableValues.$UnknownMember;
+/**
+ * @public
+ */
+export declare namespace PromptVariableValues {
+    /**
+     * <p>The text value that the variable maps to.</p>
+     * @public
+     */
+    interface TextMember {
+        text: string;
+        $unknown?: never;
+    }
+    /**
+     * @public
+     */
+    interface $UnknownMember {
+        text?: never;
+        $unknown: [string, any];
+    }
+    interface Visitor<T> {
+        text: (value: string) => T;
+        _: (name: string, value: any) => T;
+    }
+    const visit: <T>(value: PromptVariableValues, visitor: Visitor<T>) => T;
+}
 /**
  * <p>A system content block.</p>
  * @public
@@ -1418,7 +1525,7 @@ export interface ToolSpecification {
      * <p>The description for the tool.</p>
      * @public
      */
-    description?: string;
+    description?: string | undefined;
     /**
      * <p>The input schema for the tool in JSON format.</p>
      * @public
@@ -1472,15 +1579,14 @@ export interface ToolConfiguration {
      * <p>If supported by model, forces the model to request a tool.</p>
      * @public
      */
-    toolChoice?: ToolChoice;
+    toolChoice?: ToolChoice | undefined;
 }
 /**
  * @public
  */
 export interface ConverseRequest {
     /**
-     * <p>The identifier for the model that you want to call.</p>
-     *          <p>The <code>modelId</code> to provide depends on the type of model or throughput that you use:</p>
+     * <p>Specifies the model or throughput with which to run inference, or the prompt resource to use in inference. The value depends on the resource that you use:</p>
      *          <ul>
      *             <li>
      *                <p>If you use a base model, specify the model ID or its ARN. For a list of model IDs for base models, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-ids.html#model-ids-arns">Amazon Bedrock base model IDs (on-demand throughput)</a> in the Amazon Bedrock User Guide.</p>
@@ -1494,6 +1600,9 @@ export interface ConverseRequest {
      *             <li>
      *                <p>If you use a custom model, first purchase Provisioned Throughput for it. Then specify the ARN of the resulting provisioned model. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-customization-use.html">Use a custom model in Amazon Bedrock</a> in the Amazon Bedrock User Guide.</p>
      *             </li>
+     *             <li>
+     *                <p>To include a prompt that was defined in Prompt management, specify the ARN of the prompt version to use.</p>
+     *             </li>
      *          </ul>
      *          <p>The Converse API doesn't support <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-customization-import-model.html">imported models</a>.</p>
      * @public
@@ -1503,19 +1612,19 @@ export interface ConverseRequest {
      * <p>The messages that you want to send to the model.</p>
      * @public
      */
-    messages: Message[] | undefined;
+    messages?: Message[] | undefined;
     /**
-     * <p>A system prompt to pass to the model.</p>
+     * <p>A prompt that provides instructions or context to the model about the task it should perform, or the persona it should adopt during the conversation.</p>
      * @public
      */
-    system?: SystemContentBlock[];
+    system?: SystemContentBlock[] | undefined;
     /**
-     * <p>Inference parameters to pass to the model. <code>Converse</code> supports a base
+     * <p>Inference parameters to pass to the model. <code>Converse</code> and <code>ConverseStream</code> support a base
      *          set of inference parameters. If you need to pass additional parameters that the model
      *          supports, use the <code>additionalModelRequestFields</code> request field.</p>
      * @public
      */
-    inferenceConfig?: InferenceConfiguration;
+    inferenceConfig?: InferenceConfiguration | undefined;
     /**
      * <p>Configuration information for the tools that the model can use when generating a response. </p>
      *          <note>
@@ -1523,22 +1632,27 @@ export interface ConverseRequest {
      *          </note>
      * @public
      */
-    toolConfig?: ToolConfiguration;
+    toolConfig?: ToolConfiguration | undefined;
     /**
-     * <p>Configuration information for a guardrail that you want to use in the request. </p>
+     * <p>Configuration information for a guardrail that you want to use in the request. If you include <code>guardContent</code> blocks in the <code>content</code> field in the <code>messages</code> field, the guardrail operates only on those messages. If you include no <code>guardContent</code> blocks, the guardrail operates on all messages in the request body and in any included prompt resource.</p>
      * @public
      */
-    guardrailConfig?: GuardrailConfiguration;
+    guardrailConfig?: GuardrailConfiguration | undefined;
     /**
      * <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>
+     *          base set of inference parameters that <code>Converse</code> and <code>ConverseStream</code> support in the <code>inferenceConfig</code>
      *          field. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html">Model parameters</a>.</p>
      * @public
      */
-    additionalModelRequestFields?: __DocumentType;
+    additionalModelRequestFields?: __DocumentType | undefined;
+    /**
+     * <p>Contains a map of variables in a prompt from Prompt management to objects containing the values to fill in for them when running model invocation. This field is ignored if you don't specify a prompt resource in the <code>modelId</code> field.</p>
+     * @public
+     */
+    promptVariables?: Record<string, PromptVariableValues> | undefined;
     /**
      * <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
+     *          response. <code>Converse</code> and <code>ConverseStream</code> return the requested fields as a JSON Pointer object in the
      *          <code>additionalModelResponseFields</code> field. The following is example JSON for <code>additionalModelResponseFieldPaths</code>.</p>
      *          <p>
      *             <code>[
@@ -1546,14 +1660,14 @@ export interface ConverseRequest {
      *          ]</code>
      *          </p>
      *          <p>For information about the JSON Pointer syntax, see the
-     *          <a href="https://datatracker.ietf.org/doc/html/rfc6901">Internet Engineering Task Force (IETF)</a> documentation.</p>
+     *         <a href="https://datatracker.ietf.org/doc/html/rfc6901">Internet Engineering Task Force (IETF)</a> documentation.</p>
      *          <p>
-     *             <code>Converse</code> rejects an empty JSON Pointer or incorrectly structured
+     *             <code>Converse</code> and <code>ConverseStream</code> reject an empty JSON Pointer or incorrectly structured
      *          JSON Pointer with a <code>400</code> error code. if the JSON Pointer is valid, but the requested
      *          field is not in the model response, it is ignored by <code>Converse</code>.</p>
      * @public
      */
-    additionalModelResponseFieldPaths?: string[];
+    additionalModelResponseFieldPaths?: string[] | undefined;
 }
 /**
  * <p>Metrics for a call to <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_Converse.html">Converse</a>.</p>
@@ -1622,17 +1736,17 @@ export interface GuardrailTraceAssessment {
      * <p>The output from the model.</p>
      * @public
      */
-    modelOutput?: string[];
+    modelOutput?: string[] | undefined;
     /**
      * <p>The input assessment.</p>
      * @public
      */
-    inputAssessment?: Record<string, GuardrailAssessment>;
+    inputAssessment?: Record<string, GuardrailAssessment> | undefined;
     /**
      * <p>the output assessments.</p>
      * @public
      */
-    outputAssessments?: Record<string, GuardrailAssessment[]>;
+    outputAssessments?: Record<string, GuardrailAssessment[]> | undefined;
 }
 /**
  * <p>The trace object in a response from <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_Converse.html">Converse</a>. Currently, you can only trace guardrails.</p>
@@ -1643,7 +1757,7 @@ export interface ConverseTrace {
      * <p>The guardrail trace object. </p>
      * @public
      */
-    guardrail?: GuardrailTraceAssessment;
+    guardrail?: GuardrailTraceAssessment | undefined;
 }
 /**
  * <p>The tokens used in a message API inference call. </p>
@@ -1695,12 +1809,12 @@ export interface ConverseResponse {
      * <p>Additional fields in the response that are unique to the model. </p>
      * @public
      */
-    additionalModelResponseFields?: __DocumentType;
+    additionalModelResponseFields?: __DocumentType | undefined;
     /**
      * <p>A trace object that contains information about the Guardrail behavior.</p>
      * @public
      */
-    trace?: ConverseTrace;
+    trace?: ConverseTrace | undefined;
 }
 /**
  * <p>The request failed due to an error while processing the model.</p>
@@ -1713,12 +1827,12 @@ export declare class ModelErrorException extends __BaseException {
      * <p>The original status code.</p>
      * @public
      */
-    originalStatusCode?: number;
+    originalStatusCode?: number | undefined;
     /**
      * <p>The resource name.</p>
      * @public
      */
-    resourceName?: string;
+    resourceName?: string | undefined;
     /**
      * @internal
      */
@@ -1796,22 +1910,21 @@ export interface GuardrailStreamConfiguration {
      * <p>The trace behavior for the guardrail.</p>
      * @public
      */
-    trace?: GuardrailTrace;
+    trace?: GuardrailTrace | undefined;
     /**
      * <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;
+    streamProcessingMode?: GuardrailStreamProcessingMode | undefined;
 }
 /**
  * @public
  */
 export interface ConverseStreamRequest {
     /**
-     * <p>The ID for the model.</p>
-     *          <p>The <code>modelId</code> to provide depends on the type of model or throughput that you use:</p>
+     * <p>Specifies the model or throughput with which to run inference, or the prompt resource to use in inference. The value depends on the resource that you use:</p>
      *          <ul>
      *             <li>
      *                <p>If you use a base model, specify the model ID or its ARN. For a list of model IDs for base models, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-ids.html#model-ids-arns">Amazon Bedrock base model IDs (on-demand throughput)</a> in the Amazon Bedrock User Guide.</p>
@@ -1825,6 +1938,9 @@ export interface ConverseStreamRequest {
      *             <li>
      *                <p>If you use a custom model, first purchase Provisioned Throughput for it. Then specify the ARN of the resulting provisioned model. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-customization-use.html">Use a custom model in Amazon Bedrock</a> in the Amazon Bedrock User Guide.</p>
      *             </li>
+     *             <li>
+     *                <p>To include a prompt that was defined in Prompt management, specify the ARN of the prompt version to use.</p>
+     *             </li>
      *          </ul>
      *          <p>The Converse API doesn't support <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-customization-import-model.html">imported models</a>.</p>
      * @public
@@ -1834,19 +1950,19 @@ export interface ConverseStreamRequest {
      * <p>The messages that you want to send to the model.</p>
      * @public
      */
-    messages: Message[] | undefined;
+    messages?: Message[] | undefined;
     /**
-     * <p>A system prompt to send to the model.</p>
+     * <p>A prompt that provides instructions or context to the model about the task it should perform, or the persona it should adopt during the conversation.</p>
      * @public
      */
-    system?: SystemContentBlock[];
+    system?: SystemContentBlock[] | undefined;
     /**
-     * <p>Inference parameters to pass to the model. <code>ConverseStream</code> supports a base
+     * <p>Inference parameters to pass to the model. <code>Converse</code> and <code>ConverseStream</code> support a base
      *          set of inference parameters. If you need to pass additional parameters that the model
      *          supports, use the <code>additionalModelRequestFields</code> request field.</p>
      * @public
      */
-    inferenceConfig?: InferenceConfiguration;
+    inferenceConfig?: InferenceConfiguration | undefined;
     /**
      * <p>Configuration information for the tools that the model can use when generating a response.</p>
      *          <note>
@@ -1854,22 +1970,27 @@ export interface ConverseStreamRequest {
      *          </note>
      * @public
      */
-    toolConfig?: ToolConfiguration;
+    toolConfig?: ToolConfiguration | undefined;
     /**
-     * <p>Configuration information for a guardrail that you want to use in the request. </p>
+     * <p>Configuration information for a guardrail that you want to use in the request. If you include <code>guardContent</code> blocks in the <code>content</code> field in the <code>messages</code> field, the guardrail operates only on those messages. If you include no <code>guardContent</code> blocks, the guardrail operates on all messages in the request body and in any included prompt resource.</p>
      * @public
      */
-    guardrailConfig?: GuardrailStreamConfiguration;
+    guardrailConfig?: GuardrailStreamConfiguration | undefined;
     /**
      * <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>
-     *          field.</p>
+     *          base set of inference parameters that <code>Converse</code> and <code>ConverseStream</code> support in the <code>inferenceConfig</code>
+     *          field. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html">Model parameters</a>.</p>
      * @public
      */
-    additionalModelRequestFields?: __DocumentType;
+    additionalModelRequestFields?: __DocumentType | undefined;
+    /**
+     * <p>Contains a map of variables in a prompt from Prompt management to objects containing the values to fill in for them when running model invocation. This field is ignored if you don't specify a prompt resource in the <code>modelId</code> field.</p>
+     * @public
+     */
+    promptVariables?: Record<string, PromptVariableValues> | undefined;
     /**
      * <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
+     *          response. <code>Converse</code> and <code>ConverseStream</code> return the requested fields as a JSON Pointer object in the
      *          <code>additionalModelResponseFields</code> field. The following is example JSON for <code>additionalModelResponseFieldPaths</code>.</p>
      *          <p>
      *             <code>[
@@ -1877,14 +1998,14 @@ export interface ConverseStreamRequest {
      *          ]</code>
      *          </p>
      *          <p>For information about the JSON Pointer syntax, see the
-     *          <a href="https://datatracker.ietf.org/doc/html/rfc6901">Internet Engineering Task Force (IETF)</a> documentation.</p>
+     *         <a href="https://datatracker.ietf.org/doc/html/rfc6901">Internet Engineering Task Force (IETF)</a> documentation.</p>
      *          <p>
-     *             <code>ConverseStream</code> rejects an empty JSON Pointer or incorrectly structured
+     *             <code>Converse</code> and <code>ConverseStream</code> reject an empty JSON Pointer or incorrectly structured
      *          JSON Pointer with a <code>400</code> error code. if the JSON Pointer is valid, but the requested
-     *          field is not in the model response, it is ignored by <code>ConverseStream</code>.</p>
+     *          field is not in the model response, it is ignored by <code>Converse</code>.</p>
      * @public
      */
-    additionalModelResponseFieldPaths?: string[];
+    additionalModelResponseFieldPaths?: string[] | undefined;
 }
 /**
  * <p>The delta for a tool use block.</p>
@@ -2053,7 +2174,7 @@ export interface MessageStopEvent {
      * <p>The additional model response fields.</p>
      * @public
      */
-    additionalModelResponseFields?: __DocumentType;
+    additionalModelResponseFields?: __DocumentType | undefined;
 }
 /**
  * <p>Metrics for the stream.</p>
@@ -2075,7 +2196,7 @@ export interface ConverseStreamTrace {
      * <p>The guardrail trace object. </p>
      * @public
      */
-    guardrail?: GuardrailTraceAssessment;
+    guardrail?: GuardrailTraceAssessment | undefined;
 }
 /**
  * <p>A conversation stream metadata event.</p>
@@ -2096,7 +2217,7 @@ export interface ConverseStreamMetadataEvent {
      * <p>The trace object in the response from <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_ConverseStream.html">ConverseStream</a> that contains information about the guardrail behavior.</p>
      * @public
      */
-    trace?: ConverseStreamTrace;
+    trace?: ConverseStreamTrace | undefined;
 }
 /**
  * <p>An error occurred while streaming the response. Retry your request.</p>
@@ -2109,12 +2230,12 @@ export declare class ModelStreamErrorException extends __BaseException {
      * <p>The original status code.</p>
      * @public
      */
-    originalStatusCode?: number;
+    originalStatusCode?: number | undefined;
     /**
      * <p>The original message.</p>
      * @public
      */
-    originalMessage?: string;
+    originalMessage?: string | undefined;
     /**
      * @internal
      */
@@ -2368,7 +2489,7 @@ export interface ConverseStreamResponse {
      * <p>The output stream that the model generated.</p>
      * @public
      */
-    stream?: AsyncIterable<ConverseStreamOutput>;
+    stream?: AsyncIterable<ConverseStreamOutput> | undefined;
 }
 /**
  * @public
@@ -2390,18 +2511,18 @@ export interface InvokeModelRequest {
      * <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;
+    body?: Uint8Array | undefined;
     /**
      * <p>The MIME type of the input data in the request. You must specify
      *             <code>application/json</code>.</p>
      * @public
      */
-    contentType?: string;
+    contentType?: string | undefined;
     /**
      * <p>The desired MIME type of the inference body in the response. The default value is <code>application/json</code>.</p>
      * @public
      */
-    accept?: string;
+    accept?: string | undefined;
     /**
      * <p>The unique identifier of the model to invoke to run inference.</p>
      *          <p>The <code>modelId</code> to provide depends on the type of model that you use:</p>
@@ -2426,7 +2547,7 @@ export interface InvokeModelRequest {
      * <p>Specifies whether to enable or disable the Bedrock trace. If enabled, you can see the full Bedrock trace.</p>
      * @public
      */
-    trace?: Trace;
+    trace?: Trace | undefined;
     /**
      * <p>The unique identifier of the guardrail that you want to use. If you don't provide a value, no guardrail is applied
      *             to the invocation.</p>
@@ -2444,12 +2565,12 @@ export interface InvokeModelRequest {
      *          </ul>
      * @public
      */
-    guardrailIdentifier?: string;
+    guardrailIdentifier?: string | undefined;
     /**
      * <p>The version number for the guardrail. The value can also be <code>DRAFT</code>.</p>
      * @public
      */
-    guardrailVersion?: string;
+    guardrailVersion?: string | undefined;
 }
 /**
  * @public
@@ -2474,19 +2595,19 @@ export interface InvokeModelWithResponseStreamRequest {
      * <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;
+    body?: Uint8Array | undefined;
     /**
      * <p>The MIME type of the input data in the request. You must specify
      *             <code>application/json</code>.</p>
      * @public
      */
-    contentType?: string;
+    contentType?: string | undefined;
     /**
      * <p>The desired MIME type of the inference body in the response. The default value is
      *             <code>application/json</code>.</p>
      * @public
      */
-    accept?: string;
+    accept?: string | undefined;
     /**
      * <p>The unique identifier of the model to invoke to run inference.</p>
      *          <p>The <code>modelId</code> to provide depends on the type of model that you use:</p>
@@ -2511,7 +2632,7 @@ export interface InvokeModelWithResponseStreamRequest {
      * <p>Specifies whether to enable or disable the Bedrock trace. If enabled, you can see the full Bedrock trace.</p>
      * @public
      */
-    trace?: Trace;
+    trace?: Trace | undefined;
     /**
      * <p>The unique identifier of the guardrail that you want to use. If you don't provide a value, no guardrail is applied
      *             to the invocation.</p>
@@ -2529,12 +2650,12 @@ export interface InvokeModelWithResponseStreamRequest {
      *          </ul>
      * @public
      */
-    guardrailIdentifier?: string;
+    guardrailIdentifier?: string | undefined;
     /**
      * <p>The version number for the guardrail. The value can also be <code>DRAFT</code>.</p>
      * @public
      */
-    guardrailVersion?: string;
+    guardrailVersion?: string | undefined;
 }
 /**
  * <p>Payload content included in the response.</p>
@@ -2545,7 +2666,7 @@ export interface PayloadPart {
      * <p>Base64-encoded bytes of payload data.</p>
      * @public
      */
-    bytes?: Uint8Array;
+    bytes?: Uint8Array | undefined;
 }
 /**
  * <p>Definition of content in the response stream.</p>
@@ -2694,6 +2815,14 @@ export interface InvokeModelWithResponseStreamResponse {
      */
     contentType: string | undefined;
 }
+/**
+ * @internal
+ */
+export declare const ConverseRequestFilterSensitiveLog: (obj: ConverseRequest) => any;
+/**
+ * @internal
+ */
+export declare const ConverseStreamRequestFilterSensitiveLog: (obj: ConverseStreamRequest) => any;
 /**
  * @internal
  */