Class: OpenAI::Models::Responses::Tool::ImageGeneration::InputImageMask

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• OpenAI::Models::Responses::Tool::ImageGeneration::InputImageMask

Defined in:

lib/openai/models/responses/tool.rb,
sig/openai/models/responses/tool.rbs

Overview

See Also:

• OpenAI::Models::Responses::Tool::ImageGeneration#input_image_mask

Instance Attribute Summary

• #file_id ⇒ String^?

  File ID for the mask image.

• #image_url ⇒ String^?

  Base64-encoded mask image.

Attributes inherited from Internal::Type::BaseModel

#last_response

Instance Method Summary

• #initialize ⇒ InputImageMask constructor

  A new instance of InputImageMask.

• #to_hash ⇒ { ?file_id: String, ?image_url: String }

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 ⇒ InputImageMask

Returns a new instance of InputImageMask.

Parameters:

• file_id —

  File ID for the mask image.

• image_url —

  Base64-encoded mask image.

• file_id: (String)
• image_url: (String)

# File 'sig/openai/models/responses/tool.rbs', line 890

def initialize: (?file_id: String, ?image_url: String) -> void

Instance Attribute Details

#file_id ⇒ String^?

File ID for the mask image.

Returns:

• (String, nil)

# File 'lib/openai/models/responses/tool.rb', line 846

optional :file_id, String

#image_url ⇒ String^?

Base64-encoded mask image.

Returns:

• (String, nil)

# File 'lib/openai/models/responses/tool.rb', line 852

optional :image_url, String

Instance Method Details

#to_hash ⇒ { ?file_id: String, ?image_url: String }

Returns:

• ({ ?file_id: String, ?image_url: String })

# File 'sig/openai/models/responses/tool.rbs', line 892

def to_hash: -> { ?file_id: String, ?image_url: String }