Package-level declarations
Types
The request is denied because you do not have sufficient permissions to perform the requested action. For troubleshooting this error, see AccessDeniedException in the Amazon Bedrock User Guide
The model must request at least one tool (no text is generated). For example, {"any" : {}}.
Asynchronous invocation output data settings.
Asynchronous invocation output data settings.
A summary of an asynchronous invocation.
The Model automatically decides if a tool should be called or whether to generate text instead. For example, {"auto" : {}}.
Base class for all service related exceptions thrown by the BedrockRuntime client
Payload content for the bidirectional input. The input is an audio stream.
Output from the bidirectional stream. The output is speech and a text transcription.
Defines a section of content to be cached for reuse in subsequent API calls.
Contains the generated text content that corresponds to or is supported by a citation from a source document.
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.
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.
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.
Contains incremental updates to citation information during streaming responses. This allows clients to build up citation data progressively as the response is generated.
Contains the actual text content from a source document that is being cited or referenced in the model's response.
Contains incremental updates to the source content text during streaming responses, allowing clients to build up the cited content progressively.
Error occurred because of a conflict while performing an operation.
A block of content for a message that you pass to, or receive from, a model with the Converse or ConverseStream API operations.
A block of content in a streaming response.
The content block delta event.
Content block start information.
Content block start event.
A content block stop event.
Metrics for a call to Converse.
The output from a call to Converse.
A conversation stream metadata event.
Metrics for the stream.
The messages output stream
The trace object in a response from ConverseStream. Currently, you can only trace guardrails.
The trace object in a response from Converse. Currently, you can only trace guardrails.
A document to include in a message.
Specifies a character-level location within a document, providing precise positioning information for cited content using start and end character indices.
Specifies a chunk-level location within a document, providing positioning information for cited content using logical document segments or chunks.
Contains the actual content of a document that can be processed by the model and potentially cited in the response.
Specifies a page-level location within a document, providing positioning information for cited content using page numbers.
Contains the content of a document.
A behavior assessment of the guardrail policies used in a call to the Converse API.
Configuration information for a guardrail that you use with the Converse operation.
The content block to be evaluated by the guardrail.
The content filter for a guardrail.
An assessment of a content policy for a guardrail.
The details for the guardrails contextual grounding filter.
The policy assessment details for the guardrails contextual grounding filter.
A content block for selective guarding with the Converse or ConverseStream API operations.
An image block that contains images that you want to assess with a guardrail.
The image source (image bytes) of the guardrail converse image source.
A text block that contains text that you want to assess with a guardrail. For more information, see GuardrailConverseContentBlock.
The action of the guardrail coverage details.
A custom word configured in a guardrail.
Contain an image which user wants guarded. This block is accepted by the guardrails independent API.
The details of the guardrail image coverage.
The image source (image bytes) of the guardrail image source. Object used in independent api.
The invocation metrics for the guardrail.
A managed word configured in a guardrail.
The output content produced by the guardrail.
A Personally Identifiable Information (PII) entity configured in a guardrail.
A Regex filter configured in a guardrail.
The assessment for aPersonally Identifiable Information (PII) policy.
Configuration information for a guardrail that you use with the ConverseStream action.
The text block to be evaluated by the guardrail.
The guardrail coverage for the text characters.
Information about a topic guardrail.
A behavior assessment of a topic policy.
A Top level guardrail trace object. For more information, see ConverseTrace.
The details on the use of the guardrail.
The word policy assessment.
Image content for a message.
The source for an image.
Base inference parameters to pass to a model in a call to Converse or ConverseStream. For more information, see Inference parameters for foundation models.
An internal server error occurred. For troubleshooting this error, see InternalFailure in the Amazon Bedrock User Guide
Payload content, the speech chunk, for the bidirectional input of the invocation step.
Output from the bidirectional stream that was used for model invocation.
A message input, or returned from, a call to Converse or ConverseStream.
The start of a message.
The stop event for a message.
The request failed due to an error while processing the model.
The model specified in the request is not ready to serve inference requests. The AWS SDK will automatically retry the operation up to 5 times. For information about configuring automatic retries, see Retry behavior in the AWS SDKs and Tools reference guide.
An error occurred while streaming the response. Retry your request.
The request took too long to process. Processing time exceeded the model timeout length.
Payload content included in the response.
Performance settings for a model.
A prompt router trace.
Contains a map of variables in a prompt from Prompt management to an object containing the values to fill in for them when running model invocation. For more information, see How Prompt management works.
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.
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.
Contains the reasoning that the model used to return the output.
The specified resource ARN was not found. For troubleshooting this error, see ResourceNotFound in the Amazon Bedrock User Guide
Definition of content in the response stream.
A storage location in an Amazon S3 bucket.
Your request exceeds the service quota for your account. You can view your quotas at Viewing service quotas. You can resubmit your request later.
The service isn't currently available. For troubleshooting this error, see ServiceUnavailable in the Amazon Bedrock User Guide
The model must request a specific tool. For example, {"tool" : {"name" : "Your tool name"}}.
A system content block.
Your request was denied due to exceeding the account quotas for Amazon Bedrock. For troubleshooting this error, see ThrottlingException in the Amazon Bedrock User Guide
The tokens used in a message API inference call.
Information about a tool that you can use with the Converse API. For more information, see Tool use (function calling) in the Amazon Bedrock User Guide.
Determines which tools the model should request in a call to Converse or ConverseStream. ToolChoice is only supported by Anthropic Claude 3 models and by Mistral AI Mistral Large.
Configuration information for the tools that you pass to a model. For more information, see Tool use (function calling) in the Amazon Bedrock User Guide.
The schema for the tool. The top level schema type must be object.
A tool result block that contains the results for a tool request that the model previously made.
The tool result content block.
The specification for the tool.
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.
The delta for a tool use block.
The start of a tool use block.
The input fails to satisfy the constraints specified by Amazon Bedrock. For troubleshooting this error, see ValidationError in the Amazon Bedrock User Guide
A video block.
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.