phaseo_sdk 2.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 442f1a085f0d40c85475b6a863d76ca22105403424729088e1e4a65ef7432b41
+  data.tar.gz: 011eb38bf5ec8a6c589afdce5f20f2e640a6943135b98405f8b4c48101042404
+SHA512:
+  metadata.gz: 3d4d6647a4f64012a98f0875647eb6ad2d5a9bd27f982ba0f1762d36e33c223ca93e66b69b9e563ebad9dbc2f03f7d0569cedf788a6f823ec5e89cb4b1fb07d9
+  data.tar.gz: 71af9cc544a1d6285cd06b1d4a15bd0dac40aa355648ddc77fe415b62a4e9479ca32c534e3751e83154153535acbc845978ebb4a4cd1cef90029dcf62c64cb73

data/README.md

@@ -0,0 +1,99 @@
+# Phaseo Ruby SDK
+
+Official Ruby SDK for Phaseo Gateway.
+
+RubyGems package name: `phaseo_sdk`
+
+## Installation
+
+```ruby
+gem "phaseo_sdk"
+```
+
+Then run:
+
+```bash
+bundle install
+```
+
+## Quick start
+
+```ruby
+require "phaseo_sdk"
+
+client = PhaseoSdk::Phaseo.new(
+  api_key: ENV.fetch("PHASEO_API_KEY"),
+  base_path: ENV.fetch("PHASEO_BASE_URL", "https://api.phaseo.app/v1")
+)
+
+response = client.create_response(
+  model: "google/gemma-3-27b:free",
+  input: "Reply with: Ruby SDK works"
+)
+
+puts response["id"]
+```
+
+## Common methods
+
+- `create_response(payload)`
+- `create_chat_completion(payload)`
+- `list_models(options = {})`
+- `list_organisations(options = {})` for paginated `/organisations` discovery
+- `list_pricing_models(options = {})` for `/pricing/models` catalogue pricing discovery
+- `calculate_pricing(payload)` for `/pricing/calculate` usage estimation
+- `list_providers(options = {})`, `get_credits(options = {})`, `get_activity(options = {})`, and `get_analytics(options = {})` for provider discovery and management-key usage surfaces
+- `list_api_keys(options = {})` for management-key `/keys` discovery
+- `create_api_key(payload)`, `update_api_key(id, payload)`, and `delete_api_key(id)` for management-key API-key lifecycle changes
+- `get_api_key(id)` for management-key `/keys/{id}` lookup
+- `list_workspaces(options = {})`, `get_workspace(id)`, `create_workspace(payload)`, `update_workspace(id, payload)`, and `delete_workspace(id)` for management-key workspace lifecycle management
+- `get_current_api_key`
+- `health`
+- `get_model_deprecation_info(model_id)`
+- `validate_model(model_id)`
+
+Model discovery supports the public `/models` filters, including `provider`, `provider_status`, `provider_routing_status`, `model_routing_status`, `capability_status`, `provider_availability_status`, `provider_availability_reason`, `status`, `organisation`, `endpoints`, `input_types`, `output_types`, `params`, `availability`, `limit`, and `offset`.
+
+Use `provider_availability_reason` with `availability: "all"` when you want rollout-state entries such as `preview_only`, `provider_not_ready`, `gated`, `access_limited`, `region_limited`, `project_limited`, `paused`, or `soft_blocked`. Use `capability_status` with `availability: "all"` when you want non-routable endpoint mappings such as `coming_soon` or `internal_testing`.
+
+```ruby
+models = client.list_models(
+  provider: "anthropic",
+  provider_status: "beta,not_ready",
+  provider_availability_reason: "preview_only,provider_not_ready",
+  capability_status: "coming_soon,internal_testing",
+  availability: "all",
+)
+```
+
+## Async job websocket helpers
+
+Batch and video operations can expose a websocket lifecycle stream at `/v1/async/{kind}/{id}/ws`.
+
+```ruby
+batch_socket_url = client.batch_websocket_url("batch_123", interval_ms: 1500)
+video_socket_url = client.video_websocket_url("video_123", close_on_terminal: true)
+generic_socket_url = client.get_async_job_websocket_url("video", "video_123")
+resource_socket_url = client.async_jobs.websocket_url("video", "video_123")
+
+puts batch_socket_url
+puts video_socket_url
+puts generic_socket_url
+puts resource_socket_url
+```
+
+## Free and paid models
+
+- Models with `:free` in the model ID can be called with zero deposited credits.
+- Paid models require available wallet balance.
+
+## Environment variables
+
+- `PHASEO_API_KEY` (required unless passed in code)
+- `PHASEO_BASE_URL` (optional, defaults to `https://api.phaseo.app/v1`)
+
+## Regeneration and local checks
+
+- Regenerate generated client: `pnpm openapi:gen:ruby`
+- Build gem: `pnpm --filter @phaseo/ruby-sdk run build`
+- Test: `pnpm --filter @phaseo/ruby-sdk run test`

