Class: Vapi::TrieveKnowledgeBaseCreate

Inherits:
Object
  • Object
show all
Defined in:
lib/vapi_server_sdk/types/trieve_knowledge_base_create.rb

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(type:, chunk_plans:, additional_properties: nil) ⇒ Vapi::TrieveKnowledgeBaseCreate

Parameters:

  • type (String) —

    This is to create a new dataset on Trieve.

  • chunk_plans (Array<Vapi::TrieveKnowledgeBaseChunkPlan>) —

    These are the chunk plans used to create the dataset.

  • additional_properties (OpenStruct) (defaults to: nil) —

    Additional properties unmapped to the current class definition



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

def initialize(type:, chunk_plans:, additional_properties: nil)
  @type = type
  @chunk_plans = chunk_plans
  @additional_properties = additional_properties
  @_field_set = { "type": type, "chunkPlans": chunk_plans }
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/vapi_server_sdk/types/trieve_knowledge_base_create.rb', line 14

def additional_properties
  @additional_properties
end

#chunk_plans ⇒ Array<Vapi::TrieveKnowledgeBaseChunkPlan> (readonly)

Returns These are the chunk plans used to create the dataset.

Returns:



12
13
14
 
# File 'lib/vapi_server_sdk/types/trieve_knowledge_base_create.rb', line 12

def chunk_plans
  @chunk_plans
end

#type ⇒ String (readonly)

Returns This is to create a new dataset on Trieve.

Returns:

  • (String) —

    This is to create a new dataset on Trieve.



10
11
12
 
# File 'lib/vapi_server_sdk/types/trieve_knowledge_base_create.rb', line 10

def type
  @type
end

Class Method Details

.from_json(json_object:) ⇒ Vapi::TrieveKnowledgeBaseCreate

Deserialize a JSON object to an instance of TrieveKnowledgeBaseCreate

Parameters:

  • json_object (String)

Returns:



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

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  type = parsed_json["type"]
  chunk_plans = parsed_json["chunkPlans"]&.map do |item|
    item = item.to_json
    Vapi::TrieveKnowledgeBaseChunkPlan.from_json(json_object: item)
  end
  new(
    type: type,
    chunk_plans: chunk_plans,
    additional_properties: struct
  )
end

.validate_raw(obj:) ⇒ Void

Leveraged for Union-type generation, validate_raw attempts to parse the given

hash and check each fields type against the current object's property
definitions.

Parameters:

  • obj (Object)

Returns:

  • (Void) 


64
65
66
67
 
# File 'lib/vapi_server_sdk/types/trieve_knowledge_base_create.rb', line 64

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

Instance Method Details

#to_json(*_args) ⇒ String

Serialize an instance of TrieveKnowledgeBaseCreate to a JSON object

Returns:

  • (String) 


54
55
56
 
# File 'lib/vapi_server_sdk/types/trieve_knowledge_base_create.rb', line 54

def to_json(*_args)
  @_field_set&.to_json
end