voyageai

package
v1.0.13 Latest Latest
Warning

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

Go to latest
Published: Mar 6, 2026 License: MIT Imports: 10 Imported by: 2

Documentation

Index

Constants

View Source
const Provider = "VoyageAI"
View Source
const TypeDocument embed.Type = "Represent the document for retrieval"
View Source
const TypeQuery embed.Type = "Represent the query for retrieving supporting documents"

Variables

View Source
var EmbedModel_voyage_2 = embed.Model{
	Provider:         Provider,
	Name:             "voyage-2",
	InputMaxTokens:   4000,
	OutputDimensions: 1024,
	Description:      "General-purpose embedding model optimized for a balance between cost, latency, and retrieval quality. Please transition to voyage-3-lite.",
}
View Source
var EmbedModel_voyage_3 = embed.Model{
	Provider:         Provider,
	Name:             "voyage-3",
	InputMaxTokens:   32000,
	OutputDimensions: 1024,
	Description:      "Optimized for general-purpose and multilingual retrieval quality.",
}
View Source
var EmbedModel_voyage_3_5 = embed.Model{
	Provider:         Provider,
	Name:             "voyage-3.5",
	InputMaxTokens:   32000,
	OutputDimensions: 1024,
	Description:      "Optimized for general-purpose and multilingual retrieval quality.",
}
View Source
var EmbedModel_voyage_3_5_lite = embed.Model{
	Provider:         Provider,
	Name:             "voyage-3.5-lite",
	InputMaxTokens:   32000,
	OutputDimensions: 1024,
	Description:      "Optimized for latency and cost.",
}
View Source
var EmbedModel_voyage_3_large = embed.Model{
	Provider:         Provider,
	Name:             "voyage-3-large",
	InputMaxTokens:   32000,
	OutputDimensions: 1024,
	Description:      "The best general-purpose and multilingual retrieval quality",
}
View Source
var EmbedModel_voyage_3_lite = embed.Model{
	Provider:         Provider,
	Name:             "voyage-3-lite",
	InputMaxTokens:   32000,
	OutputDimensions: 512,
	Description:      "Optimized for latency and cost",
}
View Source
var EmbedModel_voyage_code_2 = embed.Model{
	Provider:         Provider,
	Name:             "voyage-code-2",
	InputMaxTokens:   16000,
	OutputDimensions: 1536,
	Description:      "Optimized for code retrieval (17% better than alternatives)",
}
View Source
var EmbedModel_voyage_context_3 = embed.Model{
	Provider:         Provider,
	Name:             "voyage-context-3",
	InputMaxTokens:   32000,
	OutputDimensions: 1024,
	Description:      "Used for contextualized embeddings and used with EmbedDocument",
}
View Source
var EmbedModel_voyage_finance_2 = embed.Model{
	Provider:         Provider,
	Name:             "voyage-finance-2",
	InputMaxTokens:   32000,
	OutputDimensions: 1024,
	Description:      "Optimized for finance retrieval and RAG.",
}
View Source
var EmbedModel_voyage_large_2 = embed.Model{
	Provider:         Provider,
	Name:             "voyage-large-2",
	InputMaxTokens:   16000,
	OutputDimensions: 1536,
	Description:      "General-purpose embedding model that is optimized for retrieval quality (e.g., better than OpenAI V3 Large). Please transition to voyage-3.",
}
View Source
var EmbedModel_voyage_large_2_instruct = embed.Model{
	Provider:         Provider,
	Name:             "voyage-large-2-instruct",
	InputMaxTokens:   16000,
	OutputDimensions: 1024,
	Description:      "Top of MTEB leaderboard . Instruction-tuned general-purpose embedding model optimized for clustering, classification, and retrieval. For retrieval, please use input_type parameter to specify whether the text is a query or document. For classification and clustering, please use the instructions here . See blog post for details. We recommend existing voyage-large-2-instruct users to transition to voyage-3",
}
View Source
var EmbedModel_voyage_law_2 = embed.Model{
	Provider:         Provider,
	Name:             "voyage-law-2",
	InputMaxTokens:   16000,
	OutputDimensions: 1024,
	Description:      "Optimized for legal and long-context retrieval and RAG. Also improved performance across all domains.",
}
View Source
var EmbedModel_voyage_multilingual_2 = embed.Model{
	Provider:         Provider,
	Name:             "voyage-multilingual-2",
	InputMaxTokens:   32000,
	OutputDimensions: 1024,
	Description:      "Optimized for multilingual retrieval and RAG.",
}

Functions

This section is empty.

Types

type VoyageAI

type VoyageAI struct {
	Log *slog.Logger `json:"-"`
	// contains filtered or unexported fields
}

func New

func New(apiKey string) *VoyageAI

func (*VoyageAI) Embed

func (v *VoyageAI) Embed(request *embed.Request) (*embed.Response, error)

func (*VoyageAI) EmbedDocument added in v1.0.0

func (v *VoyageAI) EmbedDocument(request *embed.DocumentRequest) (*embed.DocumentResponse, error)

func (*VoyageAI) Provider added in v0.7.0

func (v *VoyageAI) Provider() string

func (*VoyageAI) SetLogger

func (v *VoyageAI) SetLogger(logger *slog.Logger) *VoyageAI

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL