class Qdrant::Api::Document

Overview

WARN: Work-in-progress, unimplemented Text document for embedding. Requires inference infrastructure, unimplemented.

Included Modules

Defined in:

qdrant-api/models/document.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(text : String, model : String, options : DocumentOptions | Nil = nil) #

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


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

[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 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 model : String #

Name of the model used to generate the vector. List of available models depends on a provider.


[View source]
def model=(value : String) #

Name of the model used to generate the vector. List of available models depends on a provider.


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

[View source]
def options : DocumentOptions | Nil #

Optional properties Additional options for the model, will be passed to the inference service as-is. See model cards for available options.


[View source]
def options=(options : DocumentOptions | Nil) #

Optional properties Additional options for the model, will be passed to the inference service as-is. See model cards for available options.


[View source]
def text : String #

Required properties Text of the document. This field will be used as input for the embedding model.


[View source]
def text=(text : String) #

Required properties Text of the document. This field will be used as input for the embedding model.


[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]