abliteration 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 86d53e9c1892282ea65bf0170590ab42e6114597c68f0ef4190a7467ea60fe53
-  data.tar.gz: 5678813c43c8b7a30354d136c178111119ddcab67305894d3b9a2ee7ed0e420b
+  metadata.gz: 125b5d1033cb3b5e2d0c6da086a00dfae95d47033f9856c22bc5408e17d3061a
+  data.tar.gz: 313918f4f4d3961d98d544923972e21723391be8d7dde10d9c0b188d8fa170fc
 SHA512:
-  metadata.gz: 97df8f12b1d77c43597a086d18dce018a2cd689d7bb41fa9e9a0b226f28a8549ae5d6ae81c61fcedd0283a5397ddf5a962cd26bb76a797bf2df097cce3faf62f
-  data.tar.gz: 59001abbe69bad3e5adda01b804edb9af56401305fb9112d4d5088568a3a6e6c4d20ad8635d6f7aa17095bf4f3d5ddae017705e2521929cf0ebcfb8694b9dc9a
+  metadata.gz: 2430b73a8e7fd183ddfc2de02670bb09b7d04e1e3740894bf0870add4124fe83a2ed6ef400c3113efa087e3f5cf3dc7c9b3f5f3c01db62719c4a15677cd04b6c
+  data.tar.gz: 16b2290403b2231e95d0fbe322ebf3c884864548286a7b1c3d2fc2c9485bd82e2fa7e59ea4ba7a589fff5768d7e871b1a477e007a4b0a2e42b6e9439cb0272e6

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'rake', '~> 13.0.1'
+  gem 'pry-byebug'
+  gem 'rubocop', '~> 0.66.0'
+end

data/README.md

@@ -1,17 +1,65 @@
-# abliteration
+# abliteration (Ruby)
 
