openaiclient

Sep 22, 2024

Changes in this version

type ChatRequest

+ MaxCompletionTokens int

type ChatUsage

+ CompletionTokensDetails struct{ ... }

type Client

+ ResponseFormat *ResponseFormat

type CompletionRequest

+ MaxCompletionTokens int

type FunctionDefinition

+ Strict bool

type ResponseFormat

+ JSONSchema *ResponseFormatJSONSchema

+ type ResponseFormatJSONSchema struct

+ Name string

+ Schema *ResponseFormatJSONSchemaProperty

+ Strict bool

+ type ResponseFormatJSONSchemaProperty struct

+ AdditionalProperties bool

+ Description string

+ Enum []interface{}

+ Items *ResponseFormatJSONSchemaProperty

+ Properties map[string]*ResponseFormatJSONSchemaProperty

+ Ref string

+ Required []string

+ Type string

type Usage

+ CompletionTokensDetails struct{ ... }

Sep 12, 2024

Changes in this version

+ var ErrContentExclusive = errors.New("only one of Content / MultiContent allowed in message")

+ type ChatCompletionChoice struct

+ FinishReason FinishReason

+ Index int

+ LogProbs *LogProbs

+ Message ChatMessage

+ type ChatCompletionResponse struct

+ Choices []*ChatCompletionChoice

+ Created int64

+ ID string

+ Model string

+ Object string

+ SystemFingerprint string

+ Usage ChatUsage

type ChatMessage

+ MultiContent []llms.ContentPart

+ ToolCallID string

+ ToolCalls []ToolCall

+ func (m *ChatMessage) UnmarshalJSON(data []byte) error

+ func (m ChatMessage) MarshalJSON() ([]byte, error)

type ChatRequest

+ LogProbs bool

+ Metadata map[string]any

+ ResponseFormat *ResponseFormat

+ Seed int

+ StreamOptions *StreamOptions

+ ToolChoice any

+ Tools []Tool

+ TopLogProbs int

type Client

+ EmbeddingModel string

type CompletionRequest

+ Seed int

+ type FinishReason string

+ const FinishReasonContentFilter

+ const FinishReasonFunctionCall

+ const FinishReasonLength

+ const FinishReasonNull

+ const FinishReasonStop

+ const FinishReasonToolCalls

+ func (r FinishReason) MarshalJSON() ([]byte, error)

+ type LogProb struct

+ Bytes []byte

+ LogProb float64

+ Token string

+ TopLogProbs []TopLogProbs

+ type LogProbs struct

+ Content []LogProb

+ type ResponseFormat struct

+ Type string

+ type StreamOptions struct

+ IncludeUsage bool

type StreamedChatResponsePayload

+ Error error

+ SystemFingerprint string

+ Usage *Usage

+ type Tool struct

+ Function FunctionDefinition

+ Type ToolType

+ type ToolCall struct

+ Function ToolFunction

+ ID string

+ Type ToolType

+ func StreamingChatResponseTools(tools []ToolCall, delta []*ToolCall) ([]byte, []ToolCall)

+ type ToolChoice struct

+ Function ToolFunction

+ Type ToolType

+ type ToolFunction struct

+ Arguments string

+ Name string

+ type ToolType string

+ const ToolTypeFunction

+ type TopLogProbs struct

+ Bytes []byte

+ LogProb float64

+ Token string

+ type Usage struct

+ CompletionTokens int

+ PromptTokens int

+ TotalTokens int

Sep 12, 2024

Changes in this version

+ var ErrEmptyResponse = errors.New("empty response")

+ func IsAzure(apiType APIType) bool

+ type APIType string

+ const APITypeAzure

+ const APITypeAzureAD

+ const APITypeOpenAI

+ type ChatChoice struct

+ FinishReason string

+ Index int

+ Message ChatMessage

+ type ChatMessage struct

+ Content string

+ FunctionCall *FunctionCall

+ Name string

+ Role string

+ type ChatRequest struct

+ FrequencyPenalty float64

+ FunctionCallBehavior FunctionCallBehavior

+ Functions []FunctionDefinition

+ MaxTokens int

+ Messages []*ChatMessage

+ Model string

+ N int

+ PresencePenalty float64

+ StopWords []string

+ Stream bool

+ StreamingFunc func(ctx context.Context, chunk []byte) error

+ Temperature float64

+ TopP float64

+ type ChatResponse struct

+ Choices []*ChatChoice

+ Created float64

+ ID string

+ Model string

+ Object string

+ Usage struct{ ... }

+ type ChatUsage struct

+ CompletionTokens int

+ PromptTokens int

+ TotalTokens int

+ type Client struct

+ Model string

+ func New(token string, model string, baseURL string, organization string, ...) (*Client, error)

+ func (c *Client) CreateChat(ctx context.Context, r *ChatRequest) (*ChatResponse, error)

+ func (c *Client) CreateCompletion(ctx context.Context, r *CompletionRequest) (*Completion, error)

+ func (c *Client) CreateEmbedding(ctx context.Context, r *EmbeddingRequest) ([][]float32, error)

+ func (c *Client) CreateImage(ctx context.Context, r *ImageRequest) (*ImageResponse, error)

+ type Completion struct

+ Text string

+ type CompletionRequest struct

+ FrequencyPenalty float64

+ MaxTokens int

+ Model string

+ N int

+ PresencePenalty float64

+ Prompt string

+ Size string

+ StopWords []string

+ StreamingFunc func(ctx context.Context, chunk []byte) error

+ Temperature float64

+ TopP float64

+ type CompletionResponse struct

+ Choices []struct{ ... }

+ Created float64

+ ID string

+ Model string

+ Object string

+ Usage struct{ ... }

+ type Doer interface

+ Do func(req *http.Request) (*http.Response, error)

+ type EmbeddingRequest struct

+ Input []string

+ Model string

+ type FunctionCall struct

+ Arguments string

+ Name string

+ type FunctionCallBehavior string

+ const FunctionCallBehaviorAuto

+ const FunctionCallBehaviorNone

+ const FunctionCallBehaviorUnspecified

+ type FunctionDefinition struct

+ Description string

+ Name string

+ Parameters any

+ type ImageRequest struct

+ Model string

+ N int

+ Prompt string

+ Size string

+ type ImageResponse struct

+ Created float64

+ Data []struct{ ... }

+ type Option func(*Client) error

+ type StreamedChatResponsePayload struct

+ Choices []struct{ ... }

+ Created float64

+ ID string

+ Model string

+ Object string