cloudflare 6.4.0 → 6.5.0

package/resources/aisearch/instances/instances.d.ts

@@ -2,7 +2,6 @@ import { APIResource } from "../../../resource.js";
 import * as Core from "../../../core.js";
 import * as JobsAPI from "./jobs.js";
 import { JobCreateParams, JobCreateResponse, JobGetParams, JobGetResponse, JobListParams, JobListResponse, JobListResponsesV4PagePaginationArray, JobLogsParams, JobLogsResponse, Jobs } from "./jobs.js";
-import * as SippyAPI from "../../r2/buckets/sippy.js";
 import { V4PagePaginationArray, type V4PagePaginationArrayParams } from "../../../pagination.js";
 export declare class Instances extends APIResource {
     jobs: JobsAPI.Jobs;
@@ -67,7 +66,7 @@ export declare class Instances extends APIResource {
      *     'my-ai-search',
      *     {
      *       account_id: 'c3dc5f0b34a14ff8e1b3ec04895e1b22',
-     *       messages: [{ content: 'content', role: 'system' }],
+     *       messages: [{ content: 'string', role: 'system' }],
      *     },
      *   );
      * ```
@@ -134,7 +133,7 @@ export interface InstanceCreateResponse {
     chunk_size?: number;
     created_by?: string | null;
     custom_metadata?: Array<InstanceCreateResponse.CustomMetadata>;
-    embedding_model?: '@cf/qwen/qwen3-embedding-0.6b' | '@cf/baai/bge-m3' | '@cf/baai/bge-large-en-v1.5' | '@cf/google/embeddinggemma-300m' | 'google-ai-studio/gemini-embedding-001' | 'google-ai-studio/gemini-embedding-2-preview' | 'openai/text-embedding-3-small' | 'openai/text-embedding-3-large' | '' | null;
+    embedding_model?: '@cf/qwen/qwen3-embedding-0.6b' | '@cf/qwen/qwen3-vl-embedding-2b' | '@cf/baai/bge-m3' | '@cf/baai/bge-large-en-v1.5' | '@cf/google/embeddinggemma-300m' | 'google-ai-studio/gemini-embedding-001' | 'google-ai-studio/gemini-embedding-2-preview' | 'openai/text-embedding-3-small' | 'openai/text-embedding-3-large' | '' | null;
     enable?: boolean;
     engine_version?: number;
     fusion_method?: 'max' | 'rrf';
@@ -291,19 +290,10 @@ export declare namespace InstanceCreateResponse {
     }
     namespace SourceParams {
         interface WebCrawler {
-            crawl_options?: WebCrawler.CrawlOptions;
             parse_options?: WebCrawler.ParseOptions;
-            parse_type?: 'sitemap' | 'feed-rss' | 'crawl';
-            store_options?: WebCrawler.StoreOptions;
+            parse_type?: 'sitemap' | 'crawl';
         }
         namespace WebCrawler {
-            interface CrawlOptions {
-                depth?: number;
-                include_external_links?: boolean;
-                include_subdomains?: boolean;
-                max_age?: number;
-                source?: 'all' | 'sitemaps' | 'links';
-            }
             interface ParseOptions {
                 /**
                  * List of path-to-selector mappings for extracting specific content from crawled
@@ -343,11 +333,6 @@ export declare namespace InstanceCreateResponse {
                     selector: string;
                 }
             }
-            interface StoreOptions {
-                storage_id: string;
-                r2_jurisdiction?: string;
-                storage_type?: SippyAPI.Provider;
-            }
         }
     }
 }
@@ -372,7 +357,7 @@ export interface InstanceUpdateResponse {
     chunk_size?: number;
     created_by?: string | null;
     custom_metadata?: Array<InstanceUpdateResponse.CustomMetadata>;
-    embedding_model?: '@cf/qwen/qwen3-embedding-0.6b' | '@cf/baai/bge-m3' | '@cf/baai/bge-large-en-v1.5' | '@cf/google/embeddinggemma-300m' | 'google-ai-studio/gemini-embedding-001' | 'google-ai-studio/gemini-embedding-2-preview' | 'openai/text-embedding-3-small' | 'openai/text-embedding-3-large' | '' | null;
+    embedding_model?: '@cf/qwen/qwen3-embedding-0.6b' | '@cf/qwen/qwen3-vl-embedding-2b' | '@cf/baai/bge-m3' | '@cf/baai/bge-large-en-v1.5' | '@cf/google/embeddinggemma-300m' | 'google-ai-studio/gemini-embedding-001' | 'google-ai-studio/gemini-embedding-2-preview' | 'openai/text-embedding-3-small' | 'openai/text-embedding-3-large' | '' | null;
     enable?: boolean;
     engine_version?: number;
     fusion_method?: 'max' | 'rrf';
@@ -529,19 +514,10 @@ export declare namespace InstanceUpdateResponse {
     }
     namespace SourceParams {
         interface WebCrawler {
-            crawl_options?: WebCrawler.CrawlOptions;
             parse_options?: WebCrawler.ParseOptions;
-            parse_type?: 'sitemap' | 'feed-rss' | 'crawl';
-            store_options?: WebCrawler.StoreOptions;
+            parse_type?: 'sitemap' | 'crawl';
         }
         namespace WebCrawler {
-            interface CrawlOptions {
-                depth?: number;
-                include_external_links?: boolean;
-                include_subdomains?: boolean;
-                max_age?: number;
-                source?: 'all' | 'sitemaps' | 'links';
-            }
             interface ParseOptions {
                 /**
                  * List of path-to-selector mappings for extracting specific content from crawled
@@ -581,11 +557,6 @@ export declare namespace InstanceUpdateResponse {
                     selector: string;
                 }
             }
-            interface StoreOptions {
-                storage_id: string;
-                r2_jurisdiction?: string;
-                storage_type?: SippyAPI.Provider;
-            }
         }
     }
 }
@@ -610,7 +581,7 @@ export interface InstanceListResponse {
     chunk_size?: number;
     created_by?: string | null;
     custom_metadata?: Array<InstanceListResponse.CustomMetadata>;
-    embedding_model?: '@cf/qwen/qwen3-embedding-0.6b' | '@cf/baai/bge-m3' | '@cf/baai/bge-large-en-v1.5' | '@cf/google/embeddinggemma-300m' | 'google-ai-studio/gemini-embedding-001' | 'google-ai-studio/gemini-embedding-2-preview' | 'openai/text-embedding-3-small' | 'openai/text-embedding-3-large' | '' | null;
+    embedding_model?: '@cf/qwen/qwen3-embedding-0.6b' | '@cf/qwen/qwen3-vl-embedding-2b' | '@cf/baai/bge-m3' | '@cf/baai/bge-large-en-v1.5' | '@cf/google/embeddinggemma-300m' | 'google-ai-studio/gemini-embedding-001' | 'google-ai-studio/gemini-embedding-2-preview' | 'openai/text-embedding-3-small' | 'openai/text-embedding-3-large' | '' | null;
     enable?: boolean;
     engine_version?: number;
     fusion_method?: 'max' | 'rrf';
@@ -767,19 +738,10 @@ export declare namespace InstanceListResponse {
     }
     namespace SourceParams {
         interface WebCrawler {
-            crawl_options?: WebCrawler.CrawlOptions;
             parse_options?: WebCrawler.ParseOptions;
-            parse_type?: 'sitemap' | 'feed-rss' | 'crawl';
-            store_options?: WebCrawler.StoreOptions;
+            parse_type?: 'sitemap' | 'crawl';
         }
         namespace WebCrawler {
-            interface CrawlOptions {
-                depth?: number;
-                include_external_links?: boolean;
-                include_subdomains?: boolean;
-                max_age?: number;
-                source?: 'all' | 'sitemaps' | 'links';
-            }
             interface ParseOptions {
                 /**
                  * List of path-to-selector mappings for extracting specific content from crawled
@@ -819,11 +781,6 @@ export declare namespace InstanceListResponse {
                     selector: string;
                 }
             }
-            interface StoreOptions {
-                storage_id: string;
-                r2_jurisdiction?: string;
-                storage_type?: SippyAPI.Provider;
-            }
         }
     }
 }
@@ -848,7 +805,7 @@ export interface InstanceDeleteResponse {
     chunk_size?: number;
     created_by?: string | null;
     custom_metadata?: Array<InstanceDeleteResponse.CustomMetadata>;
-    embedding_model?: '@cf/qwen/qwen3-embedding-0.6b' | '@cf/baai/bge-m3' | '@cf/baai/bge-large-en-v1.5' | '@cf/google/embeddinggemma-300m' | 'google-ai-studio/gemini-embedding-001' | 'google-ai-studio/gemini-embedding-2-preview' | 'openai/text-embedding-3-small' | 'openai/text-embedding-3-large' | '' | null;
+    embedding_model?: '@cf/qwen/qwen3-embedding-0.6b' | '@cf/qwen/qwen3-vl-embedding-2b' | '@cf/baai/bge-m3' | '@cf/baai/bge-large-en-v1.5' | '@cf/google/embeddinggemma-300m' | 'google-ai-studio/gemini-embedding-001' | 'google-ai-studio/gemini-embedding-2-preview' | 'openai/text-embedding-3-small' | 'openai/text-embedding-3-large' | '' | null;
     enable?: boolean;
     engine_version?: number;
     fusion_method?: 'max' | 'rrf';
@@ -1005,19 +962,10 @@ export declare namespace InstanceDeleteResponse {
     }
     namespace SourceParams {
         interface WebCrawler {
-            crawl_options?: WebCrawler.CrawlOptions;
             parse_options?: WebCrawler.ParseOptions;
-            parse_type?: 'sitemap' | 'feed-rss' | 'crawl';
-            store_options?: WebCrawler.StoreOptions;
+            parse_type?: 'sitemap' | 'crawl';
         }
         namespace WebCrawler {
-            interface CrawlOptions {
-                depth?: number;
-                include_external_links?: boolean;
-                include_subdomains?: boolean;
-                max_age?: number;
-                source?: 'all' | 'sitemaps' | 'links';
-            }
             interface ParseOptions {
                 /**
                  * List of path-to-selector mappings for extracting specific content from crawled
@@ -1057,11 +1005,6 @@ export declare namespace InstanceDeleteResponse {
                     selector: string;
                 }
             }
-            interface StoreOptions {
-                storage_id: string;
-                r2_jurisdiction?: string;
-                storage_type?: SippyAPI.Provider;
-            }
         }
     }
 }
@@ -1080,10 +1023,25 @@ export declare namespace InstanceChatCompletionsResponse {
     }
     namespace Choice {
         interface Message {
-            content: string | null;
+            content: string | Array<Message.UnionMember0 | Message.UnionMember1> | null;
             role: 'system' | 'developer' | 'user' | 'assistant' | 'tool';
             [k: string]: unknown;
         }
+        namespace Message {
+            interface UnionMember0 {
+                text: string;
+                type: 'text';
+            }
+            interface UnionMember1 {
+                image_url: UnionMember1.ImageURL;
+                type: 'image_url';
+            }
+            namespace UnionMember1 {
+                interface ImageURL {
+                    url: string;
+                }
+            }
+        }
     }
     interface Chunk {
         id: string;
@@ -1132,7 +1090,7 @@ export interface InstanceReadResponse {
     chunk_size?: number;
     created_by?: string | null;
     custom_metadata?: Array<InstanceReadResponse.CustomMetadata>;
-    embedding_model?: '@cf/qwen/qwen3-embedding-0.6b' | '@cf/baai/bge-m3' | '@cf/baai/bge-large-en-v1.5' | '@cf/google/embeddinggemma-300m' | 'google-ai-studio/gemini-embedding-001' | 'google-ai-studio/gemini-embedding-2-preview' | 'openai/text-embedding-3-small' | 'openai/text-embedding-3-large' | '' | null;
+    embedding_model?: '@cf/qwen/qwen3-embedding-0.6b' | '@cf/qwen/qwen3-vl-embedding-2b' | '@cf/baai/bge-m3' | '@cf/baai/bge-large-en-v1.5' | '@cf/google/embeddinggemma-300m' | 'google-ai-studio/gemini-embedding-001' | 'google-ai-studio/gemini-embedding-2-preview' | 'openai/text-embedding-3-small' | 'openai/text-embedding-3-large' | '' | null;
     enable?: boolean;
     engine_version?: number;
     fusion_method?: 'max' | 'rrf';
@@ -1289,19 +1247,10 @@ export declare namespace InstanceReadResponse {
     }
     namespace SourceParams {
         interface WebCrawler {
-            crawl_options?: WebCrawler.CrawlOptions;
             parse_options?: WebCrawler.ParseOptions;
-            parse_type?: 'sitemap' | 'feed-rss' | 'crawl';
-            store_options?: WebCrawler.StoreOptions;
+            parse_type?: 'sitemap' | 'crawl';
         }
         namespace WebCrawler {
-            interface CrawlOptions {
-                depth?: number;
-                include_external_links?: boolean;
-                include_subdomains?: boolean;
-                max_age?: number;
-                source?: 'all' | 'sitemaps' | 'links';
-            }
             interface ParseOptions {
                 /**
                  * List of path-to-selector mappings for extracting specific content from crawled
@@ -1341,17 +1290,13 @@ export declare namespace InstanceReadResponse {
                     selector: string;
                 }
             }
-            interface StoreOptions {
-                storage_id: string;
-                r2_jurisdiction?: string;
-                storage_type?: SippyAPI.Provider;
-            }
         }
     }
 }
 export interface InstanceSearchResponse {
     chunks: Array<InstanceSearchResponse.Chunk>;
-    search_query: string;
+    query_kind: 'text' | 'image' | 'multimodal';
+    search_query?: string;
 }
 export declare namespace InstanceSearchResponse {
     interface Chunk {
@@ -1487,7 +1432,7 @@ export interface InstanceCreateParams {
     /**
      * Body param
      */
-    embedding_model?: '@cf/qwen/qwen3-embedding-0.6b' | '@cf/baai/bge-m3' | '@cf/baai/bge-large-en-v1.5' | '@cf/google/embeddinggemma-300m' | 'google-ai-studio/gemini-embedding-001' | 'google-ai-studio/gemini-embedding-2-preview' | 'openai/text-embedding-3-small' | 'openai/text-embedding-3-large' | '' | null;
+    embedding_model?: '@cf/qwen/qwen3-embedding-0.6b' | '@cf/qwen/qwen3-vl-embedding-2b' | '@cf/baai/bge-m3' | '@cf/baai/bge-large-en-v1.5' | '@cf/google/embeddinggemma-300m' | 'google-ai-studio/gemini-embedding-001' | 'google-ai-studio/gemini-embedding-2-preview' | 'openai/text-embedding-3-small' | 'openai/text-embedding-3-large' | '' | null;
     /**
      * Body param
      */
@@ -1682,19 +1627,10 @@ export declare namespace InstanceCreateParams {
     }
     namespace SourceParams {
         interface WebCrawler {
-            crawl_options?: WebCrawler.CrawlOptions;
             parse_options?: WebCrawler.ParseOptions;
-            parse_type?: 'sitemap' | 'feed-rss' | 'crawl';
-            store_options?: WebCrawler.StoreOptions;
+            parse_type?: 'sitemap' | 'crawl';
         }
         namespace WebCrawler {
-            interface CrawlOptions {
-                depth?: number;
-                include_external_links?: boolean;
-                include_subdomains?: boolean;
-                max_age?: number;
-                source?: 'all' | 'sitemaps' | 'links';
-            }
             interface ParseOptions {
                 /**
                  * List of path-to-selector mappings for extracting specific content from crawled
@@ -1734,11 +1670,6 @@ export declare namespace InstanceCreateParams {
                     selector: string;
                 }
             }
-            interface StoreOptions {
-                storage_id: string;
-                r2_jurisdiction?: string;
-                storage_type?: SippyAPI.ProviderParam;
-            }
         }
     }
 }
@@ -1788,7 +1719,7 @@ export interface InstanceUpdateParams {
     /**
      * Body param
      */
-    embedding_model?: '@cf/qwen/qwen3-embedding-0.6b' | '@cf/baai/bge-m3' | '@cf/baai/bge-large-en-v1.5' | '@cf/google/embeddinggemma-300m' | 'google-ai-studio/gemini-embedding-001' | 'google-ai-studio/gemini-embedding-2-preview' | 'openai/text-embedding-3-small' | 'openai/text-embedding-3-large' | '' | null;
+    embedding_model?: '@cf/qwen/qwen3-embedding-0.6b' | '@cf/qwen/qwen3-vl-embedding-2b' | '@cf/baai/bge-m3' | '@cf/baai/bge-large-en-v1.5' | '@cf/google/embeddinggemma-300m' | 'google-ai-studio/gemini-embedding-001' | 'google-ai-studio/gemini-embedding-2-preview' | 'openai/text-embedding-3-small' | 'openai/text-embedding-3-large' | '' | null;
     /**
      * Body param
      */
@@ -1842,6 +1773,10 @@ export interface InstanceUpdateParams {
      * Body param
      */
     score_threshold?: number;
+    /**
+     * Body param
+     */
+    source?: string | null;
     /**
      * Body param
      */
@@ -1995,19 +1930,10 @@ export declare namespace InstanceUpdateParams {
     }
     namespace SourceParams {
         interface WebCrawler {
-            crawl_options?: WebCrawler.CrawlOptions;
             parse_options?: WebCrawler.ParseOptions;
-            parse_type?: 'sitemap' | 'feed-rss' | 'crawl';
-            store_options?: WebCrawler.StoreOptions;
+            parse_type?: 'sitemap' | 'crawl';
         }
         namespace WebCrawler {
-            interface CrawlOptions {
-                depth?: number;
-                include_external_links?: boolean;
-                include_subdomains?: boolean;
-                max_age?: number;
-                source?: 'all' | 'sitemaps' | 'links';
-            }
             interface ParseOptions {
                 /**
                  * List of path-to-selector mappings for extracting specific content from crawled
@@ -2047,11 +1973,6 @@ export declare namespace InstanceUpdateParams {
                     selector: string;
                 }
             }
-            interface StoreOptions {
-                storage_id: string;
-                r2_jurisdiction?: string;
-                storage_type?: SippyAPI.ProviderParam;
-            }
         }
     }
 }
@@ -2105,10 +2026,25 @@ export interface InstanceChatCompletionsParams {
 }
 export declare namespace InstanceChatCompletionsParams {
     interface Message {
-        content: string | null;
+        content: string | Array<Message.UnionMember0 | Message.UnionMember1> | null;
         role: 'system' | 'developer' | 'user' | 'assistant' | 'tool';
         [k: string]: unknown;
     }
+    namespace Message {
+        interface UnionMember0 {
+            text: string;
+            type: 'text';
+        }
+        interface UnionMember1 {
+            image_url: UnionMember1.ImageURL;
+            type: 'image_url';
+        }
+        namespace UnionMember1 {
+            interface ImageURL {
+                url: string;
+            }
+        }
+    }
     interface AISearchOptions {
         cache?: AISearchOptions.Cache;
         query_rewrite?: AISearchOptions.QueryRewrite;
@@ -2146,7 +2082,8 @@ export declare namespace InstanceChatCompletionsParams {
             /**
              * Controls which documents are candidates for BM25 scoring. 'and' restricts
              * candidates to documents containing all query terms; 'or' includes any document
-             * containing at least one term, ranked by BM25 relevance. Defaults to 'and'.
+             * containing at least one term, ranked by BM25 relevance. When omitted, falls back
+             * to the instance-level retrieval_options.keyword_match_mode, then to 'and'.
              */
             keyword_match_mode?: 'and' | 'or';
             match_threshold?: number;
@@ -2187,7 +2124,11 @@ export interface InstanceSearchParams {
      */
     ai_search_options?: InstanceSearchParams.AISearchOptions;
     /**
-     * Body param
+     * Body param: OpenAI-compatible message array. For multimodal queries, set the
+     * last user message's `content` to an array of typed parts:
+     * `[{type:'text', text:'…'}, {type:'image_url', image_url:{url:'…'}}]`. Image
+     * inputs require the RAG's embedding_model to declare 'image' in
+     * supported_modalities.
      */
     messages?: Array<InstanceSearchParams.Message>;
     /**
@@ -2234,7 +2175,8 @@ export declare namespace InstanceSearchParams {
             /**
              * Controls which documents are candidates for BM25 scoring. 'and' restricts
              * candidates to documents containing all query terms; 'or' includes any document
-             * containing at least one term, ranked by BM25 relevance. Defaults to 'and'.
+             * containing at least one term, ranked by BM25 relevance. When omitted, falls back
+             * to the instance-level retrieval_options.keyword_match_mode, then to 'and'.
              */
             keyword_match_mode?: 'and' | 'or';
             match_threshold?: number;
@@ -2262,10 +2204,25 @@ export declare namespace InstanceSearchParams {
         }
     }
     interface Message {
-        content: string | null;
+        content: string | Array<Message.UnionMember0 | Message.UnionMember1> | null;
         role: 'system' | 'developer' | 'user' | 'assistant' | 'tool';
         [k: string]: unknown;
     }
+    namespace Message {
+        interface UnionMember0 {
+            text: string;
+            type: 'text';
+        }
+        interface UnionMember1 {
+            image_url: UnionMember1.ImageURL;
+            type: 'image_url';
+        }
+        namespace UnionMember1 {
+            interface ImageURL {
+                url: string;
+            }
+        }
+    }
 }
 export interface InstanceStatsParams {
     account_id: string;