openai

Documentation

Index

• Constants
• type Client
  • func New(opts ...Option) (*Client, error)
  • func (c *Client) ConsumedTokens() int
  • func (c *Client) Prompt(ctx context.Context, prompt *chatter.Prompt, opts ...func(*chatter.Options)) (string, error)
• type ModelID
• type Option
  • func WithFormatter(formatter chatter.Formatter) Option
  • func WithHTTP(opts ...http.Config) Option
  • func WithHost(host string) Option
  • func WithModel(id ModelID) Option
  • func WithNetRC(host string) Option
  • func WithQuotaTokensInReply(quota int) Option
  • func WithSecret(secret string) Option

Constants

const (
	GPT_35_TURBO_0125     = ModelID("gpt-3.5-turbo-0125")
	GPT_35_TURBO_INSTRUCT = ModelID("gpt-3.5-turbo-instruct")
	GPT_4                 = ModelID("gpt-4")
	GPT_4_32K             = ModelID("gpt-4-32k")
	GPT_4o                = ModelID("gpt-4o")
	GPT_4o_MINI           = ModelID("gpt-4o-mini")
)

const Version = "openai/v0.0.4"

Types

type Client

type Client struct {
	http.Stack
	// contains filtered or unexported fields
}

OpenAI client

func New

func New(opts ...Option) (*Client, error)

Creates OpenAI Chat (completion) client.

By default OpenAI reads access token from `~/.netrc`, supply custom secret `WithSecret(secret string)` if needed.

The client is configurable using

WithSecret(secret string)
WithNetRC(host string)
WithModel(...)
WithHTTP(opts ...http.Config)

func (*Client) ConsumedTokens

func (c *Client) ConsumedTokens() int

Number of tokens consumed within the session

func (*Client) Prompt

func (c *Client) Prompt(ctx context.Context, prompt *chatter.Prompt, opts ...func(*chatter.Options)) (string, error)

Send prompt

type ModelID

type ModelID string

type Option

type Option func(*Client)

Config option for the client

func WithFormatter

func WithFormatter(formatter chatter.Formatter) Option

Config Formatter

func WithHTTP

func WithHTTP(opts ...http.Config) Option

Config the http stack

func WithHost

func WithHost(host string) Option

Config the host, api.openai.com is default

func WithModel

func WithModel(id ModelID) Option

Config the model

func WithNetRC

func WithNetRC(host string) Option

Config the secret from .netrc

func WithQuotaTokensInReply

func WithQuotaTokensInReply(quota int) Option

Config tokens quota in reply

func WithSecret

func WithSecret(secret string) Option

Config the secret explicitly