Class: OpenAI::Models::Chat::ChatCompletionMessage::Annotation::URLCitation

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• OpenAI::Models::Chat::ChatCompletionMessage::Annotation::URLCitation

Defined in:

lib/openai/models/chat/chat_completion_message.rb,
sig/openai/models/chat/chat_completion_message.rbs

Overview

See Also:

• OpenAI::Models::Chat::ChatCompletionMessage::Annotation#url_citation

Instance Attribute Summary

• #end_index ⇒ Integer

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

• #start_index ⇒ Integer

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

• #title ⇒ String

  The title of the web resource.

• #url ⇒ String

  The URL of the web resource.

Attributes inherited from Internal::Type::BaseModel

#last_response

Instance Method Summary

• #initialize ⇒ Object constructor
• #to_hash ⇒ {

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, coerce_with_error, 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

Parameters:

• end_index —

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

• start_index —

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

• title —

  The title of the web resource.

• url —

  The URL of the web resource.

# File 'sig/openai/models/chat/chat_completion_message.rbs', line 154

def initialize: (

Instance Attribute Details

#end_index ⇒ Integer

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

Returns:

• (Integer)

# File 'lib/openai/models/chat/chat_completion_message.rb', line 124

required :end_index, Integer

#start_index ⇒ Integer

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

Returns:

• (Integer)

# File 'lib/openai/models/chat/chat_completion_message.rb', line 130

required :start_index, Integer

#title ⇒ String

The title of the web resource.

Returns:

• (String)

# File 'lib/openai/models/chat/chat_completion_message.rb', line 136

required :title, String

#url ⇒ String

The URL of the web resource.

Returns:

• (String)

# File 'lib/openai/models/chat/chat_completion_message.rb', line 142

required :url, String

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/openai/models/chat/chat_completion_message.rbs', line 161

def to_hash: -> {