vellum_ai 0.3.15 → 0.14.74

data/lib/vellum_ai/types/folder_entity.rb

@@ -0,0 +1,122 @@
+# frozen_string_literal: true
+require "json"
+require_relative "folder_entity_folder"
+require_relative "folder_entity_prompt_sandbox"
+require_relative "folder_entity_workflow_sandbox"
+require_relative "folder_entity_document_index"
+require_relative "folder_entity_test_suite"
+require_relative "folder_entity_dataset"
+
+module Vellum
+  class FolderEntity
+
+
+# Deserialize a JSON object to an instance of FolderEntity
+    #
+    # @param json_object [String] 
+    # @return [Vellum::FolderEntity]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      begin
+        Vellum::FolderEntityFolder.validate_raw(obj: struct)
+        unless struct.nil?
+  return Vellum::FolderEntityFolder.from_json(json_object: struct)
+else
+  return nil
+end
+      rescue StandardError
+        # noop
+      end
+      begin
+        Vellum::FolderEntityPromptSandbox.validate_raw(obj: struct)
+        unless struct.nil?
+  return Vellum::FolderEntityPromptSandbox.from_json(json_object: struct)
+else
+  return nil
+end
+      rescue StandardError
+        # noop
+      end
+      begin
+        Vellum::FolderEntityWorkflowSandbox.validate_raw(obj: struct)
+        unless struct.nil?
+  return Vellum::FolderEntityWorkflowSandbox.from_json(json_object: struct)
+else
+  return nil
+end
+      rescue StandardError
+        # noop
+      end
+      begin
+        Vellum::FolderEntityDocumentIndex.validate_raw(obj: struct)
+        unless struct.nil?
+  return Vellum::FolderEntityDocumentIndex.from_json(json_object: struct)
+else
+  return nil
+end
+      rescue StandardError
+        # noop
+      end
+      begin
+        Vellum::FolderEntityTestSuite.validate_raw(obj: struct)
+        unless struct.nil?
+  return Vellum::FolderEntityTestSuite.from_json(json_object: struct)
+else
+  return nil
+end
+      rescue StandardError
+        # noop
+      end
+      begin
+        Vellum::FolderEntityDataset.validate_raw(obj: struct)
+        unless struct.nil?
+  return Vellum::FolderEntityDataset.from_json(json_object: struct)
+else
+  return nil
+end
+      rescue StandardError
+        # noop
+      end
+ return struct
+    end
+# 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.
+    #
+    # @param obj [Object] 
+    # @return [Void]
+    def self.validate_raw(obj:)
+      begin
+        return Vellum::FolderEntityFolder.validate_raw(obj: obj)
+      rescue StandardError
+        # noop
+      end
+      begin
+        return Vellum::FolderEntityPromptSandbox.validate_raw(obj: obj)
+      rescue StandardError
+        # noop
+      end
+      begin
+        return Vellum::FolderEntityWorkflowSandbox.validate_raw(obj: obj)
+      rescue StandardError
+        # noop
+      end
+      begin
+        return Vellum::FolderEntityDocumentIndex.validate_raw(obj: obj)
+      rescue StandardError
+        # noop
+      end
+      begin
+        return Vellum::FolderEntityTestSuite.validate_raw(obj: obj)
+      rescue StandardError
+        # noop
+      end
+      begin
+        return Vellum::FolderEntityDataset.validate_raw(obj: obj)
+      rescue StandardError
+        # noop
+      end
+      raise("Passed value matched no type within the union, validation failed.")
+    end
+  end
+end

