entities/modulecapabilities/searcher.go

//                           _       _
// __      _____  __ ___   ___  __ _| |_ ___
// \ \ /\ / / _ \/ _` \ \ / / |/ _` | __/ _ \
//  \ V  V /  __/ (_| |\ V /| | (_| | ||  __/
//   \_/\_/ \___|\__,_| \_/ |_|\__,_|\__\___|
//
//  Copyright © 2016 - 2024 Weaviate B.V. All rights reserved.
//
//  CONTACT: [email protected]
//

package modulecapabilities

import (
	"context"

	"github.com/go-openapi/strfmt"
	"github.com/weaviate/weaviate/entities/moduletools"
)

// FindVectorFn method for getting a vector of given object by its ID
type FindVectorFn = func(ctx context.Context, className string, id strfmt.UUID, tenant string) ([]float32, error)

// VectorForParams defines method for passing a raw searcher content to the module
// and exchanging it for a vector. Warning: Argument "cfg"
// (moduletools.ClassConfig) is not guaranteed to be non-nil. Implementations
// have to provide a nil check before using it. It is generally present on
// class-based action, but is not present on Cross-Class requests, such as
// Explore {}
type VectorForParams = func(ctx context.Context, params interface{},
	className string, findVectorFn FindVectorFn, cfg moduletools.ClassConfig) ([]float32, error)

// ArgumentVectorForParams contains argument definitions and it's respective
// vector for params search method
type ArgumentVectorForParams = map[string]VectorForParams

// Searcher defines all methods for all searchers
// for getting a vector from a given raw searcher content
type Searcher interface {
	VectorSearches() ArgumentVectorForParams
}

// ModuleArgumentVectorForParams contains module's argument definitions and it's
// vector for params search method
type ModuleArgumentVectorForParams = map[string]ArgumentVectorForParams

// DependencySearcher defines all of the available searches loaded as a dependency
type DependencySearcher interface {
	VectorSearches() ModuleArgumentVectorForParams
}