@ai-sdk/openai 2.0.26 → 2.0.27

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @ai-sdk/openai
 
+## 2.0.27
+
+### Patch Changes
+
+- 2338c79: feat (provider/openai): add jsdoc for openai tools
+
 ## 2.0.26
 
 ### Patch Changes

package/dist/index.d.mts

@@ -58,11 +58,56 @@ declare const factory: _ai_sdk_provider_utils.ProviderDefinedToolFactory<{}, {
 }>;
 
 declare const openaiTools: {
+    /**
+     * 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`.
+     */
     codeInterpreter: _ai_sdk_provider_utils.ProviderDefinedToolFactory<{}, {
         container?: string | {
-            fileIds?: string[];
+            fileIds
+            /**
+             * 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.
+             */
+            ? /**
+             * 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.
+             */: string[];
         };
     }>;
+    /**
+     * 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.
+     */
     fileSearch: _ai_sdk_provider_utils.ProviderDefinedToolFactory<{
         query: string;
     }, {
@@ -80,6 +125,17 @@ declare const openaiTools: {
             filters: any[];
         };
     }>;
+    /**
+     * 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.
+     */
     webSearchPreview: _ai_sdk_provider_utils.ProviderDefinedToolFactory<{}, {
         searchContextSize?: "low" | "medium" | "high";
         userLocation?: {
@@ -90,6 +146,16 @@ declare const openaiTools: {
             timezone?: string;
         };
     }>;
+    /**
+     * 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.
+     */
     webSearch: (args?: Parameters<typeof factory>[0]) => _ai_sdk_provider_utils.Tool<{}, unknown>;
 };
 

package/dist/index.d.ts

@@ -58,11 +58,56 @@ declare const factory: _ai_sdk_provider_utils.ProviderDefinedToolFactory<{}, {
 }>;
 
 declare const openaiTools: {
+    /**
+     * 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`.
+     */
     codeInterpreter: _ai_sdk_provider_utils.ProviderDefinedToolFactory<{}, {
         container?: string | {
-            fileIds?: string[];
+            fileIds
+            /**
+             * 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.
+             */
+            ? /**
+             * 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.
+             */: string[];
         };
     }>;
+    /**
+     * 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.
+     */
     fileSearch: _ai_sdk_provider_utils.ProviderDefinedToolFactory<{
         query: string;
     }, {
@@ -80,6 +125,17 @@ declare const openaiTools: {
             filters: any[];
         };
     }>;
+    /**
+     * 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.
+     */
     webSearchPreview: _ai_sdk_provider_utils.ProviderDefinedToolFactory<{}, {
         searchContextSize?: "low" | "medium" | "high";
         userLocation?: {
@@ -90,6 +146,16 @@ declare const openaiTools: {
             timezone?: string;
         };
     }>;
+    /**
+     * 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.
+     */
     webSearch: (args?: Parameters<typeof factory>[0]) => _ai_sdk_provider_utils.Tool<{}, unknown>;
 };
 

package/dist/index.js

@@ -369,23 +369,11 @@ var compoundFilterSchema = import_v43.z.object({
 });
 var filtersSchema = import_v43.z.union([comparisonFilterSchema, compoundFilterSchema]);
 var fileSearchArgsSchema = import_v43.z.object({
-  /**
-   * List of vector store IDs to search through. If not provided, searches all available vector stores.
-   */
   vectorStoreIds: import_v43.z.array(import_v43.z.string()).optional(),
-  /**
-   * Maximum number of search results to return. Defaults to 10.
-   */
   maxNumResults: import_v43.z.number().optional(),
-  /**
-   * Ranking options for the search.
-   */
   ranking: import_v43.z.object({
     ranker: import_v43.z.enum(["auto", "default-2024-08-21"]).optional()
   }).optional(),
-  /**
-   * A filter to apply based on file attributes.
-   */
   filters: filtersSchema.optional()
 });
 var fileSearch = (0, import_provider_utils3.createProviderDefinedToolFactory)({
@@ -1868,9 +1856,51 @@ var webSearch = (args = {}) => {
 
 // src/openai-tools.ts
 var openaiTools = {
+  /**
+   * 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`.
+   */
   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.
+   */
   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.
+   */
   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.
+   */
   webSearch
 };