Module: Aws::BedrockRuntime::Types

Defined in:
gems/aws-sdk-bedrockruntime/lib/aws-sdk-bedrockruntime/types.rb

Defined Under Namespace

Classes: AccessDeniedException, AppliedGuardrailDetails, ApplyGuardrailRequest, ApplyGuardrailResponse, AsyncInvokeOutputDataConfig, AsyncInvokeS3OutputDataConfig, AsyncInvokeSummary, AudioBlock, AudioSource, BidirectionalInputPayloadPart, BidirectionalOutputPayloadPart, CachePointBlock, Citation, CitationGeneratedContent, CitationLocation, CitationSourceContent, CitationSourceContentDelta, CitationsConfig, CitationsContentBlock, CitationsDelta, ConflictException, ContentBlock, ContentBlockDelta, ContentBlockDeltaEvent, ContentBlockStart, ContentBlockStartEvent, ContentBlockStopEvent, ConverseMetrics, ConverseOutput, ConverseRequest, ConverseResponse, ConverseStreamMetadataEvent, ConverseStreamMetrics, ConverseStreamOutput, ConverseStreamRequest, ConverseStreamResponse, ConverseStreamTrace, ConverseTokensRequest, ConverseTrace, CountTokensInput, CountTokensRequest, CountTokensResponse, DocumentBlock, DocumentCharLocation, DocumentChunkLocation, DocumentContentBlock, DocumentPageLocation, DocumentSource, ErrorBlock, GetAsyncInvokeRequest, GetAsyncInvokeResponse, GuardrailAssessment, GuardrailAutomatedReasoningFinding, GuardrailAutomatedReasoningImpossibleFinding, GuardrailAutomatedReasoningInputTextReference, GuardrailAutomatedReasoningInvalidFinding, GuardrailAutomatedReasoningLogicWarning, GuardrailAutomatedReasoningNoTranslationsFinding, GuardrailAutomatedReasoningPolicyAssessment, GuardrailAutomatedReasoningRule, GuardrailAutomatedReasoningSatisfiableFinding, GuardrailAutomatedReasoningScenario, GuardrailAutomatedReasoningStatement, GuardrailAutomatedReasoningTooComplexFinding, GuardrailAutomatedReasoningTranslation, GuardrailAutomatedReasoningTranslationAmbiguousFinding, GuardrailAutomatedReasoningTranslationOption, GuardrailAutomatedReasoningValidFinding, GuardrailConfiguration, GuardrailContentBlock, GuardrailContentFilter, GuardrailContentPolicyAssessment, GuardrailContextualGroundingFilter, GuardrailContextualGroundingPolicyAssessment, GuardrailConverseContentBlock, GuardrailConverseImageBlock, GuardrailConverseImageSource, GuardrailConverseTextBlock, GuardrailCoverage, GuardrailCustomWord, GuardrailImageBlock, GuardrailImageCoverage, GuardrailImageSource, GuardrailInvocationMetrics, GuardrailManagedWord, GuardrailOutputContent, GuardrailPiiEntityFilter, GuardrailRegexFilter, GuardrailSensitiveInformationPolicyAssessment, GuardrailStreamConfiguration, GuardrailTextBlock, GuardrailTextCharactersCoverage, GuardrailTopic, GuardrailTopicPolicyAssessment, GuardrailTraceAssessment, GuardrailUsage, GuardrailWordPolicyAssessment, ImageBlock, ImageBlockDelta, ImageBlockStart, ImageSource, InferenceConfiguration, InternalServerException, InvokeModelRequest, InvokeModelResponse, InvokeModelTokensRequest, InvokeModelWithBidirectionalStreamInput, InvokeModelWithBidirectionalStreamOutput, InvokeModelWithBidirectionalStreamRequest, InvokeModelWithBidirectionalStreamResponse, InvokeModelWithResponseStreamRequest, InvokeModelWithResponseStreamResponse, ListAsyncInvokesRequest, ListAsyncInvokesResponse, Message, MessageStartEvent, MessageStopEvent, ModelErrorException, ModelNotReadyException, ModelStreamErrorException, ModelTimeoutException, PayloadPart, PerformanceConfiguration, PromptRouterTrace, PromptVariableValues, ReasoningContentBlock, ReasoningContentBlockDelta, ReasoningTextBlock, ResourceNotFoundException, ResponseStream, S3Location, SearchResultBlock, SearchResultContentBlock, SearchResultLocation, ServiceQuotaExceededException, ServiceTier, ServiceUnavailableException, SpecificToolChoice, StartAsyncInvokeRequest, StartAsyncInvokeResponse, SystemContentBlock, SystemTool, Tag, ThrottlingException, TokenUsage, Tool, ToolChoice, ToolConfiguration, ToolInputSchema, ToolResultBlock, ToolResultBlockDelta, ToolResultBlockStart, ToolResultContentBlock, ToolSpecification, ToolUseBlock, ToolUseBlockDelta, ToolUseBlockStart, ValidationException, VideoBlock, VideoSource, WebLocation

Instance Attribute Summary collapse

Instance Attribute Details

#additional_model_response_fields ⇒ Hash, ...

The additional model response fields.

Returns:

  • (Hash, Array, String, Numeric, Boolean) 


3687
3688
3689
3690
3691
3692
3693
 
