graphql

package
v4.16.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 20, 2024 License: BSD-3-Clause Imports: 14 Imported by: 46

Documentation

Index

Constants

View Source 
const EmptyObjectStr string = "{}"

EmptyObjectStr string representation of an empty object

Variables

This section is empty.

Functions

This section is empty.

Types

type API 

type API struct {
	// contains filtered or unexported fields
}

API group for GraphQL

func New 

func New(con *connection.Connection) *API

New GraphQL api group from connection

func (*API) Aggregate 

func (api *API) Aggregate() *AggregateBuilder

Aggregate queries

func (*API) AskArgBuilder 

func (api *API) AskArgBuilder() *AskArgumentBuilder

AskArgBuilder ask clause

func (*API) Bm25ArgBuilder added in v4.6.1 

func (api *API) Bm25ArgBuilder() *BM25ArgumentBuilder

Bm25ArgBuilder bm25 clause

func (*API) Explore 

func (api *API) Explore() *Explore

Explore queries

func (*API) Get 

func (api *API) Get() *GetBuilder

Get queries

func (*API) GroupArgBuilder 

func (api *API) GroupArgBuilder() *GroupArgumentBuilder

GroupArgBuilder nearImage clause

func (*API) GroupByArgBuilder added in v4.8.0 

func (api *API) GroupByArgBuilder() *GroupByArgumentBuilder

GroupByArgBuilder groupBy clause

func (*API) HybridArgumentBuilder added in v4.6.1 

func (api *API) HybridArgumentBuilder() *HybridArgumentBuilder

HybridArgumentBuilder hybrid clause

func (*API) HybridSearchesArgumentBuilder added in v4.14.0 

func (api *API) HybridSearchesArgumentBuilder() *HybridSearchesArgumentBuilder

HybridSearchesArgumentBuilder hybrid.searches clause

func (*API) MultiClassGet added in v4.6.0 

func (api *API) MultiClassGet() *MultiClassBuilder

Get queries with Multiple Class

func (*API) MultiTargetArgumentBuilder added in v4.15.0 

func (api *API) MultiTargetArgumentBuilder() *MultiTargetArgumentBuilder

MultiTargetArgumentBuilder targets clause

func (*API) NearAudioArgBuilder added in v4.10.0 

func (api *API) NearAudioArgBuilder() *NearAudioArgumentBuilder

NearImageArgBuilder nearImage clause

func (*API) NearDepthArgBuilder added in v4.10.0 

func (api *API) NearDepthArgBuilder() *NearDepthArgumentBuilder

NearImageArgBuilder nearImage clause

func (*API) NearImageArgBuilder 

func (api *API) NearImageArgBuilder() *NearImageArgumentBuilder

NearImageArgBuilder nearImage clause

func (*API) NearImuArgBuilder added in v4.10.0 

func (api *API) NearImuArgBuilder() *NearImuArgumentBuilder

NearImageArgBuilder nearImage clause

func (*API) NearObjectArgBuilder 

func (api *API) NearObjectArgBuilder() *NearObjectArgumentBuilder

NearObjectArgBuilder nearObject clause

func (*API) NearTextArgBuilder 

func (api *API) NearTextArgBuilder() *NearTextArgumentBuilder

NearTextArgBuilder nearText clause

func (*API) NearThermalArgBuilder added in v4.10.0 

func (api *API) NearThermalArgBuilder() *NearThermalArgumentBuilder

NearImageArgBuilder nearImage clause

func (*API) NearVectorArgBuilder 

func (api *API) NearVectorArgBuilder() *NearVectorArgumentBuilder

NearVectorArgBuilder nearVector clause

func (*API) NearVideoArgBuilder added in v4.10.0 

func (api *API) NearVideoArgBuilder() *NearVideoArgumentBuilder

NearImageArgBuilder nearImage clause

func (*API) Raw 

func (api *API) Raw() *Raw

Raw creates a raw GraphQL query

type AggregateBuilder 

type AggregateBuilder struct {
	// contains filtered or unexported fields
}

AggregateBuilder for the aggregate GraphQL query string

func (*AggregateBuilder) Do 

func (ab *AggregateBuilder) Do(ctx context.Context) (*models.GraphQLResponse, error)

Do execute the aggregation query

func (*AggregateBuilder) WithAsk 

func (ab *AggregateBuilder) WithAsk(ask *AskArgumentBuilder) *AggregateBuilder

WithAsk adds ask to clause

func (*AggregateBuilder) WithClassName 

func (ab *AggregateBuilder) WithClassName(name string) *AggregateBuilder

WithClassName that should be aggregated

func (*AggregateBuilder) WithFields 

func (ab *AggregateBuilder) WithFields(fields ...Field) *AggregateBuilder

WithFields that should be included in the aggregation query e.g. `meta{count}`

func (*AggregateBuilder) WithGroupBy 

func (ab *AggregateBuilder) WithGroupBy(propertyName string) *AggregateBuilder

WithGroupBy adds the group by property clause as the filter. 

The group by value/path clause still needs to be set in the WithFields field.

func (*AggregateBuilder) WithLimit 

func (ab *AggregateBuilder) WithLimit(limit int) *AggregateBuilder

WithLimit specifies limit to group by argument

func (*AggregateBuilder) WithNearAudio added in v4.10.0 

func (ab *AggregateBuilder) WithNearAudio(nearAudio *NearAudioArgumentBuilder) *AggregateBuilder

WithNearAudio adds nearAudio to clause