data/lib/vellum_ai/types/folder_entity_dataset.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+require_relative "folder_entity_dataset_data"
+require "ostruct"
+require "json"
+
+module Vellum
+# A slim representation of a Dataset, as it exists within a Folder.
+  class FolderEntityDataset
+  # @return [String] 
+    attr_reader :id
+  # @return [String] 
+    attr_reader :type
+  # @return [Vellum::FolderEntityDatasetData] 
+    attr_reader :data
+  # @return [OpenStruct] Additional properties unmapped to the current class definition
+    attr_reader :additional_properties
+  # @return [Object] 
+    attr_reader :_field_set
+    protected :_field_set
+
+    OMIT = Object.new
+
+    # @param id [String] 
+    # @param type [String] 
+    # @param data [Vellum::FolderEntityDatasetData] 
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vellum::FolderEntityDataset]
+    def initialize(id:, type:, data:, additional_properties: nil)
+      @id = id
+      @type = type
+      @data = data
+      @additional_properties = additional_properties
+      @_field_set = { "id": id, "type": type, "data": data }
+    end
+# Deserialize a JSON object to an instance of FolderEntityDataset
+    #
+    # @param json_object [String] 
+    # @return [Vellum::FolderEntityDataset]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      id = parsed_json["id"]
+      type = parsed_json["type"]
+      unless parsed_json["data"].nil?
+        data = parsed_json["data"].to_json
+        data = Vellum::FolderEntityDatasetData.from_json(json_object: data)
+      else
+        data = nil
+      end
+      new(
+        id: id,
+        type: type,
+        data: data,
+        additional_properties: struct
+      )
+    end
+# Serialize an instance of FolderEntityDataset to a JSON object
+    #
+    # @return [String]
+    def to_json
+      @_field_set&.to_json
+    end
+# 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.
+    #
+    # @param obj [Object] 
+    # @return [Void]
+    def self.validate_raw(obj:)
+      obj.id.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
+      obj.type.is_a?(String) != false || raise("Passed value for field obj.type is not the expected type, validation failed.")
+      Vellum::FolderEntityDatasetData.validate_raw(obj: obj.data)
+    end
+  end
+end

