completion.go

package openai

import "context"

// Well-known completion models
const (
	CompletionModelDavinci3     = "text-davinci-003"
	CompletionModelDavinci2     = "text-davinci-002"
	CompletionModelCurie1       = "text-curie-001"
	CompletionModelBabbage1     = "text-babbage-001"
	CompletionModelAda1         = "text-ada-001"
	CompletionModelCodeDavinci2 = "code-davinci-002"
)

// Complete calls the non-chat Completion endpoints for non-chatgpt completion
// models.
func (c Client) Complete(ctx context.Context, req CompleteReq) (*CompleteRes, error) {
	var res CompleteRes
	err := c.c.R().Post("completions").JSON(req).Do(ctx).JSON(&res)
	if err != nil {
		return nil, err
	}
	return &res, nil
}

// CompleteReq holds all the inputs for a completion request.
type CompleteReq struct {
	Model             string          `json:"model"`
	Prompt            string          `json:"prompt"`
	Suffix            *string         `json:"suffix,omitempty"`
	MaxTokens         *int            `json:"max_tokens,omitempty"`
	Temperature       *float64        `json:"temperature,omitempty"`
	TopP              *int            `json:"top_p,omitempty"`
	N                 *int            `json:"n,omitempty"`
	Logprobs          *int            `json:"logprobs,omitempty"`
	Echo              *bool           `json:"echo,omitempty"`
	Stop              *string         `json:"stop,omitempty"`
	PresencePentalty  *float64        `json:"presence_pentalty,omitempty"`
	FrequencyPentalty *float64        `json:"frequency_pentalty,omitempty"`
	BestOf            *int            `json:"best_of,omitempty"`
	LogitBias         *map[string]any `json:"logit_bias,omitempty"`
	User              *string         `json:"user,omitempty"`
}

// CompleteRes represents the final completion(s) from OpenAI.
type CompleteRes struct {
	Choices []CompleteChoice `json:"choices"`
	Created int              `json:"created"`
	ID      string           `json:"id"`
	Model   string           `json:"model"`
	Object  string           `json:"object"`
	Usage   Usage            `json:"usage"`
}

// CompleteChoice is the representation of the individual choices returned by
// OpenAI.
type CompleteChoice struct {
	Text         string `json:"text"`
	Index        int    `json:"index"`
	LogProbs     any    `json:"log_probs"`
	FinishReason string `json:"finish_reason"`
}