workers-ai-provider 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Sunil Pai
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,56 @@
+# workers-ai-provider ⬡ ⤫ ▴
+
+A custom provider that enables [Workers AI](https://ai.cloudflare.com/)'s models for the [Vercel AI SDK](https://sdk.vercel.ai/).
+
+> [!CAUTION]
+> This project is in its experimental early stages and is not recommended for production use.
+
+## Install
+
+```bash
+npm install workers-ai-provider
+```
+
+## Usage
+
+First setup an AI binding in `wrangler.toml`:
+
+```toml
+# ...
+[ai]
+binding = "AI"
+# ...
+```
+
+Then in your Worker, import the factory function and create a new AI provider:
+
+```ts
+// index.ts
+import { createWorkersAI } from "workers-vercel-ai-sdk";
+import * as ai from "ai";
+
+export default {
+  fetch(req: Request, env: Env) {
+    const workersai = createWorkersAI({ binding: env.AI });
+    // Use the AI provider to interact with the Vercel AI SDK
+    // Here, we generate a chat stream based on a prompt
+    const response = ai.streamText({
+      model: workersai("@cf/meta/llama-2-7b-chat-int8"),
+      messages: [
+        {
+          role: "user",
+          content: "Write an essay about hello world",
+        },
+      ],
+    });
+
+    return new Response(txt.text);
+  },
+};
+```
+
+For more info, refer to the documentation of the [Vercel AI SDK](https://sdk.vercel.ai/).
+
+### Credits
+
+Based on work by [Dhravya Shah](https://twitter.com/DhravyaShah) and the Workers AI team at Cloudflare.

package/dist/index.d.ts

@@ -0,0 +1,53 @@
+import { LanguageModelV1 } from '@ai-sdk/provider';
+
+interface WorkersAIChatSettings {
+    /**
+    Whether to inject a safety prompt before all conversations.
+    
+    Defaults to `false`.
+       */
+    safePrompt?: boolean;
+}
+
+type WorkersAIChatConfig = {
+    provider: string;
+    binding: Ai;
+};
+declare class WorkersAIChatLanguageModel implements LanguageModelV1 {
+    readonly specificationVersion = "v1";
+    readonly defaultObjectGenerationMode = "json";
+    readonly modelId: BaseAiTextGenerationModels;
+    readonly settings: WorkersAIChatSettings;
+    private readonly config;
+    constructor(modelId: BaseAiTextGenerationModels, settings: WorkersAIChatSettings, config: WorkersAIChatConfig);
+    get provider(): string;
+    private getArgs;
+    doGenerate(options: Parameters<LanguageModelV1["doGenerate"]>[0]): Promise<Awaited<ReturnType<LanguageModelV1["doGenerate"]>>>;
+    doStream(options: Parameters<LanguageModelV1["doStream"]>[0]): Promise<Awaited<ReturnType<LanguageModelV1["doStream"]>>>;
+}
+
+interface WorkersAI {
+    (modelId: BaseAiTextGenerationModels, settings?: WorkersAIChatSettings): WorkersAIChatLanguageModel;
+    /**
+    Creates a model for text generation.
+    */
+    chat(modelId: BaseAiTextGenerationModels, settings?: WorkersAIChatSettings): WorkersAIChatLanguageModel;
+}
+interface WorkersAISettings {
+    /**
+    Provide an `env.AI` binding to use for the AI inference.
+    You can set up an AI bindings in your Workers project
+    by adding the following this to `wrangler.toml`:
+    
+    ```toml
+  [ai]
+  binding = "AI"
+    ``` */
+    binding: Ai;
+}
+/**
+  Create a Workers AI provider instance.
+   */
+declare function createWorkersAIProvider(options: WorkersAISettings): WorkersAI;
+
+export { type WorkersAI, type WorkersAISettings, createWorkersAIProvider };