data/lib/vellum_ai/types/folder_entity_dataset_data.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+require "date"
+require "date"
+require "ostruct"
+require "json"
+
+module Vellum
+  class FolderEntityDatasetData
+  # @return [String] 
+    attr_reader :id
+  # @return [String] 
+    attr_reader :label
+  # @return [String] 
+    attr_reader :name
+  # @return [String] 
+    attr_reader :description
+  # @return [DateTime] 
+    attr_reader :created
+  # @return [DateTime] 
+    attr_reader :modified
+  # @return [OpenStruct] Additional properties unmapped to the current class definition
+    attr_reader :additional_properties
+  # @return [Object] 
+    attr_reader :_field_set
+    protected :_field_set
+
+    OMIT = Object.new
+
+    # @param id [String] 
+    # @param label [String] 
+    # @param name [String] 
+    # @param description [String] 
+    # @param created [DateTime] 
+    # @param modified [DateTime] 
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vellum::FolderEntityDatasetData]
+    def initialize(id:, label:, name:, description: OMIT, created:, modified:, additional_properties: nil)
+      @id = id
+      @label = label
+      @name = name
+      @description = description if description != OMIT
+      @created = created
+      @modified = modified
+      @additional_properties = additional_properties
+      @_field_set = { "id": id, "label": label, "name": name, "description": description, "created": created, "modified": modified }.reject do | _k, v |
+  v == OMIT
+end
+    end
+# Deserialize a JSON object to an instance of FolderEntityDatasetData
+    #
+    # @param json_object [String] 
+    # @return [Vellum::FolderEntityDatasetData]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      id = parsed_json["id"]
+      label = parsed_json["label"]
+      name = parsed_json["name"]
+      description = parsed_json["description"]
+      created = unless parsed_json["created"].nil?
+  DateTime.parse(parsed_json["created"])
+else
+  nil
+end
+      modified = unless parsed_json["modified"].nil?
+  DateTime.parse(parsed_json["modified"])
+else
+  nil
+end
+      new(
+        id: id,
+        label: label,
+        name: name,
+        description: description,
+        created: created,
+        modified: modified,
+        additional_properties: struct
+      )
+    end
+# Serialize an instance of FolderEntityDatasetData to a JSON object
+    #
+    # @return [String]
+    def to_json
+      @_field_set&.to_json
+    end
+# 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.
+    #
+    # @param obj [Object] 
+    # @return [Void]
+    def self.validate_raw(obj:)
+      obj.id.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
+      obj.label.is_a?(String) != false || raise("Passed value for field obj.label is not the expected type, validation failed.")
+      obj.name.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
+      obj.description&.is_a?(String) != false || raise("Passed value for field obj.description is not the expected type, validation failed.")
+      obj.created.is_a?(DateTime) != false || raise("Passed value for field obj.created is not the expected type, validation failed.")
+      obj.modified.is_a?(DateTime) != false || raise("Passed value for field obj.modified is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/vellum_ai/types/folder_entity_document_index.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+require_relative "folder_entity_document_index_data"
+require "ostruct"
+require "json"
+
+module Vellum
+# A slim representation of a Document Index, as it exists within a Folder.
+  class FolderEntityDocumentIndex
+  # @return [String] 
+    attr_reader :id
+  # @return [String] 
+    attr_reader :type
+  # @return [Vellum::FolderEntityDocumentIndexData] 
+    attr_reader :data
+  # @return [OpenStruct] Additional properties unmapped to the current class definition
+    attr_reader :additional_properties
+  # @return [Object] 
+    attr_reader :_field_set
+    protected :_field_set
+
+    OMIT = Object.new
+
+    # @param id [String] 
+    # @param type [String] 
+    # @param data [Vellum::FolderEntityDocumentIndexData] 
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vellum::FolderEntityDocumentIndex]
+    def initialize(id:, type:, data:, additional_properties: nil)
+      @id = id
+      @type = type
+      @data = data
+      @additional_properties = additional_properties
+      @_field_set = { "id": id, "type": type, "data": data }
+    end
+# Deserialize a JSON object to an instance of FolderEntityDocumentIndex
+    #
+    # @param json_object [String] 
+    # @return [Vellum::FolderEntityDocumentIndex]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      id = parsed_json["id"]
+      type = parsed_json["type"]
+      unless parsed_json["data"].nil?
+        data = parsed_json["data"].to_json
+        data = Vellum::FolderEntityDocumentIndexData.from_json(json_object: data)
+      else
+        data = nil
+      end
+      new(
+        id: id,
+        type: type,
+        data: data,
+        additional_properties: struct
+      )
+    end
+# Serialize an instance of FolderEntityDocumentIndex to a JSON object
+    #
+    # @return [String]
+    def to_json
+      @_field_set&.to_json
+    end
+# 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.
+    #
+    # @param obj [Object] 
+    # @return [Void]
+    def self.validate_raw(obj:)
+      obj.id.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
+      obj.type.is_a?(String) != false || raise("Passed value for field obj.type is not the expected type, validation failed.")
+      Vellum::FolderEntityDocumentIndexData.validate_raw(obj: obj.data)
+    end
+  end
+end