data/examples/models.rb

@@ -0,0 +1,16 @@
+require_relative '../lib/index'
+
+api_key = ENV['PHASEO_API_KEY']
+raise 'Set PHASEO_API_KEY' unless api_key
+
+client = PhaseoSdk::Phaseo.new(api_key: api_key)
+resp = client.list_models(
+  provider: "anthropic",
+  provider_status: "beta,not_ready",
+  provider_availability_reason: "preview_only,provider_not_ready",
+  capability_status: "coming_soon,internal_testing",
+  availability: "all",
+  limit: 5,
+)
+models = resp.is_a?(Hash) ? (resp["models"] || []) : []
+puts "models: #{models.length}"

data/lib/gen/client.rb

@@ -0,0 +1,86 @@
+require "json"
+require "net/http"
+require "uri"
+
+module Phaseo
+  module Gen
+    class RequestError < StandardError
+      attr_reader :status_code, :response_body
+
+      def initialize(status_code:, response_body:, status_message: nil, message: nil)
+        super(message || build_message(status_code, response_body, status_message))
+        @status_code = status_code
+        @response_body = response_body
+      end
+
+      private
+
+      def build_message(status_code, response_body, status_message)
+        trimmed = response_body.to_s.strip
+        prefix = status_message.to_s.strip.empty? ? "Request failed: #{status_code}" : "Request failed: #{status_code} #{status_message}"
+        return prefix if trimmed.empty?
+
+        "#{prefix} #{trimmed}"
+      end
+    end
+
+    class Client
+      def initialize(base_url:, headers: {})
+        @base_url = base_url.chomp("/")
+        @headers = headers
+      end
+
+      def build_request(method:, path:, query: nil, headers: nil, body: nil)
+        uri = URI.join(@base_url + "/", path.sub(%r{^/}, ""))
+        uri.query = URI.encode_www_form(query) if query && !query.empty?
+        http = Net::HTTP.new(uri.host, uri.port)
+        http.use_ssl = uri.scheme == "https"
+        request_class = Net::HTTP.const_get(method.capitalize)
+        req = request_class.new(uri)
+        (@headers || {}).merge(headers || {}).each { |k, v| req[k] = v }
+        if body
+          req["Content-Type"] = "application/json"
+          req.body = JSON.dump(body)
+        end
+        [http, req]
+      end
+
+      def request(method:, path:, query: nil, headers: nil, body: nil)
+        http, req = build_request(method:, path:, query:, headers:, body:)
+        response = http.request(req)
+        unless response.is_a?(Net::HTTPSuccess)
+          raise RequestError.new(status_code: response.code.to_i, response_body: response.body.to_s)
+        end
+        return nil if response.body.nil? || response.body.empty?
+        JSON.parse(response.body)
+      end
+
+      def request_bytes(method:, path:, query: nil, headers: nil, body: nil)
+        http, req = build_request(method:, path:, query:, headers:, body:)
+        response = http.request(req)
+        unless response.is_a?(Net::HTTPSuccess)
+          raise RequestError.new(status_code: response.code.to_i, response_body: response.body.to_s)
+        end
+        response.body.to_s.b
+      end
+
+      def request_stream(method:, path:, query: nil, headers: nil, body: nil)
+        return enum_for(__method__, method:, path:, query:, headers:, body:) unless block_given?
+        http, req = build_request(method:, path:, query:, headers: (headers || {}).merge("Accept" => "text/event-stream"), body:)
+        http.request(req) do |response|
+          unless response.is_a?(Net::HTTPSuccess)
+            raise RequestError.new(status_code: response.code.to_i, response_body: response.body.to_s)
+          end
+          buffer = String.new
+          response.read_body do |chunk|
+            buffer << chunk
+            while (index = buffer.index("\n"))
+              yield buffer.slice!(0, index + 1).sub(/\r?\n\z/, "")
+            end
+          end
+          yield buffer unless buffer.empty?
+        end
+      end
+    end
+  end
+end