@abliteration/sdk 0.1.0 → 0.1.2

package/docs/ModelsApi.md

@@ -0,0 +1,191 @@
+# ModelsApi
+
+All URIs are relative to *https://abliteration.org*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**getModel**](ModelsApi.md#getmodel) | **GET** /api/v1/models/{id} | Get one model |
+| [**listModels**](ModelsApi.md#listmodels) | **GET** /api/v1/models | List models |
+
+
+
+## getModel
+
+> GetModel200Response getModel(id)
+
+Get one model
+
+Cost: 10 credits. Priced above /authors/[id], /methods/[id] and /datasets/[id] because iterating over model ids is functionally a slow dump. The id is author/name and must be percent-encoded.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ModelsApi,
+} from '@abliteration/sdk';
+import type { GetModelRequest } from '@abliteration/sdk';
+
+async function example() {
+  console.log("🚀 Testing @abliteration/sdk SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: bearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new ModelsApi(config);
+
+  const body = {
+    // string
+    id: mlabonne/Qwen3-30B-A3B-abliterated,
+  } satisfies GetModelRequest;
+
+  try {
+    const data = await api.getModel(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**GetModel200Response**](GetModel200Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Full model record. |  -  |
+| **401** | Missing, unknown or revoked key. |  -  |
+| **402** | Not enough credits. Only possible while metering is enabled. |  -  |
+| **404** | No such entity. |  -  |
+| **429** | Per-key rate limit exceeded. Retry-After header is set. |  -  |
+| **503** | Catalog temporarily unreadable. Nothing was charged. |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## listModels
+
+> ListModels200Response listModels(method, family, author, license, downloadsGte, downloadsLte, createdAfter, createdBefore, sort, limit, offset)
+
+List models
+
+Cost: 5-300+ credits, stepped by returned rows and multiplied by `1 + (offset/2500)²`. A filtered lookup up to 200 rows costs 5; a 1000-row page on the first page costs 300; on offset=10000, 5100. Filter cheap, dump expensive. See /api#pricing. Delisted models are excluded here but remain reachable by id.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ModelsApi,
+} from '@abliteration/sdk';
+import type { ListModelsRequest } from '@abliteration/sdk';
+
+async function example() {
+  console.log("🚀 Testing @abliteration/sdk SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: bearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new ModelsApi(config);
+
+  const body = {
+    // string | M-code, case-insensitive. See GET /api/v1/methods. (optional)
+    method: method_example,
+    // string | Base family, for example qwen or llama. (optional)
+    family: family_example,
+    // string | Publisher handle, case-insensitive. (optional)
+    author: author_example,
+    // string | SPDX-ish license string as published. (optional)
+    license: license_example,
+    // number (optional)
+    downloadsGte: 56,
+    // number (optional)
+    downloadsLte: 56,
+    // string | ISO-8601 date or timestamp, inclusive. (optional)
+    createdAfter: createdAfter_example,
+    // string | ISO-8601 date or timestamp, inclusive. (optional)
+    createdBefore: createdBefore_example,
+    // 'downloads' | '-downloads' | 'likes' | '-likes' | 'created' | '-created' | 'created_at' | '-created_at' | 'first_seen' | '-first_seen' | 'first_seen_at' | '-first_seen_at' | 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. (optional)
+    sort: sort_example,
+    // number | Rows to return, 1 to 1000. Values outside the range are clamped, not rejected. (optional)
+    limit: 56,
+    // number | Rows to skip. Negative and non-numeric values are treated as 0. (optional)
+    offset: 56,
+  } satisfies ListModelsRequest;
+
+  try {
+    const data = await api.listModels(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **method** | `string` | M-code, case-insensitive. See GET /api/v1/methods. | [Optional] [Defaults to `undefined`] |
+| **family** | `string` | Base family, for example qwen or llama. | [Optional] [Defaults to `undefined`] |
+| **author** | `string` | Publisher handle, case-insensitive. | [Optional] [Defaults to `undefined`] |
+| **license** | `string` | SPDX-ish license string as published. | [Optional] [Defaults to `undefined`] |
+| **downloadsGte** | `number` |  | [Optional] [Defaults to `undefined`] |
+| **downloadsLte** | `number` |  | [Optional] [Defaults to `undefined`] |
+| **createdAfter** | `string` | ISO-8601 date or timestamp, inclusive. | [Optional] [Defaults to `undefined`] |
+| **createdBefore** | `string` | ISO-8601 date or timestamp, inclusive. | [Optional] [Defaults to `undefined`] |
+| **sort** | `downloads`, `-downloads`, `likes`, `-likes`, `created`, `-created`, `created_at`, `-created_at`, `first_seen`, `-first_seen`, `first_seen_at`, `-first_seen_at` | 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. | [Optional] [Defaults to `'downloads'`] [Enum: downloads, -downloads, likes, -likes, created, -created, created_at, -created_at, first_seen, -first_seen, first_seen_at, -first_seen_at] |
+| **limit** | `number` | Rows to return, 1 to 1000. Values outside the range are clamped, not rejected. | [Optional] [Defaults to `50`] |
+| **offset** | `number` | Rows to skip. Negative and non-numeric values are treated as 0. | [Optional] [Defaults to `0`] |
+
+### Return type
+
+[**ListModels200Response**](ListModels200Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Matching models. |  -  |
+| **401** | Missing, unknown or revoked key. |  -  |
+| **402** | Not enough credits. Only possible while metering is enabled. |  -  |
+| **429** | Per-key rate limit exceeded. Retry-After header is set. |  -  |
+| **503** | Catalog temporarily unreadable. Nothing was charged. |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+

package/docs/Passport.md

@@ -0,0 +1,38 @@
+
+# Passport
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`one_liner` | string
+`practitioner` | string
+`research` | string
+
+## Example
+
+```typescript
+import type { Passport } from '@abliteration/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "one_liner": null,
+  "practitioner": null,
+  "research": null,
+} satisfies Passport
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as Passport
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/TimelineApi.md

@@ -0,0 +1,93 @@
+# TimelineApi
+
+All URIs are relative to *https://abliteration.org*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**listTimeline**](TimelineApi.md#listtimeline) | **GET** /api/v1/timeline | Curated field events |
+
+
+
+## listTimeline
+
+> ListTimeline200Response listTimeline(from, to, eventType, limit)
+
+Curated field events
+
+Cost: 50 credits, flat.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  TimelineApi,
+} from '@abliteration/sdk';
+import type { ListTimelineRequest } from '@abliteration/sdk';
+
+async function example() {
+  console.log("🚀 Testing @abliteration/sdk SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: bearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new TimelineApi(config);
+
+  const body = {
+    // string | Inclusive lower bound on the event date, ISO-8601. (optional)
+    from: from_example,
+    // string | Inclusive upper bound on the event date, ISO-8601. (optional)
+    to: to_example,
+    // string | Event type, case-insensitive. (optional)
+    eventType: eventType_example,
+    // number (optional)
+    limit: 56,
+  } satisfies ListTimelineRequest;
+
+  try {
+    const data = await api.listTimeline(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **from** | `string` | Inclusive lower bound on the event date, ISO-8601. | [Optional] [Defaults to `undefined`] |
+| **to** | `string` | Inclusive upper bound on the event date, ISO-8601. | [Optional] [Defaults to `undefined`] |
+| **eventType** | `string` | Event type, case-insensitive. | [Optional] [Defaults to `undefined`] |
+| **limit** | `number` |  | [Optional] [Defaults to `100`] |
+
+### Return type
+
+[**ListTimeline200Response**](ListTimeline200Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Events, newest first. |  -  |
+| **401** | Missing, unknown or revoked key. |  -  |
+| **402** | Not enough credits. Only possible while metering is enabled. |  -  |
+| **429** | Per-key rate limit exceeded. Retry-After header is set. |  -  |
+| **503** | Catalog temporarily unreadable. Nothing was charged. |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+

package/openapi-generator-config.json

@@ -0,0 +1,10 @@
+{
+  "npmName": "@abliteration/sdk",
+  "npmVersion": "0.1.0",
+  "npmRepository": "https://abliteration.org/api",
+  "supportsES6": true,
+  "typescriptThreePlus": true,
+  "modelPropertyNaming": "original",
+  "withInterfaces": true,
+  "useSingleRequestParameter": true
+}

package/package.json

@@ -1,8 +1,12 @@
 {
   "name": "@abliteration/sdk",
-  "version": "0.1.0",
-  "description": "Auto-generated TypeScript SDK for the abliteration.org LLM catalog API. Covers every route on /api/v1 with typed models.",
-  "author": "Catyonic OU <contact@catyonic.com>",
+  "version": "0.1.2",
+  "description": "OpenAPI client for @abliteration/sdk",
+  "author": "OpenAPI-Generator",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/neymark/abliteration.git"
+  },
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "module": "./dist/esm/index.js",
@@ -14,18 +18,12 @@
   "devDependencies": {
     "typescript": "^4.0 || ^5.0"
   },
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/",
+    "access": "public"
+  },
   "homepage": "https://abliteration.org/api",
-  "license": "MIT",
-  "keywords": [
-    "abliteration",
-    "llm",
-    "catalog",
-    "api",
-    "openapi",
-    "sdk"
-  ],
-  "files": [
-    "dist",
-    "README.md"
-  ]
+  "bugs": {
+    "url": "https://github.com/neymark/abliteration/issues"
+  }
 }

package/src/apis/AuthorsApi.ts

@@ -0,0 +1,248 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * 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
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import * as runtime from '../runtime';
+import {
+    type GetAuthor200Response,
+    GetAuthor200ResponseFromJSON,
+    GetAuthor200ResponseToJSON,
+} from '../models/GetAuthor200Response';
+import {
+    type ListAuthors200Response,
+    ListAuthors200ResponseFromJSON,
+    ListAuthors200ResponseToJSON,
+} from '../models/ListAuthors200Response';
+
+export interface GetAuthorRequest {
+    /**
+     * 
+     */
+    id: string;
+}
+
+export interface ListAuthorsRequest {
+    /**
+     * Bare key is DESC (largest first); a leading `-` flips to ASC. Aliases: `downloads` == `total_downloads`, `models` == `total_models`, `likes` == `total_likes`.
+     */
+    sort?: ListAuthorsSortEnum;
+    /**
+     * Rows to return, 1 to 1000. Values outside the range are clamped, not rejected.
+     */
+    limit?: number;
+    /**
+     * Rows to skip. Negative and non-numeric values are treated as 0.
+     */
+    offset?: number;
+}
+
+/**
+ * AuthorsApi - interface
+ * 
+ * @export
+ * @interface AuthorsApiInterface
+ */
+export interface AuthorsApiInterface {
+    /**
+     * Creates request options for getAuthor without sending the request
+     * @param {string} id 
+     * @throws {RequiredError}
+     * @memberof AuthorsApiInterface
+     */
+    getAuthorRequestOpts(requestParameters: GetAuthorRequest): Promise<runtime.RequestOpts>;
+
+    /**
+     * Cost: 1 credit.
+     * @summary Get one author
+     * @param {string} id 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AuthorsApiInterface
+     */
+    getAuthorRaw(requestParameters: GetAuthorRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetAuthor200Response>>;
+
+    /**
+     * Cost: 1 credit.
+     * Get one author
+     */
+    getAuthor(requestParameters: GetAuthorRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetAuthor200Response>;
+
+    /**
+     * Creates request options for listAuthors without sending the request
+     * @param {'total_downloads' | '-total_downloads' | 'downloads' | '-downloads' | 'total_models' | '-total_models' | 'models' | '-models' | 'total_likes' | '-total_likes' | 'likes' | '-likes'} [sort] 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;.
+     * @param {number} [limit] Rows to return, 1 to 1000. Values outside the range are clamped, not rejected.
+     * @param {number} [offset] Rows to skip. Negative and non-numeric values are treated as 0.
+     * @throws {RequiredError}
+     * @memberof AuthorsApiInterface
+     */
+    listAuthorsRequestOpts(requestParameters: ListAuthorsRequest): Promise<runtime.RequestOpts>;
+
+    /**
+     * Cost: 5-15 credits, by rows returned.
+     * @summary List authors
+     * @param {'total_downloads' | '-total_downloads' | 'downloads' | '-downloads' | 'total_models' | '-total_models' | 'models' | '-models' | 'total_likes' | '-total_likes' | 'likes' | '-likes'} [sort] 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;.
+     * @param {number} [limit] Rows to return, 1 to 1000. Values outside the range are clamped, not rejected.
+     * @param {number} [offset] Rows to skip. Negative and non-numeric values are treated as 0.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AuthorsApiInterface
+     */
+    listAuthorsRaw(requestParameters: ListAuthorsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListAuthors200Response>>;
+
+    /**
+     * Cost: 5-15 credits, by rows returned.
+     * List authors
+     */
+    listAuthors(requestParameters: ListAuthorsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListAuthors200Response>;
+
+}
+
+/**
+ * 
+ */
+export class AuthorsApi extends runtime.BaseAPI implements AuthorsApiInterface {
+
+    /**
+     * Creates request options for getAuthor without sending the request
+     */
+    async getAuthorRequestOpts(requestParameters: GetAuthorRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError(
+                'id',
+                'Required parameter "id" was null or undefined when calling getAuthor().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("bearerAuth", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/api/v1/authors/{id}`;
+        urlPath = urlPath.replace('{id}', encodeURIComponent(String(requestParameters['id'])));
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Cost: 1 credit.
+     * Get one author
+     */
+    async getAuthorRaw(requestParameters: GetAuthorRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetAuthor200Response>> {
+        const requestOptions = await this.getAuthorRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => GetAuthor200ResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Cost: 1 credit.
+     * Get one author
+     */
+    async getAuthor(requestParameters: GetAuthorRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetAuthor200Response> {
+        const response = await this.getAuthorRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for listAuthors without sending the request
+     */
+    async listAuthorsRequestOpts(requestParameters: ListAuthorsRequest): Promise<runtime.RequestOpts> {
+        const queryParameters: any = {};
+
+        if (requestParameters['sort'] != null) {
+            queryParameters['sort'] = requestParameters['sort'];
+        }
+
+        if (requestParameters['limit'] != null) {
+            queryParameters['limit'] = requestParameters['limit'];
+        }
+
+        if (requestParameters['offset'] != null) {
+            queryParameters['offset'] = requestParameters['offset'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("bearerAuth", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/api/v1/authors`;
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Cost: 5-15 credits, by rows returned.
+     * List authors
+     */
+    async listAuthorsRaw(requestParameters: ListAuthorsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListAuthors200Response>> {
+        const requestOptions = await this.listAuthorsRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ListAuthors200ResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Cost: 5-15 credits, by rows returned.
+     * List authors
+     */
+    async listAuthors(requestParameters: ListAuthorsRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListAuthors200Response> {
+        const response = await this.listAuthorsRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+}
+
+/**
+ * @export
+ */
+export const ListAuthorsSortEnum = {
+    TotalDownloads: 'total_downloads',
+    TotalDownloads2: '-total_downloads',
+    Downloads: 'downloads',
+    Downloads2: '-downloads',
+    TotalModels: 'total_models',
+    TotalModels2: '-total_models',
+    Models: 'models',
+    Models2: '-models',
+    TotalLikes: 'total_likes',
+    TotalLikes2: '-total_likes',
+    Likes: 'likes',
+    Likes2: '-likes',
+} as const;
+export type ListAuthorsSortEnum = typeof ListAuthorsSortEnum[keyof typeof ListAuthorsSortEnum];