descriptions

Documentation

Overview

Package descriptions provides the descriptions as used by the graphql endpoint for Weaviate

Package descriptions provides the descriptions as used by the graphql endpoint for Weaviate

Package descriptions provides the descriptions as used by the graphql endpoint for Weaviate

Package descriptions provides the descriptions as used by the graphql endpoint for Weaviate

Package descriptions provides the descriptions as used by the graphql endpoint for Weaviate

Package descriptions provides the descriptions as used by the graphql endpoint for Weaviate

Package descriptions provides the descriptions as used by the graphql endpoint for Weaviate

Package descriptions provides the descriptions as used by the graphql endpoint for Weaviate

Package descriptions provides the descriptions as used by the graphql endpoint for Weaviate

Index

• Constants

Constants

const (
	AggregateProperty = "Aggregate this property"
	AggregateObjects  = "Aggregate Objects on a local Weaviate"
)

AGGREGATE

const (
	AggregateMean      = "Aggregate on the mean of numeric property values"
	AggregateSum       = "Aggregate on the sum of numeric property values"
	AggregateMedian    = "Aggregate on the median of numeric property values"
	AggregateMode      = "Aggregate on the mode of numeric property values"
	AggregateMin       = "Aggregate on the minimum of numeric property values"
	AggregateMax       = "Aggregate on the maximum of numeric property values"
	AggregateCount     = "Aggregate on the total amount of found property values"
	AggregateGroupedBy = "Indicates the group of returned data"
)

const (
	AggregateGroupedByGroupedByPath  = "The path of the grouped property"
	AggregateGroupedByGroupedByValue = "The value of the grouped property"
)

const (
	NetworkAggregateObj            = "An object allowing Aggregation of Objects"
	NetworkAggregatePropertyObject = "An object containing Aggregation information about this property"
)

const (
	NetworkAggregateMean      = "Aggregate on the mean of numeric property values"
	NetworkAggregateSum       = "Aggregate on the sum of numeric property values"
	NetworkAggregateMedian    = "Aggregate on the median of numeric property values"
	NetworkAggregateMode      = "Aggregate on the mode of numeric property values"
	NetworkAggregateMin       = "Aggregate on the minimum of numeric property values"
	NetworkAggregateMax       = "Aggregate on the maximum of numeric property values"
	NetworkAggregateCount     = "Aggregate on the total amount of found property values"
	NetworkAggregateGroupedBy = "Indicates the group of returned data"
)

const (
	NetworkAggregateGroupedByGroupedByPath  = "The path of the grouped property"
	NetworkAggregateGroupedByGroupedByValue = "The value of the grouped property"
)

const (
	LocalExplore         = "Explore Concepts on a local weaviate with vector-aided search"
	LocalExploreConcepts = "Explore Concepts on a local weaviate with vector-aided serach through keyword-based search terms"
	VectorMovement       = "Move your search term closer to or further away from another vector described by keywords"
	Keywords             = "Keywords are a list of search terms. Array type, e.g. [\"keyword 1\", \"keyword 2\"]"
	Network              = "Set to true, if the exploration should include remote peers"
	Limit                = "Limit the results set (usually fewer results mean faster queries)"
	Offset               = "Offset of the results set (usually fewer results mean faster queries)"
	Certainty            = "" /* 139-byte string literal not displayed */
	Distance             = "The required degree of similarity between an object's characteristics and the provided filter values"
	Vector               = "Target vector to be used in kNN search"
	Force                = "" /* 156-byte string literal not displayed */
	ClassName            = "Name of the Class"
	ID                   = "Concept identifier in the uuid format"
	Beacon               = "Concept identifier in the beacon format, such as weaviate://<hostname>/<kind>/id"
)

const (
	LocalFetch    = "Fetch Beacons that are similar to a specified concept from the Objects subsets on a Weaviate network"
	LocalFetchObj = "" /* 126-byte string literal not displayed */
)

