openai

Documentation

Index

• Constants
• Variables
• type Client
  • func New(opt ...Option) (*Client, error)
  • func (c *Client) Prompt(ctx context.Context, prompt []fmt.Stringer, opts ...chatter.Opt) (reply chatter.Reply, err error)
  • func (c *Client) UsedInputTokens() int
  • func (c *Client) UsedReplyTokens() int
• type LLM
• type Option

Constants

const (
	GPT_35_TURBO_0125     = LLM("gpt-3.5-turbo-0125")
	GPT_35_TURBO_INSTRUCT = LLM("gpt-3.5-turbo-instruct")
	GPT_4                 = LLM("gpt-4")
	GPT_4_32K             = LLM("gpt-4-32k")
	GPT_4O                = LLM("gpt-4o")
	GPT_4O_MINI           = LLM("gpt-4o-mini")
	GPT_O1                = LLM("o1")
	GPT_O3_MINI           = LLM("o3-mini")
)

const Version = "openai/v0.2.1"

Variables

var (
	// Set OpenAI LLM
	//
	// This option is required.
	WithLLM = opts.ForType[Client, LLM]()

	// Config HTTP stack
	WithHTTP = opts.Use[Client](http.NewStack)

	// Config the host, api.openai.com is default
	WithHost = opts.ForType[Client, ø.Authority]()

	// Config API secret key
	WithSecret = opts.ForName[Client, string]("secret")

	// Set api secret from ~/.netrc file
	WithNetRC = opts.FMap(withNetRC)

	// Config the system role, the default one is `system`.
	// The role has been switch to `developer` on newer OpenAI LLMs
	WithRoleSystem = opts.ForName[Client, string]("roleSystem")
)

Types

type Client

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

OpenAI client

func New

func New(opt ...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) Prompt

func (c *Client) Prompt(ctx context.Context, prompt []fmt.Stringer, opts ...chatter.Opt) (reply chatter.Reply, err error)

Send prompt

func (*Client) UsedInputTokens

func (c *Client) UsedInputTokens() int

func (*Client) UsedReplyTokens

func (c *Client) UsedReplyTokens() int

type LLM

type LLM string

type Option

type Option = opts.Option[Client]