class Qdrant::Api::Image

Overview

WARN: Work-in-progress, unimplemented Image object for embedding. Requires inference infrastructure, unimplemented.

Included Modules

Defined in:

qdrant-api/models/image.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(image : JSON::Any, model : String, options : Hash(String, JSON::Any) | 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 image : JSON::Any #

Required properties Image data: base64 encoded image or an URL


[View source]
def image=(image : JSON::Any) #

Required properties Image data: base64 encoded image or an URL


[View source]
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 : Hash(String, JSON::Any) | Nil #

Optional properties Parameters for the model Values of the parameters are model-specific


[View source]
def options=(options : Hash(String, JSON::Any) | Nil) #

Optional properties Parameters for the model Values of the parameters are model-specific


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