vellum_ai 0.3.15 → 0.14.74

data/lib/vellum_ai/types/paginated_workflow_sandbox_example_list.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+require_relative "workflow_sandbox_example"
+require "ostruct"
+require "json"
+
+module Vellum
+  class PaginatedWorkflowSandboxExampleList
+  # @return [Integer] 
+    attr_reader :count
+  # @return [String] 
+    attr_reader :next_
+  # @return [String] 
+    attr_reader :previous
+  # @return [Array<Vellum::WorkflowSandboxExample>] 
+    attr_reader :results
+  # @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 count [Integer] 
+    # @param next_ [String] 
+    # @param previous [String] 
+    # @param results [Array<Vellum::WorkflowSandboxExample>] 
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vellum::PaginatedWorkflowSandboxExampleList]
+    def initialize(count: OMIT, next_: OMIT, previous: OMIT, results: OMIT, additional_properties: nil)
+      @count = count if count != OMIT
+      @next_ = next_ if next_ != OMIT
+      @previous = previous if previous != OMIT
+      @results = results if results != OMIT
+      @additional_properties = additional_properties
+      @_field_set = { "count": count, "next": next_, "previous": previous, "results": results }.reject do | _k, v |
+  v == OMIT
+end
+    end
+# Deserialize a JSON object to an instance of PaginatedWorkflowSandboxExampleList
+    #
+    # @param json_object [String] 
+    # @return [Vellum::PaginatedWorkflowSandboxExampleList]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      count = parsed_json["count"]
+      next_ = parsed_json["next"]
+      previous = parsed_json["previous"]
+      results = parsed_json["results"]&.map do | item |
+  item = item.to_json
+  Vellum::WorkflowSandboxExample.from_json(json_object: item)
+end
+      new(
+        count: count,
+        next_: next_,
+        previous: previous,
+        results: results,
+        additional_properties: struct
+      )
+    end
+# Serialize an instance of PaginatedWorkflowSandboxExampleList 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.count&.is_a?(Integer) != false || raise("Passed value for field obj.count is not the expected type, validation failed.")
+      obj.next_&.is_a?(String) != false || raise("Passed value for field obj.next_ is not the expected type, validation failed.")
+      obj.previous&.is_a?(String) != false || raise("Passed value for field obj.previous is not the expected type, validation failed.")
+      obj.results&.is_a?(Array) != false || raise("Passed value for field obj.results is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/vellum_ai/types/parent_context.rb

@@ -0,0 +1,122 @@
+# frozen_string_literal: true
+require "json"
+require_relative "workflow_parent_context"
+require_relative "node_parent_context"
+require_relative "workflow_deployment_parent_context"
+require_relative "workflow_sandbox_parent_context"
+require_relative "prompt_deployment_parent_context"
+require_relative "api_request_parent_context"
+
+module Vellum
+  class ParentContext
+
+
+# Deserialize a JSON object to an instance of ParentContext
+    #
+    # @param json_object [String] 
+    # @return [Vellum::ParentContext]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      begin
+        Vellum::WorkflowParentContext.validate_raw(obj: struct)
+        unless struct.nil?
+  return Vellum::WorkflowParentContext.from_json(json_object: struct)
+else
+  return nil
+end
+      rescue StandardError
+        # noop
+      end
+      begin
+        Vellum::NodeParentContext.validate_raw(obj: struct)
+        unless struct.nil?
+  return Vellum::NodeParentContext.from_json(json_object: struct)
+else
+  return nil
+end
+      rescue StandardError
+        # noop
+      end
+      begin
+        Vellum::WorkflowDeploymentParentContext.validate_raw(obj: struct)
+        unless struct.nil?
+  return Vellum::WorkflowDeploymentParentContext.from_json(json_object: struct)
+else
+  return nil
+end
+      rescue StandardError
+        # noop
+      end
+      begin
+        Vellum::WorkflowSandboxParentContext.validate_raw(obj: struct)
+        unless struct.nil?
+  return Vellum::WorkflowSandboxParentContext.from_json(json_object: struct)
+else
+  return nil
+end
+      rescue StandardError
+        # noop
+      end
+      begin
+        Vellum::PromptDeploymentParentContext.validate_raw(obj: struct)
+        unless struct.nil?
+  return Vellum::PromptDeploymentParentContext.from_json(json_object: struct)
+else
+  return nil
+end
+      rescue StandardError
+        # noop
+      end
+      begin
+        Vellum::ApiRequestParentContext.validate_raw(obj: struct)
+        unless struct.nil?
+  return Vellum::ApiRequestParentContext.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::WorkflowParentContext.validate_raw(obj: obj)
+      rescue StandardError
+        # noop
+      end
+      begin
+        return Vellum::NodeParentContext.validate_raw(obj: obj)
+      rescue StandardError
+        # noop
+      end
+      begin
+        return Vellum::WorkflowDeploymentParentContext.validate_raw(obj: obj)
+      rescue StandardError
+        # noop
+      end
+      begin
+        return Vellum::WorkflowSandboxParentContext.validate_raw(obj: obj)
+      rescue StandardError
+        # noop
+      end
+      begin
+        return Vellum::PromptDeploymentParentContext.validate_raw(obj: obj)
+      rescue StandardError
+        # noop
+      end
+      begin
+        return Vellum::ApiRequestParentContext.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/pdf_search_result_meta_source.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+require "ostruct"
+require "json"
+
+module Vellum
+# The source of a search result from a PDF document.
+  class PdfSearchResultMetaSource
+  # @return [String] 
+    attr_reader :document_type
+  # @return [Integer] The 1-indexed page number where the chunk starts in the document. Only available
+#  for supported chunking strategies and document types.
+    attr_reader :start_page_num
+  # @return [Integer] The 1-indexed page number where the chunk ends in the document. Only available
+#  for supported chunking strategies and document types.
+    attr_reader :end_page_num
+  # @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 document_type [String] 
+    # @param start_page_num [Integer] The 1-indexed page number where the chunk starts in the document. Only available
+#  for supported chunking strategies and document types.
+    # @param end_page_num [Integer] The 1-indexed page number where the chunk ends in the document. Only available
+#  for supported chunking strategies and document types.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vellum::PdfSearchResultMetaSource]
+    def initialize(document_type:, start_page_num: OMIT, end_page_num: OMIT, additional_properties: nil)
+      @document_type = document_type
+      @start_page_num = start_page_num if start_page_num != OMIT
+      @end_page_num = end_page_num if end_page_num != OMIT
+      @additional_properties = additional_properties
+      @_field_set = { "document_type": document_type, "start_page_num": start_page_num, "end_page_num": end_page_num }.reject do | _k, v |
+  v == OMIT
+end
+    end
+# Deserialize a JSON object to an instance of PdfSearchResultMetaSource
+    #
+    # @param json_object [String] 
+    # @return [Vellum::PdfSearchResultMetaSource]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      document_type = parsed_json["document_type"]
+      start_page_num = parsed_json["start_page_num"]
+      end_page_num = parsed_json["end_page_num"]
+      new(
+        document_type: document_type,
+        start_page_num: start_page_num,
+        end_page_num: end_page_num,
+        additional_properties: struct
+      )
+    end
+# Serialize an instance of PdfSearchResultMetaSource 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.document_type.is_a?(String) != false || raise("Passed value for field obj.document_type is not the expected type, validation failed.")
+      obj.start_page_num&.is_a?(Integer) != false || raise("Passed value for field obj.start_page_num is not the expected type, validation failed.")
+      obj.end_page_num&.is_a?(Integer) != false || raise("Passed value for field obj.end_page_num is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/vellum_ai/types/pdf_search_result_meta_source_request.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+require "ostruct"
+require "json"
+
+module Vellum
+# The source of a search result from a PDF document.
+  class PdfSearchResultMetaSourceRequest
+  # @return [String] 
+    attr_reader :document_type
+  # @return [Integer] The 1-indexed page number where the chunk starts in the document. Only available
+#  for supported chunking strategies and document types.
+    attr_reader :start_page_num
+  # @return [Integer] The 1-indexed page number where the chunk ends in the document. Only available
+#  for supported chunking strategies and document types.
+    attr_reader :end_page_num
+  # @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 document_type [String] 
+    # @param start_page_num [Integer] The 1-indexed page number where the chunk starts in the document. Only available
+#  for supported chunking strategies and document types.
+    # @param end_page_num [Integer] The 1-indexed page number where the chunk ends in the document. Only available
+#  for supported chunking strategies and document types.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vellum::PdfSearchResultMetaSourceRequest]
+    def initialize(document_type:, start_page_num: OMIT, end_page_num: OMIT, additional_properties: nil)
+      @document_type = document_type
+      @start_page_num = start_page_num if start_page_num != OMIT
+      @end_page_num = end_page_num if end_page_num != OMIT
+      @additional_properties = additional_properties
+      @_field_set = { "document_type": document_type, "start_page_num": start_page_num, "end_page_num": end_page_num }.reject do | _k, v |
+  v == OMIT
+end
+    end
+# Deserialize a JSON object to an instance of PdfSearchResultMetaSourceRequest
+    #
+    # @param json_object [String] 
+    # @return [Vellum::PdfSearchResultMetaSourceRequest]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      document_type = parsed_json["document_type"]
+      start_page_num = parsed_json["start_page_num"]
+      end_page_num = parsed_json["end_page_num"]
+      new(
+        document_type: document_type,
+        start_page_num: start_page_num,
+        end_page_num: end_page_num,
+        additional_properties: struct
+      )
+    end
+# Serialize an instance of PdfSearchResultMetaSourceRequest 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.document_type.is_a?(String) != false || raise("Passed value for field obj.document_type is not the expected type, validation failed.")
+      obj.start_page_num&.is_a?(Integer) != false || raise("Passed value for field obj.start_page_num is not the expected type, validation failed.")
+      obj.end_page_num&.is_a?(Integer) != false || raise("Passed value for field obj.end_page_num is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/vellum_ai/types/plain_text_prompt_block.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+require_relative "prompt_block_state"
+require_relative "ephemeral_prompt_cache_config"
+require "ostruct"
+require "json"
+
+module Vellum
+# A block that holds a plain text string value.
+  class PlainTextPromptBlock
+  # @return [String] 
+    attr_reader :block_type
+  # @return [Vellum::PromptBlockState] 
+    attr_reader :state
+  # @return [Vellum::EphemeralPromptCacheConfig] 
+    attr_reader :cache_config
+  # @return [String] 
+    attr_reader :text
+  # @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 block_type [String] 
+    # @param state [Vellum::PromptBlockState] 
+    # @param cache_config [Vellum::EphemeralPromptCacheConfig] 
+    # @param text [String] 
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vellum::PlainTextPromptBlock]
+    def initialize(block_type:, state: OMIT, cache_config: OMIT, text:, additional_properties: nil)
+      @block_type = block_type
+      @state = state if state != OMIT
+      @cache_config = cache_config if cache_config != OMIT
+      @text = text
+      @additional_properties = additional_properties
+      @_field_set = { "block_type": block_type, "state": state, "cache_config": cache_config, "text": text }.reject do | _k, v |
+  v == OMIT
+end
+    end
+# Deserialize a JSON object to an instance of PlainTextPromptBlock
+    #
+    # @param json_object [String] 
+    # @return [Vellum::PlainTextPromptBlock]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      block_type = parsed_json["block_type"]
+      state = parsed_json["state"]
+      unless parsed_json["cache_config"].nil?
+        cache_config = parsed_json["cache_config"].to_json
+        cache_config = Vellum::EphemeralPromptCacheConfig.from_json(json_object: cache_config)
+      else
+        cache_config = nil
+      end
+      text = parsed_json["text"]
+      new(
+        block_type: block_type,
+        state: state,
+        cache_config: cache_config,
+        text: text,
+        additional_properties: struct
+      )
+    end
+# Serialize an instance of PlainTextPromptBlock 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.block_type.is_a?(String) != false || raise("Passed value for field obj.block_type is not the expected type, validation failed.")
+      obj.state&.is_a?(Vellum::PromptBlockState) != false || raise("Passed value for field obj.state is not the expected type, validation failed.")
+      obj.cache_config.nil? || Vellum::EphemeralPromptCacheConfig.validate_raw(obj: obj.cache_config)
+      obj.text.is_a?(String) != false || raise("Passed value for field obj.text is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/vellum_ai/types/price.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+require_relative "unit_enum"
+require "ostruct"
+require "json"
+
+module Vellum
+  class Price
+  # @return [Float] 
+    attr_reader :value
+  # @return [Vellum::UNIT_ENUM] 
+    attr_reader :unit
+  # @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 value [Float] 
+    # @param unit [Vellum::UNIT_ENUM] 
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vellum::Price]
+    def initialize(value:, unit:, additional_properties: nil)
+      @value = value
+      @unit = unit
+      @additional_properties = additional_properties
+      @_field_set = { "value": value, "unit": unit }
+    end
+# Deserialize a JSON object to an instance of Price
+    #
+    # @param json_object [String] 
+    # @return [Vellum::Price]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      value = parsed_json["value"]
+      unit = parsed_json["unit"]
+      new(
+        value: value,
+        unit: unit,
+        additional_properties: struct
+      )
+    end
+# Serialize an instance of Price 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.value.is_a?(Float) != false || raise("Passed value for field obj.value is not the expected type, validation failed.")
+      obj.unit.is_a?(String) != false || raise("Passed value for field obj.unit is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/vellum_ai/types/processing_failure_reason_enum.rb

@@ -1,9 +1,12 @@
 # frozen_string_literal: true
 
 module Vellum
-  # @type [PROCESSING_FAILURE_REASON_ENUM]
-  PROCESSING_FAILURE_REASON_ENUM = {
-    exceeded_character_limit: "EXCEEDED_CHARACTER_LIMIT",
-    invalid_file: "INVALID_FILE"
-  }.freeze
-end
+# * `EXCEEDED_CHARACTER_LIMIT` - Exceeded Character Limit
+#  * `INVALID_FILE` - Invalid File
+  class ProcessingFailureReasonEnum
+
+    EXCEEDED_CHARACTER_LIMIT = "EXCEEDED_CHARACTER_LIMIT"
+    INVALID_FILE = "INVALID_FILE"
+
+  end
+end

data/lib/vellum_ai/types/prompt_block.rb

@@ -0,0 +1,154 @@
+# frozen_string_literal: true
+require "json"
+require_relative "jinja_prompt_block"
+require_relative "chat_message_prompt_block"
+require_relative "variable_prompt_block"
+require_relative "rich_text_prompt_block"
+require_relative "audio_prompt_block"
+require_relative "function_call_prompt_block"
+require_relative "image_prompt_block"
+require_relative "document_prompt_block"
+
+module Vellum
+  class PromptBlock
+
+
+# Deserialize a JSON object to an instance of PromptBlock
+    #
+    # @param json_object [String] 
+    # @return [Vellum::PromptBlock]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      begin
+        Vellum::JinjaPromptBlock.validate_raw(obj: struct)
+        unless struct.nil?
+  return Vellum::JinjaPromptBlock.from_json(json_object: struct)
+else
+  return nil
+end
+      rescue StandardError
+        # noop
+      end
+      begin
+        Vellum::ChatMessagePromptBlock.validate_raw(obj: struct)
+        unless struct.nil?
+  return Vellum::ChatMessagePromptBlock.from_json(json_object: struct)
+else
+  return nil
+end
+      rescue StandardError
+        # noop
+      end
+      begin
+        Vellum::VariablePromptBlock.validate_raw(obj: struct)
+        unless struct.nil?
+  return Vellum::VariablePromptBlock.from_json(json_object: struct)
+else
+  return nil
+end
+      rescue StandardError
+        # noop
+      end
+      begin
+        Vellum::RichTextPromptBlock.validate_raw(obj: struct)
+        unless struct.nil?
+  return Vellum::RichTextPromptBlock.from_json(json_object: struct)
+else
+  return nil
+end
+      rescue StandardError
+        # noop
+      end
+      begin
+        Vellum::AudioPromptBlock.validate_raw(obj: struct)
+        unless struct.nil?
+  return Vellum::AudioPromptBlock.from_json(json_object: struct)
+else
+  return nil
+end
+      rescue StandardError
+        # noop
+      end
+      begin
+        Vellum::FunctionCallPromptBlock.validate_raw(obj: struct)
+        unless struct.nil?
+  return Vellum::FunctionCallPromptBlock.from_json(json_object: struct)
+else
+  return nil
+end
+      rescue StandardError
+        # noop
+      end
+      begin
+        Vellum::ImagePromptBlock.validate_raw(obj: struct)
+        unless struct.nil?
+  return Vellum::ImagePromptBlock.from_json(json_object: struct)
+else
+  return nil
+end
+      rescue StandardError
+        # noop
+      end
+      begin
+        Vellum::DocumentPromptBlock.validate_raw(obj: struct)
+        unless struct.nil?
+  return Vellum::DocumentPromptBlock.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::JinjaPromptBlock.validate_raw(obj: obj)
+      rescue StandardError
+        # noop
+      end
+      begin
+        return Vellum::ChatMessagePromptBlock.validate_raw(obj: obj)
+      rescue StandardError
+        # noop
+      end
+      begin
+        return Vellum::VariablePromptBlock.validate_raw(obj: obj)
+      rescue StandardError
+        # noop
+      end
+      begin
+        return Vellum::RichTextPromptBlock.validate_raw(obj: obj)
+      rescue StandardError
+        # noop
+      end
+      begin
+        return Vellum::AudioPromptBlock.validate_raw(obj: obj)
+      rescue StandardError
+        # noop
+      end
+      begin
+        return Vellum::FunctionCallPromptBlock.validate_raw(obj: obj)
+      rescue StandardError
+        # noop
+      end
+      begin
+        return Vellum::ImagePromptBlock.validate_raw(obj: obj)
+      rescue StandardError
+        # noop
+      end
+      begin
+        return Vellum::DocumentPromptBlock.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/prompt_block_state.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Vellum
+# * `ENABLED` - Enabled
+#  * `DISABLED` - Disabled
+  class PromptBlockState
+
+    ENABLED = "ENABLED"
+    DISABLED = "DISABLED"
+
+  end
+end