github.com/weaviate/weaviate@v1.24.6/adapters/handlers/graphql/descriptions/aggregate.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  // AGGREGATE
    16  const (
    17  	AggregateProperty = "Aggregate this property"
    18  	AggregateObjects  = "Aggregate Objects on a local Weaviate"
    19  )
    20  
    21  const GroupBy = "Specify which properties to group by"
    22  
    23  const (
    24  	AggregatePropertyObject = "An object containing Aggregation information about this property"
    25  )
    26  
    27  const AggregateObjectsObj = "An object allowing Aggregation of %ss on a local Weaviate"
    28  
    29  const (
    30  	AggregateMean      = "Aggregate on the mean of numeric property values"
    31  	AggregateSum       = "Aggregate on the sum of numeric property values"
    32  	AggregateMedian    = "Aggregate on the median of numeric property values"
    33  	AggregateMode      = "Aggregate on the mode of numeric property values"
    34  	AggregateMin       = "Aggregate on the minimum of numeric property values"
    35  	AggregateMax       = "Aggregate on the maximum of numeric property values"
    36  	AggregateCount     = "Aggregate on the total amount of found property values"
    37  	AggregateGroupedBy = "Indicates the group of returned data"
    38  )
    39  
    40  const AggregateNumericObj = "An object containing the %s of numeric properties"
    41  
    42  const AggregateCountObj = "An object containing countable properties"
    43  
    44  const AggregateGroupedByObj = "An object containing the path and value of the grouped property"
    45  
    46  const (
    47  	AggregateGroupedByGroupedByPath  = "The path of the grouped property"
    48  	AggregateGroupedByGroupedByValue = "The value of the grouped property"
    49  )
    50  
    51  // NETWORK
    52  const NetworkAggregateWeaviateObj = "An object containing Get Objects fields for network Weaviate instance: "
    53  
    54  const NetworkAggregate = "Perform Aggregation of Objects"
    55  
    56  const (
    57  	NetworkAggregateObj            = "An object allowing Aggregation of Objects"
    58  	NetworkAggregatePropertyObject = "An object containing Aggregation information about this property"
    59  )
    60  
    61  const NetworkAggregateThingsActionsObj = "An object allowing Aggregation of %ss on a network Weaviate"
    62  
    63  const (
    64  	NetworkAggregateMean      = "Aggregate on the mean of numeric property values"
    65  	NetworkAggregateSum       = "Aggregate on the sum of numeric property values"
    66  	NetworkAggregateMedian    = "Aggregate on the median of numeric property values"
    67  	NetworkAggregateMode      = "Aggregate on the mode of numeric property values"
    68  	NetworkAggregateMin       = "Aggregate on the minimum of numeric property values"
    69  	NetworkAggregateMax       = "Aggregate on the maximum of numeric property values"
    70  	NetworkAggregateCount     = "Aggregate on the total amount of found property values"
    71  	NetworkAggregateGroupedBy = "Indicates the group of returned data"
    72  )
    73  
    74  const NetworkAggregateNumericObj = "An object containing the %s of numeric properties"
    75  
    76  const NetworkAggregateCountObj = "An object containing countable properties"
    77  
    78  const NetworkAggregateGroupedByObj = "An object containing the path and value of the grouped property"
    79  
    80  const (
    81  	NetworkAggregateGroupedByGroupedByPath  = "The path of the grouped property"
    82  	NetworkAggregateGroupedByGroupedByValue = "The value of the grouped property"
    83  )