agents 0.24.0 → 0.25.0

package/dist/models/ai-sdk/index.d.ts

@@ -0,0 +1,353 @@
+import {
+  _ as KnownSpeechModelId,
+  a as CloudflareAIError$1,
+  c as GatewayOptions,
+  d as CloudflareEmbeddingModelId,
+  f as CloudflareImageModelId,
+  g as KnownImageModelId,
+  h as CloudflareTranscriptionModelId,
+  i as CloudflareAIAttempt,
+  l as ModelOptions$1,
+  m as CloudflareSpeechModelId,
+  o as CloudflareAIErrorCode,
+  p as CloudflareRerankingModelId,
+  s as AISettings,
+  t as Transport,
+  u as ProviderGatewaySettings,
+  v as WorkersAIModelId
+} from "../../transport-PfFnt-Ld.js";
+import {
+  APICallError,
+  EmbeddingModelV4,
+  ImageModelV4,
+  LanguageModelV4,
+  LanguageModelV4CallOptions,
+  LanguageModelV4GenerateResult,
+  LanguageModelV4StreamResult,
+  RerankingModelV4,
+  SpeechModelV4,
+  TranscriptionModelV4
+} from "@ai-sdk/provider";
+
+//#region src/models/ai-sdk/settings.d.ts
+/**
+ * One leg of a fallback chain: a Workers AI id, or any AI SDK language model
+ * — including one this provider has already wrapped for the gateway.
+ *
+ * @experimental This surface is experimental and may change.
+ */
+type FallbackLeg = WorkersAIModelId | LanguageModelV4;
+/**
+ * Per-model and per-call options.
+ *
+ * The framework-neutral options, with the fallback leg type this module
+ * accepts: a leg may be a model object as well as a Workers AI id, because a
+ * third-party model is never an id here — it is a model its own provider
+ * package built.
+ *
+ * @experimental This surface is experimental and may change.
+ */
+type ModelOptions = ModelOptions$1<FallbackLeg>;
+/**
+ * The options accepted next to a model object — `ai(anthropic("…"), { … })`.
+ * The same shape as {@link ModelOptions}; the Workers-AI-only knobs
+ * (`reasoningEffort`, `chatTemplateKwargs`) are ignored with a warning.
+ *
+ * @experimental This surface is experimental and may change.
+ */
+type GatewayModelOptions = ModelOptions;
+/**
+ * The options `ai.routed()` takes: the gateway options, `headers` and
+ * `sessionAffinity`.
+ *
+ * A routed embedding, image, speech or transcription model is the vendor's
+ * own, and only its transport is ours — there is no chain to fall back through
+ * (a leg for one of those modalities would have to be another vendor's model,
+ * which this module cannot build) and no Workers AI reasoning knob to apply.
+ * They are absent from the type rather than dropped at runtime, so the mistake
+ * is a compile error naming the option.
+ *
+ * @experimental This surface is experimental and may change.
+ */
+type RoutedModelOptions = Omit<
+  ModelOptions,
+  "fallback" | "reasoningEffort" | "chatTemplateKwargs"
+>;
+/**
+ * The options the Workers-AI-only methods take — `ai.embedding`, `ai.image`,
+ * `ai.speech`, `ai.transcription`, `ai.reranking`.
+ *
+ * Their fallback legs are ids: those models run through the Workers AI run
+ * path, which resolves a leg by id, so a model object would type-check and
+ * then be silently dropped.
+ *
+ * @experimental This surface is experimental and may change.
+ */
+type ModalityOptions = ModelOptions$1<WorkersAIModelId>;
+//#endregion
+//#region src/models/ai-sdk/errors.d.ts
+/**
+ * Error thrown for every failed Cloudflare AI call, whether it came back as a
+ * non-2xx `Response` or as a thrown Workers AI binding error.
+ *
+ * Extends the AI SDK's `APICallError` so `ai`'s built-in retry loop honours
+ * {@link CloudflareAIError.isRetryable} without any extra wiring.
+ *
+ * @experimental This surface is experimental and may change.
+ */
+declare class CloudflareAIError extends APICallError {
+  /** HTTP status, when the failure carried one. */
+  readonly status: number | undefined;
+  /** Coarse classification used for routing and fallback decisions. */
+  readonly code: CloudflareAIErrorCode;
+  /** `cf-aig-log-id` of the failed request, when the response carried one. */
+  readonly logId: string | undefined;
+  /** The model id that produced this error. */
+  readonly model: string;
+  /** Every leg tried, when this error ends a fallback chain. */
+  readonly attempts: CloudflareAIAttempt[] | undefined;
+  constructor(options: {
+    message: string;
+    model: string;
+    url: string;
+    requestBodyValues: unknown;
+    status?: number;
+    code: CloudflareAIErrorCode;
+    logId?: string;
+    responseHeaders?: Record<string, string>;
+    responseBody?: string;
+    isRetryable?: boolean;
+    data?: unknown;
+    cause?: unknown;
+    attempts?: CloudflareAIAttempt[];
+  });
+  /** Lifts the framework-neutral core error into the AI SDK error type. */
+  static fromCore(error: CloudflareAIError$1): CloudflareAIError;
+}
+//#endregion
+//#region src/models/ai-sdk/models/language.d.ts
+/**
+ * Typed observability attached to every result under
+ * `providerMetadata.cloudflare`, so consumers never have to walk response
+ * objects looking for a gateway log id.
+ *
+ * @experimental This surface is experimental and may change.
+ */
+interface CloudflareMetadata {
+  /** The model that actually answered — the fallback leg, when one was used. */
+  model: string;
+  /** The gateway id the request went through. */
+  gateway: string;
+  /**
+   * The gateway provider slug the request was routed to, for a model reached
+   * through the universal gateway path. Absent for Workers AI.
+   */
+  provider?: string;
+  /** `cf-aig-log-id`, or the binding's last log id. */
+  logId?: string;
+  /** `cf-aig-event-id` — correlates the requests of one gateway event. */
+  eventId?: string;
+  /** `cf-aig-request-id` — the gateway's id for this request. */
+  requestId?: string;
+  /** `cf-aig-trace-id` — the trace this request belongs to. */
+  traceId?: string;
+  /** `cf-aig-run-id`, when the gateway sends one. */
+  runId?: string;
+  /** `cf-aig-cache-status`, e.g. `HIT` or `MISS`. */
+  cacheStatus?: string;
+  /** `cf-aig-step` — which step of a gateway route answered. */
+  step?: number;
+}
+/** Everything a language model needs from the provider that created it. */
+interface LanguageModelConfig {
+  transport: Transport;
+  /**
+   * The provider-wide gateway defaults, in any of the spellings `createAI`
+   * takes: a bare id, a `gateway` object, or the whole settings object with
+   * the flat gateway keys on it.
+   */
+  providerGateway: string | ProviderGatewaySettings | undefined;
+}
+//#endregion
+//#region src/models/ai-sdk/models/gateway.d.ts
+/**
+ * A `LanguageModelV4` that is the user's own vendor model, routed through AI
+ * Gateway. Generation, parsing, tool handling and error shapes stay the
+ * vendor's; only the transport is Cloudflare's.
+ *
+ * @experimental This surface is experimental and may change.
+ */
+declare class GatewayLanguageModel implements LanguageModelV4 {
+  #private;
+  readonly specificationVersion: "v4";
+  constructor(
+    model: LanguageModelV4,
+    options: ModelOptions | undefined,
+    config: LanguageModelConfig
+  );
+  /** The vendor's own provider name — `anthropic.messages`, `openai.responses`. */
+  get provider(): string;
+  /** The vendor's own id spelling, which the gateway requires verbatim. */
+  get modelId(): string;
+  get supportedUrls(): LanguageModelV4["supportedUrls"];
+  /** The model this wraps, for callers that need the vendor object back. */
+  get model(): LanguageModelV4;
+  doGenerate(
+    options: LanguageModelV4CallOptions
+  ): Promise<LanguageModelV4GenerateResult>;
+  doStream(
+    options: LanguageModelV4CallOptions
+  ): Promise<LanguageModelV4StreamResult>;
+}
+//#endregion
+//#region src/models/ai-sdk/index.d.ts
+/**
+ * The provider `createAI` returns. Call it with a Workers AI id or with a
+ * model another provider built.
+ *
+ * It satisfies `ProviderV4`, so it drops into
+ * `createProviderRegistry({ cloudflare: ai })` and into
+ * `globalThis.AI_SDK_DEFAULT_PROVIDER`, where the AI SDK resolves a bare
+ * `model: "@cf/…"` string through it. That is why the named methods also
+ * accept a plain `string`: a registry has only the string, and an id that is
+ * not a Workers AI one throws there exactly as it does here.
+ *
+ * @experimental This surface is experimental and may change.
+ */
+interface AI {
+  /** A Workers AI model. Third-party ids are not ids here — pass the model. */
+  (modelId: WorkersAIModelId, options?: ModelOptions): LanguageModelV4;
+  /** Any AI SDK v4 language model, routed through AI Gateway. */
+  (model: LanguageModelV4, options?: ModelOptions): LanguageModelV4;
+  /** The AI SDK provider specification this implements. */
+  readonly specificationVersion: "v4";
+  /** Same as calling the provider directly. */
+  languageModel(
+    modelId: WorkersAIModelId,
+    options?: ModelOptions
+  ): LanguageModelV4;
+  languageModel(
+    model: LanguageModelV4,
+    options?: ModelOptions
+  ): LanguageModelV4;
+  /** The `ProviderV4` shape: a registry resolves models by string alone. */
+  languageModel(modelId: string, options?: ModelOptions): LanguageModelV4;
+  /**
+   * Any other v4 model a vendor built — embedding, image, speech,
+   * transcription — routed through AI Gateway with its own code intact.
+   *
+   * The options are the gateway ones: a routed model has no chain to fall back
+   * through and no Workers AI reasoning knob to apply, so
+   * {@link RoutedModelOptions} leaves those out rather than dropping them.
+   */
+  routed<T extends object>(model: T, options?: RoutedModelOptions): T;
+  /** A text-embedding model from the Workers AI catalog. */
+  embedding(
+    modelId: CloudflareEmbeddingModelId,
+    options?: ModalityOptions
+  ): EmbeddingModelV4;
+  /** Alias of {@link AI.embedding}, the `ProviderV4` method name. */
+  embeddingModel(
+    modelId: CloudflareEmbeddingModelId,
+    options?: ModalityOptions
+  ): EmbeddingModelV4;
+  /**
+   * Alias of {@link AI.embedding}.
+   *
+   * @deprecated `embeddingModel` is the `ProviderV4` name; this is the older
+   * `ProviderV2`/`ProviderV3` spelling, kept for one release.
+   */
+  textEmbeddingModel(
+    modelId: CloudflareEmbeddingModelId,
+    options?: ModalityOptions
+  ): EmbeddingModelV4;
+  /** A text-to-image model from the Workers AI catalog. */
+  image(
+    modelId: CloudflareImageModelId,
+    options?: ModalityOptions
+  ): ImageModelV4;
+  /** Alias of {@link AI.image}, the `ProviderV4` method name. */
+  imageModel(
+    modelId: CloudflareImageModelId,
+    options?: ModalityOptions
+  ): ImageModelV4;
+  /** A speech-recognition model from the Workers AI catalog. */
+  transcription(
+    modelId: CloudflareTranscriptionModelId,
+    options?: ModalityOptions
+  ): TranscriptionModelV4;
+  /** Alias of {@link AI.transcription}, the `ProviderV4` method name. */
+  transcriptionModel(
+    modelId: CloudflareTranscriptionModelId,
+    options?: ModalityOptions
+  ): TranscriptionModelV4;
+  /** A text-to-speech model from the Workers AI catalog. */
+  speech(
+    modelId: CloudflareSpeechModelId,
+    options?: ModalityOptions
+  ): SpeechModelV4;
+  /** Alias of {@link AI.speech}, the `ProviderV4` method name. */
+  speechModel(
+    modelId: CloudflareSpeechModelId,
+    options?: ModalityOptions
+  ): SpeechModelV4;
+  /** A reranking model from the Workers AI catalog. */
+  reranking(
+    modelId: CloudflareRerankingModelId,
+    options?: ModalityOptions
+  ): RerankingModelV4;
+  /** Alias of {@link AI.reranking}, the `ProviderV4` method name. */
+  rerankingModel(
+    modelId: CloudflareRerankingModelId,
+    options?: ModalityOptions
+  ): RerankingModelV4;
+}
+/**
+ * Creates a provider over Workers AI, and over every vendor AI Gateway can
+ * reach.
+ *
+ * The Workers AI binding is the only way in — Workers AI models go through
+ * `env.AI.run`, vendor models through `env.AI.gateway(id).run`, and there is
+ * no HTTP transport and no API token. Gateway options are flat (`id`,
+ * `cacheTtl`, …) or nested under `gateway`; per-model options and per-call
+ * `providerOptions.cloudflare` override them in that order.
+ *
+ * ```ts
+ * const ai = createAI({ binding: env.AI, id: "prod", cacheTtl: 60 });
+ * const anthropic = createAnthropic({ apiKey: "cloudflare" });
+ *
+ * ai("@cf/zai-org/glm-4.7-flash");
+ * ai(anthropic("claude-opus-4-8"), { fallback: [ai("@cf/zai-org/glm-4.7-flash")] });
+ * ai.embedding("@cf/baai/bge-base-en-v1.5");
+ * ```
+ *
+ * @experimental This surface is experimental and may change.
+ */
+declare function createAI(settings: AISettings): AI;
+//#endregion
+export {
+  AI,
+  type AISettings,
+  type CloudflareAIAttempt,
+  CloudflareAIError,
+  type CloudflareAIErrorCode,
+  type CloudflareEmbeddingModelId,
+  type CloudflareImageModelId,
+  type CloudflareMetadata,
+  type CloudflareRerankingModelId,
+  type CloudflareSpeechModelId,
+  type CloudflareTranscriptionModelId,
+  type FallbackLeg,
+  GatewayLanguageModel,
+  type GatewayModelOptions,
+  type GatewayOptions,
+  type KnownImageModelId,
+  type KnownSpeechModelId,
+  type ModalityOptions,
+  type ModelOptions,
+  type ProviderGatewaySettings,
+  type RoutedModelOptions,
+  type WorkersAIModelId,
+  createAI
+};
+//# sourceMappingURL=index.d.ts.map