searchparams

Documentation

Index

• func GetPropertyByName(c *models.Class, propName string) (*models.Property, error)
• func HasSearchableIndex(prop *models.Property) bool
• func PropertyHasSearchableIndex(class *models.Class, tentativePropertyName string) bool
• type ExploreMove
• type GroupBy
• type HybridSearch
• type KeywordRanking
  • func (k *KeywordRanking) ChooseSearchableProperties(class *models.Class)
• type NearObject
• type NearTextParams
• type NearVector
• type ObjectMove
• type WeightedSearchResult

Functions

func GetPropertyByName

func GetPropertyByName(c *models.Class, propName string) (*models.Property, error)

GetPropertyByName returns the class by its name

func HasSearchableIndex

func HasSearchableIndex(prop *models.Property) bool

Indicates whether property should be indexed Index holds document ids with property of/containing particular value and number of its occurrences in that property (index created using bucket of StrategyMapCollection)

func PropertyHasSearchableIndex

func PropertyHasSearchableIndex(class *models.Class, tentativePropertyName string) bool

Types

type ExploreMove

type ExploreMove struct {
	Values  []string
	Force   float32
	Objects []ObjectMove
}

ExploreMove moves an existing Search Vector closer (or further away from) a specific other search term

type GroupBy

type GroupBy struct {
	Property        string
	Groups          int
	ObjectsPerGroup int
}

type HybridSearch

type HybridSearch struct {
	SubSearches      interface{} `json:"subSearches"`
	Type             string      `json:"type"`
	Alpha            float64     `json:"alpha"`
	Query            string      `json:"query"`
	Vector           []float32   `json:"vector"`
	Properties       []string    `json:"properties"`
	TargetVectors    []string    `json:"targetVectors"`
	FusionAlgorithm  int         `json:"fusionalgorithm"`
	NearTextParams   *NearTextParams
	NearVectorParams *NearVector
}

type KeywordRanking

type KeywordRanking struct {
	Type                   string   `json:"type"`
	Properties             []string `json:"properties"`
	Query                  string   `json:"query"`
	AdditionalExplanations bool     `json:"additionalExplanations"`
}

func (*KeywordRanking) ChooseSearchableProperties

func (k *KeywordRanking) ChooseSearchableProperties(class *models.Class)

type NearObject

type NearObject struct {
	ID            string   `json:"id"`
	Beacon        string   `json:"beacon"`
	Certainty     float64  `json:"certainty"`
	Distance      float64  `json:"distance"`
	WithDistance  bool     `json:"-"`
	TargetVectors []string `json:"targetVectors"`
}

type NearTextParams

type NearTextParams struct {
	Values        []string
	Limit         int
	MoveTo        ExploreMove
	MoveAwayFrom  ExploreMove
	Certainty     float64
	Distance      float64
	WithDistance  bool
	Network       bool
	Autocorrect   bool
	TargetVectors []string
}

type NearVector

type NearVector struct {
	Certainty       float64              `json:"certainty"`
	Distance        float64              `json:"distance"`
	WithDistance    bool                 `json:"-"`
	VectorPerTarget map[string][]float32 `json:"vectorPerTarget"`
	TargetVectors   []string             `json:"targetVectors"`
}

type ObjectMove

type ObjectMove struct {
	ID     string
	Beacon string
}

type WeightedSearchResult

type WeightedSearchResult struct {
	SearchParams interface{} `json:"searchParams"`
	Weight       float64     `json:"weight"`
	Type         string      `json:"type"`
}