github.com/weaviate/weaviate@v1.24.6/modules/qna-openai/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  }
    26  
    27  func (n AskParams) GetCertainty() float64 {
    28  	return n.Certainty
    29  }
    30  
    31  func (n AskParams) GetDistance() float64 {
    32  	return n.Distance
    33  }
    34  
    35  func (n AskParams) SimilarityMetricProvided() bool {
    36  	return n.Certainty != 0 || n.WithDistance
    37  }
    38  
    39  func (g *GraphQLArgumentsProvider) validateAskFn(param interface{}) error {
    40  	ask, ok := param.(*AskParams)
    41  	if !ok {
    42  		return errors.New("'ask' invalid parameter")
    43  	}
    44  
    45  	if len(ask.Question) == 0 {
    46  		return errors.Errorf("'ask.question' needs to be defined")
    47  	}
    48  
    49  	if ask.Certainty != 0 && ask.WithDistance {
    50  		return errors.Errorf(
    51  			"nearText cannot provide both distance and certainty")
    52  	}
    53  
    54  	return nil
    55  }