GET
/v1/schemas/amazon-bedrock/chat/model/{modelId}/converse?kind=output
Accept:
| field | recorded source |
|---|---|
| schema | Source linked above. generated Source trace618bf3a6f4cb6e4987a01bd8ea2ce1f070e854991c750c67babf03520315dead{
"fetchedAt": 1791264064,
"extractorVersion": "1",
"verifiedAt": null
} |
Response body
8 properties · 4 required · 202 $defs| property | type | description | constraints |
|---|---|---|---|
| output* | ConverseOutput | The result from the call to Converse . | |
| stopReason* | enum | The reason why the model stopped generating output. | end_turn | tool_use | max_tokens | stop_sequence | guardrail_intervened | content_filtered · +3 more |
| usage* | TokenUsage | The total number of tokens used in the call to Converse . The total includes the tokens input to the model and the tokens generated by the model. | |
| metrics* | ConverseMetrics | Metrics for the call to Converse . | |
| additionalModelResponseFields | Document | Additional fields in the response that are unique to the model. | |
| trace | ConverseTrace | A trace object that contains information about the Guardrail behavior. | |
| performanceConfig | PerformanceConfiguration | Model performance settings for the request. | |
| serviceTier | ServiceTier | Specifies the processing tier configuration used for serving the request. |
Types
202 $defsAccountIdstring
AppliedGuardrailDetailsobject
Details about the specific guardrail that was applied during this assessment, including its identifier, version, ARN, origin, and ownership information.
| guardrailId | string | The unique ID of the guardrail that was applied. | length ≥ 0 · length ≤ 2048 |
| guardrailVersion | string | The version of the guardrail that was applied. | |
| guardrailArn | string | The ARN of the guardrail that was applied. | length ≥ 0 · length ≤ 2048 |
| guardrailOrigin | GuardrailOrigin[] | The origin of how the guardrail was applied. This can be either requested at the API level or enforced at the account or organization level as a default guardrail. | |
| guardrailOwnership | enum | The ownership type of the guardrail, indicating whether it is owned by the requesting account or is a cross-account guardrail shared from another AWS account. | SELF | CROSS_ACCOUNT |
AudioBlockobject
An audio content block that contains audio data in various supported formats.
| format* | enum | The format of the audio data, such as MP3, WAV, FLAC, or other supported audio formats. | mp3 | opus | wav | aac | flac | mp4 · +9 more |
| source* | AudioSource | The source of the audio data, which can be provided as raw bytes or an S3 location. | |
| error | ErrorBlock | Error information if the audio block could not be processed or contains invalid data. |
AudioFormatenum
mp3 | opus | wav | aac | flac | mp4 · +9 more
AudioSourceobject
The source of audio data, which can be provided either as raw bytes or a reference to an S3 location.
| bytes | string | Audio data encoded in base64. | |
| s3Location | S3Location | A reference to audio data stored in an Amazon S3 bucket. To see which models support S3 uploads, see Supported models and features for Converse . |
AudioSourceBytesBlobstring
AutomatedReasoningRuleIdentifierstring
length ≥ 0 · length ≤ 12
Blobstring
Booleanboolean
CacheDetailobject
Cache creation metrics for a specific TTL duration
| ttl* | enum | TTL duration for these cached tokens | 5m | 1h |
| inputTokens* | integer | Number of tokens written to cache with this TTL (cache creation tokens) | n ≥ 0 |
CacheDetailInputTokensIntegerinteger
n ≥ 0
CacheDetailsListCacheDetail[]
List of cache details by TTL
| ttl* | enum | TTL duration for these cached tokens | 5m | 1h |
| inputTokens* | integer | Number of tokens written to cache with this TTL (cache creation tokens) | n ≥ 0 |
CachePointBlockobject
Defines a section of content to be cached for reuse in subsequent API calls.
| type* | enum | Specifies the type of cache point within the CachePointBlock. | default |
| ttl | enum | Optional TTL duration for cache entries. When specified, enables extended TTL caching with the specified duration. When omitted, uses type value for caching behavior. | 5m | 1h |
CachePointTypeenum
default
CacheTTLenum
Time-to-live duration for ephemeral cache entries
5m | 1h
Citationobject
Contains information about a citation that references a specific source document. Citations provide traceability between the model's generated response and the source documents that informed that response.
| title | string | The title or identifier of the source document being cited. | |
| source | string | The source from the original search result that provided the cited content. | |
| sourceContent | CitationSourceContent[] | The specific content from the source document that was referenced or cited in the generated response. | |
| location | CitationLocation | The precise location within the source document where the cited content can be found, including character positions, page numbers, or chunk identifiers. |
CitationGeneratedContentobject
Contains the generated text content that corresponds to or is supported by a citation from a source document.
| text | string | The text content that was generated by the model and is supported by the associated citation. |
CitationGeneratedContentListCitationGeneratedContent[]
| text | string | The text content that was generated by the model and is supported by the associated citation. |
CitationLocationobject
Specifies the precise location within a source document where cited content can be found. This can include character-level positions, page numbers, or document chunks depending on the document type and indexing method.
| web | WebLocation | The web URL that was cited for this reference. | |
| documentChar | DocumentCharLocation | The character-level location within the document where the cited content is found. | |
| documentPage | DocumentPageLocation | The page-level location within the document where the cited content is found. | |
| documentChunk | DocumentChunkLocation | The chunk-level location within the document where the cited content is found, typically used for documents that have been segmented into logical chunks. | |
| searchResultLocation | SearchResultLocation | The search result location where the cited content is found, including the search result index and block positions within the content array. |
CitationsCitation[]
| title | string | The title or identifier of the source document being cited. | |
| source | string | The source from the original search result that provided the cited content. | |
| sourceContent | CitationSourceContent[] | The specific content from the source document that was referenced or cited in the generated response. | |
| location | CitationLocation | The precise location within the source document where the cited content can be found, including character positions, page numbers, or chunk identifiers. |
CitationsConfigobject
Configuration settings for enabling and controlling document citations in Converse API responses. When enabled, the model can include citation information that links generated content back to specific source documents.
| enabled* | boolean | Specifies whether citations from the selected document should be used in the model's response. When set to true, the model can generate citations that reference the source documents used to inform the response. |
CitationsContentBlockobject
A content block that contains both generated text and associated citation information. This block type is returned when document citations are enabled, providing traceability between the generated content and the source documents that informed the response.
| content | CitationGeneratedContent[] | The generated content that is supported by the associated citations. | |
| citations | Citation[] | An array of citations that reference the source documents used to generate the associated content. |
CitationSourceContentobject
Contains the actual text content from a source document that is being cited or referenced in the model's response.
| text | string | The text content from the source document that is being cited. |
CitationSourceContentListCitationSourceContent[]
| text | string | The text content from the source document that is being cited. |
ContentBlockobject
A block of content for a message that you pass to, or receive from, a model with the Converse or ConverseStream API operations.
| text | string | Text to include in the message. | |
| image | ImageBlock | Image to include in the message. This field is only supported by Anthropic Claude 3 models. | |
| document | DocumentBlock | A document to include in the message. | |
| video | VideoBlock | Video to include in the message. | |
| audio | AudioBlock | An audio content block containing audio data in the conversation. | |
| toolUse | ToolUseBlock | Information about a tool use request from a model. | |
| toolResult | ToolResultBlock | The result for a tool request that a model makes. | |
| guardContent | GuardrailConverseContentBlock | Contains the content to assess with the guardrail. If you don't specify guardContent in a call to the Converse API, the guardrail (if passed in the Converse API) assesses the entire message. For more information, see Use a guardrail with the Converse API in th… | |
| cachePoint | CachePointBlock | CachePoint to include in the message. | |
| reasoningContent | ReasoningContentBlock | Contains content regarding the reasoning that is carried out by the model. Reasoning refers to a Chain of Thought (CoT) that the model generates to enhance the accuracy of its final response. | |
| citationsContent | CitationsContentBlock | A content block that contains both generated text and associated citation information, providing traceability between the response and source documents. | |
| searchResult | SearchResultBlock | Search result to include in the message. | |
| toolAddition | ToolAdditionBlock | A content block for adding a tool to the available tool set mid-conversation. Each block references a single tool via its tool field. Use within a system role message to make a tool available without re-sending the full tool configuration. | |
| toolRemoval | ToolRemovalBlock | A content block for removing a tool from the available tool set mid-conversation. Each block references a single tool via its tool field. Use within a system role message to remove a tool without re-sending the full tool configuration. |
ContentBlocksContentBlock[]
| text | string | Text to include in the message. | |
| image | ImageBlock | Image to include in the message. This field is only supported by Anthropic Claude 3 models. | |
| document | DocumentBlock | A document to include in the message. | |
| video | VideoBlock | Video to include in the message. | |
| audio | AudioBlock | An audio content block containing audio data in the conversation. | |
| toolUse | ToolUseBlock | Information about a tool use request from a model. | |
| toolResult | ToolResultBlock | The result for a tool request that a model makes. | |
| guardContent | GuardrailConverseContentBlock | Contains the content to assess with the guardrail. If you don't specify guardContent in a call to the Converse API, the guardrail (if passed in the Converse API) assesses the entire message. For more information, see Use a guardrail with the Converse API in th… | |
| cachePoint | CachePointBlock | CachePoint to include in the message. | |
| reasoningContent | ReasoningContentBlock | Contains content regarding the reasoning that is carried out by the model. Reasoning refers to a Chain of Thought (CoT) that the model generates to enhance the accuracy of its final response. | |
| citationsContent | CitationsContentBlock | A content block that contains both generated text and associated citation information, providing traceability between the response and source documents. | |
| searchResult | SearchResultBlock | Search result to include in the message. | |
| toolAddition | ToolAdditionBlock | A content block for adding a tool to the available tool set mid-conversation. Each block references a single tool via its tool field. Use within a system role message to make a tool available without re-sending the full tool configuration. | |
| toolRemoval | ToolRemovalBlock | A content block for removing a tool from the available tool set mid-conversation. Each block references a single tool via its tool field. Use within a system role message to remove a tool without re-sending the full tool configuration. |
ConversationRoleenum
user | assistant | system
ConverseMetricsobject
Metrics for a call to Converse .
| latencyMs* | integer | The latency of the call to Converse , in milliseconds. |
ConverseOutputobject
The output from a call to Converse .
| message | Message | The message that the model generates. |
ConverseTraceobject
The trace object in a response from Converse .
| guardrail | GuardrailTraceAssessment | The guardrail trace object. | |
| promptRouter | PromptRouterTrace | The request's prompt router. |
Documentany
DocumentBlockobject
A document to include in a message.
| format | enum | The format of a document, or its extension. | pdf | csv | doc | docx | xls | xlsx · +3 more |
| name* | string | A name for the document. The name can only contain the following characters: Alphanumeric characters Whitespace characters (no more than one in a row) Hyphens Parentheses Square brackets This field is vulnerable to prompt injections, because the model might in… | length ≥ 1 · length ≤ 200 |
| source* | DocumentSource | Contains the content of the document. | |
| context | string | Contextual information about how the document should be processed or interpreted by the model when generating citations. | |
| citations | CitationsConfig | Configuration settings that control how citations should be generated for this specific document. |
DocumentBlockNameStringstring
length ≥ 1 · length ≤ 200
DocumentCharLocationobject
Specifies a character-level location within a document, providing precise positioning information for cited content using start and end character indices.
| documentIndex | integer | The index of the document within the array of documents provided in the request. | n ≥ 0 |
| start | integer | The starting character position of the cited content within the document. | n ≥ 0 |
| end | integer | The ending character position of the cited content within the document. | n ≥ 0 |
DocumentCharLocationDocumentIndexIntegerinteger
n ≥ 0
DocumentCharLocationEndIntegerinteger
n ≥ 0
DocumentCharLocationStartIntegerinteger
n ≥ 0
DocumentChunkLocationobject
Specifies a chunk-level location within a document, providing positioning information for cited content using logical document segments or chunks.
| documentIndex | integer | The index of the document within the array of documents provided in the request. | n ≥ 0 |
| start | integer | The starting chunk identifier or index of the cited content within the document. | n ≥ 0 |
| end | integer | The ending chunk identifier or index of the cited content within the document. | n ≥ 0 |
DocumentChunkLocationDocumentIndexIntegerinteger
n ≥ 0
DocumentChunkLocationEndIntegerinteger
n ≥ 0
DocumentChunkLocationStartIntegerinteger
n ≥ 0
DocumentContentBlockobject
Contains the actual content of a document that can be processed by the model and potentially cited in the response.
| text | string | The text content of the document. |
DocumentContentBlocksDocumentContentBlock[]
| text | string | The text content of the document. |
DocumentFormatenum
pdf | csv | doc | docx | xls | xlsx · +3 more
DocumentPageLocationobject
Specifies a page-level location within a document, providing positioning information for cited content using page numbers.
| documentIndex | integer | The index of the document within the array of documents provided in the request. | n ≥ 0 |
| start | integer | The starting page number of the cited content within the document. | n ≥ 0 |
| end | integer | The ending page number of the cited content within the document. | n ≥ 0 |
DocumentPageLocationDocumentIndexIntegerinteger
n ≥ 0
DocumentPageLocationEndIntegerinteger
n ≥ 0
DocumentPageLocationStartIntegerinteger
n ≥ 0
DocumentSourceobject
Contains the content of a document.
| bytes | string | The raw bytes for the document. If you use an Amazon Web Services SDK, you don't need to encode the bytes in base64. | |
| s3Location | S3Location | The location of a document object in an Amazon S3 bucket. To see which models support S3 uploads, see Supported models and features for Converse . | |
| text | string | The text content of the document source. | |
| content | DocumentContentBlock[] | The structured content of the document source, which may include various content blocks such as text, images, or other document elements. |
DocumentSourceBytesBlobstring
ErrorBlockobject
A block containing error information when content processing fails.
| message | string | A human-readable error message describing what went wrong during content processing. |
GuardrailArnstring
length ≥ 0 · length ≤ 2048
GuardrailAssessmentobject
A behavior assessment of the guardrail policies used in a call to the Converse API.
| topicPolicy | GuardrailTopicPolicyAssessment | The topic policy. | |
| contentPolicy | GuardrailContentPolicyAssessment | The content policy. | |
| wordPolicy | GuardrailWordPolicyAssessment | The word policy. | |
| sensitiveInformationPolicy | GuardrailSensitiveInformationPolicyAssessment | The sensitive information policy. | |
| contextualGroundingPolicy | GuardrailContextualGroundingPolicyAssessment | The contextual grounding policy used for the guardrail assessment. | |
| automatedReasoningPolicy | GuardrailAutomatedReasoningPolicyAssessment | The automated reasoning policy assessment results, including logical validation findings for the input content. | |
| invocationMetrics | GuardrailInvocationMetrics | The invocation metrics for the guardrail assessment. | |
| appliedGuardrailDetails | AppliedGuardrailDetails | Details about the specific guardrail that was applied during this assessment, including its identifier, version, ARN, origin, and ownership information. |
GuardrailAssessmentListGuardrailAssessment[]
| topicPolicy | GuardrailTopicPolicyAssessment | The topic policy. | |
| contentPolicy | GuardrailContentPolicyAssessment | The content policy. | |
| wordPolicy | GuardrailWordPolicyAssessment | The word policy. | |
| sensitiveInformationPolicy | GuardrailSensitiveInformationPolicyAssessment | The sensitive information policy. | |
| contextualGroundingPolicy | GuardrailContextualGroundingPolicyAssessment | The contextual grounding policy used for the guardrail assessment. | |
| automatedReasoningPolicy | GuardrailAutomatedReasoningPolicyAssessment | The automated reasoning policy assessment results, including logical validation findings for the input content. | |
| invocationMetrics | GuardrailInvocationMetrics | The invocation metrics for the guardrail assessment. | |
| appliedGuardrailDetails | AppliedGuardrailDetails | Details about the specific guardrail that was applied during this assessment, including its identifier, version, ARN, origin, and ownership information. |
GuardrailAssessmentListMapobject
GuardrailAssessmentMapobject
GuardrailAutomatedReasoningDifferenceScenarioListGuardrailAutomatedReasoningScenario[]
| statements | GuardrailAutomatedReasoningStatement[] | List of logical assignments and statements that define this scenario. |
GuardrailAutomatedReasoningFindingobject
Represents a logical validation result from automated reasoning policy evaluation. The finding indicates whether claims in the input are logically valid, invalid, satisfiable, impossible, or have other logical issues.
| valid | GuardrailAutomatedReasoningValidFinding | Contains the result when the automated reasoning evaluation determines that the claims in the input are logically valid and definitively true based on the provided premises and policy rules. | |
| invalid | GuardrailAutomatedReasoningInvalidFinding | Contains the result when the automated reasoning evaluation determines that the claims in the input are logically invalid and contradict the established premises or policy rules. | |
| satisfiable | GuardrailAutomatedReasoningSatisfiableFinding | Contains the result when the automated reasoning evaluation determines that the claims in the input could be either true or false depending on additional assumptions not provided in the input context. | |
| impossible | GuardrailAutomatedReasoningImpossibleFinding | Contains the result when the automated reasoning evaluation determines that no valid logical conclusions can be drawn due to contradictions in the premises or policy rules themselves. | |
| translationAmbiguous | GuardrailAutomatedReasoningTranslationAmbiguousFinding | Contains the result when the automated reasoning evaluation detects that the input has multiple valid logical interpretations, requiring additional context or clarification to proceed with validation. | |
| tooComplex | GuardrailAutomatedReasoningTooComplexFinding | Contains the result when the automated reasoning evaluation cannot process the input due to its complexity or volume exceeding the system's processing capacity for logical analysis. | |
| noTranslations | GuardrailAutomatedReasoningNoTranslationsFinding | Contains the result when the automated reasoning evaluation cannot extract any relevant logical information from the input that can be validated against the policy rules. |
GuardrailAutomatedReasoningFindingListGuardrailAutomatedReasoningFinding[]
| valid | GuardrailAutomatedReasoningValidFinding | Contains the result when the automated reasoning evaluation determines that the claims in the input are logically valid and definitively true based on the provided premises and policy rules. | |
| invalid | GuardrailAutomatedReasoningInvalidFinding | Contains the result when the automated reasoning evaluation determines that the claims in the input are logically invalid and contradict the established premises or policy rules. | |
| satisfiable | GuardrailAutomatedReasoningSatisfiableFinding | Contains the result when the automated reasoning evaluation determines that the claims in the input could be either true or false depending on additional assumptions not provided in the input context. | |
| impossible | GuardrailAutomatedReasoningImpossibleFinding | Contains the result when the automated reasoning evaluation determines that no valid logical conclusions can be drawn due to contradictions in the premises or policy rules themselves. | |
| translationAmbiguous | GuardrailAutomatedReasoningTranslationAmbiguousFinding | Contains the result when the automated reasoning evaluation detects that the input has multiple valid logical interpretations, requiring additional context or clarification to proceed with validation. | |
| tooComplex | GuardrailAutomatedReasoningTooComplexFinding | Contains the result when the automated reasoning evaluation cannot process the input due to its complexity or volume exceeding the system's processing capacity for logical analysis. | |
| noTranslations | GuardrailAutomatedReasoningNoTranslationsFinding | Contains the result when the automated reasoning evaluation cannot extract any relevant logical information from the input that can be validated against the policy rules. |
GuardrailAutomatedReasoningImpossibleFindingobject
Indicates that no valid claims can be made due to logical contradictions in the premises or rules.
| translation | GuardrailAutomatedReasoningTranslation | The logical translation of the input that this finding evaluates. | |
| contradictingRules | GuardrailAutomatedReasoningRule[] | The automated reasoning policy rules that contradict the claims and/or premises in the input. | |
| logicWarning | GuardrailAutomatedReasoningLogicWarning | Indication of a logic issue with the translation without needing to consider the automated reasoning policy rules. |
GuardrailAutomatedReasoningInputTextReferenceobject
References a portion of the original input text that corresponds to logical elements.
| text | string | The specific text from the original input that this reference points to. | length ≥ 0 · length ≤ 1000 |
GuardrailAutomatedReasoningInputTextReferenceListGuardrailAutomatedReasoningInputTextReference[]
| text | string | The specific text from the original input that this reference points to. | length ≥ 0 · length ≤ 1000 |
GuardrailAutomatedReasoningInvalidFindingobject
Indicates that the claims are logically false and contradictory to the established rules or premises.
| translation | GuardrailAutomatedReasoningTranslation | The logical translation of the input that this finding invalidates. | |
| contradictingRules | GuardrailAutomatedReasoningRule[] | The automated reasoning policy rules that contradict the claims in the input. | |
| logicWarning | GuardrailAutomatedReasoningLogicWarning | Indication of a logic issue with the translation without needing to consider the automated reasoning policy rules. |
GuardrailAutomatedReasoningLogicWarningobject
Identifies logical issues in the translated statements that exist independent of any policy rules, such as statements that are always true or always false.
| type | enum | The category of the detected logical issue, such as statements that are always true or always false. | ALWAYS_FALSE | ALWAYS_TRUE |
| premises | GuardrailAutomatedReasoningStatement[] | The logical statements that serve as premises under which the claims are validated. | |
| claims | GuardrailAutomatedReasoningStatement[] | The logical statements that are validated while assuming the policy and premises. |
GuardrailAutomatedReasoningLogicWarningTypeenum
ALWAYS_FALSE | ALWAYS_TRUE
GuardrailAutomatedReasoningNoTranslationsFindingobject
Indicates that no relevant logical information could be extracted from the input for validation.
GuardrailAutomatedReasoningPoliciesProcessedinteger
GuardrailAutomatedReasoningPolicyAssessmentobject
Contains the results of automated reasoning policy evaluation, including logical findings about the validity of claims made in the input content.
| findings | GuardrailAutomatedReasoningFinding[] | List of logical validation results produced by evaluating the input content against automated reasoning policies. |
GuardrailAutomatedReasoningPolicyUnitsProcessedinteger
GuardrailAutomatedReasoningPolicyVersionArnstring
length ≥ 0 · length ≤ 2048
GuardrailAutomatedReasoningRuleobject
References a specific automated reasoning policy rule that was applied during evaluation.
| identifier | string | The unique identifier of the automated reasoning rule. | length ≥ 0 · length ≤ 12 |
| policyVersionArn | string | The ARN of the automated reasoning policy version that contains this rule. | length ≥ 0 · length ≤ 2048 |
GuardrailAutomatedReasoningRuleListGuardrailAutomatedReasoningRule[]
| identifier | string | The unique identifier of the automated reasoning rule. | length ≥ 0 · length ≤ 12 |
| policyVersionArn | string | The ARN of the automated reasoning policy version that contains this rule. | length ≥ 0 · length ≤ 2048 |
GuardrailAutomatedReasoningSatisfiableFindingobject
Indicates that the claims could be either true or false depending on additional assumptions not provided in the input.
| translation | GuardrailAutomatedReasoningTranslation | The logical translation of the input that this finding evaluates. | |
| claimsTrueScenario | GuardrailAutomatedReasoningScenario | An example scenario demonstrating how the claims could be logically true. | |
| claimsFalseScenario | GuardrailAutomatedReasoningScenario | An example scenario demonstrating how the claims could be logically false. | |
| logicWarning | GuardrailAutomatedReasoningLogicWarning | Indication of a logic issue with the translation without needing to consider the automated reasoning policy rules. |
GuardrailAutomatedReasoningScenarioobject
Represents a logical scenario where claims can be evaluated as true or false, containing specific logical assignments.
| statements | GuardrailAutomatedReasoningStatement[] | List of logical assignments and statements that define this scenario. |
GuardrailAutomatedReasoningStatementobject
A logical statement that includes both formal logic representation and natural language explanation.
| logic | string | The formal logical representation of the statement. | length ≥ 0 · length ≤ 1000 |
| naturalLanguage | string | The natural language explanation of the logical statement. | length ≥ 0 · length ≤ 1000 |
GuardrailAutomatedReasoningStatementListGuardrailAutomatedReasoningStatement[]
| logic | string | The formal logical representation of the statement. | length ≥ 0 · length ≤ 1000 |
| naturalLanguage | string | The natural language explanation of the logical statement. | length ≥ 0 · length ≤ 1000 |
GuardrailAutomatedReasoningStatementLogicContentstring
length ≥ 0 · length ≤ 1000
GuardrailAutomatedReasoningStatementNaturalLanguageContentstring
length ≥ 0 · length ≤ 1000
GuardrailAutomatedReasoningTooComplexFindingobject
Indicates that the input exceeds the processing capacity due to the volume or complexity of the logical information.
GuardrailAutomatedReasoningTranslationobject
Contains the logical translation of natural language input into formal logical statements, including premises, claims, and confidence scores.
| premises | GuardrailAutomatedReasoningStatement[] | The logical statements that serve as the foundation or assumptions for the claims. | |
| claims | GuardrailAutomatedReasoningStatement[] | The logical statements that are being validated against the premises and policy rules. | |
| untranslatedPremises | GuardrailAutomatedReasoningInputTextReference[] | References to portions of the original input text that correspond to the premises but could not be fully translated. | |
| untranslatedClaims | GuardrailAutomatedReasoningInputTextReference[] | References to portions of the original input text that correspond to the claims but could not be fully translated. | |
| confidence | number | A confidence score between 0 and 1 indicating how certain the system is about the logical translation. | 0 ≤ n ≤ 1 |
GuardrailAutomatedReasoningTranslationAmbiguousFindingobject
Indicates that the input has multiple valid logical interpretations, requiring additional context or clarification.
| options | GuardrailAutomatedReasoningTranslationOption[] | Different logical interpretations that were detected during translation of the input. | items ≥ 0 · items ≤ 2 |
| differenceScenarios | GuardrailAutomatedReasoningScenario[] | Scenarios showing how the different translation options differ in meaning. | items ≥ 0 · items ≤ 2 |
GuardrailAutomatedReasoningTranslationConfidencenumber
0 ≤ n ≤ 1
GuardrailAutomatedReasoningTranslationListGuardrailAutomatedReasoningTranslation[]
| premises | GuardrailAutomatedReasoningStatement[] | The logical statements that serve as the foundation or assumptions for the claims. | |
| claims | GuardrailAutomatedReasoningStatement[] | The logical statements that are being validated against the premises and policy rules. | |
| untranslatedPremises | GuardrailAutomatedReasoningInputTextReference[] | References to portions of the original input text that correspond to the premises but could not be fully translated. | |
| untranslatedClaims | GuardrailAutomatedReasoningInputTextReference[] | References to portions of the original input text that correspond to the claims but could not be fully translated. | |
| confidence | number | A confidence score between 0 and 1 indicating how certain the system is about the logical translation. | 0 ≤ n ≤ 1 |
GuardrailAutomatedReasoningTranslationOptionobject
Represents one possible logical interpretation of ambiguous input content.
| translations | GuardrailAutomatedReasoningTranslation[] | Example translations that provide this possible interpretation of the input. |
GuardrailAutomatedReasoningTranslationOptionListGuardrailAutomatedReasoningTranslationOption[]
| translations | GuardrailAutomatedReasoningTranslation[] | Example translations that provide this possible interpretation of the input. |
GuardrailAutomatedReasoningValidFindingobject
Indicates that the claims are definitively true and logically implied by the premises, with no possible alternative interpretations.
| translation | GuardrailAutomatedReasoningTranslation | The logical translation of the input that this finding validates. | |
| claimsTrueScenario | GuardrailAutomatedReasoningScenario | An example scenario demonstrating how the claims are logically true. | |
| supportingRules | GuardrailAutomatedReasoningRule[] | The automated reasoning policy rules that support why this result is considered valid. | |
| logicWarning | GuardrailAutomatedReasoningLogicWarning | Indication of a logic issue with the translation without needing to consider the automated reasoning policy rules. |
GuardrailContentFilterobject
The content filter for a guardrail.
| type* | enum | The guardrail type. | INSULTS | HATE | SEXUAL | VIOLENCE | MISCONDUCT | PROMPT_ATTACK |
| confidence* | enum | The guardrail confidence. | NONE | LOW | MEDIUM | HIGH |
| filterStrength | enum | The filter strength setting for the guardrail content filter. | NONE | LOW | MEDIUM | HIGH |
| action* | enum | The guardrail action. | BLOCKED | NONE |
| detected | boolean | Indicates whether content that breaches the guardrail configuration is detected. |
GuardrailContentFilterConfidenceenum
NONE | LOW | MEDIUM | HIGH
GuardrailContentFilterListGuardrailContentFilter[]
| type* | enum | The guardrail type. | INSULTS | HATE | SEXUAL | VIOLENCE | MISCONDUCT | PROMPT_ATTACK |
| confidence* | enum | The guardrail confidence. | NONE | LOW | MEDIUM | HIGH |
| filterStrength | enum | The filter strength setting for the guardrail content filter. | NONE | LOW | MEDIUM | HIGH |
| action* | enum | The guardrail action. | BLOCKED | NONE |
| detected | boolean | Indicates whether content that breaches the guardrail configuration is detected. |
GuardrailContentFilterStrengthenum
NONE | LOW | MEDIUM | HIGH
GuardrailContentFilterTypeenum
INSULTS | HATE | SEXUAL | VIOLENCE | MISCONDUCT | PROMPT_ATTACK
GuardrailContentPolicyActionenum
BLOCKED | NONE
GuardrailContentPolicyAssessmentobject
An assessment of a content policy for a guardrail.
| filters* | GuardrailContentFilter[] | The content policy filters. |
GuardrailContentPolicyImageUnitsProcessedinteger
GuardrailContentPolicyUnitsProcessedinteger
GuardrailContextualGroundingFilterobject
The details for the guardrails contextual grounding filter.
| type* | enum | The contextual grounding filter type. | GROUNDING | RELEVANCE |
| threshold* | number | The threshold used by contextual grounding filter to determine whether the content is grounded or not. | 0 ≤ n ≤ 1 |
| score* | number | The score generated by contextual grounding filter. | 0 ≤ n ≤ 1 |
| action* | enum | The action performed by the guardrails contextual grounding filter. | BLOCKED | NONE |
| detected | boolean | Indicates whether content that fails the contextual grounding evaluation (grounding or relevance score less than the corresponding threshold) was detected. |
GuardrailContextualGroundingFiltersGuardrailContextualGroundingFilter[]
| type* | enum | The contextual grounding filter type. | GROUNDING | RELEVANCE |
| threshold* | number | The threshold used by contextual grounding filter to determine whether the content is grounded or not. | 0 ≤ n ≤ 1 |
| score* | number | The score generated by contextual grounding filter. | 0 ≤ n ≤ 1 |
| action* | enum | The action performed by the guardrails contextual grounding filter. | BLOCKED | NONE |
| detected | boolean | Indicates whether content that fails the contextual grounding evaluation (grounding or relevance score less than the corresponding threshold) was detected. |
GuardrailContextualGroundingFilterScoreDoublenumber
0 ≤ n ≤ 1
GuardrailContextualGroundingFilterThresholdDoublenumber
0 ≤ n ≤ 1
GuardrailContextualGroundingFilterTypeenum
GROUNDING | RELEVANCE
GuardrailContextualGroundingPolicyActionenum
BLOCKED | NONE
GuardrailContextualGroundingPolicyAssessmentobject
The policy assessment details for the guardrails contextual grounding filter.
| filters | GuardrailContextualGroundingFilter[] | The filter details for the guardrails contextual grounding filter. |
GuardrailContextualGroundingPolicyUnitsProcessedinteger
GuardrailConverseContentBlockobject
A content block for selective guarding with the Converse or ConverseStream API operations.
| text | GuardrailConverseTextBlock | The text to guard. | |
| image | GuardrailConverseImageBlock | Image within converse content block to be evaluated by the guardrail. |
GuardrailConverseContentQualifierenum
grounding_source | query | guard_content
GuardrailConverseContentQualifierListGuardrailConverseContentQualifier[]
GuardrailConverseImageBlockobject
An image block that contains images that you want to assess with a guardrail.
| format* | enum | The format details for the image type of the guardrail converse image block. | png | jpeg |
| source* | GuardrailConverseImageSource | The image source (image bytes) of the guardrail converse image block. |
GuardrailConverseImageFormatenum
png | jpeg
GuardrailConverseImageSourceobject
The image source (image bytes) of the guardrail converse image source.
| bytes | string | The raw image bytes for the image. |
GuardrailConverseImageSourceBytesBlobstring
GuardrailConverseTextBlockobject
A text block that contains text that you want to assess with a guardrail. For more information, see GuardrailConverseContentBlock .
| text* | string | The text that you want to guard. | |
| qualifiers | GuardrailConverseContentQualifier[] | The qualifier details for the guardrails contextual grounding filter. |
GuardrailCoverageobject
The action of the guardrail coverage details.
| textCharacters | GuardrailTextCharactersCoverage | The text characters of the guardrail coverage details. | |
| images | GuardrailImageCoverage | The guardrail coverage for images (the number of images that guardrails guarded). |
GuardrailCustomWordobject
A custom word configured in a guardrail.
| match* | string | The match for the custom word. | |
| action* | enum | The action for the custom word. | BLOCKED | NONE |
| detected | boolean | Indicates whether custom word content that breaches the guardrail configuration is detected. |
GuardrailCustomWordListGuardrailCustomWord[]
| match* | string | The match for the custom word. | |
| action* | enum | The action for the custom word. | BLOCKED | NONE |
| detected | boolean | Indicates whether custom word content that breaches the guardrail configuration is detected. |
GuardrailIdstring
length ≥ 0 · length ≤ 2048
GuardrailImageCoverageobject
The details of the guardrail image coverage.
| guarded | integer | The count (integer) of images guardrails guarded. | |
| total | integer | Represents the total number of images (integer) that were in the request (guarded and unguarded). |
GuardrailInvocationMetricsobject
The invocation metrics for the guardrail.
| guardrailProcessingLatency | integer | The processing latency details for the guardrail invocation metrics. | |
| usage | GuardrailUsage | The usage details for the guardrail invocation metrics. | |
| guardrailCoverage | GuardrailCoverage | The coverage details for the guardrail invocation metrics. |
GuardrailManagedWordobject
A managed word configured in a guardrail.
| match* | string | The match for the managed word. | |
| type* | enum | The type for the managed word. | PROFANITY |
| action* | enum | The action for the managed word. | BLOCKED | NONE |
| detected | boolean | Indicates whether managed word content that breaches the guardrail configuration is detected. |
GuardrailManagedWordListGuardrailManagedWord[]
| match* | string | The match for the managed word. | |
| type* | enum | The type for the managed word. | PROFANITY |
| action* | enum | The action for the managed word. | BLOCKED | NONE |
| detected | boolean | Indicates whether managed word content that breaches the guardrail configuration is detected. |
GuardrailManagedWordTypeenum
PROFANITY
GuardrailOriginenum
REQUEST | ACCOUNT_ENFORCED | ORGANIZATION_ENFORCED
GuardrailOriginListGuardrailOrigin[]
GuardrailOutputTextstring
GuardrailOwnershipenum
SELF | CROSS_ACCOUNT
GuardrailPiiEntityFilterobject
A Personally Identifiable Information (PII) entity configured in a guardrail.
| match* | string | The PII entity filter match. | |
| type* | enum | The PII entity filter type. | ADDRESS | AGE | AWS_ACCESS_KEY | AWS_SECRET_KEY | CA_HEALTH_NUMBER | CA_SOCIAL_INSURANCE_NUMBER · +25 more |
| action* | enum | The PII entity filter action. | ANONYMIZED | BLOCKED | NONE |
| detected | boolean | Indicates whether personally identifiable information (PII) that breaches the guardrail configuration is detected. |
GuardrailPiiEntityFilterListGuardrailPiiEntityFilter[]
| match* | string | The PII entity filter match. | |
| type* | enum | The PII entity filter type. | ADDRESS | AGE | AWS_ACCESS_KEY | AWS_SECRET_KEY | CA_HEALTH_NUMBER | CA_SOCIAL_INSURANCE_NUMBER · +25 more |
| action* | enum | The PII entity filter action. | ANONYMIZED | BLOCKED | NONE |
| detected | boolean | Indicates whether personally identifiable information (PII) that breaches the guardrail configuration is detected. |
GuardrailPiiEntityTypeenum
ADDRESS | AGE | AWS_ACCESS_KEY | AWS_SECRET_KEY | CA_HEALTH_NUMBER | CA_SOCIAL_INSURANCE_NUMBER · +25 more
GuardrailProcessingLatencyinteger
GuardrailRegexFilterobject
A Regex filter configured in a guardrail.
| name | string | The regex filter name. | |
| match | string | The regesx filter match. | |
| regex | string | The regex query. | |
| action* | enum | The region filter action. | ANONYMIZED | BLOCKED | NONE |
| detected | boolean | Indicates whether custom regex entities that breach the guardrail configuration are detected. |
GuardrailRegexFilterListGuardrailRegexFilter[]
| name | string | The regex filter name. | |
| match | string | The regesx filter match. | |
| regex | string | The regex query. | |
| action* | enum | The region filter action. | ANONYMIZED | BLOCKED | NONE |
| detected | boolean | Indicates whether custom regex entities that breach the guardrail configuration are detected. |
GuardrailSensitiveInformationPolicyActionenum
ANONYMIZED | BLOCKED | NONE
GuardrailSensitiveInformationPolicyAssessmentobject
The assessment for a Personally Identifiable Information (PII) policy.
| piiEntities* | GuardrailPiiEntityFilter[] | The PII entities in the assessment. | |
| regexes* | GuardrailRegexFilter[] | The regex queries in the assessment. |
GuardrailSensitiveInformationPolicyFreeUnitsProcessedinteger
GuardrailSensitiveInformationPolicyUnitsProcessedinteger
GuardrailTextCharactersCoverageobject
The guardrail coverage for the text characters.
| guarded | integer | The text characters that were guarded by the guardrail coverage. | |
| total | integer | The total text characters by the guardrail coverage. |
GuardrailTopicobject
Information about a topic guardrail.
| name* | string | The name for the guardrail. | |
| type* | enum | The type behavior that the guardrail should perform when the model detects the topic. | DENY |
| action* | enum | The action the guardrail should take when it intervenes on a topic. | BLOCKED | NONE |
| detected | boolean | Indicates whether topic content that breaches the guardrail configuration is detected. |
GuardrailTopicListGuardrailTopic[]
| name* | string | The name for the guardrail. | |
| type* | enum | The type behavior that the guardrail should perform when the model detects the topic. | DENY |
| action* | enum | The action the guardrail should take when it intervenes on a topic. | BLOCKED | NONE |
| detected | boolean | Indicates whether topic content that breaches the guardrail configuration is detected. |
GuardrailTopicPolicyActionenum
BLOCKED | NONE
GuardrailTopicPolicyAssessmentobject
A behavior assessment of a topic policy.
| topics* | GuardrailTopic[] | The topics in the assessment. |
GuardrailTopicPolicyUnitsProcessedinteger
GuardrailTopicTypeenum
DENY
GuardrailTraceAssessmentobject
A Top level guardrail trace object. For more information, see ConverseTrace .
| modelOutput | GuardrailOutputText[] | The output from the model. | |
| inputAssessment | GuardrailAssessmentMap | The input assessment. | |
| outputAssessments | GuardrailAssessmentListMap | the output assessments. | |
| actionReason | string | Provides the reason for the action taken when harmful content is detected. |
GuardrailUsageobject
The details on the use of the guardrail.
| topicPolicyUnits* | integer | The topic policy units processed by the guardrail. | |
| contentPolicyUnits* | integer | The content policy units processed by the guardrail. | |
| wordPolicyUnits* | integer | The word policy units processed by the guardrail. | |
| sensitiveInformationPolicyUnits* | integer | The sensitive information policy units processed by the guardrail. | |
| sensitiveInformationPolicyFreeUnits* | integer | The sensitive information policy free units processed by the guardrail. | |
| contextualGroundingPolicyUnits* | integer | The contextual grounding policy units processed by the guardrail. | |
| contentPolicyImageUnits | integer | The content policy image units processed by the guardrail. | |
| automatedReasoningPolicyUnits | integer | The number of text units processed by the automated reasoning policy. | |
| automatedReasoningPolicies | integer | The number of automated reasoning policies that were processed during the guardrail evaluation. |
GuardrailVersionstring
GuardrailWordPolicyActionenum
BLOCKED | NONE
GuardrailWordPolicyAssessmentobject
The word policy assessment.
| customWords* | GuardrailCustomWord[] | Custom words in the assessment. | |
| managedWordLists* | GuardrailManagedWord[] | Managed word lists in the assessment. |
GuardrailWordPolicyUnitsProcessedinteger
ImageBlockobject
Image content for a message.
| format* | enum | The format of the image. | png | jpeg | gif | webp |
| source* | ImageSource | The source for the image. | |
| error | ErrorBlock | Error information if the image block could not be processed or contains invalid data. |
ImageFormatenum
png | jpeg | gif | webp
ImagesGuardedinteger
ImageSourceobject
The source for an image.
| bytes | string | The raw image bytes for the image. If you use an AWS SDK, you don't need to encode the image bytes in base64. | |
| s3Location | S3Location | The location of an image object in an Amazon S3 bucket. To see which models support S3 uploads, see Supported models and features for Converse . |
ImageSourceBytesBlobstring
ImagesTotalinteger
InvokedModelIdstring
Longinteger
Messageobject
A message input, or returned from, a call to Converse or ConverseStream .
| role* | enum | The role that the message plays in the message. | user | assistant | system |
| content* | ContentBlock[] | The message content. Note the following restrictions: 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. You can include up to five documents. Each document's size must be no … |
ModelOutputsGuardrailOutputText[]
PerformanceConfigLatencyenum
standard | optimized
PerformanceConfigurationobject
Performance settings for a model.
| latency | enum | To use a latency-optimized version of the model, set to optimized . | standard | optimized |
PromptRouterTraceobject
A prompt router trace.
| invokedModelId | string | The ID of the invoked model. |
ReasoningContentBlockobject
Contains content regarding the reasoning that is carried out by the model with respect to the content in the content block. Reasoning refers to a Chain of Thought (CoT) that the model generates to enhance the accuracy of its final response.
| reasoningText | ReasoningTextBlock | The reasoning that the model used to return the output. | |
| redactedContent | string | The content in the reasoning that was encrypted by the model provider for safety reasons. The encryption doesn't affect the quality of responses. |
ReasoningTextBlockobject
Contains the reasoning that the model used to return the output.
| text* | string | The reasoning that the model used to return the output. | |
| signature | string | A token that verifies that the reasoning text was generated by the model. If you pass a reasoning block back to the API in a multi-turn conversation, include the text and its signature unmodified. |
S3Locationobject
A storage location in an Amazon S3 bucket.
| uri* | string | An object URI starting with s3:// . | length ≥ 1 · length ≤ 1024 |
| bucketOwner | string | If the bucket belongs to another AWS account, specify that account's ID. |
S3Uristring
length ≥ 1 · length ≤ 1024
SearchResultBlockobject
A search result block that enables natural citations with proper source attribution for retrieved content. This field is only supported by Anthropic Claude Opus 4.1, Opus 4, Sonnet 4.5, Sonnet 4, Sonnet 3.7, and 3.5 Haiku models.
| source* | string | The source URL or identifier for the content. | |
| title* | string | A descriptive title for the search result. | |
| content* | SearchResultContentBlock[] | An array of search result content block. | |
| citations | CitationsConfig | Configuration setting for citations |
SearchResultContentBlockobject
A block within a search result that contains the content.
| text* | string | The actual text content |
SearchResultContentBlocksSearchResultContentBlock[]
| text* | string | The actual text content |
SearchResultLocationobject
Specifies a search result location within the content array, providing positioning information for cited content using search result index and block positions.
| searchResultIndex | integer | The index of the search result content block where the cited content is found. | n ≥ 0 |
| start | integer | The starting position in the content array where the cited content begins. | n ≥ 0 |
| end | integer | The ending position in the content array where the cited content ends. | n ≥ 0 |
SearchResultLocationEndIntegerinteger
n ≥ 0
SearchResultLocationSearchResultIndexIntegerinteger
n ≥ 0
SearchResultLocationStartIntegerinteger
n ≥ 0
ServiceTierobject
Specifies the processing tier configuration used for serving the request.
| type* | enum | Specifies the processing tier type used for serving the request. | priority | default | flex | reserved |
ServiceTierTypeenum
priority | default | flex | reserved
StopReasonenum
end_turn | tool_use | max_tokens | stop_sequence | guardrail_intervened | content_filtered · +3 more
Stringstring
TextCharactersGuardedinteger
TextCharactersTotalinteger
TokenUsageobject
The tokens used in a message API inference call.
| inputTokens* | integer | The number of tokens sent in the request to the model. | n ≥ 0 |
| outputTokens* | integer | The number of tokens that the model generated for the request. | n ≥ 0 |
| totalTokens* | integer | The total of input tokens and tokens generated by the model. | n ≥ 0 |
| cacheReadInputTokens | integer | The number of input tokens read from the cache for the request. | n ≥ 0 |
| cacheWriteInputTokens | integer | The number of input tokens written to the cache for the request. | n ≥ 0 |
| cacheDetails | CacheDetail[] | Detailed breakdown of cache writes by TTL. Empty if no cache creation occurred. Sorted by TTL duration (1h before 5m). |
TokenUsageCacheReadInputTokensIntegerinteger
n ≥ 0
TokenUsageCacheWriteInputTokensIntegerinteger
n ≥ 0
TokenUsageInputTokensIntegerinteger
n ≥ 0
TokenUsageOutputTokensIntegerinteger
n ≥ 0
TokenUsageTotalTokensIntegerinteger
n ≥ 0
ToolAdditionBlockobject
A content block for adding a tool to the available tool set mid-conversation. Each block references a single tool via its tool field. Use within a system role message to make a tool available without re-sending the full tool configuration.
| tool* | ToolReference | A reference to the tool to add to the available tool set. |
ToolNamestring
length ≥ 1 · length ≤ 64
ToolReferenceobject
A reference to a tool in the tool configuration. Used with ToolAdditionBlock and ToolRemovalBlock to identify which tool to add or remove mid-conversation.
| type | string | The type of tool reference. | length ≥ 1 · length ≤ 64 |
| name | string | The name of the tool. Must match the name of a tool declared in the top-level tool configuration. | length ≥ 1 · length ≤ 128 |
| serverName | string | The name of the MCP server that provides the tool. Required when referencing an MCP tool. | length ≥ 1 · length ≤ 128 |
ToolReferenceNameStringstring
length ≥ 1 · length ≤ 128
ToolReferenceServerNameStringstring
length ≥ 1 · length ≤ 128
ToolReferenceTypeStringstring
length ≥ 1 · length ≤ 64
ToolRemovalBlockobject
A content block for removing a tool from the available tool set mid-conversation. Each block references a single tool via its tool field. Use within a system role message to remove a tool without re-sending the full tool configuration.
| tool* | ToolReference | A reference to the tool to remove from the available tool set. |
ToolResultBlockobject
A tool result block that contains the results for a tool request that the model previously made. For more information, see Call a tool with the Converse API in the Amazon Bedrock User Guide.
| toolUseId* | string | The ID of the tool request that this is the result for. | length ≥ 1 · length ≤ 64 |
| content* | ToolResultContentBlock[] | The content for tool result content block. | |
| status | enum | The status for the tool result content block. This field is only supported by Amazon Nova and Anthropic Claude 3 and 4 models. | success | error |
| type | string | The type for the tool result content block. |
ToolResultContentBlockobject
The tool result content block. For more information, see Call a tool with the Converse API in the Amazon Bedrock User Guide.
| json | Document | A tool result that is JSON format data. | |
| text | string | A tool result that is text. | |
| image | ImageBlock | A tool result that is an image. This field is only supported by Amazon Nova and Anthropic Claude 3 and 4 models. | |
| document | DocumentBlock | A tool result that is a document. | |
| video | VideoBlock | A tool result that is video. | |
| searchResult | SearchResultBlock | A tool result that is a search result. |
ToolResultContentBlocksToolResultContentBlock[]
| json | Document | A tool result that is JSON format data. | |
| text | string | A tool result that is text. | |
| image | ImageBlock | A tool result that is an image. This field is only supported by Amazon Nova and Anthropic Claude 3 and 4 models. | |
| document | DocumentBlock | A tool result that is a document. | |
| video | VideoBlock | A tool result that is video. | |
| searchResult | SearchResultBlock | A tool result that is a search result. |
ToolResultStatusenum
success | error
ToolUseBlockobject
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. For more information, see Call a tool with the Converse API in the Amazon Bedrock User Guide.
| toolUseId* | string | The ID for the tool request. | length ≥ 1 · length ≤ 64 |
| name* | string | The name of the tool that the model wants to use. | length ≥ 1 · length ≤ 64 |
| input* | Document | The input to pass to the tool. | |
| type | enum | The type for the tool request. | server_tool_use |
ToolUseIdstring
length ≥ 1 · length ≤ 64
ToolUseTypeenum
server_tool_use
VideoBlockobject
A video block.
| format* | enum | The block's format. | mkv | mov | mp4 | webm | flv | mpeg · +3 more |
| source* | VideoSource | The block's source. |
VideoFormatenum
mkv | mov | mp4 | webm | flv | mpeg · +3 more
VideoSourceobject
A video source. You can upload a smaller video as a base64-encoded string as long as the encoded file is less than 25MB. You can also transfer videos up to 1GB in size from an S3 bucket.
| bytes | string | Video content encoded in base64. | |
| s3Location | S3Location | The location of a video object in an Amazon S3 bucket. To see which models support S3 uploads, see Supported models and features for Converse . |
VideoSourceBytesBlobstring
WebLocationobject
Provides the URL and domain information for the website that was cited when performing a web search.
| url | string | The URL that was cited when performing a web search. | |
| domain | string | The domain that was cited when performing a web search. |
Validate a payload
before you spend tokensshell
$ curl -X POST https://modelschemas.com/v1/validate \
-d '{"provider":"amazon-bedrock","endpointId":"model/{modelId}/converse","payload":{…}}'
→ {"valid": false, "errors": [{"path": "#", "keyword": "required", …}]}