@cloudflare/workers-types 4.20250109.0 → 4.20250124.3

package/2022-03-21/index.d.ts

@@ -3611,7 +3611,10 @@ type AiTextGenerationInput = {
   frequency_penalty?: number;
   presence_penalty?: number;
   messages?: RoleScopedChatInput[];
-  tools?: AiTextGenerationToolInput[] | AiTextGenerationToolLegacyInput[];
+  tools?:
+    | AiTextGenerationToolInput[]
+    | AiTextGenerationToolLegacyInput[]
+    | (object & NonNullable<unknown>);
   functions?: AiTextGenerationFunctionsInput[];
 };
 type AiTextGenerationOutput =
@@ -3670,12 +3673,417 @@ declare abstract class BaseAiTranslation {
   inputs: AiTranslationInput;
   postProcessedOutputs: AiTranslationOutput;
 }
-type AiOptions = {
-  gateway?: GatewayOptions;
+type Ai_Cf_Openai_Whisper_Input =
+  | string
+  | {
+      /**
+       * An array of integers that represent the audio data constrained to 8-bit unsigned integer values
+       */
+      audio: number[];
+    };
+interface Ai_Cf_Openai_Whisper_Output {
+  /**
+   * The transcription
+   */
+  text: string;
+  word_count?: number;
+  words?: {
+    word?: string;
+    /**
+     * The second this word begins in the recording
+     */
+    start?: number;
+    /**
+     * The ending second when the word completes
+     */
+    end?: number;
+  }[];
+  vtt?: string;
+}
+declare abstract class Base_Ai_Cf_Openai_Whisper {
+  inputs: Ai_Cf_Openai_Whisper_Input;
+  postProcessedOutputs: Ai_Cf_Openai_Whisper_Output;
+}
+type Ai_Cf_Openai_Whisper_Tiny_En_Input =
+  | string
+  | {
+      /**
+       * An array of integers that represent the audio data constrained to 8-bit unsigned integer values
+       */
+      audio: number[];
+    };
+interface Ai_Cf_Openai_Whisper_Tiny_En_Output {
+  /**
+   * The transcription
+   */
+  text: string;
+  word_count?: number;
+  words?: {
+    word?: string;
+    /**
+     * The second this word begins in the recording
+     */
+    start?: number;
+    /**
+     * The ending second when the word completes
+     */
+    end?: number;
+  }[];
+  vtt?: string;
+}
+declare abstract class Base_Ai_Cf_Openai_Whisper_Tiny_En {
+  inputs: Ai_Cf_Openai_Whisper_Tiny_En_Input;
+  postProcessedOutputs: Ai_Cf_Openai_Whisper_Tiny_En_Output;
+}
+interface Ai_Cf_Openai_Whisper_Large_V3_Turbo_Input {
+  /**
+   * Base64 encoded value of the audio data.
+   */
+  audio: string;
+  /**
+   * Supported tasks are 'translate' or 'transcribe'.
+   */
+  task?: string;
+  /**
+   * The language of the audio being transcribed or translated.
+   */
+  language?: string;
+  /**
+   * Preprocess the audio with a voice activity detection model.
+   */
+  vad_filter?: string;
+  /**
+   * A text prompt to help provide context to the model on the contents of the audio.
+   */
+  initial_prompt?: string;
+  /**
+   * The prefix it appended the the beginning of the output of the transcription and can guide the transcription result.
+   */
   prefix?: string;
-  extraHeaders?: object;
-};
-type ModelType<Name extends keyof AiModels> = AiModels[Name];
+}
+interface Ai_Cf_Openai_Whisper_Large_V3_Turbo_Output {
+  transcription_info?: {
+    /**
+     * The language of the audio being transcribed or translated.
+     */
+    language?: string;
+    /**
+     * The confidence level or probability of the detected language being accurate, represented as a decimal between 0 and 1.
+     */
+    language_probability?: number;
+    /**
+     * The total duration of the original audio file, in seconds.
+     */
+    duration?: number;
+    /**
+     * The duration of the audio after applying Voice Activity Detection (VAD) to remove silent or irrelevant sections, in seconds.
+     */
+    duration_after_vad?: number;
+  };
+  /**
+   * The complete transcription of the audio.
+   */
+  text: string;
+  /**
+   * The total number of words in the transcription.
+   */
+  word_count?: number;
+  segments?: {
+    /**
+     * The starting time of the segment within the audio, in seconds.
+     */
+    start?: number;
+    /**
+     * The ending time of the segment within the audio, in seconds.
+     */
+    end?: number;
+    /**
+     * The transcription of the segment.
+     */
+    text?: string;
+    /**
+     * The temperature used in the decoding process, controlling randomness in predictions. Lower values result in more deterministic outputs.
+     */
+    temperature?: number;
+    /**
+     * The average log probability of the predictions for the words in this segment, indicating overall confidence.
+     */
+    avg_logprob?: number;
+    /**
+     * The compression ratio of the input to the output, measuring how much the text was compressed during the transcription process.
+     */
+    compression_ratio?: number;
+    /**
+     * The probability that the segment contains no speech, represented as a decimal between 0 and 1.
+     */
+    no_speech_prob?: number;
+    words?: {
+      /**
+       * The individual word transcribed from the audio.
+       */
+      word?: string;
+      /**
+       * The starting time of the word within the audio, in seconds.
+       */
+      start?: number;
+      /**
+       * The ending time of the word within the audio, in seconds.
+       */
+      end?: number;
+    }[];
+  };
+  /**
+   * The transcription in WebVTT format, which includes timing and text information for use in subtitles.
+   */
+  vtt?: string;
+}
+declare abstract class Base_Ai_Cf_Openai_Whisper_Large_V3_Turbo {
+  inputs: Ai_Cf_Openai_Whisper_Large_V3_Turbo_Input;
+  postProcessedOutputs: Ai_Cf_Openai_Whisper_Large_V3_Turbo_Output;
+}
+interface Ai_Cf_Black_Forest_Labs_Flux_1_Schnell_Input {
+  /**
+   * A text description of the image you want to generate.
+   */
+  prompt: string;
+  /**
+   * The number of diffusion steps; higher values can improve quality but take longer.
+   */
+  steps?: number;
+}
+interface Ai_Cf_Black_Forest_Labs_Flux_1_Schnell_Output {
+  /**
+   * The generated image in Base64 format.
+   */
+  image?: string;
+}
+declare abstract class Base_Ai_Cf_Black_Forest_Labs_Flux_1_Schnell {
+  inputs: Ai_Cf_Black_Forest_Labs_Flux_1_Schnell_Input;
+  postProcessedOutputs: Ai_Cf_Black_Forest_Labs_Flux_1_Schnell_Output;
+}
+type Ai_Cf_Meta_Llama_3_2_11B_Vision_Instruct_Input = Prompt | Messages;
+interface Prompt {
+  /**
+   * The input text prompt for the model to generate a response.
+   */
+  prompt: string;
+  image?: number[] | (string & NonNullable<unknown>);
+  /**
+   * If true, a chat template is not applied and you must adhere to the specific model's expected formatting.
+   */
+  raw?: boolean;
+  /**
+   * If true, the response will be streamed back incrementally using SSE, Server Sent Events.
+   */
+  stream?: boolean;
+  /**
+   * The maximum number of tokens to generate in the response.
+   */
+  max_tokens?: number;
+  /**
+   * Controls the randomness of the output; higher values produce more random results.
+   */
+  temperature?: number;
+  /**
+   * Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses.
+   */
+  top_p?: number;
+  /**
+   * Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises.
+   */
+  top_k?: number;
+  /**
+   * Random seed for reproducibility of the generation.
+   */
+  seed?: number;
+  /**
+   * Penalty for repeated tokens; higher values discourage repetition.
+   */
+  repetition_penalty?: number;
+  /**
+   * Decreases the likelihood of the model repeating the same lines verbatim.
+   */
+  frequency_penalty?: number;
+  /**
+   * Increases the likelihood of the model introducing new topics.
+   */
+  presence_penalty?: number;
+  /**
+   * Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model.
+   */
+  lora?: string;
+}
+interface Messages {
+  /**
+   * An array of message objects representing the conversation history.
+   */
+  messages: {
+    /**
+     * The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool').
+     */
+    role: string;
+    /**
+     * The content of the message as a string.
+     */
+    content: string;
+  }[];
+  image?: number[] | string;
+  functions?: {
+    name: string;
+    code: string;
+  }[];
+  /**
+   * A list of tools available for the assistant to use.
+   */
+  tools?: (
+    | {
+        /**
+         * The name of the tool. More descriptive the better.
+         */
+        name: string;
+        /**
+         * A brief description of what the tool does.
+         */
+        description: string;
+        /**
+         * Schema defining the parameters accepted by the tool.
+         */
+        parameters: {
+          /**
+           * The type of the parameters object (usually 'object').
+           */
+          type: string;
+          /**
+           * List of required parameter names.
+           */
+          required?: string[];
+          /**
+           * Definitions of each parameter.
+           */
+          properties: {
+            [k: string]: {
+              /**
+               * The data type of the parameter.
+               */
+              type: string;
+              /**
+               * A description of the expected parameter.
+               */
+              description: string;
+            };
+          };
+        };
+      }
+    | {
+        /**
+         * Specifies the type of tool (e.g., 'function').
+         */
+        type: string;
+        /**
+         * Details of the function tool.
+         */
+        function: {
+          /**
+           * The name of the function.
+           */
+          name: string;
+          /**
+           * A brief description of what the function does.
+           */
+          description: string;
+          /**
+           * Schema defining the parameters accepted by the function.
+           */
+          parameters: {
+            /**
+             * The type of the parameters object (usually 'object').
+             */
+            type: string;
+            /**
+             * List of required parameter names.
+             */
+            required?: string[];
+            /**
+             * Definitions of each parameter.
+             */
+            properties: {
+              [k: string]: {
+                /**
+                 * The data type of the parameter.
+                 */
+                type: string;
+                /**
+                 * A description of the expected parameter.
+                 */
+                description: string;
+              };
+            };
+          };
+        };
+      }
+  )[];
+  /**
+   * If true, the response will be streamed back incrementally.
+   */
+  stream?: boolean;
+  /**
+   * The maximum number of tokens to generate in the response.
+   */
+  max_tokens?: number;
+  /**
+   * Controls the randomness of the output; higher values produce more random results.
+   */
+  temperature?: number;
+  /**
+   * Controls the creativity of the AI's responses by adjusting how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses.
+   */
+  top_p?: number;
+  /**
+   * Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises.
+   */
+  top_k?: number;
+  /**
+   * Random seed for reproducibility of the generation.
+   */
+  seed?: number;
+  /**
+   * Penalty for repeated tokens; higher values discourage repetition.
+   */
+  repetition_penalty?: number;
+  /**
+   * Decreases the likelihood of the model repeating the same lines verbatim.
+   */
+  frequency_penalty?: number;
+  /**
+   * Increases the likelihood of the model introducing new topics.
+   */
+  presence_penalty?: number;
+}
+type Ai_Cf_Meta_Llama_3_2_11B_Vision_Instruct_Output =
+  | {
+      /**
+       * The generated text response from the model
+       */
+      response?: string;
+      /**
+       * An array of tool calls requests made during the response generation
+       */
+      tool_calls?: {
+        /**
+         * The arguments passed to be passed to the tool call request
+         */
+        arguments?: object;
+        /**
+         * The name of the tool to be called
+         */
+        name?: string;
+      }[];
+    }
+  | ReadableStream;
+declare abstract class Base_Ai_Cf_Meta_Llama_3_2_11B_Vision_Instruct {
+  inputs: Ai_Cf_Meta_Llama_3_2_11B_Vision_Instruct_Input;
+  postProcessedOutputs: Ai_Cf_Meta_Llama_3_2_11B_Vision_Instruct_Output;
+}
 interface AiModels {
   "@cf/huggingface/distilbert-sst-2-int8": BaseAiTextClassification;
   "@cf/stabilityai/stable-diffusion-xl-base-1.0": BaseAiTextToImage;
@@ -3732,16 +4140,54 @@ interface AiModels {
   "@cf/facebook/bart-large-cnn": BaseAiSummarization;
   "@cf/unum/uform-gen2-qwen-500m": BaseAiImageToText;
   "@cf/llava-hf/llava-1.5-7b-hf": BaseAiImageToText;
+  "@cf/openai/whisper": Base_Ai_Cf_Openai_Whisper;
+  "@cf/openai/whisper-tiny-en": Base_Ai_Cf_Openai_Whisper_Tiny_En;
+  "@cf/openai/whisper-large-v3-turbo": Base_Ai_Cf_Openai_Whisper_Large_V3_Turbo;
+  "@cf/black-forest-labs/flux-1-schnell": Base_Ai_Cf_Black_Forest_Labs_Flux_1_Schnell;
+  "@cf/meta/llama-3.2-11b-vision-instruct": Base_Ai_Cf_Meta_Llama_3_2_11B_Vision_Instruct;
 }
-type ModelListType = Record<string, any>;
-declare abstract class Ai<ModelList extends ModelListType = AiModels> {
+type AiOptions = {
+  gateway?: GatewayOptions;
+  prefix?: string;
+  extraHeaders?: object;
+};
+type AiModelsSearchParams = {
+  author?: string;
+  hide_experimental?: boolean;
+  page?: number;
+  per_page?: number;
+  search?: string;
+  source?: number;
+  task?: string;
+};
+type AiModelsSearchObject = {
+  id: string;
+  source: number;
+  name: string;
+  description: string;
+  task: {
+    id: string;
+    name: string;
+    description: string;
+  };
+  tags: string[];
+  properties: {
+    property_id: string;
+    value: string;
+  }[];
+};
+interface InferenceUpstreamError extends Error {}
+interface AiInternalError extends Error {}
+type AiModelListType = Record<string, any>;
+declare abstract class Ai<AiModelList extends AiModelListType = AiModels> {
   aiGatewayLogId: string | null;
   gateway(gatewayId: string): AiGateway;
-  run<Name extends keyof ModelList>(
+  run<Name extends keyof AiModelList>(
     model: Name,
-    inputs: ModelList[Name]["inputs"],
+    inputs: AiModelList[Name]["inputs"],
     options?: AiOptions,
-  ): Promise<ModelList[Name]["postProcessedOutputs"]>;
+  ): Promise<AiModelList[Name]["postProcessedOutputs"]>;
+  public models(params?: AiModelsSearchParams): Promise<AiModelsSearchObject[]>;
 }
 type GatewayOptions = {
   id: string;