xsai 0.0.2 → 0.0.4

package/README.md

@@ -2,6 +2,46 @@
 
 Extra-small AI SDK for any OpenAI-compatible API.
 
+<!-- automd:badges color="lime" license bundlephobia -->
+
+[![npm version](https://img.shields.io/npm/v/xsai?color=lime)](https://npmjs.com/package/xsai)
+[![npm downloads](https://img.shields.io/npm/dm/xsai?color=lime)](https://npm.chart.dev/xsai)
+[![bundle size](https://img.shields.io/bundlephobia/minzip/xsai?color=lime)](https://bundlephobia.com/package/xsai)
+[![license](https://img.shields.io/github/license/moeru-ai/xsai?color=lime)](https://github.com/moeru-ai/xsai/blob/main/LICENSE)
+
+<!-- /automd -->
+
+## Why?
+
+I'm working on a tiny local-LLM translator - [ARPK](https://github.com/moeru-ai/arpk), which is currently (v0.2.4) 449KB, of which 26% is `ollama-js` (the other 13% is the pointless `whatwg-fetch` that comes with `ollama-js`!)
+
+I wanted to make every byte count, so I started writing a lightweight library - xsAI.
+
+It provides an interface similar to the Vercel AI SDK, ESM-only and zero dependencies for minimal installation size.
+
+## Install
+
+<!-- automd:pm-install auto=false -->
+
+```sh
+# npm
+npm install xsai
+
+# yarn
+yarn add xsai
+
+# pnpm
+pnpm install xsai
+
+# bun
+bun install xsai
+
+# deno
+deno install xsai
+```
+
+<!-- /automd -->
+
 ## License
 
 [MIT](LICENSE.md)

package/dist/index.d.ts

@@ -1,29 +1,58 @@
-interface Message {
-    content: string;
-    role: 'assistant' | 'system' | 'user' | ({} & string);
-}
-
-type Model = 'gemma2' | 'llama3.1' | 'llama3.2' | 'llama3.2-vision' | 'mistral-nemo' | 'mistral-small' | 'nemotron' | 'qwen2.5' | 'qwen2.5-coder' | ({} & string);
+type GenerationModel = 'gemma2' | 'llama3.1' | 'llama3.2' | 'llama3.2-vision' | 'mistral-nemo' | 'mistral-small' | 'nemotron' | 'qwen2.5' | 'qwen2.5-coder' | ({} & string);
+type EmbedModel = 'all-minilm' | 'mxbai-embed-large' | 'nomic-embed-text' | ({} & string);
 
 interface CommonRequestOptions {
-    /**
-     * @default `http://localhost:11434/v1`
-     */
+    /** @default `http://localhost:11434/v1` */
     base?: string;
+    /** @default `undefined` */
+    headers?: HeadersInit;
+}
+
+interface EmbedOptions extends CommonRequestOptions {
+    [key: string]: unknown;
+    input: string | string[];
+    model: EmbedModel;
+    /** @default `embeddings` */
+    path?: 'embeddings' | ({} & string);
+}
+interface EmbedResponseUsage {
+    prompt_tokens: number;
+    total_tokens: number;
+}
+interface EmbedResult {
+    embedding: number[];
+    request: Request;
+    response: Response;
+    usage: EmbedResponseUsage;
 }
+declare const embed: (options: EmbedOptions) => Promise<{
+    embedding: number[];
+    request: Request;
+    response: Response;
+    usage: EmbedResponseUsage;
+}>;
+
+type FinishReason = 'content_filter' | 'error' | 'length' | 'other' | 'stop' | 'tool-calls' | ({} & string);
 
 interface GenerateTextOptions extends CommonRequestOptions {
-    messages?: Message[];
-    model: Model;
+    [key: string]: unknown;
+    model: GenerationModel;
     /** @default `completions` */
     path?: 'completions' | ({} & string);
     prompt: string;
 }
+interface GenerateTextResponseUsage {
+    completion_tokens: number;
+    prompt_tokens: number;
+    total_tokens: number;
+}
 interface GenerateTextResult {
+    finishReason: FinishReason;
     request: Request;
     response: Response;
     text: string;
+    usage: GenerateTextResponseUsage;
 }
 declare const generateText: (options: GenerateTextOptions) => Promise<GenerateTextResult>;
 
-export { generateText };
+export { type EmbedOptions, type EmbedResponseUsage, type EmbedResult, type GenerateTextOptions, type GenerateTextResult, embed, generateText };

package/dist/index.js

@@ -2,23 +2,48 @@ const clean = (record) => Object.fromEntries(Object.entries(record).filter(([, v
 
 const base = "http://localhost:11434/v1/";
 
+const embed = async (options) => {
+  const request = new Request(new URL(options.path ?? "embeddings", options.base ?? base), {
+    body: JSON.stringify(clean({
+      ...options,
+      base: void 0,
+      headers: void 0,
+      path: void 0
+    })),
+    headers: options.headers,
+    method: "POST"
+  });
+  const response = await fetch(request);
+  const json = await response.json();
+  return {
+    embedding: json.data[0].embedding,
+    request,
+    response,
+    usage: json.usage
+  };
+};
+
 const generateText = async (options) => {
   const request = new Request(new URL(options.path ?? "completions", options.base ?? base), {
     body: JSON.stringify(clean({
       stream: false,
       ...options,
       base: void 0,
+      headers: void 0,
       path: void 0
     })),
+    headers: options.headers,
     method: "POST"
   });
   const response = await fetch(request);
   const json = await response.json();
   return {
+    finishReason: json.choices[0].finish_reason,
     request,
     response,
-    text: json.choices[0].text
+    text: json.choices[0].text,
+    usage: json.usage
   };
 };
 
-export { generateText };
+export { embed, generateText };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "xsai",
-  "version": "0.0.2",
+  "version": "0.0.4",
   "type": "module",
   "author": "藍+85CD",
   "license": "MIT",
@@ -30,6 +30,7 @@
     "@importantimport/tsconfig": "^0.1.1",
     "@types/eslint": "^9.6.1",
     "@types/node": "^22.9.1",
+    "automd": "^0.3.12",
     "bumpp": "^9.8.1",
     "eslint": "^9.15.0",
     "jiti": "^2.4.0",