exa-js 1.8.20 → 1.8.22

package/dist/index.d.mts

@@ -292,6 +292,18 @@ interface components$1 {
                 /** @description Whether to provide an estimate of how many total relevant results could exist for this search.
                  *     Result of the analysis will be available in the `recall` field within the search request. */
                 recall?: boolean;
+                /** @description Limit the search to specific sources (existing imports or websets). Any results found within these sources matching the search criteria will be included in the Webset. */
+                scope?: {
+                    /** @description The ID of the source to search. */
+                    id: string;
+                    relationship?: {
+                        /** @description What the relationship of the entities you hope to find is relative to the entities contained in the provided source. */
+                        definition: string;
+                        limit: number;
+                    };
+                    /** @enum {string} */
+                    source: CreateWebsetSearchParametersScopeSource;
+                }[];
             };
         };
         CreateWebsetSearchParameters: {
@@ -335,6 +347,18 @@ interface components$1 {
             /** @description Whether to provide an estimate of how many total relevant results could exist for this search.
              *     Result of the analysis will be available in the `recall` field within the search request. */
             recall?: boolean;
+            /** @description Limit the search to specific sources (existing imports). Any results found within these sources matching the search criteria will be included in the Webset. */
+            scope?: {
+                /** @description The ID of the source to search. */
+                id: string;
+                relationship?: {
+                    /** @description What the relationship of the entities you hope to find is relative to the entities contained in the provided source. */
+                    definition: string;
+                    limit: number;
+                };
+                /** @enum {string} */
+                source: CreateWebsetSearchParametersScopeSource;
+            }[];
         };
         /** Custom */
         CustomEntity: {
@@ -868,6 +892,41 @@ interface components$1 {
              */
             type: "person";
         };
+        PreviewWebsetParameters: {
+            /** @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. */
+            entity?: components$1["schemas"]["Entity"];
+            /** @description Natural language search query describing what you are looking for.
+             *
+             *     Be specific and descriptive about your requirements, characteristics, and any constraints that help narrow down the results. */
+            query: string;
+        };
+        PreviewWebsetResponse: {
+            /** @description Detected enrichments from the query. */
+            enrichments: {
+                /** @description Description of the enrichment. */
+                description: string;
+                /**
+                 * @description Format of the enrichment.
+                 * @enum {string}
+                 */
+                format: PreviewWebsetResponseEnrichmentsFormat;
+                /** @description When format is options, the options detected from the query. */
+                options?: {
+                    /** @description Label of the option. */
+                    label: string;
+                }[];
+            }[];
+            search: {
+                /** @description Detected criteria from the query. */
+                criteria: {
+                    description: string;
+                }[];
+                /** @description Detected entity from the query. */
+                entity: components$1["schemas"]["CompanyEntity"] | components$1["schemas"]["PersonEntity"] | components$1["schemas"]["ArticleEntity"] | components$1["schemas"]["ResearchPaperEntity"] | components$1["schemas"]["CustomEntity"];
+            };
+        };
         /** Research Paper */
         ResearchPaperEntity: {
             /**
@@ -1384,6 +1443,17 @@ interface components$1 {
                 /** @description The reasoning for the estimate */
                 reasoning: string;
             } | null;
+            /** @description The scope of the search. By default, there is no scope - thus searching the web.
+             *
+             *     If provided during creation, the search will only be performed on the sources provided. */
+            scope: {
+                id: string;
+                /**
+                 * @default import
+                 * @enum {string}
+                 */
+                source: ScopeSourceType;
+            }[];
             /**
              * WebsetSearchStatus
              * @description The status of the search
@@ -1436,6 +1506,8 @@ type MonitorBehavior = components$1["schemas"]["MonitorBehavior"];
 type MonitorCadence = components$1["schemas"]["MonitorCadence"];
 type MonitorRun = components$1["schemas"]["MonitorRun"];
 type PersonEntity = components$1["schemas"]["PersonEntity"];
+type PreviewWebsetParameters = components$1["schemas"]["PreviewWebsetParameters"];
+type PreviewWebsetResponse = components$1["schemas"]["PreviewWebsetResponse"];
 type ResearchPaperEntity = components$1["schemas"]["ResearchPaperEntity"];
 type UpdateImport = components$1["schemas"]["UpdateImport"];
 type UpdateMonitor = components$1["schemas"]["UpdateMonitor"];
@@ -1490,10 +1562,18 @@ declare enum CreateWebsetParametersSearchExcludeSource {
     import = "import",
     webset = "webset"
 }
+declare enum ScopeSourceType {
+    import = "import",
+    webset = "webset"
+}
 declare enum CreateWebsetSearchParametersExcludeSource {
     import = "import",
     webset = "webset"
 }
+declare enum CreateWebsetSearchParametersScopeSource {
+    import = "import",
+    webset = "webset"
+}
 declare enum EnrichmentResultStatus {
     pending = "pending",
     completed = "completed",
@@ -1555,6 +1635,14 @@ declare enum MonitorRunType {
     search = "search",
     refresh = "refresh"
 }
+declare enum PreviewWebsetResponseEnrichmentsFormat {
+    text = "text",
+    date = "date",
+    number = "number",
+    options = "options",
+    email = "email",
+    phone = "phone"
+}
 declare enum UpdateMonitorStatus {
     enabled = "enabled",
     disabled = "disabled"
@@ -1582,6 +1670,7 @@ declare enum WebhookAttemptEventType {
 }
 declare enum WebsetStatus {
     idle = "idle",
+    pending = "pending",
     running = "running",
     paused = "paused"
 }
@@ -1618,6 +1707,7 @@ declare enum WebsetSearchRecallExpectedConfidence {
 }
 declare enum WebsetSearchStatus {
     created = "created",
+    pending = "pending",
     running = "running",
     completed = "completed",
     canceled = "canceled"
@@ -2106,6 +2196,12 @@ declare class WebsetsClient extends WebsetsBaseClient {
      * @returns The created Webset
      */
     create(params: CreateWebsetParameters): Promise<Webset>;
+    /**
+     * Preview a webset
+     * @param params The preview parameters
+     * @returns The preview response showing how the query will be decomposed
+     */
+    preview(params: PreviewWebsetParameters): Promise<PreviewWebsetResponse>;
     /**
      * Get a Webset by ID
      * @param id The ID of the Webset
@@ -3140,4 +3236,4 @@ declare class Exa {
     private parseSSEStream;
 }
 
-export { type AnswerOptions, type AnswerOptionsTyped, type AnswerResponse, type AnswerResponseTyped, type AnswerStreamChunk, type AnswerStreamResponse, type ArticleEntity, type BaseSearchOptions, type CompanyEntity, type ContentsOptions, type ContentsResultComponent, type ContextOptions, type CostDollars, type CostDollarsContents, type CostDollarsSeearch, type CreateCriterionParameters, type CreateEnrichmentParameters, CreateEnrichmentParametersFormat, type CreateImportParameters, CreateImportParametersFormat, type CreateImportResponse, type CreateImportWithCsvParameters, type CreateMonitorParameters, type CreateWebhookParameters, type CreateWebsetParameters, CreateWebsetParametersImportSource, CreateWebsetParametersSearchExcludeSource, type CreateWebsetSearchParameters, CreateWebsetSearchParametersExcludeSource, type CsvDataInput, type CustomEntity, type Default, type EnrichmentResult, type Entity, type Event, EventType, EventsClient, Exa, ExaError, type ExtrasOptions, type ExtrasResponse, type FindSimilarOptions, type GetWebsetResponse, type HighlightsContentsOptions, type HighlightsResponse, HttpStatusCode, type Import, ImportFailedReason, ImportFormat, ImportObject, ImportStatus, ImportsClient, type JSONSchema, type ListEventsResponse, type ListImportsResponse, type ListMonitorRunsResponse, type ListMonitorsOptions, type ListMonitorsResponse, type SchemaListResearchTasksRequestDto as ListResearchTasksRequest, type SchemaListResearchTasksResponseDto as ListResearchTasksResponse, type ListWebhookAttemptsResponse, type ListWebhooksResponse, type ListWebsetItemResponse, type ListWebsetItemsOptions, type ListWebsetsResponse, type LivecrawlOptions, type Monitor, type MonitorBehavior, type MonitorCadence, MonitorObject, type MonitorRun, MonitorRunObject, MonitorRunStatus, MonitorRunType, MonitorStatus, type PersonEntity, type RegularSearchOptions, ResearchClient, type ResearchCreateTaskParamsTyped, type SchemaResearchCreateTaskRequestDto as ResearchCreateTaskRequest, type SchemaResearchCreateTaskResponseDto as ResearchCreateTaskResponse, type ResearchPaperEntity, type SchemaResearchTaskDto as ResearchTask, type ResearchTaskEvent, type ResearchTaskOperation, type ResearchTaskOutputTyped, type SearchResponse, type SearchResult, type Status, type SubpagesResponse, type SummaryContentsOptions, type SummaryContentsOptionsTyped, type SummaryResponse, type TextContentsOptions, type TextResponse, type UpdateImport, type UpdateMonitor, UpdateMonitorStatus, type UpdateWebhookParameters, type UpdateWebsetRequest, type WaitUntilCompletedOptions, type Webhook, type WebhookAttempt, WebhookStatus, type Webset, type WebsetEnrichment, WebsetEnrichmentFormat, WebsetEnrichmentStatus, WebsetEnrichmentsClient, type WebsetItem, type WebsetItemArticleProperties, type WebsetItemCompanyProperties, type WebsetItemCustomProperties, type WebsetItemEvaluation, WebsetItemEvaluationSatisfied, type WebsetItemPersonProperties, type WebsetItemResearchPaperProperties, WebsetItemSource, WebsetItemsClient, WebsetMonitorsClient, type WebsetSearch, WebsetSearchBehavior, WebsetSearchCanceledReason, WebsetSearchStatus, WebsetSearchesClient, WebsetStatus, WebsetWebhooksClient, WebsetsClient, Exa as default };
+export { type AnswerOptions, type AnswerOptionsTyped, type AnswerResponse, type AnswerResponseTyped, type AnswerStreamChunk, type AnswerStreamResponse, type ArticleEntity, type BaseSearchOptions, type CompanyEntity, type ContentsOptions, type ContentsResultComponent, type ContextOptions, type CostDollars, type CostDollarsContents, type CostDollarsSeearch, type CreateCriterionParameters, type CreateEnrichmentParameters, CreateEnrichmentParametersFormat, type CreateImportParameters, CreateImportParametersFormat, type CreateImportResponse, type CreateImportWithCsvParameters, type CreateMonitorParameters, type CreateWebhookParameters, type CreateWebsetParameters, CreateWebsetParametersImportSource, CreateWebsetParametersSearchExcludeSource, type CreateWebsetSearchParameters, CreateWebsetSearchParametersExcludeSource, CreateWebsetSearchParametersScopeSource, type CsvDataInput, type CustomEntity, type Default, type EnrichmentResult, type Entity, type Event, EventType, EventsClient, Exa, ExaError, type ExtrasOptions, type ExtrasResponse, type FindSimilarOptions, type GetWebsetResponse, type HighlightsContentsOptions, type HighlightsResponse, HttpStatusCode, type Import, ImportFailedReason, ImportFormat, ImportObject, ImportStatus, ImportsClient, type JSONSchema, type ListEventsResponse, type ListImportsResponse, type ListMonitorRunsResponse, type ListMonitorsOptions, type ListMonitorsResponse, type SchemaListResearchTasksRequestDto as ListResearchTasksRequest, type SchemaListResearchTasksResponseDto as ListResearchTasksResponse, type ListWebhookAttemptsResponse, type ListWebhooksResponse, type ListWebsetItemResponse, type ListWebsetItemsOptions, type ListWebsetsResponse, type LivecrawlOptions, type Monitor, type MonitorBehavior, type MonitorCadence, MonitorObject, type MonitorRun, MonitorRunObject, MonitorRunStatus, MonitorRunType, MonitorStatus, type PersonEntity, type PreviewWebsetParameters, type PreviewWebsetResponse, PreviewWebsetResponseEnrichmentsFormat, type RegularSearchOptions, ResearchClient, type ResearchCreateTaskParamsTyped, type SchemaResearchCreateTaskRequestDto as ResearchCreateTaskRequest, type SchemaResearchCreateTaskResponseDto as ResearchCreateTaskResponse, type ResearchPaperEntity, type SchemaResearchTaskDto as ResearchTask, type ResearchTaskEvent, type ResearchTaskOperation, type ResearchTaskOutputTyped, ScopeSourceType, type SearchResponse, type SearchResult, type Status, type SubpagesResponse, type SummaryContentsOptions, type SummaryContentsOptionsTyped, type SummaryResponse, type TextContentsOptions, type TextResponse, type UpdateImport, type UpdateMonitor, UpdateMonitorStatus, type UpdateWebhookParameters, type UpdateWebsetRequest, type WaitUntilCompletedOptions, type Webhook, type WebhookAttempt, WebhookStatus, type Webset, type WebsetEnrichment, WebsetEnrichmentFormat, WebsetEnrichmentStatus, WebsetEnrichmentsClient, type WebsetItem, type WebsetItemArticleProperties, type WebsetItemCompanyProperties, type WebsetItemCustomProperties, type WebsetItemEvaluation, WebsetItemEvaluationSatisfied, type WebsetItemPersonProperties, type WebsetItemResearchPaperProperties, WebsetItemSource, WebsetItemsClient, WebsetMonitorsClient, type WebsetSearch, WebsetSearchBehavior, WebsetSearchCanceledReason, WebsetSearchStatus, WebsetSearchesClient, WebsetStatus, WebsetWebhooksClient, WebsetsClient, Exa as default };

package/dist/index.d.ts

@@ -292,6 +292,18 @@ interface components$1 {
                 /** @description Whether to provide an estimate of how many total relevant results could exist for this search.
                  *     Result of the analysis will be available in the `recall` field within the search request. */
                 recall?: boolean;
+                /** @description Limit the search to specific sources (existing imports or websets). Any results found within these sources matching the search criteria will be included in the Webset. */
+                scope?: {
+                    /** @description The ID of the source to search. */
+                    id: string;
+                    relationship?: {
+                        /** @description What the relationship of the entities you hope to find is relative to the entities contained in the provided source. */
+                        definition: string;
+                        limit: number;
+                    };
+                    /** @enum {string} */
+                    source: CreateWebsetSearchParametersScopeSource;
+                }[];
             };
         };
         CreateWebsetSearchParameters: {
@@ -335,6 +347,18 @@ interface components$1 {
             /** @description Whether to provide an estimate of how many total relevant results could exist for this search.
              *     Result of the analysis will be available in the `recall` field within the search request. */
             recall?: boolean;
+            /** @description Limit the search to specific sources (existing imports). Any results found within these sources matching the search criteria will be included in the Webset. */
+            scope?: {
+                /** @description The ID of the source to search. */
+                id: string;
+                relationship?: {
+                    /** @description What the relationship of the entities you hope to find is relative to the entities contained in the provided source. */
+                    definition: string;
+                    limit: number;
+                };
+                /** @enum {string} */
+                source: CreateWebsetSearchParametersScopeSource;
+            }[];
         };
         /** Custom */
         CustomEntity: {
@@ -868,6 +892,41 @@ interface components$1 {
              */
             type: "person";
         };
+        PreviewWebsetParameters: {
+            /** @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. */
+            entity?: components$1["schemas"]["Entity"];
+            /** @description Natural language search query describing what you are looking for.
+             *
+             *     Be specific and descriptive about your requirements, characteristics, and any constraints that help narrow down the results. */
+            query: string;
+        };
+        PreviewWebsetResponse: {
+            /** @description Detected enrichments from the query. */
+            enrichments: {
+                /** @description Description of the enrichment. */
+                description: string;
+                /**
+                 * @description Format of the enrichment.
+                 * @enum {string}
+                 */
+                format: PreviewWebsetResponseEnrichmentsFormat;
+                /** @description When format is options, the options detected from the query. */
+                options?: {
+                    /** @description Label of the option. */
+                    label: string;
+                }[];
+            }[];
+            search: {
+                /** @description Detected criteria from the query. */
+                criteria: {
+                    description: string;
+                }[];
+                /** @description Detected entity from the query. */
+                entity: components$1["schemas"]["CompanyEntity"] | components$1["schemas"]["PersonEntity"] | components$1["schemas"]["ArticleEntity"] | components$1["schemas"]["ResearchPaperEntity"] | components$1["schemas"]["CustomEntity"];
+            };
+        };
         /** Research Paper */
         ResearchPaperEntity: {
             /**
@@ -1384,6 +1443,17 @@ interface components$1 {
                 /** @description The reasoning for the estimate */
                 reasoning: string;
             } | null;
+            /** @description The scope of the search. By default, there is no scope - thus searching the web.
+             *
+             *     If provided during creation, the search will only be performed on the sources provided. */
+            scope: {
+                id: string;
+                /**
+                 * @default import
+                 * @enum {string}
+                 */
+                source: ScopeSourceType;
+            }[];
             /**
              * WebsetSearchStatus
              * @description The status of the search
@@ -1436,6 +1506,8 @@ type MonitorBehavior = components$1["schemas"]["MonitorBehavior"];
 type MonitorCadence = components$1["schemas"]["MonitorCadence"];
 type MonitorRun = components$1["schemas"]["MonitorRun"];
 type PersonEntity = components$1["schemas"]["PersonEntity"];
+type PreviewWebsetParameters = components$1["schemas"]["PreviewWebsetParameters"];
+type PreviewWebsetResponse = components$1["schemas"]["PreviewWebsetResponse"];
 type ResearchPaperEntity = components$1["schemas"]["ResearchPaperEntity"];
 type UpdateImport = components$1["schemas"]["UpdateImport"];
 type UpdateMonitor = components$1["schemas"]["UpdateMonitor"];
@@ -1490,10 +1562,18 @@ declare enum CreateWebsetParametersSearchExcludeSource {
     import = "import",
     webset = "webset"
 }
+declare enum ScopeSourceType {
+    import = "import",
+    webset = "webset"
+}
 declare enum CreateWebsetSearchParametersExcludeSource {
     import = "import",
     webset = "webset"
 }
+declare enum CreateWebsetSearchParametersScopeSource {
+    import = "import",
+    webset = "webset"
+}
 declare enum EnrichmentResultStatus {
     pending = "pending",
     completed = "completed",
@@ -1555,6 +1635,14 @@ declare enum MonitorRunType {
     search = "search",
     refresh = "refresh"
 }
+declare enum PreviewWebsetResponseEnrichmentsFormat {
+    text = "text",
+    date = "date",
+    number = "number",
+    options = "options",
+    email = "email",
+    phone = "phone"
+}
 declare enum UpdateMonitorStatus {
     enabled = "enabled",
     disabled = "disabled"
@@ -1582,6 +1670,7 @@ declare enum WebhookAttemptEventType {
 }
 declare enum WebsetStatus {
     idle = "idle",
+    pending = "pending",
     running = "running",
     paused = "paused"
 }
@@ -1618,6 +1707,7 @@ declare enum WebsetSearchRecallExpectedConfidence {
 }
 declare enum WebsetSearchStatus {
     created = "created",
+    pending = "pending",
     running = "running",
     completed = "completed",
     canceled = "canceled"
@@ -2106,6 +2196,12 @@ declare class WebsetsClient extends WebsetsBaseClient {
      * @returns The created Webset
      */
     create(params: CreateWebsetParameters): Promise<Webset>;
+    /**
+     * Preview a webset
+     * @param params The preview parameters
+     * @returns The preview response showing how the query will be decomposed
+     */
+    preview(params: PreviewWebsetParameters): Promise<PreviewWebsetResponse>;
     /**
      * Get a Webset by ID
      * @param id The ID of the Webset
@@ -3140,4 +3236,4 @@ declare class Exa {
     private parseSSEStream;
 }
 
-export { type AnswerOptions, type AnswerOptionsTyped, type AnswerResponse, type AnswerResponseTyped, type AnswerStreamChunk, type AnswerStreamResponse, type ArticleEntity, type BaseSearchOptions, type CompanyEntity, type ContentsOptions, type ContentsResultComponent, type ContextOptions, type CostDollars, type CostDollarsContents, type CostDollarsSeearch, type CreateCriterionParameters, type CreateEnrichmentParameters, CreateEnrichmentParametersFormat, type CreateImportParameters, CreateImportParametersFormat, type CreateImportResponse, type CreateImportWithCsvParameters, type CreateMonitorParameters, type CreateWebhookParameters, type CreateWebsetParameters, CreateWebsetParametersImportSource, CreateWebsetParametersSearchExcludeSource, type CreateWebsetSearchParameters, CreateWebsetSearchParametersExcludeSource, type CsvDataInput, type CustomEntity, type Default, type EnrichmentResult, type Entity, type Event, EventType, EventsClient, Exa, ExaError, type ExtrasOptions, type ExtrasResponse, type FindSimilarOptions, type GetWebsetResponse, type HighlightsContentsOptions, type HighlightsResponse, HttpStatusCode, type Import, ImportFailedReason, ImportFormat, ImportObject, ImportStatus, ImportsClient, type JSONSchema, type ListEventsResponse, type ListImportsResponse, type ListMonitorRunsResponse, type ListMonitorsOptions, type ListMonitorsResponse, type SchemaListResearchTasksRequestDto as ListResearchTasksRequest, type SchemaListResearchTasksResponseDto as ListResearchTasksResponse, type ListWebhookAttemptsResponse, type ListWebhooksResponse, type ListWebsetItemResponse, type ListWebsetItemsOptions, type ListWebsetsResponse, type LivecrawlOptions, type Monitor, type MonitorBehavior, type MonitorCadence, MonitorObject, type MonitorRun, MonitorRunObject, MonitorRunStatus, MonitorRunType, MonitorStatus, type PersonEntity, type RegularSearchOptions, ResearchClient, type ResearchCreateTaskParamsTyped, type SchemaResearchCreateTaskRequestDto as ResearchCreateTaskRequest, type SchemaResearchCreateTaskResponseDto as ResearchCreateTaskResponse, type ResearchPaperEntity, type SchemaResearchTaskDto as ResearchTask, type ResearchTaskEvent, type ResearchTaskOperation, type ResearchTaskOutputTyped, type SearchResponse, type SearchResult, type Status, type SubpagesResponse, type SummaryContentsOptions, type SummaryContentsOptionsTyped, type SummaryResponse, type TextContentsOptions, type TextResponse, type UpdateImport, type UpdateMonitor, UpdateMonitorStatus, type UpdateWebhookParameters, type UpdateWebsetRequest, type WaitUntilCompletedOptions, type Webhook, type WebhookAttempt, WebhookStatus, type Webset, type WebsetEnrichment, WebsetEnrichmentFormat, WebsetEnrichmentStatus, WebsetEnrichmentsClient, type WebsetItem, type WebsetItemArticleProperties, type WebsetItemCompanyProperties, type WebsetItemCustomProperties, type WebsetItemEvaluation, WebsetItemEvaluationSatisfied, type WebsetItemPersonProperties, type WebsetItemResearchPaperProperties, WebsetItemSource, WebsetItemsClient, WebsetMonitorsClient, type WebsetSearch, WebsetSearchBehavior, WebsetSearchCanceledReason, WebsetSearchStatus, WebsetSearchesClient, WebsetStatus, WebsetWebhooksClient, WebsetsClient, Exa as default };
+export { type AnswerOptions, type AnswerOptionsTyped, type AnswerResponse, type AnswerResponseTyped, type AnswerStreamChunk, type AnswerStreamResponse, type ArticleEntity, type BaseSearchOptions, type CompanyEntity, type ContentsOptions, type ContentsResultComponent, type ContextOptions, type CostDollars, type CostDollarsContents, type CostDollarsSeearch, type CreateCriterionParameters, type CreateEnrichmentParameters, CreateEnrichmentParametersFormat, type CreateImportParameters, CreateImportParametersFormat, type CreateImportResponse, type CreateImportWithCsvParameters, type CreateMonitorParameters, type CreateWebhookParameters, type CreateWebsetParameters, CreateWebsetParametersImportSource, CreateWebsetParametersSearchExcludeSource, type CreateWebsetSearchParameters, CreateWebsetSearchParametersExcludeSource, CreateWebsetSearchParametersScopeSource, type CsvDataInput, type CustomEntity, type Default, type EnrichmentResult, type Entity, type Event, EventType, EventsClient, Exa, ExaError, type ExtrasOptions, type ExtrasResponse, type FindSimilarOptions, type GetWebsetResponse, type HighlightsContentsOptions, type HighlightsResponse, HttpStatusCode, type Import, ImportFailedReason, ImportFormat, ImportObject, ImportStatus, ImportsClient, type JSONSchema, type ListEventsResponse, type ListImportsResponse, type ListMonitorRunsResponse, type ListMonitorsOptions, type ListMonitorsResponse, type SchemaListResearchTasksRequestDto as ListResearchTasksRequest, type SchemaListResearchTasksResponseDto as ListResearchTasksResponse, type ListWebhookAttemptsResponse, type ListWebhooksResponse, type ListWebsetItemResponse, type ListWebsetItemsOptions, type ListWebsetsResponse, type LivecrawlOptions, type Monitor, type MonitorBehavior, type MonitorCadence, MonitorObject, type MonitorRun, MonitorRunObject, MonitorRunStatus, MonitorRunType, MonitorStatus, type PersonEntity, type PreviewWebsetParameters, type PreviewWebsetResponse, PreviewWebsetResponseEnrichmentsFormat, type RegularSearchOptions, ResearchClient, type ResearchCreateTaskParamsTyped, type SchemaResearchCreateTaskRequestDto as ResearchCreateTaskRequest, type SchemaResearchCreateTaskResponseDto as ResearchCreateTaskResponse, type ResearchPaperEntity, type SchemaResearchTaskDto as ResearchTask, type ResearchTaskEvent, type ResearchTaskOperation, type ResearchTaskOutputTyped, ScopeSourceType, type SearchResponse, type SearchResult, type Status, type SubpagesResponse, type SummaryContentsOptions, type SummaryContentsOptionsTyped, type SummaryResponse, type TextContentsOptions, type TextResponse, type UpdateImport, type UpdateMonitor, UpdateMonitorStatus, type UpdateWebhookParameters, type UpdateWebsetRequest, type WaitUntilCompletedOptions, type Webhook, type WebhookAttempt, WebhookStatus, type Webset, type WebsetEnrichment, WebsetEnrichmentFormat, WebsetEnrichmentStatus, WebsetEnrichmentsClient, type WebsetItem, type WebsetItemArticleProperties, type WebsetItemCompanyProperties, type WebsetItemCustomProperties, type WebsetItemEvaluation, WebsetItemEvaluationSatisfied, type WebsetItemPersonProperties, type WebsetItemResearchPaperProperties, WebsetItemSource, WebsetItemsClient, WebsetMonitorsClient, type WebsetSearch, WebsetSearchBehavior, WebsetSearchCanceledReason, WebsetSearchStatus, WebsetSearchesClient, WebsetStatus, WebsetWebhooksClient, WebsetsClient, Exa as default };

package/dist/index.js

@@ -35,6 +35,7 @@ __export(index_exports, {
   CreateWebsetParametersImportSource: () => CreateWebsetParametersImportSource,
   CreateWebsetParametersSearchExcludeSource: () => CreateWebsetParametersSearchExcludeSource,
   CreateWebsetSearchParametersExcludeSource: () => CreateWebsetSearchParametersExcludeSource,
+  CreateWebsetSearchParametersScopeSource: () => CreateWebsetSearchParametersScopeSource,
   EventType: () => EventType,
   EventsClient: () => EventsClient,
   Exa: () => Exa2,
@@ -50,7 +51,9 @@ __export(index_exports, {
   MonitorRunStatus: () => MonitorRunStatus,
   MonitorRunType: () => MonitorRunType,
   MonitorStatus: () => MonitorStatus,
+  PreviewWebsetResponseEnrichmentsFormat: () => PreviewWebsetResponseEnrichmentsFormat,
   ResearchClient: () => ResearchClient,
+  ScopeSourceType: () => ScopeSourceType,
   UpdateMonitorStatus: () => UpdateMonitorStatus,
   WebhookStatus: () => WebhookStatus,
   WebsetEnrichmentFormat: () => WebsetEnrichmentFormat,
@@ -250,11 +253,21 @@ var CreateWebsetParametersSearchExcludeSource = /* @__PURE__ */ ((CreateWebsetPa
   CreateWebsetParametersSearchExcludeSource2["webset"] = "webset";
   return CreateWebsetParametersSearchExcludeSource2;
 })(CreateWebsetParametersSearchExcludeSource || {});
+var ScopeSourceType = /* @__PURE__ */ ((ScopeSourceType2) => {
+  ScopeSourceType2["import"] = "import";
+  ScopeSourceType2["webset"] = "webset";
+  return ScopeSourceType2;
+})(ScopeSourceType || {});
 var CreateWebsetSearchParametersExcludeSource = /* @__PURE__ */ ((CreateWebsetSearchParametersExcludeSource2) => {
   CreateWebsetSearchParametersExcludeSource2["import"] = "import";
   CreateWebsetSearchParametersExcludeSource2["webset"] = "webset";
   return CreateWebsetSearchParametersExcludeSource2;
 })(CreateWebsetSearchParametersExcludeSource || {});
+var CreateWebsetSearchParametersScopeSource = /* @__PURE__ */ ((CreateWebsetSearchParametersScopeSource2) => {
+  CreateWebsetSearchParametersScopeSource2["import"] = "import";
+  CreateWebsetSearchParametersScopeSource2["webset"] = "webset";
+  return CreateWebsetSearchParametersScopeSource2;
+})(CreateWebsetSearchParametersScopeSource || {});
 var EventType = /* @__PURE__ */ ((EventType2) => {
   EventType2["webset_created"] = "webset.created";
   EventType2["webset_deleted"] = "webset.deleted";
@@ -321,6 +334,15 @@ var MonitorRunType = /* @__PURE__ */ ((MonitorRunType2) => {
   MonitorRunType2["refresh"] = "refresh";
   return MonitorRunType2;
 })(MonitorRunType || {});
+var PreviewWebsetResponseEnrichmentsFormat = /* @__PURE__ */ ((PreviewWebsetResponseEnrichmentsFormat2) => {
+  PreviewWebsetResponseEnrichmentsFormat2["text"] = "text";
+  PreviewWebsetResponseEnrichmentsFormat2["date"] = "date";
+  PreviewWebsetResponseEnrichmentsFormat2["number"] = "number";
+  PreviewWebsetResponseEnrichmentsFormat2["options"] = "options";
+  PreviewWebsetResponseEnrichmentsFormat2["email"] = "email";
+  PreviewWebsetResponseEnrichmentsFormat2["phone"] = "phone";
+  return PreviewWebsetResponseEnrichmentsFormat2;
+})(PreviewWebsetResponseEnrichmentsFormat || {});
 var UpdateMonitorStatus = /* @__PURE__ */ ((UpdateMonitorStatus2) => {
   UpdateMonitorStatus2["enabled"] = "enabled";
   UpdateMonitorStatus2["disabled"] = "disabled";
@@ -333,6 +355,7 @@ var WebhookStatus = /* @__PURE__ */ ((WebhookStatus2) => {
 })(WebhookStatus || {});
 var WebsetStatus = /* @__PURE__ */ ((WebsetStatus2) => {
   WebsetStatus2["idle"] = "idle";
+  WebsetStatus2["pending"] = "pending";
   WebsetStatus2["running"] = "running";
   WebsetStatus2["paused"] = "paused";
   return WebsetStatus2;
@@ -365,6 +388,7 @@ var WebsetItemEvaluationSatisfied = /* @__PURE__ */ ((WebsetItemEvaluationSatisf
 })(WebsetItemEvaluationSatisfied || {});
 var WebsetSearchStatus = /* @__PURE__ */ ((WebsetSearchStatus2) => {
   WebsetSearchStatus2["created"] = "created";
+  WebsetSearchStatus2["pending"] = "pending";
   WebsetSearchStatus2["running"] = "running";
   WebsetSearchStatus2["completed"] = "completed";
   WebsetSearchStatus2["canceled"] = "canceled";
@@ -902,6 +926,14 @@ var WebsetsClient = class extends WebsetsBaseClient {
   async create(params) {
     return this.request("/v0/websets", "POST", params);
   }
+  /**
+   * Preview a webset
+   * @param params The preview parameters
+   * @returns The preview response showing how the query will be decomposed
+   */
+  async preview(params) {
+    return this.request("/v0/websets/preview", "POST", params);
+  }
   /**
    * Get a Webset by ID
    * @param id The ID of the Webset
@@ -1639,6 +1671,7 @@ var index_default = Exa2;
   CreateWebsetParametersImportSource,
   CreateWebsetParametersSearchExcludeSource,
   CreateWebsetSearchParametersExcludeSource,
+  CreateWebsetSearchParametersScopeSource,
   EventType,
   EventsClient,
   Exa,
@@ -1654,7 +1687,9 @@ var index_default = Exa2;
   MonitorRunStatus,
   MonitorRunType,
   MonitorStatus,
+  PreviewWebsetResponseEnrichmentsFormat,
   ResearchClient,
+  ScopeSourceType,
   UpdateMonitorStatus,
   WebhookStatus,
   WebsetEnrichmentFormat,