ai

Documentation

Index

• type Choice
• type Content
• type InputData
• type InputMessage
• type Metadata
• type OutputData
• type OutputMessage
• type Parameter
• type TextChatInput
• type TextChatOutput
• type Usage

Types

type Choice

type Choice struct {
	FinishReason string        `json:"finish-reason"`
	Index        int           `json:"index"`
	Message      OutputMessage `json:"message"`
	// The Unix timestamp (in seconds) of when the chat completion was created.
	Created int `json:"created"`
}

type Content

type Content struct {
	Type        string `json:"type"`
	Text        string `json:"text,omitempty"`
	ImageURL    string `json:"image-url,omitempty"`
	ImageBase64 string `json:"image-base64,omitempty"`
}

type InputData

type InputData struct {
	Model    string         `json:"model"`
	Messages []InputMessage `json:"messages"`
}

type InputMessage

type InputMessage struct {
	Contents []Content `json:"content"`
	Role     string    `json:"role"`
	Name     string    `json:"name,omitempty"`
}

type Metadata

type Metadata struct {
	Usage Usage `json:"usage"`
}

type OutputData

type OutputData struct {
	Choices []Choice `json:"choices"`
}

type OutputMessage

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

type Parameter

type Parameter struct {
	MaxTokens   *int     `json:"max-tokens,omitempty"`
	Seed        *int     `json:"seed,omitempty"`
	N           *int     `json:"n,omitempty"`
	Temperature *float32 `json:"temperature,omitempty"`
	TopP        *float32 `json:"top-p,omitempty"`
	Stream      bool     `json:"stream,omitempty"`
}

type TextChatInput

type TextChatInput struct {
	Data      InputData `json:"data"`
	Parameter Parameter `json:"parameter,omitempty"`
}

type TextChatOutput

type TextChatOutput struct {
	Data     OutputData `json:"data"`
	Metadata Metadata   `json:"metadata"`
}

type Usage

type Usage struct {
	CompletionTokens int `json:"completion-tokens"`
	PromptTokens     int `json:"prompt-tokens"`
	TotalTokens      int `json:"total-tokens"`
}