func (*AggregateBuilder) WithNearDepth added in v4.10.0 

func (ab *AggregateBuilder) WithNearDepth(nearDepth *NearDepthArgumentBuilder) *AggregateBuilder

WithNearDepth adds nearDepth to clause

func (*AggregateBuilder) WithNearImage 

func (ab *AggregateBuilder) WithNearImage(nearImage *NearImageArgumentBuilder) *AggregateBuilder

WithNearImage adds nearImage to clause

func (*AggregateBuilder) WithNearImu added in v4.10.0 

func (ab *AggregateBuilder) WithNearImu(nearImu *NearImuArgumentBuilder) *AggregateBuilder

WithNearImu adds nearIMU to clause

func (*AggregateBuilder) WithNearObject 

func (ab *AggregateBuilder) WithNearObject(nearObject *NearObjectArgumentBuilder) *AggregateBuilder

WithNearObject clause to find close objects

func (*AggregateBuilder) WithNearText 

func (ab *AggregateBuilder) WithNearText(nearText *NearTextArgumentBuilder) *AggregateBuilder

WithNearText clause to find close objects

func (*AggregateBuilder) WithNearThermal added in v4.10.0 

func (ab *AggregateBuilder) WithNearThermal(nearThermal *NearThermalArgumentBuilder) *AggregateBuilder

WithNearThermal adds nearThermal to clause

func (*AggregateBuilder) WithNearVector 

func (ab *AggregateBuilder) WithNearVector(nearVector *NearVectorArgumentBuilder) *AggregateBuilder

WithNearVector clause to find close objects

func (*AggregateBuilder) WithNearVideo added in v4.10.0 

func (ab *AggregateBuilder) WithNearVideo(nearVideo *NearVideoArgumentBuilder) *AggregateBuilder

WithNearVideo adds nearVideo to clause

func (*AggregateBuilder) WithObjectLimit 

func (ab *AggregateBuilder) WithObjectLimit(objectLimit int) *AggregateBuilder

WithObjectLimit specifies max number of vector search results to return

func (*AggregateBuilder) WithTenant added in v4.9.0 

func (ab *AggregateBuilder) WithTenant(tenant string) *AggregateBuilder

WithTenant to indicate which tenant aggregated objects belong to

func (*AggregateBuilder) WithWhere 

func (ab *AggregateBuilder) WithWhere(where *filters.WhereBuilder) *AggregateBuilder

WithWhere adds the where filter.

type AskArgumentBuilder 

type AskArgumentBuilder struct {
	// contains filtered or unexported fields
}

func (*AskArgumentBuilder) WithAutocorrect 

func (e *AskArgumentBuilder) WithAutocorrect(autocorrect bool) *AskArgumentBuilder

WithAutocorrect this is a setting enabling autocorrect of question text

func (*AskArgumentBuilder) WithCertainty 

func (e *AskArgumentBuilder) WithCertainty(certainty float32) *AskArgumentBuilder

WithCertainty specifies how accurate the answer should be

func (*AskArgumentBuilder) WithDistance 

func (e *AskArgumentBuilder) WithDistance(distance float32) *AskArgumentBuilder

WithDistance specifies how accurate the answer should be

func (*AskArgumentBuilder) WithProperties 

func (e *AskArgumentBuilder) WithProperties(properties []string) *AskArgumentBuilder

WithProperties the list of properties that contain a text to look in for an answer

func (*AskArgumentBuilder) WithQuestion 

func (e *AskArgumentBuilder) WithQuestion(question string) *AskArgumentBuilder

WithQuestion the question to be asked

func (*AskArgumentBuilder) WithRerank 

func (e *AskArgumentBuilder) WithRerank(rerank bool) *AskArgumentBuilder

WithRerank this is a setting enabling re-ranking of results based on certainty

type BM25ArgumentBuilder 

type BM25ArgumentBuilder struct {
	// contains filtered or unexported fields
}

func (*BM25ArgumentBuilder) WithProperties 

func (b *BM25ArgumentBuilder) WithProperties(properties ...string) *BM25ArgumentBuilder

WithProperties the properties to search. Leave blank for all

func (*BM25ArgumentBuilder) WithQuery 

func (b *BM25ArgumentBuilder) WithQuery(query string) *BM25ArgumentBuilder

WithQuery the search string

type Explore 

type Explore struct {
	// contains filtered or unexported fields
}

Explore query builder

func (*Explore) Do 

func (e *Explore) Do(ctx context.Context) (*models.GraphQLResponse, error)

Do execute explore search

func (*Explore) WithAsk 

func (e *Explore) WithAsk(ask *AskArgumentBuilder) *Explore

WithAsk adds ask to clause

func (*Explore) WithFields 

func (e *Explore) WithFields(fields ...ExploreFields) *Explore

WithFields that should be included in the result set

func (*Explore) WithLimit 

func (e *Explore) WithLimit(limit int) *Explore

WithLimit of objects in the result set

func (*Explore) WithNearAudio added in v4.10.0 

func (e *Explore) WithNearAudio(nearAudio *NearAudioArgumentBuilder) *Explore

WithNearAudio adds nearAudio to clause

func (*Explore) WithNearDepth added in v4.10.0 

func (e *Explore) WithNearDepth(nearDepth *NearDepthArgumentBuilder) *Explore

WithNearDepth adds nearDepth to clause

func (*Explore) WithNearImage 

func (e *Explore) WithNearImage(nearImage *NearImageArgumentBuilder) *Explore

