github.com/weaviate/weaviate@v1.24.6/adapters/handlers/graphql/descriptions/getMeta.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 descriptions provides the descriptions as used by the graphql endpoint for Weaviate
    13  package descriptions
    14  
    15  // Local
    16  const (
    17  	LocalMetaObj = "An object used to Get Meta information about Objects on a local Weaviate"
    18  	LocalMeta    = "Get Meta information about Objects on a local Weaviate"
    19  )
    20  
    21  const (
    22  	MetaPropertyType                 = "The datatype of this property"
    23  	MetaPropertyCount                = "The total amount of found instances for this property" // TODO check this with @lauraham
    24  	MetaPropertyTopOccurrences       = "An object containing data about the most frequently occurring values for this property"
    25  	MetaPropertyTopOccurrencesValue  = "The most frequently occurring value for this property"
    26  	MetaPropertyTopOccurrencesOccurs = "How often the most frequently occurring value for this property occurs" // TODO check this with @lauraham
    27  	MetaPropertyMinimum              = "The minimum value for this property"
    28  	MetaPropertyMaximum              = "The maximum value for this property"
    29  	MetaPropertyMean                 = "The mean of all values for this property"
    30  	MetaPropertySum                  = "The sum of all values for this property"
    31  	MetaPropertyObject               = "An object containing meta information about this property"
    32  )
    33  
    34  const (
    35  	AggregatePropertyType                 = "The datatype of this property"
    36  	AggregatePropertyCount                = "The total amount of found instances for this property" // TODO check this with @lauraham
    37  	AggregatePropertyTopOccurrences       = "An object containing data about the most frequently occurring values for this property"
    38  	AggregatePropertyTopOccurrencesValue  = "The most frequently occurring value for this property"
    39  	AggregatePropertyTopOccurrencesOccurs = "How often the most frequently occurring value for this property occurs" // TODO check this with @lauraham
    40  	AggregatePropertyMinimum              = "The minimum value for this property"
    41  	AggregatePropertyMaximum              = "The maximum value for this property"
    42  	AggregatePropertyMean                 = "The mean of all values for this property"
    43  	AggregatePropertySum                  = "The sum of all values for this property"
    44  )
    45  
    46  // Network
    47  const (
    48  	NetworkMeta            = "Get meta information about Objects from a Weaviate in a network"
    49  	NetworkMetaObj         = "An object used to Get meta information about Objects from a Weaviate in a network"
    50  	NetworkMetaWeaviateObj = "An object containing the Meta Objects fields for network Weaviate instance: "
    51  )
    52  
    53  const (
    54  	MetaMetaProperty = "Meta information about the object"
    55  	MetaProperty     = "Meta information about the property "
    56  )
    57  
    58  const (
    59  	MetaClassPropertyTotalTrue      = "How often this boolean property's value is true in the dataset"
    60  	MetaClassPropertyPercentageTrue = "The percentage of true values for this boolean property in the dataset"
    61  )
    62  
    63  const (
    64  	MetaClassPropertyTotalFalse      = "How often this boolean property's value is false in the dataset"
    65  	MetaClassPropertyPercentageFalse = "The percentage of false values for this boolean property in the dataset"
    66  )
    67  
    68  const (
    69  	MetaClassPropertyPointingTo = "The classes that this object contains a reference to"
    70  	MetaClassMetaCount          = "The total amount of found instances for a class"
    71  	MetaClassMetaObj            = "An object containing Meta information about a class"
    72  )
    73  
    74  const (
    75  	AggregateClassPropertyTotalTrue      = "How often this boolean property's value is true in the dataset"
    76  	AggregateClassPropertyPercentageTrue = "The percentage of true values for this boolean property in the dataset"
    77  )
    78  
    79  const (
    80  	AggregateClassPropertyTotalFalse      = "How often this boolean property's value is false in the dataset"
    81  	AggregateClassPropertyPercentageFalse = "The percentage of false values for this boolean property in the dataset"
    82  )
    83  
    84  const (
    85  	AggregateClassPropertyPointingTo = "The classes that this object contains a reference to"
    86  	AggregateClassAggregateCount     = "The total amount of found instances for a class"
    87  	AggregateClassAggregateObj       = "An object containing Aggregate information about a class"
    88  )