struct Meilisearch::Crystal::Query

• Meilisearch::Crystal::Query
• Meilisearch::Crystal::Resource
• Struct
• Value
• Object

Overview

A typed POST-search request. Nil fields are omitted from its JSON body.

Defined in:

Constructors

• .new(pull : JSON::PullParser)

  A typed POST-search request.

• .new(q : String | Nil = nil, index_uid : String | Nil = nil, offset : Int32 | Nil = nil, limit : Int32 | Nil = nil, page : Int32 | Nil = nil, hits_per_page : Int32 | Nil = nil, filter : String | Array(String) | Nil = nil, facets : Array(String) | Nil = nil, attributes_to_retrieve : Array(String) | Nil = nil, attributes_to_crop : Array(String) | Nil = nil, crop_length : Int32 | Nil = nil, crop_marker : String | Nil = nil, attributes_to_highlight : Array(String) | Nil = nil, highlight_pre_tag : String | Nil = nil, highlight_post_tag : String | Nil = nil, show_matches_position : Bool | Nil = nil, sort : Array(String) | Nil = nil, matching_strategy : MatchingStrategy | Nil = nil, show_ranking_score : Bool | Nil = nil, show_ranking_score_details : Bool | Nil = nil, ranking_score_threshold : Float64 | Nil = nil, attributes_to_search_on : Array(String) | Nil = nil, hybrid : Hybrid | Nil = nil, vector : Array(Float64) | Nil = nil, retrieve_vectors : Bool | Nil = nil, locales : Array(String) | Nil = nil, federation_options : FederationOptions | Nil = nil, distinct : String | Nil = nil)

Instance Method Summary

• #attributes_to_crop : Array(String) | Nil
• #attributes_to_highlight : Array(String) | Nil
• #attributes_to_retrieve : Array(String) | Nil
• #attributes_to_search_on : Array(String) | Nil
• #crop_length : Int32 | Nil
• #crop_marker : String | Nil
• #distinct : String | Nil
• #facets : Array(String) | Nil
• #federation_options : FederationOptions | Nil
• #filter : String | Array(String) | Nil
• #highlight_post_tag : String | Nil
• #highlight_pre_tag : String | Nil
• #hits_per_page : Int32 | Nil
• #hybrid : Hybrid | Nil
• #index_uid : String | Nil
• #limit : Int32 | Nil
• #locales : Array(String) | Nil
• #matching_strategy : MatchingStrategy | Nil
• #offset : Int32 | Nil
• #page : Int32 | Nil
• #q : String | Nil
• #ranking_score_threshold : Float64 | Nil
• #retrieve_vectors : Bool | Nil
• #show_matches_position : Bool | Nil
• #show_ranking_score : Bool | Nil
• #show_ranking_score_details : Bool | Nil
• #sort : Array(String) | Nil
• #vector : Array(Float64) | Nil

Constructor Detail

Instance Method Detail