WithNearImage adds nearImage to clause

func (*Explore) WithNearImu added in v4.10.0 

func (e *Explore) WithNearImu(nearImu *NearImuArgumentBuilder) *Explore

WithNearImu adds nearIMU to clause

func (*Explore) WithNearObject 

func (e *Explore) WithNearObject(nearObject *NearObjectArgumentBuilder) *Explore

WithNearObject adds nearObject to clause

func (*Explore) WithNearText 

func (e *Explore) WithNearText(nearText *NearTextArgumentBuilder) *Explore

WithNearText adds nearText to clause

func (*Explore) WithNearThermal added in v4.10.0 

func (e *Explore) WithNearThermal(nearThermal *NearThermalArgumentBuilder) *Explore

WithNearThermal adds nearThermal to clause

func (*Explore) WithNearVector 

func (e *Explore) WithNearVector(nearVector *NearVectorArgumentBuilder) *Explore

WithNearVector clause to find close objects

func (*Explore) WithNearVideo added in v4.10.0 

func (e *Explore) WithNearVideo(nearVideo *NearVideoArgumentBuilder) *Explore

WithNearVideo adds nearVideo to clause

func (*Explore) WithOffset 

func (e *Explore) WithOffset(offset int) *Explore

WithOffset of objects in the result set

type ExploreFields 

type ExploreFields string

ExploreFields used in an Explore GraphQL query 

const (
	// Certainty includes the certainty that a data object is related to the query concept
	Certainty ExploreFields = "certainty"

	// Distance includes the distance that a data object is related to the query concept
	Distance ExploreFields = "distance"

	// Beacon includes the beacon to the found objects
	Beacon ExploreFields = "beacon"

	// ClassName includes the class name of the found objects
	ClassName ExploreFields = "className"
)

type Field 

type Field struct {
	Name   string
	Fields []Field
}

type FieldsBuilder 

type FieldsBuilder struct {
	// contains filtered or unexported fields
}

func (*FieldsBuilder) WithFields 

func (b *FieldsBuilder) WithFields(fields []Field) *FieldsBuilder

type FusionType added in v4.9.0 

type FusionType string
const Ranked FusionType = "rankedFusion"

Ranked FusionType operator 

const RelativeScore FusionType = "relativeScoreFusion"

RelativeScore FusionType operator

type GenerativeSearchBuilder added in v4.6.2 

type GenerativeSearchBuilder struct {
	// contains filtered or unexported fields
}

func NewGenerativeSearch added in v4.6.2 

func NewGenerativeSearch() *GenerativeSearchBuilder

func (*GenerativeSearchBuilder) GroupedResult added in v4.6.2 

func (gsb *GenerativeSearchBuilder) GroupedResult(task string, properties ...string) *GenerativeSearchBuilder

func (*GenerativeSearchBuilder) SingleResult added in v4.6.2 

func (gsb *GenerativeSearchBuilder) SingleResult(prompt string) *GenerativeSearchBuilder

type GetBuilder 

type GetBuilder struct {
	// contains filtered or unexported fields
}

GetBuilder for GraphQL

func NewQueryClassBuilder added in v4.6.0 

func NewQueryClassBuilder(className string) *GetBuilder

ClassName that should be queried

func (*GetBuilder) Build added in v4.16.0 

func (gb *GetBuilder) Build() string

Build execute the GraphQL query

func (*GetBuilder) Do 

func (gb *GetBuilder) Do(ctx context.Context) (*models.GraphQLResponse, error)

Do execute the GraphQL query

func (*GetBuilder) WithAfter added in v4.6.2 

func (gb *GetBuilder) WithAfter(id string) *GetBuilder

WithAfter is part of the Cursor API. It can be used to extract all elements by specfiying the last ID from the previous "page". Cannot be combined with any other filters or search operators other than limit. Requires WithClassName() and WithLimit() to be set.

func (*GetBuilder) WithAsk 

func (gb *GetBuilder) WithAsk(ask *AskArgumentBuilder) *GetBuilder

WithAsk clause to find an aswer to the question

func (*GetBuilder) WithAutocut added in v4.9.0 

func (gb *GetBuilder) WithAutocut(autocut int) *GetBuilder

WithAutocut of objects in the result set

func (*GetBuilder) WithBM25 

func (gb *GetBuilder) WithBM25(bm25 *BM25ArgumentBuilder) *GetBuilder

WithBM25 to search the inverted index

func (*GetBuilder) WithClassName 

func (gb *GetBuilder) WithClassName(name string) *GetBuilder

WithClassName that should be queried

func (*GetBuilder) WithConsistencyLevel added in v4.8.0 

func (gb *GetBuilder) WithConsistencyLevel(lvl string) *GetBuilder

func (*GetBuilder) WithFields 

func (gb *GetBuilder) WithFields(fields ...Field) *GetBuilder

WithFields included in the result set

func (*GetBuilder) WithGenerativeSearch added in v4.6.2 

func (gb *GetBuilder) WithGenerativeSearch(s *GenerativeSearchBuilder) *GetBuilder

To Use OpenAI to generate a response based on the results

func (*GetBuilder) WithGroup 

func (gb *GetBuilder) WithGroup(group *GroupArgumentBuilder) *GetBuilder

WithGroup statement

func (*GetBuilder) WithGroupBy added in v4.8.0 

func (gb *GetBuilder) WithGroupBy(groupBy *GroupByArgumentBuilder) *GetBuilder

