Class: Vellum::InstructorVectorizerConfig

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

Overview

Configuration for using an Instructor vectorizer.

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(instruction_domain:, instruction_query_text_type:, instruction_document_text_type:, additional_properties: nil) ⇒ Vellum::InstructorVectorizerConfig

Parameters:

  • instruction_domain (String)
  • instruction_query_text_type (String)
  • instruction_document_text_type (String)
  • additional_properties (OpenStruct) (defaults to: nil) —

    Additional properties unmapped to the current class definition



27
28
29
30
31
32
33
 
# File 'lib/vellum_ai/types/instructor_vectorizer_config.rb', line 27

def initialize(instruction_domain:, instruction_query_text_type:, instruction_document_text_type:, additional_properties: nil)
  @instruction_domain = instruction_domain
  @instruction_query_text_type = instruction_query_text_type
  @instruction_document_text_type = instruction_document_text_type
  @additional_properties = additional_properties
  @_field_set = { "instruction_domain": instruction_domain, "instruction_query_text_type": instruction_query_text_type, "instruction_document_text_type": instruction_document_text_type }
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



15
16
17
 
# File 'lib/vellum_ai/types/instructor_vectorizer_config.rb', line 15

def additional_properties
  @additional_properties
end

#instruction_document_text_type ⇒ String (readonly)

Returns:

  • (String) 


13
14
15
 
# File 'lib/vellum_ai/types/instructor_vectorizer_config.rb', line 13

def instruction_document_text_type
  @instruction_document_text_type
end

#instruction_domain ⇒ String (readonly)

Returns:

  • (String) 


9
10
11
 
# File 'lib/vellum_ai/types/instructor_vectorizer_config.rb', line 9

def instruction_domain
  @instruction_domain
end

#instruction_query_text_type ⇒ String (readonly)

Returns:

  • (String) 


11
12
13
 
# File 'lib/vellum_ai/types/instructor_vectorizer_config.rb', line 11

def instruction_query_text_type
  @instruction_query_text_type
end

Class Method Details

.from_json(json_object:) ⇒ Vellum::InstructorVectorizerConfig

Parameters:

  • json_object (String)

Returns:



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

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  instruction_domain = parsed_json["instruction_domain"]
  instruction_query_text_type = parsed_json["instruction_query_text_type"]
  instruction_document_text_type = parsed_json["instruction_document_text_type"]
  new(
    instruction_domain: instruction_domain,
    instruction_query_text_type: instruction_query_text_type,
    instruction_document_text_type: instruction_document_text_type,
    additional_properties: struct
  )
end

.validate_raw(obj:) ⇒ Void

Parameters:

  • obj (Object)

Returns:

  • (Void) 


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

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

Instance Method Details

#to_json ⇒ String

Returns:

  • (String) 


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

def to_json
  @_field_set&.to_json
end