vellum_ai 0.3.14 → 0.14.74

data/lib/vellum_ai/prompts/client.rb

@@ -0,0 +1,194 @@
+# frozen_string_literal: true
+require_relative "../../requests"
+require_relative "../types/prompt_exec_config"
+require_relative "../types/prompt_push_response"
+require "async"
+require "async"
+require_relative "../../requests"
+
+module Vellum
+  class PromptsClient
+  # @return [Vellum::RequestClient] 
+    attr_reader :request_client
+
+
+    # @param request_client [Vellum::RequestClient] 
+    # @return [Vellum::PromptsClient]
+    def initialize(request_client:)
+      @request_client = request_client
+    end
+# Used to pull the definition of a Prompt from Vellum.
+    #
+    # @param id [String] The ID of the Prompt to pull from. Prompt Sandbox IDs are currently supported.
+    # @param prompt_variant_id [String] The ID of the Prompt Variant within a Prompt Sandbox to pull. Must be included
+#  if providing the ID of a Prompt Sandbox.
+    # @param request_options [Vellum::RequestOptions] 
+    # @return [Vellum::PromptExecConfig]
+    # @example
+#  api = Vellum::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Vellum::Environment::PRODUCTION,
+#    api_key: "YOUR_API_KEY"
+#  )
+#  api.prompts.pull(id: "id")
+    def pull(id:, prompt_variant_id: nil, request_options: nil)
+      response = @request_client.conn.get do | req |
+  unless request_options&.timeout_in_seconds.nil?
+    req.options.timeout = request_options.timeout_in_seconds
+  end
+  unless request_options&.api_key.nil?
+    req.headers["X-API-KEY"] = request_options.api_key
+  end
+  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}), "Accept": "application/json" }.compact
+  req.params = { **(request_options&.additional_query_parameters || {}), "prompt_variant_id": prompt_variant_id }.compact
+  unless request_options.nil? || request_options&.additional_body_parameters.nil?
+    req.body = { **(request_options&.additional_body_parameters || {}) }.compact
+  end
+  req.url "#{@request_client.get_url(environment: Default, request_options: request_options)}/v1/prompts/#{id}/pull"
+end
+      Vellum::PromptExecConfig.from_json(json_object: response.body)
+    end
+# Used to push updates to a Prompt in Vellum.
+    #
+    # @param exec_config [Hash] Request of type Vellum::PromptExecConfig, as a Hash
+    #   * :ml_model (String) 
+    #   * :input_variables (Array<Vellum::VellumVariable>) 
+    #   * :parameters (Hash)
+    #     * :stop (Array<String>) 
+    #     * :temperature (Float) 
+    #     * :max_tokens (Integer) 
+    #     * :top_p (Float) 
+    #     * :top_k (Integer) 
+    #     * :frequency_penalty (Float) 
+    #     * :presence_penalty (Float) 
+    #     * :logit_bias (Hash{String => Float}) 
+    #     * :custom_parameters (Hash{String => Object}) 
+    #   * :settings (Hash)
+    #     * :timeout (Float) 
+    #     * :stream_enabled (Boolean) 
+    #   * :blocks (Array<Vellum::PromptBlock>) 
+    #   * :functions (Array<Vellum::FunctionDefinition>) 
+    # @param prompt_variant_id [String] 
+    # @param prompt_sandbox_id [String] 
+    # @param request_options [Vellum::RequestOptions] 
+    # @return [Vellum::PromptPushResponse]
+    # @example
+#  api = Vellum::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Vellum::Environment::PRODUCTION,
+#    api_key: "YOUR_API_KEY"
+#  )
+#  api.prompts.push(exec_config: { ml_model: "ml_model", input_variables: [{ id: "id", key: "key", type: STRING }], parameters: {  }, blocks: [{ block_type: "JINJA", template: "template" }] })
+    def push(exec_config:, prompt_variant_id: nil, prompt_sandbox_id: nil, request_options: nil)
+      response = @request_client.conn.post do | req |
+  unless request_options&.timeout_in_seconds.nil?
+    req.options.timeout = request_options.timeout_in_seconds
+  end
+  unless request_options&.api_key.nil?
+    req.headers["X-API-KEY"] = request_options.api_key
+  end
+  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
+  unless request_options.nil? || request_options&.additional_query_parameters.nil?
+    req.params = { **(request_options&.additional_query_parameters || {}) }.compact
+  end
+  req.body = { **(request_options&.additional_body_parameters || {}), exec_config: exec_config, prompt_variant_id: prompt_variant_id, prompt_sandbox_id: prompt_sandbox_id }.compact
+  req.url "#{@request_client.get_url(environment: Default, request_options: request_options)}/v1/prompts/push"
+end
+      Vellum::PromptPushResponse.from_json(json_object: response.body)
+    end
+  end
+  class AsyncPromptsClient
+  # @return [Vellum::AsyncRequestClient] 
+    attr_reader :request_client
+
+
+    # @param request_client [Vellum::RequestClient] 
+    # @return [Vellum::AsyncPromptsClient]
+    def initialize(request_client:)
+      @request_client = request_client
+    end
+# Used to pull the definition of a Prompt from Vellum.
+    #
+    # @param id [String] The ID of the Prompt to pull from. Prompt Sandbox IDs are currently supported.
+    # @param prompt_variant_id [String] The ID of the Prompt Variant within a Prompt Sandbox to pull. Must be included
+#  if providing the ID of a Prompt Sandbox.
+    # @param request_options [Vellum::RequestOptions] 
+    # @return [Vellum::PromptExecConfig]
+    # @example
+#  api = Vellum::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Vellum::Environment::PRODUCTION,
+#    api_key: "YOUR_API_KEY"
+#  )
+#  api.prompts.pull(id: "id")
+    def pull(id:, prompt_variant_id: nil, request_options: nil)
+      Async do
+        response = @request_client.conn.get do | req |
+  unless request_options&.timeout_in_seconds.nil?
+    req.options.timeout = request_options.timeout_in_seconds
+  end
+  unless request_options&.api_key.nil?
+    req.headers["X-API-KEY"] = request_options.api_key
+  end
+  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}), "Accept": "application/json" }.compact
+  req.params = { **(request_options&.additional_query_parameters || {}), "prompt_variant_id": prompt_variant_id }.compact
+  unless request_options.nil? || request_options&.additional_body_parameters.nil?
+    req.body = { **(request_options&.additional_body_parameters || {}) }.compact
+  end
+  req.url "#{@request_client.get_url(environment: Default, request_options: request_options)}/v1/prompts/#{id}/pull"
+end
+        Vellum::PromptExecConfig.from_json(json_object: response.body)
+      end
+    end
+# Used to push updates to a Prompt in Vellum.
+    #
+    # @param exec_config [Hash] Request of type Vellum::PromptExecConfig, as a Hash
+    #   * :ml_model (String) 
+    #   * :input_variables (Array<Vellum::VellumVariable>) 
+    #   * :parameters (Hash)
+    #     * :stop (Array<String>) 
+    #     * :temperature (Float) 
+    #     * :max_tokens (Integer) 
+    #     * :top_p (Float) 
+    #     * :top_k (Integer) 
+    #     * :frequency_penalty (Float) 
+    #     * :presence_penalty (Float) 
+    #     * :logit_bias (Hash{String => Float}) 
+    #     * :custom_parameters (Hash{String => Object}) 
+    #   * :settings (Hash)
+    #     * :timeout (Float) 
+    #     * :stream_enabled (Boolean) 
+    #   * :blocks (Array<Vellum::PromptBlock>) 
+    #   * :functions (Array<Vellum::FunctionDefinition>) 
+    # @param prompt_variant_id [String] 
+    # @param prompt_sandbox_id [String] 
+    # @param request_options [Vellum::RequestOptions] 
+    # @return [Vellum::PromptPushResponse]
+    # @example
+#  api = Vellum::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Vellum::Environment::PRODUCTION,
+#    api_key: "YOUR_API_KEY"
+#  )
+#  api.prompts.push(exec_config: { ml_model: "ml_model", input_variables: [{ id: "id", key: "key", type: STRING }], parameters: {  }, blocks: [{ block_type: "JINJA", template: "template" }] })
+    def push(exec_config:, prompt_variant_id: nil, prompt_sandbox_id: nil, request_options: nil)
+      Async do
+        response = @request_client.conn.post do | req |
+  unless request_options&.timeout_in_seconds.nil?
+    req.options.timeout = request_options.timeout_in_seconds
+  end
+  unless request_options&.api_key.nil?
+    req.headers["X-API-KEY"] = request_options.api_key
+  end
+  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
+  unless request_options.nil? || request_options&.additional_query_parameters.nil?
+    req.params = { **(request_options&.additional_query_parameters || {}) }.compact
+  end
+  req.body = { **(request_options&.additional_body_parameters || {}), exec_config: exec_config, prompt_variant_id: prompt_variant_id, prompt_sandbox_id: prompt_sandbox_id }.compact
+  req.url "#{@request_client.get_url(environment: Default, request_options: request_options)}/v1/prompts/push"
+end
+        Vellum::PromptPushResponse.from_json(json_object: response.body)
+      end
+    end
+  end
+end

