jinaai

Documentation

Index

• type Client
  • func New[T types.Embedding](jinaAIApiKey string, timeout time.Duration, defaultRPM, defaultTPM int, ...) *Client[T]
  • func (c *Client[T]) GetApiKeyHash(ctx context.Context, config moduletools.ClassConfig) [32]byte
  • func (c *Client[T]) GetVectorizerRateLimit(ctx context.Context, cfg moduletools.ClassConfig) *modulecomponents.RateLimits
  • func (c *Client[T]) Vectorize(ctx context.Context, input []string, settings Settings) (*modulecomponents.VectorizationResult[T], *modulecomponents.RateLimits, int, ...)
  • func (c *Client[T]) VectorizeMultiModal(ctx context.Context, texts, images []string, settings Settings) (*modulecomponents.VectorizationCLIPResult[T], error)
• type MultiModalInput
• type Settings
• type Task

Types

type Client

type Client[T types.Embedding] struct {
	// contains filtered or unexported fields
}

func New

func New[T types.Embedding](jinaAIApiKey string, timeout time.Duration, defaultRPM, defaultTPM int, logger logrus.FieldLogger) *Client[T]

func (*Client[T]) GetApiKeyHash

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

func (*Client[T]) GetVectorizerRateLimit

func (c *Client[T]) GetVectorizerRateLimit(ctx context.Context, cfg moduletools.ClassConfig) *modulecomponents.RateLimits

func (*Client[T]) Vectorize

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

func (*Client[T]) VectorizeMultiModal

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

type MultiModalInput

type MultiModalInput struct {
	Text  string `json:"text,omitempty"`
	Image string `json:"image,omitempty"`
}

type Settings

type Settings struct {
	Task       Task
	Model      string
	BaseURL    string
	Dimensions *int64
	Normalized bool
}

type Task

type Task string

const (
	// taskType
	RetrievalQuery   Task = "retrieval.query"
	RetrievalPassage Task = "retrieval.passage"
)