vellum_ai 0.3.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 51f2e016abf98b307b469b704ca8f6cbfee098bb83f0c19d1dfa5ad0514908d5
+  data.tar.gz: 2cfc2c48a9d061283e3264caf5ae705968d2aec96d0b8d23ff6b1cc659ab7b10
+SHA512:
+  metadata.gz: db41f9553fa39d81da3b4dc30bd4d296aa424a646488523c6bd8ec2eae4965f56ec793d20582ffc8abbebb7823a72c9edef70e1c9636c9903499c16c571e894c
+  data.tar.gz: bfd98565b2c779bbab50735f403b8b311d4e19b2c3765be50b9331f653bdc6b512b279a071e0c437451170fa70e206f71b5b1583db1635819650deca470d113d

data/lib/core/file_utilities.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require "faraday/multipart"
+require "mini_mime"
+
+module Vellum
+  # Utility class for managing files.
+  class FileUtilities
+    # @param file_like [String, IO] The file to be uploaded, or a string path to the file.
+    # @return [Faraday::Multipart::FilePart]
+    def self.as_faraday_multipart(file_like:)
+      path = if file_like.is_a?(String)
+               file_like
+             else
+               file_like.path
+             end
+      mime_type = MiniMime.lookup_by_filename(path)
+      mime_type = if mime_type.nil?
+                    "application/octet-stream"
+                  else
+                    mime_type.content_type
+                  end
+      Faraday::Multipart::FilePart.new(file_like, mime_type)
+    end
+  end
+end

data/lib/environment.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Vellum
+  class Environment
+    PRODUCTION = {
+      Default: "https://api.vellum.ai",
+      Predict: "https://predict.vellum.ai",
+      Documents: "https://documents.vellum.ai"
+    }.freeze
+  end
+end

data/lib/gemconfig.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Vellum
+  module Gemconfig
+    VERSION = ""
+    AUTHORS = ["Vellum"].freeze
+    EMAIL = ""
+    SUMMARY = "The Vellum Ruby Library provides access to the Vellum API from Ruby."
+    DESCRIPTION = "The Vellum Ruby Library provides access to the Vellum API from Ruby."
+    HOMEPAGE = "https://github.com/vellum-ai/vellum-client-ruby"
+    SOURCE_CODE_URI = "https://github.com/vellum-ai/vellum-client-ruby"
+    CHANGELOG_URI = "https://github.com/vellum-ai/vellum-client-ruby/blob/master/CHANGELOG.md"
+  end
+end

data/lib/requests.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+require_relative "environment"
+require "faraday"
+require "faraday/multipart"
+require "faraday/retry"
+require "async/http/faraday"
+
+module Vellum
+  class RequestClient
+    attr_reader :headers, :default_environment, :conn
+
+    # @param environment [Environment]
+    # @param max_retries [Long] The number of times to retry a failed request, defaults to 2.
+    # @param timeout_in_seconds [Long]
+    # @param api_key [String]
+    # @return [RequestClient]
+    def initialize(api_key:, environment: Environment::PRODUCTION, max_retries: nil, timeout_in_seconds: nil)
+      @default_environment = environment
+      @headers = {
+        "X-Fern-Language": "Ruby",
+        "X-Fern-SDK-Name": "Vellum",
+        "X-Fern-SDK-Version": "0.3.4",
+        "X_API_KEY": api_key.to_s
+      }
+      @conn = Faraday.new(headers: @headers) do |faraday|
+        faraday.request :multipart
+        faraday.request :json
+        faraday.response :raise_error, include_request: true
+        faraday.request :retry, { max: max_retries } unless max_retries.nil?
+        faraday.options.timeout = timeout_in_seconds unless timeout_in_seconds.nil?
+      end
+    end
+  end
+
+  class AsyncRequestClient
+    attr_reader :headers, :default_environment, :conn
+
+    # @param environment [Environment]
+    # @param max_retries [Long] The number of times to retry a failed request, defaults to 2.
+    # @param timeout_in_seconds [Long]
+    # @param api_key [String]
+    # @return [AsyncRequestClient]
+    def initialize(api_key:, environment: Environment::PRODUCTION, max_retries: nil, timeout_in_seconds: nil)
+      @default_environment = environment
+      @headers = {
+        "X-Fern-Language": "Ruby",
+        "X-Fern-SDK-Name": "Vellum",
+        "X-Fern-SDK-Version": "0.3.4",
+        "X_API_KEY": api_key.to_s
+      }
+      @conn = Faraday.new(headers: @headers) do |faraday|
+        faraday.request :multipart
+        faraday.request :json
+        faraday.response :raise_error, include_request: true
+        faraday.adapter :async_http
+        faraday.request :retry, { max: max_retries } unless max_retries.nil?
+        faraday.options.timeout = timeout_in_seconds unless timeout_in_seconds.nil?
+      end
+    end
+  end
+
+  # Additional options for request-specific configuration when calling APIs via the SDK.
+  class RequestOptions
+    attr_reader :api_key, :additional_headers, :additional_query_parameters, :additional_body_parameters,
+                :timeout_in_seconds
+
+    # @param api_key [String]
+    # @param additional_headers [Hash{String => Object}]
+    # @param additional_query_parameters [Hash{String => Object}]
+    # @param additional_body_parameters [Hash{String => Object}]
+    # @param timeout_in_seconds [Long]
+    # @return [RequestOptions]
+    def initialize(api_key: nil, additional_headers: nil, additional_query_parameters: nil,
+                   additional_body_parameters: nil, timeout_in_seconds: nil)
+      # @type [String]
+      @api_key = api_key
+      # @type [Hash{String => Object}]
+      @additional_headers = additional_headers
+      # @type [Hash{String => Object}]
+      @additional_query_parameters = additional_query_parameters
+      # @type [Hash{String => Object}]
+      @additional_body_parameters = additional_body_parameters
+      # @type [Long]
+      @timeout_in_seconds = timeout_in_seconds
+    end
+  end
+end

