workers-ai-provider 4.0.0 → 4.0.1

package/dist/openai.d.mts

@@ -1,4 +1,4 @@
-import { a as ProviderPlugin } from "./gateway-delegate-CAX7trdL.mjs";
+import { a as ProviderPlugin } from "./gateway-delegate-DYjgGAa-.mjs";
 
 //#region src/openai.d.ts
 /**
@@ -14,6 +14,10 @@ import { a as ProviderPlugin } from "./gateway-delegate-CAX7trdL.mjs";
  * Uses `.chat()` (Chat Completions) deliberately: the bare `openai()` call
  * (AI SDK v6+) defaults to the Responses API, which the AI Gateway run catalog
  * does not serve.
+ *
+ * @deprecated Pass the vendor's own model to `createAI` from
+ * `agents/models/ai-sdk` instead of a plugin plus a slug:
+ * `ai(createOpenAI({ apiKey: "cloudflare" }).chat("gpt-5.4"))`.
  */
 declare const openai: ProviderPlugin;
 //#endregion

package/dist/openai.mjs

@@ -13,6 +13,10 @@ import { createOpenAI } from "@ai-sdk/openai";
 * Uses `.chat()` (Chat Completions) deliberately: the bare `openai()` call
 * (AI SDK v6+) defaults to the Responses API, which the AI Gateway run catalog
 * does not serve.