Local

const (
	LocalFetchObjects = "Perform a Fuzzy Fetch to Fetch Beacons similar to a specified concept on a Weaviate network from the Objects subset"
	LocalFetchFuzzy   = "Perform a Fuzzy Fetch to Fetch Beacons similar to a specified concept on a Weaviate network from both the Objects subsets"
)

const (
	LocalFetchBeacon     = "A Beacon result from a local Weaviate Local Fetch query"
	LocalFetchClassName  = "The class name of the result from a local Weaviate Local Fetch query"
	LocalFetchCertainty  = "The degree of similarity on a scale of 0-1 between the Beacon's characteristics and the provided concept"
	LocalFetchActionsObj = "An object used to Fetch Beacons from the Actions subset of the dataset"
)

const (
	LocalFetchFuzzyBeacon    = "A Beacon result from a local Weaviate Fetch Fuzzy query from both the Objects subsets"
	LocalFetchFuzzyClassName = "Class name of the result from a local Weaviate Fetch Fuzzy query from both the Objects subsets"
	LocalFetchFuzzyCertainty = "The degree of similarity on a scale of 0-1 between the Beacon's characteristics and the provided concept"
	LocalFetchFuzzyObj       = "An object used to Fetch Beacons from both the Objects subsets"
)

const (
	NetworkFetch    = "Fetch Beacons that are similar to a specified concept from the Objects subsets on a Weaviate network"
	NetworkFetchObj = "An object used to perform a Fuzzy Fetch to search for Objects similar to a specified concept on a Weaviate network"
)

NETWORK

const (
	NetworkFetchFuzzyClassName = "The class name of the result from a network Weaviate Fetch Fuzzy query from both the Objects subsets"
	NetworkFetchFuzzyBeacon    = "A Beacon result from a network Weaviate Fetch Fuzzy query from both the Objects subsets"
	NetworkFetchFuzzyCertainty = "The degree of similarity on a scale of 0-1 between the Beacon's characteristics and the provided concept"
	NetworkFetchFuzzyObj       = "An object used to Fetch Beacons from both the Objects subsets"
)

const (
	GetWhere       = "Filter options for a local Get query, used to convert the result to the specified filters"
	GetWhereInpObj = "An object containing filter options for a local Get query, used to convert the result to the specified filters"
)

Where filter elements

const (
	LocalMetaWhere       = "Filter options for a local Meta query, used to convert the result to the specified filters"
	LocalMetaWhereInpObj = "An object containing filter options for a local Meta query, used to convert the result to the specified filters"
)

const (
	AggregateWhere       = "Filter options for a local Aggregate query, used to convert the result to the specified filters"
	AggregateWhereInpObj = "An object containing filter options for a local Aggregate query, used to convert the result to the specified filters"
)

const (
	NetworkGetWhere       = "Filter options for a network Get query, used to convert the result to the specified filters"
	NetworkGetWhereInpObj = "An object containing filter options for a network Get query, used to convert the result to the specified filters"
)

const (
	NetworkMetaWhere       = "Filter options for a network Meta query, used to convert the result to the specified filters"
	NetworkMetaWhereInpObj = "An object containing filter options for a network Meta query, used to convert the result to the specified filters"
)

const (
	NetworkAggregateWhere       = "Filter options for a network Aggregate query, used to convert the result to the specified filters"
	NetworkAggregateWhereInpObj = "An object containing filter options for a network Aggregate query, used to convert the result to the specified filters"
)

const (
	WhereOperands       = "Contains the Operands that can be applied to a 'where' filter"
	WhereOperandsInpObj = "An object containing the Operands that can be applied to a 'where' filter"
)

const (
	WhereOperator     = "Contains the Operators that can be applied to a 'where' filter"
	WhereOperatorEnum = "An object containing the Operators that can be applied to a 'where' filter"
)

