image.go

// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.

package openai

import (
"bytes"
"context"
"io"
"mime/multipart"
"net/http"

"github.com/openai/openai-go/internal/apiform"
"github.com/openai/openai-go/internal/apijson"
"github.com/openai/openai-go/internal/requestconfig"
"github.com/openai/openai-go/option"
"github.com/openai/openai-go/packages/param"
"github.com/openai/openai-go/packages/resp"
)

// ImageService contains methods and other services that help with interacting with
// the openai API.
//
// Note, unlike clients, this service does not read variables from the environment
// automatically. You should not instantiate this service directly, and instead use
// the [NewImageService] method instead.
typeImageServicestruct {
Options []option.RequestOption
}

// NewImageService generates a new service that applies the given options to each
// request. These options are applied after the parent client's options (if there
// is one), and before any request-specific options.
funcNewImageService(opts...option.RequestOption) (rImageService) {
r=ImageService{}
r.Options=opts
return
}

// Creates a variation of a given image.
func (r*ImageService) NewVariation(ctx context.Context, bodyImageNewVariationParams, opts...option.RequestOption) (res*ImagesResponse, errerror) {
opts=append(r.Options[:], opts...)
path:="images/variations"
err=requestconfig.ExecuteNewRequest(ctx, http.MethodPost, path, body, &res, opts...)
return
}

// Creates an edited or extended image given an original image and a prompt.
func (r*ImageService) Edit(ctx context.Context, bodyImageEditParams, opts...option.RequestOption) (res*ImagesResponse, errerror) {
opts=append(r.Options[:], opts...)
path:="images/edits"
err=requestconfig.ExecuteNewRequest(ctx, http.MethodPost, path, body, &res, opts...)
return
}

// Creates an image given a prompt.
func (r*ImageService) Generate(ctx context.Context, bodyImageGenerateParams, opts...option.RequestOption) (res*ImagesResponse, errerror) {
opts=append(r.Options[:], opts...)
path:="images/generations"
err=requestconfig.ExecuteNewRequest(ctx, http.MethodPost, path, body, &res, opts...)
return
}

// Represents the url or the content of an image generated by the OpenAI API.
typeImagestruct {
// The base64-encoded JSON of the generated image, if `response_format` is
// `b64_json`.
B64JSONstring`json:"b64_json"`
// The prompt that was used to generate the image, if there was any revision to the
// prompt.
RevisedPromptstring`json:"revised_prompt"`
// The URL of the generated image, if `response_format` is `url` (default).
URLstring`json:"url"`
// Metadata for the response, check the presence of optional fields with the
// [resp.Field.IsPresent] method.
JSONstruct {
B64JSON resp.Field
RevisedPrompt resp.Field
URL resp.Field
ExtraFieldsmap[string]resp.Field
rawstring
 } `json:"-"`
}

// Returns the unmodified JSON received from the API
func (rImage) RawJSON() string { returnr.JSON.raw }
func (r*Image) UnmarshalJSON(data []byte) error {
returnapijson.UnmarshalRoot(data, r)
}

typeImageModel=string

const (
ImageModelDallE2ImageModel="dall-e-2"
ImageModelDallE3ImageModel="dall-e-3"
)

typeImagesResponsestruct {
Createdint64`json:"created,required"`
Data []Image`json:"data,required"`
// Metadata for the response, check the presence of optional fields with the
// [resp.Field.IsPresent] method.
JSONstruct {
Created resp.Field
Data resp.Field
ExtraFieldsmap[string]resp.Field
rawstring
 } `json:"-"`
}

// Returns the unmodified JSON received from the API
func (rImagesResponse) RawJSON() string { returnr.JSON.raw }
func (r*ImagesResponse) UnmarshalJSON(data []byte) error {
returnapijson.UnmarshalRoot(data, r)
}

