openai

Documentation

Overview

Package openai implements the OpenAI model provider

Index

• type Provider
  • func NewProvider(opts ...ai.Option) *Provider
  • func (p *Provider) Generate(ctx context.Context, req *ai.Request, opts ...ai.GenerateOption) (*ai.Response, error)
  • func (p *Provider) GenerateImage(ctx context.Context, req *ai.ImageRequest, opts ...ai.GenerateOption) (*ai.ImageResponse, error)
  • func (p *Provider) Init(opts ...ai.Option) error
  • func (p *Provider) Options() ai.Options
  • func (p *Provider) Stream(ctx context.Context, req *ai.Request, opts ...ai.GenerateOption) (ai.Stream, error)
  • func (p *Provider) String() string

Types

type Provider

type Provider struct {
	// contains filtered or unexported fields
}

Provider implements the ai.Model interface for OpenAI

func NewProvider

func NewProvider(opts ...ai.Option) *Provider

NewProvider creates a new OpenAI provider

func (*Provider) Generate

func (p *Provider) Generate(ctx context.Context, req *ai.Request, opts ...ai.GenerateOption) (*ai.Response, error)

Generate generates a response from the model

func (*Provider) GenerateImage

func (p *Provider) GenerateImage(ctx context.Context, req *ai.ImageRequest, opts ...ai.GenerateOption) (*ai.ImageResponse, error)

func (*Provider) Init

func (p *Provider) Init(opts ...ai.Option) error

Init initializes the provider with options

func (*Provider) Options

func (p *Provider) Options() ai.Options

Options returns the provider options

func (*Provider) Stream

func (p *Provider) Stream(ctx context.Context, req *ai.Request, opts ...ai.GenerateOption) (ai.Stream, error)

Stream generates a streaming response (not yet implemented)

func (*Provider) String

func (p *Provider) String() string

String returns the provider name