const (
	WhereValueInt                          = "Specify an Integer value that the target property will be compared to"
	WhereValueNumber                       = "Specify a Float value that the target property will be compared to"
	WhereValueBoolean                      = "Specify a Boolean value that the target property will be compared to"
	WhereValueString                       = "Specify a String value that the target property will be compared to"
	WhereValueRange                        = "" /* 261-byte string literal not displayed */
	WhereValueRangeGeoCoordinates          = "The geoCoordinates that form the center point of the search."
	WhereValueRangeGeoCoordinatesLatitude  = "The latitude (in decimal format) of the geoCoordinates to search around."
	WhereValueRangeGeoCoordinatesLongitude = "The longitude (in decimal format) of the geoCoordinates to search around."
	WhereValueRangeDistance                = "The distance from the point specified via geoCoordinates."
	WhereValueRangeDistanceMax             = "The maximum distance from the point specified geoCoordinates."
	WhereValueText                         = "Specify a Text value that the target property will be compared to"
	WhereValueDate                         = "Specify a Date value that the target property will be compared to"
)

const (
	WhereProperties    = "Specify which properties to filter on"
	WherePropertiesObj = "Specify which properties to filter on"
)

Properties and Classes filter elements (used by Fetch and Introspect Where filters)

const (
	WherePropertiesPropertyName = "Specify which property name to filter properties on"
	WhereCertainty              = "" /* 126-byte string literal not displayed */
	WhereName                   = "Specify the name of the property to filter on"
)

const (
	WhereKeywords       = "Specify which keywords to filter on"
	WhereKeywordsInpObj = "Specify the value and the weight of a keyword"
)

const (
	WhereKeywordsValue  = "Specify the value of the keyword"
	WhereKeywordsWeight = "Specify the weight of the keyword"
)

const (
	WhereClass  = "Specify which classes to filter on"
	WhereInpObj = "Specify which classes and properties to filter on"
)

const (
	FetchWhereFilterFields       = "An object containing filter options for a network Fetch search, used to convert the result to the specified filters"
	FetchWhereFilterFieldsInpObj = "Filter options for a network Fetch search, used to convert the result to the specified filters"
)

Unique Fetch filter elements

const (
	FetchFuzzyValue     = "Specify the concept that will be used to fetch Objects on the network (e.g. 'Airplane', or 'City')"
	FetchFuzzyCertainty = "Specify how much a Beacon's characteristics must match the provided concept on a scale of 0 to 1"
)

const (
	IntrospectWhereFilterFields       = "An object containing filter options for a network Fetch search, used to convert the result to the specified filters"
	IntrospectWhereFilterFieldsInpObj = "Filter options for a network Fetch search, used to convert the result to the specified filters"
	IntrospectBeaconId                = "The id of the Beacon"
)

Unique Introspect filter elements

const (
	GroupByGroup  = "Specify the property of the class to group by"
	GroupByCount  = "Get the number of instances of a property in a group"
	GroupBySum    = "Get the sum of the values of a property in a group"
	GroupByMin    = "Get the minimum occurring value of a property in a group"
	GroupByMax    = "Get the maximum occurring value of a property in a group"
	GroupByMean   = "Get the mean value of a property in a group"
	GroupByMedian = "Get the median of a property in a group"
	GroupByMode   = "Get the mode of a property in a group"
)

GroupBy filter elements

const (
	First = "Show the first x results (pagination option)"
	After = "Show the results after the first x results (pagination option)"
)

Pagination filter elements

const (
	SortPath  = "" /* 152-byte string literal not displayed */
	SortOrder = "Specify the sort order, either ascending (asc) which is default or descending (desc)"
)

const (
	GroupByFilter          = "Specify the property of the class to group by"
	GroupByPath            = "" /* 155-byte string literal not displayed */
	GroupByGroups          = "Specify the number of groups to be created"
	GroupByObjectsPerGroup = "Specify the number of max objects in group"
)

