@abliteration/sdk 0.1.0 → 0.1.2

package/docs/ListTimeline200Response.md

@@ -0,0 +1,48 @@
+
+# ListTimeline200Response
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`data` | [Array<Event>](Event.md)
+`cost` | number
+`credits_remaining` | number
+`rate_limit_limit` | number
+`rate_limit_remaining` | number
+`rate_limit_reset` | number
+`metering` | string
+`request_id` | string
+
+## Example
+
+```typescript
+import type { ListTimeline200Response } from '@abliteration/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "data": null,
+  "cost": null,
+  "credits_remaining": null,
+  "rate_limit_limit": null,
+  "rate_limit_remaining": null,
+  "rate_limit_reset": null,
+  "metering": null,
+  "request_id": null,
+} satisfies ListTimeline200Response
+
+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 ListTimeline200Response
+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/Method.md

@@ -0,0 +1,44 @@
+
+# Method
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`label` | string
+`category` | string
+`wiki_slug` | string
+`model_count` | number
+`total_downloads` | number
+
+## Example
+
+```typescript
+import type { Method } from '@abliteration/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "label": null,
+  "category": null,
+  "wiki_slug": null,
+  "model_count": null,
+  "total_downloads": null,
+} satisfies Method
+
+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 Method
+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/MethodDetail.md

@@ -0,0 +1,50 @@
+
+# MethodDetail
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`label` | string
+`category` | string
+`wiki_slug` | string
+`model_count` | number
+`total_downloads` | number
+`wiki_url` | string
+`top_authors` | [Array<MethodDetailAllOfTopAuthors>](MethodDetailAllOfTopAuthors.md)
+`sample_models` | [Array<ModelSummary>](ModelSummary.md)
+
+## Example
+
+```typescript
+import type { MethodDetail } from '@abliteration/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "label": null,
+  "category": null,
+  "wiki_slug": null,
+  "model_count": null,
+  "total_downloads": null,
+  "wiki_url": null,
+  "top_authors": null,
+  "sample_models": null,
+} satisfies MethodDetail
+
+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 MethodDetail
+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/MethodDetailAllOfTopAuthors.md

@@ -0,0 +1,36 @@
+
+# MethodDetailAllOfTopAuthors
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`author` | string
+`count` | number
+
+## Example
+
+```typescript
+import type { MethodDetailAllOfTopAuthors } from '@abliteration/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "author": null,
+  "count": null,
+} satisfies MethodDetailAllOfTopAuthors
+
+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 MethodDetailAllOfTopAuthors
+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/MethodsApi.md

@@ -0,0 +1,153 @@
+# MethodsApi
+
+All URIs are relative to *https://abliteration.org*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**getMethod**](MethodsApi.md#getmethod) | **GET** /api/v1/methods/{id} | Get one method |
+| [**listMethods**](MethodsApi.md#listmethods) | **GET** /api/v1/methods | List the method taxonomy |
+
+
+
+## getMethod
+
+> GetMethod200Response getMethod(id)
+
+Get one method
+
+Cost: 1 credit.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  MethodsApi,
+} from '@abliteration/sdk';
+import type { GetMethodRequest } 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 MethodsApi(config);
+
+  const body = {
+    // 'M1' | 'M2' | 'M3' | 'M4' | 'M5' | 'M5-frankenstein' | 'M6' | 'M7' | 'M8' | 'M-uncensored' | 'unknown'
+    id: id_example,
+  } satisfies GetMethodRequest;
+
+  try {
+    const data = await api.getMethod(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | `M1`, `M2`, `M3`, `M4`, `M5`, `M5-frankenstein`, `M6`, `M7`, `M8`, `M-uncensored`, `unknown` |  | [Defaults to `undefined`] [Enum: M1, M2, M3, M4, M5, M5-frankenstein, M6, M7, M8, M-uncensored, unknown] |
+
+### Return type
+
+[**GetMethod200Response**](GetMethod200Response.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** | Method with counts, top authors and sample models. |  -  |
+| **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)
+
+
+## listMethods
+
+> ListMethods200Response listMethods()
+
+List the method taxonomy
+
+Cost: 5-15 credits. Every code is returned, including ones with no models.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  MethodsApi,
+} from '@abliteration/sdk';
+import type { ListMethodsRequest } 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 MethodsApi(config);
+
+  try {
+    const data = await api.listMethods();
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**ListMethods200Response**](ListMethods200Response.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** | The taxonomy with counts. |  -  |
+| **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/ModelDetail.md

@@ -0,0 +1,131 @@
+
+# ModelDetail
+
+The full catalog record, plus files, benchmarks and an author summary.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`author` | string
+`name` | string
+`primary_method` | string
+`secondary_methods` | string
+`confidence` | string
+`classification_evidence` | string
+`classifier_version` | string
+`classified_at` | string
+`family` | string
+`params_b` | number
+`is_gguf` | number
+`is_moe` | number
+`is_multimodal` | number
+`is_image_gen` | number
+`is_second_order` | number
+`downloads` | number
+`likes` | number
+`created_at` | string
+`last_modified` | string
+`first_seen_at` | string
+`last_seen_at` | string
+`readme_text` | string
+`readme_status` | string
+`tags` | string
+`pipeline_tag` | string
+`library_name` | string
+`yaml_base_model` | string
+`yaml_language` | string
+`yaml_datasets` | string
+`yaml_license` | string
+`yaml_tags` | string
+`files_count` | number
+`total_size_bytes` | number
+`largest_file_bytes` | number
+`smallest_model_bytes` | number
+`quantizations` | string
+`has_mmproj` | number
+`hub_downloads_all_time` | number
+`hub_trending_score` | number
+`hub_real_params_m` | number
+`hub_context_length` | number
+`hub_siblings_count` | number
+`hub_provider_count` | number
+`hub_provider_names` | string
+`hub_enriched_at` | string
+`files` | Array<object>
+`benchmarks` | object
+`author_summary` | [Author](Author.md)
+
+## Example
+
+```typescript
+import type { ModelDetail } from '@abliteration/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "author": null,
+  "name": null,
+  "primary_method": null,
+  "secondary_methods": null,
+  "confidence": null,
+  "classification_evidence": null,
+  "classifier_version": null,
+  "classified_at": null,
+  "family": null,
+  "params_b": null,
+  "is_gguf": null,
+  "is_moe": null,
+  "is_multimodal": null,
+  "is_image_gen": null,
+  "is_second_order": null,
+  "downloads": null,
+  "likes": null,
+  "created_at": null,
+  "last_modified": null,
+  "first_seen_at": null,
+  "last_seen_at": null,
+  "readme_text": null,
+  "readme_status": null,
+  "tags": null,
+  "pipeline_tag": null,
+  "library_name": null,
+  "yaml_base_model": null,
+  "yaml_language": null,
+  "yaml_datasets": null,
+  "yaml_license": null,
+  "yaml_tags": null,
+  "files_count": null,
+  "total_size_bytes": null,
+  "largest_file_bytes": null,
+  "smallest_model_bytes": null,
+  "quantizations": null,
+  "has_mmproj": null,
+  "hub_downloads_all_time": null,
+  "hub_trending_score": null,
+  "hub_real_params_m": null,
+  "hub_context_length": null,
+  "hub_siblings_count": null,
+  "hub_provider_count": null,
+  "hub_provider_names": null,
+  "hub_enriched_at": null,
+  "files": null,
+  "benchmarks": null,
+  "author_summary": null,
+} satisfies ModelDetail
+
+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 ModelDetail
+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/ModelError.md

@@ -0,0 +1,42 @@
+
+# ModelError
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`error` | string
+`message` | string
+`retry_after` | number
+`credits_remaining` | number
+`request_id` | string
+
+## Example
+
+```typescript
+import type { ModelError } from '@abliteration/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "error": null,
+  "message": null,
+  "retry_after": null,
+  "credits_remaining": null,
+  "request_id": null,
+} satisfies ModelError
+
+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 ModelError
+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/ModelIndex.md

@@ -0,0 +1,52 @@
+
+# ModelIndex
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`name` | string
+`value` | number
+`unit` | string
+`measured` | boolean
+`source` | string
+`history_available` | boolean
+`as_of` | string
+`note` | string
+`recent_history` | [Array<DaiPoint>](DaiPoint.md)
+
+## Example
+
+```typescript
+import type { ModelIndex } from '@abliteration/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "name": null,
+  "value": null,
+  "unit": null,
+  "measured": null,
+  "source": null,
+  "history_available": null,
+  "as_of": null,
+  "note": null,
+  "recent_history": null,
+} satisfies ModelIndex
+
+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 ModelIndex
+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/ModelSummary.md

@@ -0,0 +1,58 @@
+
+# ModelSummary
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`author` | string
+`name` | string
+`method` | string
+`confidence` | string
+`family` | string
+`params_b` | number
+`license` | string
+`downloads` | number
+`likes` | number
+`is_gguf` | number
+`created_at` | string
+`first_seen_at` | string
+
+## Example
+
+```typescript
+import type { ModelSummary } from '@abliteration/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "author": null,
+  "name": null,
+  "method": null,
+  "confidence": null,
+  "family": null,
+  "params_b": null,
+  "license": null,
+  "downloads": null,
+  "likes": null,
+  "is_gguf": null,
+  "created_at": null,
+  "first_seen_at": null,
+} satisfies ModelSummary
+
+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 ModelSummary
+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)
+
+