Spaces:
Running
Running
File size: 1,914 Bytes
b110593 |
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 58 59 60 61 62 63 64 65 66 67 68 69 |
// _ _
// __ _____ __ ___ ___ __ _| |_ ___
// \ \ /\ / / _ \/ _` \ \ / / |/ _` | __/ _ \
// \ V V / __/ (_| |\ V /| | (_| | || __/
// \_/\_/ \___|\__,_| \_/ |_|\__,_|\__\___|
//
// Copyright © 2016 - 2024 Weaviate B.V. All rights reserved.
//
// CONTACT: [email protected]
//
package traverser
import (
"fmt"
)
// TODO: is this still used?
// SearchType to search for either class names or property names
type SearchType string
const (
// SearchTypeClass to search the contextionary for class names
SearchTypeClass SearchType = "class"
// SearchTypeProperty to search the contextionary for property names
SearchTypeProperty SearchType = "property"
)
// SearchParams to be used for a SchemaSearch. See individual properties for
// additional documentation on what they do
type SearchParams struct {
// SearchType can be SearchTypeClass or SearchTypeProperty
SearchType SearchType
// Name is the string-representation of the class or property name
Name string
// Certainty must be a value between 0 and 1. The higher it is the narrower
// is the search, the lower it is, the wider the search is
Certainty float32
}
// Validate the feasibility of the specified arguments
func (p SearchParams) Validate() error {
if p.Name == "" {
return fmt.Errorf("Name cannot be empty")
}
if err := p.validateCertaintyOrWeight(p.Certainty); err != nil {
return fmt.Errorf("invalid Certainty: %s", err)
}
if p.SearchType != SearchTypeClass && p.SearchType != SearchTypeProperty {
return fmt.Errorf(
"SearchType must be SearchTypeClass or SearchTypeProperty, but got '%s'", p.SearchType)
}
return nil
}
func (p SearchParams) validateCertaintyOrWeight(c float32) error {
if c >= 0 && c <= 1 {
return nil
}
return fmt.Errorf("must be between 0 and 1, but got '%f'", c)
}
|