chat

Documentation

Overview

Package chat contains a client for Open AI's ChatGPT APIs.

Index

• type Choice
• type Client
  • func NewClient(session *openai.Session, model string) *Client
  • func (c *Client) CreateCompletion(ctx context.Context, p *CreateCompletionParams) (*CreateCompletionResponse, error)
• type CreateCompletionParams
• type CreateCompletionResponse
• type CreateCompletionStreamingResponse
• type Message
• type StreamingChoice
• type StreamingClient
  • func NewStreamingClient(session *openai.Session, model string) *StreamingClient
  • func (c *StreamingClient) CreateCompletion(ctx context.Context, p *CreateCompletionParams, ...) error

Types

type Choice

type Choice struct {
	Message      *Message `json:"message,omitempty"`
	Index        int      `json:"index,omitempty"`
	LogProbs     int      `json:"logprobs,omitempty"`
	FinishReason string   `json:"finish_reason,omitempty"`
}

type Client

type Client struct {

	// CreateCompletionsEndpoint allows overriding the default API endpoint.
	// Set this field before using the client.
	CreateCompletionEndpoint string
	// contains filtered or unexported fields
}

Client is a client to communicate with Open AI's ChatGPT APIs.

func NewClient

func NewClient(session *openai.Session, model string) *Client

NewClient creates a new default client that uses the given session and defaults to the given model.

func (*Client) CreateCompletion

func (c *Client) CreateCompletion(ctx context.Context, p *CreateCompletionParams) (*CreateCompletionResponse, error)

type CreateCompletionParams

type CreateCompletionParams struct {
	Model string `json:"model,omitempty"`

	Messages []*Message `json:"messages,omitempty"`
	Stop     []string   `json:"stop,omitempty"`
	Stream   bool       `json:"stream,omitempty"`

	N           int     `json:"n,omitempty"`
	TopP        float64 `json:"top_p,omitempty"`
	Temperature float64 `json:"temperature,omitempty"`
	MaxTokens   int     `json:"max_tokens,omitempty"`

	PresencePenalty  float64 `json:"presence_penalty,omitempty"`
	FrequencyPenalty float64 `json:"frequency_penalty,omitempty"`

	User string `json:"user,omitempty"`
}

type CreateCompletionResponse

type CreateCompletionResponse struct {
	ID        string    `json:"id,omitempty"`
	Object    string    `json:"object,omitempty"`
	CreatedAt int64     `json:"created_at,omitempty"`
	Choices   []*Choice `json:"choices,omitempty"`

	Usage *openai.Usage `json:"usage,omitempty"`
}

type CreateCompletionStreamingResponse

type CreateCompletionStreamingResponse struct {
	ID        string             `json:"id,omitempty"`
	Object    string             `json:"object,omitempty"`
	CreatedAt int64              `json:"created_at,omitempty"`
	Choices   []*StreamingChoice `json:"choices,omitempty"`
}

type Message

type Message struct {
	Role    string `json:"role,omitempty"`
	Content string `json:"content,omitempty"`
	Name    string `json:"name,omitempty"`
}

type StreamingChoice

type StreamingChoice struct {
	Delta        *Message `json:"delta,omitempty"`
	Index        int      `json:"index,omitempty"`
	LogProbs     int      `json:"logprobs,omitempty"`
	FinishReason string   `json:"finish_reason,omitempty"`
}

type StreamingClient

type StreamingClient struct {

	// CreateCompletionsEndpoint allows overriding the default API endpoint.
	// Set this field before using the client.
	CreateCompletionEndpoint string
	// contains filtered or unexported fields
}

StreamingClient is a client to communicate with Open AI's ChatGPT APIs.

func NewStreamingClient

func NewStreamingClient(session *openai.Session, model string) *StreamingClient

NewStreamingClient creates a new default streaming client that uses the given session and defaults to the given model.

func (*StreamingClient) CreateCompletion

func (c *StreamingClient) CreateCompletion(ctx context.Context, p *CreateCompletionParams, fn func(r *CreateCompletionStreamingResponse)) error