exa-js 2.0.5 → 2.0.7

package/dist/index.d.mts

@@ -1551,6 +1551,11 @@ interface components {
         };
         PreviewWebsetParameters: {
             search: {
+                /**
+                 * @description When query parameter search=true, the number of preview items to return.
+                 * @default 10
+                 */
+                count: number;
                 /** @description Entity used to inform the decomposition.
                  *
                  *     It is not required to provide it, we automatically detect the entity from all the information provided in the query. Only use this when you need more fine control. */
@@ -3015,7 +3020,7 @@ type ContentsOptions = {
  * Options for performing a search query
  * @typedef {Object} SearchOptions
  * @property {ContentsOptions | boolean} [contents] - Options for retrieving page contents for each result returned. Default is { text: { maxCharacters: 10_000 } }.
- * @property {number} [numResults] - Number of search results to return. Default 10. Max 10 for basic plans.
+ * @property {number} [numResults] - Number of search results to return. Default 10. Max 10 for basic plans. For deep search, recommend leaving blank - number of results will be determined dynamically for your query.
  * @property {string[]} [includeDomains] - List of domains to include in the search.
  * @property {string[]} [excludeDomains] - List of domains to exclude in the search.
  * @property {string} [startCrawlDate] - Start date for results based on crawl date.
@@ -3044,17 +3049,49 @@ type BaseSearchOptions = {
     userLocation?: string;
 };
 /**
- * Search options for performing a search query.
- * @typedef {Object} RegularSearchOptions
+ * Base search options shared across all search types
  */
-type RegularSearchOptions = BaseSearchOptions & {
+type BaseRegularSearchOptions = BaseSearchOptions & {
     /**
      * If true, the search results are moderated for safety.
      */
     moderation?: boolean;
     useAutoprompt?: boolean;
-    type?: "keyword" | "neural" | "auto" | "hybrid" | "fast" | "deep";
 };
+/**
+ * Contents options for deep search - context is always returned and cannot be disabled
+ */
+type DeepContentsOptions = Omit<ContentsOptions, "context"> & {
+    context?: Omit<ContextOptions, never> | true;
+};
+/**
+ * Search options for deep search type, which supports additional queries.
+ * Note: context is always returned by the API for deep search and cannot be set to false.
+ */
+type DeepSearchOptions = Omit<BaseRegularSearchOptions, "contents"> & {
+    type: "deep";
+    /**
+     * Alternative query formulations for deep search to skip automatic LLM-based query expansion.
+     * Max 5 queries.
+     * @example ["machine learning", "ML algorithms", "neural networks"]
+     */
+    additionalQueries?: string[];
+    /**
+     * Options for retrieving page contents. For deep search, context is always returned.
+     */
+    contents?: DeepContentsOptions;
+};
+/**
+ * Search options for non-deep search types (keyword, neural, auto, hybrid, fast)
+ */
+type NonDeepSearchOptions = BaseRegularSearchOptions & {
+    type?: "keyword" | "neural" | "auto" | "hybrid" | "fast";
+};
+/**
+ * Search options for performing a search query.
+ * Uses a discriminated union to ensure additionalQueries is only allowed when type is "deep".
+ */
+type RegularSearchOptions = DeepSearchOptions | NonDeepSearchOptions;
 /**
  * Options for finding similar links.
  * @typedef {Object} FindSimilarOptions
@@ -3371,10 +3408,10 @@ declare class Exa {
      * When no contents option is specified, returns text contents by default.
      *
      * @param {string} query - The query string.
-     * @param {Omit<RegularSearchOptions, 'contents'>} options - Search options without contents
+     * @param {Omit<DeepSearchOptions, 'contents'> | Omit<NonDeepSearchOptions, 'contents'>} options - Search options without contents
      * @returns {Promise<SearchResponse<{ text: true }>>} A list of relevant search results with text contents.
      */
-    search(query: string, options: Omit<RegularSearchOptions, "contents">): Promise<SearchResponse<{
+    search(query: string, options: Omit<DeepSearchOptions, "contents"> | Omit<NonDeepSearchOptions, "contents">): Promise<SearchResponse<{
         text: true;
     }>>;
     /**

package/dist/index.d.ts

@@ -1551,6 +1551,11 @@ interface components {
         };
         PreviewWebsetParameters: {
             search: {
+                /**
+                 * @description When query parameter search=true, the number of preview items to return.
+                 * @default 10
+                 */
+                count: number;
                 /** @description Entity used to inform the decomposition.
                  *
                  *     It is not required to provide it, we automatically detect the entity from all the information provided in the query. Only use this when you need more fine control. */
@@ -3015,7 +3020,7 @@ type ContentsOptions = {
  * Options for performing a search query
  * @typedef {Object} SearchOptions
  * @property {ContentsOptions | boolean} [contents] - Options for retrieving page contents for each result returned. Default is { text: { maxCharacters: 10_000 } }.
- * @property {number} [numResults] - Number of search results to return. Default 10. Max 10 for basic plans.
+ * @property {number} [numResults] - Number of search results to return. Default 10. Max 10 for basic plans. For deep search, recommend leaving blank - number of results will be determined dynamically for your query.
  * @property {string[]} [includeDomains] - List of domains to include in the search.
  * @property {string[]} [excludeDomains] - List of domains to exclude in the search.
  * @property {string} [startCrawlDate] - Start date for results based on crawl date.
@@ -3044,17 +3049,49 @@ type BaseSearchOptions = {
     userLocation?: string;
 };
 /**
- * Search options for performing a search query.
- * @typedef {Object} RegularSearchOptions
+ * Base search options shared across all search types
  */
-type RegularSearchOptions = BaseSearchOptions & {
+type BaseRegularSearchOptions = BaseSearchOptions & {
     /**
      * If true, the search results are moderated for safety.
      */
     moderation?: boolean;
     useAutoprompt?: boolean;
-    type?: "keyword" | "neural" | "auto" | "hybrid" | "fast" | "deep";
 };
+/**
+ * Contents options for deep search - context is always returned and cannot be disabled
+ */
+type DeepContentsOptions = Omit<ContentsOptions, "context"> & {
+    context?: Omit<ContextOptions, never> | true;
+};
+/**
+ * Search options for deep search type, which supports additional queries.
+ * Note: context is always returned by the API for deep search and cannot be set to false.
+ */
+type DeepSearchOptions = Omit<BaseRegularSearchOptions, "contents"> & {
+    type: "deep";
+    /**
+     * Alternative query formulations for deep search to skip automatic LLM-based query expansion.
+     * Max 5 queries.
+     * @example ["machine learning", "ML algorithms", "neural networks"]
+     */
+    additionalQueries?: string[];
+    /**
+     * Options for retrieving page contents. For deep search, context is always returned.
+     */
+    contents?: DeepContentsOptions;
+};
+/**
+ * Search options for non-deep search types (keyword, neural, auto, hybrid, fast)
+ */
+type NonDeepSearchOptions = BaseRegularSearchOptions & {
+    type?: "keyword" | "neural" | "auto" | "hybrid" | "fast";
+};
+/**
+ * Search options for performing a search query.
+ * Uses a discriminated union to ensure additionalQueries is only allowed when type is "deep".
+ */
+type RegularSearchOptions = DeepSearchOptions | NonDeepSearchOptions;
 /**
  * Options for finding similar links.
  * @typedef {Object} FindSimilarOptions
@@ -3371,10 +3408,10 @@ declare class Exa {
      * When no contents option is specified, returns text contents by default.
      *
      * @param {string} query - The query string.
-     * @param {Omit<RegularSearchOptions, 'contents'>} options - Search options without contents
+     * @param {Omit<DeepSearchOptions, 'contents'> | Omit<NonDeepSearchOptions, 'contents'>} options - Search options without contents
      * @returns {Promise<SearchResponse<{ text: true }>>} A list of relevant search results with text contents.
      */
-    search(query: string, options: Omit<RegularSearchOptions, "contents">): Promise<SearchResponse<{
+    search(query: string, options: Omit<DeepSearchOptions, "contents"> | Omit<NonDeepSearchOptions, "contents">): Promise<SearchResponse<{
         text: true;
     }>>;
     /**

package/dist/index.js

@@ -74,7 +74,7 @@ var import_cross_fetch = __toESM(require("cross-fetch"));
 // package.json
 var package_default = {
   name: "exa-js",
-  version: "2.0.5",
+  version: "2.0.7",
   description: "Exa SDK for Node.js and the browser",
   publishConfig: {
     access: "public"