# File 'gems/aws-sdk-bedrockruntime/lib/aws-sdk-bedrockruntime/types.rb', line 3687

class MessageStopEvent < Struct.new(
  :stop_reason,
  :additional_model_response_fields,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end

#any ⇒ Types::AnyToolChoice

The model must request at least one tool (no text is generated).

Returns:

  • (Types::AnyToolChoice) 


4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
 
# File 'gems/aws-sdk-bedrockruntime/lib/aws-sdk-bedrockruntime/types.rb', line 4384

class ToolChoice < Struct.new(
  :auto,
  :any,
  :tool,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class Auto < ToolChoice; end
  class Any < ToolChoice; end
  class Tool < ToolChoice; end
  class Unknown < ToolChoice; end
end

#audio ⇒ Types::AudioBlock

An audio content block containing audio data in the conversation.

Returns:



715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
 
# File 'gems/aws-sdk-bedrockruntime/lib/aws-sdk-bedrockruntime/types.rb', line 715

class ContentBlock < Struct.new(
  :text,
  :image,
  :document,
  :video,
  :audio,
  :tool_use,
  :tool_result,
  :guard_content,
  :cache_point,
  :reasoning_content,
  :citations_content,
  :search_result,
  :unknown)
  SENSITIVE = [:reasoning_content]
  include Aws::Structure
  include Aws::Structure::Union

  class Text < ContentBlock; end
  class Image < ContentBlock; end
  class Document < ContentBlock; end
  class Video < ContentBlock; end
  class Audio < ContentBlock; end
  class ToolUse < ContentBlock; end
  class ToolResult < ContentBlock; end
  class GuardContent < ContentBlock; end
  class CachePoint < ContentBlock; end
  class ReasoningContent < ContentBlock; end
  class CitationsContent < ContentBlock; end
  class SearchResult < ContentBlock; end
  class Unknown < ContentBlock; end
end

#auto ⇒ Types::AutoToolChoice

(Default). The Model automatically decides if a tool should be called or whether to generate text instead.

Returns:

  • (Types::AutoToolChoice) 


4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
 
# File 'gems/aws-sdk-bedrockruntime/lib/aws-sdk-bedrockruntime/types.rb', line 4384

class ToolChoice < Struct.new(
  :auto,
  :any,
  :tool,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class Auto < ToolChoice; end
  class Any < ToolChoice; end
  class Tool < ToolChoice; end
  class Unknown < ToolChoice; end
end

#bytes ⇒ String

Video content encoded in base64.

Returns:

  • (String) 


315
316
317
318
319
320
321
322
323
324
325
326
 
# File 'gems/aws-sdk-bedrockruntime/lib/aws-sdk-bedrockruntime/types.rb', line 315

class AudioSource < Struct.new(
  :bytes,
  :s3_location,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class Bytes < AudioSource; end
  class S3Location < AudioSource; end
  class Unknown < AudioSource; end
end

#cache_point ⇒ Types::CachePointBlock

CachePoint to include in the tool configuration.

Returns:



715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
 
# File 'gems/aws-sdk-bedrockruntime/lib/aws-sdk-bedrockruntime/types.rb', line 715

class ContentBlock < Struct.new(
  :text,
  :image,
  :document,
  :video,
  :audio,
  :tool_use,
  :tool_result,
  :guard_content,
  :cache_point,
  :reasoning_content,
  :citations_content,
  :search_result,
  :unknown)
  SENSITIVE = [:reasoning_content]
  include Aws::Structure
  include Aws::Structure::Union

  class Text < ContentBlock; end
  class Image < ContentBlock; end
  class Document < ContentBlock; end
  class Video < ContentBlock; end
  class Audio < ContentBlock; end
  class ToolUse < ContentBlock; end
  class ToolResult < ContentBlock; end
  class GuardContent < ContentBlock; end
  class CachePoint < ContentBlock; end
  class ReasoningContent < ContentBlock; end
  class CitationsContent < ContentBlock; end
  class SearchResult < ContentBlock; end
  class Unknown < ContentBlock; end
end

#citation ⇒ Types::CitationsDelta

Incremental citation information that is streamed as part of the response generation process.

Returns:



781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
 
# File 'gems/aws-sdk-bedrockruntime/lib/aws-sdk-bedrockruntime/types.rb', line 781

class ContentBlockDelta < Struct.new(
  :text,
  :tool_use,
  :tool_result,
  :reasoning_content,
  :citation,
  :image,
  :unknown)
  SENSITIVE = [:reasoning_content]
  include Aws::Structure
  include Aws::Structure::Union

  class Text < ContentBlockDelta; end
  class ToolUse < ContentBlockDelta; end
  class ToolResult < ContentBlockDelta; end
  class ReasoningContent < ContentBlockDelta; end
  class Citation < ContentBlockDelta; end
  class Image < ContentBlockDelta; end
  class Unknown < ContentBlockDelta; end
end

#citations_content ⇒ Types::CitationsContentBlock

A content block that contains both generated text and associated citation information, providing traceability between the response and source documents.

Returns:



715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
 
# File 'gems/aws-sdk-bedrockruntime/lib/aws-sdk-bedrockruntime/types.rb', line 715

class ContentBlock < Struct.new(
  :text,
  :image,
  :document,
  :video,
  :audio,
  :tool_use,
  :tool_result,
  :guard_content,
  :cache_point,
  :reasoning_content,
  :citations_content,
  :search_result,
  :unknown)
  SENSITIVE = [:reasoning_content]
  include Aws::Structure
  include Aws::Structure::Union

  class Text < ContentBlock; end
  class Image < ContentBlock; end
  class Document < ContentBlock; end
  class Video < ContentBlock; end
  class Audio < ContentBlock; end
  class ToolUse < ContentBlock; end
  class ToolResult < ContentBlock; end
  class GuardContent < ContentBlock; end
  class CachePoint < ContentBlock; end
  class ReasoningContent < ContentBlock; end
  class CitationsContent < ContentBlock; end
  class SearchResult < ContentBlock; end
  class Unknown < ContentBlock; end
end

#content ⇒ Array<Types::DocumentContentBlock>

The structured content of the document source, which may include various content blocks such as text, images, or other document elements.

Returns:



1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
 
# File 'gems/aws-sdk-bedrockruntime/lib/aws-sdk-bedrockruntime/types.rb', line 1707

class DocumentSource < Struct.new(
  :bytes,
  :s3_location,
  :text,
  :content,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class Bytes < DocumentSource; end
  class S3Location < DocumentSource; end
  class Text < DocumentSource; end
  class Content < DocumentSource; end
  class Unknown < DocumentSource; end
end

#content_block_index ⇒ Integer

The index for a content block.

Returns:

  • (Integer) 


814
815
816
817
818
819
820
 
# File 'gems/aws-sdk-bedrockruntime/lib/aws-sdk-bedrockruntime/types.rb', line 814

class ContentBlockDeltaEvent < Struct.new(
  :delta,
  :content_block_index,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end

#converse ⇒ Types::ConverseTokensRequest

A Converse request for which to count tokens. Use this field when you want to count tokens for a conversation-based input that would be sent to the Converse operation.

Returns:



1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
 
# File 'gems/aws-sdk-bedrockruntime/lib/aws-sdk-bedrockruntime/types.rb', line 1453

class CountTokensInput < Struct.new(
  :invoke_model,
  :converse,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class InvokeModel < CountTokensInput; end
  class Converse < CountTokensInput; end
  class Unknown < CountTokensInput; end
end

#delta ⇒ Types::ContentBlockDelta

The delta for a content block delta event.

Returns:



814
815
816
817
818
819
820
 
# File 'gems/aws-sdk-bedrockruntime/lib/aws-sdk-bedrockruntime/types.rb', line 814

class ContentBlockDeltaEvent < Struct.new(
  :delta,
  :content_block_index,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end

#document ⇒ Types::DocumentBlock

A tool result that is a document.

Returns:



715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
 
# File 'gems/aws-sdk-bedrockruntime/lib/aws-sdk-bedrockruntime/types.rb', line 715

class ContentBlock < Struct.new(
  :text,
  :image,
  :document,
  :video,
  :audio,
  :tool_use,
  :tool_result,
  :guard_content,
  :cache_point,
  :reasoning_content,
  :citations_content,
  :search_result,
  :unknown)
  SENSITIVE = [:reasoning_content]
  include Aws::Structure
  include Aws::Structure::Union

  class Text < ContentBlock; end
  class Image < ContentBlock; end
  class Document < ContentBlock; end
  class Video < ContentBlock; end
  class Audio < ContentBlock; end
  class ToolUse < ContentBlock; end
  class ToolResult < ContentBlock; end
  class GuardContent < ContentBlock; end
  class CachePoint < ContentBlock; end
  class ReasoningContent < ContentBlock; end
  class CitationsContent < ContentBlock; end
  class SearchResult < ContentBlock; end
  class Unknown < ContentBlock; end
end

#document_char ⇒ Types::DocumentCharLocation

The character-level location within the document where the cited content is found.

Returns:



488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
 
# File 'gems/aws-sdk-bedrockruntime/lib/aws-sdk-bedrockruntime/types.rb', line 488

class CitationLocation < Struct.new(
  :web,
  :document_char,
  :document_page,
  :document_chunk,
  :search_result_location,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class Web < CitationLocation; end
  class DocumentChar < CitationLocation; end
  class DocumentPage < CitationLocation; end
  class DocumentChunk < CitationLocation; end
  class SearchResultLocation < CitationLocation; end
  class Unknown < CitationLocation; end
end

#document_chunk ⇒ Types::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.

Returns:



488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
 
# File 'gems/aws-sdk-bedrockruntime/lib/aws-sdk-bedrockruntime/types.rb', line 488

class CitationLocation < Struct.new(
  :web,
  :document_char,
  :document_page,
  :document_chunk,
  :search_result_location,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class Web < CitationLocation; end
  class DocumentChar < CitationLocation; end
  class DocumentPage < CitationLocation; end
  class DocumentChunk < CitationLocation; end
  class SearchResultLocation < CitationLocation; end
  class Unknown < CitationLocation; end
end

#document_page ⇒ Types::DocumentPageLocation

The page-level location within the document where the cited content is found.

Returns:



488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
 
# File 'gems/aws-sdk-bedrockruntime/lib/aws-sdk-bedrockruntime/types.rb', line 488

class CitationLocation < Struct.new(
  :web,
  :document_char,
  :document_page,
  :document_chunk,
  :search_result_location,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class Web < CitationLocation; end
  class DocumentChar < CitationLocation; end
  class DocumentPage < CitationLocation; end
  class DocumentChunk < CitationLocation; end
  class SearchResultLocation < CitationLocation; end
  class Unknown < CitationLocation; end
end

#guard_content ⇒ Types::GuardrailConverseContentBlock

A content block to assess with the guardrail. Use with the Converse or ConverseStream API operations.

For more information, see Use a guardrail with the Converse API in the Amazon Bedrock User Guide.

Returns:



715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
 
# File 'gems/aws-sdk-bedrockruntime/lib/aws-sdk-bedrockruntime/types.rb', line 715

class ContentBlock < Struct.new(
  :text,
  :image,
  :document,
  :video,
  :audio,
  :tool_use,
  :tool_result,
  :guard_content,
  :cache_point,
  :reasoning_content,
  :citations_content,
  :search_result,
  :unknown)
  SENSITIVE = [:reasoning_content]
  include Aws::Structure
  include Aws::Structure::Union

  class Text < ContentBlock; end
  class Image < ContentBlock; end
  class Document < ContentBlock; end
  class Video < ContentBlock; end
  class Audio < ContentBlock; end
  class ToolUse < ContentBlock; end
  class ToolResult < ContentBlock; end
  class GuardContent < ContentBlock; end
  class CachePoint < ContentBlock; end
  class ReasoningContent < ContentBlock; end
  class CitationsContent < ContentBlock; end
  class SearchResult < ContentBlock; end
  class Unknown < ContentBlock; end
end

#image ⇒ Types::ImageBlock

A tool result that is an image.

This field is only supported by Amazon Nova and Anthropic Claude 3 and 4 models.

Returns:



715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
 
# File 'gems/aws-sdk-bedrockruntime/lib/aws-sdk-bedrockruntime/types.rb', line 715

class ContentBlock < Struct.new(
  :text,
  :image,
  :document,
  :video,
  :audio,
  :tool_use,
  :tool_result,
  :guard_content,
  :cache_point,
  :reasoning_content,
  :citations_content,
  :search_result,
  :unknown)
  SENSITIVE = [:reasoning_content]
  include Aws::Structure
  include Aws::Structure::Union

  class Text < ContentBlock; end
  class Image < ContentBlock; end
  class Document < ContentBlock; end
  class Video < ContentBlock; end
  class Audio < ContentBlock; end
  class ToolUse < ContentBlock; end
  class ToolResult < ContentBlock; end
  class GuardContent < ContentBlock; end
  class CachePoint < ContentBlock; end
  class ReasoningContent < ContentBlock; end
  class CitationsContent < ContentBlock; end
  class SearchResult < ContentBlock; end
  class Unknown < ContentBlock; end
end

#impossible ⇒ Types::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.

Returns:



1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
 
# File 'gems/aws-sdk-bedrockruntime/lib/aws-sdk-bedrockruntime/types.rb', line 1908

class GuardrailAutomatedReasoningFinding < Struct.new(
  :valid,
  :invalid,
  :satisfiable,
  :impossible,
  :translation_ambiguous,
  :too_complex,
  :no_translations,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class Valid < GuardrailAutomatedReasoningFinding; end
  class Invalid < GuardrailAutomatedReasoningFinding; end
  class Satisfiable < GuardrailAutomatedReasoningFinding; end
  class Impossible < GuardrailAutomatedReasoningFinding; end
  class TranslationAmbiguous < GuardrailAutomatedReasoningFinding; end
  class TooComplex < GuardrailAutomatedReasoningFinding; end
  class NoTranslations < GuardrailAutomatedReasoningFinding; end
  class Unknown < GuardrailAutomatedReasoningFinding; end
end

#invalid ⇒ Types::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.

Returns:



1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
 
# File 'gems/aws-sdk-bedrockruntime/lib/aws-sdk-bedrockruntime/types.rb', line 1908

class GuardrailAutomatedReasoningFinding < Struct.new(
  :valid,
  :invalid,
  :satisfiable,
  :impossible,
  :translation_ambiguous,
  :too_complex,
  :no_translations,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class Valid < GuardrailAutomatedReasoningFinding; end
  class Invalid < GuardrailAutomatedReasoningFinding; end
  class Satisfiable < GuardrailAutomatedReasoningFinding; end
  class Impossible < GuardrailAutomatedReasoningFinding; end
  class TranslationAmbiguous < GuardrailAutomatedReasoningFinding; end
  class TooComplex < GuardrailAutomatedReasoningFinding; end
  class NoTranslations < GuardrailAutomatedReasoningFinding; end
  class Unknown < GuardrailAutomatedReasoningFinding; end
end

#invoke_model ⇒ Types::InvokeModelTokensRequest

An InvokeModel request for which to count tokens. Use this field when you want to count tokens for a raw text input that would be sent to the InvokeModel operation.

Returns:



1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
 
# File 'gems/aws-sdk-bedrockruntime/lib/aws-sdk-bedrockruntime/types.rb', line 1453

class CountTokensInput < Struct.new(
  :invoke_model,
  :converse,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class InvokeModel < CountTokensInput; end
  class Converse < CountTokensInput; end
  class Unknown < CountTokensInput; end
end

#json ⇒ Hash, ...

A tool result that is JSON format data.

Returns:

  • (Hash, Array, String, Numeric, Boolean) 


4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
 
# File 'gems/aws-sdk-bedrockruntime/lib/aws-sdk-bedrockruntime/types.rb', line 4445

class ToolInputSchema < Struct.new(
  :json,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class Json < ToolInputSchema; end
  class Unknown < ToolInputSchema; end
end

#message ⇒ String

Returns:

  • (String) 


922
923
924
925
926
927
928
929
930
931
 
# File 'gems/aws-sdk-bedrockruntime/lib/aws-sdk-bedrockruntime/types.rb', line 922

class ConverseOutput < Struct.new(
  :message,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class Message < ConverseOutput; end
  class Unknown < ConverseOutput; end
end

#metrics ⇒ Types::ConverseStreamMetrics

The metrics for the conversation stream metadata event.

Returns:



1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
 
# File 'gems/aws-sdk-bedrockruntime/lib/aws-sdk-bedrockruntime/types.rb', line 1163

class ConverseStreamMetadataEvent < Struct.new(
  :usage,
  :metrics,
  :trace,
  :performance_config,
  :service_tier,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end

#no_translations ⇒ Types::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.

Returns:



1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
 
# File 'gems/aws-sdk-bedrockruntime/lib/aws-sdk-bedrockruntime/types.rb', line 1908

class GuardrailAutomatedReasoningFinding < Struct.new(
  :valid,
  :invalid,
  :satisfiable,
  :impossible,
  :translation_ambiguous,
  :too_complex,
  :no_translations,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class Valid < GuardrailAutomatedReasoningFinding; end
  class Invalid < GuardrailAutomatedReasoningFinding; end
  class Satisfiable < GuardrailAutomatedReasoningFinding; end
  class Impossible < GuardrailAutomatedReasoningFinding; end
  class TranslationAmbiguous < GuardrailAutomatedReasoningFinding; end
  class TooComplex < GuardrailAutomatedReasoningFinding; end
  class NoTranslations < GuardrailAutomatedReasoningFinding; end
  class Unknown < GuardrailAutomatedReasoningFinding; end
end

#original_message ⇒ String

The original message.

Returns:

  • (String) 


3753
3754
3755
3756
3757
3758
3759
3760
 
# File 'gems/aws-sdk-bedrockruntime/lib/aws-sdk-bedrockruntime/types.rb', line 3753

class ModelStreamErrorException < Struct.new(
  :message,
  :original_status_code,
  :original_message,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end

#original_status_code ⇒ Integer

The original status code.

Returns:

  • (Integer) 


3753
3754
3755
3756
3757
3758
3759
3760
 
# File 'gems/aws-sdk-bedrockruntime/lib/aws-sdk-bedrockruntime/types.rb', line 3753

class ModelStreamErrorException < Struct.new(
  :message,
  :original_status_code,
  :original_message,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end

#performance_config ⇒ Types::PerformanceConfiguration

Model performance configuration metadata for the conversation stream event.

Returns:



1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
 
# File 'gems/aws-sdk-bedrockruntime/lib/aws-sdk-bedrockruntime/types.rb', line 1163

class ConverseStreamMetadataEvent < Struct.new(
  :usage,
  :metrics,
  :trace,
  :performance_config,
  :service_tier,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end

#reasoning_content ⇒ Types::ReasoningContentBlockDelta

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.

Returns:



715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
 
# File 'gems/aws-sdk-bedrockruntime/lib/aws-sdk-bedrockruntime/types.rb', line 715

class ContentBlock < Struct.new(
  :text,
  :image,
  :document,
  :video,
  :audio,
  :tool_use,
  :tool_result,
  :guard_content,
  :cache_point,
  :reasoning_content,
  :citations_content,
  :search_result,
  :unknown)
  SENSITIVE = [:reasoning_content]
  include Aws::Structure
  include Aws::Structure::Union

  class Text < ContentBlock; end
  class Image < ContentBlock; end
  class Document < ContentBlock; end
  class Video < ContentBlock; end
  class Audio < ContentBlock; end
  class ToolUse < ContentBlock; end
  class ToolResult < ContentBlock; end
  class GuardContent < ContentBlock; end
  class CachePoint < ContentBlock; end
  class ReasoningContent < ContentBlock; end
  class CitationsContent < ContentBlock; end
  class SearchResult < ContentBlock; end
  class Unknown < ContentBlock; end
end

#reasoning_text ⇒ Types::ReasoningTextBlock

The reasoning that the model used to return the output.

Returns:



3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
 
# File 'gems/aws-sdk-bedrockruntime/lib/aws-sdk-bedrockruntime/types.rb', line 3869

class ReasoningContentBlock < Struct.new(
  :reasoning_text,
  :redacted_content,
  :unknown)
  SENSITIVE = [:reasoning_text]
  include Aws::Structure
  include Aws::Structure::Union

  class ReasoningText < ReasoningContentBlock; end
  class RedactedContent < ReasoningContentBlock; end
  class Unknown < ReasoningContentBlock; end
end

#redacted_content ⇒ 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.

Returns:

  • (String) 


3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
 
# File 'gems/aws-sdk-bedrockruntime/lib/aws-sdk-bedrockruntime/types.rb', line 3869

class ReasoningContentBlock < Struct.new(
  :reasoning_text,
  :redacted_content,
  :unknown)
  SENSITIVE = [:reasoning_text]
  include Aws::Structure
  include Aws::Structure::Union

  class ReasoningText < ReasoningContentBlock; end
  class RedactedContent < ReasoningContentBlock; end
  class Unknown < ReasoningContentBlock; end
end

#role ⇒ String

The role for the message.

Returns:

  • (String) 


3668
3669
3670
3671
3672
3673
 
# File 'gems/aws-sdk-bedrockruntime/lib/aws-sdk-bedrockruntime/types.rb', line 3668

class MessageStartEvent < Struct.new(
  :role,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end

#s3_location ⇒ Types::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.

Returns:



315
316
317
318
319
320
321
322
323
324
325
326
 
# File 'gems/aws-sdk-bedrockruntime/lib/aws-sdk-bedrockruntime/types.rb', line 315

class AudioSource < Struct.new(
  :bytes,
  :s3_location,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class Bytes < AudioSource; end
  class S3Location < AudioSource; end
  class Unknown < AudioSource; end
end

#s3_output_data_config ⇒ Types::AsyncInvokeS3OutputDataConfig

A storage location for the output data in an S3 bucket

Returns:



174
175
176
177
178
179
180
181
182
183
 
# File 'gems/aws-sdk-bedrockruntime/lib/aws-sdk-bedrockruntime/types.rb', line 174

class AsyncInvokeOutputDataConfig < Struct.new(
  :s3_output_data_config,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class S3OutputDataConfig < AsyncInvokeOutputDataConfig; end
  class Unknown < AsyncInvokeOutputDataConfig; end
end

#satisfiable ⇒ Types::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.

Returns:



1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
 
# File 'gems/aws-sdk-bedrockruntime/lib/aws-sdk-bedrockruntime/types.rb', line 1908

class GuardrailAutomatedReasoningFinding < Struct.new(
  :valid,
  :invalid,
  :satisfiable,
  :impossible,
  :translation_ambiguous,
  :too_complex,
  :no_translations,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class Valid < GuardrailAutomatedReasoningFinding; end
  class Invalid < GuardrailAutomatedReasoningFinding; end
  class Satisfiable < GuardrailAutomatedReasoningFinding; end
  class Impossible < GuardrailAutomatedReasoningFinding; end
  class TranslationAmbiguous < GuardrailAutomatedReasoningFinding; end
  class TooComplex < GuardrailAutomatedReasoningFinding; end
  class NoTranslations < GuardrailAutomatedReasoningFinding; end
  class Unknown < GuardrailAutomatedReasoningFinding; end
end

#search_result ⇒ Types::SearchResultBlock

A tool result that is a search result.

Returns:



715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
 
# File 'gems/aws-sdk-bedrockruntime/lib/aws-sdk-bedrockruntime/types.rb', line 715

class ContentBlock < Struct.new(
  :text,
  :image,
  :document,
  :video,
  :audio,
  :tool_use,
  :tool_result,
  :guard_content,
  :cache_point,
  :reasoning_content,
  :citations_content,
  :search_result,
  :unknown)
  SENSITIVE = [:reasoning_content]
  include Aws::Structure
  include Aws::Structure::Union

  class Text < ContentBlock; end
  class Image < ContentBlock; end
  class Document < ContentBlock; end
  class Video < ContentBlock; end
  class Audio < ContentBlock; end
  class ToolUse < ContentBlock; end
  class ToolResult < ContentBlock; end
  class GuardContent < ContentBlock; end
  class CachePoint < ContentBlock; end
  class ReasoningContent < ContentBlock; end
  class CitationsContent < ContentBlock; end
  class SearchResult < ContentBlock; end
  class Unknown < ContentBlock; end
end

#search_result_location ⇒ Types::SearchResultLocation

The search result location where the cited content is found, including the search result index and block positions within the content array.

Returns:



488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
 
# File 'gems/aws-sdk-bedrockruntime/lib/aws-sdk-bedrockruntime/types.rb', line 488

class CitationLocation < Struct.new(
  :web,
  :document_char,
  :document_page,
  :document_chunk,
  :search_result_location,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class Web < CitationLocation; end
  class DocumentChar < CitationLocation; end
  class DocumentPage < CitationLocation; end
  class DocumentChunk < CitationLocation; end
  class SearchResultLocation < CitationLocation; end
  class Unknown < CitationLocation; end
end

#service_tier ⇒ Types::ServiceTier

Specifies the processing tier configuration used for serving the request.

Returns:



1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
 
# File 'gems/aws-sdk-bedrockruntime/lib/aws-sdk-bedrockruntime/types.rb', line 1163

class ConverseStreamMetadataEvent < Struct.new(
  :usage,
  :metrics,
  :trace,
  :performance_config,
  :service_tier,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end

#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.

Returns:

  • (String) 


3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
 
# File 'gems/aws-sdk-bedrockruntime/lib/aws-sdk-bedrockruntime/types.rb', line 3907

class ReasoningContentBlockDelta < Struct.new(
  :text,
  :redacted_content,
  :signature,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class Text < ReasoningContentBlockDelta; end
  class RedactedContent < ReasoningContentBlockDelta; end
  class Signature < ReasoningContentBlockDelta; end
  class Unknown < ReasoningContentBlockDelta; end
end

#start ⇒ Types::ContentBlockStart

Start information about a content block start event.

Returns:



867
868
869
870
871
872
873
 
# File 'gems/aws-sdk-bedrockruntime/lib/aws-sdk-bedrockruntime/types.rb', line 867

class ContentBlockStartEvent < Struct.new(
  :start,
  :content_block_index,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end

#stop_reason ⇒ String

The reason why the model stopped generating output.

Returns:

  • (String) 


3687
3688
3689
3690
3691
3692
3693
 
# File 'gems/aws-sdk-bedrockruntime/lib/aws-sdk-bedrockruntime/types.rb', line 3687

class MessageStopEvent < Struct.new(
  :stop_reason,
  :additional_model_response_fields,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end

#system_tool ⇒ Types::SystemTool

Specifies the system-defined tool that you want use.

Returns:



4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
 
# File 'gems/aws-sdk-bedrockruntime/lib/aws-sdk-bedrockruntime/types.rb', line 4343

class Tool < Struct.new(
  :tool_spec,
  :system_tool,
  :cache_point,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class ToolSpec < Tool; end
  class SystemTool < Tool; end
  class CachePoint < Tool; end
  class Unknown < Tool; end
end

#text ⇒ String

A tool result that is text.

Returns:

  • (String) 


440
441
442
443
444
445
446
447
448
449
 
# File 'gems/aws-sdk-bedrockruntime/lib/aws-sdk-bedrockruntime/types.rb', line 440

class CitationGeneratedContent < Struct.new(
  :text,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class Text < CitationGeneratedContent; end
  class Unknown < CitationGeneratedContent; end
end

#too_complex ⇒ Types::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.

Returns:



1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
 
# File 'gems/aws-sdk-bedrockruntime/lib/aws-sdk-bedrockruntime/types.rb', line 1908

class GuardrailAutomatedReasoningFinding < Struct.new(
  :valid,
  :invalid,
  :satisfiable,
  :impossible,
  :translation_ambiguous,
  :too_complex,
  :no_translations,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class Valid < GuardrailAutomatedReasoningFinding; end
  class Invalid < GuardrailAutomatedReasoningFinding; end
  class Satisfiable < GuardrailAutomatedReasoningFinding; end
  class Impossible < GuardrailAutomatedReasoningFinding; end
  class TranslationAmbiguous < GuardrailAutomatedReasoningFinding; end
  class TooComplex < GuardrailAutomatedReasoningFinding; end
  class NoTranslations < GuardrailAutomatedReasoningFinding; end
  class Unknown < GuardrailAutomatedReasoningFinding; end
end

#tool ⇒ Types::SpecificToolChoice

The Model must request the specified tool. Only supported by Anthropic Claude 3 and Amazon Nova models.

Returns:



4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
 
# File 'gems/aws-sdk-bedrockruntime/lib/aws-sdk-bedrockruntime/types.rb', line 4384

class ToolChoice < Struct.new(
  :auto,
  :any,
  :tool,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class Auto < ToolChoice; end
  class Any < ToolChoice; end
  class Tool < ToolChoice; end
  class Unknown < ToolChoice; end
end

#tool_result ⇒ Types::ToolResultBlockStart

The

Returns:



715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
 
# File 'gems/aws-sdk-bedrockruntime/lib/aws-sdk-bedrockruntime/types.rb', line 715

class ContentBlock < Struct.new(
  :text,
  :image,
  :document,
  :video,
  :audio,
  :tool_use,
  :tool_result,
  :guard_content,
  :cache_point,
  :reasoning_content,
  :citations_content,
  :search_result,
  :unknown)
  SENSITIVE = [:reasoning_content]
  include Aws::Structure
  include Aws::Structure::Union

  class Text < ContentBlock; end
  class Image < ContentBlock; end
  class Document < ContentBlock; end
  class Video < ContentBlock; end
  class Audio < ContentBlock; end
  class ToolUse < ContentBlock; end
  class ToolResult < ContentBlock; end
  class GuardContent < ContentBlock; end
  class CachePoint < ContentBlock; end
  class ReasoningContent < ContentBlock; end
  class CitationsContent < ContentBlock; end
  class SearchResult < ContentBlock; end
  class Unknown < ContentBlock; end
end

#tool_spec ⇒ Types::ToolSpecification

The specfication for the tool.

Returns:



4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
 
# File 'gems/aws-sdk-bedrockruntime/lib/aws-sdk-bedrockruntime/types.rb', line 4343

class Tool < Struct.new(
  :tool_spec,
  :system_tool,
  :cache_point,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class ToolSpec < Tool; end
  class SystemTool < Tool; end
  class CachePoint < Tool; end
  class Unknown < Tool; end
end

#tool_use ⇒ Types::ToolUseBlockStart

Information about a tool that the model is requesting to use.

Returns:



715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
 
# File 'gems/aws-sdk-bedrockruntime/lib/aws-sdk-bedrockruntime/types.rb', line 715

class ContentBlock < Struct.new(
  :text,
  :image,
  :document,
  :video,
  :audio,
  :tool_use,
  :tool_result,
  :guard_content,
  :cache_point,
  :reasoning_content,
  :citations_content,
  :search_result,
  :unknown)
  SENSITIVE = [:reasoning_content]
  include Aws::Structure
  include Aws::Structure::Union

  class Text < ContentBlock; end
  class Image < ContentBlock; end
  class Document < ContentBlock; end
  class Video < ContentBlock; end
  class Audio < ContentBlock; end
  class ToolUse < ContentBlock; end
  class ToolResult < ContentBlock; end
  class GuardContent < ContentBlock; end
  class CachePoint < ContentBlock; end
  class ReasoningContent < ContentBlock; end
  class CitationsContent < ContentBlock; end
  class SearchResult < ContentBlock; end
  class Unknown < ContentBlock; end
end

#trace ⇒ Types::ConverseStreamTrace

The trace object in the response from ConverseStream that contains information about the guardrail behavior.

Returns:



1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
 
# File 'gems/aws-sdk-bedrockruntime/lib/aws-sdk-bedrockruntime/types.rb', line 1163

class ConverseStreamMetadataEvent < Struct.new(
  :usage,
  :metrics,
  :trace,
  :performance_config,
  :service_tier,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end

#translation_ambiguous ⇒ Types::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.

Returns:



1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
 
# File 'gems/aws-sdk-bedrockruntime/lib/aws-sdk-bedrockruntime/types.rb', line 1908

class GuardrailAutomatedReasoningFinding < Struct.new(
  :valid,
  :invalid,
  :satisfiable,
  :impossible,
  :translation_ambiguous,
  :too_complex,
  :no_translations,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class Valid < GuardrailAutomatedReasoningFinding; end
  class Invalid < GuardrailAutomatedReasoningFinding; end
  class Satisfiable < GuardrailAutomatedReasoningFinding; end
  class Impossible < GuardrailAutomatedReasoningFinding; end
  class TranslationAmbiguous < GuardrailAutomatedReasoningFinding; end
  class TooComplex < GuardrailAutomatedReasoningFinding; end
  class NoTranslations < GuardrailAutomatedReasoningFinding; end
  class Unknown < GuardrailAutomatedReasoningFinding; end
end

#usage ⇒ Types::TokenUsage

Usage information for the conversation stream event.

Returns:



1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
 
# File 'gems/aws-sdk-bedrockruntime/lib/aws-sdk-bedrockruntime/types.rb', line 1163

class ConverseStreamMetadataEvent < Struct.new(
  :usage,
  :metrics,
  :trace,
  :performance_config,
  :service_tier,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end

#valid ⇒ Types::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.

Returns:



1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
 
# File 'gems/aws-sdk-bedrockruntime/lib/aws-sdk-bedrockruntime/types.rb', line 1908

class GuardrailAutomatedReasoningFinding < Struct.new(
  :valid,
  :invalid,
  :satisfiable,
  :impossible,
  :translation_ambiguous,
  :too_complex,
  :no_translations,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class Valid < GuardrailAutomatedReasoningFinding; end
  class Invalid < GuardrailAutomatedReasoningFinding; end
  class Satisfiable < GuardrailAutomatedReasoningFinding; end
  class Impossible < GuardrailAutomatedReasoningFinding; end
  class TranslationAmbiguous < GuardrailAutomatedReasoningFinding; end
  class TooComplex < GuardrailAutomatedReasoningFinding; end
  class NoTranslations < GuardrailAutomatedReasoningFinding; end
  class Unknown < GuardrailAutomatedReasoningFinding; end
end

#video ⇒ Types::VideoBlock

A tool result that is video.

Returns:



715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
 
# File 'gems/aws-sdk-bedrockruntime/lib/aws-sdk-bedrockruntime/types.rb', line 715

class ContentBlock < Struct.new(
  :text,
  :image,
  :document,
  :video,
  :audio,
  :tool_use,
  :tool_result,
  :guard_content,
  :cache_point,
  :reasoning_content,
  :citations_content,
  :search_result,
  :unknown)
  SENSITIVE = [:reasoning_content]
  include Aws::Structure
  include Aws::Structure::Union

  class Text < ContentBlock; end
  class Image < ContentBlock; end
  class Document < ContentBlock; end
  class Video < ContentBlock; end
  class Audio < ContentBlock; end
  class ToolUse < ContentBlock; end
  class ToolResult < ContentBlock; end
  class GuardContent < ContentBlock; end
  class CachePoint < ContentBlock; end
  class ReasoningContent < ContentBlock; end
  class CitationsContent < ContentBlock; end
  class SearchResult < ContentBlock; end
  class Unknown < ContentBlock; end
end

#web ⇒ Types::WebLocation

The web URL that was cited for this reference.

Returns:



488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
 
# File 'gems/aws-sdk-bedrockruntime/lib/aws-sdk-bedrockruntime/types.rb', line 488

class CitationLocation < Struct.new(
  :web,
  :document_char,
  :document_page,
  :document_chunk,
  :search_result_location,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class Web < CitationLocation; end
  class DocumentChar < CitationLocation; end
  class DocumentPage < CitationLocation; end
  class DocumentChunk < CitationLocation; end
  class SearchResultLocation < CitationLocation; end
  class Unknown < CitationLocation; end
end