@ai-sdk/openai 2.0.26 → 2.0.27

package/dist/index.mjs

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