openairt

Documentation

Index

• Constants
• func ResamplePCM(pcmData []byte, fromRate, toRate int) ([]byte, error)
• type Client
  • func New(opts ...ClientOption) *Client
  • func (c *Client) Audio() io.ReadWriter
  • func (c *Client) CreateResponse() error
  • func (c *Client) CreateResponseWithPayload(p events.ResponseCreatePayload) error
  • func (c *Client) OnError(h func(e *events.ErrorEvent))
  • func (c *Client) OnEvent(h func(e any))
  • func (c *Client) OnToolCall(h func(name string, args map[string]any) (any, error))
  • func (c *Client) Open(ctx context.Context) error
  • func (c *Client) Send(evt any) error
  • func (c *Client) SessionUpdate(session events.SessionUpdate) error
  • func (c *Client) UserInput(text string, respond bool) (err error)
• type ClientOption
  • func WithDefaultLogger() ClientOption
  • func WithEnvKey(vars ...string) ClientOption
  • func WithInstruction(instruction string) ClientOption
  • func WithKey(apiKey string) ClientOption
  • func WithLanguage(language string) ClientOption
  • func WithLogger(logger *slog.Logger) ClientOption
  • func WithModel(model string) ClientOption
  • func WithOptions(opts ...ClientOption) ClientOption
  • func WithSampleRate(sr int) ClientOption
  • func WithSpeed(speed float64) ClientOption
  • func WithTemperature(temperature float64) ClientOption
  • func WithTools(tools ...tool.Tool) ClientOption
  • func WithVoice(voice string) ClientOption
• type InterruptEvent
• type PCMStreamer
  • func NewPCMStreamer(b []byte) *PCMStreamer
  • func (s *PCMStreamer) Err() error
  • func (s *PCMStreamer) Stream(samples [][2]float64) (n int, ok bool)

Constants

const (
	ApiKeyEnvVarNameShort = "OPENAI_KEY"
	ApiKeyEnvVarNameLong  = "OPENAI_API_KEY"
)

Functions

func ResamplePCM

func ResamplePCM(pcmData []byte, fromRate, toRate int) ([]byte, error)

Types

type Client

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

func New

func New(opts ...ClientOption) *Client

func (*Client) Audio

func (c *Client) Audio() io.ReadWriter

Audio returns user audio

func (*Client) CreateResponse

func (c *Client) CreateResponse() error

func (*Client) CreateResponseWithPayload

func (c *Client) CreateResponseWithPayload(p events.ResponseCreatePayload) error

func (*Client) OnError

func (c *Client) OnError(h func(e *events.ErrorEvent))

func (*Client) OnEvent

func (c *Client) OnEvent(h func(e any))

func (*Client) OnToolCall

func (c *Client) OnToolCall(h func(name string, args map[string]any) (any, error))

func (*Client) Open

func (c *Client) Open(ctx context.Context) error

func (*Client) Send

func (c *Client) Send(evt any) error

Send sends any kind of event to the websocket

func (*Client) SessionUpdate

func (c *Client) SessionUpdate(session events.SessionUpdate) error

func (*Client) UserInput

func (c *Client) UserInput(text string, respond bool) (err error)

type ClientOption

type ClientOption func(*clientConfig)

func WithDefaultLogger

func WithDefaultLogger() ClientOption

func WithEnvKey

func WithEnvKey(vars ...string) ClientOption

func WithInstruction

func WithInstruction(instruction string) ClientOption

func WithKey

func WithKey(apiKey string) ClientOption

func WithLanguage

func WithLanguage(language string) ClientOption

func WithLogger

func WithLogger(logger *slog.Logger) ClientOption

func WithModel

func WithModel(model string) ClientOption

func WithOptions

func WithOptions(opts ...ClientOption) ClientOption

func WithSampleRate

func WithSampleRate(sr int) ClientOption

func WithSpeed

func WithSpeed(speed float64) ClientOption

func WithTemperature

func WithTemperature(temperature float64) ClientOption

func WithTools

func WithTools(tools ...tool.Tool) ClientOption

func WithVoice

func WithVoice(voice string) ClientOption

type InterruptEvent

type InterruptEvent struct {
}

type PCMStreamer

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

func NewPCMStreamer

func NewPCMStreamer(b []byte) *PCMStreamer

func (*PCMStreamer) Err

func (s *PCMStreamer) Err() error

func (*PCMStreamer) Stream

func (s *PCMStreamer) Stream(samples [][2]float64) (n int, ok bool)