openai

package
v0.24.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 14, 2026 License: AGPL-3.0 Imports: 14 Imported by: 0

Documentation

Overview

Package openai implements pkg/embeddings's Embedder client for OpenAI's embeddings API.

Index

Constants

View Source 
const (
	// DefaultEmbeddingModel is OpenAI's default Tapes embedding model.
	DefaultEmbeddingModel = "text-embedding-3-large"

	// DefaultBaseURL is the OpenAI API base URL.
	DefaultBaseURL = "https://api.openai.com/v1"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type Embedder 

type Embedder struct {
	// contains filtered or unexported fields
}

Embedder wraps OpenAI's embeddings API.

func NewEmbedder 

func NewEmbedder(cfg EmbedderConfig) (*Embedder, error)

NewEmbedder creates a new embedder using OpenAI's embeddings API.

func (*Embedder) Close 

func (e *Embedder) Close() error

Close releases resources held by the embedder.

func (*Embedder) Embed 

func (e *Embedder) Embed(ctx context.Context, text string) ([]float32, error)

Embed converts text into a vector embedding.

type EmbedderConfig 

type EmbedderConfig struct {
	// BaseURL is the OpenAI-compatible API URL. It may include or omit /v1.
	// Defaults to DefaultBaseURL if empty.
	BaseURL string

	// Model is the embedding model to use.
	// Defaults to DefaultEmbeddingModel if empty.
	Model string

	// APIKey is the OpenAI API key. Defaults to OPENAI_API_KEY if empty.
	APIKey string

	// Dimensions optionally requests shortened embeddings for text-embedding-3
	// models. Leave 0 to use the model default.
	Dimensions uint
}

EmbedderConfig holds configuration for the OpenAI embedder.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.