platform/dbops/binaries/weaviate-src/usecases/modulecomponents/text2vecbase/interfaces.go

//                           _       _
// __      _____  __ ___   ___  __ _| |_ ___
// \ \ /\ / / _ \/ _` \ \ / / |/ _` | __/ _ \
//  \ V  V /  __/ (_| |\ V /| | (_| | ||  __/
//   \_/\_/ \___|\__,_| \_/ |_|\__,_|\__\___|
//
//  Copyright © 2016 - 2025 Weaviate B.V. All rights reserved.
//
//  CONTACT: hello@weaviate.io
//

package text2vecbase

import (
	"context"

	"github.com/weaviate/weaviate/entities/dto"
	"github.com/weaviate/weaviate/entities/models"
	"github.com/weaviate/weaviate/entities/moduletools"
	"github.com/weaviate/weaviate/usecases/modulecomponents"
	"github.com/weaviate/weaviate/usecases/modulecomponents/batch"
	objectsvectorizer "github.com/weaviate/weaviate/usecases/modulecomponents/vectorizer"
)

type TextVectorizer[T dto.Embedding] interface {
	Object(ctx context.Context, object *models.Object,
		cfg moduletools.ClassConfig) (T, models.AdditionalProperties, error)
	Texts(ctx context.Context, input []string,
		cfg moduletools.ClassConfig) (T, error)
}

type TextVectorizerBatch[T dto.Embedding] interface {
	Texts(ctx context.Context, input []string,
		cfg moduletools.ClassConfig) (T, error)
	Object(ctx context.Context, object *models.Object,
		cfg moduletools.ClassConfig, cs objectsvectorizer.ClassSettings) (T, models.AdditionalProperties, error)
	ObjectBatch(ctx context.Context, objects []*models.Object, skipObject []bool, cfg moduletools.ClassConfig) ([]T, map[int]error)
}

type MetaProvider interface {
	MetaInfo() (map[string]interface{}, error)
}

type BatchVectorizer[T dto.Embedding] struct {
	client           BatchClient[T]
	objectVectorizer *objectsvectorizer.ObjectVectorizer
	batchVectorizer  *batch.Batch[T]
	tokenizerFunc    batch.TokenizerFuncType
	encoderCache     *batch.EncoderCache
}

type BatchClient[T dto.Embedding] interface {
	batch.BatchClient[T]
	VectorizeQuery(ctx context.Context, input []string,
		cfg moduletools.ClassConfig) (*modulecomponents.VectorizationResult[T], error)
}