typeImageNewVariationParamsstruct {
// The image to use as the basis for the variation(s). Must be a valid PNG file,
// less than 4MB, and square.
Image io.Reader`json:"image,required" format:"binary"`
// The number of images to generate. Must be between 1 and 10. For `dall-e-3`, only
// `n=1` is supported.
N param.Opt[int64] `json:"n,omitzero"`
// A unique identifier representing your end-user, which can help OpenAI to monitor
// and detect abuse.
// [Learn more](https://platform.openai.com/docs/guides/safety-best-practices#end-user-ids).
User param.Opt[string] `json:"user,omitzero"`
// The model to use for image generation. Only `dall-e-2` is supported at this
// time.
ModelImageModel`json:"model,omitzero"`
// The format in which the generated images are returned. Must be one of `url` or
// `b64_json`. URLs are only valid for 60 minutes after the image has been
// generated.
//
// Any of "url", "b64_json".
ResponseFormatImageNewVariationParamsResponseFormat`json:"response_format,omitzero"`
// The size of the generated images. Must be one of `256x256`, `512x512`, or
// `1024x1024`.
//
// Any of "256x256", "512x512", "1024x1024".
SizeImageNewVariationParamsSize`json:"size,omitzero"`
paramObj
}

// IsPresent returns true if the field's value is not omitted and not the JSON
// "null". To check if this field is omitted, use [param.IsOmitted].
func (fImageNewVariationParams) IsPresent() bool { return!param.IsOmitted(f) &&!f.IsNull() }

func (rImageNewVariationParams) MarshalMultipart() (data []byte, contentTypestring, errerror) {
buf:=bytes.NewBuffer(nil)
writer:=multipart.NewWriter(buf)
err=apiform.MarshalRoot(r, writer)
iferr!=nil {
writer.Close()
returnnil, "", err
 }
err=writer.Close()
iferr!=nil {
returnnil, "", err
 }
returnbuf.Bytes(), writer.FormDataContentType(), nil
}

// The format in which the generated images are returned. Must be one of `url` or
// `b64_json`. URLs are only valid for 60 minutes after the image has been
// generated.
typeImageNewVariationParamsResponseFormatstring

const (
ImageNewVariationParamsResponseFormatURLImageNewVariationParamsResponseFormat="url"
ImageNewVariationParamsResponseFormatB64JSONImageNewVariationParamsResponseFormat="b64_json"
)

// The size of the generated images. Must be one of `256x256`, `512x512`, or
// `1024x1024`.
typeImageNewVariationParamsSizestring

const (
ImageNewVariationParamsSize256x256ImageNewVariationParamsSize="256x256"
ImageNewVariationParamsSize512x512ImageNewVariationParamsSize="512x512"
ImageNewVariationParamsSize1024x1024ImageNewVariationParamsSize="1024x1024"
)

typeImageEditParamsstruct {
// 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 io.Reader`json:"image,required" format:"binary"`
// A text description of the desired image(s). The maximum length is 1000
// characters.
Promptstring`json:"prompt,required"`
// The number of images to generate. Must be between 1 and 10.
N param.Opt[int64] `json:"n,omitzero"`
// A unique identifier representing your end-user, which can help OpenAI to monitor
// and detect abuse.
// [Learn more](https://platform.openai.com/docs/guides/safety-best-practices#end-user-ids).
User param.Opt[string] `json:"user,omitzero"`
// The model to use for image generation. Only `dall-e-2` is supported at this
// time.
ModelImageModel`json:"model,omitzero"`
// The format in which the generated images are returned. Must be one of `url` or
// `b64_json`. URLs are only valid for 60 minutes after the image has been
// generated.
//
// Any of "url", "b64_json".
ResponseFormatImageEditParamsResponseFormat`json:"response_format,omitzero"`
// The size of the generated images. Must be one of `256x256`, `512x512`, or
// `1024x1024`.
//
// Any of "256x256", "512x512", "1024x1024".
SizeImageEditParamsSize`json:"size,omitzero"`
// 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 io.Reader`json:"mask" format:"binary"`
paramObj
}

// IsPresent returns true if the field's value is not omitted and not the JSON
// "null". To check if this field is omitted, use [param.IsOmitted].
func (fImageEditParams) IsPresent() bool { return!param.IsOmitted(f) &&!f.IsNull() }

