github.com/weaviate/weaviate@v1.24.6/adapters/handlers/graphql/descriptions/explore.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  const (
    16  	LocalExplore         = "Explore Concepts on a local weaviate with vector-aided search"
    17  	LocalExploreConcepts = "Explore Concepts on a local weaviate with vector-aided serach through keyword-based search terms"
    18  	VectorMovement       = "Move your search term closer to or further away from another vector described by keywords"
    19  	Keywords             = "Keywords are a list of search terms. Array type, e.g. [\"keyword 1\", \"keyword 2\"]"
    20  	Network              = "Set to true, if the exploration should include remote peers"
    21  	Limit                = "Limit the results set (usually fewer results mean faster queries)"
    22  	Offset               = "Offset of the results set (usually fewer results mean faster queries)"
    23  	Certainty            = "Normalized Distance between the result item and the search vector. Normalized to be between 0 (identical vectors) and 1 (perfect opposite)."
    24  	Distance             = "The required degree of similarity between an object's characteristics and the provided filter values"
    25  	Vector               = "Target vector to be used in kNN search"
    26  	Force                = "The force to apply for a particular movements. Must be between 0 and 1 where 0 is equivalent to no movement and 1 is equivalent to largest movement possible"
    27  	ClassName            = "Name of the Class"
    28  	ID                   = "Concept identifier in the uuid format"
    29  	Beacon               = "Concept identifier in the beacon format, such as weaviate://<hostname>/<kind>/id"
    30  )