class Qdrant::Api::RecommendRequest

• Qdrant::Api::RecommendRequest
• Reference
• Object

Overview

Recommendation request. Provides positive and negative examples of the vectors, which can be ids of points that are already stored in the collection, raw vectors, or even ids and vectors combined. Service should look for the points which are closer to positive examples and at the same time further to negative examples. The concrete way of how to compare negative and positive distances is up to the #strategy chosen.

Included Modules

• JSON::Serializable
• Qdrant::Api::Serializable
• Qdrant::Api::Validation
• YAML::Serializable

Defined in:

qdrant-api/models/recommend_request.cr

Constructors

• .new(ctx : YAML::ParseContext, node : YAML::Nodes::Node)
• .new(pull : JSON::PullParser)
• .new(limit : Int32, shard_key : ShardKeySelector | Nil = nil, positive : Array(RecommendExample) | Nil = nil, negative : Array(RecommendExample) | Nil = nil, strategy : RecommendStrategy | Nil = nil, filter : Filter | Nil = nil, params : SearchParams | Nil = nil, offset : Int32 | Nil = nil, with_payload : WithPayloadInterface | Nil = nil, with_vector : WithVector | Nil = nil, score_threshold : Float32 | Nil = nil, using : String | Nil = nil, lookup_from : LookupLocation | Nil = nil)

  Initializes the object @param [Hash] attributes Model attributes in the form of hash

• .new(*, __pull_for_json_serializable pull : JSON::PullParser)
• .new(*, __context_for_yaml_serializable ctx : YAML::ParseContext, __node_for_yaml_serializable node : YAML::Nodes::Node)

Instance Method Summary

• #==(other : self)

  Returns true if this reference is the same as other.

• #filter : Filter | Nil

  Look only for points which satisfies this conditions

• #filter=(filter : Filter | Nil)

  Look only for points which satisfies this conditions

• #hash(hasher)

  See Object#hash(hasher)

• #limit : Int32

  Required properties Max number of result to return

• #limit=(value : Int32)

  Required properties Max number of result to return

• #limit_validation_error(value) : String | Nil
• #list_invalid_properties

  Show invalid properties with the reasons.

• #lookup_from : LookupLocation | Nil

  The location used to lookup vectors.

• #lookup_from=(lookup_from : LookupLocation | Nil)

  The location used to lookup vectors.

• #negative : Array(RecommendExample) | Nil

  Try to avoid vectors like this

• #negative=(negative : Array(RecommendExample) | Nil)

  Try to avoid vectors like this

• #offset : Int32 | Nil

  Offset of the first result to return.

• #offset=(value : Int32 | Nil)

  Offset of the first result to return.

• #offset_validation_error(value) : String | Nil
• #params : SearchParams | Nil

  Additional search params

• #params=(params : SearchParams | Nil)

  Additional search params

• #positive : Array(RecommendExample) | Nil

  Look for vectors closest to those

• #positive=(positive : Array(RecommendExample) | Nil)

  Look for vectors closest to those

• #score_threshold : Float32 | Nil

  Define a minimal score threshold for the result.

• #score_threshold=(score_threshold : Float32 | Nil)

  Define a minimal score threshold for the result.

• #shard_key : ShardKeySelector | Nil

  Optional properties Specify in which shards to look for the points, if not specified - look in all shards

• #shard_key=(shard_key : ShardKeySelector | Nil)

  Optional properties Specify in which shards to look for the points, if not specified - look in all shards

• #strategy : RecommendStrategy | Nil

  How to use positive and negative examples to find the results

• #strategy=(strategy : RecommendStrategy | Nil)

  How to use positive and negative examples to find the results

• #using : String | Nil

  Define which vector to use for recommendation, if not specified - try to use default vector

• #using=(using : String | Nil)

  Define which vector to use for recommendation, if not specified - try to use default vector

• #valid?

  Check to see if the all the properties in the model are valid @return true if the model is valid

• #with_payload : WithPayloadInterface | Nil

  Select which payload to return with the response.

• #with_payload=(with_payload : WithPayloadInterface | Nil)

  Select which payload to return with the response.

• #with_vector : WithVector | Nil

  Options for specifying which vectors to include into response.

• #with_vector=(with_vector : WithVector | Nil)

  Options for specifying which vectors to include into response.

Constructor Detail

Instance Method Detail