exa-js 1.10.2 → 1.10.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -49,6 +49,7 @@ const searchAndCustomContentsResults = await exa.searchAndContents(
49
49
  "This is a Exa query:",
50
50
  {
51
51
  text: { maxCharacters: 3000 },
52
+ highlights: { maxCharacters: 4000 },
52
53
  }
53
54
  );
54
55
 
package/dist/index.d.mts CHANGED
@@ -3024,7 +3024,7 @@ type ExtrasOptions = {
3024
3024
  * Search options for performing a search query.
3025
3025
  * @typedef {Object} ContentsOptions
3026
3026
  * @property {TextContentsOptions | boolean} [text] - Options for retrieving text contents.
3027
- * @property {HighlightsContentsOptions | boolean} [highlights] - Options for retrieving highlights. NOTE: For search type "deep", only "true" is allowed. "query", "numSentences" and "highlightsPerUrl" will not be respected;
3027
+ * @property {HighlightsContentsOptions | boolean} [highlights] - Options for retrieving highlights. NOTE: For search type "deep", only "true" is allowed. "query", "maxCharacters", "numSentences" and "highlightsPerUrl" will not be respected;
3028
3028
  * @property {SummaryContentsOptions | boolean} [summary] - Options for retrieving summary.
3029
3029
  * @property {LivecrawlOptions} [livecrawl] - Options for livecrawling contents. Default is "never" for neural/auto search, "fallback" for keyword search.
3030
3030
  * @property {number} [livecrawlTimeout] - The timeout for livecrawling. Max and default is 10000ms.
@@ -3066,12 +3066,16 @@ type TextContentsOptions = {
3066
3066
  * to your initial query, and may vary in quantity and length.
3067
3067
  * @typedef {Object} HighlightsContentsOptions
3068
3068
  * @property {string} [query] - The query string to use for highlights search.
3069
- * @property {number} [numSentences] - The number of sentences to return for each highlight.
3070
- * @property {number} [highlightsPerUrl] - The number of highlights to return for each URL.
3069
+ * @property {number} [maxCharacters] - The maximum number of characters to return for highlights.
3070
+ * @property {number} [numSentences] - Deprecated. Use maxCharacters instead.
3071
+ * @property {number} [highlightsPerUrl] - Deprecated. Use maxCharacters instead.
3071
3072
  */
3072
3073
  type HighlightsContentsOptions = {
3073
3074
  query?: string;
3075
+ maxCharacters?: number;
3076
+ /** @deprecated Use maxCharacters instead */
3074
3077
  numSentences?: number;
3078
+ /** @deprecated Use maxCharacters instead */
3075
3079
  highlightsPerUrl?: number;
3076
3080
  };
3077
3081
  /**
package/dist/index.d.ts CHANGED
@@ -3024,7 +3024,7 @@ type ExtrasOptions = {
3024
3024
  * Search options for performing a search query.
3025
3025
  * @typedef {Object} ContentsOptions
3026
3026
  * @property {TextContentsOptions | boolean} [text] - Options for retrieving text contents.
3027
- * @property {HighlightsContentsOptions | boolean} [highlights] - Options for retrieving highlights. NOTE: For search type "deep", only "true" is allowed. "query", "numSentences" and "highlightsPerUrl" will not be respected;
3027
+ * @property {HighlightsContentsOptions | boolean} [highlights] - Options for retrieving highlights. NOTE: For search type "deep", only "true" is allowed. "query", "maxCharacters", "numSentences" and "highlightsPerUrl" will not be respected;
3028
3028
  * @property {SummaryContentsOptions | boolean} [summary] - Options for retrieving summary.
3029
3029
  * @property {LivecrawlOptions} [livecrawl] - Options for livecrawling contents. Default is "never" for neural/auto search, "fallback" for keyword search.
3030
3030
  * @property {number} [livecrawlTimeout] - The timeout for livecrawling. Max and default is 10000ms.
@@ -3066,12 +3066,16 @@ type TextContentsOptions = {
3066
3066
  * to your initial query, and may vary in quantity and length.
3067
3067
  * @typedef {Object} HighlightsContentsOptions
3068
3068
  * @property {string} [query] - The query string to use for highlights search.
3069
- * @property {number} [numSentences] - The number of sentences to return for each highlight.
3070
- * @property {number} [highlightsPerUrl] - The number of highlights to return for each URL.
3069
+ * @property {number} [maxCharacters] - The maximum number of characters to return for highlights.
3070
+ * @property {number} [numSentences] - Deprecated. Use maxCharacters instead.
3071
+ * @property {number} [highlightsPerUrl] - Deprecated. Use maxCharacters instead.
3071
3072
  */
3072
3073
  type HighlightsContentsOptions = {
3073
3074
  query?: string;
3075
+ maxCharacters?: number;
3076
+ /** @deprecated Use maxCharacters instead */
3074
3077
  numSentences?: number;
3078
+ /** @deprecated Use maxCharacters instead */
3075
3079
  highlightsPerUrl?: number;
3076
3080
  };
3077
3081
  /**
package/dist/index.js CHANGED
@@ -74,7 +74,7 @@ var import_cross_fetch = __toESM(require("cross-fetch"));
74
74
  // package.json
75
75
  var package_default = {
76
76
  name: "exa-js",
77
- version: "1.10.2",
77
+ version: "1.10.3",
78
78
  description: "Exa SDK for Node.js and the browser",
79
79
  publishConfig: {
80
80
  access: "public"