func (rImageEditParams) MarshalMultipart() (data []byte, contentTypestring, errerror) {
buf:=bytes.NewBuffer(nil)
writer:=multipart.NewWriter(buf)
err=apiform.MarshalRoot(r, writer)
iferr!=nil {
writer.Close()
returnnil, "", err
 }
err=writer.Close()
iferr!=nil {
returnnil, "", err
 }
returnbuf.Bytes(), writer.FormDataContentType(), nil
}

// The format in which the generated images are returned. Must be one of `url` or
// `b64_json`. URLs are only valid for 60 minutes after the image has been
// generated.
typeImageEditParamsResponseFormatstring

const (
ImageEditParamsResponseFormatURLImageEditParamsResponseFormat="url"
ImageEditParamsResponseFormatB64JSONImageEditParamsResponseFormat="b64_json"
)

// The size of the generated images. Must be one of `256x256`, `512x512`, or
// `1024x1024`.
typeImageEditParamsSizestring

const (
ImageEditParamsSize256x256ImageEditParamsSize="256x256"
ImageEditParamsSize512x512ImageEditParamsSize="512x512"
ImageEditParamsSize1024x1024ImageEditParamsSize="1024x1024"
)

typeImageGenerateParamsstruct {
// 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`.
Promptstring`json:"prompt,required"`
// The number of images to generate. Must be between 1 and 10. For `dall-e-3`, only
// `n=1` is supported.
N param.Opt[int64] `json:"n,omitzero"`
// A unique identifier representing your end-user, which can help OpenAI to monitor
// and detect abuse.
// [Learn more](https://platform.openai.com/docs/guides/safety-best-practices#end-user-ids).
User param.Opt[string] `json:"user,omitzero"`
// The model to use for image generation.
ModelImageModel`json:"model,omitzero"`
// The format in which the generated images are returned. Must be one of `url` or
// `b64_json`. URLs are only valid for 60 minutes after the image has been
// generated.
//
// Any of "url", "b64_json".
ResponseFormatImageGenerateParamsResponseFormat`json:"response_format,omitzero"`
// 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.
//
// Any of "256x256", "512x512", "1024x1024", "1792x1024", "1024x1792".
SizeImageGenerateParamsSize`json:"size,omitzero"`
// 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`.
//
// Any of "vivid", "natural".
StyleImageGenerateParamsStyle`json:"style,omitzero"`
// 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`.
//
// Any of "standard", "hd".
QualityImageGenerateParamsQuality`json:"quality,omitzero"`
paramObj
}

// IsPresent returns true if the field's value is not omitted and not the JSON
// "null". To check if this field is omitted, use [param.IsOmitted].
func (fImageGenerateParams) IsPresent() bool { return!param.IsOmitted(f) &&!f.IsNull() }

func (rImageGenerateParams) MarshalJSON() (data []byte, errerror) {
typeshadowImageGenerateParams
returnparam.MarshalObject(r, (*shadow)(&r))
}

// 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`.
typeImageGenerateParamsQualitystring

const (
ImageGenerateParamsQualityStandardImageGenerateParamsQuality="standard"
ImageGenerateParamsQualityHDImageGenerateParamsQuality="hd"
)

// The format in which the generated images are returned. Must be one of `url` or
// `b64_json`. URLs are only valid for 60 minutes after the image has been
// generated.
typeImageGenerateParamsResponseFormatstring

const (
ImageGenerateParamsResponseFormatURLImageGenerateParamsResponseFormat="url"
ImageGenerateParamsResponseFormatB64JSONImageGenerateParamsResponseFormat="b64_json"
)

// 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.
typeImageGenerateParamsSizestring

const (
ImageGenerateParamsSize256x256ImageGenerateParamsSize="256x256"
ImageGenerateParamsSize512x512ImageGenerateParamsSize="512x512"
ImageGenerateParamsSize1024x1024ImageGenerateParamsSize="1024x1024"
ImageGenerateParamsSize1792x1024ImageGenerateParamsSize="1792x1024"
ImageGenerateParamsSize1024x1792ImageGenerateParamsSize="1024x1792"
)

// 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`.
typeImageGenerateParamsStylestring

const (
ImageGenerateParamsStyleVividImageGenerateParamsStyle="vivid"
ImageGenerateParamsStyleNaturalImageGenerateParamsStyle="natural"
)