-Ruby wrapper for the [abliteration.org](https://abliteration.org) catalog API.
+Auto-generated Ruby client for the [abliteration.org](https://abliteration.org) catalog API. Covers every route on `/api/v1` with typed models.
 
-**Status:** namespace-reserved. A real Ruby client is planned. Until then, use the HTTP API directly or the [Node.js CLI](https://www.npmjs.com/package/@abliteration/cli):
+## Install
 
 ```bash
-npm install -g @abliteration/cli
-abl login
-abl models --method M4 --limit 5
+gem install abliteration
+```
+
+Or in your `Gemfile`:
+
+```ruby
+gem 'abliteration', '~> 0.1'
+```
+
+## Get a key
+
+Generate a Bearer token at <https://abliteration.org/shop/account#api-keys>. Then either export it or configure the client explicitly.
+
+```bash
+export ABLITERATION_API_KEY=abl_live_...
+```
+
+## Quick start
+
+```ruby
+require 'abliteration'
+
+Abliteration.configure do |c|
+  c.access_token = ENV['ABLITERATION_API_KEY']
+end
+
+api = Abliteration::ModelsApi.new
+result = api.list_models(method: 'M4', limit: 5)
+result.data.each do |m|
+  puts "#{m.id} - #{m.downloads}"
+end
+
+# Envelope also carries billing/rate-limit metadata:
+puts "spent: #{result.cost}, wallet: #{result.credits_remaining}"
 ```
 
 Full API docs: <https://abliteration.org/api>
 
+## Available APIs
+
+- `ModelsApi` - list and detail
+- `MethodsApi` - M1-M9 taxonomy
+- `IndicesApi` - DAI, Freedom Velocity, Weaponization, F2W Latency
+- `AuthorsApi`, `DatasetsApi`, `TimelineApi`
+
+## Alternatives
+
+- Python: `pip install abliteration`
+- CLI (Node): `npm install -g @abliteration/cli`
+- HTTP directly: any Ruby HTTP client + `Authorization: Bearer` header
+
 ## License
 
-MIT
+MIT.
+
+---
+
+*This client is auto-generated from the OpenAPI spec at [/api/v1/openapi.json](https://abliteration.org/api/v1/openapi.json) using [openapi-generator](https://openapi-generator.tech).*

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/abliteration.gemspec

@@ -1,22 +1,39 @@
-Gem::Specification.new do |spec|
-  spec.name          = 'abliteration'
-  spec.version       = '0.0.1'
-  spec.authors       = ['Catyonic OU']
-  spec.email         = ['antifaust@gmail.com']
-
-  spec.summary       = 'Ruby wrapper for the abliteration.org catalog API (coming soon)'
-  spec.description   = 'A Ruby client for abliteration.org catalog API is planned. ' \
-                       'For now, use the HTTP API directly or the Node.js CLI ' \
-                       '(npm install -g @abliteration/cli).'
-  spec.homepage      = 'https://abliteration.org/api'
-  spec.license       = 'MIT'
-
-  spec.required_ruby_version = '>= 2.7.0'
-
-  spec.metadata['homepage_uri']    = 'https://abliteration.org/api'
-  spec.metadata['documentation_uri'] = 'https://abliteration.org/api'
-  spec.metadata['bug_tracker_uri'] = 'https://abliteration.org/api'
-
-  spec.files = ['lib/abliteration.rb', 'README.md', 'abliteration.gemspec']
-  spec.require_paths = ['lib']
+# -*- encoding: utf-8 -*-
+
+=begin
+#abliteration.org Public API
+
+#Read access to the abliteration.org catalog: models and their method classification, alignment datasets and their passports, the M-code taxonomy, the four flagship indices and the curated field timeline.  Every call is authenticated with a bearer key and metered in credits against the same wallet the Research Agent spends from. There is no free tier for machine traffic and no separate billing.  Responses report `cost` and `credits_remaining` on every success. While `metering` reads `preview`, the cost shown is what the call will bill once metering is enabled and nothing is actually deducted; when it reads `billed`, it was.
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.25.0
+
+=end
+
+$:.push File.expand_path("../lib", __FILE__)
+require "abliteration/version"
+
+Gem::Specification.new do |s|
+  s.name        = "abliteration"
+  s.version     = Abliteration::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Catyonic OU"]
+  s.email       = ["contact@catyonic.com"]
+  s.homepage    = "https://abliteration.org/api"
+  s.summary     = "Ruby client for the abliteration.org catalog API"
+  s.description = "Auto-generated Ruby client for the abliteration.org LLM catalog API. Covers every route on /api/v1 with typed models and error responses."
+  s.license     = "MIT"
+  s.required_ruby_version = ">= 2.7"
+  s.metadata    = {}
+
+  s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
+
+  s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'
+
+  s.files         = `find *`.split("\n").uniq.sort.select { |f| !f.empty? }
+  s.test_files    = `find spec/*`.split("\n")
+  s.executables   = []
+  s.require_paths = ["lib"]
 end

data/docs/Author.md

@@ -0,0 +1,26 @@
+# Abliteration::Author
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **author** | **String** |  | [optional] |
+| **total_models** | **Integer** |  | [optional] |
+| **total_downloads** | **Integer** |  | [optional] |
+| **total_likes** | **Integer** |  | [optional] |
+| **first_seen_at** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'abliteration'
+
+instance = Abliteration::Author.new(
+  author: null,
+  total_models: null,
+  total_downloads: null,
+  total_likes: null,
+  first_seen_at: null
+)
+```
+

data/docs/AuthorDetail.md

@@ -0,0 +1,28 @@
+# Abliteration::AuthorDetail
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **author** | **String** |  | [optional] |
+| **total_models** | **Integer** |  | [optional] |
+| **total_downloads** | **Integer** |  | [optional] |
+| **total_likes** | **Integer** |  | [optional] |
+| **first_seen_at** | **String** |  | [optional] |
+| **models** | [**Array<ModelSummary>**](ModelSummary.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'abliteration'
+
+instance = Abliteration::AuthorDetail.new(
+  author: null,
+  total_models: null,
+  total_downloads: null,
+  total_likes: null,
+  first_seen_at: null,
+  models: null
+)
+```
+

data/docs/AuthorsApi.md

@@ -0,0 +1,153 @@
+# Abliteration::AuthorsApi
+
+All URIs are relative to *https://abliteration.org*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_author**](AuthorsApi.md#get_author) | **GET** /api/v1/authors/{id} | Get one author |
+| [**list_authors**](AuthorsApi.md#list_authors) | **GET** /api/v1/authors | List authors |
+
+
+## get_author
+
+> <GetAuthor200Response> get_author(id)
+
+Get one author
+
+Cost: 1 credit.
+
+### Examples
+
+```ruby
+require 'time'
+require 'abliteration'
+# setup authorization
+Abliteration.configure do |config|
+  # Configure Bearer authorization: bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Abliteration::AuthorsApi.new
+id = 'mlabonne' # String | 
+
+begin
+  # Get one author
+  result = api_instance.get_author(id)
+  p result
+rescue Abliteration::ApiError => e
+  puts "Error when calling AuthorsApi->get_author: #{e}"
+end
+```
+
+#### Using the get_author_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetAuthor200Response>, Integer, Hash)> get_author_with_http_info(id)
+
+```ruby
+begin
+  # Get one author
+  data, status_code, headers = api_instance.get_author_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetAuthor200Response>
+rescue Abliteration::ApiError => e
+  puts "Error when calling AuthorsApi->get_author_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+
+### Return type
+
+[**GetAuthor200Response**](GetAuthor200Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_authors
+
+> <ListAuthors200Response> list_authors(opts)
+
+List authors
+
+Cost: 5-15 credits, by rows returned.
+
+### Examples
+
+```ruby
+require 'time'
+require 'abliteration'
+# setup authorization
+Abliteration.configure do |config|
+  # Configure Bearer authorization: bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Abliteration::AuthorsApi.new
+opts = {
+  sort: 'total_downloads', # String | 
+  limit: 56, # Integer | Rows to return, 1 to 1000. Values outside the range are clamped, not rejected.
+  offset: 56 # Integer | Rows to skip. Negative and non-numeric values are treated as 0.
+}
+
+begin
+  # List authors
+  result = api_instance.list_authors(opts)
+  p result
+rescue Abliteration::ApiError => e
+  puts "Error when calling AuthorsApi->list_authors: #{e}"
+end
+```
+
+#### Using the list_authors_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ListAuthors200Response>, Integer, Hash)> list_authors_with_http_info(opts)
+
+```ruby
+begin
+  # List authors
+  data, status_code, headers = api_instance.list_authors_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ListAuthors200Response>
+rescue Abliteration::ApiError => e
+  puts "Error when calling AuthorsApi->list_authors_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **sort** | **String** |  | [optional][default to &#39;-total_downloads&#39;] |
+| **limit** | **Integer** | Rows to return, 1 to 1000. Values outside the range are clamped, not rejected. | [optional][default to 50] |
+| **offset** | **Integer** | Rows to skip. Negative and non-numeric values are treated as 0. | [optional][default to 0] |
+
+### Return type
+
+[**ListAuthors200Response**](ListAuthors200Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/DaiPoint.md

@@ -0,0 +1,22 @@
+# Abliteration::DaiPoint
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **month** | **String** |  | [optional] |
+| **weighted_dai_pct** | **Float** |  | [optional] |
+| **bases_included** | **Integer** |  | [optional] |
+
+## Example
+
+```ruby
+require 'abliteration'
+
+instance = Abliteration::DaiPoint.new(
+  month: 2026-09,
+  weighted_dai_pct: null,
+  bases_included: null
+)
+```
+

data/docs/Dataset.md

@@ -0,0 +1,38 @@
+# Abliteration::Dataset
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [optional] |
+| **author** | **String** |  | [optional] |
+| **slug** | **String** |  | [optional] |
+| **category** | **String** |  | [optional] |
+| **license** | **String** |  | [optional] |
+| **downloads** | **Integer** |  | [optional] |
+| **downloads_all** | **Integer** |  | [optional] |
+| **likes** | **Integer** |  | [optional] |
+| **gated** | **Integer** |  | [optional] |
+| **created_at** | **String** |  | [optional] |
+| **first_seen_at** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'abliteration'
+
+instance = Abliteration::Dataset.new(
+  id: null,
+  author: null,
+  slug: null,
+  category: null,
+  license: null,
+  downloads: null,
+  downloads_all: null,
+  likes: null,
+  gated: null,
+  created_at: null,
+  first_seen_at: null
+)
+```
+

data/docs/DatasetDetail.md

@@ -0,0 +1,22 @@
+# Abliteration::DatasetDetail
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [optional] |
+| **files** | **Array<Object>** |  | [optional] |
+| **passport** | [**Passport**](Passport.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'abliteration'
+
+instance = Abliteration::DatasetDetail.new(
+  id: null,
+  files: null,
+  passport: null
+)
+```
+

data/docs/DatasetsApi.md

@@ -0,0 +1,159 @@
+# Abliteration::DatasetsApi
+
+All URIs are relative to *https://abliteration.org*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_dataset**](DatasetsApi.md#get_dataset) | **GET** /api/v1/datasets/{id} | Get one dataset |
+| [**list_datasets**](DatasetsApi.md#list_datasets) | **GET** /api/v1/datasets | List datasets |
+
+
+## get_dataset
+
+> <GetDataset200Response> get_dataset(id)
+
+Get one dataset
+
+Cost: 1 credit. The passport is null for datasets that do not have one yet.
+
+### Examples
+
+```ruby
+require 'time'
+require 'abliteration'
+# setup authorization
+Abliteration.configure do |config|
+  # Configure Bearer authorization: bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Abliteration::DatasetsApi.new
+id = 'mlabonne/orpo-dpo-mix-40k' # String | 
+
+begin
+  # Get one dataset
+  result = api_instance.get_dataset(id)
+  p result
+rescue Abliteration::ApiError => e
+  puts "Error when calling DatasetsApi->get_dataset: #{e}"
+end
+```
+
+#### Using the get_dataset_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetDataset200Response>, Integer, Hash)> get_dataset_with_http_info(id)
+
+```ruby
+begin
+  # Get one dataset
+  data, status_code, headers = api_instance.get_dataset_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetDataset200Response>
+rescue Abliteration::ApiError => e
+  puts "Error when calling DatasetsApi->get_dataset_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+
+### Return type
+
+[**GetDataset200Response**](GetDataset200Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_datasets
+
+> <ListDatasets200Response> list_datasets(opts)
+
+List datasets
+
+Cost: 5-15 credits, by rows returned.
+
+### Examples
+
+```ruby
+require 'time'
+require 'abliteration'
+# setup authorization
+Abliteration.configure do |config|
+  # Configure Bearer authorization: bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Abliteration::DatasetsApi.new
+opts = {
+  category: 'category_example', # String | Workflow stage, for example heal or extract.
+  author: 'author_example', # String | Publisher handle, case-insensitive.
+  license: 'license_example', # String | License string as published.
+  sort: 'downloads', # String | 
+  limit: 56, # Integer | Rows to return, 1 to 1000. Values outside the range are clamped, not rejected.
+  offset: 56 # Integer | Rows to skip. Negative and non-numeric values are treated as 0.
+}
+
+begin
+  # List datasets
+  result = api_instance.list_datasets(opts)
+  p result
+rescue Abliteration::ApiError => e
+  puts "Error when calling DatasetsApi->list_datasets: #{e}"
+end
+```
+
+#### Using the list_datasets_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ListDatasets200Response>, Integer, Hash)> list_datasets_with_http_info(opts)
+
+```ruby
+begin
+  # List datasets
+  data, status_code, headers = api_instance.list_datasets_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ListDatasets200Response>
+rescue Abliteration::ApiError => e
+  puts "Error when calling DatasetsApi->list_datasets_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **category** | **String** | Workflow stage, for example heal or extract. | [optional] |
+| **author** | **String** | Publisher handle, case-insensitive. | [optional] |
+| **license** | **String** | License string as published. | [optional] |
+| **sort** | **String** |  | [optional][default to &#39;-downloads&#39;] |
+| **limit** | **Integer** | Rows to return, 1 to 1000. Values outside the range are clamped, not rejected. | [optional][default to 50] |
+| **offset** | **Integer** | Rows to skip. Negative and non-numeric values are treated as 0. | [optional][default to 0] |
+
+### Return type
+
+[**ListDatasets200Response**](ListDatasets200Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/Envelope.md

@@ -0,0 +1,32 @@
+# Abliteration::Envelope
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | **Object** | The payload. An array on list routes, an object on single-entity routes. |  |
+| **cost** | **Integer** | Credits this call costs. |  |
+| **credits_remaining** | **Integer** | Wallet balance after the call. Unchanged while metering is preview. |  |
+| **rate_limit_limit** | **Integer** | Ceiling for the current window. Also returned as X-RateLimit-Limit. |  |
+| **rate_limit_remaining** | **Integer** | Calls left in the current window for this key. Also returned as X-RateLimit-Remaining. |  |
+| **rate_limit_reset** | **Integer** | Unix seconds at which the window resets to full ceiling. Also returned as X-RateLimit-Reset. |  |
+| **metering** | **String** | Whether cost was actually deducted. |  |
+| **request_id** | **String** | Also returned in the x-request-id header. |  |
+
+## Example
+
+```ruby
+require 'abliteration'
+
+instance = Abliteration::Envelope.new(
+  data: null,
+  cost: null,
+  credits_remaining: null,
+  rate_limit_limit: null,
+  rate_limit_remaining: null,
+  rate_limit_reset: null,
+  metering: null,
+  request_id: null
+)
+```
+

data/docs/Error.md

@@ -0,0 +1,26 @@
+# Abliteration::Error
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **error** | **String** | Stable machine-readable slug. |  |
+| **message** | **String** | Human-readable detail. May be reworded at any time. | [optional] |
+| **retry_after** | **Integer** | Seconds to wait. Present on 429. | [optional] |
+| **credits_remaining** | **Integer** | Present on 402. | [optional] |
+| **request_id** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'abliteration'
+
+instance = Abliteration::Error.new(
+  error: null,
+  message: null,
+  retry_after: null,
+  credits_remaining: null,
+  request_id: null
+)
+```
+