openai

Documentation

Index

• Constants
• Variables
• func ConvertPNGToDataURI(data []byte) string
• func CreateImageRequest(token string, prompt string) (*http.Request, error)
• func CreateSpeechToTextRequest(token string, audio []byte) (*http.Request, error)
• func CreateTextCompletionRequest(token string, model string, messages Messages, outputs ...string) (*http.Request, error)
• func CreateTextToSpeechRequest(token string, text string, opts ...TTSReqOptions) (*http.Request, error)
• func CreateVisionRequest(token string, model ModelConfig, messages Messages) (*http.Request, error)
• func Do(ctx context.Context, token string, model ModelConfig, prompt Prompt) (io.Reader, error)
• func DoImageRequest(ctx context.Context, token string, prompt string) ([]byte, error)
• func ErrorBadRequest(r http.Response) error
• func ErrorRateLimitExceeded(r http.Response) error
• func NewClientError(r *http.Response) error
• func ParseCreateImageResponse(resp *http.Response) (string, error)
• func ParseLinkToImage(link string) ([]byte, error)
• func ParseTextCompletionRequest(resp *http.Response) (io.Reader, error)
• func ParseVisionResponse(resp *http.Response) (io.Reader, error)
• func SpeechToText(ctx context.Context, token string, audio []byte) (string, error)
• func TextToSpeech(ctx context.Context, token string, text string) ([]byte, error)
• func URLToURI(url url.URL) (string, error)
• type BadRequestError
  • func (e BadRequestError) Error() string
• type ClientError
  • func (e ClientError) Error() string
• type ImageRequest
• type ImageResponse
• type Message
• type Messages
  • func MessageFromPrompt(prompt Prompt) Messages
• type ModelConfig
• type Prompt
• type RateLimitError
  • func (e RateLimitError) Error() string
• type TTSReqOptions
  • func WithVoice(voice Voice) TTSReqOptions
• type TextCompletionRequest
• type TextCompletionResponse
• type TextMessage
  • func (m TextMessage) GetFormat() string
• type TextToSpeechRequestBody
• type VisionCompletionResponse
• type VisionImageURL
• type VisionMessage
  • func (m VisionMessage) GetContent() string
  • func (m VisionMessage) GetFormat() string
• type VisionRequest
• type Voice

Constants

const (
	RoleUser      = "user"
	RoleAssistant = "assistant"
	RoleSystem    = "system"
)

const (
	GPT4o     = "gpt-4o"
	GPT4oMini = "gpt-4o-mini"
	GPTo1     = "o1-preview"
	GPTo1Mini = "o1-mini"
)

const (
	DALLE3 = "dall-e-3"
	GPT4V  = "gpt-4o"
)

const (
	TTS     = "tts-1"
	TTS_HQ  = "tts-1-hq"
	WHISPER = "whisper-1"
)

Variables

var Models = map[string]ModelConfig{
	"gpt-4o": {
		Name:                   "gpt-4o",
		SupportsSystemMessages: true,
		SupportsVision:         true,
	},
	"gpt-4o-mini": {
		Name:                   "gpt-4o-mini",
		SupportsSystemMessages: true,
		SupportsVision:         true,
	},
	"o1-preview": {
		Name:                   "o1-preview",
		SupportsSystemMessages: false,
		SupportsVision:         false,
	},
	"o1-mini": {
		Name:                   "o1-mini",
		SupportsSystemMessages: false,
		SupportsVision:         false,
	},
}

Functions

func ConvertPNGToDataURI

func ConvertPNGToDataURI(data []byte) string

func CreateImageRequest

func CreateImageRequest(token string, prompt string) (*http.Request, error)

func CreateSpeechToTextRequest

func CreateSpeechToTextRequest(token string, audio []byte) (*http.Request, error)

func CreateTextCompletionRequest

func CreateTextCompletionRequest(token string, model string, messages Messages, outputs ...string) (*http.Request, error)

func CreateTextToSpeechRequest

func CreateTextToSpeechRequest(token string, text string, opts ...TTSReqOptions) (*http.Request, error)

func CreateVisionRequest

func CreateVisionRequest(token string, model ModelConfig, messages Messages) (*http.Request, error)

func Do

func Do(ctx context.Context, token string, model ModelConfig, prompt Prompt) (io.Reader, error)

func DoImageRequest

