Class: Vellum::HkunlpInstructorXlVectorizer

Inherits:
Object
  • Object
show all
Defined in:
lib/vellum_ai/types/hkunlp_instructor_xl_vectorizer.rb

Overview

Vectorizer for hkunlp/instructor-xl.

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(model_name:, config:, additional_properties: nil) ⇒ Vellum::HkunlpInstructorXlVectorizer

Parameters:

  • model_name (String)
  • config (Vellum::InstructorVectorizerConfig)
  • additional_properties (OpenStruct) (defaults to: nil) —

    Additional properties unmapped to the current class definition



25
26
27
28
29
30
 
# File 'lib/vellum_ai/types/hkunlp_instructor_xl_vectorizer.rb', line 25

def initialize(model_name:, config:, additional_properties: nil)
  @model_name = model_name
  @config = config
  @additional_properties = additional_properties
  @_field_set = { "model_name": model_name, "config": config }
end

Instance Attribute Details

#additional_properties ⇒ OpenStruct (readonly)

Returns Additional properties unmapped to the current class definition.

Returns:

  • (OpenStruct) —

    Additional properties unmapped to the current class definition



14
15
16
 
# File 'lib/vellum_ai/types/hkunlp_instructor_xl_vectorizer.rb', line 14

def additional_properties
  @additional_properties
end

#config ⇒ Vellum::InstructorVectorizerConfig (readonly)

Returns:



12
13
14
 
# File 'lib/vellum_ai/types/hkunlp_instructor_xl_vectorizer.rb', line 12

def config
  @config
end

#model_name ⇒ String (readonly)

Returns:

  • (String) 


10
11
12
 
# File 'lib/vellum_ai/types/hkunlp_instructor_xl_vectorizer.rb', line 10

def model_name
  @model_name
end

Class Method Details

.from_json(json_object:) ⇒ Vellum::HkunlpInstructorXlVectorizer

Parameters:

  • json_object (String)

Returns:



35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/vellum_ai/types/hkunlp_instructor_xl_vectorizer.rb', line 35

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  model_name = parsed_json["model_name"]
  unless parsed_json["config"].nil?
    config = parsed_json["config"].to_json
    config = Vellum::InstructorVectorizerConfig.from_json(json_object: config)
  else
    config = nil
  end
  new(
    model_name: model_name,
    config: config,
    additional_properties: struct
  )
end

.validate_raw(obj:) ⇒ Void

Parameters:

  • obj (Object)

Returns:

  • (Void) 


63
64
65
66
 
# File 'lib/vellum_ai/types/hkunlp_instructor_xl_vectorizer.rb', line 63

def self.validate_raw(obj:)
  obj.model_name.is_a?(String) != false || raise("Passed value for field obj.model_name is not the expected type, validation failed.")
  Vellum::InstructorVectorizerConfig.validate_raw(obj: obj.config)
end

Instance Method Details

#to_json ⇒ String

Returns:

  • (String) 


54
55
56
 
# File 'lib/vellum_ai/types/hkunlp_instructor_xl_vectorizer.rb', line 54

def to_json
  @_field_set&.to_json
end