Class: Anthropic::Models::CitationsSearchResultLocation

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/anthropic/models/citations_search_result_location.rb,
sig/anthropic/models/citations_search_result_location.rbs

Instance Attribute Summary collapse

Instance Method Summary collapse

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(cited_text:, end_block_index:, search_result_index:, source:, start_block_index:, title:, type: :search_result_location) ⇒ Object

Some parameter documentations has been truncated, see Anthropic::Models::CitationsSearchResultLocation for more details.

Parameters:

  • cited_text (String) —

    The full text of the cited block range, concatenated.

  • end_block_index (Integer) —

    Exclusive 0-based end index of the cited block range in the source's content a

  • search_result_index (Integer) —

    0-based index of the cited search result among all search_result content block

  • source (String)
  • start_block_index (Integer) —

    0-based index of the first cited block in the source's content array.

  • title (String, nil)
  • type (Symbol, :search_result_location) (defaults to: :search_result_location) 



# File 'lib/anthropic/models/citations_search_result_location.rb', line 59

Instance Attribute Details

#cited_text ⇒ String

The full text of the cited block range, concatenated.

Always equals the contents of content[start_block_index:end_block_index] joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns.

Parameters:

  • value (String)

Returns:

  • (String) 


15
 
# File 'lib/anthropic/models/citations_search_result_location.rb', line 15

required :cited_text, String

#end_block_index ⇒ Integer

Exclusive 0-based end index of the cited block range in the source's content array.

Always greater than start_block_index; a single-block citation has end_block_index = start_block_index + 1.

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


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

required :end_block_index, Integer

#search_result_index ⇒ Integer

0-based index of the cited search result among all search_result content blocks in the request, in the order they appear across messages and tool results.

Counted separately from document_index; server-side web search results are not included in this count.

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


36
 
# File 'lib/anthropic/models/citations_search_result_location.rb', line 36

required :search_result_index, Integer

#source ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


41
 
# File 'lib/anthropic/models/citations_search_result_location.rb', line 41

required :source, String

#start_block_index ⇒ Integer

0-based index of the first cited block in the source's content array.

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


47
 
# File 'lib/anthropic/models/citations_search_result_location.rb', line 47

required :start_block_index, Integer

#title ⇒ String?

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


52
 
# File 'lib/anthropic/models/citations_search_result_location.rb', line 52

required :title, String, nil?: true

#type ⇒ Symbol, :search_result_location

Parameters:

  • value (:search_result_location)

Returns:

  • (Symbol, :search_result_location) 


57
 
# File 'lib/anthropic/models/citations_search_result_location.rb', line 57

required :type, const: :search_result_location

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


39
 
# File 'sig/anthropic/models/citations_search_result_location.rbs', line 39

def to_hash: -> {