const (
	GetObj = "An object used to Get Objects on a local Weaviate"
	Get    = "Get Objects on a local Weaviate"
)

const (
	NetworkGet    = "Get Objects from a Weaviate in a network"
	NetworkGetObj = "An object used to Get Objects from a Weaviate in a network"
)

Network

const (
	LocalMetaObj = "An object used to Get Meta information about Objects on a local Weaviate"
	LocalMeta    = "Get Meta information about Objects on a local Weaviate"
)

Local

const (
	MetaPropertyType                 = "The datatype of this property"
	MetaPropertyCount                = "The total amount of found instances for this property" // TODO check this with @lauraham
	MetaPropertyTopOccurrences       = "An object containing data about the most frequently occurring values for this property"
	MetaPropertyTopOccurrencesValue  = "The most frequently occurring value for this property"
	MetaPropertyTopOccurrencesOccurs = "How often the most frequently occurring value for this property occurs" // TODO check this with @lauraham
	MetaPropertyMinimum              = "The minimum value for this property"
	MetaPropertyMaximum              = "The maximum value for this property"
	MetaPropertyMean                 = "The mean of all values for this property"
	MetaPropertySum                  = "The sum of all values for this property"
	MetaPropertyObject               = "An object containing meta information about this property"
)

const (
	AggregatePropertyType                 = "The datatype of this property"
	AggregatePropertyCount                = "The total amount of found instances for this property" // TODO check this with @lauraham
	AggregatePropertyTopOccurrences       = "An object containing data about the most frequently occurring values for this property"
	AggregatePropertyTopOccurrencesValue  = "The most frequently occurring value for this property"
	AggregatePropertyTopOccurrencesOccurs = "How often the most frequently occurring value for this property occurs" // TODO check this with @lauraham
	AggregatePropertyMinimum              = "The minimum value for this property"
	AggregatePropertyMaximum              = "The maximum value for this property"
	AggregatePropertyMean                 = "The mean of all values for this property"
	AggregatePropertySum                  = "The sum of all values for this property"
)

const (
	NetworkMeta            = "Get meta information about Objects from a Weaviate in a network"
	NetworkMetaObj         = "An object used to Get meta information about Objects from a Weaviate in a network"
	NetworkMetaWeaviateObj = "An object containing the Meta Objects fields for network Weaviate instance: "
)

Network

const (
	MetaMetaProperty = "Meta information about the object"
	MetaProperty     = "Meta information about the property "
)

const (
	MetaClassPropertyTotalTrue      = "How often this boolean property's value is true in the dataset"
	MetaClassPropertyPercentageTrue = "The percentage of true values for this boolean property in the dataset"
)

const (
	MetaClassPropertyTotalFalse      = "How often this boolean property's value is false in the dataset"
	MetaClassPropertyPercentageFalse = "The percentage of false values for this boolean property in the dataset"
)

const (
	MetaClassPropertyPointingTo = "The classes that this object contains a reference to"
	MetaClassMetaCount          = "The total amount of found instances for a class"
	MetaClassMetaObj            = "An object containing Meta information about a class"
)

const (
	AggregateClassPropertyTotalTrue      = "How often this boolean property's value is true in the dataset"
	AggregateClassPropertyPercentageTrue = "The percentage of true values for this boolean property in the dataset"
)

const (
	AggregateClassPropertyTotalFalse      = "How often this boolean property's value is false in the dataset"
	AggregateClassPropertyPercentageFalse = "The percentage of false values for this boolean property in the dataset"
)

const (
	AggregateClassPropertyPointingTo = "The classes that this object contains a reference to"
	AggregateClassAggregateCount     = "The total amount of found instances for a class"
	AggregateClassAggregateObj       = "An object containing Aggregate information about a class"
)

const (
	NetworkIntrospect    = "Get Introspection information about Objects and/or Beacons in a Weaviate network"
	NetworkIntrospectObj = "An object used to perform an Introspection query on a Weaviate network"
)

