abliteration 0.0.1 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 86d53e9c1892282ea65bf0170590ab42e6114597c68f0ef4190a7467ea60fe53
-  data.tar.gz: 5678813c43c8b7a30354d136c178111119ddcab67305894d3b9a2ee7ed0e420b
+  metadata.gz: 930048af7914198ecdd2ad300cbd5827447316fc3a112bbe0fc5844c2e9ddd9a
+  data.tar.gz: bd3f3ef798683cce29bf1f03cff941113c52de594a151d1bed8a7b36fa8f4d67
 SHA512:
-  metadata.gz: 97df8f12b1d77c43597a086d18dce018a2cd689d7bb41fa9e9a0b226f28a8549ae5d6ae81c61fcedd0283a5397ddf5a962cd26bb76a797bf2df097cce3faf62f
-  data.tar.gz: 59001abbe69bad3e5adda01b804edb9af56401305fb9112d4d5088568a3a6e6c4d20ad8635d6f7aa17095bf4f3d5ddae017705e2521929cf0ebcfb8694b9dc9a
+  metadata.gz: '0773808bc6776876aa64b5823ecce1ba35c76fae49e3634691296ec30efae25f09b44a38720c2ffbce094d3457db696fa8abf54a2dca29e1ef47525e4de320f4'
+  data.tar.gz: a2e281a0f34b542d64adadbceb16c80f8d3e525864430fe6bc26d29dc1ac6fd46f3c69a2db784cccd185685465151e3cfe52bea9ccaf4535978924cbadf731dc

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,143 @@
 # abliteration
 
