Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

openai

package

Go to main page

Versions in this module

v0

v0.0.10

Feb 11, 2025

Changes in this version

+ func WithAudioSpeed(v float64) llm.Opt

+ func WithQuality(v string) llm.Opt

+ func WithSize(v string) llm.Opt

+ func WithStyle(v string) llm.Opt

type Audio

+ Speed float64

type Completions

+ func (c Completions) Attachment(index int) *llm.Attachment

type Image

+ func (r *Image) Attachment(index int) *llm.Attachment

+ func (r *Image) Choice(index int) llm.Completion

+ func (r *Image) Num() int

+ func (r *Image) Role() string

+ func (r *Image) Text(index int) string

+ func (r *Image) ToolCalls(index int) []llm.ToolCall

+ type ImageResponse struct

+ Created uint64

+ Data []*Image

+ func (r ImageResponse) Attachment(index int) *llm.Attachment

+ func (r ImageResponse) Choice(index int) llm.Completion

+ func (r ImageResponse) Num() int

+ func (r ImageResponse) Role() string

+ func (r ImageResponse) Text(index int) string

+ func (r ImageResponse) ToolCalls(index int) []llm.ToolCall

type Message

+ func (message *Message) Attachment(index int) *llm.Attachment

v0.0.9

Feb 7, 2025

v0.0.8

Feb 7, 2025

v0.0.7

Feb 7, 2025

v0.0.6

Feb 7, 2025

Changes in this version

+ func WithAudio(voice, format string) llm.Opt

+ func WithDimensions(v uint64) llm.Opt

+ func WithDisableParallelToolCalls() llm.Opt

+ func WithLogProbs() llm.Opt

+ func WithLogitBias(token uint64, bias int64) llm.Opt

+ func WithMetadata(k, v string) llm.Opt

+ func WithModalities(v ...string) llm.Opt

+ func WithReasoningEffort(v string) llm.Opt

+ func WithServiceTier(v string) llm.Opt

+ func WithStore(v bool) llm.Opt

+ func WithStreamOptions(fn func(llm.Completion), include_usage bool) llm.Opt

+ func WithTopLogProbs(v uint64) llm.Opt

+ type Audio struct

+ Format string

+ Voice string

+ func NewAudio(voice, format string) *Audio

+ type Client struct

+ func New(ApiKey string, opts ...client.ClientOpt) (*Client, error)

+ func (*Client) Name() string

+ func (openai *Client) DeleteModel(ctx context.Context, model string) error

+ func (openai *Client) GenerateEmbedding(ctx context.Context, model string, prompt []string, opts ...llm.Opt) (*embeddings, error)

+ func (openai *Client) GetModel(ctx context.Context, model string) (*Model, error)

+ func (openai *Client) ListModels(ctx context.Context) ([]Model, error)

+ func (openai *Client) Model(ctx context.Context, name string) llm.Model

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

+ type Completion struct

+ Delta *Message

+ Index uint64

+ Message *Message

+ Reason string

+ func (c Completion) String() string

+ type Completions []Completion

+ func (c Completions) Audio(index int) *llm.Attachment

+ func (c Completions) Choice(index int) llm.Completion

+ func (c Completions) Num() int

+ func (c Completions) Role() string

+ func (c Completions) Text(index int) string

+ func (c Completions) ToolCalls(index int) []llm.ToolCall

+ type Content struct

+ Audio *llm.Attachment

+ Content string

+ Image *Image

+ Text string

+ Type string

+ func NewContentString(typ, content string) *Content

+ func NewImageData(image *llm.Attachment) *Content

+ func NewImageUrl(url *url.URL) *Content

+ func NewTextContext(content string) *Content

+ type Embedding struct

+ Index uint64

+ Type string

+ Vector []float64

+ func (m Embedding) MarshalJSON() ([]byte, error)

+ type Embeddings struct

+ Data []Embedding

+ Model string

+ Type string

+ type Format struct

+ Type string

+ func NewFormat(format string) *Format

+ type Image struct

+ Url string

+ type Message struct

+ Calls ToolCalls

+ Media *llm.Attachment

+ func (Message) Num() int

+ func (message *Message) Audio(index int) *llm.Attachment

+ func (message *Message) Choice(index int) llm.Completion

+ func (message *Message) Role() string

+ func (message *Message) Text(index int) string

+ func (message *Message) ToolCalls(index int) []llm.ToolCall

+ type Metrics struct

+ CompletionTokenDetails struct{ ... }

+ CompletionTokens uint64

+ PromptTokenDetails struct{ ... }

+ PromptTokens uint64

+ TotalTokens uint64

+ func (m Metrics) String() string

+ type Model struct

+ CreatedAt uint64

+ Name string

+ OwnedBy string

+ Type string

+ type Prediction string

+ type Response struct

+ Created uint64

+ Id string

+ Model string

+ ServiceTier string

+ SystemFingerprint string

+ Type string

+ func (r Response) String() string

+ type RoleContent struct

+ Content any

+ Role string

+ type StreamOptions struct

+ IncludeUsage bool

+ func NewStreamOptions(include_usage bool) *StreamOptions

+ type Text string

+ type ToolCall struct

+ Function struct{ ... }

+ Id string

+ Index uint64

+ Type string

+ type ToolCallArray []ToolCall

+ type ToolCalls []toolcall

+ type ToolChoice struct

+ Function struct{ ... }

+ Type string

+ func NewToolChoice(function string) *ToolChoice

+ type ToolResults struct

+ Id string