Skip to main content Link Search Menu Expand Document (external link)
effect

AmazonBedrockSchema.ts overview

Since v1.0.0

Exports Grouped by Category

Models

ConverseResponseStreamEvent (type alias)

Signature

type ConverseResponseStreamEvent = typeof ConverseResponseStreamEvent.Type

Source

Since v1.0.0

Schemas

BedrockFoundationModelId (class)

The foundation models supported by Amazon Bedrock.

An up-to-date list can be generated with the following command:

aws bedrock list-foundation-models --output json | jq '[.modelSummaries[].modelId]'

Signature

declare class BedrockFoundationModelId

Source

Since v1.0.0

CachePointBlock (class)

Signature

declare class CachePointBlock

Source

Since v1.0.0

ContentBlock (class)

Signature

declare class ContentBlock

Source

Since v1.0.0

ContentBlockDelta (class)

Signature

declare class ContentBlockDelta

Source

Since v1.0.0

ContentBlockDeltaEvent (class)

Signature

declare class ContentBlockDeltaEvent

Source

Since v1.0.0

ContentBlockStart (class)

Signature

declare class ContentBlockStart

Source

Since v1.0.0

ContentBlockStartEvent (class)

Signature

declare class ContentBlockStartEvent

Source

Since v1.0.0

ContentBlockStopEvent (class)

Signature

declare class ContentBlockStopEvent

Source

Since v1.0.0

ConverseMetrics (class)

Signature

declare class ConverseMetrics

Source

Since v1.0.0

ConverseOutput (class)

Signature

declare class ConverseOutput

Source

Since v1.0.0

ConverseRequest (class)

Signature

declare class ConverseRequest

Source

Since v1.0.0

ConverseResponse (class)

Signature

declare class ConverseResponse

Source

Since v1.0.0

ConverseResponseStreamEvent

Signature

