Class: OpenAI::Models::Chat::ChatCompletionContentPartImage::ImageURL

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• OpenAI::Models::Chat::ChatCompletionContentPartImage::ImageURL

Defined in:

lib/openai/models/chat/chat_completion_content_part_image.rb

Overview

See Also:

• #image_url

Defined Under Namespace

Modules: Detail

Instance Attribute Summary

• #detail ⇒ Symbol, ...

  Specifies the detail level of the image.

• #url ⇒ String

  Either a URL of the image or the base64 encoded image data.

Instance Method Summary

• #initialize(url: , detail: nil) ⇒ Object constructor

  Some parameter documentations has been truncated, see ImageURL for more details.

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, 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(url: , detail: nil) ⇒ Object

Some parameter documentations has been truncated, see OpenAI::Models::Chat::ChatCompletionContentPartImage::ImageURL for more details.

Parameters:

• url (String) (defaults to: ) —

  Either a URL of the image or the base64 encoded image data.

• detail (Symbol, OpenAI::Models::Chat::ChatCompletionContentPartImage::ImageURL::Detail) (defaults to: nil) —

  Specifies the detail level of the image. Learn more in the [Vision guide](https:

# File 'lib/openai/models/chat/chat_completion_content_part_image.rb', line 40

Instance Attribute Details

#detail ⇒ Symbol, ...

Specifies the detail level of the image. Learn more in the [Vision guide](platform.openai.com/docs/guides/vision#low-or-high-fidelity-image-understanding).

Returns:

• (Symbol, OpenAI::Models::Chat::ChatCompletionContentPartImage::ImageURL::Detail, nil)

# File 'lib/openai/models/chat/chat_completion_content_part_image.rb', line 38

optional :detail, enum: -> { OpenAI::Chat::ChatCompletionContentPartImage::ImageURL::Detail }

#url ⇒ String

Either a URL of the image or the base64 encoded image data.

Returns:

• (String)

# File 'lib/openai/models/chat/chat_completion_content_part_image.rb', line 31

required :url, String