Class: Anthropic::Models::DocumentBlockParam

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Anthropic::Models::DocumentBlockParam

Defined in:

lib/anthropic/models/document_block_param.rb

Defined Under Namespace

Modules: Source

Instance Attribute Summary

• #cache_control ⇒ Anthropic::Models::CacheControlEphemeral^?

  Create a cache control breakpoint at this content block.

• #citations ⇒ Anthropic::Models::CitationsConfigParam^?
• #context ⇒ String^?
• #source ⇒ Anthropic::Models::Base64PDFSource, ...
• #title ⇒ String^?
• #type ⇒ Symbol, :document

Instance Method Summary

• #initialize(source:, cache_control: nil, citations: nil, context: nil, title: nil, type: :document) ⇒ void constructor

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, inspect, #inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(source:, cache_control: nil, citations: nil, context: nil, title: nil, type: :document) ⇒ void

Parameters:

• source (Anthropic::Models::Base64PDFSource, Anthropic::Models::PlainTextSource, Anthropic::Models::ContentBlockSource, Anthropic::Models::URLPDFSource)
• cache_control (Anthropic::Models::CacheControlEphemeral, nil) (defaults to: nil) —

  Create a cache control breakpoint at this content block.

• citations (Anthropic::Models::CitationsConfigParam, nil) (defaults to: nil)
• context (String, nil) (defaults to: nil)
• title (String, nil) (defaults to: nil)
• type (Symbol, :document) (defaults to: :document)

# File 'lib/anthropic/models/document_block_param.rb', line 37

Instance Attribute Details

#cache_control ⇒ Anthropic::Models::CacheControlEphemeral^?

Create a cache control breakpoint at this content block.

Returns:

• (Anthropic::Models::CacheControlEphemeral, nil)

# File 'lib/anthropic/models/document_block_param.rb', line 20

optional :cache_control, -> { Anthropic::CacheControlEphemeral }, nil?: true

#citations ⇒ Anthropic::Models::CitationsConfigParam^?

Returns:

• (Anthropic::Models::CitationsConfigParam, nil)

# File 'lib/anthropic/models/document_block_param.rb', line 25

optional :citations, -> { Anthropic::CitationsConfigParam }, nil?: true

#context ⇒ String^?

Returns:

• (String, nil)

# File 'lib/anthropic/models/document_block_param.rb', line 30

optional :context, String, nil?: true

#source ⇒ Anthropic::Models::Base64PDFSource, ...

Returns:

• (Anthropic::Models::Base64PDFSource, Anthropic::Models::PlainTextSource, Anthropic::Models::ContentBlockSource, Anthropic::Models::URLPDFSource)

# File 'lib/anthropic/models/document_block_param.rb', line 9

required :source, union: -> { Anthropic::DocumentBlockParam::Source }

#title ⇒ String^?

Returns:

• (String, nil)

# File 'lib/anthropic/models/document_block_param.rb', line 35

optional :title, String, nil?: true

#type ⇒ Symbol, :document

Returns:

• (Symbol, :document)

# File 'lib/anthropic/models/document_block_param.rb', line 14

required :type, const: :document