data/lib/types_export.rb

@@ -0,0 +1,255 @@
+# frozen_string_literal: true
+
+require_relative "vellum_ai/deployments/types/deployments_list_request_status"
+require_relative "vellum_ai/workflow_deployments/types/workflow_deployments_list_request_status"
+require_relative "vellum_ai/types/api_node_result"
+require_relative "vellum_ai/types/api_node_result_data"
+require_relative "vellum_ai/types/array_chat_message_content"
+require_relative "vellum_ai/types/array_chat_message_content_item"
+require_relative "vellum_ai/types/array_chat_message_content_item_request"
+require_relative "vellum_ai/types/array_chat_message_content_request"
+require_relative "vellum_ai/types/block_type_enum"
+require_relative "vellum_ai/types/chat_history_enum"
+require_relative "vellum_ai/types/chat_history_input_request"
+require_relative "vellum_ai/types/chat_message"
+require_relative "vellum_ai/types/chat_message_content"
+require_relative "vellum_ai/types/chat_message_content_request"
+require_relative "vellum_ai/types/chat_message_request"
+require_relative "vellum_ai/types/chat_message_role"
+require_relative "vellum_ai/types/code_execution_node_chat_history_result"
+require_relative "vellum_ai/types/code_execution_node_error_result"
+require_relative "vellum_ai/types/code_execution_node_json_result"
+require_relative "vellum_ai/types/code_execution_node_number_result"
+require_relative "vellum_ai/types/code_execution_node_result"
+require_relative "vellum_ai/types/code_execution_node_result_data"
+require_relative "vellum_ai/types/code_execution_node_result_output"
+require_relative "vellum_ai/types/code_execution_node_search_results_result"
+require_relative "vellum_ai/types/code_execution_node_string_result"
+require_relative "vellum_ai/types/conditional_node_result"
+require_relative "vellum_ai/types/conditional_node_result_data"
+require_relative "vellum_ai/types/deployment_provider_payload_response"
+require_relative "vellum_ai/types/deployment_read"
+require_relative "vellum_ai/types/document_document_to_document_index"
+require_relative "vellum_ai/types/document_index_read"
+require_relative "vellum_ai/types/document_read"
+require_relative "vellum_ai/types/document_status"
+require_relative "vellum_ai/types/enriched_normalized_completion"
+require_relative "vellum_ai/types/entity_status"
+require_relative "vellum_ai/types/environment_enum"
+require_relative "vellum_ai/types/error_enum"
+require_relative "vellum_ai/types/error_variable_value"
+require_relative "vellum_ai/types/execute_prompt_api_error_response"
+require_relative "vellum_ai/types/execute_prompt_event"
+require_relative "vellum_ai/types/execute_prompt_response"
+require_relative "vellum_ai/types/execute_workflow_error_response"
+require_relative "vellum_ai/types/execute_workflow_response"
+require_relative "vellum_ai/types/execute_workflow_stream_error_response"
+require_relative "vellum_ai/types/execute_workflow_workflow_result_event"
+require_relative "vellum_ai/types/finish_reason_enum"
+require_relative "vellum_ai/types/fulfilled_enum"
+require_relative "vellum_ai/types/fulfilled_execute_prompt_event"
+require_relative "vellum_ai/types/fulfilled_execute_prompt_response"
+require_relative "vellum_ai/types/fulfilled_execute_workflow_workflow_result_event"
+require_relative "vellum_ai/types/fulfilled_function_call"
+require_relative "vellum_ai/types/fulfilled_prompt_execution_meta"
+require_relative "vellum_ai/types/fulfilled_workflow_node_result_event"
+require_relative "vellum_ai/types/function_call"
+require_relative "vellum_ai/types/function_call_chat_message_content"
+require_relative "vellum_ai/types/function_call_chat_message_content_request"
+require_relative "vellum_ai/types/function_call_chat_message_content_value"
+require_relative "vellum_ai/types/function_call_chat_message_content_value_request"
+require_relative "vellum_ai/types/function_call_enum"
+require_relative "vellum_ai/types/function_call_variable_value"
+require_relative "vellum_ai/types/generate_error_response"
+require_relative "vellum_ai/types/generate_options_request"
+require_relative "vellum_ai/types/generate_request"
+require_relative "vellum_ai/types/generate_response"
+require_relative "vellum_ai/types/generate_result"
+require_relative "vellum_ai/types/generate_result_data"
+require_relative "vellum_ai/types/generate_result_error"
+require_relative "vellum_ai/types/generate_stream_response"
+require_relative "vellum_ai/types/generate_stream_result"
+require_relative "vellum_ai/types/generate_stream_result_data"
+require_relative "vellum_ai/types/image_chat_message_content"
+require_relative "vellum_ai/types/image_chat_message_content_request"
+require_relative "vellum_ai/types/image_enum"
+require_relative "vellum_ai/types/indexing_state_enum"
+require_relative "vellum_ai/types/initiated_enum"
+require_relative "vellum_ai/types/initiated_execute_prompt_event"
+require_relative "vellum_ai/types/initiated_prompt_execution_meta"
+require_relative "vellum_ai/types/initiated_workflow_node_result_event"
+require_relative "vellum_ai/types/json_input_request"
+require_relative "vellum_ai/types/json_enum"
+require_relative "vellum_ai/types/json_variable_value"
+require_relative "vellum_ai/types/logical_operator"
+require_relative "vellum_ai/types/logprobs_enum"
+require_relative "vellum_ai/types/metadata_filter_config_request"
+require_relative "vellum_ai/types/metadata_filter_rule_combinator"
+require_relative "vellum_ai/types/metadata_filter_rule_request"
+require_relative "vellum_ai/types/model_version_build_config"
+require_relative "vellum_ai/types/model_version_exec_config"
+require_relative "vellum_ai/types/model_version_exec_config_parameters"
+require_relative "vellum_ai/types/model_version_read"
+require_relative "vellum_ai/types/model_version_read_status_enum"
+require_relative "vellum_ai/types/model_version_sandbox_snapshot"
+require_relative "vellum_ai/types/named_test_case_chat_history_variable_value_request"
+require_relative "vellum_ai/types/named_test_case_error_variable_value_request"
+require_relative "vellum_ai/types/named_test_case_json_variable_value_request"
+require_relative "vellum_ai/types/named_test_case_number_variable_value_request"
+require_relative "vellum_ai/types/named_test_case_search_results_variable_value_request"
+require_relative "vellum_ai/types/named_test_case_string_variable_value_request"
+require_relative "vellum_ai/types/named_test_case_variable_value_request"
+require_relative "vellum_ai/types/node_input_compiled_chat_history_value"
+require_relative "vellum_ai/types/node_input_compiled_error_value"
+require_relative "vellum_ai/types/node_input_compiled_json_value"
+require_relative "vellum_ai/types/node_input_compiled_number_value"
+require_relative "vellum_ai/types/node_input_compiled_search_results_value"
+require_relative "vellum_ai/types/node_input_compiled_string_value"
+require_relative "vellum_ai/types/node_input_variable_compiled_value"
+require_relative "vellum_ai/types/node_output_compiled_chat_history_value"
+require_relative "vellum_ai/types/node_output_compiled_error_value"
+require_relative "vellum_ai/types/node_output_compiled_json_value"
+require_relative "vellum_ai/types/node_output_compiled_number_value"
+require_relative "vellum_ai/types/node_output_compiled_search_results_value"
+require_relative "vellum_ai/types/node_output_compiled_string_value"
+require_relative "vellum_ai/types/node_output_compiled_value"
+require_relative "vellum_ai/types/normalized_log_probs"
+require_relative "vellum_ai/types/normalized_token_log_probs"
+require_relative "vellum_ai/types/number_enum"
+require_relative "vellum_ai/types/paginated_slim_deployment_read_list"
+require_relative "vellum_ai/types/paginated_slim_document_list"
+require_relative "vellum_ai/types/paginated_slim_workflow_deployment_list"
+require_relative "vellum_ai/types/processing_failure_reason_enum"
+require_relative "vellum_ai/types/processing_state_enum"
+require_relative "vellum_ai/types/prompt_deployment_expand_meta_request_request"
+require_relative "vellum_ai/types/prompt_deployment_input_request"
+require_relative "vellum_ai/types/prompt_execution_meta"
+require_relative "vellum_ai/types/prompt_node_result"
+require_relative "vellum_ai/types/prompt_node_result_data"
+require_relative "vellum_ai/types/prompt_output"
+require_relative "vellum_ai/types/prompt_template_block"
+require_relative "vellum_ai/types/prompt_template_block_data"
+require_relative "vellum_ai/types/prompt_template_block_data_request"
+require_relative "vellum_ai/types/prompt_template_block_properties"
+require_relative "vellum_ai/types/prompt_template_block_properties_request"
+require_relative "vellum_ai/types/prompt_template_block_request"
+require_relative "vellum_ai/types/provider_enum"
+require_relative "vellum_ai/types/raw_prompt_execution_overrides_request"
+require_relative "vellum_ai/types/register_prompt_error_response"
+require_relative "vellum_ai/types/register_prompt_model_parameters_request"
+require_relative "vellum_ai/types/register_prompt_prompt"
+require_relative "vellum_ai/types/register_prompt_prompt_info_request"
+require_relative "vellum_ai/types/register_prompt_response"
+require_relative "vellum_ai/types/registered_prompt_deployment"
+require_relative "vellum_ai/types/registered_prompt_input_variable_request"
+require_relative "vellum_ai/types/registered_prompt_model_version"
+require_relative "vellum_ai/types/registered_prompt_sandbox"
+require_relative "vellum_ai/types/registered_prompt_sandbox_snapshot"
+require_relative "vellum_ai/types/rejected_enum"
+require_relative "vellum_ai/types/rejected_execute_prompt_event"
+require_relative "vellum_ai/types/rejected_execute_prompt_response"
+require_relative "vellum_ai/types/rejected_execute_workflow_workflow_result_event"
+require_relative "vellum_ai/types/rejected_function_call"
+require_relative "vellum_ai/types/rejected_prompt_execution_meta"
+require_relative "vellum_ai/types/rejected_workflow_node_result_event"
+require_relative "vellum_ai/types/sandbox_scenario"
+require_relative "vellum_ai/types/scenario_input"
+require_relative "vellum_ai/types/scenario_input_request"
+require_relative "vellum_ai/types/scenario_input_type_enum"
+require_relative "vellum_ai/types/search_error_response"
+require_relative "vellum_ai/types/search_filters_request"
+require_relative "vellum_ai/types/search_node_result"
+require_relative "vellum_ai/types/search_node_result_data"
+require_relative "vellum_ai/types/search_request_options_request"
+require_relative "vellum_ai/types/search_response"
+require_relative "vellum_ai/types/search_result"
+require_relative "vellum_ai/types/search_result_document"
+require_relative "vellum_ai/types/search_result_document_request"
+require_relative "vellum_ai/types/search_result_merging_request"
+require_relative "vellum_ai/types/search_result_request"
+require_relative "vellum_ai/types/search_results_enum"
+require_relative "vellum_ai/types/search_weights_request"
+require_relative "vellum_ai/types/slim_deployment_read"
+require_relative "vellum_ai/types/slim_document"
+require_relative "vellum_ai/types/slim_workflow_deployment"
+require_relative "vellum_ai/types/streaming_enum"
+require_relative "vellum_ai/types/streaming_execute_prompt_event"
+require_relative "vellum_ai/types/streaming_prompt_execution_meta"
+require_relative "vellum_ai/types/streaming_workflow_node_result_event"
+require_relative "vellum_ai/types/string_chat_message_content"
+require_relative "vellum_ai/types/string_chat_message_content_request"
+require_relative "vellum_ai/types/string_enum"
+require_relative "vellum_ai/types/string_input_request"
+require_relative "vellum_ai/types/string_variable_value"
+require_relative "vellum_ai/types/submit_completion_actual_request"
+require_relative "vellum_ai/types/submit_completion_actuals_error_response"
+require_relative "vellum_ai/types/submit_workflow_execution_actual_request"
+require_relative "vellum_ai/types/templating_node_chat_history_result"
+require_relative "vellum_ai/types/templating_node_error_result"
+require_relative "vellum_ai/types/templating_node_json_result"
+require_relative "vellum_ai/types/templating_node_number_result"
+require_relative "vellum_ai/types/templating_node_result"
+require_relative "vellum_ai/types/templating_node_result_data"
+require_relative "vellum_ai/types/templating_node_result_output"
+require_relative "vellum_ai/types/templating_node_search_results_result"
+require_relative "vellum_ai/types/templating_node_string_result"
+require_relative "vellum_ai/types/terminal_node_chat_history_result"
+require_relative "vellum_ai/types/terminal_node_error_result"
+require_relative "vellum_ai/types/terminal_node_json_result"
+require_relative "vellum_ai/types/terminal_node_number_result"
+require_relative "vellum_ai/types/terminal_node_result"
+require_relative "vellum_ai/types/terminal_node_result_data"
+require_relative "vellum_ai/types/terminal_node_result_output"
+require_relative "vellum_ai/types/terminal_node_search_results_result"
+require_relative "vellum_ai/types/terminal_node_string_result"
+require_relative "vellum_ai/types/test_case_chat_history_variable_value"
+require_relative "vellum_ai/types/test_case_error_variable_value"
+require_relative "vellum_ai/types/test_case_json_variable_value"
+require_relative "vellum_ai/types/test_case_number_variable_value"
+require_relative "vellum_ai/types/test_case_search_results_variable_value"
+require_relative "vellum_ai/types/test_case_string_variable_value"
+require_relative "vellum_ai/types/test_case_variable_value"
+require_relative "vellum_ai/types/test_suite_test_case"
+require_relative "vellum_ai/types/upload_document_error_response"
+require_relative "vellum_ai/types/upload_document_response"
+require_relative "vellum_ai/types/vellum_error"
+require_relative "vellum_ai/types/vellum_error_code_enum"
+require_relative "vellum_ai/types/vellum_error_request"
+require_relative "vellum_ai/types/vellum_image"
+require_relative "vellum_ai/types/vellum_image_request"
+require_relative "vellum_ai/types/vellum_variable"
+require_relative "vellum_ai/types/vellum_variable_type"
+require_relative "vellum_ai/types/workflow_event_error"
+require_relative "vellum_ai/types/workflow_execution_actual_chat_history_request"
+require_relative "vellum_ai/types/workflow_execution_actual_json_request"
+require_relative "vellum_ai/types/workflow_execution_actual_string_request"
+require_relative "vellum_ai/types/workflow_execution_event_error_code"
+require_relative "vellum_ai/types/workflow_execution_event_type"
+require_relative "vellum_ai/types/workflow_execution_node_result_event"
+require_relative "vellum_ai/types/workflow_execution_workflow_result_event"
+require_relative "vellum_ai/types/workflow_node_result_data"
+require_relative "vellum_ai/types/workflow_node_result_event"
+require_relative "vellum_ai/types/workflow_node_result_event_state"
+require_relative "vellum_ai/types/workflow_output"
+require_relative "vellum_ai/types/workflow_output_chat_history"
+require_relative "vellum_ai/types/workflow_output_error"
+require_relative "vellum_ai/types/workflow_output_function_call"
+require_relative "vellum_ai/types/workflow_output_image"
+require_relative "vellum_ai/types/workflow_output_json"
+require_relative "vellum_ai/types/workflow_output_number"
+require_relative "vellum_ai/types/workflow_output_search_results"
+require_relative "vellum_ai/types/workflow_output_string"
+require_relative "vellum_ai/types/workflow_request_chat_history_input_request"
+require_relative "vellum_ai/types/workflow_request_input_request"
+require_relative "vellum_ai/types/workflow_request_json_input_request"
+require_relative "vellum_ai/types/workflow_request_number_input_request"
+require_relative "vellum_ai/types/workflow_request_string_input_request"
+require_relative "vellum_ai/types/workflow_result_event"
+require_relative "vellum_ai/types/workflow_result_event_output_data"
+require_relative "vellum_ai/types/workflow_result_event_output_data_chat_history"
+require_relative "vellum_ai/types/workflow_result_event_output_data_error"
+require_relative "vellum_ai/types/workflow_result_event_output_data_json"
+require_relative "vellum_ai/types/workflow_result_event_output_data_number"
+require_relative "vellum_ai/types/workflow_result_event_output_data_search_results"
+require_relative "vellum_ai/types/workflow_result_event_output_data_string"
+require_relative "vellum_ai/types/workflow_stream_event"