data/lib/vellum_ai/types/folder_entity_document_index_data.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+require "date"
+require "date"
+require_relative "entity_status"
+require_relative "document_index_indexing_config"
+require "ostruct"
+require "json"
+
+module Vellum
+  class FolderEntityDocumentIndexData
+  # @return [String] 
+    attr_reader :id
+  # @return [String] 
+    attr_reader :label
+  # @return [DateTime] 
+    attr_reader :created
+  # @return [DateTime] 
+    attr_reader :modified
+  # @return [Vellum::EntityStatus] 
+    attr_reader :status
+  # @return [Vellum::DocumentIndexIndexingConfig] 
+    attr_reader :indexing_config
+  # @return [OpenStruct] Additional properties unmapped to the current class definition
+    attr_reader :additional_properties
+  # @return [Object] 
+    attr_reader :_field_set
+    protected :_field_set
+
+    OMIT = Object.new
+
+    # @param id [String] 
+    # @param label [String] 
+    # @param created [DateTime] 
+    # @param modified [DateTime] 
+    # @param status [Vellum::EntityStatus] 
+    # @param indexing_config [Vellum::DocumentIndexIndexingConfig] 
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vellum::FolderEntityDocumentIndexData]
+    def initialize(id:, label:, created:, modified:, status:, indexing_config:, additional_properties: nil)
+      @id = id
+      @label = label
+      @created = created
+      @modified = modified
+      @status = status
+      @indexing_config = indexing_config
+      @additional_properties = additional_properties
+      @_field_set = { "id": id, "label": label, "created": created, "modified": modified, "status": status, "indexing_config": indexing_config }
+    end
+# Deserialize a JSON object to an instance of FolderEntityDocumentIndexData
+    #
+    # @param json_object [String] 
+    # @return [Vellum::FolderEntityDocumentIndexData]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      id = parsed_json["id"]
+      label = parsed_json["label"]
+      created = unless parsed_json["created"].nil?
+  DateTime.parse(parsed_json["created"])
+else
+  nil
+end
+      modified = unless parsed_json["modified"].nil?
+  DateTime.parse(parsed_json["modified"])
+else
+  nil
+end
+      status = parsed_json["status"]
+      unless parsed_json["indexing_config"].nil?
+        indexing_config = parsed_json["indexing_config"].to_json
+        indexing_config = Vellum::DocumentIndexIndexingConfig.from_json(json_object: indexing_config)
+      else
+        indexing_config = nil
+      end
+      new(
+        id: id,
+        label: label,
+        created: created,
+        modified: modified,
+        status: status,
+        indexing_config: indexing_config,
+        additional_properties: struct
+      )
+    end
+# Serialize an instance of FolderEntityDocumentIndexData to a JSON object
+    #
+    # @return [String]
+    def to_json
+      @_field_set&.to_json
+    end
+# 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.
+    #
+    # @param obj [Object] 
+    # @return [Void]
+    def self.validate_raw(obj:)
+      obj.id.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
+      obj.label.is_a?(String) != false || raise("Passed value for field obj.label is not the expected type, validation failed.")
+      obj.created.is_a?(DateTime) != false || raise("Passed value for field obj.created is not the expected type, validation failed.")
+      obj.modified.is_a?(DateTime) != false || raise("Passed value for field obj.modified is not the expected type, validation failed.")
+      obj.status.is_a?(Vellum::EntityStatus) != false || raise("Passed value for field obj.status is not the expected type, validation failed.")
+      Vellum::DocumentIndexIndexingConfig.validate_raw(obj: obj.indexing_config)
+    end
+  end
+end

data/lib/vellum_ai/types/folder_entity_folder.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+require_relative "folder_entity_folder_data"
+require "ostruct"
+require "json"
+
+module Vellum
+# A slim representation of a Folder, as it exists within another Folder.
+  class FolderEntityFolder
+  # @return [String] 
+    attr_reader :id
+  # @return [String] 
+    attr_reader :type
+  # @return [Vellum::FolderEntityFolderData] 
+    attr_reader :data
+  # @return [OpenStruct] Additional properties unmapped to the current class definition
+    attr_reader :additional_properties
+  # @return [Object] 
+    attr_reader :_field_set
+    protected :_field_set
+
+    OMIT = Object.new
+
+    # @param id [String] 
+    # @param type [String] 
+    # @param data [Vellum::FolderEntityFolderData] 
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vellum::FolderEntityFolder]
+    def initialize(id:, type:, data:, additional_properties: nil)
+      @id = id
+      @type = type
+      @data = data
+      @additional_properties = additional_properties
+      @_field_set = { "id": id, "type": type, "data": data }
+    end
+# Deserialize a JSON object to an instance of FolderEntityFolder
+    #
+    # @param json_object [String] 
+    # @return [Vellum::FolderEntityFolder]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      id = parsed_json["id"]
+      type = parsed_json["type"]
+      unless parsed_json["data"].nil?
+        data = parsed_json["data"].to_json
+        data = Vellum::FolderEntityFolderData.from_json(json_object: data)
+      else
+        data = nil
+      end
+      new(
+        id: id,
+        type: type,
+        data: data,
+        additional_properties: struct
+      )
+    end
+# Serialize an instance of FolderEntityFolder to a JSON object
+    #
+    # @return [String]
+    def to_json
+      @_field_set&.to_json
+    end
+# 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.
+    #
+    # @param obj [Object] 
+    # @return [Void]
+    def self.validate_raw(obj:)
+      obj.id.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
+      obj.type.is_a?(String) != false || raise("Passed value for field obj.type is not the expected type, validation failed.")
+      Vellum::FolderEntityFolderData.validate_raw(obj: obj.data)
+    end
+  end
+end

data/lib/vellum_ai/types/folder_entity_folder_data.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+require "date"
+require "date"
+require "ostruct"
+require "json"
+
+module Vellum
+  class FolderEntityFolderData
+  # @return [String] 
+    attr_reader :id
+  # @return [String] 
+    attr_reader :label
+  # @return [DateTime] 
+    attr_reader :created
+  # @return [DateTime] 
+    attr_reader :modified
+  # @return [Boolean] 
+    attr_reader :has_contents
+  # @return [OpenStruct] Additional properties unmapped to the current class definition
+    attr_reader :additional_properties
+  # @return [Object] 
+    attr_reader :_field_set
+    protected :_field_set
+
+    OMIT = Object.new
+
+    # @param id [String] 
+    # @param label [String] 
+    # @param created [DateTime] 
+    # @param modified [DateTime] 
+    # @param has_contents [Boolean] 
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vellum::FolderEntityFolderData]
+    def initialize(id:, label:, created:, modified:, has_contents:, additional_properties: nil)
+      @id = id
+      @label = label
+      @created = created
+      @modified = modified
+      @has_contents = has_contents
+      @additional_properties = additional_properties
+      @_field_set = { "id": id, "label": label, "created": created, "modified": modified, "has_contents": has_contents }
+    end
+# Deserialize a JSON object to an instance of FolderEntityFolderData
+    #
+    # @param json_object [String] 
+    # @return [Vellum::FolderEntityFolderData]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      id = parsed_json["id"]
+      label = parsed_json["label"]
+      created = unless parsed_json["created"].nil?
+  DateTime.parse(parsed_json["created"])
+else
+  nil
+end
+      modified = unless parsed_json["modified"].nil?
+  DateTime.parse(parsed_json["modified"])
+else
+  nil
+end
+      has_contents = parsed_json["has_contents"]
+      new(
+        id: id,
+        label: label,
+        created: created,
+        modified: modified,
+        has_contents: has_contents,
+        additional_properties: struct
+      )
+    end
+# Serialize an instance of FolderEntityFolderData to a JSON object
+    #
+    # @return [String]
+    def to_json
+      @_field_set&.to_json
+    end
+# 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.
+    #
+    # @param obj [Object] 
+    # @return [Void]
+    def self.validate_raw(obj:)
+      obj.id.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
+      obj.label.is_a?(String) != false || raise("Passed value for field obj.label is not the expected type, validation failed.")
+      obj.created.is_a?(DateTime) != false || raise("Passed value for field obj.created is not the expected type, validation failed.")
+      obj.modified.is_a?(DateTime) != false || raise("Passed value for field obj.modified is not the expected type, validation failed.")
+      obj.has_contents.is_a?(Boolean) != false || raise("Passed value for field obj.has_contents is not the expected type, validation failed.")
+    end
+  end
+end