openai

Documentation

Index

• func DefaultModels() []*provider.Model
• type Provider
  • func NewProvider(apiKey, baseURL string) *Provider
  • func NewProviderWithModels(apiKey, baseURL string, models []*provider.Model) *Provider
  • func NewProviderWithModelsAndOptions(apiKey, baseURL string, models []*provider.Model, ...) (*Provider, error)
  • func NewProviderWithModelsAndProxy(apiKey, baseURL, proxyURL string, models []*provider.Model) (*Provider, error)
  • func (p *Provider) API() string
  • func (p *Provider) Chat(ctx context.Context, params provider.ChatParams) <-chan provider.StreamEvent
  • func (p *Provider) DisableReasoning()
  • func (p *Provider) IsReasoningDisabled() bool
  • func (p *Provider) SetHeaders(headers map[string]string)
  • func (p *Provider) SetResponsesConfig(cfg config.ResponsesConfig)
  • func (p *Provider) SetRetryConfig(cfg *provider.RetryConfig)
  • func (p *Provider) SetThinkingFormat(format string)
  • func (p *Provider) SetUseResponsesAPI(enabled bool)

Functions

func DefaultModels

func DefaultModels() []*provider.Model

DefaultModels returns the default OpenAI model list.

Types

type Provider

type Provider struct {
	provider.BaseProvider
	// contains filtered or unexported fields
}

Provider implements the OpenAI Chat Completions API.

func NewProvider

func NewProvider(apiKey, baseURL string) *Provider

NewProvider creates a new OpenAI provider with default models.

func NewProviderWithModels

func NewProviderWithModels(apiKey, baseURL string, models []*provider.Model) *Provider

NewProviderWithModels creates a new OpenAI provider with custom models.

func NewProviderWithModelsAndOptions

func NewProviderWithModelsAndOptions(apiKey, baseURL string, models []*provider.Model, opts provider.HTTPClientOptions) (*Provider, error)

func NewProviderWithModelsAndProxy

func NewProviderWithModelsAndProxy(apiKey, baseURL, proxyURL string, models []*provider.Model) (*Provider, error)

func (*Provider) API

func (p *Provider) API() string

API returns the protocol/API type.

func (*Provider) Chat

func (p *Provider) Chat(ctx context.Context, params provider.ChatParams) <-chan provider.StreamEvent

Chat implements the streaming chat interface.

func (*Provider) DisableReasoning

func (p *Provider) DisableReasoning()

DisableReasoning disables reasoning_content support for incompatible APIs.

func (*Provider) IsReasoningDisabled

func (p *Provider) IsReasoningDisabled() bool

IsReasoningDisabled returns whether reasoning support is disabled.

func (*Provider) SetHeaders

func (p *Provider) SetHeaders(headers map[string]string)

SetHeaders sets custom HTTP headers applied to every provider request.

func (*Provider) SetResponsesConfig

func (p *Provider) SetResponsesConfig(cfg config.ResponsesConfig)

SetResponsesConfig applies Responses API-specific configuration.

func (*Provider) SetRetryConfig

func (p *Provider) SetRetryConfig(cfg *provider.RetryConfig)

SetRetryConfig sets the retry configuration for this provider.

func (*Provider) SetThinkingFormat

func (p *Provider) SetThinkingFormat(format string)

SetThinkingFormat sets the thinking parameter format. "openai" = reasoning_effort, "deepseek" = thinking + reasoning_effort, "xiaomi" = legacy thinking-only format.

func (*Provider) SetUseResponsesAPI

func (p *Provider) SetUseResponsesAPI(enabled bool)

SetUseResponsesAPI switches the provider to the Responses API.