135 lines
5.0 KiB
Go
135 lines
5.0 KiB
Go
package openai
|
|
|
|
import (
|
|
"context"
|
|
"errors"
|
|
"net/http"
|
|
)
|
|
|
|
// Chat message role defined by the OpenAI API.
|
|
const (
|
|
ChatMessageRoleSystem = "system"
|
|
ChatMessageRoleUser = "user"
|
|
ChatMessageRoleAssistant = "assistant"
|
|
ChatMessageRoleFunction = "function"
|
|
)
|
|
|
|
const chatCompletionsSuffix = "/chat/completions"
|
|
|
|
var (
|
|
ErrChatCompletionInvalidModel = errors.New("this model is not supported with this method, please use CreateCompletion client method instead") //nolint:lll
|
|
ErrChatCompletionStreamNotSupported = errors.New("streaming is not supported with this method, please use CreateChatCompletionStream") //nolint:lll
|
|
)
|
|
|
|
type ChatCompletionMessage struct {
|
|
Role string `json:"role"`
|
|
Content string `json:"content"`
|
|
|
|
// This property isn't in the official documentation, but it's in
|
|
// the documentation for the official library for python:
|
|
// - https://github.com/openai/openai-python/blob/main/chatml.md
|
|
// - https://github.com/openai/openai-cookbook/blob/main/examples/How_to_count_tokens_with_tiktoken.ipynb
|
|
Name string `json:"name,omitempty"`
|
|
|
|
FunctionCall *FunctionCall `json:"function_call,omitempty"`
|
|
}
|
|
|
|
type FunctionCall struct {
|
|
Name string `json:"name,omitempty"`
|
|
// call function with arguments in JSON format
|
|
Arguments string `json:"arguments,omitempty"`
|
|
}
|
|
|
|
// ChatCompletionRequest represents a request structure for chat completion API.
|
|
type ChatCompletionRequest struct {
|
|
Model string `json:"model"`
|
|
Messages []ChatCompletionMessage `json:"messages"`
|
|
MaxTokens int `json:"max_tokens,omitempty"`
|
|
Temperature float32 `json:"temperature,omitempty"`
|
|
TopP float32 `json:"top_p,omitempty"`
|
|
N int `json:"n,omitempty"`
|
|
Stream bool `json:"stream,omitempty"`
|
|
Stop []string `json:"stop,omitempty"`
|
|
PresencePenalty float32 `json:"presence_penalty,omitempty"`
|
|
FrequencyPenalty float32 `json:"frequency_penalty,omitempty"`
|
|
// LogitBias is must be a token id string (specified by their token ID in the tokenizer), not a word string.
|
|
// incorrect: `"logit_bias":{"You": 6}`, correct: `"logit_bias":{"1639": 6}`
|
|
// refs: https://platform.openai.com/docs/api-reference/chat/create#chat/create-logit_bias
|
|
LogitBias map[string]int `json:"logit_bias,omitempty"`
|
|
User string `json:"user,omitempty"`
|
|
Functions []FunctionDefinition `json:"functions,omitempty"`
|
|
FunctionCall any `json:"function_call,omitempty"`
|
|
}
|
|
|
|
type FunctionDefinition struct {
|
|
Name string `json:"name"`
|
|
Description string `json:"description,omitempty"`
|
|
// Parameters is an object describing the function.
|
|
// You can pass a []byte describing the schema,
|
|
// or you can pass in a struct which serializes to the proper JSON schema.
|
|
// The jsonschema package is provided for convenience, but you should
|
|
// consider another specialized library if you require more complex schemas.
|
|
Parameters any `json:"parameters"`
|
|
}
|
|
|
|
// Deprecated: use FunctionDefinition instead.
|
|
type FunctionDefine = FunctionDefinition
|
|
|
|
type FinishReason string
|
|
|
|
const (
|
|
FinishReasonStop FinishReason = "stop"
|
|
FinishReasonLength FinishReason = "length"
|
|
FinishReasonFunctionCall FinishReason = "function_call"
|
|
FinishReasonContentFilter FinishReason = "content_filter"
|
|
FinishReasonNull FinishReason = "null"
|
|
)
|
|
|
|
type ChatCompletionChoice struct {
|
|
Index int `json:"index"`
|
|
Message ChatCompletionMessage `json:"message"`
|
|
// FinishReason
|
|
// stop: API returned complete message,
|
|
// or a message terminated by one of the stop sequences provided via the stop parameter
|
|
// length: Incomplete model output due to max_tokens parameter or token limit
|
|
// function_call: The model decided to call a function
|
|
// content_filter: Omitted content due to a flag from our content filters
|
|
// null: API response still in progress or incomplete
|
|
FinishReason FinishReason `json:"finish_reason"`
|
|
}
|
|
|
|
// ChatCompletionResponse represents a response structure for chat completion API.
|
|
type ChatCompletionResponse struct {
|
|
ID string `json:"id"`
|
|
Object string `json:"object"`
|
|
Created int64 `json:"created"`
|
|
Model string `json:"model"`
|
|
Choices []ChatCompletionChoice `json:"choices"`
|
|
Usage Usage `json:"usage"`
|
|
}
|
|
|
|
// CreateChatCompletion — API call to Create a completion for the chat message.
|
|
func (c *Client) CreateChatCompletion(
|
|
ctx context.Context,
|
|
request ChatCompletionRequest,
|
|
) (response ChatCompletionResponse, err error) {
|
|
if request.Stream {
|
|
err = ErrChatCompletionStreamNotSupported
|
|
return
|
|
}
|
|
|
|
urlSuffix := chatCompletionsSuffix
|
|
if !checkEndpointSupportsModel(urlSuffix, request.Model) {
|
|
err = ErrChatCompletionInvalidModel
|
|
return
|
|
}
|
|
|
|
req, err := c.newRequest(ctx, http.MethodPost, c.fullURL(urlSuffix, request.Model), withBody(request))
|
|
if err != nil {
|
|
return
|
|
}
|
|
|
|
err = c.sendRequest(req, &response)
|
|
return
|
|
}
|