WithGroupBy to perform group by operation

func (*GetBuilder) WithHybrid 

func (gb *GetBuilder) WithHybrid(hybrid *HybridArgumentBuilder) *GetBuilder

WithHybrid to combine multiple searches

func (*GetBuilder) WithLimit 

func (gb *GetBuilder) WithLimit(limit int) *GetBuilder

WithLimit of objects in the result set

func (*GetBuilder) WithNearAudio added in v4.10.0 

func (gb *GetBuilder) WithNearAudio(nearAudio *NearAudioArgumentBuilder) *GetBuilder

WithNearAudio clause to find close objects

func (*GetBuilder) WithNearDepth added in v4.10.0 

func (gb *GetBuilder) WithNearDepth(nearDepth *NearDepthArgumentBuilder) *GetBuilder

WithNearDepth clause to find close objects

func (*GetBuilder) WithNearImage 

func (gb *GetBuilder) WithNearImage(nearImage *NearImageArgumentBuilder) *GetBuilder

WithNearImage clause to find close objects

func (*GetBuilder) WithNearImu added in v4.10.0 

func (gb *GetBuilder) WithNearImu(nearImu *NearImuArgumentBuilder) *GetBuilder

WithNearImage clause to find close objects

func (*GetBuilder) WithNearObject 

func (gb *GetBuilder) WithNearObject(nearObject *NearObjectArgumentBuilder) *GetBuilder

WithNearObject clause to find close objects

func (*GetBuilder) WithNearText 

func (gb *GetBuilder) WithNearText(nearText *NearTextArgumentBuilder) *GetBuilder

WithNearText clause to find close objects

func (*GetBuilder) WithNearThermal added in v4.10.0 

func (gb *GetBuilder) WithNearThermal(nearThermal *NearThermalArgumentBuilder) *GetBuilder

WithNearImage clause to find close objects

func (*GetBuilder) WithNearVector 

func (gb *GetBuilder) WithNearVector(nearVector *NearVectorArgumentBuilder) *GetBuilder

WithNearVector clause to find close objects

func (*GetBuilder) WithNearVideo added in v4.10.0 

func (gb *GetBuilder) WithNearVideo(nearVideo *NearVideoArgumentBuilder) *GetBuilder

WithNearVideo clause to find close objects

func (*GetBuilder) WithOffset 

func (gb *GetBuilder) WithOffset(offset int) *GetBuilder

WithOffset of objects in the result set

func (*GetBuilder) WithSort 

func (gb *GetBuilder) WithSort(sort ...Sort) *GetBuilder

WithSort included in the result set

func (*GetBuilder) WithTenant added in v4.9.0 

func (gb *GetBuilder) WithTenant(tenant string) *GetBuilder

WithTenant to indicate which tenant fetched objects belong to

func (*GetBuilder) WithWhere 

func (gb *GetBuilder) WithWhere(where *filters.WhereBuilder) *GetBuilder

WithWhere filter

type GroupArgumentBuilder 

type GroupArgumentBuilder struct {
	// contains filtered or unexported fields
}

func (*GroupArgumentBuilder) WithForce 

func (b *GroupArgumentBuilder) WithForce(force float32) *GroupArgumentBuilder

WithBeacon the beacon of the object

func (*GroupArgumentBuilder) WithType 

func (b *GroupArgumentBuilder) WithType(groupType GroupType) *GroupArgumentBuilder

WithType the type of group argument

type GroupByArgumentBuilder added in v4.8.0 

type GroupByArgumentBuilder struct {
	// contains filtered or unexported fields
}

func (*GroupByArgumentBuilder) WithGroups added in v4.8.0 

func (b *GroupByArgumentBuilder) WithGroups(groups int) *GroupByArgumentBuilder

WithGroups maximum number of groups

func (*GroupByArgumentBuilder) WithObjectsPerGroup added in v4.8.0 

func (b *GroupByArgumentBuilder) WithObjectsPerGroup(objectsPerGroup int) *GroupByArgumentBuilder

WithObjectsPerGroup maximum number of elements in group

func (*GroupByArgumentBuilder) WithPath added in v4.8.0 

func (b *GroupByArgumentBuilder) WithPath(path []string) *GroupByArgumentBuilder

WithPath the property by which is should be grouped by

type GroupType 

type GroupType string

GroupType filter 

const Closest GroupType = "closest"

Closest group type filter 

const Merge GroupType = "merge"

Merge group type filter

type HybridArgumentBuilder 

type HybridArgumentBuilder struct {
	// contains filtered or unexported fields
}

func (*HybridArgumentBuilder) WithAlpha 

func (h *HybridArgumentBuilder) WithAlpha(alpha float32) *HybridArgumentBuilder

WithAlpha the bias

func (*HybridArgumentBuilder) WithFusionType added in v4.9.0 

func (h *HybridArgumentBuilder) WithFusionType(fusionType FusionType) *HybridArgumentBuilder

WithFusionType sets the fusion type to be used. Can be omitted.

func (*HybridArgumentBuilder) WithMaxVectorDistance added in v4.16.0 

func (s *HybridArgumentBuilder) WithMaxVectorDistance(d float32) *HybridArgumentBuilder

WithMaxVectorDistance is the equivalent of 'distance' threshold in vector search.

func (*HybridArgumentBuilder) WithProperties added in v4.8.1 

func (h *HybridArgumentBuilder) WithProperties(properties []string) *HybridArgumentBuilder

WithProperties The properties which are searched. Can be omitted.

