exa-js 2.7.0 → 2.8.0
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 +3 -1
- package/dist/index.d.mts +8 -1
- package/dist/index.d.ts +8 -1
- package/dist/index.js +1 -1
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +1 -1
- package/dist/index.mjs.map +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -62,6 +62,7 @@ const result = await exa.search("interesting articles about space", {
|
|
|
62
62
|
```ts
|
|
63
63
|
const deepResult = await exa.search("Who leads OpenAI's safety team?", {
|
|
64
64
|
type: "deep",
|
|
65
|
+
systemPrompt: "Prefer official sources and avoid duplicate results",
|
|
65
66
|
outputSchema: {
|
|
66
67
|
type: "object",
|
|
67
68
|
properties: {
|
|
@@ -80,6 +81,8 @@ Deep `outputSchema` modes:
|
|
|
80
81
|
- `type: "text"`: return plain text in `output.content` (optionally guided by `description`)
|
|
81
82
|
- `type: "object"`: return structured JSON in `output.content`
|
|
82
83
|
|
|
84
|
+
Deep search also supports `systemPrompt` to guide both the search process and the final returned result, for example by preferring certain sources, emphasizing novel findings, avoiding duplicates, or constraining output style.
|
|
85
|
+
|
|
83
86
|
For `type: "object"`, deep search currently enforces:
|
|
84
87
|
- max nesting depth: `2`
|
|
85
88
|
- max total properties: `10`
|
|
@@ -87,7 +90,6 @@ For `type: "object"`, deep search currently enforces:
|
|
|
87
90
|
Deep search variants:
|
|
88
91
|
- `deep`: light mode
|
|
89
92
|
- `deep-reasoning`: base reasoning mode
|
|
90
|
-
- `deep-max`: max-effort mode
|
|
91
93
|
|
|
92
94
|
## Contents
|
|
93
95
|
|
package/dist/index.d.mts
CHANGED
|
@@ -1742,6 +1742,8 @@ interface components {
|
|
|
1742
1742
|
* @description The date and time the webset was created
|
|
1743
1743
|
*/
|
|
1744
1744
|
createdAt: string;
|
|
1745
|
+
/** @description The URL to view the webset in the Exa dashboard */
|
|
1746
|
+
dashboardUrl: string;
|
|
1745
1747
|
/** @description The Enrichments to apply to the Webset Items. */
|
|
1746
1748
|
enrichments: components["schemas"]["WebsetEnrichment"][];
|
|
1747
1749
|
/** @description The Excludes sources (existing imports or websets) that apply to all operations within this Webset. Any results found within these sources will be omitted across all search and import operations. */
|
|
@@ -3094,7 +3096,7 @@ type BaseRegularSearchOptions = BaseSearchOptions & {
|
|
|
3094
3096
|
moderation?: boolean;
|
|
3095
3097
|
useAutoprompt?: boolean;
|
|
3096
3098
|
};
|
|
3097
|
-
type DeepSearchType = "deep" | "deep-reasoning"
|
|
3099
|
+
type DeepSearchType = "deep" | "deep-reasoning";
|
|
3098
3100
|
/**
|
|
3099
3101
|
* Deep search output schema mode for plain text responses.
|
|
3100
3102
|
*/
|
|
@@ -3146,6 +3148,11 @@ type DeepSearchOptions = Omit<BaseRegularSearchOptions, "contents"> & {
|
|
|
3146
3148
|
* @example ["machine learning", "ML algorithms", "neural networks"]
|
|
3147
3149
|
*/
|
|
3148
3150
|
additionalQueries?: string[];
|
|
3151
|
+
/**
|
|
3152
|
+
* Additional instructions that guide both deep-search planning and the final returned synthesis.
|
|
3153
|
+
* Use this to prefer certain sources, emphasize novelty, avoid duplicates, or constrain output style.
|
|
3154
|
+
*/
|
|
3155
|
+
systemPrompt?: string;
|
|
3149
3156
|
/**
|
|
3150
3157
|
* Output schema for deep search responses.
|
|
3151
3158
|
* - `type: "text"` for plain text output (optionally guided by `description`)
|
package/dist/index.d.ts
CHANGED
|
@@ -1742,6 +1742,8 @@ interface components {
|
|
|
1742
1742
|
* @description The date and time the webset was created
|
|
1743
1743
|
*/
|
|
1744
1744
|
createdAt: string;
|
|
1745
|
+
/** @description The URL to view the webset in the Exa dashboard */
|
|
1746
|
+
dashboardUrl: string;
|
|
1745
1747
|
/** @description The Enrichments to apply to the Webset Items. */
|
|
1746
1748
|
enrichments: components["schemas"]["WebsetEnrichment"][];
|
|
1747
1749
|
/** @description The Excludes sources (existing imports or websets) that apply to all operations within this Webset. Any results found within these sources will be omitted across all search and import operations. */
|
|
@@ -3094,7 +3096,7 @@ type BaseRegularSearchOptions = BaseSearchOptions & {
|
|
|
3094
3096
|
moderation?: boolean;
|
|
3095
3097
|
useAutoprompt?: boolean;
|
|
3096
3098
|
};
|
|
3097
|
-
type DeepSearchType = "deep" | "deep-reasoning"
|
|
3099
|
+
type DeepSearchType = "deep" | "deep-reasoning";
|
|
3098
3100
|
/**
|
|
3099
3101
|
* Deep search output schema mode for plain text responses.
|
|
3100
3102
|
*/
|
|
@@ -3146,6 +3148,11 @@ type DeepSearchOptions = Omit<BaseRegularSearchOptions, "contents"> & {
|
|
|
3146
3148
|
* @example ["machine learning", "ML algorithms", "neural networks"]
|
|
3147
3149
|
*/
|
|
3148
3150
|
additionalQueries?: string[];
|
|
3151
|
+
/**
|
|
3152
|
+
* Additional instructions that guide both deep-search planning and the final returned synthesis.
|
|
3153
|
+
* Use this to prefer certain sources, emphasize novelty, avoid duplicates, or constrain output style.
|
|
3154
|
+
*/
|
|
3155
|
+
systemPrompt?: string;
|
|
3149
3156
|
/**
|
|
3150
3157
|
* Output schema for deep search responses.
|
|
3151
3158
|
* - `type: "text"` for plain text output (optionally guided by `description`)
|
package/dist/index.js
CHANGED