search

Documentation

Index

• type LocalRef
• type Result
  • func (r Result) Object() *models.Object
  • func (r Result) ObjectWithVector(includeVector bool) *models.Object
• type Results
  • func (rs Results) Objects() []*models.Object
  • func (rs Results) ObjectsWithVector(includeVector bool) []*models.Object
• type SelectClass
• type SelectProperties
  • func (sp SelectProperties) FindProperty(propName string) *SelectProperty
  • func (sp SelectProperties) HasProps() bool
  • func (sp SelectProperties) HasRefs() bool
  • func (sp SelectProperties) ShouldResolve(path []string) (bool, error)
• type SelectProperty
  • func (sp SelectProperty) FindSelectClass(className schema.ClassName) *SelectClass
  • func (sp SelectProperty) FindSelectProperty(name string) *SelectProperty
  • func (sp SelectProperty) HasPeer(peerName string) bool

Types

type LocalRef

type LocalRef struct {
	Class  string
	Fields map[string]interface{}
}

LocalRef to be filled by the search backend to indicate that the particular reference field is a local ref and does not require further resolving, as opposed to a NetworkRef.

type Result

type Result struct {
	ID                   strfmt.UUID
	DocID                *uint64
	ClassName            string
	Score                float32
	SecondarySortValue   float32
	ExplainScore         string
	Dist                 float32
	Vector               []float32
	Vectors              models.Vectors
	Beacon               string
	Certainty            float32
	Schema               models.PropertySchema
	Created              int64
	Updated              int64
	AdditionalProperties models.AdditionalProperties
	VectorWeights        map[string]string
	IsConsistent         bool
	Tenant               string

	// Dimensions in case search was vector-based, 0 otherwise
	Dims int
}

Result contains some info of a concept (kind), but not all. For additional info the ID can be used to retrieve the full concept from the connector storage

func (Result) Object

func (r Result) Object() *models.Object

func (Result) ObjectWithVector

func (r Result) ObjectWithVector(includeVector bool) *models.Object

type Results

type Results []Result

func (Results) Objects

func (rs Results) Objects() []*models.Object

func (Results) ObjectsWithVector

func (rs Results) ObjectsWithVector(includeVector bool) []*models.Object

type SelectClass

type SelectClass struct {
	ClassName            string                `json:"className"`
	RefProperties        SelectProperties      `json:"refProperties"`
	AdditionalProperties additional.Properties `json:"additionalProperties"`
}

type SelectProperties

type SelectProperties []SelectProperty

func (SelectProperties) FindProperty

func (sp SelectProperties) FindProperty(propName string) *SelectProperty

func (SelectProperties) HasProps

func (sp SelectProperties) HasProps() bool

func (SelectProperties) HasRefs

func (sp SelectProperties) HasRefs() bool

func (SelectProperties) ShouldResolve

func (sp SelectProperties) ShouldResolve(path []string) (bool, error)

type SelectProperty

type SelectProperty struct {
	Name string `json:"name"`

	IsPrimitive bool `json:"isPrimitive"`

	IsObject bool `json:"isObject"`

	// Include the __typename in all the Refs below.
	IncludeTypeName bool `json:"includeTypeName"`

	// Not a primitive nor nested type? Then select these properties.
	Refs []SelectClass `json:"refs"`

	// Nested type? Then select these properties.
	Props []SelectProperty `json:"objs"`
}

func (SelectProperty) FindSelectClass

func (sp SelectProperty) FindSelectClass(className schema.ClassName) *SelectClass

FindSelectClass by specifying the exact class name

func (SelectProperty) FindSelectProperty

func (sp SelectProperty) FindSelectProperty(name string) *SelectProperty

FindSelectObject by specifying the exact object name

func (SelectProperty) HasPeer

func (sp SelectProperty) HasPeer(peerName string) bool

HasPeer returns true if any of the referenced classes are from the specified peer