func (*HybridArgumentBuilder) WithQuery 

func (h *HybridArgumentBuilder) WithQuery(query string) *HybridArgumentBuilder

WithQuery the search string

func (*HybridArgumentBuilder) WithSearches added in v4.14.0 

func (h *HybridArgumentBuilder) WithSearches(searches *HybridSearchesArgumentBuilder) *HybridArgumentBuilder

WithSearches sets the searches to be used with hybrid.

func (*HybridArgumentBuilder) WithTargetVectors added in v4.13.1 

func (h *HybridArgumentBuilder) WithTargetVectors(targetVectors ...string) *HybridArgumentBuilder

WithTargetVectors sets the target vectors to be used with hybrid query.

func (*HybridArgumentBuilder) WithTargets added in v4.15.0 

func (h *HybridArgumentBuilder) WithTargets(targets *MultiTargetArgumentBuilder) *HybridArgumentBuilder

WithTargets sets the multi target vectors to be used with hybrid query. This builder takes precedence over WithTargetVectors. So if WithTargets is used, WithTargetVectors will be ignored.

func (*HybridArgumentBuilder) WithVector 

func (h *HybridArgumentBuilder) WithVector(vector []float32) *HybridArgumentBuilder

WithVector the vector. Can be omitted

type HybridSearchesArgumentBuilder added in v4.14.0 

type HybridSearchesArgumentBuilder struct {
	// contains filtered or unexported fields
}

func (*HybridSearchesArgumentBuilder) WithNearText added in v4.14.0 

func (s *HybridSearchesArgumentBuilder) WithNearText(nearText *NearTextArgumentBuilder) *HybridSearchesArgumentBuilder

func (*HybridSearchesArgumentBuilder) WithNearVector added in v4.14.0 

func (s *HybridSearchesArgumentBuilder) WithNearVector(nearVector *NearVectorArgumentBuilder) *HybridSearchesArgumentBuilder

type MoveParameters 

type MoveParameters struct {
	// Concepts that should be used as base for the movement operation
	Concepts []string
	// Force to be applied in the movement operation
	Force float32
	// Objects used to adjust the serach direction
	Objects []MoverObject
}

MoveParameters to fine tune Explore queries

func (*MoveParameters) String 

func (m *MoveParameters) String() string

type MoverObject 

type MoverObject struct {
	ID     string
	Beacon string
}

MoverObject is the object the search is supposed to move close to (or further away from) it.

func (*MoverObject) String 

func (m *MoverObject) String() string

String returns string representation of m as {"id": "value" beacon:"value"}. Empty fields are considered optional and are excluded. It returns EmptyObjectStr if both fields are empty

type MultiClassBuilder added in v4.6.0 

type MultiClassBuilder struct {
	// contains filtered or unexported fields
}

func (*MultiClassBuilder) AddQueryClass added in v4.6.0 

func (mb *MultiClassBuilder) AddQueryClass(class *GetBuilder) *MultiClassBuilder

func (*MultiClassBuilder) Do added in v4.6.0 

func (mb *MultiClassBuilder) Do(ctx context.Context) (*models.GraphQLResponse, error)

Do execute the GraphQL query

type MultiTargetArgumentBuilder added in v4.15.0 

type MultiTargetArgumentBuilder struct {
	// contains filtered or unexported fields
}

func (*MultiTargetArgumentBuilder) Average added in v4.15.0 

func (m *MultiTargetArgumentBuilder) Average(targetVectors ...string) *MultiTargetArgumentBuilder

func (*MultiTargetArgumentBuilder) ManualWeights added in v4.15.0 

func (m *MultiTargetArgumentBuilder) ManualWeights(targetVectors map[string]float32) *MultiTargetArgumentBuilder

func (*MultiTargetArgumentBuilder) ManualWeightsMulti added in v4.16.0 

func (m *MultiTargetArgumentBuilder) ManualWeightsMulti(targetVectors map[string][]float32) *MultiTargetArgumentBuilder

func (*MultiTargetArgumentBuilder) Minimum added in v4.15.0 

func (m *MultiTargetArgumentBuilder) Minimum(targetVectors ...string) *MultiTargetArgumentBuilder

func (*MultiTargetArgumentBuilder) RelativeScore added in v4.15.0 

func (m *MultiTargetArgumentBuilder) RelativeScore(targetVectors map[string]float32) *MultiTargetArgumentBuilder

func (*MultiTargetArgumentBuilder) RelativeScoreMulti added in v4.16.0 

func (m *MultiTargetArgumentBuilder) RelativeScoreMulti(targetVectors map[string][]float32) *MultiTargetArgumentBuilder

func (*MultiTargetArgumentBuilder) Sum added in v4.15.0 

func (m *MultiTargetArgumentBuilder) Sum(targetVectors ...string) *MultiTargetArgumentBuilder

type NearAudioArgumentBuilder added in v4.10.0 

type NearAudioArgumentBuilder struct {
	// contains filtered or unexported fields
}

func (*NearAudioArgumentBuilder) WithAudio added in v4.10.0 

func (b *NearAudioArgumentBuilder) WithAudio(audio string) *NearAudioArgumentBuilder

WithAudio base64 encoded audio

func (*NearAudioArgumentBuilder) WithCertainty added in v4.10.0 

func (b *NearAudioArgumentBuilder) WithCertainty(certainty float32) *NearAudioArgumentBuilder

WithCertainty that is minimally required for an object to be included in the result set