data/lib/vellum_ai/deployments/client.rb

@@ -0,0 +1,157 @@
+# frozen_string_literal: true
+
+require_relative "../../requests"
+require_relative "types/deployments_list_request_status"
+require_relative "../types/paginated_slim_deployment_read_list"
+require_relative "../types/deployment_read"
+require_relative "../types/prompt_deployment_input_request"
+require_relative "../types/deployment_provider_payload_response"
+require "async"
+
+module Vellum
+  class DeploymentsClient
+    attr_reader :request_client
+
+    # @param request_client [RequestClient]
+    # @return [DeploymentsClient]
+    def initialize(request_client:)
+      # @type [RequestClient]
+      @request_client = request_client
+    end
+
+    # @param limit [Integer] Number of results to return per page.
+    # @param offset [Integer] The initial index from which to return the results.
+    # @param ordering [String] Which field to use when ordering the results.
+    # @param status [DEPLOYMENTS_LIST_REQUEST_STATUS] The current status of the deployment
+    # @param request_options [RequestOptions]
+    # @return [PaginatedSlimDeploymentReadList]
+    def list(limit: nil, offset: nil, ordering: nil, status: nil, request_options: nil)
+      response = @request_client.conn.get do |req|
+        req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+        req.headers["X_API_KEY"] = request_options.api_key unless request_options&.api_key.nil?
+        req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
+        req.params = {
+          **(request_options&.additional_query_parameters || {}),
+          "limit": limit,
+          "offset": offset,
+          "ordering": ordering,
+          "status": status
+        }.compact
+        req.url "#{@request_client.default_environment[:Default]}/v1/deployments"
+      end
+      PaginatedSlimDeploymentReadList.from_json(json_object: response.body)
+    end
+
+    # Used to retrieve a deployment given its ID or name.
+    #
+    # @param id [String] Either the Deployment's ID or its unique name
+    # @param request_options [RequestOptions]
+    # @return [DeploymentRead]
+    def retrieve(id:, request_options: nil)
+      response = @request_client.conn.get do |req|
+        req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+        req.headers["X_API_KEY"] = request_options.api_key unless request_options&.api_key.nil?
+        req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
+        req.url "#{@request_client.default_environment[:Default]}/v1/deployments/#{id}"
+      end
+      DeploymentRead.from_json(json_object: response.body)
+    end
+
+    # @param deployment_id [String] The ID of the deployment. Must provide either this or deployment_name.
+    # @param deployment_name [String] The name of the deployment. Must provide either this or deployment_id.
+    # @param inputs [Array<Hash>] The list of inputs defined in the Prompt's deployment with their corresponding values.Request of type Array<PromptDeploymentInputRequest>, as a Hash
+    # @param request_options [RequestOptions]
+    # @return [DeploymentProviderPayloadResponse]
+    def retrieve_provider_payload(inputs:, deployment_id: nil, deployment_name: nil, request_options: nil)
+      response = @request_client.conn.post do |req|
+        req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+        req.headers["X_API_KEY"] = request_options.api_key unless request_options&.api_key.nil?
+        req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
+        req.body = {
+          **(request_options&.additional_body_parameters || {}),
+          deployment_id: deployment_id,
+          deployment_name: deployment_name,
+          inputs: inputs
+        }.compact
+        req.url "#{@request_client.default_environment[:Default]}/v1/deployments/provider-payload"
+      end
+      DeploymentProviderPayloadResponse.from_json(json_object: response.body)
+    end
+  end
+
+  class AsyncDeploymentsClient
+    attr_reader :request_client
+
+    # @param request_client [AsyncRequestClient]
+    # @return [AsyncDeploymentsClient]
+    def initialize(request_client:)
+      # @type [AsyncRequestClient]
+      @request_client = request_client
+    end
+
+    # @param limit [Integer] Number of results to return per page.
+    # @param offset [Integer] The initial index from which to return the results.
+    # @param ordering [String] Which field to use when ordering the results.
+    # @param status [DEPLOYMENTS_LIST_REQUEST_STATUS] The current status of the deployment
+    # @param request_options [RequestOptions]
+    # @return [PaginatedSlimDeploymentReadList]
+    def list(limit: nil, offset: nil, ordering: nil, status: nil, request_options: nil)
+      Async do
+        response = @request_client.conn.get do |req|
+          req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+          req.headers["X_API_KEY"] = request_options.api_key unless request_options&.api_key.nil?
+          req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
+          req.params = {
+            **(request_options&.additional_query_parameters || {}),
+            "limit": limit,
+            "offset": offset,
+            "ordering": ordering,
+            "status": status
+          }.compact
+          req.url "#{@request_client.default_environment[:Default]}/v1/deployments"
+        end
+        PaginatedSlimDeploymentReadList.from_json(json_object: response.body)
+      end
+    end
+
+    # Used to retrieve a deployment given its ID or name.
+    #
+    # @param id [String] Either the Deployment's ID or its unique name
+    # @param request_options [RequestOptions]
+    # @return [DeploymentRead]
+    def retrieve(id:, request_options: nil)
+      Async do
+        response = @request_client.conn.get do |req|
+          req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+          req.headers["X_API_KEY"] = request_options.api_key unless request_options&.api_key.nil?
+          req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
+          req.url "#{@request_client.default_environment[:Default]}/v1/deployments/#{id}"
+        end
+        DeploymentRead.from_json(json_object: response.body)
+      end
+    end
+
+    # @param deployment_id [String] The ID of the deployment. Must provide either this or deployment_name.
+    # @param deployment_name [String] The name of the deployment. Must provide either this or deployment_id.
+    # @param inputs [Array<Hash>] The list of inputs defined in the Prompt's deployment with their corresponding values.Request of type Array<PromptDeploymentInputRequest>, as a Hash
+    # @param request_options [RequestOptions]
+    # @return [DeploymentProviderPayloadResponse]
+    def retrieve_provider_payload(inputs:, deployment_id: nil, deployment_name: nil, request_options: nil)
+      Async do
+        response = @request_client.conn.post do |req|
+          req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+          req.headers["X_API_KEY"] = request_options.api_key unless request_options&.api_key.nil?
+          req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
+          req.body = {
+            **(request_options&.additional_body_parameters || {}),
+            deployment_id: deployment_id,
+            deployment_name: deployment_name,
+            inputs: inputs
+          }.compact
+          req.url "#{@request_client.default_environment[:Default]}/v1/deployments/provider-payload"
+        end
+        DeploymentProviderPayloadResponse.from_json(json_object: response.body)
+      end
+    end
+  end
+end

data/lib/vellum_ai/deployments/types/deployments_list_request_status.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Vellum
+  module Deployments
+    # @type [DEPLOYMENTS_LIST_REQUEST_STATUS]
+    DEPLOYMENTS_LIST_REQUEST_STATUS = { active: "ACTIVE", archived: "ARCHIVED" }.freeze
+  end
+end