github.com/weaviate/weaviate@v1.24.6/entities/additional/classification.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 additional
    13  
    14  import "github.com/go-openapi/strfmt"
    15  
    16  type Classification struct {
    17  	BasedOn          []string        `json:"basedOn"`
    18  	ClassifiedFields []string        `json:"classifiedFields"`
    19  	Completed        strfmt.DateTime `json:"completed,omitempty"`
    20  	ID               strfmt.UUID     `json:"id,omitempty"`
    21  	Scope            []string        `json:"scope"`
    22  }
    23  
    24  type Properties struct {
    25  	Classification     bool                   `json:"classification"`
    26  	RefMeta            bool                   `json:"refMeta"`
    27  	Vector             bool                   `json:"vector"`
    28  	Vectors            []string               `json:"vectors"`
    29  	Certainty          bool                   `json:"certainty"`
    30  	ID                 bool                   `json:"id"`
    31  	CreationTimeUnix   bool                   `json:"creationTimeUnix"`
    32  	LastUpdateTimeUnix bool                   `json:"lastUpdateTimeUnix"`
    33  	ModuleParams       map[string]interface{} `json:"moduleParams"`
    34  	Distance           bool                   `json:"distance"`
    35  	Score              bool                   `json:"score"`
    36  	ExplainScore       bool                   `json:"explainScore"`
    37  	IsConsistent       bool                   `json:"isConsistent"`
    38  	Group              bool                   `json:"group"`
    39  
    40  	// The User is not interested in returning props, we can skip any costly
    41  	// operation that isn't required.
    42  	NoProps bool `json:"noProps"`
    43  
    44  	// ReferenceQuery is used to indicate that a search
    45  	// is being conducted on behalf of a referenced
    46  	// property. for example: this is relevant when a
    47  	// where filter operand is passed in with a path to
    48  	// a referenced class, rather than a path to one of
    49  	// its own props.
    50  	//
    51  	// The reason we need this indication is that
    52  	// without it, the sub-Search which is
    53  	// conducted to extract the reference propValuePair
    54  	// is conducted with the pagination set to whatever
    55  	// the QueryMaximumResults. if this value is set low
    56  	// relative to the number of objects being searched,
    57  	// weaviate will be unable to find enough results to
    58  	// make any comparisons, and erroneously returns
    59  	// empty, or with fewer results than expected.
    60  	ReferenceQuery bool `json:"-"`
    61  }