func (*NearAudioArgumentBuilder) WithDistance added in v4.10.0 

func (b *NearAudioArgumentBuilder) WithDistance(distance float32) *NearAudioArgumentBuilder

WithDistance that is minimally required for an object to be included in the result set

func (*NearAudioArgumentBuilder) WithReader added in v4.10.0 

func (b *NearAudioArgumentBuilder) WithReader(audioReader io.Reader) *NearAudioArgumentBuilder

WithReader the audio file

func (*NearAudioArgumentBuilder) WithTargetVectors added in v4.13.0 

func (b *NearAudioArgumentBuilder) WithTargetVectors(targetVectors ...string) *NearAudioArgumentBuilder

WithTargetVectors target vector name

func (*NearAudioArgumentBuilder) WithTargets added in v4.15.0 

func (h *NearAudioArgumentBuilder) WithTargets(targets *MultiTargetArgumentBuilder) *NearAudioArgumentBuilder

WithTargets sets the multi target vectors to be used with hybrid query. This builder takes precedence over WithTargetVectors. So if WithTargets is used, WithTargetVectors will be ignored.

type NearDepthArgumentBuilder added in v4.10.0 

type NearDepthArgumentBuilder struct {
	// contains filtered or unexported fields
}

func (*NearDepthArgumentBuilder) WithCertainty added in v4.10.0 

func (b *NearDepthArgumentBuilder) WithCertainty(certainty float32) *NearDepthArgumentBuilder

WithCertainty that is minimally required for an object to be included in the result set

func (*NearDepthArgumentBuilder) WithDepth added in v4.10.0 

func (b *NearDepthArgumentBuilder) WithDepth(depth string) *NearDepthArgumentBuilder

WithDepth base64 encoded depth

func (*NearDepthArgumentBuilder) WithDistance added in v4.10.0 

func (b *NearDepthArgumentBuilder) WithDistance(distance float32) *NearDepthArgumentBuilder

WithDistance that is minimally required for an object to be included in the result set

func (*NearDepthArgumentBuilder) WithReader added in v4.10.0 

func (b *NearDepthArgumentBuilder) WithReader(depthReader io.Reader) *NearDepthArgumentBuilder

WithReader the depth file

func (*NearDepthArgumentBuilder) WithTargetVectors added in v4.13.0 

func (b *NearDepthArgumentBuilder) WithTargetVectors(targetVectors ...string) *NearDepthArgumentBuilder

WithTargetVectors target vector name

func (*NearDepthArgumentBuilder) WithTargets added in v4.15.0 

func (h *NearDepthArgumentBuilder) WithTargets(targets *MultiTargetArgumentBuilder) *NearDepthArgumentBuilder

WithTargets sets the multi target vectors to be used with hybrid query. This builder takes precedence over WithTargetVectors. So if WithTargets is used, WithTargetVectors will be ignored.

type NearImageArgumentBuilder 

type NearImageArgumentBuilder struct {
	// contains filtered or unexported fields
}

func (*NearImageArgumentBuilder) WithCertainty 

func (b *NearImageArgumentBuilder) WithCertainty(certainty float32) *NearImageArgumentBuilder

WithCertainty that is minimally required for an object to be included in the result set

func (*NearImageArgumentBuilder) WithDistance 

func (b *NearImageArgumentBuilder) WithDistance(distance float32) *NearImageArgumentBuilder

WithDistance that is minimally required for an object to be included in the result set

func (*NearImageArgumentBuilder) WithImage 

func (b *NearImageArgumentBuilder) WithImage(image string) *NearImageArgumentBuilder

WithImage base64 encoded image

func (*NearImageArgumentBuilder) WithReader 

func (b *NearImageArgumentBuilder) WithReader(imageReader io.Reader) *NearImageArgumentBuilder

WithReader the image file

func (*NearImageArgumentBuilder) WithTargetVectors added in v4.13.0 

func (b *NearImageArgumentBuilder) WithTargetVectors(targetVectors ...string) *NearImageArgumentBuilder

WithTargetVectors target vector name

func (*NearImageArgumentBuilder) WithTargets added in v4.15.0 

func (h *NearImageArgumentBuilder) WithTargets(targets *MultiTargetArgumentBuilder) *NearImageArgumentBuilder

WithTargets sets the multi target vectors to be used with hybrid query. This builder takes precedence over WithTargetVectors. So if WithTargets is used, WithTargetVectors will be ignored.

type NearImuArgumentBuilder added in v4.10.0 

type NearImuArgumentBuilder struct {
	// contains filtered or unexported fields
}

func (*NearImuArgumentBuilder) WithCertainty added in v4.10.0 

func (b *NearImuArgumentBuilder) WithCertainty(certainty float32) *NearImuArgumentBuilder

WithCertainty that is minimally required for an object to be included in the result set

func (*NearImuArgumentBuilder) WithDistance added in v4.10.0 

func (b *NearImuArgumentBuilder) WithDistance(distance float32) *NearImuArgumentBuilder

WithDistance that is minimally required for an object to be included in the result set

func (*NearImuArgumentBuilder) WithImu added in v4.10.0 

func (b *NearImuArgumentBuilder) WithImu(imu string) *NearImuArgumentBuilder

WithImu base64 encoded imu

func (*NearImuArgumentBuilder) WithReader added in v4.10.0 

func (b *NearImuArgumentBuilder) WithReader(imuReader io.Reader) *NearImuArgumentBuilder

WithReader the imu file

