Class: Anthropic::Models::Beta::BetaCitationSearchResultLocationParam

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/anthropic/models/beta/beta_citation_search_result_location_param.rb

Instance Attribute Summary collapse

Method Summary

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, #initialize, 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

This class inherits a constructor from Anthropic::Internal::Type::BaseModel

Instance Attribute Details

#cited_text ⇒ String

The full text of the cited block range, concatenated.

Always equals the contents of ‘content` 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.

Returns:

  • (String) 


16
 
# File 'lib/anthropic/models/beta/beta_citation_search_result_location_param.rb', line 16

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

Returns:

  • (Integer) 


26
 
# File 'lib/anthropic/models/beta/beta_citation_search_result_location_param.rb', line 26

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.

Returns:

  • (Integer) 


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

required :search_result_index, Integer

#source ⇒ String

Returns:

  • (String) 


42
 
# File 'lib/anthropic/models/beta/beta_citation_search_result_location_param.rb', line 42

required :source, String

#start_block_index ⇒ Integer

0-based index of the first cited block in the source’s ‘content` array.

Returns:

  • (Integer) 


48
 
# File 'lib/anthropic/models/beta/beta_citation_search_result_location_param.rb', line 48

required :start_block_index, Integer

#title ⇒ String?

Returns:

  • (String, nil) 


53
 
# File 'lib/anthropic/models/beta/beta_citation_search_result_location_param.rb', line 53

required :title, String, nil?: true

#type ⇒ Symbol, :search_result_location

Returns:

  • (Symbol, :search_result_location) 


58
 
# File 'lib/anthropic/models/beta/beta_citation_search_result_location_param.rb', line 58

required :type, const: :search_result_location