class
Qdrant::Api::Document
- Qdrant::Api::Document
- Reference
- Object
Overview
WARN: Work-in-progress, unimplemented Text document for embedding. Requires inference infrastructure, unimplemented.
Included Modules
- JSON::Serializable
- Qdrant::Api::Serializable
- Qdrant::Api::Validation
- YAML::Serializable
Defined in:
qdrant-api/models/document.crConstructors
- .new(ctx : YAML::ParseContext, node : YAML::Nodes::Node)
-
.new(text : String, model : String, options : DocumentOptions | Nil = nil)
Initializes the object @param [Hash] attributes Model attributes in the form of hash
- .new(pull : JSON::PullParser)
- .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
trueif this reference is the same as other. -
#hash(hasher)
See
Object#hash(hasher) -
#list_invalid_properties
Show invalid properties with the reasons.
-
#model : String
Name of the model used to generate the vector.
-
#model=(value : String)
Name of the model used to generate the vector.
- #model_validation_error(value) : String | Nil
-
#options : DocumentOptions | Nil
Optional properties Additional options for the model, will be passed to the inference service as-is.
-
#options=(options : DocumentOptions | Nil)
Optional properties Additional options for the model, will be passed to the inference service as-is.
-
#text : String
Required properties Text of the document.
-
#text=(text : String)
Required properties Text of the document.
-
#valid?
Check to see if the all the properties in the model are valid @return true if the model is valid
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
Initializes the object @param [Hash] attributes Model attributes in the form of hash
Instance Method Detail
Returns true if this reference is the same as other. Invokes same?.
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
Name of the model used to generate the vector. List of available models depends on a provider.
Name of the model used to generate the vector. List of available models depends on a provider.
Optional properties Additional options for the model, will be passed to the inference service as-is. See model cards for available options.
Optional properties Additional options for the model, will be passed to the inference service as-is. See model cards for available options.
Required properties Text of the document. This field will be used as input for the embedding model.
Required properties Text of the document. This field will be used as input for the embedding model.
Check to see if the all the properties in the model are valid @return true if the model is valid