openai

package module

Go to main page

Versions in this module

v1

v1.2.0

Aug 15, 2026

Changes in this version

+ type ImageInputTokensDetails struct

+ ImageTokens int

+ TextTokens int

type ImageRequest

+ Background string

+ Moderation string

+ OutputCompression *int

+ OutputFormat string

type ImageResponse

+ Usage *ImageUsage

+ type ImageUsage struct

+ InputTokens int

+ InputTokensDetails *ImageInputTokensDetails

+ OutputTokens int

+ TotalTokens int

v1.1.2

Aug 11, 2026

v1.1.1

Aug 11, 2026

v1.1.0

Aug 11, 2026

Changes in this version

type Client

+ func (c *Client) Capabilities() ai.Capabilities

v1.0.0

Aug 11, 2026

Changes in this version

+ type IncompleteDetails struct

+ Reason string

+ type ResponseAnnotation struct

+ EndIndex int

+ StartIndex int

+ Title string

+ Type string

+ URL string

+ type ResponseContent struct

+ Annotations []ResponseAnnotation

+ Text string

+ Type string

type ResponseOutput

+ Arguments string

+ CallID string

+ ID string

+ Name string

+ Role string

+ Status string

type ResponseStreamEvent

+ Annotation *ResponseAnnotation

+ type ResponseText struct

+ Format json.RawMessage

+ type ResponseTool struct

+ Description string

+ Filters *WebSearchFilters

+ Name string

+ Parameters json.RawMessage

+ Type string

+ UserLocation *ResponseUserLocation

+ type ResponseUserLocation struct

+ City string

+ Country string

+ Region string

+ Timezone string

+ Type string

type ResponsesRequest

+ Text *ResponseText

+ ToolChoice any

+ Tools []ResponseTool

+ TopP *float64

type ResponsesResponse

+ IncompleteDetails *IncompleteDetails

+ type WebSearchFilters struct

+ AllowedDomains []string

v0

v0.3.0

Aug 5, 2026

Changes in this version

+ const ImageFormatB64JSON

+ const ImageFormatURL

+ const ModelDallE2

+ const ModelDallE3

+ const ModelGPTImage1

+ var ErrImageFormat = errors.New("openai: model cannot return that image format")

+ var ErrNoImageBytes = errors.New("openai: image was returned as a URL")

+ var ErrNoImageRequest = errors.New("openai: image request is nil")

type ImageData

+ func (d ImageData) Bytes() ([]byte, error)

v0.2.0

Jul 11, 2026

Changes in this version

type Client

+ func (c *Client) FileContentTo(ctx context.Context, id string, w io.Writer) error

+ func (c *Client) SpeechTo(ctx context.Context, req *SpeechRequest, w io.Writer) error

v0.1.3

Jul 10, 2026

v0.1.2

Jul 10, 2026

Changes in this version

+ type ResponseItem struct

+ Arguments string

+ CallID string

+ ID string

+ Name string

+ Type string

type ResponseStreamEvent

+ Arguments string

+ Item *ResponseItem

+ ItemID string

+ OutputIndex int

v0.1.1

Jul 9, 2026

Changes in this version

type Client

+ func (c *Client) ResponsesStream(ctx context.Context, req *ResponsesRequest) iter.Seq2[ResponseStreamEvent, error]

+ type ResponseStreamEvent struct

+ Code string

+ Delta string

+ Message string

+ Response *ResponsesResponse

+ Type string

type ResponsesRequest

+ Stream bool

v0.1.0

Jul 8, 2026

Changes in this version

+ const DefaultBaseURL

+ const DefaultModerationModel

+ const ModelGPT4Turbo

+ const ModelGPT4o

+ const ModelGPT4oMini

+ const ModelO3Mini

+ type Batch struct

+ CreatedAt int64

+ Endpoint string

+ ErrorFileID string

+ ID string

+ InputFileID string

+ Object string

+ OutputFileID string

+ RequestCounts BatchCounts

+ Status string

+ type BatchCounts struct

+ Completed int

+ Failed int

+ Total int

+ type ChatChoice struct

+ FinishReason string

+ Index int

+ Message ChatMessage

+ type ChatFunctionCall struct

+ Arguments string

+ Name string

+ type ChatFunctionDef struct

+ Description string

+ Name string

+ Parameters json.RawMessage

+ type ChatMessage struct

+ Content any

+ Name string

+ Role string

+ ToolCallID string

+ ToolCalls []ChatToolCall

+ type ChatRequest struct

+ MaxCompletionTokens int

+ Messages []ChatMessage

+ Model string

+ N int

+ ResponseFormat json.RawMessage

+ Seed *int

+ Stop []string

+ Stream bool

+ StreamOptions *streamOptions

+ Temperature *float64

+ ToolChoice any

+ Tools []ChatTool

+ TopP *float64

+ User string

+ type ChatResponse struct

+ Choices []ChatChoice

+ ID string

+ Model string

+ Object string

+ Usage ChatUsage

