Class: Vellum::OpenAiVectorizerConfig

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

Overview

Configuration for using an OpenAI vectorizer.

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(add_openai_api_key: OMIT, additional_properties: nil) ⇒ Vellum::OpenAiVectorizerConfig

Parameters:

  • add_openai_api_key (Boolean) (defaults to: OMIT)
  • additional_properties (OpenStruct) (defaults to: nil) —

    Additional properties unmapped to the current class definition



21
22
23
24
25
26
27
 
# File 'lib/vellum_ai/types/open_ai_vectorizer_config.rb', line 21

def initialize(add_openai_api_key: OMIT, additional_properties: nil)
  @add_openai_api_key = add_openai_api_key if add_openai_api_key != OMIT
  @additional_properties = additional_properties
  @_field_set = { "add_openai_api_key": add_openai_api_key }.reject do | _k, v |
  v == OMIT
end
end

Instance Attribute Details

#add_openai_api_key ⇒ Boolean (readonly)

Returns:

  • (Boolean) 


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

def add_openai_api_key
  @add_openai_api_key
end

#additional_properties ⇒ OpenStruct (readonly)

Returns Additional properties unmapped to the current class definition.

Returns:

  • (OpenStruct) —

    Additional properties unmapped to the current class definition



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

def additional_properties
  @additional_properties
end

Class Method Details

.from_json(json_object:) ⇒ Vellum::OpenAiVectorizerConfig

Parameters:

  • json_object (String)

Returns:



32
33
34
35
36
37
 
# File 'lib/vellum_ai/types/open_ai_vectorizer_config.rb', line 32

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

.validate_raw(obj:) ⇒ Void

Parameters:

  • obj (Object)

Returns:

  • (Void) 


50
51
52
 
# File 'lib/vellum_ai/types/open_ai_vectorizer_config.rb', line 50

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

Instance Method Details

#to_json ⇒ String

Returns:

  • (String) 


41
42
43
 
# File 'lib/vellum_ai/types/open_ai_vectorizer_config.rb', line 41

def to_json
  @_field_set&.to_json
end