openai

Documentation

Index

• Variables
• func ConfigSchema() []engine.ConfigField
• func ModelsByCapability() map[string][]string
• type Config
• type Engine
  • func New(cfg Config) *Engine
  • func (e *Engine) Capabilities() engine.Capability
  • func (e *Engine) Compile(graph workflow.Graph) (Request, error)
  • func (e *Engine) Execute(ctx context.Context, graph workflow.Graph) (engine.Result, error)
• type Request

Variables

var ErrMissingPrompt = errors.New("openai: prompt not found in workflow graph")

Functions

func ConfigSchema

func ConfigSchema() []engine.ConfigField

ConfigSchema returns the configuration fields required by the OpenAI engine.

func ModelsByCapability

func ModelsByCapability() map[string][]string

ModelsByCapability returns all known OpenAI models grouped by capability.

Types

type Config

type Config struct {
	APIKey     string
	BaseURL    string
	Model      string
	Quality    string
	Style      string
	HTTPClient *http.Client
}

Config configures the OpenAI image engine.

type Engine

type Engine struct {
	// contains filtered or unexported fields
}

Engine compiles a workflow graph into an OpenAI image request.

func New

func New(cfg Config) *Engine

New creates an OpenAI engine instance.

func (*Engine) Capabilities

func (e *Engine) Capabilities() engine.Capability

Capabilities implements engine.Describer.

func (*Engine) Compile

func (e *Engine) Compile(graph workflow.Graph) (Request, error)

Compile extracts prompt and size from a graph into an OpenAI request.

func (*Engine) Execute

func (e *Engine) Execute(ctx context.Context, graph workflow.Graph) (engine.Result, error)

Execute compiles the workflow and calls the OpenAI images API.

type Request

type Request struct {
	Model   string
	Prompt  string
	Size    string
	Quality string
	Style   string
}

Request is the flattened image generation payload derived from a graph.