@zenning/openai 1.4.2 → 1.4.4

package/dist/index.d.mts

@@ -183,147 +183,159 @@ type OpenAITranscriptionModelId = 'whisper-1' | 'gpt-4o-mini-transcribe' | 'gpt-
 
 type OpenAIResponsesModelId = 'o1' | 'o1-2024-12-17' | 'o1-mini' | 'o1-mini-2024-09-12' | 'o1-preview' | 'o1-preview-2024-09-12' | 'o3-mini' | 'o3-mini-2025-01-31' | 'o3' | 'o3-2025-04-16' | 'o4-mini' | 'o4-mini-2025-04-16' | 'gpt-4.1' | 'gpt-4.1-2025-04-14' | 'gpt-4.1-mini' | 'gpt-4.1-mini-2025-04-14' | 'gpt-4.1-nano' | 'gpt-4.1-nano-2025-04-14' | 'gpt-4o' | 'gpt-4o-2024-05-13' | 'gpt-4o-2024-08-06' | 'gpt-4o-2024-11-20' | 'gpt-4o-audio-preview' | 'gpt-4o-audio-preview-2024-10-01' | 'gpt-4o-audio-preview-2024-12-17' | 'gpt-4o-search-preview' | 'gpt-4o-search-preview-2025-03-11' | 'gpt-4o-mini-search-preview' | 'gpt-4o-mini-search-preview-2025-03-11' | 'gpt-4o-mini' | 'gpt-4o-mini-2024-07-18' | 'gpt-4-turbo' | 'gpt-4-turbo-2024-04-09' | 'gpt-4-turbo-preview' | 'gpt-4-0125-preview' | 'gpt-4-1106-preview' | 'gpt-4' | 'gpt-4-0613' | 'gpt-4.5-preview' | 'gpt-4.5-preview-2025-02-27' | 'gpt-3.5-turbo-0125' | 'gpt-3.5-turbo' | 'gpt-3.5-turbo-1106' | 'chatgpt-4o-latest' | (string & {});
 
