AmazonBedrockSchema.ts overview
Since v1.0.0
Exports Grouped by Category
- Schemas
- BedrockFoundationModelId (class)
- CachePointBlock (class)
- ContentBlock (class)
- ContentBlockDelta (class)
- ContentBlockDeltaEvent (class)
- ContentBlockStart (class)
- ContentBlockStartEvent (class)
- ContentBlockStopEvent (class)
- ConverseMetrics (class)
- ConverseOutput (class)
- ConverseRequest (class)
- ConverseResponse (class)
- ConverseStreamMetadataEvent (class)
- ConverseStreamMetrics (class)
- ConverseStreamResponse (class)
- ConverseStreamTrace (class)
- ConverseTrace (class)
- DocumentBlock (class)
- DocumentFormat
- DocumentFormat (type alias)
- GuardrailAssessment (class)
- GuardrailConfiguration (class)
- GuardrailContentFilter (class)
- GuardrailContentPolicyAssessment (class)
- GuardrailContextualGroundingFilter (class)
- GuardrailContextualGroundingPolicyAssessment (class)
- GuardrailConverseContentBlock (class)
- GuardrailConverseImageBlock (class)
- GuardrailConverseTextBlock (class)
- GuardrailCoverage (class)
- GuardrailCustomWord (class)
- GuardrailImageCoverage (class)
- GuardrailInvocationMetrics (class)
- GuardrailManagedWord (class)
- GuardrailPiiEntityFilter (class)
- GuardrailRegexFilter (class)
- GuardrailSensitiveInformationPolicyAssessment (class)
- GuardrailTextCharactersCoverage (class)
- GuardrailTopic (class)
- GuardrailTopicPolicyAssessment (class)
- GuardrailTraceAssessment (class)
- GuardrailUsage (class)
- GuardrailWordPolicyAssessment (class)
- ImageBlock (class)
- ImageFormat
- ImageFormat (type alias)
- InferenceConfiguration (class)
- IntZeroOrGreater
- JsonBlock (class)
- Message (class)
- MessageStartEvent (class)
- MessageStopEvent (class)
- PerformanceConfiguration (class)
- PromptRouterTrace (class)
- ReasoningContentBlock (class)
- ReasoningContentBlockDelta (class)
- StopReason
- StopReason (type alias)
- SystemContentBlock (class)
- TokenUsage (class)
- Tool (class)
- ToolChoice (class)
- ToolConfiguration (class)
- ToolResultBlock (class)
- ToolSpecification (class)
- ToolUseBlock (class)
- ToolUseBlockDelta (class)
- ToolUseBlockStart (class)
- VideoBlock (class)
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
Since v1.0.0
CachePointBlock (class)
Signature
declare class CachePointBlock
Since v1.0.0
ContentBlock (class)
Signature
declare class ContentBlock
Since v1.0.0
ContentBlockDelta (class)
Signature
declare class ContentBlockDelta
Since v1.0.0
ContentBlockDeltaEvent (class)
Signature
declare class ContentBlockDeltaEvent
Since v1.0.0
ContentBlockStart (class)
Signature
declare class ContentBlockStart
Since v1.0.0
ContentBlockStartEvent (class)
Signature
declare class ContentBlockStartEvent
Since v1.0.0
ContentBlockStopEvent (class)
Signature
declare class ContentBlockStopEvent
Since v1.0.0
ConverseMetrics (class)
Signature
declare class ConverseMetrics
Since v1.0.0
ConverseOutput (class)
Signature
declare class ConverseOutput
Since v1.0.0
ConverseRequest (class)
Signature
declare class ConverseRequest
Since v1.0.0
ConverseResponse (class)
Signature
declare class ConverseResponse
Since v1.0.0
ConverseStreamMetadataEvent (class)
Signature
declare class ConverseStreamMetadataEvent
Since v1.0.0
ConverseStreamMetrics (class)
Signature
declare class ConverseStreamMetrics
Since v1.0.0
ConverseStreamResponse (class)
Signature
declare class ConverseStreamResponse
Since v1.0.0
ConverseStreamTrace (class)
Signature
declare class ConverseStreamTrace
Since v1.0.0
ConverseTrace (class)
Signature
declare class ConverseTrace
Since v1.0.0
DocumentBlock (class)
Signature
declare class DocumentBlock
Since v1.0.0
DocumentFormat
Signature
declare const DocumentFormat: Schema.Literal<["csv", "doc", "docx", "html", "md", "pdf", "txt", "xls", "xlsx"]>
Since v1.0.0
DocumentFormat (type alias)
Signature
type DocumentFormat = typeof DocumentFormat.Type
Since v1.0.0
GuardrailAssessment (class)
Signature
declare class GuardrailAssessment
Since v1.0.0
GuardrailConfiguration (class)
Signature
declare class GuardrailConfiguration
Since v1.0.0
GuardrailContentFilter (class)
Signature
declare class GuardrailContentFilter
Since v1.0.0
GuardrailContentPolicyAssessment (class)
Signature
declare class GuardrailContentPolicyAssessment
Since v1.0.0
GuardrailContextualGroundingFilter (class)
Signature
declare class GuardrailContextualGroundingFilter
Since v1.0.0
GuardrailContextualGroundingPolicyAssessment (class)
Signature
declare class GuardrailContextualGroundingPolicyAssessment
Since v1.0.0
GuardrailConverseContentBlock (class)
Signature
declare class GuardrailConverseContentBlock
Since v1.0.0
GuardrailConverseImageBlock (class)
Signature
declare class GuardrailConverseImageBlock
Since v1.0.0
GuardrailConverseTextBlock (class)
Signature
declare class GuardrailConverseTextBlock
Since v1.0.0
GuardrailCoverage (class)
Signature
declare class GuardrailCoverage
Since v1.0.0
GuardrailCustomWord (class)
Signature
declare class GuardrailCustomWord
Since v1.0.0
GuardrailImageCoverage (class)
Signature
declare class GuardrailImageCoverage
Since v1.0.0
GuardrailInvocationMetrics (class)
Signature
declare class GuardrailInvocationMetrics
Since v1.0.0
GuardrailManagedWord (class)
Signature
declare class GuardrailManagedWord
Since v1.0.0
GuardrailPiiEntityFilter (class)
Signature
declare class GuardrailPiiEntityFilter
Since v1.0.0
GuardrailRegexFilter (class)
Signature
declare class GuardrailRegexFilter
Since v1.0.0
GuardrailSensitiveInformationPolicyAssessment (class)
Signature
declare class GuardrailSensitiveInformationPolicyAssessment
Since v1.0.0
GuardrailTextCharactersCoverage (class)
Signature
declare class GuardrailTextCharactersCoverage
Since v1.0.0
GuardrailTopic (class)
Signature
declare class GuardrailTopic
Since v1.0.0
GuardrailTopicPolicyAssessment (class)
Signature
declare class GuardrailTopicPolicyAssessment
Since v1.0.0
GuardrailTraceAssessment (class)
Signature
declare class GuardrailTraceAssessment
Since v1.0.0
GuardrailUsage (class)
Signature
declare class GuardrailUsage
Since v1.0.0
GuardrailWordPolicyAssessment (class)
Signature
declare class GuardrailWordPolicyAssessment
Since v1.0.0
ImageBlock (class)
Signature
declare class ImageBlock
Since v1.0.0
ImageFormat
Signature
declare const ImageFormat: Schema.Literal<["gif", "jpeg", "png", "webp"]>
Since v1.0.0
ImageFormat (type alias)
Signature
type ImageFormat = typeof ImageFormat.Type
Since v1.0.0
InferenceConfiguration (class)
Signature
declare class InferenceConfiguration
Since v1.0.0
IntZeroOrGreater
Signature
declare const IntZeroOrGreater: Schema.filter<typeof Schema.Int>
Since v1.0.0
JsonBlock (class)
Signature
declare class JsonBlock
Since v1.0.0
Message (class)
Signature
declare class Message
Since v1.0.0
MessageStartEvent (class)
Signature
declare class MessageStartEvent
Since v1.0.0
MessageStopEvent (class)
Signature
declare class MessageStopEvent
Since v1.0.0
PerformanceConfiguration (class)
Signature
declare class PerformanceConfiguration
Since v1.0.0
PromptRouterTrace (class)
Signature
declare class PromptRouterTrace
Since v1.0.0
ReasoningContentBlock (class)
Signature
declare class ReasoningContentBlock
Since v1.0.0
ReasoningContentBlockDelta (class)
Signature
declare class ReasoningContentBlockDelta
Since v1.0.0
StopReason
Signature
declare const StopReason: Schema.Literal<
["end_turn", "tool_use", "max_tokens", "stop_sequence", "guardrail_intervened", "content_filtered"]
>
Since v1.0.0
StopReason (type alias)
Signature
type StopReason = typeof StopReason.Type
Since v1.0.0
SystemContentBlock (class)
Signature
declare class SystemContentBlock
Since v1.0.0
TokenUsage (class)
Signature
declare class TokenUsage
Since v1.0.0
Tool (class)
Signature
declare class Tool
Since v1.0.0
ToolChoice (class)
Signature
declare class ToolChoice
Since v1.0.0
ToolConfiguration (class)
Signature
declare class ToolConfiguration
Since v1.0.0
ToolResultBlock (class)
Signature
declare class ToolResultBlock
Since v1.0.0
ToolSpecification (class)
Signature
declare class ToolSpecification
Since v1.0.0
ToolUseBlock (class)
Signature
declare class ToolUseBlock
Since v1.0.0
ToolUseBlockDelta (class)
Signature
declare class ToolUseBlockDelta
Since v1.0.0
ToolUseBlockStart (class)
Signature
declare class ToolUseBlockStart
Since v1.0.0
VideoBlock (class)
Signature
declare class VideoBlock
Since v1.0.0