declare const ConverseResponseStreamEvent: Schema.Schema<
  | ({ readonly messageStart: MessageStartEvent } & { readonly type: "messageStart" })
  | ({ readonly messageStop: MessageStopEvent } & { readonly type: "messageStop" })
  | ({ readonly contentBlockStart: ContentBlockStartEvent } & { readonly type: "contentBlockStart" })
  | ({ readonly contentBlockDelta: ContentBlockDeltaEvent } & { readonly type: "contentBlockDelta" })
  | ({ readonly contentBlockStop: ContentBlockStopEvent } & { readonly type: "contentBlockStop" })
  | ({ readonly metadata: ConverseStreamMetadataEvent } & { readonly type: "metadata" })
  | ({ readonly internalServerException: { readonly [x: string]: unknown } } & {
      readonly type: "internalServerException"
    })
  | ({ readonly modelStreamErrorException: { readonly [x: string]: unknown } } & {
      readonly type: "modelStreamErrorException"
    })
  | ({ readonly serviceUnavailableException: { readonly [x: string]: unknown } } & {
      readonly type: "serviceUnavailableException"
    })
  | ({ readonly throttlingException: { readonly [x: string]: unknown } } & { readonly type: "throttlingException" })
  | ({ readonly validationException: { readonly [x: string]: unknown } } & { readonly type: "validationException" }),
  | { readonly messageStart: { readonly role: "user" | "assistant" } }
  | {
      readonly messageStop: {
        readonly stopReason:
          | "end_turn"
          | "tool_use"
          | "max_tokens"
          | "stop_sequence"
          | "guardrail_intervened"
          | "content_filtered"
        readonly additionalModelResponseFields?: { readonly [x: string]: unknown } | undefined
      }
    }
  | {
      readonly contentBlockStart: {
        readonly start: { readonly toolUse?: { readonly name: string; readonly toolUseId: string } | undefined }
        readonly contentBlockIndex: number
      }
    }
  | {
      readonly contentBlockDelta: {
        readonly contentBlockIndex: number
        readonly delta:
          | {
              readonly reasoningContent:
                | { readonly redactedContent: string }
                | { readonly signature: string }
                | { readonly text: string }
            }
          | { readonly text: string }
          | { readonly toolUse: { readonly input: string } }
      }
    }
  | { readonly contentBlockStop: { readonly contentBlockIndex: number } }
  | {
      readonly metadata: {
        readonly metrics: { readonly latencyMs: number }
        readonly usage: {
          readonly inputTokens: number
          readonly outputTokens: number
          readonly totalTokens: number
          readonly cacheReadInputTokens?: number | undefined
          readonly cacheWriteInputTokens?: number | undefined
        }
        readonly performanceConfig?: { readonly latency?: "standard" | "optimized" | undefined } | undefined
        readonly trace?:
          | {
              readonly guardrail?:
                | {
                    readonly actionReason?: string | undefined
                    readonly inputAssessment?:
                      | {
                          readonly [x: string]: {
                            readonly contentPolicy?:
                              | {
                                  readonly filters: ReadonlyArray<{
                                    readonly type:
                                      | "HATE"
                                      | "INSULTS"
                                      | "MISCONDUCT"
                                      | "PROMPT_ATTACK"
                                      | "SEXUAL"
                                      | "VIOLENCE"
                                    readonly action: "BLOCKED" | "NONE"
                                    readonly confidence: "NONE" | "LOW" | "MEDIUM" | "HIGH"
                                    readonly detected?: boolean | undefined
                                    readonly filterStrength?: "NONE" | "LOW" | "MEDIUM" | "HIGH" | undefined
                                  }>
                                }
                              | undefined
                            readonly contextualGroundingPolicy?:
                              | {
                                  readonly filters?:
                                    | ReadonlyArray<{
                                        readonly type: "GROUNDING" | "RELEVANCE"
                                        readonly action: "BLOCKED" | "NONE"
                                        readonly score: number
                                        readonly threshold: number
                                        readonly detected?: boolean | undefined
                                      }>
                                    | undefined
                                }
                              | undefined
                            readonly invocationMetrics?:
                              | {
                                  readonly usage?:
                                    | {
                                        readonly contentPolicyUnits: number
                                        readonly contextualGroundingPolicyUnits: number
                                        readonly sensitiveInformationPolicyFreeUnits: number
                                        readonly sensitiveInformationPolicyUnits: number
                                        readonly topicPolicyUnits: number
                                        readonly wordPolicyUnits: number
                                        readonly contentPolicyImageUnits?: number | undefined
                                      }
                                    | undefined
                                  readonly guardrailCoverage?:
                                    | {
                                        readonly images?:
                                          | {
                                              readonly guarded?: number | undefined
                                              readonly total?: number | undefined
                                            }
                                          | undefined
                                        readonly textCharacters?:
                                          | {
                                              readonly guarded?: number | undefined
                                              readonly total?: number | undefined
                                            }
                                          | undefined
                                      }
                                    | undefined
                                  readonly guardrailProcessingLatency?: number | undefined
                                }
                              | undefined
                            readonly sensitiveInformationPolicy?:
                              | {
                                  readonly piiEntities: ReadonlyArray<{
                                    readonly type:
                                      | "ADDRESS"
                                      | "AGE"
                                      | "AWS_ACCESS_KEY"
                                      | "AWS_SECRET_KEY"
                                      | "CA_HEALTH_NUMBER"
                                      | "CA_SOCIAL_INSURANCE_NUMBER"
                                      | "CREDIT_DEBIT_CARD_CVV"
                                      | "CREDIT_DEBIT_CARD_EXPIRY"
                                      | "CREDIT_DEBIT_CARD_NUMBER"
                                      | "DRIVER_ID"
                                      | "EMAIL"
                                      | "INTERNATIONAL_BANK_ACCOUNT_NUMBER"
                                      | "IP_ADDRESS"
                                      | "LICENSE_PLATE"
                                      | "MAC_ADDRESS"
                                      | "NAME"
                                      | "PASSWORD"
                                      | "PHONE"
                                      | "PIN"
                                      | "SWIFT_CODE"
                                      | "UK_NATIONAL_HEALTH_SERVICE_NUMBER"
                                      | "UK_NATIONAL_INSURANCE_NUMBER"
                                      | "UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER"
                                      | "URL"
                                      | "USERNAME"
                                      | "US_BANK_ACCOUNT_NUMBER"
                                      | "US_BANK_ROUTING_NUMBER"
                                      | "US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER"
                                      | "US_PASSPORT_NUMBER"
                                      | "US_SOCIAL_SECURITY_NUMBER"
                                      | "VEHICLE_IDENTIFICATION_NUMBER"
                                    readonly action: "BLOCKED" | "NONE" | "ANONYMIZED"
                                    readonly match: string
                                    readonly detected?: boolean | undefined
                                  }>
                                  readonly regexes: ReadonlyArray<{
                                    readonly action: "BLOCKED" | "NONE" | "ANONYMIZED"
                                    readonly name?: string | undefined
                                    readonly detected?: boolean | undefined
                                    readonly match?: string | undefined
                                    readonly regex?: string | undefined
                                  }>
                                }
                              | undefined
                            readonly topicPolicy?:
                              | {
                                  readonly topics: ReadonlyArray<{
                                    readonly type: "DENY"
                                    readonly name: string
                                    readonly action: "BLOCKED" | "NONE"
                                    readonly detected?: boolean | undefined
                                  }>
                                }
                              | undefined
                            readonly wordPolicy?:
                              | {
                                  readonly customWords: {
                                    readonly action: "BLOCKED" | "NONE"
                                    readonly match: string
                                    readonly detected?: boolean | undefined
                                  }
                                  readonly managedWordLists: {
                                    readonly type: "PROFANITY"
                                    readonly action: "BLOCKED" | "NONE"
                                    readonly match: string
                                    readonly detected?: boolean | undefined
                                  }
                                }
                              | undefined
                          }
                        }
                      | undefined
                    readonly modelOutput?: ReadonlyArray<string> | undefined
                    readonly outputAssessments?:
                      | {
                          readonly [x: string]: {
                            readonly contentPolicy?:
                              | {
                                  readonly filters: ReadonlyArray<{
                                    readonly type:
                                      | "HATE"
                                      | "INSULTS"
                                      | "MISCONDUCT"
                                      | "PROMPT_ATTACK"
                                      | "SEXUAL"
                                      | "VIOLENCE"
                                    readonly action: "BLOCKED" | "NONE"
                                    readonly confidence: "NONE" | "LOW" | "MEDIUM" | "HIGH"
                                    readonly detected?: boolean | undefined
                                    readonly filterStrength?: "NONE" | "LOW" | "MEDIUM" | "HIGH" | undefined
                                  }>
                                }
                              | undefined
                            readonly contextualGroundingPolicy?:
                              | {
                                  readonly filters?:
                                    | ReadonlyArray<{
                                        readonly type: "GROUNDING" | "RELEVANCE"
                                        readonly action: "BLOCKED" | "NONE"
                                        readonly score: number
                                        readonly threshold: number
                                        readonly detected?: boolean | undefined
                                      }>
                                    | undefined
                                }
                              | undefined
                            readonly invocationMetrics?:
                              | {
                                  readonly usage?:
                                    | {
                                        readonly contentPolicyUnits: number
                                        readonly contextualGroundingPolicyUnits: number
                                        readonly sensitiveInformationPolicyFreeUnits: number
                                        readonly sensitiveInformationPolicyUnits: number
                                        readonly topicPolicyUnits: number
                                        readonly wordPolicyUnits: number
                                        readonly contentPolicyImageUnits?: number | undefined
                                      }
                                    | undefined
                                  readonly guardrailCoverage?:
                                    | {
                                        readonly images?:
                                          | {
                                              readonly guarded?: number | undefined
                                              readonly total?: number | undefined
                                            }
                                          | undefined
                                        readonly textCharacters?:
                                          | {
                                              readonly guarded?: number | undefined
                                              readonly total?: number | undefined
                                            }
                                          | undefined
                                      }
                                    | undefined
                                  readonly guardrailProcessingLatency?: number | undefined
                                }
                              | undefined
                            readonly sensitiveInformationPolicy?:
                              | {
                                  readonly piiEntities: ReadonlyArray<{
                                    readonly type:
                                      | "ADDRESS"
                                      | "AGE"
                                      | "AWS_ACCESS_KEY"
                                      | "AWS_SECRET_KEY"
                                      | "CA_HEALTH_NUMBER"
                                      | "CA_SOCIAL_INSURANCE_NUMBER"
                                      | "CREDIT_DEBIT_CARD_CVV"
                                      | "CREDIT_DEBIT_CARD_EXPIRY"
                                      | "CREDIT_DEBIT_CARD_NUMBER"
                                      | "DRIVER_ID"
                                      | "EMAIL"
                                      | "INTERNATIONAL_BANK_ACCOUNT_NUMBER"
                                      | "IP_ADDRESS"
                                      | "LICENSE_PLATE"
                                      | "MAC_ADDRESS"
                                      | "NAME"
                                      | "PASSWORD"
                                      | "PHONE"
                                      | "PIN"
                                      | "SWIFT_CODE"
                                      | "UK_NATIONAL_HEALTH_SERVICE_NUMBER"
                                      | "UK_NATIONAL_INSURANCE_NUMBER"
                                      | "UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER"
                                      | "URL"
                                      | "USERNAME"
                                      | "US_BANK_ACCOUNT_NUMBER"
                                      | "US_BANK_ROUTING_NUMBER"
                                      | "US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER"
                                      | "US_PASSPORT_NUMBER"
                                      | "US_SOCIAL_SECURITY_NUMBER"
                                      | "VEHICLE_IDENTIFICATION_NUMBER"
                                    readonly action: "BLOCKED" | "NONE" | "ANONYMIZED"
                                    readonly match: string
                                    readonly detected?: boolean | undefined
                                  }>
                                  readonly regexes: ReadonlyArray<{
                                    readonly action: "BLOCKED" | "NONE" | "ANONYMIZED"
                                    readonly name?: string | undefined
                                    readonly detected?: boolean | undefined
                                    readonly match?: string | undefined
                                    readonly regex?: string | undefined
                                  }>
                                }
                              | undefined
                            readonly topicPolicy?:
                              | {
                                  readonly topics: ReadonlyArray<{
                                    readonly type: "DENY"
                                    readonly name: string
                                    readonly action: "BLOCKED" | "NONE"
                                    readonly detected?: boolean | undefined
                                  }>
                                }
                              | undefined
                            readonly wordPolicy?:
                              | {
                                  readonly customWords: {
                                    readonly action: "BLOCKED" | "NONE"
                                    readonly match: string
                                    readonly detected?: boolean | undefined
                                  }
                                  readonly managedWordLists: {
                                    readonly type: "PROFANITY"
                                    readonly action: "BLOCKED" | "NONE"
                                    readonly match: string
                                    readonly detected?: boolean | undefined
                                  }
                                }
                              | undefined
                          }
                        }
                      | undefined
                  }
                | undefined
              readonly promptRouter?: { readonly invokedModelId?: string | undefined } | undefined
            }
          | undefined
      }
    }
  | { readonly internalServerException: { readonly [x: string]: unknown } }
  | { readonly modelStreamErrorException: { readonly [x: string]: unknown } }
  | { readonly serviceUnavailableException: { readonly [x: string]: unknown } }
  | { readonly throttlingException: { readonly [x: string]: unknown } }
  | { readonly validationException: { readonly [x: string]: unknown } },
  never
