agents 0.28.0 → 0.29.0

package/dist/settings-NgGwF7Qt.d.ts

@@ -1,331 +0,0 @@
-//#region src/models/core/catalog.d.ts
-/**
- * Keys of the ambient `AiModels` interface (from `@cloudflare/workers-types`)
- * whose model type extends `T`. Kept in step with the installed workers-types
- * version rather than hand-maintained here.
- */
-type WorkersAIModelIdsExtending<T> = {
-  [K in keyof AiModels]: AiModels[K] extends T ? K : never;
-}[keyof AiModels];
-/** The `inputs` shape a catalog entry declares. */
-type InputsOf<K extends keyof AiModels> = AiModels[K] extends {
-  inputs: infer I;
-}
-  ? I
-  : never;
-/** The `postProcessedOutputs` shape a catalog entry declares. */
-type OutputsOf<K extends keyof AiModels> = AiModels[K] extends {
-  postProcessedOutputs: infer O;
-}
-  ? O
-  : never;
-/**
- * Catalog keys whose input takes a required `messages` array — every current
- * chat model. Newer entries get their own generated class rather than
- * extending `BaseAiTextGeneration`, so the base-class arm alone misses them.
- */
-type ChatCatalogId = {
-  [K in keyof AiModels]: Extract<
-    InputsOf<K>,
-    {
-      messages: unknown;
-    }
-  > extends never
-    ? never
-    : K;
-}[keyof AiModels];
-/**
- * Catalog keys that take text and answer with embedding vectors. Both halves
- * matter: the input test alone also matches translation, classification and
- * speech models, which take `text` but return something else entirely.
- */
-type EmbeddingCatalogId = {
-  [K in keyof AiModels]: Extract<
-    InputsOf<K>,
-    {
-      text: unknown;
-    }
-  > extends never
-    ? never
-    : Extract<
-          OutputsOf<K>,
-          {
-            data?: number[][];
-          }
-        > extends never
-      ? never
-      : K;
-}[keyof AiModels];
-/**
- * Catalog keys that take audio to transcribe. The `audio` key is required on
- * every speech-recognition input and on no other input shape, so the test is
- * exact rather than heuristic.
- */
-type TranscriptionCatalogId = {
-  [K in keyof AiModels]: Extract<
-    InputsOf<K>,
-    {
-      audio: unknown;
-    }
-  > extends never
-    ? never
-    : K;
-}[keyof AiModels];
-/**
- * Catalog keys that score a list of contexts against a query — rerankers.
- * `contexts` is required on exactly those inputs.
- */
-type RerankingCatalogId = {
-  [K in keyof AiModels]: Extract<
-    InputsOf<K>,
-    {
-      contexts: unknown;
-    }
-  > extends never
-    ? never
-    : K;
-}[keyof AiModels];
-/**
- * A Workers AI model id.
- *
- * Workers AI is the one catalog this package keeps up with, so this is the
- * only id shape it accepts: `@cf/<author>/<model>`. Autocomplete covers the
- * text-generation catalog from the installed `@cloudflare/workers-types`; the
- * template arm keeps every other `@cf/` slug assignable, because the catalog
- * lives server-side and moves independently of these types.
- *
- * Third-party models are not ids here — they are model objects built by their
- * own provider package and routed through AI Gateway.
- *
- * @experimental This surface is experimental and may change.
- */
-type WorkersAIModelId =
-  | Extract<
-      | ChatCatalogId
-      | Exclude<
-          WorkersAIModelIdsExtending<BaseAiTextGeneration>,
-          WorkersAIModelIdsExtending<BaseAiTextToImage>
-        >,
-      `@cf/${string}`
-    >
-  | (`@cf/${string}` & {});
-/**
- * A text-embedding model id accepted by `ai.embedding()`.
- *
- * The modality methods are Workers AI only — there is no vendor route for them
- * — so, like {@link WorkersAIModelId}, they take `@cf/` ids and nothing else.
- *
- * @experimental This surface is experimental and may change.
- */
-type CloudflareEmbeddingModelId =
-  | Extract<
-      EmbeddingCatalogId | WorkersAIModelIdsExtending<BaseAiTextEmbeddings>,
-      `@cf/${string}`
-    >
-  | (`@cf/${string}` & {});
-/**
- * Workers AI text-to-image ids that the generated `AiModels` entries do not
- * classify as {@link BaseAiTextToImage} — the newer partner models get their
- * own generated class instead. Curated for autocomplete only; the catalog
- * lives server-side and any slug is accepted.
- *
- * The FLUX.2 family (`flux-2-dev`, `flux-2-klein-4b`, `flux-2-klein-9b`) is
- * deliberately absent, for the reason {@link UnsupportedTranscriptionId}
- * records for the Deepgram recognisers: its generated input takes a required
- * `multipart` object body (`{ multipart: { body, contentType } }`) and no
- * `prompt`, which the JSON run path cannot carry — live, the run path answers
- * `400 Bad input: required properties at "/" are 'multipart'`. Suggesting an
- * id that always 400s is worse than not suggesting it.
- *
- * @experimental This surface is experimental and may change.
- */
-type KnownImageModelId =
-  | "@cf/black-forest-labs/flux-1-schnell"
-  | "@cf/leonardo/lucid-origin"
-  | "@cf/leonardo/phoenix-1.0";
-/**
- * An image model id accepted by `ai.image()`.
- *
- * @experimental This surface is experimental and may change.
- */
-type CloudflareImageModelId =
-  | Extract<
-      WorkersAIModelIdsExtending<BaseAiTextToImage> | KnownImageModelId,
-      `@cf/${string}`
-    >
-  | (`@cf/${string}` & {});
-/**
- * Workers AI text-to-speech ids without a {@link BaseAiTextToSpeech} entry.
- * Curated for autocomplete only.
- *
- * @experimental This surface is experimental and may change.
- */
-type KnownSpeechModelId =
-  | "@cf/deepgram/aura-1"
-  | "@cf/deepgram/aura-2-en"
-  | "@cf/deepgram/aura-2-es";
-/**
- * A text-to-speech model id accepted by `ai.speech()`.
- *
- * @experimental This surface is experimental and may change.
- */
-type CloudflareSpeechModelId =
-  | Extract<
-      WorkersAIModelIdsExtending<BaseAiTextToSpeech> | KnownSpeechModelId,
-      `@cf/${string}`
-    >
-  | (`@cf/${string}` & {});
-/**
- * Deepgram's recognition models want the audio as an object body
- * (`audio: { body, contentType }`) rather than as base64, which the JSON run
- * path cannot carry — every documented variant answered `400` live. They stay
- * out of the suggested arm, and the transcription model answers a clear error
- * for them.
- */
-type UnsupportedTranscriptionId = "@cf/deepgram/nova-3" | "@cf/deepgram/flux";
-/**
- * A speech-recognition model id accepted by `ai.transcription()`.
- *
- * Deepgram's recognition models (`@cf/deepgram/nova-3`, `@cf/deepgram/flux`)
- * are deliberately not suggested: the run path rejects their documented input
- * shape, so this provider answers a clear error for them rather than a 400.
- *
- * @experimental This surface is experimental and may change.
- */
-type CloudflareTranscriptionModelId =
-  | Extract<
-      | Exclude<TranscriptionCatalogId, UnsupportedTranscriptionId>
-      | Exclude<
-          WorkersAIModelIdsExtending<BaseAiAutomaticSpeechRecognition>,
-          UnsupportedTranscriptionId
-        >,
-      `@cf/${string}`
-    >
-  | (`@cf/${string}` & {});
-/**
- * A reranking model id accepted by `ai.reranking()`.
- *
- * @experimental This surface is experimental and may change.
- */
-type CloudflareRerankingModelId =
-  | Extract<RerankingCatalogId, `@cf/${string}`>
-  | (`@cf/${string}` & {});
-//#endregion
-//#region src/models/core/settings.d.ts
-/**
- * AI Gateway settings for a request. The gateway is an option, not a separate
- * product: every call goes through one, and `id` defaults to `"default"`,
- * which Cloudflare creates on first use.
- *
- * @experimental This surface is experimental and may change.
- */
-interface GatewayOptions {
-  /** Gateway id. Defaults to `"default"` (auto-created on first use). */
-  id?: string;
-  /** Bypass the cache for this request. */
-  skipCache?: boolean;
-  /** Cache lifetime in seconds. */
-  cacheTtl?: number;
-  /** Explicit cache key, instead of the request-derived one. */
-  cacheKey?: string;
-  /** Whether the gateway stores the request/response in its log. */
-  collectLog?: boolean;
-  /** Arbitrary key/values attached to the gateway log entry. */
-  metadata?: Record<string, string | number | boolean | null>;
-  /** Correlates several requests into one gateway event. */
-  eventId?: string;
-  /** Upstream request timeout in milliseconds. */
-  requestTimeoutMs?: number;
-  /** Server-side retry policy for the upstream provider call. */
-  retries?: {
-    maxAttempts?: 1 | 2 | 3 | 4 | 5;
-    retryDelayMs?: number;
-    backoff?: "constant" | "linear" | "exponential";
-  };
-}
-/**
- * How `createAI` reaches Cloudflare: the Workers AI binding, and nothing else.
- * Workers AI models go through `env.AI.run`, vendor models through
- * `env.AI.gateway(id).run` — both are the binding, so there is no HTTP
- * transport, no account id and no API token to hold.
- *
- * @experimental This surface is experimental and may change.
- */
-type AISettings = {
-  /** The `AI` binding from a Worker's env. */ binding: Ai;
-} & ProviderGatewaySettings;
-/**
- * Provider-wide gateway defaults, in either spelling: nested under `gateway`,
- * or flat (`{ id: "prod", cacheTtl: 60 }`). Both merge, the flat key winning.
- *
- * @experimental This surface is experimental and may change.
- */
-interface ProviderGatewaySettings extends GatewayOptions {
-  /** Gateway id or full gateway options. */
-  gateway?: string | GatewayOptions;
-}
-/**
- * Per-model and per-call options. The flat gateway keys are sugar for
- * `gateway: { ... }`; both forms merge, with the flat key winning.
- *
- * The same shape is accepted per call under
- * `providerOptions.cloudflare`, where it takes precedence over the per-model
- * options, which in turn take precedence over the `createAI` settings.
- *
- * `Leg` is what a framework module accepts as a fallback leg. Workers AI ids
- * are the only kind this module can resolve on its own, so they are the
- * default; a module whose legs may also be model objects says so
- * (`ModelOptions<WorkersAIModelId | LanguageModelV4>`) rather than rebuilding
- * the type.
- *
- * @experimental This surface is experimental and may change.
- */
-interface ModelOptions<Leg = WorkersAIModelId> extends ProviderGatewaySettings {
-  /**
-   * Models to try, in order, if the primary fails before any output is
-   * produced. A leg travels with the chain's gateway options — those win over
-   * a leg's own, and `metadata` merges — while everything a leg was built with
-   * itself stays its own. Client-side today; becomes server-side when the
-   * platform ships model-first routing.
-   */
-  fallback?: Leg[];
-  /** Extra request headers, merged last. */
-  headers?: Record<string, string>;
-  /**
-   * Workers AI only: route same-key requests to the same replica for
-   * prefix-cache hits. Sent as the `x-session-affinity` header.
-   */
-  sessionAffinity?: string;
-  /**
-   * Explicit reasoning effort. `null` disables reasoning on models that
-   * support toggling it. The unified AI SDK `reasoning` call option maps onto
-   * this when this is not set.
-   */
-  reasoningEffort?: "low" | "medium" | "high" | null;
-  /**
-   * Workers AI only: forwarded verbatim as `chat_template_kwargs`, e.g.
-   * `{ enable_thinking: false }`.
-   */
-  chatTemplateKwargs?: Record<string, unknown>;
-}
-/** A gateway config with the id filled in. */
-interface ResolvedGateway extends GatewayOptions {
-  id: string;
-}
-//#endregion
-export {
-  ResolvedGateway as a,
-  CloudflareRerankingModelId as c,
-  KnownImageModelId as d,
-  KnownSpeechModelId as f,
-  ProviderGatewaySettings as i,
-  CloudflareSpeechModelId as l,
-  GatewayOptions as n,
-  CloudflareEmbeddingModelId as o,
-  WorkersAIModelId as p,
-  ModelOptions as r,
-  CloudflareImageModelId as s,
-  AISettings as t,
-  CloudflareTranscriptionModelId as u
-};
-//# sourceMappingURL=settings-NgGwF7Qt.d.ts.map