client

Documentation

Index

• type ChatCompletionChoice
• type ChatCompletionMessage
• type ChatCompletionParams
• type ChatCompletionResult
• type Client
  • func New(o ...Option) Client
• type Error
  • func (e Error) Error() string
• type ErrorResponse
• type Option
  • func WithAPIKey(apiKey string) Option
  • func WithBaseURL(baseURL string) Option
  • func WithOrgID(orgID string) Option

Types

type ChatCompletionChoice

type ChatCompletionChoice struct {
	FinishedReason string                `json:"finish_reason"`
	Index          int                   `json:"index"`
	Message        ChatCompletionMessage `json:"message"`
}

type ChatCompletionMessage

type ChatCompletionMessage struct {
	Role    string `json:"role"`
	Content string `json:"content"`
}

type ChatCompletionParams

type ChatCompletionParams struct {
	Model    string                  `json:"model"`
	Messages []ChatCompletionMessage `json:"messages"`
}

type ChatCompletionResult

type ChatCompletionResult struct {
	Choices []ChatCompletionChoice `json:"choices"`
}

type Client

type Client interface {
	GenerateChatCompletion(ctx context.Context, params *ChatCompletionParams) (*ChatCompletionResult, error)
}

Client implements the OpenAI API client with minimal functionality

func New

func New(o ...Option) Client

New creates a new OpenAI API client

type Error

type Error struct {
	Type    string `json:"type"`
	Message string `json:"message"`
}

func (Error) Error

func (e Error) Error() string

type ErrorResponse

type ErrorResponse struct {
	Error Error `json:"error"`
}

type Option

type Option func(*client)

func WithAPIKey

func WithAPIKey(apiKey string) Option

func WithBaseURL

func WithBaseURL(baseURL string) Option

func WithOrgID

func WithOrgID(orgID string) Option