func (*NearImuArgumentBuilder) WithTargetVectors added in v4.13.0 

func (b *NearImuArgumentBuilder) WithTargetVectors(targetVectors ...string) *NearImuArgumentBuilder

WithTargetVectors target vector name

func (*NearImuArgumentBuilder) WithTargets added in v4.15.0 

func (h *NearImuArgumentBuilder) WithTargets(targets *MultiTargetArgumentBuilder) *NearImuArgumentBuilder

WithTargets sets the multi target vectors to be used with hybrid query. This builder takes precedence over WithTargetVectors. So if WithTargets is used, WithTargetVectors will be ignored.

type NearObjectArgumentBuilder 

type NearObjectArgumentBuilder struct {
	// contains filtered or unexported fields
}

func (*NearObjectArgumentBuilder) WithBeacon 

func (e *NearObjectArgumentBuilder) WithBeacon(beacon string) *NearObjectArgumentBuilder

WithBeacon the beacon of the object

func (*NearObjectArgumentBuilder) WithCertainty 

func (e *NearObjectArgumentBuilder) WithCertainty(certainty float32) *NearObjectArgumentBuilder

WithCertainty that is minimally required for an object to be included in the result set

func (*NearObjectArgumentBuilder) WithDistance 

func (e *NearObjectArgumentBuilder) WithDistance(distance float32) *NearObjectArgumentBuilder

WithDistance that is minimally required for an object to be included in the result set

func (*NearObjectArgumentBuilder) WithID 

func (e *NearObjectArgumentBuilder) WithID(id string) *NearObjectArgumentBuilder

WithID the id of the object

func (*NearObjectArgumentBuilder) WithTargetVectors added in v4.13.0 

func (e *NearObjectArgumentBuilder) WithTargetVectors(targetVectors ...string) *NearObjectArgumentBuilder

WithTargetVectors target vector name

func (*NearObjectArgumentBuilder) WithTargets added in v4.15.0 

func (h *NearObjectArgumentBuilder) WithTargets(targets *MultiTargetArgumentBuilder) *NearObjectArgumentBuilder

WithTargets sets the multi target vectors to be used with hybrid query. This builder takes precedence over WithTargetVectors. So if WithTargets is used, WithTargetVectors will be ignored.

type NearTextArgumentBuilder 

type NearTextArgumentBuilder struct {
	// contains filtered or unexported fields
}

func (*NearTextArgumentBuilder) WithAutocorrect 

func (e *NearTextArgumentBuilder) WithAutocorrect(autocorrect bool) *NearTextArgumentBuilder

WithAutocorrect this is a setting enabling autocorrect of the concepts texts

func (*NearTextArgumentBuilder) WithCertainty 

func (e *NearTextArgumentBuilder) WithCertainty(certainty float32) *NearTextArgumentBuilder

WithCertainty that is minimally required for an object to be included in the result set

func (*NearTextArgumentBuilder) WithConcepts 

func (e *NearTextArgumentBuilder) WithConcepts(concepts []string) *NearTextArgumentBuilder

WithConcepts the result is based on

func (*NearTextArgumentBuilder) WithDistance 

func (e *NearTextArgumentBuilder) WithDistance(distance float32) *NearTextArgumentBuilder

WithDistance that is minimally required for an object to be included in the result set

func (*NearTextArgumentBuilder) WithMoveAwayFrom 

func (e *NearTextArgumentBuilder) WithMoveAwayFrom(parameters *MoveParameters) *NearTextArgumentBuilder

WithMoveAwayFrom specific concept

func (*NearTextArgumentBuilder) WithMoveTo 

func (e *NearTextArgumentBuilder) WithMoveTo(parameters *MoveParameters) *NearTextArgumentBuilder

WithMoveTo specific concept

func (*NearTextArgumentBuilder) WithTargetVectors added in v4.13.0 

func (e *NearTextArgumentBuilder) WithTargetVectors(targetVectors ...string) *NearTextArgumentBuilder

WithTargetVectors target vector name

func (*NearTextArgumentBuilder) WithTargets added in v4.15.0 

func (h *NearTextArgumentBuilder) WithTargets(targets *MultiTargetArgumentBuilder) *NearTextArgumentBuilder

WithTargets sets the multi target vectors to be used with hybrid query. This builder takes precedence over WithTargetVectors. So if WithTargets is used, WithTargetVectors will be ignored.

type NearThermalArgumentBuilder added in v4.10.0 

type NearThermalArgumentBuilder struct {
	// contains filtered or unexported fields
}

func (*NearThermalArgumentBuilder) WithCertainty added in v4.10.0 

func (b *NearThermalArgumentBuilder) WithCertainty(certainty float32) *NearThermalArgumentBuilder

WithCertainty that is minimally required for an object to be included in the result set

func (*NearThermalArgumentBuilder) WithDistance added in v4.10.0 

func (b *NearThermalArgumentBuilder) WithDistance(distance float32) *NearThermalArgumentBuilder

WithDistance that is minimally required for an object to be included in the result set

func (*NearThermalArgumentBuilder) WithReader added in v4.10.0 

func (b *NearThermalArgumentBuilder) WithReader(thermalReader io.Reader) *NearThermalArgumentBuilder

WithReader the thermal file

func (*NearThermalArgumentBuilder) WithTargetVectors added in v4.13.0 

func (b *NearThermalArgumentBuilder) WithTargetVectors(targetVectors ...string) *NearThermalArgumentBuilder

WithTargetVectors target vector name