>

Source

Since v1.0.0

ConverseStreamMetadataEvent (class)

Signature

declare class ConverseStreamMetadataEvent

Source

Since v1.0.0

ConverseStreamMetrics (class)

Signature

declare class ConverseStreamMetrics

Source

Since v1.0.0

ConverseStreamTrace (class)

Signature

declare class ConverseStreamTrace

Source

Since v1.0.0

ConverseTrace (class)

Signature

declare class ConverseTrace

Source

Since v1.0.0

DocumentBlock (class)

Signature

declare class DocumentBlock

Source

Since v1.0.0

DocumentFormat

Signature

declare const DocumentFormat: Schema.Literal<["csv", "doc", "docx", "html", "md", "pdf", "txt", "xls", "xlsx"]>

Source

Since v1.0.0

DocumentFormat (type alias)

Signature

type DocumentFormat = typeof DocumentFormat.Type

Source

Since v1.0.0

GuardrailAssessment (class)

Signature

declare class GuardrailAssessment

Source

Since v1.0.0

GuardrailConfiguration (class)

Signature

declare class GuardrailConfiguration

Source

Since v1.0.0

GuardrailContentFilter (class)

Signature

declare class GuardrailContentFilter

Source

Since v1.0.0

GuardrailContentPolicyAssessment (class)

Signature

declare class GuardrailContentPolicyAssessment

Source

Since v1.0.0

GuardrailContextualGroundingFilter (class)

Signature

declare class GuardrailContextualGroundingFilter

Source

Since v1.0.0

GuardrailContextualGroundingPolicyAssessment (class)

Signature

declare class GuardrailContextualGroundingPolicyAssessment

Source

Since v1.0.0

GuardrailConverseContentBlock (class)

Signature

declare class GuardrailConverseContentBlock

Source

Since v1.0.0

GuardrailConverseImageBlock (class)

Signature

declare class GuardrailConverseImageBlock

Source

Since v1.0.0

GuardrailConverseTextBlock (class)

Signature

declare class GuardrailConverseTextBlock

Source

Since v1.0.0

GuardrailCoverage (class)

Signature

declare class GuardrailCoverage

Source

Since v1.0.0

GuardrailCustomWord (class)

Signature

declare class GuardrailCustomWord

Source

Since v1.0.0

GuardrailImageCoverage (class)

Signature

declare class GuardrailImageCoverage

Source

Since v1.0.0

GuardrailInvocationMetrics (class)

Signature

declare class GuardrailInvocationMetrics

Source

Since v1.0.0

GuardrailManagedWord (class)

Signature

declare class GuardrailManagedWord