+ type ChatStreamChunk struct

+ Choices []struct{ ... }

+ ID string

+ Model string

+ Usage *ChatUsage

+ type ChatTool struct

+ Function ChatFunctionDef

+ Type string

+ type ChatToolCall struct

+ Function ChatFunctionCall

+ ID string

+ Type string

+ type ChatUsage struct

+ CompletionTokens int

+ PromptTokens int

+ TotalTokens int

+ type Client struct

+ func New(apiKey string, opts ...Option) *Client

+ func (c *Client) CancelBatch(ctx context.Context, id string) (*Batch, error)

+ func (c *Client) ChatCompletion(ctx context.Context, req *ChatRequest) (*ChatResponse, error)

+ func (c *Client) ChatCompletionStream(ctx context.Context, req *ChatRequest) iter.Seq2[ChatStreamChunk, error]

+ func (c *Client) CreateBatch(ctx context.Context, inputFileID, endpoint, completionWindow string) (*Batch, error)

+ func (c *Client) CreateResponse(ctx context.Context, req *ResponsesRequest) (*ResponsesResponse, error)

+ func (c *Client) DeleteFile(ctx context.Context, id string) error

+ func (c *Client) Embed(ctx context.Context, model string, input ...string) ([][]float64, error)

+ func (c *Client) Embeddings(ctx context.Context, req *EmbeddingRequest) (*EmbeddingResponse, error)

+ func (c *Client) FileContent(ctx context.Context, id string) ([]byte, error)

+ func (c *Client) Files(ctx context.Context) ([]File, error)

+ func (c *Client) Generate(ctx context.Context, req *ai.Request) (*ai.Response, error)

+ func (c *Client) GenerateImage(ctx context.Context, req *ImageRequest) (*ImageResponse, error)

+ func (c *Client) GetBatch(ctx context.Context, id string) (*Batch, error)

+ func (c *Client) GetFile(ctx context.Context, id string) (*File, error)

+ func (c *Client) GetModel(ctx context.Context, id string) (*Model, error)

+ func (c *Client) ListBatches(ctx context.Context) ([]Batch, error)

+ func (c *Client) Models(ctx context.Context) ([]Model, error)

+ func (c *Client) Moderate(ctx context.Context, input string) (*ModerationResult, error)

+ func (c *Client) Speech(ctx context.Context, req *SpeechRequest) ([]byte, error)

+ func (c *Client) Stream(ctx context.Context, req *ai.Request) iter.Seq2[ai.Chunk, error]

+ func (c *Client) Transcribe(ctx context.Context, req *TranscriptionRequest) (string, error)

+ func (c *Client) Translate(ctx context.Context, req *TranscriptionRequest) (string, error)

+ func (c *Client) UploadFile(ctx context.Context, filename string, data []byte, purpose string) (*File, error)

+ type Embedding struct

+ Embedding []float64

+ Index int

+ type EmbeddingRequest struct

+ Dimensions int

+ EncodingFormat string

+ Input []string

+ Model string

+ User string

+ type EmbeddingResponse struct

+ Data []Embedding

+ Model string

+ Object string

+ Usage struct{ ... }

+ type File struct

+ Bytes int64

+ CreatedAt int64

+ Filename string

+ ID string

+ Object string

+ Purpose string

+ type ImageData struct

+ B64JSON string

+ RevisedPrompt string

+ URL string

+ type ImageRequest struct

+ Model string

+ N int

+ Prompt string

+ Quality string

+ ResponseFormat string

+ Size string

+ Style string

+ User string

+ type ImageResponse struct

+ Created int64

+ Data []ImageData

+ type Model struct

+ Created int64

+ ID string

+ Object string

+ OwnedBy string

+ type ModerationResponse struct

+ ID string

+ Model string

+ Results []ModerationResult

+ type ModerationResult struct

+ Categories map[string]bool

+ CategoryScores map[string]float64

+ Flagged bool

+ type Option func(*settings)

+ func WithBaseURL(u string) Option

+ func WithHTTPClient(c *http.Client) Option

+ func WithHeader(key, value string) Option

+ func WithMaxRetries(n int) Option

+ func WithOrg(id string) Option

+ func WithProject(id string) Option

+ func WithTimeout(d time.Duration) Option

+ type ResponseOutput struct

+ Content []struct{ ... }

+ Type string

+ type ResponsesRequest struct

+ Input any

+ Instructions string

+ MaxOutputTokens int

+ Model string

+ Store *bool

+ Temperature *float64

+ type ResponsesResponse struct

+ ID string

+ Model string

+ Output []ResponseOutput

+ Status string

+ Usage struct{ ... }

+ func (r *ResponsesResponse) Text() string

+ type SpeechRequest struct

+ Format string

+ Input string

+ Model string

+ Speed float64

+ Voice string

+ type TranscriptionRequest struct

+ File []byte

+ Filename string

+ Format string

+ Language string

+ Model string

+ Prompt string

v0.0.1-alpha

Jun 6, 2023

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL