vellum_ai 0.3.15 → 0.14.74

data/lib/vellum_ai/types/folder_entity_prompt_sandbox.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+require_relative "folder_entity_prompt_sandbox_data"
+require "ostruct"
+require "json"
+
+module Vellum
+# A slim representation of a Prompt Sandbox, as it exists within a Folder.
+  class FolderEntityPromptSandbox
+  # @return [String] 
+    attr_reader :id
+  # @return [String] 
+    attr_reader :type
+  # @return [Vellum::FolderEntityPromptSandboxData] 
+    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::FolderEntityPromptSandboxData] 
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vellum::FolderEntityPromptSandbox]
+    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 FolderEntityPromptSandbox
+    #
+    # @param json_object [String] 
+    # @return [Vellum::FolderEntityPromptSandbox]
+    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::FolderEntityPromptSandboxData.from_json(json_object: data)
+      else
+        data = nil
+      end
+      new(
+        id: id,
+        type: type,
+        data: data,
+        additional_properties: struct
+      )
+    end
+# Serialize an instance of FolderEntityPromptSandbox 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::FolderEntityPromptSandboxData.validate_raw(obj: obj.data)
+    end
+  end
+end

data/lib/vellum_ai/types/folder_entity_prompt_sandbox_data.rb

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

data/lib/vellum_ai/types/folder_entity_test_suite.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+require_relative "folder_entity_test_suite_data"
+require "ostruct"
+require "json"
+
+module Vellum
+# A slim representation of a Test Suite, as it exists within a Folder.
+  class FolderEntityTestSuite
+  # @return [String] 
+    attr_reader :id
+  # @return [String] 
+    attr_reader :type
+  # @return [Vellum::FolderEntityTestSuiteData] 
+    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::FolderEntityTestSuiteData] 
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vellum::FolderEntityTestSuite]
+    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 FolderEntityTestSuite
+    #
+    # @param json_object [String] 
+    # @return [Vellum::FolderEntityTestSuite]
+    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::FolderEntityTestSuiteData.from_json(json_object: data)
+      else
+        data = nil
+      end
+      new(
+        id: id,
+        type: type,
+        data: data,
+        additional_properties: struct
+      )
+    end
+# Serialize an instance of FolderEntityTestSuite 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::FolderEntityTestSuiteData.validate_raw(obj: obj.data)
+    end
+  end
+end

data/lib/vellum_ai/types/folder_entity_test_suite_data.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+require "date"
+require "date"
+require_relative "entity_status"
+require "ostruct"
+require "json"
+
+module Vellum
+  class FolderEntityTestSuiteData
+  # @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 [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 additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vellum::FolderEntityTestSuiteData]
+    def initialize(id:, label:, created:, modified:, status:, additional_properties: nil)
+      @id = id
+      @label = label
+      @created = created
+      @modified = modified
+      @status = status
+      @additional_properties = additional_properties
+      @_field_set = { "id": id, "label": label, "created": created, "modified": modified, "status": status }
+    end
+# Deserialize a JSON object to an instance of FolderEntityTestSuiteData
+    #
+    # @param json_object [String] 
+    # @return [Vellum::FolderEntityTestSuiteData]
+    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"]
+      new(
+        id: id,
+        label: label,
+        created: created,
+        modified: modified,
+        status: status,
+        additional_properties: struct
+      )
+    end
+# Serialize an instance of FolderEntityTestSuiteData 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.")
+    end
+  end
+end

data/lib/vellum_ai/types/folder_entity_workflow_sandbox.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+require_relative "folder_entity_workflow_sandbox_data"
+require "ostruct"
+require "json"
+
+module Vellum
+# A slim representation of a Workflow Sandbox, as it exists within a Folder.
+  class FolderEntityWorkflowSandbox
+  # @return [String] 
+    attr_reader :id
+  # @return [String] 
+    attr_reader :type
+  # @return [Vellum::FolderEntityWorkflowSandboxData] 
+    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::FolderEntityWorkflowSandboxData] 
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vellum::FolderEntityWorkflowSandbox]
+    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 FolderEntityWorkflowSandbox
+    #
+    # @param json_object [String] 
+    # @return [Vellum::FolderEntityWorkflowSandbox]
+    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::FolderEntityWorkflowSandboxData.from_json(json_object: data)
+      else
+        data = nil
+      end
+      new(
+        id: id,
+        type: type,
+        data: data,
+        additional_properties: struct
+      )
+    end
+# Serialize an instance of FolderEntityWorkflowSandbox 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::FolderEntityWorkflowSandboxData.validate_raw(obj: obj.data)
+    end
+  end
+end

data/lib/vellum_ai/types/folder_entity_workflow_sandbox_data.rb

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

data/lib/vellum_ai/types/fulfilled_ad_hoc_execute_prompt_event.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+require_relative "prompt_output"
+require_relative "ad_hoc_fulfilled_prompt_execution_meta"
+require "ostruct"
+require "json"
+
+module Vellum
+# The final data event returned indicating that the stream has ended and all final
+#  resolved values from the model can be found.
+  class FulfilledAdHocExecutePromptEvent
+  # @return [String] 
+    attr_reader :state
+  # @return [Array<Vellum::PromptOutput>] 
+    attr_reader :outputs
+  # @return [String] 
+    attr_reader :execution_id
+  # @return [Vellum::AdHocFulfilledPromptExecutionMeta] 
+    attr_reader :meta
+  # @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 state [String] 
+    # @param outputs [Array<Vellum::PromptOutput>] 
+    # @param execution_id [String] 
+    # @param meta [Vellum::AdHocFulfilledPromptExecutionMeta] 
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vellum::FulfilledAdHocExecutePromptEvent]
+    def initialize(state:, outputs:, execution_id:, meta: OMIT, additional_properties: nil)
+      @state = state
+      @outputs = outputs
+      @execution_id = execution_id
+      @meta = meta if meta != OMIT
+      @additional_properties = additional_properties
+      @_field_set = { "state": state, "outputs": outputs, "execution_id": execution_id, "meta": meta }.reject do | _k, v |
+  v == OMIT
+end
+    end
+# Deserialize a JSON object to an instance of FulfilledAdHocExecutePromptEvent
+    #
+    # @param json_object [String] 
+    # @return [Vellum::FulfilledAdHocExecutePromptEvent]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      state = parsed_json["state"]
+      outputs = parsed_json["outputs"]&.map do | item |
+  item = item.to_json
+  Vellum::PromptOutput.from_json(json_object: item)
+end
+      execution_id = parsed_json["execution_id"]
+      unless parsed_json["meta"].nil?
+        meta = parsed_json["meta"].to_json
+        meta = Vellum::AdHocFulfilledPromptExecutionMeta.from_json(json_object: meta)
+      else
+        meta = nil
+      end
+      new(
+        state: state,
+        outputs: outputs,
+        execution_id: execution_id,
+        meta: meta,
+        additional_properties: struct
+      )
+    end
+# Serialize an instance of FulfilledAdHocExecutePromptEvent 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.state.is_a?(String) != false || raise("Passed value for field obj.state is not the expected type, validation failed.")
+      obj.outputs.is_a?(Array) != false || raise("Passed value for field obj.outputs is not the expected type, validation failed.")
+      obj.execution_id.is_a?(String) != false || raise("Passed value for field obj.execution_id is not the expected type, validation failed.")
+      obj.meta.nil? || Vellum::AdHocFulfilledPromptExecutionMeta.validate_raw(obj: obj.meta)
+    end
+  end
+end