images

README

Images

Bindings for the images endpoint.

Example

See Open AI's guide to image generation.

See images-example.go.

Documentation

Overview

Package images provides bindings for the images endpoint. Given a prompt and/or an input image, the model will generate a new image. Related guide: Image Generation.

Index

• Constants
• type CreationRequest
• type EditRequest
• type Response
  • func MakeCreationRequest(request *CreationRequest, organizationID *string) (*Response, error)
  • func MakeEditRequest(request *EditRequest, organizationID *string) (*Response, error)
  • func MakeModeratedCreationRequest(request *CreationRequest, organizationID *string) (*Response, *moderations.Response, error)
  • func MakeModeratedRequest(request *EditRequest, organizationID *string) (*Response, *moderations.Response, error)
  • func MakeVariationRequest(request *VariationRequest, organizationID *string) (*Response, error)
• type VariationRequest

Constants

const (
	BaseEndpoint      = common.BaseURL + "images/"
	CreateEndpoint    = BaseEndpoint + "generations"
	EditEndpoint      = BaseEndpoint + "edits"
	VariationEndpoint = BaseEndpoint + "variations"
)

const (
	Dalle2SmallImage  = "256x256"
	Dalle2MediumImage = "512x512"
	Dalle2LargeImage  = "1024x1024"

	Dalle3SquareImage    = "1024x1024"
	Dalle3LandscapeImage = "1792x1024"
	Dalle3PortraitImage  = "1024x1792"

	// Deprecated: Use Dalle2SmallImage instead.
	SmallImage = Dalle2SmallImage
	// Deprecated: Use Dalle2MediumImage instead.
	MediumImage = Dalle2MediumImage
	// Deprecated: Use Dalle2LargeImage instead.
	LargeImage = Dalle2LargeImage
)

const (
	ResponseFormatURL     = "url"
	ResponseFormatB64JSON = "b64_json"
)

const (
	ModelDalle2 = "dall-e-2"
	ModelDalle3 = "dall-e-3"
)

const (
	QualityStandard = "standard"
	QualityHD       = "hd"
)

const (
	StyleVivid   = "vivid"
	StyleNatural = "natural"
)

Types

type CreationRequest

type CreationRequest struct {
	// A text description of the desired image(s).
	// The maximum length is 1000 characters for dall-e-2 and 4000 characters for dall-e-3.
	Prompt string `json:"prompt,omitempty"`

	// The model to use for image generation.
	Model string `json:"model,omitempty"`

	// The number of images to generate. Must be between 1 and 10.
	// For dall-e-3, only n=1 is supported.
	N *uint64 `json:"n,omitempty"`

	// The quality of the image that will be generated.
	// "hd" creates images with finer details and greater consistency across the image.
	// This param is only supported for dall-e-3.
	Quality string `json:"quality,omitempty"`

	// The format in which the generated images are returned. Must be one of url or b64_json.
	ResponseFormat string `json:"response_format,omitempty"`

	// The size of the generated images.
	// Must be one of 256x256, 512x512, or 1024x1024 for dall-e-2.
	// Must be one of 1024x1024, 1792x1024, or 1024x1792 for dall-e-3 models.
	Size string `json:"size,omitempty"`

	// The style of the generated images. Must be one of vivid or natural.
	// Vivid causes the model to lean towards generating hyper-real and dramatic images.
	// Natural causes the model to produce more natural, less hyper-real looking images.
	// This param is only supported for dall-e-3.
	Style string `json:"style,omitempty"`

	// A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse.
	User string `json:"user,omitempty"`
}

Request structure for the image creation API endpoint.

type EditRequest

type EditRequest struct {
	// The image to edit. Must be a valid PNG file, less than 4MB, and square.
	// If mask is not provided, image must have transparency, which will be
	// used as the mask.
	Image string `json:"image,omitempty"`

	// The name of the image, including its extension, but not including
	// any path information.
	ImageName string `json:"-"`

	// A text description of the desired image(s). The maximum length is 1000 characters.
	Prompt string `json:"prompt,omitempty"`

	// An additional image whose fully transparent areas (e.g. where alpha is zero)
	// indicate where image should be edited. Must be a valid PNG file, less than 4MB,
	// and have the same dimensions as image.
	Mask string `json:"mask,omitempty"`

	// The name of the mask, including its extension, but not including any
	// path information.
	MaskName string `json:"-"`

	// The model to use for image generation. Only dall-e-2 is supported at this time.
	Model string `json:"model,omitempty"`

	// The number of images to generate. Must be between 1 and 10.
	N *uint64 `json:"n,omitempty"`

	// The size of the generated images. Must be one of 256x256, 512x512, or 1024x1024.
	Size string `json:"size,omitempty"`

	// The format in which the generated images are returned. Must be one of url or b64_json.
	ResponseFormat string `json:"response_format,omitempty"`

	// A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse.
	User string `json:"user,omitempty"`
}

Request structure for the image editing API endpoint.

type Response

type Response struct {
	Created uint64 `json:"created"`
	Data    []struct {
		URL           string `json:"url"`
		B64JSON       string `json:"b64_json"`
		RevisedPrompt string `json:"revised_prompt"`
	}
	Error *common.ResponseError `json:"error,omitempty"`
}

Response structure for the image API endpoint.

func MakeCreationRequest

func MakeCreationRequest(request *CreationRequest, organizationID *string) (*Response, error)

Creates an image given a prompt.

func MakeEditRequest

func MakeEditRequest(request *EditRequest, organizationID *string) (*Response, error)

Creates an edited or extended image given an original image and a prompt.

func MakeModeratedCreationRequest

func MakeModeratedCreationRequest(request *CreationRequest, organizationID *string) (*Response, *moderations.Response, error)

Runs request inputs through the moderations endpoint prior to making the request. Returns a moderations.ModerationFlagError prior to making the request if the inputs are flagged by the moderations endpoint.

func MakeModeratedRequest

func MakeModeratedRequest(request *EditRequest, organizationID *string) (*Response, *moderations.Response, error)

Runs request inputs through the moderations endpoint prior to making the request. Returns a moderations.ModerationFlagError prior to making the request if the inputs are flagged by the moderations endpoint.

func MakeVariationRequest

func MakeVariationRequest(request *VariationRequest, organizationID *string) (*Response, error)

Creates a variation of a given image.

type VariationRequest

type VariationRequest struct {
	// The image to use as the basis for the variation(s). Must be a valid PNG file, less than 4MB, and square.
	Image string `json:"image,omitempty"`

	// The name of the image, including its extension, but not including
	// any path information.
	ImageName string `json:"-"`

	// The model to use for image generation. Only dall-e-2 is supported at this time.
	Model string `json:"model,omitempty"`

	// The number of images to generate. Must be between 1 and 10.
	N *uint64 `json:"n,omitempty"`

	// The size of the generated images. Must be one of 256x256, 512x512, or 1024x1024.
	Size string `json:"size,omitempty"`

	// The format in which the generated images are returned. Must be one of url or b64_json.
	ResponseFormat string `json:"response_format,omitempty"`

	// A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse.
	User string `json:"user,omitempty"`
}

Request structure for the image variations API endpoint.