@agent-garden/provider-definition 1.0.0

package/caption.d.ts

@@ -0,0 +1,17 @@
+import { Field } from "./provider";
+
+export type CaptionCallbacks = {
+    onUpdate: (chunk: string) => void;
+    onFinish: (result: string) => void;
+    onError: (error: Error) => void;
+    onController: (controller: AbortController) => void;
+};
+
+export interface CaptionApi {
+    fields: { [key: string]: Field };
+    name: string;
+    icon: string;
+    minSize: { width: number, height: number };
+    maxSize: { width: number, height: number };
+    request: (props: { image: string, prompt?: string, callbacks: CaptionCallbacks }) => Promise<void>;
+}

package/embed.d.ts

@@ -0,0 +1,16 @@
+import OpenAI from "openai";
+import { Field } from "./provider";
+
+type EmbedFeature = 'vision' | 'audio'
+
+export type EmbedItem = string | OpenAI.Chat.Completions.ChatCompletionContentPart[];
+
+export interface EmbedApi {
+    fields: { [key: string]: Field };
+    name: string;
+    icon: string;
+    modelId: string;
+    dimension: number;
+    features: EmbedFeature[];
+    request: (props: { items: EmbedItem[] }) => Promise<{ item: EmbedItem, modelId: string, embedding: number[] }[]>;
+}

package/index.d.ts

@@ -0,0 +1,9 @@
+
+export * from './provider'
+
+export * from './caption'
+export * from './embed'
+export * from './llm'
+export * from './paint'
+export * from './rerank'
+export * from './translate'

package/llm.d.ts

@@ -0,0 +1,54 @@
+
+import OpenAI from "openai";
+import { Field } from "./provider";
+
+export type LlmMessage = OpenAI.Chat.Completions.ChatCompletionMessageParam;
+
+export type LlmMediaHandle = (
+    callbacks: {
+        onUpdate: (progress: number) => void;
+        onFinish: (result: string) => void;
+        onError: (error: Error) => void;
+        onController: (controller: AbortController) => void;
+    }
+) => void;
+
+export type LlmChunk = string | {
+    type: 'reasoning';
+    text: string;
+} | {
+    type: 'function';
+    text: string;
+} | {
+    type: 'image';
+    handle: LlmMediaHandle;
+} | {
+    type: 'audio';
+    handle: LlmMediaHandle;
+};
+
+export type LlmCallbacks = {
+    onUpdate: (chunk: string | LlmChunk) => void;
+    onFinish: (result: LlmMessage) => void;
+    onError: (error: Error) => void;
+    onController: (controller: AbortController) => void;
+};
+
+type LlmFeature = 'vision' | 'audio' | 'reasoning' | 'togglable_reasoning' | 'web_search' | 'function_call' | 'structured_output' | 'cache';    
+
+export interface LlmFeatureParams {
+    reasoning?: boolean;
+    webSearch?: boolean;
+    functions?: OpenAI.Chat.Completions.ChatCompletionTool[];
+    structuredOutput?: boolean;
+}
+
+export interface LlmApi {
+    fields: { [key: string]: Field };
+    name: string;
+    icon: string;
+    features: LlmFeature[];
+    maxTokens: number;
+    estimateTokens: (messages: LlmMessage[]) => number;
+    request: (props: { messages: LlmMessage[], features: LlmFeatureParams, callbacks: LlmCallbacks }) => Promise<void>;
+}

package/package.json

@@ -0,0 +1,15 @@
+{
+  "dependencies": {
+    "openai": "^6.3.0"
+  },
+  "name": "@agent-garden/provider-definition",
+  "version": "1.0.0",
+  "main": "index.d.ts",
+  "devDependencies": {},
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "author": "ZeeChung",
+  "license": "MIT",
+  "description": ""
+}

package/paint.d.ts

@@ -0,0 +1,19 @@
+import { Field } from "./provider";
+
+export type PaintCallbacks = {
+    onUpdate: (progress: number) => void;
+    onFinish: (result: string) => void;
+    onError: (error: Error) => void;
+    onController: (controller: AbortController) => void;
+}
+
+type PaintFeature = 'text2img' | 'img2img' | 'repaint';
+
+export interface PaintApi {
+    fields: { [key: string]: Field };
+    name: string;
+    icon: string;
+    features: PaintFeature[];
+    outputSizes: { width: number, height: number }[];
+    request: (props: { prompt: string, reference?: string, size: { width: number, height: number }, callbacks: PaintCallbacks }) => Promise<void>;
+}

package/provider.d.ts

@@ -0,0 +1,59 @@
+
+import { LlmApi } from "./llm";
+import { CaptionApi } from "./caption";
+import { PaintApi } from "./paint";
+import { RerankApi } from "./rerank";
+import { EmbedApi } from "./embed";
+import { TranslateApi } from "./translate";
+
+
+export type ProviderApis = {
+    postStream: (url: string, body: string, headers: { [key: string]: string }) => Promise<AsyncIterable<string>>;
+    post: (url: string, body: string, headers: { [key: string]: string }) => Promise<string>;
+};
+
+
+export type Field = StringField | NumberField | SelectionField;
+
+interface StringField {
+    type: 'string' | 'password';
+    current?: string;
+}
+
+interface NumberField {
+    type: 'number';
+    current?: number;
+    maxValue?: number;
+    minValue?: number;
+    step?: number;
+}
+
+type SelectionField = {
+    type: 'selection';
+    current?: string;
+    options: { [key: string]: string }
+    multiple?: false;
+} | {
+    type: 'selection';
+    current?: string[];
+    options: { [key: string]: string }
+    multiple: true;
+};
+
+
+export interface Provider {
+    schema: 'provider';
+    init: (apis: ProviderApis) => Promise<void>;
+    name: string;
+    fields: { [key: string]: Field };
+    icon: string;
+    domains: string[];  // trusted domains
+    apis: {
+        llm?: LlmApi;
+        caption?: CaptionApi;
+        paint?: PaintApi;
+        rerank?: RerankApi;
+        embed?: EmbedApi;
+        translate?: TranslateApi;
+    };
+}

package/rerank.d.ts

@@ -0,0 +1,8 @@
+import { Field } from "./provider";
+
+export interface RerankApi {
+    fields: { [key: string]: Field };
+    name: string;
+    icon: string;
+    request: (props: { items: string[], prompt: string }) => Promise<{ item: string, score?: number }[]>;
+}

package/translate.d.ts

@@ -0,0 +1,8 @@
+import { Field } from "./provider";
+
+export interface TranslateApi {     // TODO: regularize language codes
+    fields: { [key: string]: Field };
+    sources: string[];
+    targets: string[];
+    request: (props: { text: string, source: string, target: string }) => Promise<string>;
+}