voyageai

Documentation

Index

• type Client
  • func New(apiKey string, timeout time.Duration, urlBuilder UrlBuilder, ...) *Client
  • func (c *Client) GetApiKeyHash(ctx context.Context, cfg moduletools.ClassConfig) [32]byte
  • func (c *Client) GetVectorizerRateLimit(ctx context.Context, modelRL VoyageRLModel) *modulecomponents.RateLimits
  • func (c *Client) Vectorize(ctx context.Context, input []string, settings Settings) (*modulecomponents.VectorizationResult[[]float32], *modulecomponents.RateLimits, ...)
  • func (c *Client) VectorizeMultiModal(ctx context.Context, texts, images []string, settings Settings) (*modulecomponents.VectorizationCLIPResult[[]float32], error)
  • func (c *Client) VectorizeQuery(ctx context.Context, input []string, settings Settings) (*modulecomponents.VectorizationResult[[]float32], error)
• type InputType
• type Settings
• type UrlBuilder
• type VoyageRLModel

Types

type Client

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

func New

func New(apiKey string, timeout time.Duration, urlBuilder UrlBuilder, logger logrus.FieldLogger) *Client

func (*Client) GetApiKeyHash

func (c *Client) GetApiKeyHash(ctx context.Context, cfg moduletools.ClassConfig) [32]byte

func (*Client) GetVectorizerRateLimit

func (c *Client) GetVectorizerRateLimit(ctx context.Context, modelRL VoyageRLModel) *modulecomponents.RateLimits

func (*Client) Vectorize

func (c *Client) Vectorize(ctx context.Context, input []string, settings Settings,
) (*modulecomponents.VectorizationResult[[]float32], *modulecomponents.RateLimits, int, error)

func (*Client) VectorizeMultiModal

func (c *Client) VectorizeMultiModal(ctx context.Context, texts, images []string,
	settings Settings,
) (*modulecomponents.VectorizationCLIPResult[[]float32], error)

func (*Client) VectorizeQuery

func (c *Client) VectorizeQuery(ctx context.Context, input []string, settings Settings,
) (*modulecomponents.VectorizationResult[[]float32], error)

type InputType

type InputType string

const (
	Document InputType = "document"
	Query    InputType = "query"
)

type Settings

type Settings struct {
	BaseURL   string
	Model     string
	Truncate  bool
	InputType InputType
}

type UrlBuilder

type UrlBuilder interface {
	URL(baseURL string) string
}

type VoyageRLModel

type VoyageRLModel struct {
	TokenLimit   int
	RequestLimit int
}