@xsai/model 0.5.1 → 1.0.0-beta.1

package/README.md

@@ -1 +1,23 @@
-https://xsai.js.org/docs/packages/model
+# @xsai/model
+
+<!-- automd:file src="/docs/snippets/model.md" -->
+
+```sh
+pnpm add @xsai/model
+```
+
+```ts
+import { listModels, models } from '@xsai/model'
+
+const catalog = models({
+  apiKey: process.env.OPENAI_API_KEY,
+  baseURL: 'https://api.openai.com/v1/',
+})
+
+const entries = await listModels(catalog)
+console.log(entries.map(entry => entry.id))
+```
+
+<!-- /automd -->
+
+Read the [documentation](https://xsai.js.org/model).

package/dist/index.d.ts

@@ -1,21 +1,39 @@
-import { CommonRequestOptions } from '@xsai/shared';
+import { Promisable, HttpOptions } from '@xsai/shared';
 
-interface Model {
-    created: number;
+interface ModelCatalog {
+    list: (options?: ModelCatalogOptions) => Promisable<ModelCatalogEntry[]>;
+    retrieve: (options: ModelCatalogOptions & {
+        id: string;
+    }) => Promisable<ModelCatalogEntry>;
+}
+interface ModelCatalogEntry {
     id: string;
-    object: 'model';
-    owned_by: string;
+    providerMetadata?: ModelCatalogEntryProviderMetadata;
 }
-
-interface ListModelsOptions extends Omit<CommonRequestOptions, 'model'> {
+interface ModelCatalogEntryProviderMetadata {
 }
-interface ListModelsResponse {
-    data: Model[];
-    object: 'list';
+interface ModelCatalogOptions {
+    providerOptions?: ModelCatalogProviderOptions;
+    signal?: AbortSignal;
 }
-declare const listModels: (options: ListModelsOptions) => Promise<Model[]>;
+interface ModelCatalogProviderOptions {
+}
+
+declare const listModels: (catalog: ModelCatalog, options?: ModelCatalogOptions) => Promise<ModelCatalogEntry[]>;
 
-declare const retrieveModel: (options: CommonRequestOptions) => Promise<Model>;
+declare module '@xsai/model' {
+    interface ModelCatalogEntryProviderMetadata {
+        models?: {
+            created?: number;
+            ownedBy?: string;
+        };
+    }
+}
+declare const models: (options: Omit<HttpOptions, "model">) => ModelCatalog;
+
+declare const retrieveModel: (catalog: ModelCatalog, options: ModelCatalogOptions & {
+    id: string;
+}) => Promise<ModelCatalogEntry>;
 
-export { listModels, retrieveModel };
-export type { ListModelsOptions, ListModelsResponse, Model };
+export { listModels, models, retrieveModel };
+export type { ModelCatalog, ModelCatalogEntry, ModelCatalogEntryProviderMetadata, ModelCatalogOptions, ModelCatalogProviderOptions };

package/dist/index.js

@@ -1,13 +1,23 @@
-import { requestURL, requestHeaders, responseCatch, responseJSON } from '@xsai/shared';
+import { sendRequest } from '@xsai/shared';
 
-const listModels = async (options) => (options.fetch ?? globalThis.fetch)(requestURL("models", options.baseURL), {
-  headers: requestHeaders(options.headers, options.apiKey),
-  signal: options.abortSignal
-}).then(responseCatch).then(responseJSON).then(({ data }) => data);
+const listModels = async (catalog, options = {}) => catalog.list(options);
 
-const retrieveModel = async (options) => (options.fetch ?? globalThis.fetch)(requestURL(`models/${options.model}`, options.baseURL), {
-  headers: requestHeaders(options.headers, options.apiKey),
-  signal: options.abortSignal
-}).then(responseCatch).then(responseJSON);
+const modelEntry = (model) => ({
+  id: model.id,
+  providerMetadata: { models: { created: model.created, ownedBy: model.owned_by } }
+});
+const models = (options) => ({
+  list: async (catalogOptions = {}) => {
+    const response = await sendRequest({ method: "GET", path: "models", signal: catalogOptions.signal }, options);
+    const json = await response.json();
+    return json.data.map(modelEntry);
+  },
+  retrieve: async (catalogOptions) => {
+    const response = await sendRequest({ method: "GET", path: `models/${encodeURIComponent(catalogOptions.id)}`, signal: catalogOptions.signal }, options);
+    return modelEntry(await response.json());
+  }
+});
 
-export { listModels, retrieveModel };
+const retrieveModel = async (catalog, options) => catalog.retrieve(options);
+
+export { listModels, models, retrieveModel };

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@xsai/model",
   "type": "module",
-  "version": "0.5.1",
-  "description": "extra-small AI SDK.",
+  "version": "1.0.0-beta.1",
+  "description": "extra-small AI SDK: list and retrieve models.",
   "author": "Moeru AI",
   "license": "MIT",
   "homepage": "https://xsai.js.org",
@@ -14,8 +14,10 @@
   "bugs": "https://github.com/moeru-ai/xsai/issues",
   "keywords": [
     "xsai",
+    "ai",
     "openai",
-    "ai"
+    "model",
+    "models"
   ],
   "sideEffects": false,
   "exports": {
@@ -29,11 +31,11 @@
     "dist"
   ],
   "dependencies": {
-    "@xsai/shared": "0.5.1"
+    "@xsai/shared": "1.0.0-beta.1"
   },
   "scripts": {
-    "build": "pkgroll",
-    "test": "vitest run",
+    "build": "pkgroll --clean-dist",
+    "test": "vitest run --exclude e2e/**",
     "test:watch": "vitest"
   },
   "main": "./dist/index.js",