Noizu Labs: OpenAI v0.1.3

Noizu.OpenAI.Api.Image (Noizu Labs: OpenAI v0.1.3)

Noizu.OpenAI.Api.Image is a module that provides functionality for generating and editing images using OpenAI's API.

This module offers three main functions:

  1. create/2 - Creates a new image using the given prompt and options.
  2. edit/3 - Edits the given image based on the specified prompt and options.
  3. variation/3 - Generates a variation of the given image using the specified prompt and options.

usage

 Usage 

{:ok, image} = Noizu.OpenAI.Api.Image.create(prompt, options)
{:ok, edited_image} = Noizu.OpenAI.Api.Image.edit(image, prompt, options)
{:ok, image_variation} = Noizu.OpenAI.Api.Image.variation(image, prompt, options)

Link to this section Summary

Types

image_edit_options()
image_edit_response()
image_options()
image_response()
image_variation_options()
image_variation_response()

Functions

create(prompt, options \\ nil)

Generates an image using the OpenAI API.

edit(image, prompt, options \\ nil)

Generates a new image by editing an existing image based on the provided prompt.

variation(image, prompt, options \\ nil)

Generates a new image variation based on an existing image and the provided prompt.

Link to this section Types

Link to this type

image_edit_options()

@type image_edit_options() ::
  %{
    optional(:mask) => Noizu.OpenAI.mask_option(),
    optional(:completions | :n) => Noizu.OpenAI.completions_option(),
    optional(:size) => Noizu.OpenAI.size_option(),
    optional(:response_format) => Noizu.OpenAI.response_format_option(),
    optional(:user) => Noizu.OpenAI.user_option(),
    optional(:stream) => Noizu.OpenAI.stream_option()
  }
  | Keyword.t()
Link to this type

image_edit_response()

@type image_edit_response() :: map()
Link to this type

image_options()

@type image_options() ::
  %{
    optional(:completions | :n) => Noizu.OpenAI.completions_option(),
    optional(:size) => Noizu.OpenAI.size_option(),
    optional(:response_format) => Noizu.OpenAI.response_format_option(),
    optional(:user) => Noizu.OpenAI.user_option(),
    optional(:stream) => Noizu.OpenAI.stream_option()
  }
  | Keyword.t()
Link to this type

image_response()

@type image_response() :: map()
Link to this type

image_variation_options()

@type image_variation_options() ::
  %{
    optional(:completions | :n) => Noizu.OpenAI.completions_option(),
    optional(:size) => Noizu.OpenAI.size_option(),
    optional(:response_format) => Noizu.OpenAI.response_format_option(),
    optional(:user) => Noizu.OpenAI.user_option(),
    optional(:stream) => Noizu.OpenAI.stream_option()
  }
  | Keyword.t()
Link to this type

image_variation_response()

@type image_variation_response() :: map()

Link to this section Functions

Link to this function

create(prompt, options \\ nil)

@spec create(prompt :: String.t(), options :: image_options()) ::
  {:ok, image_response()} | {:error, term()}

Generates an image using the OpenAI API.

parameters

 Parameters

  • prompt: A string containing the prompt for the image
  • options: An optional map or keyword list containing API options

returns

 Returns

Returns a tuple {:ok, response} on successful API call, where response is a map containing the generated image. Returns {:error, term} on failure, where term contains error details.

example

 Example 

prompt = "A beautiful sunset over the beach with palm trees"
{:ok, response} = Noizu.OpenAI.image(prompt)
Link to this function

edit(image, prompt, options \\ nil)

@spec edit(image :: String.t(), prompt :: String.t(), options :: image_edit_options()) ::
  {:ok, image_edit_response()} | {:error, term()}

Generates a new image by editing an existing image based on the provided prompt.

parameters

 Parameters

  • image: The URL of the existing image to be edited
  • prompt: The text prompt describing the desired edit
  • options: A map or keyword list of optional parameters (e.g., :mask, :completions, :size, :response_format, :user, :stream)

returns

 Returns

Returns a tuple {:ok, response} on successful API call, where response is a map containing the generated image information. Returns {:error, term} on failure, where term contains error details.

example

 Example 

image_url = "https://example.com/your_image.jpg"
prompt = "Add a spaceship flying in the sky."
{:ok, response} = Noizu.OpenAI.image_edit(image_url, prompt)
Link to this function

variation(image, prompt, options \\ nil)

@spec variation(
  image :: String.t(),
  prompt :: String.t(),
  options :: image_variation_options()
) ::
  {:ok, image_variation_response()} | {:error, term()}

Generates a new image variation based on an existing image and the provided prompt.

parameters

 Parameters

  • image: The URL of the existing image to be varied
  • prompt: The text prompt describing the desired variation
  • options: A map or keyword list of optional parameters (e.g., :completions, :size, :response_format, :user, :stream)

returns

 Returns

Returns a tuple {:ok, response} on successful API call, where response is a map containing the generated image variation information. Returns {:error, term} on failure, where term contains error details.

example

 Example 

image_url = "https://example.com/your_image.jpg"
prompt = "A different version of the image with more clouds in the sky."
{:ok, response} = Noizu.OpenAI.image_variation(image_url, prompt)