Source

Since v1.0.0

GuardrailPiiEntityFilter (class)

Signature

declare class GuardrailPiiEntityFilter

Source

Since v1.0.0

GuardrailRegexFilter (class)

Signature

declare class GuardrailRegexFilter

Source

Since v1.0.0

GuardrailSensitiveInformationPolicyAssessment (class)

Signature

declare class GuardrailSensitiveInformationPolicyAssessment

Source

Since v1.0.0

GuardrailTextCharactersCoverage (class)

Signature

declare class GuardrailTextCharactersCoverage

Source

Since v1.0.0

GuardrailTopic (class)

Signature

declare class GuardrailTopic

Source

Since v1.0.0

GuardrailTopicPolicyAssessment (class)

Signature

declare class GuardrailTopicPolicyAssessment

Source

Since v1.0.0

GuardrailTraceAssessment (class)

Signature

declare class GuardrailTraceAssessment

Source

Since v1.0.0

GuardrailUsage (class)

Signature

declare class GuardrailUsage

Source

Since v1.0.0

GuardrailWordPolicyAssessment (class)

Signature

declare class GuardrailWordPolicyAssessment

Source

Since v1.0.0

ImageBlock (class)

Signature

declare class ImageBlock

Source

Since v1.0.0

ImageFormat

Signature

declare const ImageFormat: Schema.Literal<["gif", "jpeg", "png", "webp"]>

Source

Since v1.0.0

ImageFormat (type alias)

Signature

type ImageFormat = typeof ImageFormat.Type

Source

Since v1.0.0

InferenceConfiguration (class)

Signature

declare class InferenceConfiguration

Source

Since v1.0.0

IntZeroOrGreater

Signature

declare const IntZeroOrGreater: Schema.filter<typeof Schema.Int>

Source

Since v1.0.0

JsonBlock (class)

Signature

declare class JsonBlock

Source

Since v1.0.0

Message (class)

Signature

declare class Message

Source

Since v1.0.0

MessageStartEvent (class)

Signature

declare class MessageStartEvent

Source

Since v1.0.0

MessageStopEvent (class)

Signature

declare class MessageStopEvent

Source

Since v1.0.0

PerformanceConfiguration (class)

Signature

declare class PerformanceConfiguration

Source

Since v1.0.0

PromptRouterTrace (class)

Signature

declare class PromptRouterTrace

Source

Since v1.0.0

ReasoningContentBlock (class)

Signature

declare class ReasoningContentBlock

Source

Since v1.0.0

ReasoningContentBlockDelta (class)

Signature

declare class ReasoningContentBlockDelta

Source

Since v1.0.0

StopReason

Signature

declare const StopReason: Schema.Literal<
  ["end_turn", "tool_use", "max_tokens", "stop_sequence", "guardrail_intervened", "content_filtered"]
>

Source

Since v1.0.0

StopReason (type alias)

Signature

type StopReason = typeof StopReason.Type

Source

Since v1.0.0

SystemContentBlock (class)

Signature

declare class SystemContentBlock

Source

Since v1.0.0

TokenUsage (class)

Signature

declare class TokenUsage

Source

Since v1.0.0

Tool (class)

Signature

declare class Tool

Source

Since v1.0.0

ToolChoice (class)

Signature

declare class ToolChoice

Source

Since v1.0.0

ToolConfiguration (class)

Signature

declare class ToolConfiguration

Source

Since v1.0.0

ToolResultBlock (class)

Signature

declare class ToolResultBlock

Source

Since v1.0.0

ToolSpecification (class)

Signature

declare class ToolSpecification

Source

Since v1.0.0

ToolUseBlock (class)

Signature

declare class ToolUseBlock

Source

Since v1.0.0

ToolUseBlockDelta (class)

Signature

declare class ToolUseBlockDelta

Source

Since v1.0.0

ToolUseBlockStart (class)

Signature

declare class ToolUseBlockStart

Source

Since v1.0.0

VideoBlock (class)

Signature

declare class VideoBlock

Source

Since v1.0.0