exa-js 1.9.0 → 1.9.1

package/dist/index.d.mts

@@ -253,7 +253,7 @@ interface components$1 {
                 /** @description The ID of the source to search. */
                 id: string;
                 /** @enum {string} */
-                source: CreateWebsetParametersImportSource;
+                source: WebsetImportSource;
             }[];
             /** @description Set of key-value pairs you want to associate with this object. */
             metadata?: {
@@ -281,7 +281,7 @@ interface components$1 {
                     /** @description The ID of the source to exclude. */
                     id: string;
                     /** @enum {string} */
-                    source: CreateWebsetParametersSearchExcludeSource;
+                    source: WebsetSearchExcludeSource;
                 }[];
                 /** @description Natural language search query describing what you are looking for.
                  *
@@ -302,7 +302,7 @@ interface components$1 {
                         limit: number;
                     };
                     /** @enum {string} */
-                    source: CreateWebsetSearchParametersScopeSource;
+                    source: WebsetSearchScopeSource;
                 }[];
             };
         };
@@ -314,7 +314,7 @@ interface components$1 {
              *     - **append**: Add new items to existing ones, keeping items that match the new criteria
              * @default override
              */
-            behavior: components$1["schemas"]["WebsetSearchBehavior"];
+            behavior: WebsetSearchBehavior;
             /** @description Number of Items the Search will attempt to find.
              *
              *     The actual number of Items found may be less than this number depending on the query complexity. */
@@ -332,7 +332,7 @@ interface components$1 {
                 /** @description The ID of the source to exclude. */
                 id: string;
                 /** @enum {string} */
-                source: CreateWebsetSearchParametersExcludeSource;
+                source: WebsetSearchExcludeSource;
             }[];
             /** @description Set of key-value pairs you want to associate with this object. */
             metadata?: {
@@ -357,7 +357,7 @@ interface components$1 {
                     limit: number;
                 };
                 /** @enum {string} */
-                source: CreateWebsetSearchParametersScopeSource;
+                source: WebsetSearchScopeSource;
             }[];
         };
         /** Custom */
@@ -592,6 +592,139 @@ interface components$1 {
              * @constant
              */
             type: "webset.search.completed";
+        } | {
+            /**
+             * Format: date-time
+             * @description The date and time the event was created
+             */
+            createdAt: string;
+            data: components$1["schemas"]["Import"];
+            /** @description The unique identifier for the event */
+            id: string;
+            /**
+             * @default event
+             * @constant
+             */
+            object: "event";
+            /**
+             * @default import.created
+             * @constant
+             */
+            type: "import.created";
+        } | {
+            /**
+             * Format: date-time
+             * @description The date and time the event was created
+             */
+            createdAt: string;
+            data: components$1["schemas"]["Import"];
+            /** @description The unique identifier for the event */
+            id: string;
+            /**
+             * @default event
+             * @constant
+             */
+            object: "event";
+            /**
+             * @default import.completed
+             * @constant
+             */
+            type: "import.completed";
+        } | {
+            /**
+             * Format: date-time
+             * @description The date and time the event was created
+             */
+            createdAt: string;
+            data: components$1["schemas"]["Monitor"];
+            /** @description The unique identifier for the event */
+            id: string;
+            /**
+             * @default event
+             * @constant
+             */
+            object: "event";
+            /**
+             * @default monitor.created
+             * @constant
+             */
+            type: "monitor.created";
+        } | {
+            /**
+             * Format: date-time
+             * @description The date and time the event was created
+             */
+            createdAt: string;
+            data: components$1["schemas"]["Monitor"];
+            /** @description The unique identifier for the event */
+            id: string;
+            /**
+             * @default event
+             * @constant
+             */
+            object: "event";
+            /**
+             * @default monitor.updated
+             * @constant
+             */
+            type: "monitor.updated";
+        } | {
+            /**
+             * Format: date-time
+             * @description The date and time the event was created
+             */
+            createdAt: string;
+            data: components$1["schemas"]["Monitor"];
+            /** @description The unique identifier for the event */
+            id: string;
+            /**
+             * @default event
+             * @constant
+             */
+            object: "event";
+            /**
+             * @default monitor.deleted
+             * @constant
+             */
+            type: "monitor.deleted";
+        } | {
+            /**
+             * Format: date-time
+             * @description The date and time the event was created
+             */
+            createdAt: string;
+            data: components$1["schemas"]["MonitorRun"];
+            /** @description The unique identifier for the event */
+            id: string;
+            /**
+             * @default event
+             * @constant
+             */
+            object: "event";
+            /**
+             * @default monitor.run.created
+             * @constant
+             */
+            type: "monitor.run.created";
+        } | {
+            /**
+             * Format: date-time
+             * @description The date and time the event was created
+             */
+            createdAt: string;
+            data: components$1["schemas"]["MonitorRun"];
+            /** @description The unique identifier for the event */
+            id: string;
+            /**
+             * @default event
+             * @constant
+             */
+            object: "event";
+            /**
+             * @default monitor.run.completed
+             * @constant
+             */
+            type: "monitor.run.completed";
         };
         /** @enum {string} */
         EventType: EventType;
