fetch_hive 0.2.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cb9c7b6224f335829b0c44df8fcbf9eb51a116d1adc8349662d5f19299fe0561
+  data.tar.gz: 00c639eeb3ae5857ba4044d481ece8f4e61d443522eec500e52ce05f1aa35406
+SHA512:
+  metadata.gz: e202d13a1a682b2ceaa470e07153b42c2959398d6dfea6c15a4661c298fcbace443f557110b2783186eaac2186cc0ee50913a4948f68328f9981f029af5ca696
+  data.tar.gz: 911804e51870a54f5be80bd57fcb56088adf098fd9fbec00f518505eff89e68afb7ef28df44b9b80fcac2db2621bba4a2997ead022096e9ce792460aede7d663

data/README.md

@@ -0,0 +1,64 @@
+# Fetch Hive Ruby SDK
+
+Official Ruby SDK for the [Fetch Hive](https://fetchhive.com) API — invoke prompts, workflows, and agents with a clean, idiomatic interface.
+
+**Version:** 0.2.2
+
+## Installation
+
+Add to your `Gemfile`:
+
+```ruby
+gem "fetch_hive", "~> 0.2.2"
+```
+
+Then run:
+
+```bash
+bundle install
+```
+
+Or install directly:
+
+```bash
+gem install fetch_hive
+```
+
+## Quick start
+
+```ruby
+require "fetch_hive"
+
+client = FetchHive::Client.new(api_key: ENV["FETCH_HIVE_API_KEY"])
+
+# Invoke a prompt
+result = client.invoke_prompt(deployment: "my-prompt", inputs: { name: "Alice" })
+puts result["response"]
+
+# Invoke a workflow
+run = client.invoke_workflow(deployment: "my-workflow", inputs: { topic: "AI" })
+puts run["output"]
+
+# Send a message to an agent (non-streaming)
+reply = client.invoke_agent(agent: "my-agent", message: "Hello!")
+puts reply["response"]
+
+# Stream an agent response
+client.invoke_agent_stream(agent: "my-agent", message: "Tell me a story") do |chunk|
+  print chunk["content"] if chunk["type"] == "delta"
+end
+```
+
+## Configuration
+
+| Option | Default | Description |
+|---|---|---|
+| `api_key` | `ENV["FETCH_HIVE_API_KEY"]` | Bearer token from the Fetch Hive dashboard |
+| `base_url` | `https://api.fetchhive.com/v1` | Override the API base URL |
+| `timeout` | `120` | Request timeout in seconds |
+
+## Links
+
+- [Fetch Hive dashboard](https://app.fetchhive.com)
+- [API documentation](https://docs.fetchhive.com)
+- [GitHub](https://github.com/Fetch-Hive/ruby-sdk)

data/lib/fetch_hive/client.rb

@@ -0,0 +1,160 @@
+# frozen_string_literal: true
+
+require "faraday"
+require "json"
+require_relative "streaming"
+
+module FetchHive
+  # Idiomatic facade over the OpenAPI-generated code.
+  #
+  # Usage:
+  #
+  #   client = FetchHive::Client.new(api_key: ENV["FETCH_HIVE_API_KEY"])
+  #
+  #   # Non-streaming prompt
+  #   result = client.invoke_prompt(deployment: "my-prompt", inputs: { name: "Alice" })
+  #   puts result["response"]
+  #
+  #   # Streaming agent
+  #   client.invoke_agent_stream(agent: "my-agent", message: "Hello") do |chunk|
+  #     print chunk["content"] if chunk["type"] == "delta"
+  #   end
+  #
+  class Client
+    DEFAULT_BASE_URL = "https://api.fetchhive.com/v1"
+
+    # @param api_key  [String, nil] Bearer token. Falls back to +FETCH_HIVE_API_KEY+ env var.
+    # @param base_url [String]      Override the API base URL.
+    # @param timeout  [Integer]     Request timeout in seconds (default: 120).
+    def initialize(api_key: nil, base_url: DEFAULT_BASE_URL, timeout: 120)
+      resolved = api_key || ENV["FETCH_HIVE_API_KEY"]
+      raise ArgumentError, "api_key is required. Pass it explicitly or set FETCH_HIVE_API_KEY." if resolved.nil? || resolved.empty?
+
+      @api_key  = resolved
+      @base_url = base_url.to_s.sub(%r{/+\z}, "")
+      @timeout  = timeout
+    end
+
+    # ── Prompt ─────────────────────────────────────────────────────────────────
+
+    # Invoke a prompt deployment and return the full response hash.
+    def invoke_prompt(deployment:, variant: nil, inputs: nil, user: nil)
+      body = { deployment: deployment, streaming: false }
+      body[:variant] = variant if variant
+      body[:inputs]  = inputs  if inputs
+      body[:user]    = user    if user
+      post("/invoke", body)
+    end
+
+    # Invoke a prompt deployment and stream SSE events.
+    # Yields each parsed event hash. Returns an Enumerator when no block given.
+    def invoke_prompt_stream(deployment:, variant: nil, inputs: nil, user: nil, &block)
+      body = { deployment: deployment, streaming: true }
+      body[:variant] = variant if variant
+      body[:inputs]  = inputs  if inputs
+      body[:user]    = user    if user
+      post_stream("/invoke", body, &block)
+    end
+
+    # ── Workflow ────────────────────────────────────────────────────────────────
+
+    # Invoke a workflow deployment (sync or async).
+    def invoke_workflow(deployment:, variant: nil, inputs: nil, async_mode: false, callback_url: nil, user: nil)
+      body = { deployment: deployment }
+      body[:variant] = variant if variant
+      body[:inputs]  = inputs  if inputs
+      body[:user]    = user    if user
+      if async_mode
+        body[:async] = { enabled: true }
+        body[:async][:callback_url] = callback_url if callback_url
+      end
+      post("/workflow/invoke", body)
+    end
+
+    # ── Agent ───────────────────────────────────────────────────────────────────
+
+    # Send a message to an agent and return the full response hash.
+    def invoke_agent(agent:, message:, thread_id: nil, user: nil, messages: nil, image_urls: nil)
+      body = { agent: agent, message: message, streaming: false }
+      body[:thread_id]  = thread_id  if thread_id
+      body[:user]       = user       if user
+      body[:messages]   = messages   if messages
+      body[:image_urls] = image_urls if image_urls
+      post("/agent/invoke", body)
+    end
+
+    # Send a message to an agent and stream SSE events.
+    # Yields each parsed event hash. Returns an Enumerator when no block given.
+    def invoke_agent_stream(agent:, message:, thread_id: nil, user: nil, messages: nil, image_urls: nil, &block)
+      body = { agent: agent, message: message, streaming: true }
+      body[:thread_id]  = thread_id  if thread_id
+      body[:user]       = user       if user
+      body[:messages]   = messages   if messages
+      body[:image_urls] = image_urls if image_urls
+      post_stream("/agent/invoke", body, &block)
+    end
+
+    private
+
+    def default_headers
+      {
+        "Authorization" => "Bearer #{@api_key}",
+        "Content-Type"  => "application/json"
+      }
+    end
+
+    def connection
+      Faraday.new(url: @base_url, request: { timeout: @timeout }) do |f|
+        f.adapter Faraday.default_adapter
+      end
+    end
+
+    def post(path, body)
+      resp = connection.post(path) do |req|
+        req.headers.merge!(default_headers)
+        req.body = JSON.generate(body)
+      end
+      raise "FetchHive API error #{resp.status}: #{resp.body}" unless resp.success?
+
+      JSON.parse(resp.body)
+    end
+
+    def post_stream(path, body, &block)
+      return enum_for(:post_stream, path, body) unless block
+
+      io, writer = IO.pipe
+
+      thread = Thread.new do
+        conn = Faraday.new(url: @base_url, request: { timeout: @timeout }) do |f|
+          f.adapter Faraday.default_adapter
+        end
+
+        resp = conn.post(path) do |req|
+          req.headers.merge!(default_headers)
+          req.body = JSON.generate(body)
+          req.options.on_data = proc do |chunk, _size, env|
+            if env && !env.status.between?(200, 299)
+              writer.close
+              raise "FetchHive API error #{env.status}: #{chunk}"
+            end
+            writer.write(chunk)
+          end
+        end
+
+        unless resp.success?
+          writer.close
+          raise "FetchHive API error #{resp.status}: #{resp.body}"
+        end
+
+        writer.close
+      end
+
+      begin
+        FetchHive::Streaming.parse_sse(io, &block)
+      ensure
+        io.close
+        thread.join
+      end
+    end
+  end
+end

data/lib/fetch_hive/generated/api/agents_api.rb

@@ -0,0 +1,90 @@
+=begin
+#Fetch Hive Public API
+
+#The Fetch Hive public API lets you invoke prompts, workflows, and agents programmatically using an API token.  ## Authentication All requests require a Bearer token in the `Authorization` header: ``` Authorization: Bearer <your-api-token> ```  ## Streaming Pass `\"streaming\": true` in the request body to receive a `text/event-stream` response. Each event is a JSON object sent as `data: <json>\\n\\n`. The stream ends with `data: [DONE]\\n\\n`. 
+
+The version of the OpenAPI document: 0.2.2
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.22.0
+
+=end
+
+require 'cgi'
+
+module FetchHive::Generated
+  class AgentsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Invoke an agent
+    # Sends a message to a configured agent and returns its response. Agents can use tools, maintain conversation history via `thread_id`, or accept ephemeral history via the `messages` field.  Set `streaming: true` to receive a Server-Sent Events stream. Each `data:` line contains a JSON object of type `SseChunk`.  Image URLs can be supplied in `image_urls` for multimodal inputs (must be HTTPS). 
+    # @param invoke_agent_request [InvokeAgentRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [InvokeAgentResponse]
+    def invoke_agent(invoke_agent_request, opts = {})
+      data, _status_code, _headers = invoke_agent_with_http_info(invoke_agent_request, opts)
+      data
+    end
+
+    # Invoke an agent
+    # Sends a message to a configured agent and returns its response. Agents can use tools, maintain conversation history via &#x60;thread_id&#x60;, or accept ephemeral history via the &#x60;messages&#x60; field.  Set &#x60;streaming: true&#x60; to receive a Server-Sent Events stream. Each &#x60;data:&#x60; line contains a JSON object of type &#x60;SseChunk&#x60;.  Image URLs can be supplied in &#x60;image_urls&#x60; for multimodal inputs (must be HTTPS). 
+    # @param invoke_agent_request [InvokeAgentRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(InvokeAgentResponse, Integer, Hash)>] InvokeAgentResponse data, response status code and response headers
+    def invoke_agent_with_http_info(invoke_agent_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AgentsApi.invoke_agent ...'
+      end
+      # verify the required parameter 'invoke_agent_request' is set
+      if @api_client.config.client_side_validation && invoke_agent_request.nil?
+        fail ArgumentError, "Missing the required parameter 'invoke_agent_request' when calling AgentsApi.invoke_agent"
+      end
+      # resource path
+      local_var_path = '/agent/invoke'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(invoke_agent_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'InvokeAgentResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['BearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"AgentsApi.invoke_agent",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AgentsApi#invoke_agent\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/fetch_hive/generated/api/prompts_api.rb

@@ -0,0 +1,90 @@
+=begin
+#Fetch Hive Public API
+
+#The Fetch Hive public API lets you invoke prompts, workflows, and agents programmatically using an API token.  ## Authentication All requests require a Bearer token in the `Authorization` header: ``` Authorization: Bearer <your-api-token> ```  ## Streaming Pass `\"streaming\": true` in the request body to receive a `text/event-stream` response. Each event is a JSON object sent as `data: <json>\\n\\n`. The stream ends with `data: [DONE]\\n\\n`. 
+
+The version of the OpenAPI document: 0.2.2
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.22.0
+
+=end
+
+require 'cgi'
+
+module FetchHive::Generated
+  class PromptsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Invoke a prompt deployment
+    # Runs a configured prompt deployment and returns the model response. Set `streaming: true` to receive a Server-Sent Events stream instead of a single JSON object. 
+    # @param invoke_prompt_request [InvokePromptRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [InvokePromptResponse]
+    def invoke_prompt(invoke_prompt_request, opts = {})
+      data, _status_code, _headers = invoke_prompt_with_http_info(invoke_prompt_request, opts)
+      data
+    end
+
+    # Invoke a prompt deployment
+    # Runs a configured prompt deployment and returns the model response. Set &#x60;streaming: true&#x60; to receive a Server-Sent Events stream instead of a single JSON object. 
+    # @param invoke_prompt_request [InvokePromptRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(InvokePromptResponse, Integer, Hash)>] InvokePromptResponse data, response status code and response headers
+    def invoke_prompt_with_http_info(invoke_prompt_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PromptsApi.invoke_prompt ...'
+      end
+      # verify the required parameter 'invoke_prompt_request' is set
+      if @api_client.config.client_side_validation && invoke_prompt_request.nil?
+        fail ArgumentError, "Missing the required parameter 'invoke_prompt_request' when calling PromptsApi.invoke_prompt"
+      end
+      # resource path
+      local_var_path = '/invoke'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(invoke_prompt_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'InvokePromptResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['BearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"PromptsApi.invoke_prompt",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: PromptsApi#invoke_prompt\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/fetch_hive/generated/api/workflows_api.rb

@@ -0,0 +1,90 @@
+=begin
+#Fetch Hive Public API
+
+#The Fetch Hive public API lets you invoke prompts, workflows, and agents programmatically using an API token.  ## Authentication All requests require a Bearer token in the `Authorization` header: ``` Authorization: Bearer <your-api-token> ```  ## Streaming Pass `\"streaming\": true` in the request body to receive a `text/event-stream` response. Each event is a JSON object sent as `data: <json>\\n\\n`. The stream ends with `data: [DONE]\\n\\n`. 
+
+The version of the OpenAPI document: 0.2.2
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.22.0
+
+=end
+
+require 'cgi'
+
+module FetchHive::Generated
+  class WorkflowsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Invoke a workflow deployment
+    # Runs a configured workflow deployment. Supports both synchronous and asynchronous execution via the `async` field.  When `async.enabled` is `false` (default), the request blocks until the workflow completes and returns the output directly.  When `async.enabled` is `true`, the server returns a `202` with a `run_id`. Poll `GET /v1/workflow_runs/{id}` on the management API to check status. 
+    # @param invoke_workflow_request [InvokeWorkflowRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [InvokeWorkflowResponse]
+    def invoke_workflow(invoke_workflow_request, opts = {})
+      data, _status_code, _headers = invoke_workflow_with_http_info(invoke_workflow_request, opts)
+      data
+    end
+
+    # Invoke a workflow deployment
+    # Runs a configured workflow deployment. Supports both synchronous and asynchronous execution via the &#x60;async&#x60; field.  When &#x60;async.enabled&#x60; is &#x60;false&#x60; (default), the request blocks until the workflow completes and returns the output directly.  When &#x60;async.enabled&#x60; is &#x60;true&#x60;, the server returns a &#x60;202&#x60; with a &#x60;run_id&#x60;. Poll &#x60;GET /v1/workflow_runs/{id}&#x60; on the management API to check status. 
+    # @param invoke_workflow_request [InvokeWorkflowRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(InvokeWorkflowResponse, Integer, Hash)>] InvokeWorkflowResponse data, response status code and response headers
+    def invoke_workflow_with_http_info(invoke_workflow_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: WorkflowsApi.invoke_workflow ...'
+      end
+      # verify the required parameter 'invoke_workflow_request' is set
+      if @api_client.config.client_side_validation && invoke_workflow_request.nil?
+        fail ArgumentError, "Missing the required parameter 'invoke_workflow_request' when calling WorkflowsApi.invoke_workflow"
+      end
+      # resource path
+      local_var_path = '/workflow/invoke'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(invoke_workflow_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'InvokeWorkflowResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['BearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"WorkflowsApi.invoke_workflow",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: WorkflowsApi#invoke_workflow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end