-Ruby wrapper for the [abliteration.org](https://abliteration.org) catalog API.
+Abliteration - the Ruby gem for the abliteration.org Public API
 
-**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):
+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.
+
+This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
+
+- API version: 1.0.0
+- Package version: 0.1.0
+- Generator version: 7.25.0
+- Build package: org.openapitools.codegen.languages.RubyClientCodegen
+For more information, please visit [https://abliteration.org/api](https://abliteration.org/api)
+
+## Installation
+
+### Build a gem
+
+To build the Ruby code into a gem:
+
+```shell
+gem build abliteration.gemspec
+```
+
+Then either install the gem locally:
+
+```shell
+gem install ./abliteration-0.1.0.gem
+```
+
+(for development, run `gem install --dev ./abliteration-0.1.0.gem` to install the development dependencies)
+
+or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
+
+Finally add this to the Gemfile:
+
+    gem 'abliteration', '~> 0.1.0'
+
+### Install from Git
+
+If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
+
+    gem 'abliteration', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
+
+### Include the Ruby code directly
+
+Include the Ruby code directly using `-I` as follows:
+
+```shell
+ruby -Ilib script.rb
+```
+
+## Getting Started
+
+Please follow the [installation](#installation) procedure and then run the following code:
+
+```ruby
+# Load the gem
+require 'abliteration'
+
+# Setup authorization
+Abliteration.configure do |config|
+  # Configure Bearer authorization: bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+  # Configure a proc to get access tokens in lieu of the static access_token configuration
+  config.access_token_getter = -> { 'YOUR TOKEN GETTER PROC' } 
+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 "Exception when calling AuthorsApi->get_author: #{e}"
+end
 
-```bash
-npm install -g @abliteration/cli
-abl login
-abl models --method M4 --limit 5
 ```
 
-Full API docs: <https://abliteration.org/api>
+## Documentation for API Endpoints
+
+All URIs are relative to *https://abliteration.org*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*Abliteration::AuthorsApi* | [**get_author**](docs/AuthorsApi.md#get_author) | **GET** /api/v1/authors/{id} | Get one author
+*Abliteration::AuthorsApi* | [**list_authors**](docs/AuthorsApi.md#list_authors) | **GET** /api/v1/authors | List authors
+*Abliteration::DatasetsApi* | [**get_dataset**](docs/DatasetsApi.md#get_dataset) | **GET** /api/v1/datasets/{id} | Get one dataset
+*Abliteration::DatasetsApi* | [**list_datasets**](docs/DatasetsApi.md#list_datasets) | **GET** /api/v1/datasets | List datasets
+*Abliteration::IndicesApi* | [**get_index**](docs/IndicesApi.md#get_index) | **GET** /api/v1/indices/{id} | One index with history
+*Abliteration::IndicesApi* | [**list_indices**](docs/IndicesApi.md#list_indices) | **GET** /api/v1/indices | All four indices
+*Abliteration::MethodsApi* | [**get_method**](docs/MethodsApi.md#get_method) | **GET** /api/v1/methods/{id} | Get one method
+*Abliteration::MethodsApi* | [**list_methods**](docs/MethodsApi.md#list_methods) | **GET** /api/v1/methods | List the method taxonomy
+*Abliteration::ModelsApi* | [**get_model**](docs/ModelsApi.md#get_model) | **GET** /api/v1/models/{id} | Get one model
+*Abliteration::ModelsApi* | [**list_models**](docs/ModelsApi.md#list_models) | **GET** /api/v1/models | List models
+*Abliteration::TimelineApi* | [**list_timeline**](docs/TimelineApi.md#list_timeline) | **GET** /api/v1/timeline | Curated field events
+
+
+## Documentation for Models
+
+ - [Abliteration::Author](docs/Author.md)
+ - [Abliteration::AuthorDetail](docs/AuthorDetail.md)
+ - [Abliteration::DaiPoint](docs/DaiPoint.md)
+ - [Abliteration::Dataset](docs/Dataset.md)
+ - [Abliteration::DatasetDetail](docs/DatasetDetail.md)
+ - [Abliteration::Envelope](docs/Envelope.md)
+ - [Abliteration::Error](docs/Error.md)
+ - [Abliteration::Event](docs/Event.md)
+ - [Abliteration::GetAuthor200Response](docs/GetAuthor200Response.md)
+ - [Abliteration::GetDataset200Response](docs/GetDataset200Response.md)
+ - [Abliteration::GetIndex200Response](docs/GetIndex200Response.md)
+ - [Abliteration::GetMethod200Response](docs/GetMethod200Response.md)
+ - [Abliteration::GetModel200Response](docs/GetModel200Response.md)
+ - [Abliteration::Index](docs/Index.md)
+ - [Abliteration::IndexDetail](docs/IndexDetail.md)
+ - [Abliteration::ListAuthors200Response](docs/ListAuthors200Response.md)
+ - [Abliteration::ListDatasets200Response](docs/ListDatasets200Response.md)
+ - [Abliteration::ListIndices200Response](docs/ListIndices200Response.md)
+ - [Abliteration::ListMethods200Response](docs/ListMethods200Response.md)
+ - [Abliteration::ListModels200Response](docs/ListModels200Response.md)
+ - [Abliteration::ListTimeline200Response](docs/ListTimeline200Response.md)
+ - [Abliteration::Method](docs/Method.md)
+ - [Abliteration::MethodDetail](docs/MethodDetail.md)
+ - [Abliteration::MethodDetailAllOfTopAuthors](docs/MethodDetailAllOfTopAuthors.md)
+ - [Abliteration::ModelDetail](docs/ModelDetail.md)
+ - [Abliteration::ModelSummary](docs/ModelSummary.md)
+ - [Abliteration::Passport](docs/Passport.md)
+
+
+## Documentation for Authorization
+
+
+Authentication schemes defined for the API:
+### bearerAuth
 
-## License
+- **Type**: Bearer authentication
 
-MIT

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,28 @@
+# Abliteration::Author
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Same value as `author`; added for consistency with the other single-entity payloads. | [optional] |
+| **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(
+  id: null,
+  author: null,
+  total_models: null,
+  total_downloads: null,
+  total_likes: null,
+  first_seen_at: null
+)
+```
+

data/docs/AuthorDetail.md

@@ -0,0 +1,30 @@
+# Abliteration::AuthorDetail
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Same value as `author`; added for consistency with the other single-entity payloads. | [optional] |
+| **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(
+  id: null,
+  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 | Bare key is DESC (largest first); a leading `-` flips to ASC. Aliases: `downloads` == `total_downloads`, `models` == `total_models`, `likes` == `total_likes`.
+  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** | Bare key is DESC (largest first); a leading &#x60;-&#x60; flips to ASC. Aliases: &#x60;downloads&#x60; &#x3D;&#x3D; &#x60;total_downloads&#x60;, &#x60;models&#x60; &#x3D;&#x3D; &#x60;total_models&#x60;, &#x60;likes&#x60; &#x3D;&#x3D; &#x60;total_likes&#x60;. | [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
+)
+```
+