embedding

Documentation

Overview

Package embedding contains a client for Open AI's Embeddings APIs.

Index

• type Client
  • func NewClient(session *openai.Session, model string) *Client
  • func (c *Client) Create(ctx context.Context, p *CreateParams) (*CreateResponse, error)
• type CreateParams
• type CreateResponse
• type Data

Types

type Client

type Client struct {

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

Client is a client to communicate with Open AI's Embeddings 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) Create

func (c *Client) Create(ctx context.Context, p *CreateParams) (*CreateResponse, error)

type CreateParams

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

	Input []string `json:"input,omitempty"`
	User  string   `json:"user,omitempty"`
}

type CreateResponse

type CreateResponse struct {
	Object string  `json:"object,omitempty"`
	Data   []*Data `json:"data,omitempty"`
	Model  string  `json:"model,omitempty"`

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

type Data

type Data struct {
	Object    string    `json:"object,omitempty"`
	Embedding []float64 `json:"embedding,omitempty"`
	Index     int       `json:"index,omitempty"`
}