exa-js 1.8.2 → 1.8.6

package/dist/index.d.mts

@@ -1980,6 +1980,7 @@ type ContentsOptions = {
     highlights?: HighlightsContentsOptions | true;
     summary?: SummaryContentsOptions | true;
     livecrawl?: LivecrawlOptions;
+    context?: ContextOptions | true;
     livecrawlTimeout?: number;
     filterEmptyResults?: boolean;
     subpages?: number;
@@ -1990,7 +1991,7 @@ type ContentsOptions = {
  * Options for livecrawling contents
  * @typedef {string} LivecrawlOptions
  */
-type LivecrawlOptions = "never" | "fallback" | "always" | "auto";
+type LivecrawlOptions = "never" | "fallback" | "always" | "auto" | "preferred";
 /**
  * Options for retrieving text from page.
  * @typedef {Object} TextContentsOptions
@@ -2013,6 +2014,16 @@ type HighlightsContentsOptions = {
     numSentences?: number;
     highlightsPerUrl?: number;
 };
+/**
+ * Options for retrieving summary from page.
+ * @typedef {Object} SummaryContentsOptions
+ * @property {string} [query] - The query string to use for summary generation.
+ * @property {JSONSchema} [schema] - JSON schema for structured output from summary.
+ */
+type SummaryContentsOptions = {
+    query?: string;
+    schema?: JSONSchema;
+};
 /**
  * Represents a JSON Schema definition used for structured summary output.
  * To learn more visit https://json-schema.org/overview/what-is-jsonschema.
@@ -2035,14 +2046,13 @@ type JSONSchema = {
     not?: JSONSchema;
 };
 /**
- * Options for retrieving summary from page.
- * @typedef {Object} SummaryContentsOptions
- * @property {string} [query] - The query string to use for summary generation.
- * @property {JSONSchema} [schema] - JSON schema for structured output from summary.
+ * Options for retrieving the context from a list of search results. The context is a string
+ * representation of all the search results.
+ * @typedef {Object} ContextOptions
+ * @property {number} [maxCharacters] - The maximum number of characters.
  */
-type SummaryContentsOptions = {
-    query?: string;
-    schema?: JSONSchema;
+type ContextOptions = {
+    maxCharacters?: number;
 };
 /**
  * @typedef {Object} TextResponse
@@ -2155,6 +2165,7 @@ type SearchResult<T extends ContentsOptions> = {
  * Represents a search response object.
  * @typedef {Object} SearchResponse
  * @property {Result[]} results - The list of search results.
+ * @property {string} [context] - The context for the search.
  * @property {string} [autopromptString] - The autoprompt string, if applicable.
  * @property {string} [autoDate] - The autoprompt date, if applicable.
  * @property {string} requestId - The request ID for the search.
@@ -2162,6 +2173,7 @@ type SearchResult<T extends ContentsOptions> = {
  */
 type SearchResponse<T extends ContentsOptions> = {
     results: SearchResult<T>[];
+    context?: string;
     autopromptString?: string;
     autoDate?: string;
     requestId: string;
@@ -2347,4 +2359,4 @@ declare class Exa {
     private parseSSEStream;
 }
 
-export { type AnswerOptions, type AnswerResponse, type AnswerStreamChunk, type AnswerStreamResponse, type BaseSearchOptions, type ContentsOptions, type ContentsResultComponent, type CostDollars, type CostDollarsContents, type CostDollarsSeearch, type CreateCriterionParameters, type CreateEnrichmentParameters, CreateEnrichmentParametersFormat, type CreateMonitorParameters, type CreateWebhookParameters, type CreateWebsetParameters, type CreateWebsetSearchParameters, type Default, type EnrichmentResult, type Event, EventType, EventsClient, Exa, ExaError, type ExtrasOptions, type ExtrasResponse, type FindSimilarOptions, type GetWebsetResponse, type HighlightsContentsOptions, type HighlightsResponse, HttpStatusCode, type JSONSchema, type ListEventsResponse, type ListMonitorRunsResponse, type ListMonitorsOptions, type ListMonitorsResponse, type ListResearchTasksOptions, type SchemaListResearchTasksResponseDto as ListResearchTasksResponse, type ListWebhookAttemptsResponse, type ListWebhooksResponse, type ListWebsetItemResponse, type ListWebsetsResponse, type LivecrawlOptions, type Monitor, type MonitorBehaviorRefresh, type MonitorBehaviorSearch, type MonitorCadence, MonitorObject, type MonitorRefreshBehaviorContentsConfig, type MonitorRefreshBehaviorEnrichmentsConfig, type MonitorRun, MonitorRunObject, MonitorRunStatus, MonitorRunType, MonitorStatus, type RegularSearchOptions, ResearchClient, ResearchCreateTaskRequestDtoModel as ResearchModel, ResearchTaskDtoStatus as ResearchStatus, type SchemaResearchTaskDto as ResearchTask, type SearchResponse, type SearchResult, type SubpagesResponse, type SummaryContentsOptions, type SummaryResponse, type TextContentsOptions, type TextResponse, type UpdateMonitor, UpdateMonitorStatus, type UpdateWebhookParameters, type UpdateWebsetRequest, type Webhook, type WebhookAttempt, WebhookStatus, type Webset, type WebsetArticleEntity, type WebsetCompanyEntity, type WebsetCustomEntity, type WebsetEnrichment, WebsetEnrichmentFormat, WebsetEnrichmentStatus, WebsetEnrichmentsClient, type WebsetEntity, type WebsetItem, type WebsetItemArticleProperties, type WebsetItemCompanyProperties, type WebsetItemCustomProperties, type WebsetItemEvaluation, WebsetItemEvaluationSatisfied, type WebsetItemPersonProperties, type WebsetItemResearchPaperProperties, WebsetItemSource, WebsetItemsClient, WebsetMonitorsClient, type WebsetPersonEntity, type WebsetResearchPaperEntity, type WebsetSearch, WebsetSearchBehavior, WebsetSearchCanceledReason, WebsetSearchStatus, WebsetSearchesClient, WebsetStatus, WebsetWebhooksClient, WebsetsClient, Exa as default };
+export { type AnswerOptions, type AnswerResponse, type AnswerStreamChunk, type AnswerStreamResponse, type BaseSearchOptions, type ContentsOptions, type ContentsResultComponent, type ContextOptions, type CostDollars, type CostDollarsContents, type CostDollarsSeearch, type CreateCriterionParameters, type CreateEnrichmentParameters, CreateEnrichmentParametersFormat, type CreateMonitorParameters, type CreateWebhookParameters, type CreateWebsetParameters, type CreateWebsetSearchParameters, type Default, type EnrichmentResult, type Event, EventType, EventsClient, Exa, ExaError, type ExtrasOptions, type ExtrasResponse, type FindSimilarOptions, type GetWebsetResponse, type HighlightsContentsOptions, type HighlightsResponse, HttpStatusCode, type JSONSchema, type ListEventsResponse, type ListMonitorRunsResponse, type ListMonitorsOptions, type ListMonitorsResponse, type ListResearchTasksOptions, type SchemaListResearchTasksResponseDto as ListResearchTasksResponse, type ListWebhookAttemptsResponse, type ListWebhooksResponse, type ListWebsetItemResponse, type ListWebsetsResponse, type LivecrawlOptions, type Monitor, type MonitorBehaviorRefresh, type MonitorBehaviorSearch, type MonitorCadence, MonitorObject, type MonitorRefreshBehaviorContentsConfig, type MonitorRefreshBehaviorEnrichmentsConfig, type MonitorRun, MonitorRunObject, MonitorRunStatus, MonitorRunType, MonitorStatus, type RegularSearchOptions, ResearchClient, ResearchCreateTaskRequestDtoModel as ResearchModel, ResearchTaskDtoStatus as ResearchStatus, type SchemaResearchTaskDto as ResearchTask, type SearchResponse, type SearchResult, type SubpagesResponse, type SummaryContentsOptions, type SummaryResponse, type TextContentsOptions, type TextResponse, type UpdateMonitor, UpdateMonitorStatus, type UpdateWebhookParameters, type UpdateWebsetRequest, type Webhook, type WebhookAttempt, WebhookStatus, type Webset, type WebsetArticleEntity, type WebsetCompanyEntity, type WebsetCustomEntity, type WebsetEnrichment, WebsetEnrichmentFormat, WebsetEnrichmentStatus, WebsetEnrichmentsClient, type WebsetEntity, type WebsetItem, type WebsetItemArticleProperties, type WebsetItemCompanyProperties, type WebsetItemCustomProperties, type WebsetItemEvaluation, WebsetItemEvaluationSatisfied, type WebsetItemPersonProperties, type WebsetItemResearchPaperProperties, WebsetItemSource, WebsetItemsClient, WebsetMonitorsClient, type WebsetPersonEntity, type WebsetResearchPaperEntity, type WebsetSearch, WebsetSearchBehavior, WebsetSearchCanceledReason, WebsetSearchStatus, WebsetSearchesClient, WebsetStatus, WebsetWebhooksClient, WebsetsClient, Exa as default };

package/dist/index.d.ts

@@ -1980,6 +1980,7 @@ type ContentsOptions = {
     highlights?: HighlightsContentsOptions | true;
     summary?: SummaryContentsOptions | true;
     livecrawl?: LivecrawlOptions;
+    context?: ContextOptions | true;
     livecrawlTimeout?: number;
     filterEmptyResults?: boolean;
     subpages?: number;
@@ -1990,7 +1991,7 @@ type ContentsOptions = {
  * Options for livecrawling contents
  * @typedef {string} LivecrawlOptions
  */
-type LivecrawlOptions = "never" | "fallback" | "always" | "auto";
+type LivecrawlOptions = "never" | "fallback" | "always" | "auto" | "preferred";
 /**
  * Options for retrieving text from page.
  * @typedef {Object} TextContentsOptions
@@ -2013,6 +2014,16 @@ type HighlightsContentsOptions = {
     numSentences?: number;
     highlightsPerUrl?: number;
 };
+/**
+ * Options for retrieving summary from page.
+ * @typedef {Object} SummaryContentsOptions
+ * @property {string} [query] - The query string to use for summary generation.
+ * @property {JSONSchema} [schema] - JSON schema for structured output from summary.
+ */
+type SummaryContentsOptions = {
+    query?: string;
+    schema?: JSONSchema;
+};
 /**
  * Represents a JSON Schema definition used for structured summary output.
  * To learn more visit https://json-schema.org/overview/what-is-jsonschema.
@@ -2035,14 +2046,13 @@ type JSONSchema = {
     not?: JSONSchema;
 };
 /**
- * Options for retrieving summary from page.
- * @typedef {Object} SummaryContentsOptions
- * @property {string} [query] - The query string to use for summary generation.
- * @property {JSONSchema} [schema] - JSON schema for structured output from summary.
+ * Options for retrieving the context from a list of search results. The context is a string
+ * representation of all the search results.
+ * @typedef {Object} ContextOptions
+ * @property {number} [maxCharacters] - The maximum number of characters.
  */
-type SummaryContentsOptions = {
-    query?: string;
-    schema?: JSONSchema;
+type ContextOptions = {
+    maxCharacters?: number;
 };
 /**
  * @typedef {Object} TextResponse
@@ -2155,6 +2165,7 @@ type SearchResult<T extends ContentsOptions> = {
  * Represents a search response object.
  * @typedef {Object} SearchResponse
  * @property {Result[]} results - The list of search results.
+ * @property {string} [context] - The context for the search.
  * @property {string} [autopromptString] - The autoprompt string, if applicable.
  * @property {string} [autoDate] - The autoprompt date, if applicable.
  * @property {string} requestId - The request ID for the search.
@@ -2162,6 +2173,7 @@ type SearchResult<T extends ContentsOptions> = {
  */
 type SearchResponse<T extends ContentsOptions> = {
     results: SearchResult<T>[];
+    context?: string;
     autopromptString?: string;
     autoDate?: string;
     requestId: string;
@@ -2347,4 +2359,4 @@ declare class Exa {
     private parseSSEStream;
 }
 
-export { type AnswerOptions, type AnswerResponse, type AnswerStreamChunk, type AnswerStreamResponse, type BaseSearchOptions, type ContentsOptions, type ContentsResultComponent, type CostDollars, type CostDollarsContents, type CostDollarsSeearch, type CreateCriterionParameters, type CreateEnrichmentParameters, CreateEnrichmentParametersFormat, type CreateMonitorParameters, type CreateWebhookParameters, type CreateWebsetParameters, type CreateWebsetSearchParameters, type Default, type EnrichmentResult, type Event, EventType, EventsClient, Exa, ExaError, type ExtrasOptions, type ExtrasResponse, type FindSimilarOptions, type GetWebsetResponse, type HighlightsContentsOptions, type HighlightsResponse, HttpStatusCode, type JSONSchema, type ListEventsResponse, type ListMonitorRunsResponse, type ListMonitorsOptions, type ListMonitorsResponse, type ListResearchTasksOptions, type SchemaListResearchTasksResponseDto as ListResearchTasksResponse, type ListWebhookAttemptsResponse, type ListWebhooksResponse, type ListWebsetItemResponse, type ListWebsetsResponse, type LivecrawlOptions, type Monitor, type MonitorBehaviorRefresh, type MonitorBehaviorSearch, type MonitorCadence, MonitorObject, type MonitorRefreshBehaviorContentsConfig, type MonitorRefreshBehaviorEnrichmentsConfig, type MonitorRun, MonitorRunObject, MonitorRunStatus, MonitorRunType, MonitorStatus, type RegularSearchOptions, ResearchClient, ResearchCreateTaskRequestDtoModel as ResearchModel, ResearchTaskDtoStatus as ResearchStatus, type SchemaResearchTaskDto as ResearchTask, type SearchResponse, type SearchResult, type SubpagesResponse, type SummaryContentsOptions, type SummaryResponse, type TextContentsOptions, type TextResponse, type UpdateMonitor, UpdateMonitorStatus, type UpdateWebhookParameters, type UpdateWebsetRequest, type Webhook, type WebhookAttempt, WebhookStatus, type Webset, type WebsetArticleEntity, type WebsetCompanyEntity, type WebsetCustomEntity, type WebsetEnrichment, WebsetEnrichmentFormat, WebsetEnrichmentStatus, WebsetEnrichmentsClient, type WebsetEntity, type WebsetItem, type WebsetItemArticleProperties, type WebsetItemCompanyProperties, type WebsetItemCustomProperties, type WebsetItemEvaluation, WebsetItemEvaluationSatisfied, type WebsetItemPersonProperties, type WebsetItemResearchPaperProperties, WebsetItemSource, WebsetItemsClient, WebsetMonitorsClient, type WebsetPersonEntity, type WebsetResearchPaperEntity, type WebsetSearch, WebsetSearchBehavior, WebsetSearchCanceledReason, WebsetSearchStatus, WebsetSearchesClient, WebsetStatus, WebsetWebhooksClient, WebsetsClient, Exa as default };
+export { type AnswerOptions, type AnswerResponse, type AnswerStreamChunk, type AnswerStreamResponse, type BaseSearchOptions, type ContentsOptions, type ContentsResultComponent, type ContextOptions, type CostDollars, type CostDollarsContents, type CostDollarsSeearch, type CreateCriterionParameters, type CreateEnrichmentParameters, CreateEnrichmentParametersFormat, type CreateMonitorParameters, type CreateWebhookParameters, type CreateWebsetParameters, type CreateWebsetSearchParameters, type Default, type EnrichmentResult, type Event, EventType, EventsClient, Exa, ExaError, type ExtrasOptions, type ExtrasResponse, type FindSimilarOptions, type GetWebsetResponse, type HighlightsContentsOptions, type HighlightsResponse, HttpStatusCode, type JSONSchema, type ListEventsResponse, type ListMonitorRunsResponse, type ListMonitorsOptions, type ListMonitorsResponse, type ListResearchTasksOptions, type SchemaListResearchTasksResponseDto as ListResearchTasksResponse, type ListWebhookAttemptsResponse, type ListWebhooksResponse, type ListWebsetItemResponse, type ListWebsetsResponse, type LivecrawlOptions, type Monitor, type MonitorBehaviorRefresh, type MonitorBehaviorSearch, type MonitorCadence, MonitorObject, type MonitorRefreshBehaviorContentsConfig, type MonitorRefreshBehaviorEnrichmentsConfig, type MonitorRun, MonitorRunObject, MonitorRunStatus, MonitorRunType, MonitorStatus, type RegularSearchOptions, ResearchClient, ResearchCreateTaskRequestDtoModel as ResearchModel, ResearchTaskDtoStatus as ResearchStatus, type SchemaResearchTaskDto as ResearchTask, type SearchResponse, type SearchResult, type SubpagesResponse, type SummaryContentsOptions, type SummaryResponse, type TextContentsOptions, type TextResponse, type UpdateMonitor, UpdateMonitorStatus, type UpdateWebhookParameters, type UpdateWebsetRequest, type Webhook, type WebhookAttempt, WebhookStatus, type Webset, type WebsetArticleEntity, type WebsetCompanyEntity, type WebsetCustomEntity, type WebsetEnrichment, WebsetEnrichmentFormat, WebsetEnrichmentStatus, WebsetEnrichmentsClient, type WebsetEntity, type WebsetItem, type WebsetItemArticleProperties, type WebsetItemCompanyProperties, type WebsetItemCustomProperties, type WebsetItemEvaluation, WebsetItemEvaluationSatisfied, type WebsetItemPersonProperties, type WebsetItemResearchPaperProperties, WebsetItemSource, WebsetItemsClient, WebsetMonitorsClient, type WebsetPersonEntity, type WebsetResearchPaperEntity, type WebsetSearch, WebsetSearchBehavior, WebsetSearchCanceledReason, WebsetSearchStatus, WebsetSearchesClient, WebsetStatus, WebsetWebhooksClient, WebsetsClient, Exa as default };

package/dist/index.js

@@ -977,6 +977,7 @@ var Exa2 = class {
       extras,
       livecrawl,
       livecrawlTimeout,
+      context,
       ...rest
     } = options;
     const contentsOptions = {};
@@ -993,6 +994,7 @@ var Exa2 = class {
     if (livecrawl !== void 0) contentsOptions.livecrawl = livecrawl;
     if (livecrawlTimeout !== void 0)
       contentsOptions.livecrawlTimeout = livecrawlTimeout;
+    if (context !== void 0) contentsOptions.context = context;
     return {
       contentsOptions,
       restOptions: rest