Class: RunApi::GptImage::Resources::EditImage

Inherits:
Object
  • Object
show all
Includes:
Core::ResourceHelpers
Defined in:
lib/runapi/gpt_image/resources/edit_image.rb

Overview

GPT Image 1.5 image-to-image edit resource.

Constant Summary collapse

ENDPOINT = 
"/api/v1/gpt_image/edit_image"
RESPONSE_CLASS = 
Types::EditImageResponse
COMPLETED_RESPONSE_CLASS = 
Types::CompletedEditImageResponse

Instance Method Summary collapse

Constructor Details

#initialize(http) ⇒ EditImage

Returns a new instance of EditImage.



15
16
17
 
# File 'lib/runapi/gpt_image/resources/edit_image.rb', line 15

def initialize(http)
  @http = http
end

Instance Method Details

#create(**params) ⇒ RunApi::GptImage::Types::EditImageResponse

Create an image-to-image edit task.

Parameters:

  • params (Hash) —

    edit parameters

Returns:



32
33
34
35
36
 
# File 'lib/runapi/gpt_image/resources/edit_image.rb', line 32

def create(**params)
  params = compact_params(params)
  validate_params!(params)
  request(:post, ENDPOINT, body: params)
end

#get(id) ⇒ RunApi::GptImage::Types::EditImageResponse

Get edit status by task ID.

Parameters:

  • id (String) —

    task ID

Returns:



42
43
44
 
# File 'lib/runapi/gpt_image/resources/edit_image.rb', line 42

def get(id)
  request(:get, "#{ENDPOINT}/#{id}")
end

#run(**params) ⇒ RunApi::GptImage::Types::CompletedEditImageResponse

Edit an image and wait until complete.

Parameters:

  • params (Hash) —

    edit parameters

Returns:



23
24
25
26
 
# File 'lib/runapi/gpt_image/resources/edit_image.rb', line 23

def run(**params)
  task = create(**params)
  poll_until_complete { get(task.id) }
end