data/lib/vellum_ai/release_reviews/client.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+require_relative "../../requests"
+require_relative "../types/workflow_deployment_release"
+require "async"
+require_relative "../../requests"
+
+module Vellum
+  class ReleaseReviewsClient
+  # @return [Vellum::RequestClient] 
+    attr_reader :request_client
+
+
+    # @param request_client [Vellum::RequestClient] 
+    # @return [Vellum::ReleaseReviewsClient]
+    def initialize(request_client:)
+      @request_client = request_client
+    end
+# Retrieve a specific Workflow Deployment Release by either its UUID or the name
+#  of a Release Tag that points to it.
+    #
+    # @param id [String] Either the Workflow Deployment's ID or its unique name
+    # @param release_id_or_release_tag [String] Either the UUID of Workflow Deployment Release you'd like to retrieve, or the
+#  name of a Release Tag that's pointing to the Workflow Deployment Release you'd
+#  like to retrieve.
+    # @param request_options [Vellum::RequestOptions] 
+    # @return [Vellum::WorkflowDeploymentRelease]
+    # @example
+#  api = Vellum::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Vellum::Environment::PRODUCTION,
+#    api_key: "YOUR_API_KEY"
+#  )
+#  api.release_reviews.retrieve_workflow_deployment_release(id: "id", release_id_or_release_tag: "release_id_or_release_tag")
+    def retrieve_workflow_deployment_release(id:, release_id_or_release_tag:, request_options: nil)
+      response = @request_client.conn.get do | req |
+  unless request_options&.timeout_in_seconds.nil?
+    req.options.timeout = request_options.timeout_in_seconds
+  end
+  unless request_options&.api_key.nil?
+    req.headers["X-API-KEY"] = request_options.api_key
+  end
+  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
+  unless request_options.nil? || request_options&.additional_query_parameters.nil?
+    req.params = { **(request_options&.additional_query_parameters || {}) }.compact
+  end
+  unless request_options.nil? || request_options&.additional_body_parameters.nil?
+    req.body = { **(request_options&.additional_body_parameters || {}) }.compact
+  end
+  req.url "#{@request_client.get_url(environment: Default, request_options: request_options)}/v1/workflow-deployments/#{id}/releases/#{release_id_or_release_tag}"
+end
+      Vellum::WorkflowDeploymentRelease.from_json(json_object: response.body)
+    end
+  end
+  class AsyncReleaseReviewsClient
+  # @return [Vellum::AsyncRequestClient] 
+    attr_reader :request_client
+
+
+    # @param request_client [Vellum::RequestClient] 
+    # @return [Vellum::AsyncReleaseReviewsClient]
+    def initialize(request_client:)
+      @request_client = request_client
+    end
+# Retrieve a specific Workflow Deployment Release by either its UUID or the name
+#  of a Release Tag that points to it.
+    #
+    # @param id [String] Either the Workflow Deployment's ID or its unique name
+    # @param release_id_or_release_tag [String] Either the UUID of Workflow Deployment Release you'd like to retrieve, or the
+#  name of a Release Tag that's pointing to the Workflow Deployment Release you'd
+#  like to retrieve.
+    # @param request_options [Vellum::RequestOptions] 
+    # @return [Vellum::WorkflowDeploymentRelease]
+    # @example
+#  api = Vellum::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Vellum::Environment::PRODUCTION,
+#    api_key: "YOUR_API_KEY"
+#  )
+#  api.release_reviews.retrieve_workflow_deployment_release(id: "id", release_id_or_release_tag: "release_id_or_release_tag")
+    def retrieve_workflow_deployment_release(id:, release_id_or_release_tag:, request_options: nil)
+      Async do
+        response = @request_client.conn.get do | req |
+  unless request_options&.timeout_in_seconds.nil?
+    req.options.timeout = request_options.timeout_in_seconds
+  end
+  unless request_options&.api_key.nil?
+    req.headers["X-API-KEY"] = request_options.api_key
+  end
+  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
+  unless request_options.nil? || request_options&.additional_query_parameters.nil?
+    req.params = { **(request_options&.additional_query_parameters || {}) }.compact
+  end
+  unless request_options.nil? || request_options&.additional_body_parameters.nil?
+    req.body = { **(request_options&.additional_body_parameters || {}) }.compact
+  end
+  req.url "#{@request_client.get_url(environment: Default, request_options: request_options)}/v1/workflow-deployments/#{id}/releases/#{release_id_or_release_tag}"
+end
+        Vellum::WorkflowDeploymentRelease.from_json(json_object: response.body)
+      end
+    end
+  end
+end