func DoImageRequest(ctx context.Context, token string, prompt string) ([]byte, error)

func ErrorBadRequest

func ErrorBadRequest(r http.Response) error

func ErrorRateLimitExceeded

func ErrorRateLimitExceeded(r http.Response) error

func NewClientError

func NewClientError(r *http.Response) error

func ParseCreateImageResponse

func ParseCreateImageResponse(resp *http.Response) (string, error)

func ParseLinkToImage

func ParseLinkToImage(link string) ([]byte, error)

func ParseTextCompletionRequest

func ParseTextCompletionRequest(resp *http.Response) (io.Reader, error)

func ParseVisionResponse

func ParseVisionResponse(resp *http.Response) (io.Reader, error)

func SpeechToText

func SpeechToText(ctx context.Context, token string, audio []byte) (string, error)

func TextToSpeech

func TextToSpeech(ctx context.Context, token string, text string) ([]byte, error)

func URLToURI

func URLToURI(url url.URL) (string, error)

Types

type BadRequestError

type BadRequestError struct {
	Reason       string
	PromptTokens int
	TotalTokens  int
	TokenLimit   int
}

func (BadRequestError) Error

func (e BadRequestError) Error() string

type ClientError

type ClientError struct {
	Status     string
	StatusCode int
}

func (ClientError) Error

func (e ClientError) Error() string

type ImageRequest

type ImageRequest struct {
	Model  string `json:"model"`
	Prompt string `json:"prompt"`
	N      int    `json:"n"`
	Size   string `json:"size"`
}

Image Generation Capability

type ImageResponse

type ImageResponse struct {
	Created int `json:"created"`
	Data    []struct {
		Url string `json:"url"`
	} `json:"data"`
}

type Message

type Message interface {
	GetFormat() string
}

type Messages

type Messages []Message

func MessageFromPrompt

func MessageFromPrompt(prompt Prompt) Messages

type ModelConfig

type ModelConfig struct {
	Name                   string
	SupportsSystemMessages bool
	SupportsVision         bool
}

type Prompt

type Prompt interface {
	GetPurpose() string
	GetHistory() ([]string, []string)
	GetQuestion() string
	GetReferences() [][]byte
	GetResponseFormat() []string
}

type RateLimitError

type RateLimitError struct {
	RetryAfter time.Duration
}

func (RateLimitError) Error

func (e RateLimitError) Error() string

type TTSReqOptions

type TTSReqOptions func(TextToSpeechRequestBody) TextToSpeechRequestBody

func WithVoice

func WithVoice(voice Voice) TTSReqOptions

type TextCompletionRequest

type TextCompletionRequest struct {
	Model          string         `json:"model"`
	Messages       Messages       `json:"messages"`
	ResponseFormat map[string]any `json:"response_format"`
}

type TextCompletionResponse

type TextCompletionResponse struct {
	Choices []struct {
		Message TextMessage `json:"message"`
	} `json:"choices"`
}

type TextMessage

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

func (TextMessage) GetFormat

func (m TextMessage) GetFormat() string

type TextToSpeechRequestBody

type TextToSpeechRequestBody struct {
	Model string `json:"model"`
	Input string `json:"input"`
	Voice Voice  `json:"voice"`
}

type VisionCompletionResponse

type VisionCompletionResponse struct {
	Choices []struct {
		Message struct {
			Content string `json:"content"`
		} `json:"message"`
	} `json:"choices"`
}

type VisionImageURL

type VisionImageURL struct {
	Type     string `json:"type"`
	ImageURL struct {
		URL string `json:"url"`
	} `json:"image_url"`
}

type VisionMessage

type VisionMessage struct {
	Role    string           `json:"role"`
	Content []VisionImageURL `json:"content"`
}

func (VisionMessage) GetContent

func (m VisionMessage) GetContent() string

func (VisionMessage) GetFormat

func (m VisionMessage) GetFormat() string

type VisionRequest

type VisionRequest struct {
	Model     string   `json:"model"`
	Messages  Messages `json:"messages"`
	MaxTokens int      `json:"max_tokens"`
}

type Voice

type Voice string

const (
	Alloy   Voice = "alloy"
	Echo    Voice = "echo"
	Fable   Voice = "fable"
	Onyx    Voice = "onyx"
	Nova    Voice = "nova"
	Shimmer Voice = "shimmer"
)