NETWORK

const (
	NetworkIntrospectWeaviate  = "The Weaviate instance that the current Object or Beacon belongs to"
	NetworkIntrospectClassName = "The name of the current Object or Beacon's class"
	NetworkIntrospectCertainty = "The degree of similarity between a(n) Object or Beacon and the filter input"
)

const (
	NetworkIntrospectBeaconProperties             = "The properties of a Beacon"
	NetworkIntrospectBeaconPropertiesPropertyName = "The names of the properties of a Beacon"
)

const (
	LocalMergeObj = "An object used to Merge Objects on a local Weaviate"
	LocalMerge    = "Merge Objects on a local Weaviate"
)

Local

const (
	NetworkMerge    = "Merge Objects from a Weaviate in a network"
	NetworkMergeObj = "An object used to Merge Objects from a Weaviate in a network"
)

Network

const (
	WeaviateObj     = "The location of the root query"
	WeaviateNetwork = "Query a Weaviate network"
)

ROOT

const (
	NetworkWeaviate = "An object for the network Weaviate instance: "
	NetworkObj      = "An object used to perform queries on a Weaviate network"
)

NETWORK

const (
	AfterID = "Show the results after a given ID"
)

Cursor API

const AggregateCountObj = "An object containing countable properties"

const AggregateGroupedByObj = "An object containing the path and value of the grouped property"

const AggregateNumericObj = "An object containing the %s of numeric properties"

const AggregateObjectsObj = "An object allowing Aggregation of %ss on a local Weaviate"

const (
	AggregatePropertyObject = "An object containing Aggregation information about this property"
)

const ConsistencyLevel = "Determines how many replicas must acknowledge a request " +
	"before it is considered successful. Can be 'ONE', 'QUORUM', or 'ALL'"

const GetClassUUID = "The UUID of a Object, assigned by its local Weaviate"

const (
	GetObjects = "Get Objects on a local Weaviate"
)

Local

const GetObjectsActionsObj = "An object used to get %ss on a local Weaviate"

const GroupBy = "Specify which properties to group by"

const LocalMergeClassUUID = "The UUID of a Object, assigned by its local Weaviate"

const LocalObj = "A query on a local Weaviate"

LOCAL

const NetworkAggregate = "Perform Aggregation of Objects"

const NetworkAggregateCountObj = "An object containing countable properties"

const NetworkAggregateGroupedByObj = "An object containing the path and value of the grouped property"

const NetworkAggregateNumericObj = "An object containing the %s of numeric properties"

const NetworkAggregateThingsActionsObj = "An object allowing Aggregation of %ss on a network Weaviate"

const NetworkAggregateWeaviateObj = "An object containing Get Objects fields for network Weaviate instance: "

NETWORK

const (
	NetworkFetchFuzzy = "Perform a Fuzzy Fetch to Fetch Beacons similar to a specified concept on a Weaviate network from both the Objects subsets"
)

const NetworkGetClassUUID = "The UUID of a Object, assigned by the Weaviate network" // TODO check this with @lauraham

const (
	NetworkGetObjects = "Get Objects from a Weaviate in a network"
)

const (
	NetworkGetObjectsObj = "An object containing the Objects objects on this network Weaviate instance."
)

const NetworkGetWeaviateObj = "An object containing Get Objects fields for network Weaviate instance: "

const NetworkMergeClassUUID = "The UUID of a Thing or Action, assigned by the Weaviate network" // TODO check this with @lauraham

const NetworkMergeWeaviateObj = "An object containing Merge Objects fields for network Weaviate instance: "

const NetworkTimeout = "Specify the time in seconds after which an unresolved request automatically fails"

Request timeout filter elements

const Tenant = "The value by which a tenant is identified, specified in the class schema"

const WherePath = "" /* 155-byte string literal not displayed */