View Source LangChain.Images.OpenAIImage (LangChain v0.3.0-rc.0)

Represents the OpenAI Images API endpoint for working with DALL-E-2 and DALL-E-3.

Parses and validates inputs for making a request from the OpenAI Image API.

Converts responses into more specialized LangChain data structures and provide functions for saving generated images.

Summary

Types

t()

Functions

call(openai)

Calls the OpenAI API passing the OpenAIImage struct with configuration.

for_api(openai)

Return the params formatted for an API request.

new(attrs)

Setup a OpenAIImage client configuration.

new!(attrs)

Setup a OpenAIImage client configuration and return it or raise an error if invalid.

Types

t()

@type t() :: %LangChain.Images.OpenAIImage{
  api_key: term(),
  endpoint: term(),
  model: term(),
  n: term(),
  prompt: term(),
  quality: term(),
  receive_timeout: term(),
  response_format: term(),
  size: term(),
  style: term(),
  user: term()
}

Functions

call(openai)

@spec call(t()) :: {:ok, [LangChain.Images.GeneratedImage.t()]} | {:error, String.t()}

Calls the OpenAI API passing the OpenAIImage struct with configuration.

When successful, it returns {:ok, generated_images} where that is a list of LangChain.Images.GeneratedImage structs.

for_api(openai)

@spec for_api(t()) :: %{required(atom()) => any()}

Return the params formatted for an API request.

new(attrs)

@spec new(attrs :: map()) :: {:ok, t()} | {:error, Ecto.Changeset.t()}

Setup a OpenAIImage client configuration.

new!(attrs)

@spec new!(attrs :: map()) :: t() | no_return()

Setup a OpenAIImage client configuration and return it or raise an error if invalid.