class Qdrant::Api::TextIndexParams

Included Modules

Defined in:

qdrant-api/models/text_index_params.cr

Constructors

Instance Method Summary

Macros inherited from module Qdrant::Api::Validation

validates(name, klass, nilable, **rules) validates

Instance methods inherited from module Qdrant::Api::Serializable

eql?(other) eql?, to_body : Hash(String, JSON::Any) to_body, to_h : Hash(String, JSON::Any) to_h, to_s(io : IO) : Nil to_s

Constructor Detail

def self.new(ctx : YAML::ParseContext, node : YAML::Nodes::Node) #

[View source]
def self.new(pull : JSON::PullParser) #

[View source]
def self.new(_type : TextIndexType, tokenizer : TokenizerType | Nil = nil, min_token_len : Int32 | Nil = nil, max_token_len : Int32 | Nil = nil, lowercase : Bool | Nil = nil, ascii_folding : Bool | Nil = nil, phrase_matching : Bool | Nil = nil, stopwords : StopwordsInterface | Nil = nil, on_disk : Bool | Nil = nil, stemmer : StemmingAlgorithm | Nil = nil, enable_hnsw : Bool | Nil = nil) #

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


[View source]
def self.new(*, __pull_for_json_serializable pull : JSON::PullParser) #

[View source]
def self.new(*, __context_for_yaml_serializable ctx : YAML::ParseContext, __node_for_yaml_serializable node : YAML::Nodes::Node) #

[View source]

Instance Method Detail

def ==(other : self) #
Description copied from class Reference

Returns true if this reference is the same as other. Invokes same?.


def _type : TextIndexType #

Required properties


[View source]
def _type=(_type : TextIndexType) #

Required properties


[View source]
def ascii_folding : Bool | Nil #

If true, normalize tokens by folding accented characters to ASCII (e.g., "ação" -> "acao"). Default: false.


[View source]
def ascii_folding=(ascii_folding : Bool | Nil) #

If true, normalize tokens by folding accented characters to ASCII (e.g., "ação" -> "acao"). Default: false.


[View source]
def enable_hnsw : Bool | Nil #

Enable HNSW graph building for this payload field. If true, builds additional HNSW links (Need payload_m > 0). Default: true.


[View source]
def enable_hnsw=(enable_hnsw : Bool | Nil) #

Enable HNSW graph building for this payload field. If true, builds additional HNSW links (Need payload_m > 0). Default: true.


[View source]
def hash(hasher) #
Description copied from class Reference

See Object#hash(hasher)


def list_invalid_properties #

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons


[View source]
def lowercase : Bool | Nil #

If true, lowercase all tokens. Default: true.


[View source]
def lowercase=(lowercase : Bool | Nil) #

If true, lowercase all tokens. Default: true.


[View source]
def max_token_len : Int32 | Nil #

Maximum characters to be tokenized.


[View source]
def max_token_len=(value : Int32 | Nil) #

Maximum characters to be tokenized.


[View source]
def max_token_len_validation_error(value) : String | Nil #

[View source]
def min_token_len : Int32 | Nil #

Minimum characters to be tokenized.


[View source]
def min_token_len=(value : Int32 | Nil) #

Minimum characters to be tokenized.


[View source]
def min_token_len_validation_error(value) : String | Nil #

[View source]
def on_disk : Bool | Nil #

If true, store the index on disk. Default: false.


[View source]
def on_disk=(on_disk : Bool | Nil) #

If true, store the index on disk. Default: false.


[View source]
def phrase_matching : Bool | Nil #

If true, support phrase matching. Default: false.


[View source]
def phrase_matching=(phrase_matching : Bool | Nil) #

If true, support phrase matching. Default: false.


[View source]
def stemmer : StemmingAlgorithm | Nil #

Algorithm for stemming. Default: disabled.


[View source]
def stemmer=(stemmer : StemmingAlgorithm | Nil) #

Algorithm for stemming. Default: disabled.


[View source]
def stopwords : StopwordsInterface | Nil #

Ignore this set of tokens. Can select from predefined languages and/or provide a custom set.


[View source]
def stopwords=(stopwords : StopwordsInterface | Nil) #

Ignore this set of tokens. Can select from predefined languages and/or provide a custom set.


[View source]
def tokenizer : TokenizerType | Nil #

Optional properties


[View source]
def tokenizer=(tokenizer : TokenizerType | Nil) #

Optional properties


[View source]
def valid? #

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


[View source]