embedding

Documentation

Overview

Package embedding provides functions to use OpenAI's Embeddings API.

Index

• type Service
• type Vector
  • func (v Vector) AngleDiff(v2 Vector) float64
  • func (v Vector) Distance(v2 Vector) float64

Types

type Service

type Service interface {
	One(input string) (Vector, error)
	Array(inputs ...string) ([]Vector, error)

	// Dimensions returns the number of dimensions used for embeddings.
	Dimensions() int

	// SetDimensions sets the number of dimensions used for embeddings.
	SetDimensions(int)
}

Service is the service for the Embeddings API.

type Vector

type Vector []float64

Vector is a calculated embedding.

func (Vector) AngleDiff

func (v Vector) AngleDiff(v2 Vector) float64

AngleDiff calculates the cosine similarity between two vectors. 1 means that vectors are parallel, 0 - orthogonal, -1 - antiparallel.

func (Vector) Distance

func (v Vector) Distance(v2 Vector) float64

Distance calculates the Euclidean distance between two vectors.