Class: OpenAI::Models::Responses::ResponseOutputTextAnnotationAddedEvent::Annotation::URLCitation

Inherits:
Internal::Type::BaseModel
  • Object
show all
Defined in:
lib/openai/models/responses/response_output_text_annotation_added_event.rb,
sig/openai/models/responses/response_output_text_annotation_added_event.rbs

Instance Attribute Summary collapse

Attributes inherited from Internal::Type::BaseModel

#last_response

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], #_request_id, #_set_last_response, coerce, #deconstruct_keys, #deep_to_h, dump, #encode_with, 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 ⇒ Object 



111
 
# File 'sig/openai/models/responses/response_output_text_annotation_added_event.rbs', line 111

def initialize: (

Instance Attribute Details

#end_index ⇒ Integer

The index of the last character of the URL citation in the message.

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


133
 
# File 'lib/openai/models/responses/response_output_text_annotation_added_event.rb', line 133

required :end_index, Integer

#start_index ⇒ Integer

The index of the first character of the URL citation in the message.

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


139
 
# File 'lib/openai/models/responses/response_output_text_annotation_added_event.rb', line 139

required :start_index, Integer

#title ⇒ String

The title of the web resource.

Parameters:

  • value (String)

Returns:

  • (String) 


145
 
# File 'lib/openai/models/responses/response_output_text_annotation_added_event.rb', line 145

required :title, String

#type ⇒ Symbol, :url_citation

The type of the URL citation. Always url_citation.

Parameters:

  • value (:url_citation)

Returns:

  • (Symbol, :url_citation) 


151
 
# File 'lib/openai/models/responses/response_output_text_annotation_added_event.rb', line 151

required :type, const: :url_citation

#url ⇒ String

The URL of the web resource.

Parameters:

  • value (String)

Returns:

  • (String) 


157
 
# File 'lib/openai/models/responses/response_output_text_annotation_added_event.rb', line 157

required :url, String

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


119
 
# File 'sig/openai/models/responses/response_output_text_annotation_added_event.rbs', line 119

def to_hash: -> {