+*
+* @deprecated Pass the vendor's own model to `createAI` from
+* `agents/models/ai-sdk` instead of a plugin plus a slug:
+* `ai(createOpenAI({ apiKey: "cloudflare" }).chat("gpt-5.4"))`.
 */
 const openai = {
 	wireFormat: "openai",

package/dist/openai.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"openai.mjs","names":[],"sources":["../src/openai.ts"],"sourcesContent":["import { createOpenAI } from \"@ai-sdk/openai\";\nimport type { ProviderPlugin } from \"./gateway-delegate\";\n\n/**\n * OpenAI-wire provider plugin for the gateway delegate. Pass to\n * `createGatewayDelegate({ providers: [openai] })` to handle every\n * OpenAI-compatible provider in one go — `openai/…`, plus the OpenAI-compatible\n * long tail (`deepseek/…`, `xai/…`, `groq/…`, `mistral/…`, `perplexity/…`,\n * `openrouter/…`, `cohere/…`, …). The registry routes each slug to its gateway\n * provider id; this plugin only supplies the response parser.\n *\n * Requires `@ai-sdk/openai` (an optional peer dependency — install it yourself).\n *\n * Uses `.chat()` (Chat Completions) deliberately: the bare `openai()` call\n * (AI SDK v6+) defaults to the Responses API, which the AI Gateway run catalog\n * does not serve.\n */\nexport const openai: ProviderPlugin = {\n\twireFormat: \"openai\",\n\tcreate: ({ modelId, fetch, baseURL }) =>\n\t\t// apiKey is a placeholder — the gateway handles auth (unified billing / BYOK)\n\t\t// and the delegate strips the Authorization header on the gateway path.\n\t\t// baseURL (set by the registry for non-OpenAI openai-wire providers) makes\n\t\t// the generated URL host-strip to the right gateway-native endpoint.\n\t\tcreateOpenAI({ apiKey: \"unused\", fetch, ...(baseURL ? { baseURL } : {}) }).chat(modelId),\n};\n"],"mappings":";;;;;;;;;;;;;;;;AAiBA,MAAa,SAAyB;CACrC,YAAY;CACZ,SAAS,EAAE,SAAS,OAAO,cAK1B,aAAa;EAAE,QAAQ;EAAU;EAAO,GAAI,UAAU,EAAE,QAAQ,IAAI,CAAC;CAAG,CAAC,CAAC,CAAC,KAAK,OAAO;AACzF"}
+{"version":3,"file":"openai.mjs","names":[],"sources":["../src/openai.ts"],"sourcesContent":["import { createOpenAI } from \"@ai-sdk/openai\";\nimport type { ProviderPlugin } from \"./gateway-delegate\";\n\n/**\n * OpenAI-wire provider plugin for the gateway delegate. Pass to\n * `createGatewayDelegate({ providers: [openai] })` to handle every\n * OpenAI-compatible provider in one go — `openai/…`, plus the OpenAI-compatible\n * long tail (`deepseek/…`, `xai/…`, `groq/…`, `mistral/…`, `perplexity/…`,\n * `openrouter/…`, `cohere/…`, …). The registry routes each slug to its gateway\n * provider id; this plugin only supplies the response parser.\n *\n * Requires `@ai-sdk/openai` (an optional peer dependency — install it yourself).\n *\n * Uses `.chat()` (Chat Completions) deliberately: the bare `openai()` call\n * (AI SDK v6+) defaults to the Responses API, which the AI Gateway run catalog\n * does not serve.\n *\n * @deprecated Pass the vendor's own model to `createAI` from\n * `agents/models/ai-sdk` instead of a plugin plus a slug:\n * `ai(createOpenAI({ apiKey: \"cloudflare\" }).chat(\"gpt-5.4\"))`.\n */\nexport const openai: ProviderPlugin = {\n\twireFormat: \"openai\",\n\tcreate: ({ modelId, fetch, baseURL }) =>\n\t\t// apiKey is a placeholder — the gateway handles auth (unified billing / BYOK)\n\t\t// and the delegate strips the Authorization header on the gateway path.\n\t\t// baseURL (set by the registry for non-OpenAI openai-wire providers) makes\n\t\t// the generated URL host-strip to the right gateway-native endpoint.\n\t\tcreateOpenAI({ apiKey: \"unused\", fetch, ...(baseURL ? { baseURL } : {}) }).chat(modelId),\n};\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAqBA,MAAa,SAAyB;CACrC,YAAY;CACZ,SAAS,EAAE,SAAS,OAAO,cAK1B,aAAa;EAAE,QAAQ;EAAU;EAAO,GAAI,UAAU,EAAE,QAAQ,IAAI,CAAC;CAAG,CAAC,CAAC,CAAC,KAAK,OAAO;AACzF"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "workers-ai-provider",
-  "version": "4.0.0",
+  "version": "4.0.1",
   "description": "Workers AI Provider for the vercel AI SDK",
   "keywords": [
     "ai",

package/src/anthropic.ts

@@ -7,6 +7,10 @@ import type { ProviderPlugin } from "./gateway-delegate";
  * `"anthropic/<model>"` slugs.
  *
  * Requires `@ai-sdk/anthropic` (an optional peer dependency — install it yourself).
+ *
+ * @deprecated Pass the vendor's own model to `createAI` from
+ * `agents/models/ai-sdk` instead of a plugin plus a slug:
+ * `ai(createAnthropic({ apiKey: "cloudflare" })("claude-opus-4-8"))`.
  */
 export const anthropic: ProviderPlugin = {
 	wireFormat: "anthropic",

package/src/client-fallback.ts

@@ -25,6 +25,9 @@ export interface FallbackLeg {
  * Fallback triggers on `doGenerate`/`doStream` rejection (the dispatch never
  * produced a stream). Errors that surface *mid-stream* — after content has
  * already been emitted — are not recoverable here and propagate as-is.
+ *
+ * @deprecated Use the `fallback` option of `createAI` from
+ * `agents/models/ai-sdk`: `ai(primary, { fallback: [secondary, "@cf/…"] })`.
  */
 export function createClientFallbackModel(legs: FallbackLeg[]): LanguageModelV4 {
 	if (legs.length === 0) {

package/src/gateway-provider.ts

@@ -56,6 +56,12 @@ interface AiGatewayRunner {
  * A `fetch` that dispatches the wrapped provider's request through AI Gateway.
  * Detects the gateway provider id from the request URL (or uses `config.provider`),
  * strips the provider host to the endpoint path, and forwards the body verbatim.
+ *
+ * @deprecated Route the vendor's model with `createAI` from
+ * `agents/models/ai-sdk`: `ai(model)` for language models, `ai.routed(model)`
+ * for embedding, image, speech and transcription models, on AI Gateway's
+ * provider-native path. `vendorKey: "request"` forwards the vendor key, as
+ * `byok: true` does here.
  */
 export function createGatewayFetch(config: GatewayFetchConfig): typeof globalThis.fetch {
 	if (!config?.binding) {
@@ -130,6 +136,12 @@ export function createGatewayFetch(config: GatewayFetchConfig): typeof globalThi
  * });
  * const model = openai("gpt-5");
  * ```
+ *
+ * @deprecated Route the vendor's model with `createAI` from
+ * `agents/models/ai-sdk`: `ai(model)` for language models, `ai.routed(model)`
+ * for embedding, image, speech and transcription models, on AI Gateway's
+ * provider-native path. `vendorKey: "request"` forwards the vendor key, as
+ * `byok: true` does here.
  */
 export function createGatewayProvider<T>(
 	factory: (opts: { apiKey?: string; baseURL?: string; fetch: typeof globalThis.fetch }) => T,

package/src/google.ts

@@ -7,6 +7,10 @@ import type { ProviderPlugin } from "./gateway-delegate";
  * (Google AI Studio) and `"google-vertex/<model>"` slugs.
  *
  * Requires `@ai-sdk/google` (an optional peer dependency — install it yourself).
+ *
+ * @deprecated Pass the vendor's own model to `createAI` from
+ * `agents/models/ai-sdk` instead of a plugin plus a slug:
+ * `ai(createGoogle({ apiKey: "cloudflare" })("gemini-2.5-flash"))`.
  */
 export const google: ProviderPlugin = {
 	wireFormat: "google",

package/src/index.ts

@@ -276,6 +276,23 @@ export interface WorkersAI {
 
 /**
  * Create a Workers AI provider instance.
+ *
+ * @deprecated Use `createAI` from `agents/models/ai-sdk`, with the binding or
+ * with an account id and API token (credentials mode's `apiKey`):
+ *
+ * ```ts
+ * import { createAI } from "agents/models/ai-sdk";
+ * const ai = createAI({ binding: env.AI }); // or { accountId, apiToken }
+ * ai("@cf/zai-org/glm-4.7-flash"); // was workersai("@cf/…")
+ * ai("anthropic/claude-opus-4.8"); // was "anthropic/…" + providers; the catalog's spelling
+ * ai("dynamic/support"); // dynamic routes, as before
+ * ai(createAnthropic({ apiKey: "cloudflare" })("claude-opus-4-8")); // a vendor's own model
+ * ai.embedding("@cf/baai/bge-base-en-v1.5"); // .image/.speech/.transcription/.reranking alike
+ * ```
+ *
+ * `vendorKey`, `byokAlias` and `zdr` cover BYOK, and through the binding a
+ * catalog stream resumes after a dropped connection. For AI Search, use
+ * `ai-search-provider`.
  */
 export function createWorkersAI(options: WorkersAISettings): WorkersAI {
 	if (!options.binding && !("accountId" in options && "apiKey" in options)) {
@@ -600,10 +617,22 @@ export function createWorkersAI(options: WorkersAISettings): WorkersAI {
 // AI Search (formerly AutoRAG)
 // ---------------------------------------------------------------------------
 
+/**
+ * @deprecated Use `createAISearchNamespace` from `ai-search-provider`, over the
+ * `ai_search_namespaces` binding that replaces `env.AI.autorag()`:
+ * `createAISearchNamespace({ binding: env.AI_SEARCH }).get("my-instance").chat()`.
+ * @see https://developers.cloudflare.com/ai-search/api/migration/workers-binding/
+ */
 export type AISearchSettings = {
 	binding: AutoRAG;
 };
 
+/**
+ * @deprecated Use `createAISearchNamespace` from `ai-search-provider`, over the
+ * `ai_search_namespaces` binding that replaces `env.AI.autorag()`:
+ * `createAISearchNamespace({ binding: env.AI_SEARCH }).get("my-instance").chat()`.
+ * @see https://developers.cloudflare.com/ai-search/api/migration/workers-binding/
+ */
 export interface AISearchProvider {
 	(settings?: AISearchChatSettings): AISearchChatLanguageModel;
 	/**
@@ -616,7 +645,11 @@ export interface AISearchProvider {
  * Create an AI Search provider instance.
  *
  * AI Search (formerly AutoRAG) is Cloudflare's managed search service.
- * @see https://developers.cloudflare.com/ai-search/
+ *
+ * @deprecated Use `createAISearchNamespace` from `ai-search-provider`, over the
+ * `ai_search_namespaces` binding that replaces `env.AI.autorag()`:
+ * `createAISearchNamespace({ binding: env.AI_SEARCH }).get("my-instance").chat()`.
+ * @see https://developers.cloudflare.com/ai-search/api/migration/workers-binding/
  */
 export function createAISearch(
 	options: AISearchSettings,
@@ -662,8 +695,9 @@ export type AutoRAGProvider = AISearchProvider;
 let autoRAGWarned = false;
 
 /**
- * @deprecated Use `createAISearch` instead. AutoRAG has been renamed to AI Search.
- * @see https://developers.cloudflare.com/ai-search/
+ * @deprecated Use `createAISearchNamespace` from `ai-search-provider`. AutoRAG
+ * has been renamed to AI Search.
+ * @see https://developers.cloudflare.com/ai-search/api/migration/workers-binding/
  */
 export function createAutoRAG(options: AISearchSettings): AISearchProvider {
 	if (!autoRAGWarned) {

package/src/openai.ts

@@ -14,6 +14,10 @@ import type { ProviderPlugin } from "./gateway-delegate";
  * Uses `.chat()` (Chat Completions) deliberately: the bare `openai()` call
  * (AI SDK v6+) defaults to the Responses API, which the AI Gateway run catalog
  * does not serve.
+ *
+ * @deprecated Pass the vendor's own model to `createAI` from
+ * `agents/models/ai-sdk` instead of a plugin plus a slug:
+ * `ai(createOpenAI({ apiKey: "cloudflare" }).chat("gpt-5.4"))`.
  */
 export const openai: ProviderPlugin = {
 	wireFormat: "openai",