@@ -911,7 +1044,7 @@ interface components$1 {
                  * @description Format of the enrichment.
                  * @enum {string}
                  */
-                format: PreviewWebsetResponseEnrichmentsFormat;
+                format: WebsetEnrichmentFormat;
                 /** @description When format is options, the options detected from the query. */
                 options?: {
                     /** @description Label of the option. */
@@ -935,6 +1068,26 @@ interface components$1 {
              */
             type: "research_paper";
         };
+        UpdateEnrichmentParameters: {
+            /** @description Provide a description of the enrichment task you want to perform to each Webset Item. */
+            description?: string;
+            /**
+             * @description Format of the enrichment response.
+             *
+             *     We automatically select the best format based on the description. If you want to explicitly specify the format, you can do so here.
+             * @enum {string}
+             */
+            format?: WebsetEnrichmentFormat;
+            /** @description Set of key-value pairs you want to associate with this object. */
+            metadata?: {
+                [key: string]: string;
+            } | null;
+            /** @description When the format is options, the different options for the enrichment agent to choose from. */
+            options?: {
+                /** @description The label of the option */
+                label: string;
+            }[];
+        };
         UpdateImport: {
             metadata?: {
                 [key: string]: string;
@@ -1027,7 +1180,7 @@ interface components$1 {
              * @description The type of event
              * @enum {string}
              */
-            eventType: WebhookAttemptEventType;
+            eventType: EventType;
             /** @description The unique identifier for the webhook attempt */
             id: string;
             /**
@@ -1364,14 +1517,14 @@ interface components$1 {
              *     - `append`: the search will add the new Items found to the existing Webset. Any Items that don't match the new criteria will be discarded.
              * @default override
              */
-            behavior: components$1["schemas"]["WebsetSearchBehavior"];
+            behavior: WebsetSearchBehavior;
             /**
              * Format: date-time
              * @description The date and time the search was canceled
              */
             canceledAt: string | null;
             /** @description The reason the search was canceled */
-            canceledReason: components$1["schemas"]["WebsetSearchCanceledReason"];
+            canceledReason: WebsetSearchCanceledReason;
             /** @description The number of results the search will attempt to find. The actual number of results may be less than this number depending on the search complexity. */
             count: number;
             /**
@@ -1448,11 +1601,13 @@ interface components$1 {
              *     If provided during creation, the search will only be performed on the sources provided. */
             scope: {
                 id: string;
-                /**
-                 * @default import
-                 * @enum {string}
-                 */
-                source: ScopeSourceType;
+                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: WebsetSearchScopeSource;
             }[];
             /**
              * WebsetSearchStatus
@@ -1468,10 +1623,6 @@ interface components$1 {
             /** @description The unique identifier for the Webset this search belongs to */
             websetId: string;
         };
-        /** @enum {string} */
-        WebsetSearchBehavior: WebsetSearchBehavior;
-        /** @enum {string} */
-        WebsetSearchCanceledReason: WebsetSearchCanceledReason;
     };
     responses: never;
     parameters: never;
@@ -1511,6 +1662,7 @@ 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 UpdateEnrichmentParameters = components$1["schemas"]["UpdateEnrichmentParameters"];
 type UpdateImport = components$1["schemas"]["UpdateImport"];
 type UpdateMonitor = components$1["schemas"]["UpdateMonitor"];
 type UpdateWebhookParameters = components$1["schemas"]["UpdateWebhookParameters"];
@@ -1533,7 +1685,8 @@ declare enum CreateEnrichmentParametersFormat {
     number = "number",
     options = "options",
     email = "email",
-    phone = "phone"
+    phone = "phone",
+    url = "url"
 }
 declare enum CreateImportParametersFormat {
     csv = "csv"
@@ -1556,23 +1709,7 @@ declare enum CreateImportResponseStatus {
     completed = "completed",
     failed = "failed"
 }
-declare enum CreateWebsetParametersImportSource {
-    import = "import",
-    webset = "webset"
-}
-declare enum CreateWebsetParametersSearchExcludeSource {
-    import = "import",
-    webset = "webset"
-}
-declare enum ScopeSourceType {
-    import = "import",
-    webset = "webset"
-}
-declare enum CreateWebsetSearchParametersExcludeSource {
-    import = "import",
-    webset = "webset"
-}
-declare enum CreateWebsetSearchParametersScopeSource {
+declare enum WebsetImportSource {
     import = "import",
     webset = "webset"
 }
@@ -1592,9 +1729,13 @@ declare enum EventType {
     webset_search_updated = "webset.search.updated",
     import_created = "import.created",
     import_completed = "import.completed",
-    import_processing = "import.processing",
     webset_item_created = "webset.item.created",
     webset_item_enriched = "webset.item.enriched",
+    monitor_created = "monitor.created",
+    monitor_updated = "monitor.updated",
+    monitor_deleted = "monitor.deleted",
+    monitor_run_created = "monitor.run.created",
+    monitor_run_completed = "monitor.run.completed",
     webset_export_created = "webset.export.created",
     webset_export_completed = "webset.export.completed"
 }
@@ -1637,14 +1778,6 @@ 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"
@@ -1653,23 +1786,6 @@ declare enum WebhookStatus {
     active = "active",
     inactive = "inactive"
 }
-declare enum WebhookAttemptEventType {
-    webset_created = "webset.created",
-    webset_deleted = "webset.deleted",
-    webset_paused = "webset.paused",
-    webset_idle = "webset.idle",
-    webset_search_created = "webset.search.created",
-    webset_search_canceled = "webset.search.canceled",
-    webset_search_completed = "webset.search.completed",
-    webset_search_updated = "webset.search.updated",
-    import_created = "import.created",
-    import_completed = "import.completed",
-    import_processing = "import.processing",
-    webset_item_created = "webset.item.created",
-    webset_item_enriched = "webset.item.enriched",
-    webset_export_created = "webset.export.created",
-    webset_export_completed = "webset.export.completed"
-}
 declare enum WebsetStatus {
     idle = "idle",
     pending = "pending",
@@ -1687,7 +1803,8 @@ declare enum WebsetEnrichmentFormat {
     number = "number",
     options = "options",
     email = "email",
-    phone = "phone"
+    phone = "phone",
+    url = "url"
 }
 declare enum WebsetItemSource {
     search = "search",
@@ -1707,6 +1824,10 @@ declare enum WebsetSearchRecallExpectedConfidence {
     medium = "medium",
     low = "low"
 }
+declare enum WebsetSearchScopeSource {
+    import = "import",
+    webset = "webset"
+}
 declare enum WebsetSearchStatus {
     created = "created",
     pending = "pending",
@@ -1752,6 +1873,14 @@ declare class WebsetEnrichmentsClient extends WebsetsBaseClient {
      * @returns The deleted Webset Enrichment
      */
     delete(websetId: string, id: string): Promise<WebsetEnrichment>;
+    /**
+     * Update an Enrichment
+     * @param websetId The ID of the Webset
+     * @param id The ID of the Enrichment
+     * @param params The enrichment update parameters
+     * @returns Promise that resolves when the update is complete
+     */
+    update(websetId: string, id: string, params: UpdateEnrichmentParameters): Promise<void>;
     /**
      * Cancel a running Enrichment
      * @param websetId The ID of the Webset
@@ -4445,4 +4574,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, 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 ListResearchRequest, type ListResearchResponse, 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, type Research, type ResearchCreateParamsTyped, type ResearchCreateRequest, type ResearchCreateResponse, type ResearchDefinitionEvent, type ResearchEvent, type ResearchOperation, type ResearchOutputEvent, type ResearchPaperEntity, type ResearchPlanDefinitionEvent, type ResearchPlanOperationEvent, type ResearchPlanOutputEvent, type ResearchStatus, type ResearchStreamEvent, type ResearchStreamEventTyped, type ResearchTaskDefinitionEvent, type ResearchTaskOperationEvent, type ResearchTaskOutputEvent, type ResearchTyped, 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 WebsetHeadersLike, 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, type CreateWebsetSearchParameters, 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 ListResearchRequest, type ListResearchResponse, 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, type RegularSearchOptions, type Research, type ResearchCreateParamsTyped, type ResearchCreateRequest, type ResearchCreateResponse, type ResearchDefinitionEvent, type ResearchEvent, type ResearchOperation, type ResearchOutputEvent, type ResearchPaperEntity, type ResearchPlanDefinitionEvent, type ResearchPlanOperationEvent, type ResearchPlanOutputEvent, type ResearchStatus, type ResearchStreamEvent, type ResearchStreamEventTyped, type ResearchTaskDefinitionEvent, type ResearchTaskOperationEvent, type ResearchTaskOutputEvent, type ResearchTyped, type SearchResponse, type SearchResult, type Status, type SubpagesResponse, type SummaryContentsOptions, type SummaryContentsOptionsTyped, type SummaryResponse, type TextContentsOptions, type TextResponse, type UpdateEnrichmentParameters, type UpdateImport, type UpdateMonitor, UpdateMonitorStatus, type UpdateWebhookParameters, type UpdateWebsetRequest, type WaitUntilCompletedOptions, type Webhook, type WebhookAttempt, WebhookStatus, type Webset, type WebsetEnrichment, WebsetEnrichmentFormat, WebsetEnrichmentStatus, WebsetEnrichmentsClient, type WebsetHeadersLike, WebsetImportSource, type WebsetItem, type WebsetItemArticleProperties, type WebsetItemCompanyProperties, type WebsetItemCustomProperties, type WebsetItemEvaluation, WebsetItemEvaluationSatisfied, type WebsetItemPersonProperties, type WebsetItemResearchPaperProperties, WebsetItemSource, WebsetItemsClient, WebsetMonitorsClient, type WebsetSearch, WebsetSearchBehavior, WebsetSearchCanceledReason, WebsetSearchExcludeSource, WebsetSearchScopeSource, WebsetSearchStatus, WebsetSearchesClient, WebsetStatus, WebsetWebhooksClient, WebsetsClient, Exa as default };