File size: 1,836 Bytes
95d599c | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 | // _ _
// __ _____ __ ___ ___ __ _| |_ ___
// \ \ /\ / / _ \/ _` \ \ / / |/ _` | __/ _ \
// \ V V / __/ (_| |\ V /| | (_| | || __/
// \_/\_/ \___|\__,_| \_/ |_|\__,_|\__\___|
//
// Copyright © 2016 - 2025 Weaviate B.V. All rights reserved.
//
// CONTACT: hello@weaviate.io
//
package modulecapabilities
import (
"github.com/tailor-inc/graphql"
"github.com/weaviate/weaviate/entities/dto"
)
// GetArgumentsFn generates get graphql config for a given classname
type GetArgumentsFn = func(classname string) *graphql.ArgumentConfig
// AggregateArgumentsFn generates aggregate graphql config for a given classname
type AggregateArgumentsFn = func(classname string) *graphql.ArgumentConfig
// ExploreArgumentsFn generates explore graphql config
type ExploreArgumentsFn = func() *graphql.ArgumentConfig
// ExtractFn extracts graphql params to given struct implementation
type ExtractFn = func(param map[string]interface{}) (interface{}, *dto.TargetCombination, error)
// NearParam defines params with certainty information
type NearParam interface {
GetCertainty() float64
GetDistance() float64
GetTargetVectors() []string
SimilarityMetricProvided() bool
}
// ValidateFn validates a given module param
type ValidateFn = func(param interface{}) error
// GraphQLArgument defines all the needed settings / methods
// to add a module specific graphql argument
type GraphQLArgument struct {
GetArgumentsFunction GetArgumentsFn
AggregateArgumentsFunction AggregateArgumentsFn
ExploreArgumentsFunction ExploreArgumentsFn
ExtractFunction ExtractFn
ValidateFunction ValidateFn
}
// GraphQLArguments defines the capabilities of modules to add their
// arguments to graphql API
type GraphQLArguments interface {
Arguments() map[string]GraphQLArgument
}
|