exa-js 1.8.19 → 1.8.21

package/dist/index.d.mts

@@ -289,8 +289,16 @@ interface components$1 {
                  *
                  *     Any URLs provided will be crawled and used as additional context for the search. */
                 query: string;
-                /** @description Whether to compute recall metrics for the search */
+                /** @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;
+                    /** @enum {string} */
+                    source: ScopeSourceType;
+                }[];
             };
         };
         CreateWebsetSearchParameters: {
@@ -331,8 +339,16 @@ interface components$1 {
              *
              *     Any URLs provided will be crawled and used as additional context for the search. */
             query: string;
-            /** @description Whether to compute recall metrics for the search */
+            /** @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;
+                /** @enum {string} */
+                source: ScopeSourceType;
+            }[];
         };
         /** Custom */
         CustomEntity: {
@@ -360,7 +376,10 @@ interface components$1 {
                 snippet: string | null;
                 /** @description The title of the reference */
                 title: string | null;
-                /** @description The URL of the reference */
+                /**
+                 * Format: uri
+                 * @description The URL of the reference
+                 */
                 url: string;
             }[];
             /** @description The result of the enrichment. */
@@ -697,7 +716,7 @@ interface components$1 {
                      * @default append
                      * @enum {string}
                      */
-                    behavior: MonitorBehaviorConfigBehavior;
+                    behavior: WebsetSearchBehavior;
                     /** @description The maximum number of results to find */
                     count: number;
                     /** @description The criteria to search for. By default, the criteria from the last search is used. */
@@ -777,7 +796,7 @@ interface components$1 {
                  * @default append
                  * @enum {string}
                  */
-                behavior: MonitorBehaviorConfigBehavior;
+                behavior: WebsetSearchBehavior;
                 /** @description The maximum number of results to find */
                 count: number;
                 /** @description The criteria to search for. By default, the criteria from the last search is used. */
@@ -828,6 +847,8 @@ interface components$1 {
              * @description When the run failed
              */
             failedAt: string | null;
+            /** @description The reason the run failed */
+            failedReason: string | null;
             /** @description The unique identifier for the Monitor Run */
             id: string;
             /** @description The monitor that the run is associated with */
@@ -861,6 +882,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: {
             /**
@@ -1022,6 +1078,8 @@ interface components$1 {
             status: WebsetStatus;
             /** @description The Streams for the Webset. */
             streams: unknown[];
+            /** @description The title of the webset */
+            title: string | null;
             /**
              * Format: date-time
              * @description The date and time the webset was updated
@@ -1216,7 +1274,10 @@ interface components$1 {
                 snippet: string | null;
                 /** @description The title of the reference */
                 title: string | null;
-                /** @description The URL of the reference */
+                /**
+                 * Format: uri
+                 * @description The URL of the reference
+                 */
                 url: string;
             }[];
             /**
@@ -1372,6 +1433,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
@@ -1424,6 +1496,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"];
@@ -1478,6 +1552,9 @@ declare enum CreateWebsetParametersSearchExcludeSource {
     import = "import",
     webset = "webset"
 }
+declare enum ScopeSourceType {
+    import = "import"
+}
 declare enum CreateWebsetSearchParametersExcludeSource {
     import = "import",
     webset = "webset"
@@ -1529,10 +1606,6 @@ declare enum MonitorStatus {
     enabled = "enabled",
     disabled = "disabled"
 }
-declare enum MonitorBehaviorConfigBehavior {
-    override = "override",
-    append = "append"
-}
 declare enum MonitorRunObject {
     monitor_run = "monitor_run"
 }
@@ -1540,12 +1613,21 @@ declare enum MonitorRunStatus {
     created = "created",
     running = "running",
     completed = "completed",
-    canceled = "canceled"
+    canceled = "canceled",
+    failed = "failed"
 }
 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"
@@ -1573,6 +1655,7 @@ declare enum WebhookAttemptEventType {
 }
 declare enum WebsetStatus {
     idle = "idle",
+    pending = "pending",
     running = "running",
     paused = "paused"
 }
@@ -1609,6 +1692,7 @@ declare enum WebsetSearchRecallExpectedConfidence {
 }
 declare enum WebsetSearchStatus {
     created = "created",
+    pending = "pending",
     running = "running",
     completed = "completed",
     canceled = "canceled"
@@ -1798,6 +1882,15 @@ declare class ImportsClient extends WebsetsBaseClient {
  * Client for managing Webset Items
  */
 
+/**
+ * Options for listing webset items
+ */
+interface ListWebsetItemsOptions extends PaginationParams {
+    /**
+     * The id of the source to filter items by
+     */
+    sourceId?: string;
+}
 /**
  * Client for managing Webset Items
  */
@@ -1805,24 +1898,24 @@ declare class WebsetItemsClient extends WebsetsBaseClient {
     /**
      * List all Items for a Webset
      * @param websetId The ID of the Webset
-     * @param params - Optional pagination parameters
+     * @param params - Optional pagination and filtering parameters
      * @returns A promise that resolves with the list of Items
      */
-    list(websetId: string, params?: PaginationParams): Promise<ListWebsetItemResponse>;
+    list(websetId: string, params?: ListWebsetItemsOptions): Promise<ListWebsetItemResponse>;
     /**
      * Iterate through all Items in a Webset, handling pagination automatically
      * @param websetId The ID of the Webset
      * @param options Pagination options
      * @returns Async generator of Webset Items
      */
-    listAll(websetId: string, options?: PaginationParams): AsyncGenerator<WebsetItem>;
+    listAll(websetId: string, options?: ListWebsetItemsOptions): AsyncGenerator<WebsetItem>;
     /**
      * Collect all items from a Webset into an array
      * @param websetId The ID of the Webset
      * @param options Pagination options
      * @returns Promise resolving to an array of all Webset Items
      */
-    getAll(websetId: string, options?: PaginationParams): Promise<WebsetItem[]>;
+    getAll(websetId: string, options?: ListWebsetItemsOptions): Promise<WebsetItem[]>;
     /**
      * Get an Item by ID
      * @param websetId The ID of the Webset
@@ -1961,6 +2054,10 @@ interface ListWebhookAttemptsOptions extends PaginationParams {
      * The type of event to filter by
      */
     eventType?: EventType;
+    /**
+     * Filter attempts by their success status
+     */
+    successful?: boolean;
 }
 /**
  * Client for managing Webset Webhooks
@@ -2084,6 +2181,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
@@ -3118,4 +3221,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 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, 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

@@ -289,8 +289,16 @@ interface components$1 {
                  *
                  *     Any URLs provided will be crawled and used as additional context for the search. */
                 query: string;
-                /** @description Whether to compute recall metrics for the search */
+                /** @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;
+                    /** @enum {string} */
+                    source: ScopeSourceType;
+                }[];
             };
         };
         CreateWebsetSearchParameters: {
@@ -331,8 +339,16 @@ interface components$1 {
              *
              *     Any URLs provided will be crawled and used as additional context for the search. */
             query: string;
-            /** @description Whether to compute recall metrics for the search */
+            /** @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;
+                /** @enum {string} */
+                source: ScopeSourceType;
+            }[];
         };
         /** Custom */
         CustomEntity: {
@@ -360,7 +376,10 @@ interface components$1 {
                 snippet: string | null;
                 /** @description The title of the reference */
                 title: string | null;
-                /** @description The URL of the reference */
+                /**
+                 * Format: uri
+                 * @description The URL of the reference
+                 */
                 url: string;
             }[];
             /** @description The result of the enrichment. */
@@ -697,7 +716,7 @@ interface components$1 {
                      * @default append
                      * @enum {string}
                      */
-                    behavior: MonitorBehaviorConfigBehavior;
+                    behavior: WebsetSearchBehavior;
                     /** @description The maximum number of results to find */
                     count: number;
                     /** @description The criteria to search for. By default, the criteria from the last search is used. */
@@ -777,7 +796,7 @@ interface components$1 {
                  * @default append
                  * @enum {string}
                  */
-                behavior: MonitorBehaviorConfigBehavior;
+                behavior: WebsetSearchBehavior;
                 /** @description The maximum number of results to find */
                 count: number;
                 /** @description The criteria to search for. By default, the criteria from the last search is used. */
@@ -828,6 +847,8 @@ interface components$1 {
              * @description When the run failed
              */
             failedAt: string | null;
+            /** @description The reason the run failed */
+            failedReason: string | null;
             /** @description The unique identifier for the Monitor Run */
             id: string;
             /** @description The monitor that the run is associated with */
@@ -861,6 +882,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: {
             /**
@@ -1022,6 +1078,8 @@ interface components$1 {
             status: WebsetStatus;
             /** @description The Streams for the Webset. */
             streams: unknown[];
+            /** @description The title of the webset */
+            title: string | null;
             /**
              * Format: date-time
              * @description The date and time the webset was updated
@@ -1216,7 +1274,10 @@ interface components$1 {
                 snippet: string | null;
                 /** @description The title of the reference */
                 title: string | null;
-                /** @description The URL of the reference */
+                /**
+                 * Format: uri
+                 * @description The URL of the reference
+                 */
                 url: string;
             }[];
             /**
@@ -1372,6 +1433,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
@@ -1424,6 +1496,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"];
@@ -1478,6 +1552,9 @@ declare enum CreateWebsetParametersSearchExcludeSource {
     import = "import",
     webset = "webset"
 }
+declare enum ScopeSourceType {
+    import = "import"
+}
 declare enum CreateWebsetSearchParametersExcludeSource {
     import = "import",
     webset = "webset"
@@ -1529,10 +1606,6 @@ declare enum MonitorStatus {
     enabled = "enabled",
     disabled = "disabled"
 }
-declare enum MonitorBehaviorConfigBehavior {
-    override = "override",
-    append = "append"
-}
 declare enum MonitorRunObject {
     monitor_run = "monitor_run"
 }
@@ -1540,12 +1613,21 @@ declare enum MonitorRunStatus {
     created = "created",
     running = "running",
     completed = "completed",
-    canceled = "canceled"
+    canceled = "canceled",
+    failed = "failed"
 }
 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"
@@ -1573,6 +1655,7 @@ declare enum WebhookAttemptEventType {
 }
 declare enum WebsetStatus {
     idle = "idle",
+    pending = "pending",
     running = "running",
     paused = "paused"
 }
@@ -1609,6 +1692,7 @@ declare enum WebsetSearchRecallExpectedConfidence {
 }
 declare enum WebsetSearchStatus {
     created = "created",
+    pending = "pending",
     running = "running",
     completed = "completed",
     canceled = "canceled"
@@ -1798,6 +1882,15 @@ declare class ImportsClient extends WebsetsBaseClient {
  * Client for managing Webset Items
  */
 
+/**
+ * Options for listing webset items
+ */
+interface ListWebsetItemsOptions extends PaginationParams {
+    /**
+     * The id of the source to filter items by
+     */
+    sourceId?: string;
+}
 /**
  * Client for managing Webset Items
  */
@@ -1805,24 +1898,24 @@ declare class WebsetItemsClient extends WebsetsBaseClient {
     /**
      * List all Items for a Webset
      * @param websetId The ID of the Webset
-     * @param params - Optional pagination parameters
+     * @param params - Optional pagination and filtering parameters
      * @returns A promise that resolves with the list of Items
      */
-    list(websetId: string, params?: PaginationParams): Promise<ListWebsetItemResponse>;
+    list(websetId: string, params?: ListWebsetItemsOptions): Promise<ListWebsetItemResponse>;
     /**
      * Iterate through all Items in a Webset, handling pagination automatically
      * @param websetId The ID of the Webset
      * @param options Pagination options
      * @returns Async generator of Webset Items
      */
-    listAll(websetId: string, options?: PaginationParams): AsyncGenerator<WebsetItem>;
+    listAll(websetId: string, options?: ListWebsetItemsOptions): AsyncGenerator<WebsetItem>;
     /**
      * Collect all items from a Webset into an array
      * @param websetId The ID of the Webset
      * @param options Pagination options
      * @returns Promise resolving to an array of all Webset Items
      */
-    getAll(websetId: string, options?: PaginationParams): Promise<WebsetItem[]>;
+    getAll(websetId: string, options?: ListWebsetItemsOptions): Promise<WebsetItem[]>;
     /**
      * Get an Item by ID
      * @param websetId The ID of the Webset
@@ -1961,6 +2054,10 @@ interface ListWebhookAttemptsOptions extends PaginationParams {
      * The type of event to filter by
      */
     eventType?: EventType;
+    /**
+     * Filter attempts by their success status
+     */
+    successful?: boolean;
 }
 /**
  * Client for managing Webset Webhooks
@@ -2084,6 +2181,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
@@ -3118,4 +3221,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 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, 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 };