github.com/weaviate/weaviate@v1.24.6/modules/qna-transformers/ask/param.go (about)

     1  //                           _       _
     2  // __      _____  __ ___   ___  __ _| |_ ___
     3  // \ \ /\ / / _ \/ _` \ \ / / |/ _` | __/ _ \
     4  //  \ V  V /  __/ (_| |\ V /| | (_| | ||  __/
     5  //   \_/\_/ \___|\__,_| \_/ |_|\__,_|\__\___|
     6  //
     7  //  Copyright © 2016 - 2024 Weaviate B.V. All rights reserved.
     8  //
     9  //  CONTACT: hello@weaviate.io
    10  //
    11  
    12  package ask
    13  
    14  import (
    15  	"github.com/pkg/errors"
    16  )
    17  
    18  type AskParams struct {
    19  	Question     string
    20  	Certainty    float64
    21  	Distance     float64
    22  	WithDistance bool
    23  	Properties   []string
    24  	Autocorrect  bool
    25  	Rerank       bool
    26  }
    27  
    28  func (n AskParams) GetCertainty() float64 {
    29  	return n.Certainty
    30  }
    31  
    32  func (n AskParams) GetDistance() float64 {
    33  	return n.Distance
    34  }
    35  
    36  func (n AskParams) SimilarityMetricProvided() bool {
    37  	return n.Certainty != 0 || n.WithDistance
    38  }
    39  
    40  func (g *GraphQLArgumentsProvider) validateAskFn(param interface{}) error {
    41  	ask, ok := param.(*AskParams)
    42  	if !ok {
    43  		return errors.New("'ask' invalid parameter")
    44  	}
    45  
    46  	if len(ask.Question) == 0 {
    47  		return errors.Errorf("'ask.question' needs to be defined")
    48  	}
    49  
    50  	if ask.Certainty != 0 && ask.WithDistance {
    51  		return errors.Errorf(
    52  			"nearText cannot provide both distance and certainty")
    53  	}
    54  
    55  	return nil
    56  }