-declare const WebSearchPreviewParameters: z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>;
-declare function webSearchPreviewTool({ searchContextSize, userLocation, }?: {
+declare function codeInterpreter(args?: {
+    container?: string | {
+        fileIds?: string[];
+    };
+}): {
+    type: "provider-defined";
+    id: "openai.code_interpreter";
+    name: "code_interpreter";
+    args: {
+        container?: string | {
+            fileIds?: string[];
+        };
+    };
+};
+
+declare function fileSearch(args?: {
+    vectorStoreIds?: string[];
+    maxNumResults?: number;
+    ranking?: {
+        ranker?: 'auto' | 'default-2024-08-21';
+    };
+    filters?: {
+        key: string;
+        type: 'eq' | 'ne' | 'gt' | 'gte' | 'lt' | 'lte';
+        value: string | number | boolean;
+    } | {
+        type: 'and' | 'or';
+        filters: any[];
+    };
+}): {
+    type: "provider-defined";
+    id: "openai.file_search";
+    name: "file_search";
+    args: {
+        vectorStoreIds?: string[];
+        maxNumResults?: number;
+        ranking?: {
+            ranker?: "auto" | "default-2024-08-21";
+        };
+        filters?: {
+            key: string;
+            type: "eq" | "ne" | "gt" | "gte" | "lt" | "lte";
+            value: string | number | boolean;
+        } | {
+            type: "and" | "or";
+            filters: any[];
+        };
+    };
+};
+
+declare function webSearch(args?: {
+    filters?: {
+        allowedDomains?: string[];
+    };
     searchContextSize?: 'low' | 'medium' | 'high';
     userLocation?: {
-        type?: 'approximate';
+        type: 'approximate';
+        country?: string;
         city?: string;
         region?: string;
-        country?: string;
         timezone?: string;
     };
 }): {
-    type: 'provider-defined';
-    id: 'openai.web_search_preview';
-    args: {};
-    parameters: typeof WebSearchPreviewParameters;
-};
-declare const CodeInterpreterParameters: z.ZodObject<{
-    container: z.ZodUnion<[z.ZodString, z.ZodObject<{
-        containerId: z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodNull]>, string | undefined, string | null>;
-        type: z.ZodEnum<["auto", "file", "code_interpreter"]>;
-        files: z.ZodArray<z.ZodString, "many">;
-    }, "strip", z.ZodTypeAny, {
-        type: "file" | "auto" | "code_interpreter";
-        files: string[];
-        containerId?: string | undefined;
-    }, {
-        type: "file" | "auto" | "code_interpreter";
-        files: string[];
-        containerId: string | null;
-    }>]>;
-}, "strip", z.ZodTypeAny, {
-    container: string | {
-        type: "file" | "auto" | "code_interpreter";
-        files: string[];
-        containerId?: string | undefined;
-    };
-}, {
-    container: string | {
-        type: "file" | "auto" | "code_interpreter";
-        files: string[];
-        containerId: string | null;
+    type: "provider-defined";
+    id: "openai.web_search";
+    name: "web_search";
+    args: {
+        filters?: {
+            allowedDomains?: string[];
+        };
+        searchContextSize?: "low" | "medium" | "high";
+        userLocation?: {
+            type: "approximate";
+            country?: string;
+            city?: string;
+            region?: string;
+            timezone?: string;
+        };
     };
-}>;
-declare function codeInterpreterTool({ container, }: {
-    container: string | {
-        containerId?: string;
-        type: 'auto' | 'code_interpreter';
-        files: string[];
+};
+
+declare function webSearchPreview(args?: {
+    searchContextSize?: 'low' | 'medium' | 'high';
+    userLocation?: {
+        type: 'approximate';
+        country?: string;
+        city?: string;
+        region?: string;
+        timezone?: string;
     };
 }): {
-    type: 'provider-defined';
-    id: 'openai.code_interpreter';
+    type: "provider-defined";
+    id: "openai.web_search_preview";
+    name: "web_search_preview";
     args: {
-        container: string | {
-            containerId?: string;
-            type: 'auto' | 'code_interpreter';
-            files: string[];
+        searchContextSize?: "low" | "medium" | "high";
+        userLocation?: {
+            type: "approximate";
+            country?: string;
+            city?: string;
+            region?: string;
+            timezone?: string;
         };
     };
-    parameters: typeof CodeInterpreterParameters;
 };
-declare const filtersSchema: z.ZodUnion<[z.ZodObject<{
-    key: z.ZodString;
-    type: z.ZodEnum<["eq", "ne", "gt", "gte", "lt", "lte"]>;
-    value: z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodBoolean]>;
-}, "strip", z.ZodTypeAny, {
-    value: string | number | boolean;
-    type: "gte" | "gt" | "lte" | "lt" | "ne" | "eq";
-    key: string;
-}, {
-    value: string | number | boolean;
-    type: "gte" | "gt" | "lte" | "lt" | "ne" | "eq";
-    key: string;
-}>, z.ZodType<any, z.ZodTypeDef, any>]>;
-declare const fileSearchArgsSchema: z.ZodObject<{
+
+declare const openaiTools: {
     /**
-     * List of vector store IDs to search through. If not provided, searches all available vector stores.
+     * The Code Interpreter tool allows models to write and run Python code in a
+     * sandboxed environment to solve complex problems in domains like data analysis,
+     * coding, and math.
+     *
+     * @param container - The container to use for the code interpreter.
+     *
+     * Must have name `code_interpreter`.
      */
-    vectorStoreIds: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
-    /**
-     * Maximum number of search results to return. Defaults to 10.
+    codeInterpreter: typeof codeInterpreter;
+    /**
+     * File search is a tool available in the Responses API. It enables models to
+     * retrieve information in a knowledge base of previously uploaded files through
+     * semantic and keyword search.
+     *
+     * Must have name `file_search`.
+     *
+     * @param vectorStoreIds - The vector store IDs to use for the file search.
+     * @param maxNumResults - The maximum number of results to return.
+     * @param ranking - The ranking options to use for the file search.
+     * @param filters - The filters to use for the file search.
      */
-    maxNumResults: z.ZodOptional<z.ZodNumber>;
-    /**
-     * Ranking options for the search.
+    fileSearch: typeof fileSearch;
+    /**
+     * Web search allows models to access up-to-date information from the internet
+     * and provide answers with sourced citations.
+     *
+     * Must have name `web_search_preview`.
+     *
+     * @param searchContextSize - The search context size to use for the web search.
+     * @param userLocation - The user location to use for the web search.
+     *
+     * @deprecated Use `webSearch` instead.
      */
-    ranking: z.ZodOptional<z.ZodObject<{
-        ranker: z.ZodOptional<z.ZodEnum<["auto", "default-2024-08-21"]>>;
-    }, "strip", z.ZodTypeAny, {
-        ranker?: "auto" | "default-2024-08-21" | undefined;
-    }, {
-        ranker?: "auto" | "default-2024-08-21" | undefined;
-    }>>;
-    /**
-     * A filter to apply based on file attributes.
+    webSearchPreview: typeof webSearchPreview;
+    /**
+     * Web search allows models to access up-to-date information from the internet
+     * and provide answers with sourced citations.
+     *
+     * Must have name `web_search`.
+     *
+     * @param filters - The filters to use for the web search.
+     * @param searchContextSize - The search context size to use for the web search.
+     * @param userLocation - The user location to use for the web search.
      */
-    filters: z.ZodOptional<z.ZodUnion<[z.ZodObject<{
-        key: z.ZodString;
-        type: z.ZodEnum<["eq", "ne", "gt", "gte", "lt", "lte"]>;
-        value: z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodBoolean]>;
-    }, "strip", z.ZodTypeAny, {
-        value: string | number | boolean;
-        type: "gte" | "gt" | "lte" | "lt" | "ne" | "eq";
-        key: string;
-    }, {
-        value: string | number | boolean;
-        type: "gte" | "gt" | "lte" | "lt" | "ne" | "eq";
-        key: string;
-    }>, z.ZodType<any, z.ZodTypeDef, any>]>>;
-}, "strip", z.ZodTypeAny, {
-    vectorStoreIds?: string[] | undefined;
-    maxNumResults?: number | undefined;
-    ranking?: {
-        ranker?: "auto" | "default-2024-08-21" | undefined;
-    } | undefined;
-    filters?: any;
-}, {
-    vectorStoreIds?: string[] | undefined;
-    maxNumResults?: number | undefined;
-    ranking?: {
-        ranker?: "auto" | "default-2024-08-21" | undefined;
-    } | undefined;
-    filters?: any;
-}>;
-declare function fileSearchTool({ vectorStoreIds, maxNumResults, ranking, filters, }?: {
-    vectorStoreIds?: string[];
-    maxNumResults?: number;
-    ranking?: {
-        ranker?: 'auto' | 'default-2024-08-21';
-    };
-    filters?: typeof filtersSchema;
-}): {
-    type: 'provider-defined';
-    id: 'openai.file_search';
-    args: z.infer<typeof fileSearchArgsSchema>;
-    parameters: {};
-};
-declare const openaiTools: {
-    webSearchPreview: typeof webSearchPreviewTool;
-    codeInterpreter: typeof codeInterpreterTool;
-    fileSearch: typeof fileSearchTool;
+    webSearch: typeof webSearch;
 };
 
 type OpenAISpeechModelId = 'tts-1' | 'tts-1-hd' | 'gpt-4o-mini-tts' | (string & {});

package/dist/index.d.ts

@@ -183,147 +183,159 @@ type OpenAITranscriptionModelId = 'whisper-1' | 'gpt-4o-mini-transcribe' | 'gpt-
 
 type OpenAIResponsesModelId = 'o1' | 'o1-2024-12-17' | 'o1-mini' | 'o1-mini-2024-09-12' | 'o1-preview' | 'o1-preview-2024-09-12' | 'o3-mini' | 'o3-mini-2025-01-31' | 'o3' | 'o3-2025-04-16' | 'o4-mini' | 'o4-mini-2025-04-16' | 'gpt-4.1' | 'gpt-4.1-2025-04-14' | 'gpt-4.1-mini' | 'gpt-4.1-mini-2025-04-14' | 'gpt-4.1-nano' | 'gpt-4.1-nano-2025-04-14' | 'gpt-4o' | 'gpt-4o-2024-05-13' | 'gpt-4o-2024-08-06' | 'gpt-4o-2024-11-20' | 'gpt-4o-audio-preview' | 'gpt-4o-audio-preview-2024-10-01' | 'gpt-4o-audio-preview-2024-12-17' | 'gpt-4o-search-preview' | 'gpt-4o-search-preview-2025-03-11' | 'gpt-4o-mini-search-preview' | 'gpt-4o-mini-search-preview-2025-03-11' | 'gpt-4o-mini' | 'gpt-4o-mini-2024-07-18' | 'gpt-4-turbo' | 'gpt-4-turbo-2024-04-09' | 'gpt-4-turbo-preview' | 'gpt-4-0125-preview' | 'gpt-4-1106-preview' | 'gpt-4' | 'gpt-4-0613' | 'gpt-4.5-preview' | 'gpt-4.5-preview-2025-02-27' | 'gpt-3.5-turbo-0125' | 'gpt-3.5-turbo' | 'gpt-3.5-turbo-1106' | 'chatgpt-4o-latest' | (string & {});
 
-declare const WebSearchPreviewParameters: z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>;
-declare function webSearchPreviewTool({ searchContextSize, userLocation, }?: {
+declare function codeInterpreter(args?: {
+    container?: string | {
+        fileIds?: string[];
+    };
+}): {
+    type: "provider-defined";
+    id: "openai.code_interpreter";
+    name: "code_interpreter";
+    args: {
+        container?: string | {
+            fileIds?: string[];
+        };
+    };
+};
+
+declare function fileSearch(args?: {
+    vectorStoreIds?: string[];
+    maxNumResults?: number;
+    ranking?: {
+        ranker?: 'auto' | 'default-2024-08-21';
+    };
+    filters?: {
+        key: string;
+        type: 'eq' | 'ne' | 'gt' | 'gte' | 'lt' | 'lte';
+        value: string | number | boolean;
+    } | {
+        type: 'and' | 'or';
+        filters: any[];
+    };
+}): {
+    type: "provider-defined";
+    id: "openai.file_search";
+    name: "file_search";
+    args: {
+        vectorStoreIds?: string[];
+        maxNumResults?: number;
+        ranking?: {
+            ranker?: "auto" | "default-2024-08-21";
+        };
+        filters?: {
+            key: string;
+            type: "eq" | "ne" | "gt" | "gte" | "lt" | "lte";
+            value: string | number | boolean;
+        } | {
+            type: "and" | "or";
+            filters: any[];
+        };
+    };
+};
+
+declare function webSearch(args?: {
+    filters?: {
+        allowedDomains?: string[];
+    };
     searchContextSize?: 'low' | 'medium' | 'high';
     userLocation?: {
-        type?: 'approximate';
+        type: 'approximate';
+        country?: string;
         city?: string;
         region?: string;
-        country?: string;
         timezone?: string;
     };
 }): {
-    type: 'provider-defined';
-    id: 'openai.web_search_preview';
-    args: {};
-    parameters: typeof WebSearchPreviewParameters;
-};
-declare const CodeInterpreterParameters: z.ZodObject<{
-    container: z.ZodUnion<[z.ZodString, z.ZodObject<{
-        containerId: z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodNull]>, string | undefined, string | null>;
-        type: z.ZodEnum<["auto", "file", "code_interpreter"]>;
-        files: z.ZodArray<z.ZodString, "many">;
-    }, "strip", z.ZodTypeAny, {
-        type: "file" | "auto" | "code_interpreter";
-        files: string[];
-        containerId?: string | undefined;
-    }, {
-        type: "file" | "auto" | "code_interpreter";
-        files: string[];
-        containerId: string | null;
-    }>]>;
-}, "strip", z.ZodTypeAny, {
-    container: string | {
-        type: "file" | "auto" | "code_interpreter";
-        files: string[];
-        containerId?: string | undefined;
-    };
-}, {
-    container: string | {
-        type: "file" | "auto" | "code_interpreter";
-        files: string[];
-        containerId: string | null;
+    type: "provider-defined";
+    id: "openai.web_search";
+    name: "web_search";
+    args: {
+        filters?: {
+            allowedDomains?: string[];
+        };
+        searchContextSize?: "low" | "medium" | "high";
+        userLocation?: {
+            type: "approximate";
+            country?: string;
+            city?: string;
+            region?: string;
+            timezone?: string;
+        };
     };
-}>;
-declare function codeInterpreterTool({ container, }: {
-    container: string | {
-        containerId?: string;
-        type: 'auto' | 'code_interpreter';
-        files: string[];
+};
+
+declare function webSearchPreview(args?: {
+    searchContextSize?: 'low' | 'medium' | 'high';
+    userLocation?: {
+        type: 'approximate';
+        country?: string;
+        city?: string;
+        region?: string;
+        timezone?: string;
     };
 }): {
-    type: 'provider-defined';
-    id: 'openai.code_interpreter';
+    type: "provider-defined";
+    id: "openai.web_search_preview";
+    name: "web_search_preview";
     args: {
-        container: string | {
-            containerId?: string;
-            type: 'auto' | 'code_interpreter';
-            files: string[];
+        searchContextSize?: "low" | "medium" | "high";
+        userLocation?: {
+            type: "approximate";
+            country?: string;
+            city?: string;
+            region?: string;
+            timezone?: string;
         };
     };
-    parameters: typeof CodeInterpreterParameters;
 };
-declare const filtersSchema: z.ZodUnion<[z.ZodObject<{
-    key: z.ZodString;
-    type: z.ZodEnum<["eq", "ne", "gt", "gte", "lt", "lte"]>;
-    value: z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodBoolean]>;
-}, "strip", z.ZodTypeAny, {
-    value: string | number | boolean;
-    type: "gte" | "gt" | "lte" | "lt" | "ne" | "eq";
-    key: string;
-}, {
-    value: string | number | boolean;
-    type: "gte" | "gt" | "lte" | "lt" | "ne" | "eq";
-    key: string;
-}>, z.ZodType<any, z.ZodTypeDef, any>]>;
-declare const fileSearchArgsSchema: z.ZodObject<{
+
+declare const openaiTools: {
     /**
-     * List of vector store IDs to search through. If not provided, searches all available vector stores.
+     * The Code Interpreter tool allows models to write and run Python code in a
+     * sandboxed environment to solve complex problems in domains like data analysis,
+     * coding, and math.
+     *
+     * @param container - The container to use for the code interpreter.
+     *
+     * Must have name `code_interpreter`.
      */
-    vectorStoreIds: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
-    /**
-     * Maximum number of search results to return. Defaults to 10.
+    codeInterpreter: typeof codeInterpreter;
+    /**
+     * File search is a tool available in the Responses API. It enables models to
+     * retrieve information in a knowledge base of previously uploaded files through
+     * semantic and keyword search.
+     *
+     * Must have name `file_search`.
+     *
+     * @param vectorStoreIds - The vector store IDs to use for the file search.
+     * @param maxNumResults - The maximum number of results to return.
+     * @param ranking - The ranking options to use for the file search.
+     * @param filters - The filters to use for the file search.
      */
-    maxNumResults: z.ZodOptional<z.ZodNumber>;
-    /**
-     * Ranking options for the search.
+    fileSearch: typeof fileSearch;
+    /**
+     * Web search allows models to access up-to-date information from the internet
+     * and provide answers with sourced citations.
+     *
+     * Must have name `web_search_preview`.
+     *
+     * @param searchContextSize - The search context size to use for the web search.
+     * @param userLocation - The user location to use for the web search.
+     *
+     * @deprecated Use `webSearch` instead.
      */
-    ranking: z.ZodOptional<z.ZodObject<{
-        ranker: z.ZodOptional<z.ZodEnum<["auto", "default-2024-08-21"]>>;
-    }, "strip", z.ZodTypeAny, {
-        ranker?: "auto" | "default-2024-08-21" | undefined;
-    }, {
-        ranker?: "auto" | "default-2024-08-21" | undefined;
-    }>>;
-    /**
-     * A filter to apply based on file attributes.
+    webSearchPreview: typeof webSearchPreview;
+    /**
+     * Web search allows models to access up-to-date information from the internet
+     * and provide answers with sourced citations.
+     *
+     * Must have name `web_search`.
+     *
+     * @param filters - The filters to use for the web search.
+     * @param searchContextSize - The search context size to use for the web search.
+     * @param userLocation - The user location to use for the web search.
      */
-    filters: z.ZodOptional<z.ZodUnion<[z.ZodObject<{
-        key: z.ZodString;
-        type: z.ZodEnum<["eq", "ne", "gt", "gte", "lt", "lte"]>;
-        value: z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodBoolean]>;
-    }, "strip", z.ZodTypeAny, {
-        value: string | number | boolean;
-        type: "gte" | "gt" | "lte" | "lt" | "ne" | "eq";
-        key: string;
-    }, {
-        value: string | number | boolean;
-        type: "gte" | "gt" | "lte" | "lt" | "ne" | "eq";
-        key: string;
-    }>, z.ZodType<any, z.ZodTypeDef, any>]>>;
-}, "strip", z.ZodTypeAny, {
-    vectorStoreIds?: string[] | undefined;
-    maxNumResults?: number | undefined;
-    ranking?: {
-        ranker?: "auto" | "default-2024-08-21" | undefined;
-    } | undefined;
-    filters?: any;
-}, {
-    vectorStoreIds?: string[] | undefined;
-    maxNumResults?: number | undefined;
-    ranking?: {
-        ranker?: "auto" | "default-2024-08-21" | undefined;
-    } | undefined;
-    filters?: any;
-}>;
-declare function fileSearchTool({ vectorStoreIds, maxNumResults, ranking, filters, }?: {
-    vectorStoreIds?: string[];
-    maxNumResults?: number;
-    ranking?: {
-        ranker?: 'auto' | 'default-2024-08-21';
-    };
-    filters?: typeof filtersSchema;
-}): {
-    type: 'provider-defined';
-    id: 'openai.file_search';
-    args: z.infer<typeof fileSearchArgsSchema>;
-    parameters: {};
-};
-declare const openaiTools: {
-    webSearchPreview: typeof webSearchPreviewTool;
-    codeInterpreter: typeof codeInterpreterTool;
-    fileSearch: typeof fileSearchTool;
+    webSearch: typeof webSearch;
 };
 
 type OpenAISpeechModelId = 'tts-1' | 'tts-1-hd' | 'gpt-4o-mini-tts' | (string & {});