func (*NearThermalArgumentBuilder) WithTargets added in v4.15.0 

func (h *NearThermalArgumentBuilder) WithTargets(targets *MultiTargetArgumentBuilder) *NearThermalArgumentBuilder

WithTargets sets the multi target vectors to be used with hybrid query. This builder takes precedence over WithTargetVectors. So if WithTargets is used, WithTargetVectors will be ignored.

func (*NearThermalArgumentBuilder) WithThermal added in v4.10.0 

func (b *NearThermalArgumentBuilder) WithThermal(thermal string) *NearThermalArgumentBuilder

WithThermal base64 encoded thermal

type NearVectorArgumentBuilder 

type NearVectorArgumentBuilder struct {
	// contains filtered or unexported fields
}

func (*NearVectorArgumentBuilder) WithCertainty 

func (b *NearVectorArgumentBuilder) WithCertainty(certainty float32) *NearVectorArgumentBuilder

WithCertainty that is minimally required for an object to be included in the result set

func (*NearVectorArgumentBuilder) WithDistance 

func (b *NearVectorArgumentBuilder) WithDistance(distance float32) *NearVectorArgumentBuilder

WithDistance that is minimally required for an object to be included in the result set

func (*NearVectorArgumentBuilder) WithTargetVectors added in v4.13.0 

func (b *NearVectorArgumentBuilder) WithTargetVectors(targetVectors ...string) *NearVectorArgumentBuilder

WithTargetVectors target vector name

func (*NearVectorArgumentBuilder) WithTargets added in v4.15.0 

func (b *NearVectorArgumentBuilder) WithTargets(targets *MultiTargetArgumentBuilder) *NearVectorArgumentBuilder

WithTargets sets the multi target vectors to be used with hybrid query. This builder method takes precedence over WithTargetVectors. So if WithTargets is used, WithTargetVectors will be ignored.

func (*NearVectorArgumentBuilder) WithVector 

func (b *NearVectorArgumentBuilder) WithVector(vector []float32) *NearVectorArgumentBuilder

WithVector sets the search vector to be used in query

func (*NearVectorArgumentBuilder) WithVectorPerTarget added in v4.15.0 

func (b *NearVectorArgumentBuilder) WithVectorPerTarget(vectorPerTarget map[string][]float32) *NearVectorArgumentBuilder

WithVectorPerTarget sets the search vector per target to be used in a multi target search query. This builder method takes precedence over WithVector. So if WithVectorPerTarget is used, WithVector will be ignored.

func (*NearVectorArgumentBuilder) WithVectorsPerTarget added in v4.16.0 

func (b *NearVectorArgumentBuilder) WithVectorsPerTarget(vectorPerTarget map[string][][]float32) *NearVectorArgumentBuilder

WithVectorsPerTarget sets the search vector per target to be used in a multi target search query. This builder method takes precedence over WithVector and WithVectorPerTarget. So if WithVectorsPerTarget is used, WithVector and WithVectorPerTarget will be ignored.

type NearVideoArgumentBuilder added in v4.10.0 

type NearVideoArgumentBuilder struct {
	// contains filtered or unexported fields
}

func (*NearVideoArgumentBuilder) WithCertainty added in v4.10.0 

func (b *NearVideoArgumentBuilder) WithCertainty(certainty float32) *NearVideoArgumentBuilder

WithCertainty that is minimally required for an object to be included in the result set

func (*NearVideoArgumentBuilder) WithDistance added in v4.10.0 

func (b *NearVideoArgumentBuilder) WithDistance(distance float32) *NearVideoArgumentBuilder

WithDistance that is minimally required for an object to be included in the result set

func (*NearVideoArgumentBuilder) WithReader added in v4.10.0 

func (b *NearVideoArgumentBuilder) WithReader(videoReader io.Reader) *NearVideoArgumentBuilder

WithReader the video file

func (*NearVideoArgumentBuilder) WithTargetVectors added in v4.13.0 

func (b *NearVideoArgumentBuilder) WithTargetVectors(targetVectors ...string) *NearVideoArgumentBuilder

WithTargetVectors target vector name

func (*NearVideoArgumentBuilder) WithTargets added in v4.15.0 

func (h *NearVideoArgumentBuilder) WithTargets(targets *MultiTargetArgumentBuilder) *NearVideoArgumentBuilder

WithTargets sets the multi target vectors to be used with hybrid query. This builder takes precedence over WithTargetVectors. So if WithTargets is used, WithTargetVectors will be ignored.

func (*NearVideoArgumentBuilder) WithVideo added in v4.10.0 

func (b *NearVideoArgumentBuilder) WithVideo(video string) *NearVideoArgumentBuilder

WithVideo base64 encoded video

type Raw 

type Raw struct {
	// contains filtered or unexported fields
}

Raw for accepting a prebuilt query from the user

func (*Raw) Do 

func (gql *Raw) Do(ctx context.Context) (*models.GraphQLResponse, error)

Do execute the GraphQL query

func (*Raw) WithQuery 

func (b *Raw) WithQuery(query string) *Raw

WithQuery the query string

type Sort 

type Sort struct {
	Path  []string
	Order SortOrder
}

type SortBuilder 

type SortBuilder struct {
	// contains filtered or unexported fields
}

type SortOrder 

type SortOrder string

SortOrder used in Sort Argument builder 

const (
	// Asc ascending sort order
	Asc SortOrder = "asc"

	// Desc descending sort order
	Desc SortOrder = "desc"
)

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.