abliteration 0.0.1 → 0.1.1

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 | Bare key is the natural direction (downloads/likes = most first, dates = newest first). A leading `-` flips it. `created` and `first_seen` are aliases for the full column names.
+  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** | Bare key is the natural direction (downloads/likes &#x3D; most first, dates &#x3D; newest first). A leading &#x60;-&#x60; flips it. &#x60;created&#x60; and &#x60;first_seen&#x60; are aliases for the full column names. | [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
+)
+```
+

data/docs/Event.md

@@ -0,0 +1,30 @@
+# Abliteration::Event
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [optional] |
+| **date** | **String** |  | [optional] |
+| **date_precision** | **String** |  | [optional] |
+| **type** | **String** |  | [optional] |
+| **title** | **String** |  | [optional] |
+| **description** | **String** |  | [optional] |
+| **primary_source_url** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'abliteration'
+
+instance = Abliteration::Event.new(
+  id: null,
+  date: null,
+  date_precision: null,
+  type: null,
+  title: null,
+  description: null,
+  primary_source_url: null
+)
+```
+

data/docs/GetAuthor200Response.md

@@ -0,0 +1,32 @@
+# Abliteration::GetAuthor200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**AuthorDetail**](AuthorDetail.md) |  |  |
+| **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::GetAuthor200Response.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/GetDataset200Response.md

@@ -0,0 +1,32 @@
+# Abliteration::GetDataset200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**DatasetDetail**](DatasetDetail.md) |  |  |
+| **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::GetDataset200Response.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/GetIndex200Response.md

@@ -0,0 +1,32 @@
+# Abliteration::GetIndex200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**IndexDetail**](IndexDetail.md) |  |  |
+| **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::GetIndex200Response.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/GetMethod200Response.md

@@ -0,0 +1,32 @@
+# Abliteration::GetMethod200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**MethodDetail**](MethodDetail.md) |  |  |
+| **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::GetMethod200Response.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/GetModel200Response.md

@@ -0,0 +1,32 @@
+# Abliteration::GetModel200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**ModelDetail**](ModelDetail.md) |  |  |
+| **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::GetModel200Response.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/Index.md

@@ -0,0 +1,36 @@
+# Abliteration::Index
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [optional] |
+| **name** | **String** |  | [optional] |
+| **value** | **Float** |  | [optional] |
+| **unit** | **String** |  | [optional] |
+| **measured** | **Boolean** | False when the value is a placeholder constant rather than a measurement. | [optional] |
+| **source** | **String** | Where the number is produced. | [optional] |
+| **history_available** | **Boolean** |  | [optional] |
+| **as_of** | **String** |  | [optional] |
+| **note** | **String** |  | [optional] |
+| **recent_history** | [**Array<DaiPoint>**](DaiPoint.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'abliteration'
+
+instance = Abliteration::Index.new(
+  id: null,
+  name: null,
+  value: null,
+  unit: null,
+  measured: null,
+  source: null,
+  history_available: null,
+  as_of: null,
+  note: null,
+  recent_history: null
+)
+```
+

data/docs/IndexDetail.md

@@ -0,0 +1,38 @@
+# Abliteration::IndexDetail
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [optional] |
+| **name** | **String** |  | [optional] |
+| **value** | **Float** |  | [optional] |
+| **unit** | **String** |  | [optional] |
+| **measured** | **Boolean** | False when the value is a placeholder constant rather than a measurement. | [optional] |
+| **source** | **String** | Where the number is produced. | [optional] |
+| **history_available** | **Boolean** |  | [optional] |
+| **as_of** | **String** |  | [optional] |
+| **note** | **String** |  | [optional] |
+| **recent_history** | [**Array<DaiPoint>**](DaiPoint.md) |  | [optional] |
+| **history** | [**Array<DaiPoint>**](DaiPoint.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'abliteration'
+
+instance = Abliteration::IndexDetail.new(
+  id: null,
+  name: null,
+  value: null,
+  unit: null,
+  measured: null,
+  source: null,
+  history_available: null,
+  as_of: null,
+  note: null,
+  recent_history: null,
+  history: null
+)
+```
+

data/docs/IndicesApi.md

@@ -0,0 +1,144 @@
+# Abliteration::IndicesApi
+
+All URIs are relative to *https://abliteration.org*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_index**](IndicesApi.md#get_index) | **GET** /api/v1/indices/{id} | One index with history |
+| [**list_indices**](IndicesApi.md#list_indices) | **GET** /api/v1/indices | All four indices |
+
+
+## get_index
+
+> <GetIndex200Response> get_index(id)
+
+One index with history
+
+Cost: 10 credits. Only dai has a history series; the others return an empty array with history_available false.
+
+### 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::IndicesApi.new
+id = 'dai' # String | Canonical id or one of the short aliases (DAI, FV, WEAP, F2W). Case-insensitive.
+
+begin
+  # One index with history
+  result = api_instance.get_index(id)
+  p result
+rescue Abliteration::ApiError => e
+  puts "Error when calling IndicesApi->get_index: #{e}"
+end
+```
+
+#### Using the get_index_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetIndex200Response>, Integer, Hash)> get_index_with_http_info(id)
+
+```ruby
+begin
+  # One index with history
+  data, status_code, headers = api_instance.get_index_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetIndex200Response>
+rescue Abliteration::ApiError => e
+  puts "Error when calling IndicesApi->get_index_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Canonical id or one of the short aliases (DAI, FV, WEAP, F2W). Case-insensitive. |  |
+
+### Return type
+
+[**GetIndex200Response**](GetIndex200Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_indices
+
+> <ListIndices200Response> list_indices
+
+All four indices
+
+Cost: 20 credits. Check the measured flag before treating a value as a finding.
+
+### 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::IndicesApi.new
+
+begin
+  # All four indices
+  result = api_instance.list_indices
+  p result
+rescue Abliteration::ApiError => e
+  puts "Error when calling IndicesApi->list_indices: #{e}"
+end
+```
+
+#### Using the list_indices_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ListIndices200Response>, Integer, Hash)> list_indices_with_http_info
+
+```ruby
+begin
+  # All four indices
+  data, status_code, headers = api_instance.list_indices_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ListIndices200Response>
+rescue Abliteration::ApiError => e
+  puts "Error when calling IndicesApi->list_indices_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**ListIndices200Response**](ListIndices200Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/ListAuthors200Response.md

@@ -0,0 +1,32 @@
+# Abliteration::ListAuthors200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**Array<Author>**](Author.md) |  |  |
+| **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::ListAuthors200Response.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
+)
+```
+