@aws-amplify/graphql-api-construct 1.12.0 → 1.12.1-async-lambda.0

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

@@ -0,0 +1,2728 @@
+import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
+import { DocumentType as __DocumentType } from "@smithy/types";
+import { BedrockRuntimeServiceException as __BaseException } from "./BedrockRuntimeServiceException";
+/**
+ * <p>The request is denied because of missing access permissions.</p>
+ * @public
+ */
+export declare class AccessDeniedException extends __BaseException {
+    readonly name: "AccessDeniedException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
+}
+/**
+ * @public
+ * @enum
+ */
+export declare const GuardrailContentQualifier: {
+    readonly GROUNDING_SOURCE: "grounding_source";
+    readonly GUARD_CONTENT: "guard_content";
+    readonly QUERY: "query";
+};
+/**
+ * @public
+ */
+export type GuardrailContentQualifier = (typeof GuardrailContentQualifier)[keyof typeof GuardrailContentQualifier];
+/**
+ * <p>The text block to be evaluated by the guardrail.</p>
+ * @public
+ */
+export interface GuardrailTextBlock {
+    /**
+     * <p>The input text details to be evaluated by the guardrail.</p>
+     * @public
+     */
+    text: string | undefined;
+    /**
+     * <p>The qualifiers describing the text block.</p>
+     * @public
+     */
+    qualifiers?: GuardrailContentQualifier[];
+}
+/**
+ * <p>The content block to be evaluated by the guardrail.</p>
+ * @public
+ */
+export type GuardrailContentBlock = GuardrailContentBlock.TextMember | GuardrailContentBlock.$UnknownMember;
+/**
+ * @public
+ */
+export declare namespace GuardrailContentBlock {
+    /**
+     * <p>Text within content block to be evaluated by the guardrail.</p>
+     * @public
+     */
+    interface TextMember {
+        text: GuardrailTextBlock;
+        $unknown?: never;
+    }
+    /**
+     * @public
+     */
+    interface $UnknownMember {
+        text?: never;
+        $unknown: [string, any];
+    }
+    interface Visitor<T> {
+        text: (value: GuardrailTextBlock) => T;
+        _: (name: string, value: any) => T;
+    }
+    const visit: <T>(value: GuardrailContentBlock, visitor: Visitor<T>) => T;
+}
+/**
+ * @public
+ * @enum
+ */
+export declare const GuardrailContentSource: {
+    readonly INPUT: "INPUT";
+    readonly OUTPUT: "OUTPUT";
+};
+/**
+ * @public
+ */
+export type GuardrailContentSource = (typeof GuardrailContentSource)[keyof typeof GuardrailContentSource];
+/**
+ * @public
+ */
+export interface ApplyGuardrailRequest {
+    /**
+     * <p>The guardrail identifier used in the request to apply the guardrail.</p>
+     * @public
+     */
+    guardrailIdentifier: string | undefined;
+    /**
+     * <p>The guardrail version used in the request to apply the guardrail.</p>
+     * @public
+     */
+    guardrailVersion: string | undefined;
+    /**
+     * <p>The source of data used in the request to apply the guardrail.</p>
+     * @public
+     */
+    source: GuardrailContentSource | undefined;
+    /**
+     * <p>The content details used in the request to apply the guardrail.</p>
+     * @public
+     */
+    content: GuardrailContentBlock[] | undefined;
+}
+/**
+ * @public
+ * @enum
+ */
+export declare const GuardrailAction: {
+    readonly GUARDRAIL_INTERVENED: "GUARDRAIL_INTERVENED";
+    readonly NONE: "NONE";
+};
+/**
+ * @public
+ */
+export type GuardrailAction = (typeof GuardrailAction)[keyof typeof GuardrailAction];
+/**
+ * @public
+ * @enum
+ */
+export declare const GuardrailContentPolicyAction: {
+    readonly BLOCKED: "BLOCKED";
+};
+/**
+ * @public
+ */
+export type GuardrailContentPolicyAction = (typeof GuardrailContentPolicyAction)[keyof typeof GuardrailContentPolicyAction];
+/**
+ * @public
+ * @enum
+ */
+export declare const GuardrailContentFilterConfidence: {
+    readonly HIGH: "HIGH";
+    readonly LOW: "LOW";
+    readonly MEDIUM: "MEDIUM";
+    readonly NONE: "NONE";
+};
+/**
+ * @public
+ */
+export type GuardrailContentFilterConfidence = (typeof GuardrailContentFilterConfidence)[keyof typeof GuardrailContentFilterConfidence];
+/**
+ * @public
+ * @enum
+ */
+export declare const GuardrailContentFilterType: {
+    readonly HATE: "HATE";
+    readonly INSULTS: "INSULTS";
+    readonly MISCONDUCT: "MISCONDUCT";
+    readonly PROMPT_ATTACK: "PROMPT_ATTACK";
+    readonly SEXUAL: "SEXUAL";
+    readonly VIOLENCE: "VIOLENCE";
+};
+/**
+ * @public
+ */
+export type GuardrailContentFilterType = (typeof GuardrailContentFilterType)[keyof typeof GuardrailContentFilterType];
+/**
+ * <p>The content filter for a guardrail.</p>
+ * @public
+ */
+export interface GuardrailContentFilter {
+    /**
+     * <p>The guardrail type.</p>
+     * @public
+     */
+    type: GuardrailContentFilterType | undefined;
+    /**
+     * <p>The guardrail confidence.</p>
+     * @public
+     */
+    confidence: GuardrailContentFilterConfidence | undefined;
+    /**
+     * <p>The guardrail action.</p>
+     * @public
+     */
+    action: GuardrailContentPolicyAction | undefined;
+}
+/**
+ * <p>An assessment of a content policy for a guardrail.</p>
+ * @public
+ */
+export interface GuardrailContentPolicyAssessment {
+    /**
+     * <p>The content policy filters.</p>
+     * @public
+     */
+    filters: GuardrailContentFilter[] | undefined;
+}
+/**
+ * @public
+ * @enum
+ */
+export declare const GuardrailContextualGroundingPolicyAction: {
+    readonly BLOCKED: "BLOCKED";
+    readonly NONE: "NONE";
+};
+/**
+ * @public
+ */
+export type GuardrailContextualGroundingPolicyAction = (typeof GuardrailContextualGroundingPolicyAction)[keyof typeof GuardrailContextualGroundingPolicyAction];
+/**
+ * @public
+ * @enum
+ */
+export declare const GuardrailContextualGroundingFilterType: {
+    readonly GROUNDING: "GROUNDING";
+    readonly RELEVANCE: "RELEVANCE";
+};
+/**
+ * @public
+ */
+export type GuardrailContextualGroundingFilterType = (typeof GuardrailContextualGroundingFilterType)[keyof typeof GuardrailContextualGroundingFilterType];
+/**
+ * <p>The details for the guardrails contextual grounding filter.</p>
+ * @public
+ */
+export interface GuardrailContextualGroundingFilter {
+    /**
+     * <p>The contextual grounding filter type.</p>
+     * @public
+     */
+    type: GuardrailContextualGroundingFilterType | undefined;
+    /**
+     * <p>The threshold used by contextual grounding filter to determine whether the content is grounded or not.</p>
+     * @public
+     */
+    threshold: number | undefined;
+    /**
+     * <p>The score generated by contextual grounding filter.</p>
+     * @public
+     */
+    score: number | undefined;
+    /**
+     * <p>The action performed by the guardrails contextual grounding filter.</p>
+     * @public
+     */
+    action: GuardrailContextualGroundingPolicyAction | undefined;
+}
+/**
+ * <p>The policy assessment details for the guardrails contextual grounding filter.</p>
+ * @public
+ */
+export interface GuardrailContextualGroundingPolicyAssessment {
+    /**
+     * <p>The filter details for the guardrails contextual grounding filter.</p>
+     * @public
+     */
+    filters?: GuardrailContextualGroundingFilter[];
+}
+/**
+ * @public
+ * @enum
+ */
+export declare const GuardrailSensitiveInformationPolicyAction: {
+    readonly ANONYMIZED: "ANONYMIZED";
+    readonly BLOCKED: "BLOCKED";
+};
+/**
+ * @public
+ */
+export type GuardrailSensitiveInformationPolicyAction = (typeof GuardrailSensitiveInformationPolicyAction)[keyof typeof GuardrailSensitiveInformationPolicyAction];
+/**
+ * @public
+ * @enum
+ */
+export declare const GuardrailPiiEntityType: {
+    readonly ADDRESS: "ADDRESS";
+    readonly AGE: "AGE";
+    readonly AWS_ACCESS_KEY: "AWS_ACCESS_KEY";
+    readonly AWS_SECRET_KEY: "AWS_SECRET_KEY";
+    readonly CA_HEALTH_NUMBER: "CA_HEALTH_NUMBER";
+    readonly CA_SOCIAL_INSURANCE_NUMBER: "CA_SOCIAL_INSURANCE_NUMBER";
+    readonly CREDIT_DEBIT_CARD_CVV: "CREDIT_DEBIT_CARD_CVV";
+    readonly CREDIT_DEBIT_CARD_EXPIRY: "CREDIT_DEBIT_CARD_EXPIRY";
+    readonly CREDIT_DEBIT_CARD_NUMBER: "CREDIT_DEBIT_CARD_NUMBER";
+    readonly DRIVER_ID: "DRIVER_ID";
+    readonly EMAIL: "EMAIL";
+    readonly INTERNATIONAL_BANK_ACCOUNT_NUMBER: "INTERNATIONAL_BANK_ACCOUNT_NUMBER";
+    readonly IP_ADDRESS: "IP_ADDRESS";
+    readonly LICENSE_PLATE: "LICENSE_PLATE";
+    readonly MAC_ADDRESS: "MAC_ADDRESS";
+    readonly NAME: "NAME";
+    readonly PASSWORD: "PASSWORD";
+    readonly PHONE: "PHONE";
+    readonly PIN: "PIN";
+    readonly SWIFT_CODE: "SWIFT_CODE";
+    readonly UK_NATIONAL_HEALTH_SERVICE_NUMBER: "UK_NATIONAL_HEALTH_SERVICE_NUMBER";
+    readonly UK_NATIONAL_INSURANCE_NUMBER: "UK_NATIONAL_INSURANCE_NUMBER";
+    readonly UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER: "UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER";
+    readonly URL: "URL";
+    readonly USERNAME: "USERNAME";
+    readonly US_BANK_ACCOUNT_NUMBER: "US_BANK_ACCOUNT_NUMBER";
+    readonly US_BANK_ROUTING_NUMBER: "US_BANK_ROUTING_NUMBER";
+    readonly US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER: "US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER";
+    readonly US_PASSPORT_NUMBER: "US_PASSPORT_NUMBER";
+    readonly US_SOCIAL_SECURITY_NUMBER: "US_SOCIAL_SECURITY_NUMBER";
+    readonly VEHICLE_IDENTIFICATION_NUMBER: "VEHICLE_IDENTIFICATION_NUMBER";
+};
+/**
+ * @public
+ */
+export type GuardrailPiiEntityType = (typeof GuardrailPiiEntityType)[keyof typeof GuardrailPiiEntityType];
+/**
+ * <p>A Personally Identifiable Information (PII) entity configured in a guardrail.</p>
+ * @public
+ */
+export interface GuardrailPiiEntityFilter {
+    /**
+     * <p>The PII entity filter match.</p>
+     * @public
+     */
+    match: string | undefined;
+    /**
+     * <p>The PII entity filter type.</p>
+     * @public
+     */
+    type: GuardrailPiiEntityType | undefined;
+    /**
+     * <p>The PII entity filter action.</p>
+     * @public
+     */
+    action: GuardrailSensitiveInformationPolicyAction | undefined;
+}
+/**
+ * <p>A Regex filter configured in a guardrail.</p>
+ * @public
+ */
+export interface GuardrailRegexFilter {
+    /**
+     * <p>The regex filter name.</p>
+     * @public
+     */
+    name?: string;
+    /**
+     * <p>The regesx filter match.</p>
+     * @public
+     */
+    match?: string;
+    /**
+     * <p>The regex query.</p>
+     * @public
+     */
+    regex?: string;
+    /**
+     * <p>The region filter action.</p>
+     * @public
+     */
+    action: GuardrailSensitiveInformationPolicyAction | undefined;
+}
+/**
+ * <p>The assessment for aPersonally Identifiable Information (PII) policy. </p>
+ * @public
+ */
+export interface GuardrailSensitiveInformationPolicyAssessment {
+    /**
+     * <p>The PII entities in the assessment.</p>
+     * @public
+     */
+    piiEntities: GuardrailPiiEntityFilter[] | undefined;
+    /**
+     * <p>The regex queries in the assessment.</p>
+     * @public
+     */
+    regexes: GuardrailRegexFilter[] | undefined;
+}
+/**
+ * @public
+ * @enum
+ */
+export declare const GuardrailTopicPolicyAction: {
+    readonly BLOCKED: "BLOCKED";
+};
+/**
+ * @public
+ */
+export type GuardrailTopicPolicyAction = (typeof GuardrailTopicPolicyAction)[keyof typeof GuardrailTopicPolicyAction];
+/**
+ * @public
+ * @enum
+ */
+export declare const GuardrailTopicType: {
+    readonly DENY: "DENY";
+};
+/**
+ * @public
+ */
+export type GuardrailTopicType = (typeof GuardrailTopicType)[keyof typeof GuardrailTopicType];
+/**
+ * <p>Information about a topic guardrail.</p>
+ * @public
+ */
+export interface GuardrailTopic {
+    /**
+     * <p>The name for the guardrail.</p>
+     * @public
+     */
+    name: string | undefined;
+    /**
+     * <p>The type behavior that the guardrail should perform when the model detects the topic.</p>
+     * @public
+     */
+    type: GuardrailTopicType | undefined;
+    /**
+     * <p>The action the guardrail should take when it intervenes on a topic.</p>
+     * @public
+     */
+    action: GuardrailTopicPolicyAction | undefined;
+}
+/**
+ * <p>A behavior assessment of a topic policy.</p>
+ * @public
+ */
+export interface GuardrailTopicPolicyAssessment {
+    /**
+     * <p>The topics in the assessment.</p>
+     * @public
+     */
+    topics: GuardrailTopic[] | undefined;
+}
+/**
+ * @public
+ * @enum
+ */
+export declare const GuardrailWordPolicyAction: {
+    readonly BLOCKED: "BLOCKED";
+};
+/**
+ * @public
+ */
+export type GuardrailWordPolicyAction = (typeof GuardrailWordPolicyAction)[keyof typeof GuardrailWordPolicyAction];
+/**
+ * <p>A custom word configured in a guardrail.</p>
+ * @public
+ */
+export interface GuardrailCustomWord {
+    /**
+     * <p>The match for the custom word.</p>
+     * @public
+     */
+    match: string | undefined;
+    /**
+     * <p>The action for the custom word.</p>
+     * @public
+     */
+    action: GuardrailWordPolicyAction | undefined;
+}
+/**
+ * @public
+ * @enum
+ */
+export declare const GuardrailManagedWordType: {
+    readonly PROFANITY: "PROFANITY";
+};
+/**
+ * @public
+ */
+export type GuardrailManagedWordType = (typeof GuardrailManagedWordType)[keyof typeof GuardrailManagedWordType];
+/**
+ * <p>A managed word configured in a guardrail.</p>
+ * @public
+ */
+export interface GuardrailManagedWord {
+    /**
+     * <p>The match for the managed word.</p>
+     * @public
+     */
+    match: string | undefined;
+    /**
+     * <p>The type for the managed word.</p>
+     * @public
+     */
+    type: GuardrailManagedWordType | undefined;
+    /**
+     * <p>The action for the managed word.</p>
+     * @public
+     */
+    action: GuardrailWordPolicyAction | undefined;
+}
+/**
+ * <p>The word policy assessment.</p>
+ * @public
+ */
+export interface GuardrailWordPolicyAssessment {
+    /**
+     * <p>Custom words in the assessment.</p>
+     * @public
+     */
+    customWords: GuardrailCustomWord[] | undefined;
+    /**
+     * <p>Managed word lists in the assessment.</p>
+     * @public
+     */
+    managedWordLists: GuardrailManagedWord[] | undefined;
+}
+/**
+ * <p>A behavior assessment of the guardrail policies used in a call to the Converse API. </p>
+ * @public
+ */
+export interface GuardrailAssessment {
+    /**
+     * <p>The topic policy.</p>
+     * @public
+     */
+    topicPolicy?: GuardrailTopicPolicyAssessment;
+    /**
+     * <p>The content policy.</p>
+     * @public
+     */
+    contentPolicy?: GuardrailContentPolicyAssessment;
+    /**
+     * <p>The word policy.</p>
+     * @public
+     */
+    wordPolicy?: GuardrailWordPolicyAssessment;
+    /**
+     * <p>The sensitive information policy.</p>
+     * @public
+     */
+    sensitiveInformationPolicy?: GuardrailSensitiveInformationPolicyAssessment;
+    /**
+     * <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 {
+    /**
+     * <p>The specific text for the output content produced by the guardrail.</p>
+     * @public
+     */
+    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
+ */
+export interface ApplyGuardrailResponse {
+    /**
+     * <p>The usage details in the response from the guardrail.</p>
+     * @public
+     */
+    usage: GuardrailUsage | undefined;
+    /**
+     * <p>The action taken in the response from the guardrail.</p>
+     * @public
+     */
+    action: GuardrailAction | undefined;
+    /**
+     * <p>The output details in the response from the guardrail.</p>
+     * @public
+     */
+    outputs: GuardrailOutputContent[] | undefined;
+    /**
+     * <p>The assessment details in the response from the guardrail.</p>
+     * @public
+     */
+    assessments: GuardrailAssessment[] | undefined;
+}
+/**
+ * <p>An internal server error occurred. Retry your request.</p>
+ * @public
+ */
+export declare class InternalServerException extends __BaseException {
+    readonly name: "InternalServerException";
+    readonly $fault: "server";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
+}
+/**
+ * <p>The specified resource ARN was not found. Check the ARN and try your request again.</p>
+ * @public
+ */
+export declare class ResourceNotFoundException extends __BaseException {
+    readonly name: "ResourceNotFoundException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
+}
+/**
+ * <p>Your request exceeds the service quota for your account. You can view your quotas at <a href="https://docs.aws.amazon.com/servicequotas/latest/userguide/gs-request-quota.html">Viewing service quotas</a>. You can resubmit your request later.</p>
+ * @public
+ */
+export declare class ServiceQuotaExceededException extends __BaseException {
+    readonly name: "ServiceQuotaExceededException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
+}
+/**
+ * <p>Your request was throttled because of service-wide limitations. Resubmit your request later or in a different region. You can also purchase <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/prov-throughput.html">Provisioned Throughput</a> to increase the rate or number of tokens you can process.</p>
+ * @public
+ */
+export declare class ThrottlingException extends __BaseException {
+    readonly name: "ThrottlingException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
+}
+/**
+ * <p>Input validation failed. Check your request parameters and retry the request.</p>
+ * @public
+ */
+export declare class ValidationException extends __BaseException {
+    readonly name: "ValidationException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
+}
+/**
+ * @public
+ * @enum
+ */
+export declare const GuardrailTrace: {
+    readonly DISABLED: "disabled";
+    readonly ENABLED: "enabled";
+};
+/**
+ * @public
+ */
+export type GuardrailTrace = (typeof GuardrailTrace)[keyof typeof GuardrailTrace];
+/**
+ * <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
+ */
+export interface GuardrailConfiguration {
+    /**
+     * <p>The identifier for the guardrail.</p>
+     * @public
+     */
+    guardrailIdentifier: string | undefined;
+    /**
+     * <p>The version of the guardrail.</p>
+     * @public
+     */
+    guardrailVersion: string | undefined;
+    /**
+     * <p>The trace behavior for the guardrail.</p>
+     * @public
+     */
+    trace?: GuardrailTrace;
+}
+/**
+ * <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,
+ *          see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html">Inference parameters for foundation models</a>.</p>
+ *          <p>If you need to pass additional parameters that the model
+ *          supports, use the <code>additionalModelRequestFields</code> request field in the call to <code>Converse</code>
+ *          or <code>ConverseStream</code>.
+ *          For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html">Model parameters</a>.</p>
+ * @public
+ */
+export interface InferenceConfiguration {
+    /**
+     * <p>The maximum number of tokens to allow in the generated response. The default value is
+     *          the maximum allowed value for the model that you are using. For more information, see
+     *             <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html">Inference parameters for foundation models</a>. </p>
+     * @public
+     */
+    maxTokens?: number;
+    /**
+     * <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,
+     *          while a higher value makes the model more likely to choose lower-probability
+     *          options.</p>
+     *          <p>The default value is the default value for the model that
+     *          you are using. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html">Inference parameters for foundation
+     *             models</a>. </p>
+     * @public
+     */
+    temperature?: number;
+    /**
+     * <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
+     *          probability distribution of tokens that could be next in the sequence.</p>
+     *          <p>The default value is the default value for the model that you are using. For more information, see
+     *          <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html">Inference parameters for foundation models</a>. </p>
+     * @public
+     */
+    topP?: number;
+    /**
+     * <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[];
+}
+/**
+ * @public
+ * @enum
+ */
+export declare const DocumentFormat: {
+    readonly CSV: "csv";
+    readonly DOC: "doc";
+    readonly DOCX: "docx";
+    readonly HTML: "html";
+    readonly MD: "md";
+    readonly PDF: "pdf";
+    readonly TXT: "txt";
+    readonly XLS: "xls";
+    readonly XLSX: "xlsx";
+};
+/**
+ * @public
+ */
+export type DocumentFormat = (typeof DocumentFormat)[keyof typeof DocumentFormat];
+/**
+ * <p>Contains the content of a document.</p>
+ * @public
+ */
+export type DocumentSource = DocumentSource.BytesMember | DocumentSource.$UnknownMember;
+/**
+ * @public
+ */
+export declare namespace DocumentSource {
+    /**
+     * <p>The raw bytes for the document. If you use an Amazon Web Services SDK, you don't need to encode the bytes in base64.</p>
+     * @public
+     */
+    interface BytesMember {
+        bytes: Uint8Array;
+        $unknown?: never;
+    }
+    /**
+     * @public
+     */
+    interface $UnknownMember {
+        bytes?: never;
+        $unknown: [string, any];
+    }
+    interface Visitor<T> {
+        bytes: (value: Uint8Array) => T;
+        _: (name: string, value: any) => T;
+    }
+    const visit: <T>(value: DocumentSource, visitor: Visitor<T>) => T;
+}
+/**
+ * <p>A document to include in a message.</p>
+ * @public
+ */
+export interface DocumentBlock {
+    /**
+     * <p>The format of a document, or its extension.</p>
+     * @public
+     */
+    format: DocumentFormat | undefined;
+    /**
+     * <p>A name for the document. The name can only contain the following characters:</p>
+     *          <ul>
+     *             <li>
+     *                <p>Alphanumeric characters</p>
+     *             </li>
+     *             <li>
+     *                <p>Whitespace characters (no more than one in a row)</p>
+     *             </li>
+     *             <li>
+     *                <p>Hyphens</p>
+     *             </li>
+     *             <li>
+     *                <p>Parentheses</p>
+     *             </li>
+     *             <li>
+     *                <p>Square brackets</p>
+     *             </li>
+     *          </ul>
+     *          <note>
+     *             <p>This field is vulnerable to prompt injections, because the model might inadvertently interpret it as instructions. Therefore, we recommend that you specify a neutral name.</p>
+     *          </note>
+     * @public
+     */
+    name: string | undefined;
+    /**
+     * <p>Contains the content of the document.</p>
+     * @public
+     */
+    source: DocumentSource | undefined;
+}
+/**
+ * @public
+ * @enum
+ */
+export declare const GuardrailConverseContentQualifier: {
+    readonly GROUNDING_SOURCE: "grounding_source";
+    readonly GUARD_CONTENT: "guard_content";
+    readonly QUERY: "query";
+};
+/**
+ * @public
+ */
+export type GuardrailConverseContentQualifier = (typeof GuardrailConverseContentQualifier)[keyof typeof GuardrailConverseContentQualifier];
+/**
+ * <p>A text block that contains text that you want to assess with a guardrail. For more information, see <a>GuardrailConverseContentBlock</a>.</p>
+ * @public
+ */
+export interface GuardrailConverseTextBlock {
+    /**
+     * <p>The text that you want to guard.</p>
+     * @public
+     */
+    text: string | undefined;
+    /**
+     * <p>The qualifier details for the guardrails contextual grounding filter.</p>
+     * @public
+     */
+    qualifiers?: GuardrailConverseContentQualifier[];
+}
+/**
+ * <p/>
+ *          <p>A content block for selective guarding with the <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> API operations.
+ *       </p>
+ * @public
+ */
+export type GuardrailConverseContentBlock = GuardrailConverseContentBlock.TextMember | GuardrailConverseContentBlock.$UnknownMember;
+/**
+ * @public
+ */
+export declare namespace GuardrailConverseContentBlock {
+    /**
+     * <p>The text to guard.</p>
+     * @public
+     */
+    interface TextMember {
+        text: GuardrailConverseTextBlock;
+        $unknown?: never;
+    }
+    /**
+     * @public
+     */
+    interface $UnknownMember {
+        text?: never;
+        $unknown: [string, any];
+    }
+    interface Visitor<T> {
+        text: (value: GuardrailConverseTextBlock) => T;
+        _: (name: string, value: any) => T;
+    }
+    const visit: <T>(value: GuardrailConverseContentBlock, visitor: Visitor<T>) => T;
+}
+/**
+ * @public
+ * @enum
+ */
+export declare const ImageFormat: {
+    readonly GIF: "gif";
+    readonly JPEG: "jpeg";
+    readonly PNG: "png";
+    readonly WEBP: "webp";
+};
+/**
+ * @public
+ */
+export type ImageFormat = (typeof ImageFormat)[keyof typeof ImageFormat];
+/**
+ * <p>The source for an image.</p>
+ * @public
+ */
+export type ImageSource = ImageSource.BytesMember | ImageSource.$UnknownMember;
+/**
+ * @public
+ */
+export declare namespace ImageSource {
+    /**
+     * <p>The raw image bytes for the image. If you use an AWS SDK, you don't need to encode the image bytes in base64.</p>
+     * @public
+     */
+    interface BytesMember {
+        bytes: Uint8Array;
+        $unknown?: never;
+    }
+    /**
+     * @public
+     */
+    interface $UnknownMember {
+        bytes?: never;
+        $unknown: [string, any];
+    }
+    interface Visitor<T> {
+        bytes: (value: Uint8Array) => T;
+        _: (name: string, value: any) => T;
+    }
+    const visit: <T>(value: ImageSource, visitor: Visitor<T>) => T;
+}
+/**
+ * <p>Image content for a message.</p>
+ * @public
+ */
+export interface ImageBlock {
+    /**
+     * <p>The format of the image.</p>
+     * @public
+     */
+    format: ImageFormat | undefined;
+    /**
+     * <p>The source for the image.</p>
+     * @public
+     */
+    source: ImageSource | undefined;
+}
+/**
+ * <p>The tool result content block.</p>
+ * @public
+ */
+export type ToolResultContentBlock = ToolResultContentBlock.DocumentMember | ToolResultContentBlock.ImageMember | ToolResultContentBlock.JsonMember | ToolResultContentBlock.TextMember | ToolResultContentBlock.$UnknownMember;
+/**
+ * @public
+ */
+export declare namespace ToolResultContentBlock {
+    /**
+     * <p>A tool result that is JSON format data.</p>
+     * @public
+     */
+    interface JsonMember {
+        json: __DocumentType;
+        text?: never;
+        image?: never;
+        document?: never;
+        $unknown?: never;
+    }
+    /**
+     * <p>A tool result that is text.</p>
+     * @public
+     */
+    interface TextMember {
+        json?: never;
+        text: string;
+        image?: never;
+        document?: never;
+        $unknown?: never;
+    }
+    /**
+     * <p>A tool result that is an image.</p>
+     *          <note>
+     *             <p>This field is only supported by Anthropic Claude 3 models.</p>
+     *          </note>
+     * @public
+     */
+    interface ImageMember {
+        json?: never;
+        text?: never;
+        image: ImageBlock;
+        document?: never;
+        $unknown?: never;
+    }
+    /**
+     * <p>A tool result that is a document.</p>
+     * @public
+     */
+    interface DocumentMember {
+        json?: never;
+        text?: never;
+        image?: never;
+        document: DocumentBlock;
+        $unknown?: never;
+    }
+    /**
+     * @public
+     */
+    interface $UnknownMember {
+        json?: never;
+        text?: never;
+        image?: never;
+        document?: never;
+        $unknown: [string, any];
+    }
+    interface Visitor<T> {
+        json: (value: __DocumentType) => T;
+        text: (value: string) => T;
+        image: (value: ImageBlock) => T;
+        document: (value: DocumentBlock) => T;
+        _: (name: string, value: any) => T;
+    }
+    const visit: <T>(value: ToolResultContentBlock, visitor: Visitor<T>) => T;
+}
+/**
+ * @public
+ * @enum
+ */
+export declare const ToolResultStatus: {
+    readonly ERROR: "error";
+    readonly SUCCESS: "success";
+};
+/**
+ * @public
+ */
+export type ToolResultStatus = (typeof ToolResultStatus)[keyof typeof ToolResultStatus];
+/**
+ * <p>A tool result block that contains the results for a tool request that
+ *       the model previously made.</p>
+ * @public
+ */
+export interface ToolResultBlock {
+    /**
+     * <p>The ID of the tool request that this is the result for.</p>
+     * @public
+     */
+    toolUseId: string | undefined;
+    /**
+     * <p>The content for tool result content block.</p>
+     * @public
+     */
+    content: ToolResultContentBlock[] | undefined;
+    /**
+     * <p>The status for the tool result content block.</p>
+     *          <note>
+     *             <p>This field is only supported Anthropic Claude 3 models.</p>
+     *          </note>
+     * @public
+     */
+    status?: ToolResultStatus;
+}
+/**
+ * <p>A tool use content block. Contains information about a tool that the model
+ *       is requesting be run., The model uses the result from the tool to generate a response. </p>
+ * @public
+ */
+export interface ToolUseBlock {
+    /**
+     * <p>The ID for the tool request.</p>
+     * @public
+     */
+    toolUseId: string | undefined;
+    /**
+     * <p>The name of the tool that the model wants to use.</p>
+     * @public
+     */
+    name: string | undefined;
+    /**
+     * <p>The input to pass to the tool. </p>
+     * @public
+     */
+    input: __DocumentType | undefined;
+}
+/**
+ * <p>A block of content for a message that you pass to, or receive from, a model with the <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> API operations.</p>
+ * @public
+ */
+export type ContentBlock = ContentBlock.DocumentMember | ContentBlock.GuardContentMember | ContentBlock.ImageMember | ContentBlock.TextMember | ContentBlock.ToolResultMember | ContentBlock.ToolUseMember | ContentBlock.$UnknownMember;
+/**
+ * @public
+ */
+export declare namespace ContentBlock {
+    /**
+     * <p>Text to include in the message.</p>
+     * @public
+     */
+    interface TextMember {
+        text: string;
+        image?: never;
+        document?: never;
+        toolUse?: never;
+        toolResult?: never;
+        guardContent?: never;
+        $unknown?: never;
+    }
+    /**
+     * <p>Image to include in the message. </p>
+     *          <note>
+     *             <p>This field is only supported by Anthropic Claude 3 models.</p>
+     *          </note>
+     * @public
+     */
+    interface ImageMember {
+        text?: never;
+        image: ImageBlock;
+        document?: never;
+        toolUse?: never;
+        toolResult?: never;
+        guardContent?: never;
+        $unknown?: never;
+    }
+    /**
+     * <p>A document to include in the message.</p>
+     * @public
+     */
+    interface DocumentMember {
+        text?: never;
+        image?: never;
+        document: DocumentBlock;
+        toolUse?: never;
+        toolResult?: never;
+        guardContent?: never;
+        $unknown?: never;
+    }
+    /**
+     * <p>Information about a tool use request from a model.</p>
+     * @public
+     */
+    interface ToolUseMember {
+        text?: never;
+        image?: never;
+        document?: never;
+        toolUse: ToolUseBlock;
+        toolResult?: never;
+        guardContent?: never;
+        $unknown?: never;
+    }
+    /**
+     * <p>The result for a tool request that a model makes.</p>
+     * @public
+     */
+    interface ToolResultMember {
+        text?: never;
+        image?: never;
+        document?: never;
+        toolUse?: never;
+        toolResult: ToolResultBlock;
+        guardContent?: never;
+        $unknown?: never;
+    }
+    /**
+     * <p>Contains the content to assess with the guardrail. If you don't specify
+     *             <code>guardContent</code> in a call to the Converse API, the guardrail (if passed in the
+     *          Converse API) assesses the entire message.</p>
+     *          <p>For more information, see  <i>Use a guardrail with the Converse API</i> in the <i>Amazon Bedrock User Guide</i>.
+     *
+     *       </p>
+     * @public
+     */
+    interface GuardContentMember {
+        text?: never;
+        image?: never;
+        document?: never;
+        toolUse?: never;
+        toolResult?: never;
+        guardContent: GuardrailConverseContentBlock;
+        $unknown?: never;
+    }
+    /**
+     * @public
+     */
+    interface $UnknownMember {
+        text?: never;
+        image?: never;
+        document?: never;
+        toolUse?: never;
+        toolResult?: never;
+        guardContent?: never;
+        $unknown: [string, any];
+    }
+    interface Visitor<T> {
+        text: (value: string) => T;
+        image: (value: ImageBlock) => T;
+        document: (value: DocumentBlock) => T;
+        toolUse: (value: ToolUseBlock) => T;
+        toolResult: (value: ToolResultBlock) => T;
+        guardContent: (value: GuardrailConverseContentBlock) => T;
+        _: (name: string, value: any) => T;
+    }
+    const visit: <T>(value: ContentBlock, visitor: Visitor<T>) => T;
+}
+/**
+ * @public
+ * @enum
+ */
+export declare const ConversationRole: {
+    readonly ASSISTANT: "assistant";
+    readonly USER: "user";
+};
+/**
+ * @public
+ */
+export type ConversationRole = (typeof ConversationRole)[keyof typeof ConversationRole];
+/**
+ * <p>A message input, or returned from, 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>.</p>
+ * @public
+ */
+export interface Message {
+    /**
+     * <p>The role that the message plays in the message.</p>
+     * @public
+     */
+    role: ConversationRole | undefined;
+    /**
+     * <p>The message content. Note the following restrictions:</p>
+     *          <ul>
+     *             <li>
+     *                <p>You can include up to 20 images. Each image's size, height, and width must be no more than 3.75 MB, 8000 px, and 8000 px, respectively.</p>
+     *             </li>
+     *             <li>
+     *                <p>You can include up to five documents. Each document's size must be no more than 4.5 MB.</p>
+     *             </li>
+     *             <li>
+     *                <p>If you include a <code>ContentBlock</code> with a <code>document</code> field in the array, you must also include a <code>ContentBlock</code> with a <code>text</code> field.</p>
+     *             </li>
+     *             <li>
+     *                <p>You can only include images and documents if the <code>role</code> is <code>user</code>.</p>
+     *             </li>
+     *          </ul>
+     * @public
+     */
+    content: ContentBlock[] | undefined;
+}
+/**
+ * <p>A system content block.</p>
+ * @public
+ */
+export type SystemContentBlock = SystemContentBlock.GuardContentMember | SystemContentBlock.TextMember | SystemContentBlock.$UnknownMember;
+/**
+ * @public
+ */
+export declare namespace SystemContentBlock {
+    /**
+     * <p>A system prompt for the model. </p>
+     * @public
+     */
+    interface TextMember {
+        text: string;
+        guardContent?: never;
+        $unknown?: never;
+    }
+    /**
+     * <p>A content block to assess with the guardrail. Use with the <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> API operations. </p>
+     *          <p>For more information, see <i>Use a guardrail with the Converse
+     *             API</i> in the <i>Amazon Bedrock User Guide</i>.</p>
+     * @public
+     */
+    interface GuardContentMember {
+        text?: never;
+        guardContent: GuardrailConverseContentBlock;
+        $unknown?: never;
+    }
+    /**
+     * @public
+     */
+    interface $UnknownMember {
+        text?: never;
+        guardContent?: never;
+        $unknown: [string, any];
+    }
+    interface Visitor<T> {
+        text: (value: string) => T;
+        guardContent: (value: GuardrailConverseContentBlock) => T;
+        _: (name: string, value: any) => T;
+    }
+    const visit: <T>(value: SystemContentBlock, visitor: Visitor<T>) => T;
+}
+/**
+ * <p>The model must request at least one tool (no text is generated). For example, <code>\{"any" : \{\}\}</code>.</p>
+ * @public
+ */
+export interface AnyToolChoice {
+}
+/**
+ * <p>The Model automatically decides if a tool should be called or whether to generate text instead.
+ *          For example, <code>\{"auto" : \{\}\}</code>.</p>
+ * @public
+ */
+export interface AutoToolChoice {
+}
+/**
+ * <p>The model must request a specific tool.  For example, <code>\{"tool" : \{"name" : "Your tool name"\}\}</code>.</p>
+ *          <note>
+ *             <p>This field is only supported by Anthropic Claude 3 models.</p>
+ *          </note>
+ * @public
+ */
+export interface SpecificToolChoice {
+    /**
+     * <p>The name of the tool that the model must request. </p>
+     * @public
+     */
+    name: string | undefined;
+}
+/**
+ * <p>Determines which tools the model should request in a call to <code>Converse</code> or <code>ConverseStream</code>.
+ *          <code>ToolChoice</code> is only supported by
+ *       Anthropic Claude 3 models and by Mistral AI Mistral Large.</p>
+ * @public
+ */
+export type ToolChoice = ToolChoice.AnyMember | ToolChoice.AutoMember | ToolChoice.ToolMember | ToolChoice.$UnknownMember;
+/**
+ * @public
+ */
+export declare namespace ToolChoice {
+    /**
+     * <p>(Default). The Model automatically decides if a tool should be called or whether to generate text instead. </p>
+     * @public
+     */
+    interface AutoMember {
+        auto: AutoToolChoice;
+        any?: never;
+        tool?: never;
+        $unknown?: never;
+    }
+    /**
+     * <p>The model must request at least one tool (no text is generated).</p>
+     * @public
+     */
+    interface AnyMember {
+        auto?: never;
+        any: AnyToolChoice;
+        tool?: never;
+        $unknown?: never;
+    }
+    /**
+     * <p>The Model must request the specified tool.  Only supported by Anthropic Claude 3 models. </p>
+     * @public
+     */
+    interface ToolMember {
+        auto?: never;
+        any?: never;
+        tool: SpecificToolChoice;
+        $unknown?: never;
+    }
+    /**
+     * @public
+     */
+    interface $UnknownMember {
+        auto?: never;
+        any?: never;
+        tool?: never;
+        $unknown: [string, any];
+    }
+    interface Visitor<T> {
+        auto: (value: AutoToolChoice) => T;
+        any: (value: AnyToolChoice) => T;
+        tool: (value: SpecificToolChoice) => T;
+        _: (name: string, value: any) => T;
+    }
+    const visit: <T>(value: ToolChoice, visitor: Visitor<T>) => T;
+}
+/**
+ * <p>The schema for the tool. The top level schema type must be <code>object</code>. </p>
+ * @public
+ */
+export type ToolInputSchema = ToolInputSchema.JsonMember | ToolInputSchema.$UnknownMember;
+/**
+ * @public
+ */
+export declare namespace ToolInputSchema {
+    /**
+     * <p>The JSON schema for the tool. For more information, see <a href="https://json-schema.org/understanding-json-schema/reference">JSON Schema Reference</a>.</p>
+     * @public
+     */
+    interface JsonMember {
+        json: __DocumentType;
+        $unknown?: never;
+    }
+    /**
+     * @public
+     */
+    interface $UnknownMember {
+        json?: never;
+        $unknown: [string, any];
+    }
+    interface Visitor<T> {
+        json: (value: __DocumentType) => T;
+        _: (name: string, value: any) => T;
+    }
+    const visit: <T>(value: ToolInputSchema, visitor: Visitor<T>) => T;
+}
+/**
+ * <p>The specification for the tool.</p>
+ * @public
+ */
+export interface ToolSpecification {
+    /**
+     * <p>The name for the tool.</p>
+     * @public
+     */
+    name: string | undefined;
+    /**
+     * <p>The description for the tool.</p>
+     * @public
+     */
+    description?: string;
+    /**
+     * <p>The input schema for the tool in JSON format.</p>
+     * @public
+     */
+    inputSchema: ToolInputSchema | undefined;
+}
+/**
+ * <p>Information about a tool that you can use with the Converse API. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/tool-use.html">Tool use (function calling)</a> in the Amazon Bedrock User Guide.</p>
+ * @public
+ */
+export type Tool = Tool.ToolSpecMember | Tool.$UnknownMember;
+/**
+ * @public
+ */
+export declare namespace Tool {
+    /**
+     * <p>The specfication for the tool.</p>
+     * @public
+     */
+    interface ToolSpecMember {
+        toolSpec: ToolSpecification;
+        $unknown?: never;
+    }
+    /**
+     * @public
+     */
+    interface $UnknownMember {
+        toolSpec?: never;
+        $unknown: [string, any];
+    }
+    interface Visitor<T> {
+        toolSpec: (value: ToolSpecification) => T;
+        _: (name: string, value: any) => T;
+    }
+    const visit: <T>(value: Tool, visitor: Visitor<T>) => T;
+}
+/**
+ * <p>Configuration information for the tools that you pass to a model. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/tool-use.html">Tool use (function calling)</a> in the Amazon Bedrock User Guide.</p>
+ *          <note>
+ *             <p>This field is only supported by Anthropic Claude 3, Cohere Command R, Cohere Command R+, and Mistral Large models.</p>
+ *          </note>
+ * @public
+ */
+export interface ToolConfiguration {
+    /**
+     * <p>An array of tools that you want to pass to a model.</p>
+     * @public
+     */
+    tools: Tool[] | undefined;
+    /**
+     * <p>If supported by model, forces the model to request a tool.</p>
+     * @public
+     */
+    toolChoice?: ToolChoice;
+}
+/**
+ * @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>
+     *          <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>
+     *             </li>
+     *             <li>
+     *                <p>If you use an inference profile, specify the inference profile ID or its ARN. For a list of inference profile IDs, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/cross-region-inference-support.html">Supported Regions and models for cross-region inference</a> in the Amazon Bedrock User Guide.</p>
+     *             </li>
+     *             <li>
+     *                <p>If you use a provisioned model, specify the ARN of the Provisioned Throughput. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/prov-thru-use.html">Run inference using a Provisioned Throughput</a> in the Amazon Bedrock User Guide.</p>
+     *             </li>
+     *             <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>
+     *          </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
+     */
+    modelId: string | undefined;
+    /**
+     * <p>The messages that you want to send to the model.</p>
+     * @public
+     */
+    messages: Message[] | undefined;
+    /**
+     * <p>A system prompt to pass to the model.</p>
+     * @public
+     */
+    system?: SystemContentBlock[];
+    /**
+     * <p>Inference parameters to pass to the model. <code>Converse</code> supports 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;
+    /**
+     * <p>Configuration information for the tools that the model can use when generating a response. </p>
+     *          <note>
+     *             <p>This field is only supported by Anthropic Claude 3, Cohere Command R, Cohere Command R+, and Mistral Large models.</p>
+     *          </note>
+     * @public
+     */
+    toolConfig?: ToolConfiguration;
+    /**
+     * <p>Configuration information for a guardrail that you want to use in the request. </p>
+     * @public
+     */
+    guardrailConfig?: GuardrailConfiguration;
+    /**
+     * <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>
+     *          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;
+    /**
+     * <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
+     *          <code>additionalModelResponseFields</code> field. The following is example JSON for <code>additionalModelResponseFieldPaths</code>.</p>
+     *          <p>
+     *             <code>[
+     *          "/stop_sequence"
+     *          ]</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>
+     *          <p>
+     *             <code>Converse</code> rejects 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[];
+}
+/**
+ * <p>Metrics for a call to <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_Converse.html">Converse</a>.</p>
+ * @public
+ */
+export interface ConverseMetrics {
+    /**
+     * <p>The latency of the call to <code>Converse</code>, in milliseconds.
+     *          </p>
+     * @public
+     */
+    latencyMs: number | undefined;
+}
+/**
+ * <p>The output from a call to <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_Converse.html">Converse</a>.</p>
+ * @public
+ */
+export type ConverseOutput = ConverseOutput.MessageMember | ConverseOutput.$UnknownMember;
+/**
+ * @public
+ */
+export declare namespace ConverseOutput {
+    /**
+     * <p>The message that the model generates.</p>
+     * @public
+     */
+    interface MessageMember {
+        message: Message;
+        $unknown?: never;
+    }
+    /**
+     * @public
+     */
+    interface $UnknownMember {
+        message?: never;
+        $unknown: [string, any];
+    }
+    interface Visitor<T> {
+        message: (value: Message) => T;
+        _: (name: string, value: any) => T;
+    }
+    const visit: <T>(value: ConverseOutput, visitor: Visitor<T>) => T;
+}
+/**
+ * @public
+ * @enum
+ */
+export declare const StopReason: {
+    readonly CONTENT_FILTERED: "content_filtered";
+    readonly END_TURN: "end_turn";
+    readonly GUARDRAIL_INTERVENED: "guardrail_intervened";
+    readonly MAX_TOKENS: "max_tokens";
+    readonly STOP_SEQUENCE: "stop_sequence";
+    readonly TOOL_USE: "tool_use";
+};
+/**
+ * @public
+ */
+export type StopReason = (typeof StopReason)[keyof typeof StopReason];
+/**
+ * <p>A Top level guardrail trace object. For more information, see <a>ConverseTrace</a>.</p>
+ * @public
+ */
+export interface GuardrailTraceAssessment {
+    /**
+     * <p>The output from the model.</p>
+     * @public
+     */
+    modelOutput?: string[];
+    /**
+     * <p>The input assessment.</p>
+     * @public
+     */
+    inputAssessment?: Record<string, GuardrailAssessment>;
+    /**
+     * <p>the output assessments.</p>
+     * @public
+     */
+    outputAssessments?: Record<string, GuardrailAssessment[]>;
+}
+/**
+ * <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>
+ * @public
+ */
+export interface ConverseTrace {
+    /**
+     * <p>The guardrail trace object. </p>
+     * @public
+     */
+    guardrail?: GuardrailTraceAssessment;
+}
+/**
+ * <p>The tokens used in a message API inference call. </p>
+ * @public
+ */
+export interface TokenUsage {
+    /**
+     * <p>The number of tokens sent in the request to the model.</p>
+     * @public
+     */
+    inputTokens: number | undefined;
+    /**
+     * <p>The number of tokens that the model generated for the request.</p>
+     * @public
+     */
+    outputTokens: number | undefined;
+    /**
+     * <p>The total of input tokens and tokens generated by the model.</p>
+     * @public
+     */
+    totalTokens: number | undefined;
+}
+/**
+ * @public
+ */
+export interface ConverseResponse {
+    /**
+     * <p>The result from the call to <code>Converse</code>.</p>
+     * @public
+     */
+    output: ConverseOutput | undefined;
+    /**
+     * <p>The reason why the model stopped generating output.</p>
+     * @public
+     */
+    stopReason: StopReason | undefined;
+    /**
+     * <p>The total number of tokens used in the call to <code>Converse</code>. The total includes
+     *          the tokens input to the model and the tokens generated by the model.</p>
+     * @public
+     */
+    usage: TokenUsage | undefined;
+    /**
+     * <p>Metrics for the call to <code>Converse</code>.</p>
+     * @public
+     */
+    metrics: ConverseMetrics | undefined;
+    /**
+     * <p>Additional fields in the response that are unique to the model. </p>
+     * @public
+     */
+    additionalModelResponseFields?: __DocumentType;
+    /**
+     * <p>A trace object that contains information about the Guardrail behavior.</p>
+     * @public
+     */
+    trace?: ConverseTrace;
+}
+/**
+ * <p>The request failed due to an error while processing the model.</p>
+ * @public
+ */
+export declare class ModelErrorException extends __BaseException {
+    readonly name: "ModelErrorException";
+    readonly $fault: "client";
+    /**
+     * <p>The original status code.</p>
+     * @public
+     */
+    originalStatusCode?: number;
+    /**
+     * <p>The resource name.</p>
+     * @public
+     */
+    resourceName?: string;
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<ModelErrorException, __BaseException>);
+}
+/**
+ * <p>The model specified in the request is not ready to serve inference requests. The AWS SDK
+ *            will automatically retry the operation up to 5 times. For information about configuring
+ *            automatic retries, see <a href="https://docs.aws.amazon.com/sdkref/latest/guide/feature-retry-behavior.html">Retry behavior</a> in the <i>AWS SDKs and Tools</i>
+ *            reference guide.</p>
+ * @public
+ */
+export declare class ModelNotReadyException extends __BaseException {
+    readonly name: "ModelNotReadyException";
+    readonly $fault: "client";
+    $retryable: {};
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<ModelNotReadyException, __BaseException>);
+}
+/**
+ * <p>The request took too long to process. Processing time exceeded the model timeout length.</p>
+ * @public
+ */
+export declare class ModelTimeoutException extends __BaseException {
+    readonly name: "ModelTimeoutException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<ModelTimeoutException, __BaseException>);
+}
+/**
+ * <p>The service isn't currently available. Try again later.</p>
+ * @public
+ */
+export declare class ServiceUnavailableException extends __BaseException {
+    readonly name: "ServiceUnavailableException";
+    readonly $fault: "server";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<ServiceUnavailableException, __BaseException>);
+}
+/**
+ * @public
+ * @enum
+ */
+export declare const GuardrailStreamProcessingMode: {
+    readonly ASYNC: "async";
+    readonly SYNC: "sync";
+};
+/**
+ * @public
+ */
+export type GuardrailStreamProcessingMode = (typeof GuardrailStreamProcessingMode)[keyof typeof GuardrailStreamProcessingMode];
+/**
+ * <p>Configuration information for a guardrail that you use with the <a>ConverseStream</a> action.
+ *             </p>
+ * @public
+ */
+export interface GuardrailStreamConfiguration {
+    /**
+     * <p>The identifier for the guardrail.</p>
+     * @public
+     */
+    guardrailIdentifier: string | undefined;
+    /**
+     * <p>The version of the guardrail.</p>
+     * @public
+     */
+    guardrailVersion: string | undefined;
+    /**
+     * <p>The trace behavior for the guardrail.</p>
+     * @public
+     */
+    trace?: GuardrailTrace;
+    /**
+     * <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;
+}
+/**
+ * @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>
+     *          <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>
+     *             </li>
+     *             <li>
+     *                <p>If you use an inference profile, specify the inference profile ID or its ARN. For a list of inference profile IDs, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/cross-region-inference-support.html">Supported Regions and models for cross-region inference</a> in the Amazon Bedrock User Guide.</p>
+     *             </li>
+     *             <li>
+     *                <p>If you use a provisioned model, specify the ARN of the Provisioned Throughput. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/prov-thru-use.html">Run inference using a Provisioned Throughput</a> in the Amazon Bedrock User Guide.</p>
+     *             </li>
+     *             <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>
+     *          </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
+     */
+    modelId: string | undefined;
+    /**
+     * <p>The messages that you want to send to the model.</p>
+     * @public
+     */
+    messages: Message[] | undefined;
+    /**
+     * <p>A system prompt to send to the model.</p>
+     * @public
+     */
+    system?: SystemContentBlock[];
+    /**
+     * <p>Inference parameters to pass to the model. <code>ConverseStream</code> supports 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;
+    /**
+     * <p>Configuration information for the tools that the model can use when generating a response.</p>
+     *          <note>
+     *             <p>This field is only supported by Anthropic Claude 3 models.</p>
+     *          </note>
+     * @public
+     */
+    toolConfig?: ToolConfiguration;
+    /**
+     * <p>Configuration information for a guardrail that you want to use in the request. </p>
+     * @public
+     */
+    guardrailConfig?: GuardrailStreamConfiguration;
+    /**
+     * <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>
+     * @public
+     */
+    additionalModelRequestFields?: __DocumentType;
+    /**
+     * <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
+     *          <code>additionalModelResponseFields</code> field. The following is example JSON for <code>additionalModelResponseFieldPaths</code>.</p>
+     *          <p>
+     *             <code>[
+     *          "/stop_sequence"
+     *          ]</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>
+     *          <p>
+     *             <code>ConverseStream</code> rejects 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>
+     * @public
+     */
+    additionalModelResponseFieldPaths?: string[];
+}
+/**
+ * <p>The delta for a tool use block.</p>
+ * @public
+ */
+export interface ToolUseBlockDelta {
+    /**
+     * <p>The input for a requested tool.</p>
+     * @public
+     */
+    input: string | undefined;
+}
+/**
+ * <p>A bock of content in a streaming response.</p>
+ * @public
+ */
+export type ContentBlockDelta = ContentBlockDelta.TextMember | ContentBlockDelta.ToolUseMember | ContentBlockDelta.$UnknownMember;
+/**
+ * @public
+ */
+export declare namespace ContentBlockDelta {
+    /**
+     * <p>The content text.</p>
+     * @public
+     */
+    interface TextMember {
+        text: string;
+        toolUse?: never;
+        $unknown?: never;
+    }
+    /**
+     * <p>Information about a tool that the model is requesting to use.</p>
+     * @public
+     */
+    interface ToolUseMember {
+        text?: never;
+        toolUse: ToolUseBlockDelta;
+        $unknown?: never;
+    }
+    /**
+     * @public
+     */
+    interface $UnknownMember {
+        text?: never;
+        toolUse?: never;
+        $unknown: [string, any];
+    }
+    interface Visitor<T> {
+        text: (value: string) => T;
+        toolUse: (value: ToolUseBlockDelta) => T;
+        _: (name: string, value: any) => T;
+    }
+    const visit: <T>(value: ContentBlockDelta, visitor: Visitor<T>) => T;
+}
+/**
+ * <p>The content block delta event.</p>
+ * @public
+ */
+export interface ContentBlockDeltaEvent {
+    /**
+     * <p>The delta for a content block delta event.</p>
+     * @public
+     */
+    delta: ContentBlockDelta | undefined;
+    /**
+     * <p>The block index for a content block delta event. </p>
+     * @public
+     */
+    contentBlockIndex: number | undefined;
+}
+/**
+ * <p>The start of a tool use block.</p>
+ * @public
+ */
+export interface ToolUseBlockStart {
+    /**
+     * <p>The ID for the tool request.</p>
+     * @public
+     */
+    toolUseId: string | undefined;
+    /**
+     * <p>The name of the tool that the model is requesting to use.</p>
+     * @public
+     */
+    name: string | undefined;
+}
+/**
+ * <p>Content block start information.</p>
+ * @public
+ */
+export type ContentBlockStart = ContentBlockStart.ToolUseMember | ContentBlockStart.$UnknownMember;
+/**
+ * @public
+ */
+export declare namespace ContentBlockStart {
+    /**
+     * <p>Information about a tool that the model is requesting to use.</p>
+     * @public
+     */
+    interface ToolUseMember {
+        toolUse: ToolUseBlockStart;
+        $unknown?: never;
+    }
+    /**
+     * @public
+     */
+    interface $UnknownMember {
+        toolUse?: never;
+        $unknown: [string, any];
+    }
+    interface Visitor<T> {
+        toolUse: (value: ToolUseBlockStart) => T;
+        _: (name: string, value: any) => T;
+    }
+    const visit: <T>(value: ContentBlockStart, visitor: Visitor<T>) => T;
+}
+/**
+ * <p>Content block start event.</p>
+ * @public
+ */
+export interface ContentBlockStartEvent {
+    /**
+     * <p>Start information about a content block start event.  </p>
+     * @public
+     */
+    start: ContentBlockStart | undefined;
+    /**
+     * <p>The index for a content block start event.</p>
+     * @public
+     */
+    contentBlockIndex: number | undefined;
+}
+/**
+ * <p>A content block stop event.</p>
+ * @public
+ */
+export interface ContentBlockStopEvent {
+    /**
+     * <p>The index for a content block.</p>
+     * @public
+     */
+    contentBlockIndex: number | undefined;
+}
+/**
+ * <p>The start of a message.</p>
+ * @public
+ */
+export interface MessageStartEvent {
+    /**
+     * <p>The role for the message.</p>
+     * @public
+     */
+    role: ConversationRole | undefined;
+}
+/**
+ * <p>The stop event for a message.</p>
+ * @public
+ */
+export interface MessageStopEvent {
+    /**
+     * <p>The reason why the model stopped generating output.</p>
+     * @public
+     */
+    stopReason: StopReason | undefined;
+    /**
+     * <p>The additional model response fields.</p>
+     * @public
+     */
+    additionalModelResponseFields?: __DocumentType;
+}
+/**
+ * <p>Metrics for the stream.</p>
+ * @public
+ */
+export interface ConverseStreamMetrics {
+    /**
+     * <p>The latency for the streaming request, in milliseconds.</p>
+     * @public
+     */
+    latencyMs: number | undefined;
+}
+/**
+ * <p>The trace object in a response from <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_ConverseStream.html">ConverseStream</a>. Currently, you can only trace guardrails.</p>
+ * @public
+ */
+export interface ConverseStreamTrace {
+    /**
+     * <p>The guardrail trace object. </p>
+     * @public
+     */
+    guardrail?: GuardrailTraceAssessment;
+}
+/**
+ * <p>A conversation stream metadata event.</p>
+ * @public
+ */
+export interface ConverseStreamMetadataEvent {
+    /**
+     * <p>Usage information for the conversation stream event.</p>
+     * @public
+     */
+    usage: TokenUsage | undefined;
+    /**
+     * <p>The metrics for the conversation stream metadata event.</p>
+     * @public
+     */
+    metrics: ConverseStreamMetrics | undefined;
+    /**
+     * <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;
+}
+/**
+ * <p>An error occurred while streaming the response. Retry your request.</p>
+ * @public
+ */
+export declare class ModelStreamErrorException extends __BaseException {
+    readonly name: "ModelStreamErrorException";
+    readonly $fault: "client";
+    /**
+     * <p>The original status code.</p>
+     * @public
+     */
+    originalStatusCode?: number;
+    /**
+     * <p>The original message.</p>
+     * @public
+     */
+    originalMessage?: string;
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<ModelStreamErrorException, __BaseException>);
+}
+/**
+ * <p>The messages output stream</p>
+ * @public
+ */
+export type ConverseStreamOutput = ConverseStreamOutput.ContentBlockDeltaMember | ConverseStreamOutput.ContentBlockStartMember | ConverseStreamOutput.ContentBlockStopMember | ConverseStreamOutput.InternalServerExceptionMember | ConverseStreamOutput.MessageStartMember | ConverseStreamOutput.MessageStopMember | ConverseStreamOutput.MetadataMember | ConverseStreamOutput.ModelStreamErrorExceptionMember | ConverseStreamOutput.ServiceUnavailableExceptionMember | ConverseStreamOutput.ThrottlingExceptionMember | ConverseStreamOutput.ValidationExceptionMember | ConverseStreamOutput.$UnknownMember;
+/**
+ * @public
+ */
+export declare namespace ConverseStreamOutput {
+    /**
+     * <p>Message start information.</p>
+     * @public
+     */
+    interface MessageStartMember {
+        messageStart: MessageStartEvent;
+        contentBlockStart?: never;
+        contentBlockDelta?: never;
+        contentBlockStop?: never;
+        messageStop?: never;
+        metadata?: never;
+        internalServerException?: never;
+        modelStreamErrorException?: never;
+        validationException?: never;
+        throttlingException?: never;
+        serviceUnavailableException?: never;
+        $unknown?: never;
+    }
+    /**
+     * <p>Start information for a content block.</p>
+     * @public
+     */
+    interface ContentBlockStartMember {
+        messageStart?: never;
+        contentBlockStart: ContentBlockStartEvent;
+        contentBlockDelta?: never;
+        contentBlockStop?: never;
+        messageStop?: never;
+        metadata?: never;
+        internalServerException?: never;
+        modelStreamErrorException?: never;
+        validationException?: never;
+        throttlingException?: never;
+        serviceUnavailableException?: never;
+        $unknown?: never;
+    }
+    /**
+     * <p>The messages output content block delta.</p>
+     * @public
+     */
+    interface ContentBlockDeltaMember {
+        messageStart?: never;
+        contentBlockStart?: never;
+        contentBlockDelta: ContentBlockDeltaEvent;
+        contentBlockStop?: never;
+        messageStop?: never;
+        metadata?: never;
+        internalServerException?: never;
+        modelStreamErrorException?: never;
+        validationException?: never;
+        throttlingException?: never;
+        serviceUnavailableException?: never;
+        $unknown?: never;
+    }
+    /**
+     * <p>Stop information for a content block.</p>
+     * @public
+     */
+    interface ContentBlockStopMember {
+        messageStart?: never;
+        contentBlockStart?: never;
+        contentBlockDelta?: never;
+        contentBlockStop: ContentBlockStopEvent;
+        messageStop?: never;
+        metadata?: never;
+        internalServerException?: never;
+        modelStreamErrorException?: never;
+        validationException?: never;
+        throttlingException?: never;
+        serviceUnavailableException?: never;
+        $unknown?: never;
+    }
+    /**
+     * <p>Message stop information.</p>
+     * @public
+     */
+    interface MessageStopMember {
+        messageStart?: never;
+        contentBlockStart?: never;
+        contentBlockDelta?: never;
+        contentBlockStop?: never;
+        messageStop: MessageStopEvent;
+        metadata?: never;
+        internalServerException?: never;
+        modelStreamErrorException?: never;
+        validationException?: never;
+        throttlingException?: never;
+        serviceUnavailableException?: never;
+        $unknown?: never;
+    }
+    /**
+     * <p>Metadata for the converse output stream.</p>
+     * @public
+     */
+    interface MetadataMember {
+        messageStart?: never;
+        contentBlockStart?: never;
+        contentBlockDelta?: never;
+        contentBlockStop?: never;
+        messageStop?: never;
+        metadata: ConverseStreamMetadataEvent;
+        internalServerException?: never;
+        modelStreamErrorException?: never;
+        validationException?: never;
+        throttlingException?: never;
+        serviceUnavailableException?: never;
+        $unknown?: never;
+    }
+    /**
+     * <p>An internal server error occurred. Retry your request.</p>
+     * @public
+     */
+    interface InternalServerExceptionMember {
+        messageStart?: never;
+        contentBlockStart?: never;
+        contentBlockDelta?: never;
+        contentBlockStop?: never;
+        messageStop?: never;
+        metadata?: never;
+        internalServerException: InternalServerException;
+        modelStreamErrorException?: never;
+        validationException?: never;
+        throttlingException?: never;
+        serviceUnavailableException?: never;
+        $unknown?: never;
+    }
+    /**
+     * <p>A streaming error occurred. Retry your request.</p>
+     * @public
+     */
+    interface ModelStreamErrorExceptionMember {
+        messageStart?: never;
+        contentBlockStart?: never;
+        contentBlockDelta?: never;
+        contentBlockStop?: never;
+        messageStop?: never;
+        metadata?: never;
+        internalServerException?: never;
+        modelStreamErrorException: ModelStreamErrorException;
+        validationException?: never;
+        throttlingException?: never;
+        serviceUnavailableException?: never;
+        $unknown?: never;
+    }
+    /**
+     * <p>Input validation failed. Check your request parameters and retry the request.</p>
+     * @public
+     */
+    interface ValidationExceptionMember {
+        messageStart?: never;
+        contentBlockStart?: never;
+        contentBlockDelta?: never;
+        contentBlockStop?: never;
+        messageStop?: never;
+        metadata?: never;
+        internalServerException?: never;
+        modelStreamErrorException?: never;
+        validationException: ValidationException;
+        throttlingException?: never;
+        serviceUnavailableException?: never;
+        $unknown?: never;
+    }
+    /**
+     * <p>The number of requests exceeds the limit. Resubmit your request later.</p>
+     * @public
+     */
+    interface ThrottlingExceptionMember {
+        messageStart?: never;
+        contentBlockStart?: never;
+        contentBlockDelta?: never;
+        contentBlockStop?: never;
+        messageStop?: never;
+        metadata?: never;
+        internalServerException?: never;
+        modelStreamErrorException?: never;
+        validationException?: never;
+        throttlingException: ThrottlingException;
+        serviceUnavailableException?: never;
+        $unknown?: never;
+    }
+    /**
+     * <p>The service isn't currently available. Try again later.</p>
+     * @public
+     */
+    interface ServiceUnavailableExceptionMember {
+        messageStart?: never;
+        contentBlockStart?: never;
+        contentBlockDelta?: never;
+        contentBlockStop?: never;
+        messageStop?: never;
+        metadata?: never;
+        internalServerException?: never;
+        modelStreamErrorException?: never;
+        validationException?: never;
+        throttlingException?: never;
+        serviceUnavailableException: ServiceUnavailableException;
+        $unknown?: never;
+    }
+    /**
+     * @public
+     */
+    interface $UnknownMember {
+        messageStart?: never;
+        contentBlockStart?: never;
+        contentBlockDelta?: never;
+        contentBlockStop?: never;
+        messageStop?: never;
+        metadata?: never;
+        internalServerException?: never;
+        modelStreamErrorException?: never;
+        validationException?: never;
+        throttlingException?: never;
+        serviceUnavailableException?: never;
+        $unknown: [string, any];
+    }
+    interface Visitor<T> {
+        messageStart: (value: MessageStartEvent) => T;
+        contentBlockStart: (value: ContentBlockStartEvent) => T;
+        contentBlockDelta: (value: ContentBlockDeltaEvent) => T;
+        contentBlockStop: (value: ContentBlockStopEvent) => T;
+        messageStop: (value: MessageStopEvent) => T;
+        metadata: (value: ConverseStreamMetadataEvent) => T;
+        internalServerException: (value: InternalServerException) => T;
+        modelStreamErrorException: (value: ModelStreamErrorException) => T;
+        validationException: (value: ValidationException) => T;
+        throttlingException: (value: ThrottlingException) => T;
+        serviceUnavailableException: (value: ServiceUnavailableException) => T;
+        _: (name: string, value: any) => T;
+    }
+    const visit: <T>(value: ConverseStreamOutput, visitor: Visitor<T>) => T;
+}
+/**
+ * @public
+ */
+export interface ConverseStreamResponse {
+    /**
+     * <p>The output stream that the model generated.</p>
+     * @public
+     */
+    stream?: AsyncIterable<ConverseStreamOutput>;
+}
+/**
+ * @public
+ * @enum
+ */
+export declare const Trace: {
+    readonly DISABLED: "DISABLED";
+    readonly ENABLED: "ENABLED";
+};
+/**
+ * @public
+ */
+export type Trace = (typeof Trace)[keyof typeof Trace];
+/**
+ * @public
+ */
+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;
+    /**
+     * <p>The MIME type of the input data in the request. You must specify
+     *             <code>application/json</code>.</p>
+     * @public
+     */
+    contentType?: string;
+    /**
+     * <p>The desired MIME type of the inference body in the response. The default value is <code>application/json</code>.</p>
+     * @public
+     */
+    accept?: string;
+    /**
+     * <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>
+     *          <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>
+     *             </li>
+     *             <li>
+     *                <p>If you use a provisioned model, specify the ARN of the Provisioned Throughput. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/prov-thru-use.html">Run inference using a Provisioned Throughput</a> in the Amazon Bedrock User Guide.</p>
+     *             </li>
+     *             <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>If you use an <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-customization-import-model.html">imported model</a>, specify the ARN of the imported model. You can get the model ARN from a successful call to <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_CreateModelImportJob.html">CreateModelImportJob</a> or from the Imported models page in the Amazon Bedrock console.</p>
+     *             </li>
+     *          </ul>
+     * @public
+     */
+    modelId: string | undefined;
+    /**
+     * <p>Specifies whether to enable or disable the Bedrock trace. If enabled, you can see the full Bedrock trace.</p>
+     * @public
+     */
+    trace?: Trace;
+    /**
+     * <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>
+     *          <p>An error will be thrown in the following situations.</p>
+     *          <ul>
+     *             <li>
+     *                <p>You don't provide a guardrail identifier but you specify the <code>amazon-bedrock-guardrailConfig</code> field in the request body.</p>
+     *             </li>
+     *             <li>
+     *                <p>You enable the guardrail but the <code>contentType</code> isn't <code>application/json</code>.</p>
+     *             </li>
+     *             <li>
+     *                <p>You provide a guardrail identifier, but <code>guardrailVersion</code> isn't specified.</p>
+     *             </li>
+     *          </ul>
+     * @public
+     */
+    guardrailIdentifier?: string;
+    /**
+     * <p>The version number for the guardrail. The value can also be <code>DRAFT</code>.</p>
+     * @public
+     */
+    guardrailVersion?: string;
+}
+/**
+ * @public
+ */
+export interface InvokeModelResponse {
+    /**
+     * <p>Inference response from the model in the format specified in the <code>contentType</code> header. 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>.</p>
+     * @public
+     */
+    body: Uint8Array | undefined;
+    /**
+     * <p>The MIME type of the inference result.</p>
+     * @public
+     */
+    contentType: string | undefined;
+}
+/**
+ * @public
+ */
+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;
+    /**
+     * <p>The MIME type of the input data in the request. You must specify
+     *             <code>application/json</code>.</p>
+     * @public
+     */
+    contentType?: string;
+    /**
+     * <p>The desired MIME type of the inference body in the response. The default value is
+     *             <code>application/json</code>.</p>
+     * @public
+     */
+    accept?: string;
+    /**
+     * <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>
+     *          <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>
+     *             </li>
+     *             <li>
+     *                <p>If you use a provisioned model, specify the ARN of the Provisioned Throughput. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/prov-thru-use.html">Run inference using a Provisioned Throughput</a> in the Amazon Bedrock User Guide.</p>
+     *             </li>
+     *             <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>If you use an <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-customization-import-model.html">imported model</a>, specify the ARN of the imported model. You can get the model ARN from a successful call to <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_CreateModelImportJob.html">CreateModelImportJob</a> or from the Imported models page in the Amazon Bedrock console.</p>
+     *             </li>
+     *          </ul>
+     * @public
+     */
+    modelId: string | undefined;
+    /**
+     * <p>Specifies whether to enable or disable the Bedrock trace. If enabled, you can see the full Bedrock trace.</p>
+     * @public
+     */
+    trace?: Trace;
+    /**
+     * <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>
+     *          <p>An error is thrown in the following situations.</p>
+     *          <ul>
+     *             <li>
+     *                <p>You don't provide a guardrail identifier but you specify the <code>amazon-bedrock-guardrailConfig</code> field in the request body.</p>
+     *             </li>
+     *             <li>
+     *                <p>You enable the guardrail but the <code>contentType</code> isn't <code>application/json</code>.</p>
+     *             </li>
+     *             <li>
+     *                <p>You provide a guardrail identifier, but <code>guardrailVersion</code> isn't specified.</p>
+     *             </li>
+     *          </ul>
+     * @public
+     */
+    guardrailIdentifier?: string;
+    /**
+     * <p>The version number for the guardrail. The value can also be <code>DRAFT</code>.</p>
+     * @public
+     */
+    guardrailVersion?: string;
+}
+/**
+ * <p>Payload content included in the response.</p>
+ * @public
+ */
+export interface PayloadPart {
+    /**
+     * <p>Base64-encoded bytes of payload data.</p>
+     * @public
+     */
+    bytes?: Uint8Array;
+}
+/**
+ * <p>Definition of content in the response stream.</p>
+ * @public
+ */
+export type ResponseStream = ResponseStream.ChunkMember | ResponseStream.InternalServerExceptionMember | ResponseStream.ModelStreamErrorExceptionMember | ResponseStream.ModelTimeoutExceptionMember | ResponseStream.ServiceUnavailableExceptionMember | ResponseStream.ThrottlingExceptionMember | ResponseStream.ValidationExceptionMember | ResponseStream.$UnknownMember;
+/**
+ * @public
+ */
+export declare namespace ResponseStream {
+    /**
+     * <p>Content included in the response.</p>
+     * @public
+     */
+    interface ChunkMember {
+        chunk: PayloadPart;
+        internalServerException?: never;
+        modelStreamErrorException?: never;
+        validationException?: never;
+        throttlingException?: never;
+        modelTimeoutException?: never;
+        serviceUnavailableException?: never;
+        $unknown?: never;
+    }
+    /**
+     * <p>An internal server error occurred. Retry your request.</p>
+     * @public
+     */
+    interface InternalServerExceptionMember {
+        chunk?: never;
+        internalServerException: InternalServerException;
+        modelStreamErrorException?: never;
+        validationException?: never;
+        throttlingException?: never;
+        modelTimeoutException?: never;
+        serviceUnavailableException?: never;
+        $unknown?: never;
+    }
+    /**
+     * <p>An error occurred while streaming the response. Retry your request.</p>
+     * @public
+     */
+    interface ModelStreamErrorExceptionMember {
+        chunk?: never;
+        internalServerException?: never;
+        modelStreamErrorException: ModelStreamErrorException;
+        validationException?: never;
+        throttlingException?: never;
+        modelTimeoutException?: never;
+        serviceUnavailableException?: never;
+        $unknown?: never;
+    }
+    /**
+     * <p>Input validation failed. Check your request parameters and retry the request.</p>
+     * @public
+     */
+    interface ValidationExceptionMember {
+        chunk?: never;
+        internalServerException?: never;
+        modelStreamErrorException?: never;
+        validationException: ValidationException;
+        throttlingException?: never;
+        modelTimeoutException?: never;
+        serviceUnavailableException?: never;
+        $unknown?: never;
+    }
+    /**
+     * <p>Your request was throttled because of service-wide limitations. Resubmit your request later or in a different region. You can also purchase <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/prov-throughput.html">Provisioned Throughput</a> to increase the rate or number of tokens you can process.</p>
+     * @public
+     */
+    interface ThrottlingExceptionMember {
+        chunk?: never;
+        internalServerException?: never;
+        modelStreamErrorException?: never;
+        validationException?: never;
+        throttlingException: ThrottlingException;
+        modelTimeoutException?: never;
+        serviceUnavailableException?: never;
+        $unknown?: never;
+    }
+    /**
+     * <p>The request took too long to process. Processing time exceeded the model timeout length.</p>
+     * @public
+     */
+    interface ModelTimeoutExceptionMember {
+        chunk?: never;
+        internalServerException?: never;
+        modelStreamErrorException?: never;
+        validationException?: never;
+        throttlingException?: never;
+        modelTimeoutException: ModelTimeoutException;
+        serviceUnavailableException?: never;
+        $unknown?: never;
+    }
+    /**
+     * <p>The service isn't currently available. Try again later.</p>
+     * @public
+     */
+    interface ServiceUnavailableExceptionMember {
+        chunk?: never;
+        internalServerException?: never;
+        modelStreamErrorException?: never;
+        validationException?: never;
+        throttlingException?: never;
+        modelTimeoutException?: never;
+        serviceUnavailableException: ServiceUnavailableException;
+        $unknown?: never;
+    }
+    /**
+     * @public
+     */
+    interface $UnknownMember {
+        chunk?: never;
+        internalServerException?: never;
+        modelStreamErrorException?: never;
+        validationException?: never;
+        throttlingException?: never;
+        modelTimeoutException?: never;
+        serviceUnavailableException?: never;
+        $unknown: [string, any];
+    }
+    interface Visitor<T> {
+        chunk: (value: PayloadPart) => T;
+        internalServerException: (value: InternalServerException) => T;
+        modelStreamErrorException: (value: ModelStreamErrorException) => T;
+        validationException: (value: ValidationException) => T;
+        throttlingException: (value: ThrottlingException) => T;
+        modelTimeoutException: (value: ModelTimeoutException) => T;
+        serviceUnavailableException: (value: ServiceUnavailableException) => T;
+        _: (name: string, value: any) => T;
+    }
+    const visit: <T>(value: ResponseStream, visitor: Visitor<T>) => T;
+}
+/**
+ * @public
+ */
+export interface InvokeModelWithResponseStreamResponse {
+    /**
+     * <p>Inference response from the model in the format specified by the <code>contentType</code> header. To see the format and content of this field for different models, refer to <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html">Inference parameters</a>.</p>
+     * @public
+     */
+    body: AsyncIterable<ResponseStream> | undefined;
+    /**
+     * <p>The MIME type of the inference result.</p>
+     * @public
+     */
+    contentType: string | undefined;
+}
+/**
+ * @internal
+ */
+export declare const ConverseStreamOutputFilterSensitiveLog: (obj: ConverseStreamOutput) => any;
+/**
+ * @internal
+ */
+export declare const ConverseStreamResponseFilterSensitiveLog: (obj: ConverseStreamResponse) => any;
+/**
+ * @internal
+ */
+export declare const InvokeModelRequestFilterSensitiveLog: (obj: InvokeModelRequest) => any;
+/**
+ * @internal
+ */
+export declare const InvokeModelResponseFilterSensitiveLog: (obj: InvokeModelResponse) => any;
+/**
+ * @internal
+ */
+export declare const InvokeModelWithResponseStreamRequestFilterSensitiveLog: (obj: InvokeModelWithResponseStreamRequest) => any;
+/**
+ * @internal
+ */
+export declare const PayloadPartFilterSensitiveLog: (obj: PayloadPart) => any;
+/**
+ * @internal
+ */
+export declare const ResponseStreamFilterSensitiveLog: (obj: ResponseStream) => any;
+/**
+ * @internal
+ */
+export declare const InvokeModelWithResponseStreamResponseFilterSensitiveLog: (obj: InvokeModelWithResponseStreamResponse) => any;