exa-js 1.8.17 → 1.8.18

package/dist/index.d.mts

@@ -287,6 +287,8 @@ 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 */
+                recall?: boolean;
             };
         };
         CreateWebsetSearchParameters: {
@@ -327,12 +329,11 @@ 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 */
+            recall?: boolean;
         };
         /** Custom */
         CustomEntity: {
-            /** @description When you decide to use a custom entity, this is the description of the entity.
-             *
-             *     The entity represents what type of results the  will return. For example, if you want results to be Job Postings, you might use "Job Postings" as the entity description. */
             description: string;
             /**
              * @default custom
@@ -362,6 +363,11 @@ interface components$1 {
             }[];
             /** @description The result of the enrichment. */
             result: string[] | null;
+            /**
+             * @description The status of the enrichment result.
+             * @enum {string}
+             */
+            status: EnrichmentResultStatus;
         };
         Entity: components$1["schemas"]["CompanyEntity"] | components$1["schemas"]["PersonEntity"] | components$1["schemas"]["ArticleEntity"] | components$1["schemas"]["ResearchPaperEntity"] | components$1["schemas"]["CustomEntity"];
         /** Event */
@@ -557,6 +563,7 @@ interface components$1 {
             type: "webset.search.completed";
         };
         /** @enum {string} */
+        EventType: EventType;
         GetWebsetResponse: components$1["schemas"]["Webset"] & {
             /** @description When expand query parameter contains `items`, this will contain the items in the webset */
             items?: components$1["schemas"]["WebsetItem"][];
@@ -1332,13 +1339,37 @@ interface components$1 {
             object: "webset_search";
             /** @description The progress of the search */
             progress: {
+                /** @description The number of results analyzed so far */
+                analyzed: number;
                 /** @description The completion percentage of the search */
                 completion: number;
                 /** @description The number of results found so far */
                 found: number;
+                /** @description The estimated time remaining in seconds, null if unknown */
+                timeLeft: number | null;
             };
             /** @description The query used to create the search. */
             query: string;
+            /** @description Recall metrics for the search, null if not yet computed or requested. */
+            recall: {
+                expected: {
+                    bounds: {
+                        /** @description The maximum estimated total number of potential matches */
+                        max: number;
+                        /** @description The minimum estimated total number of potential matches */
+                        min: number;
+                    };
+                    /**
+                     * @description The confidence in the estimate
+                     * @enum {string}
+                     */
+                    confidence: WebsetSearchRecallExpectedConfidence;
+                    /** @description The estimated total number of potential matches */
+                    total: number;
+                };
+                /** @description The reasoning for the estimate */
+                reasoning: string;
+            } | null;
             /**
              * WebsetSearchStatus
              * @description The status of the search
@@ -1449,6 +1480,11 @@ declare enum CreateWebsetSearchParametersExcludeSource {
     import = "import",
     webset = "webset"
 }
+declare enum EnrichmentResultStatus {
+    pending = "pending",
+    completed = "completed",
+    canceled = "canceled"
+}
 declare enum EventType {
     webset_created = "webset.created",
     webset_deleted = "webset.deleted",
@@ -1564,6 +1600,11 @@ declare enum WebsetSearchExcludeSource {
     import = "import",
     webset = "webset"
 }
+declare enum WebsetSearchRecallExpectedConfidence {
+    high = "high",
+    medium = "medium",
+    low = "low"
+}
 declare enum WebsetSearchStatus {
     created = "created",
     running = "running",

package/dist/index.d.ts

@@ -287,6 +287,8 @@ 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 */
+                recall?: boolean;
             };
         };
         CreateWebsetSearchParameters: {
@@ -327,12 +329,11 @@ 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 */
+            recall?: boolean;
         };
         /** Custom */
         CustomEntity: {
-            /** @description When you decide to use a custom entity, this is the description of the entity.
-             *
-             *     The entity represents what type of results the  will return. For example, if you want results to be Job Postings, you might use "Job Postings" as the entity description. */
             description: string;
             /**
              * @default custom
@@ -362,6 +363,11 @@ interface components$1 {
             }[];
             /** @description The result of the enrichment. */
             result: string[] | null;
+            /**
+             * @description The status of the enrichment result.
+             * @enum {string}
+             */
+            status: EnrichmentResultStatus;
         };
         Entity: components$1["schemas"]["CompanyEntity"] | components$1["schemas"]["PersonEntity"] | components$1["schemas"]["ArticleEntity"] | components$1["schemas"]["ResearchPaperEntity"] | components$1["schemas"]["CustomEntity"];
         /** Event */
@@ -557,6 +563,7 @@ interface components$1 {
             type: "webset.search.completed";
         };
         /** @enum {string} */
+        EventType: EventType;
         GetWebsetResponse: components$1["schemas"]["Webset"] & {
             /** @description When expand query parameter contains `items`, this will contain the items in the webset */
             items?: components$1["schemas"]["WebsetItem"][];
@@ -1332,13 +1339,37 @@ interface components$1 {
             object: "webset_search";
             /** @description The progress of the search */
             progress: {
+                /** @description The number of results analyzed so far */
+                analyzed: number;
                 /** @description The completion percentage of the search */
                 completion: number;
                 /** @description The number of results found so far */
                 found: number;
+                /** @description The estimated time remaining in seconds, null if unknown */
+                timeLeft: number | null;
             };
             /** @description The query used to create the search. */
             query: string;
+            /** @description Recall metrics for the search, null if not yet computed or requested. */
+            recall: {
+                expected: {
+                    bounds: {
+                        /** @description The maximum estimated total number of potential matches */
+                        max: number;
+                        /** @description The minimum estimated total number of potential matches */
+                        min: number;
+                    };
+                    /**
+                     * @description The confidence in the estimate
+                     * @enum {string}
+                     */
+                    confidence: WebsetSearchRecallExpectedConfidence;
+                    /** @description The estimated total number of potential matches */
+                    total: number;
+                };
+                /** @description The reasoning for the estimate */
+                reasoning: string;
+            } | null;
             /**
              * WebsetSearchStatus
              * @description The status of the search
@@ -1449,6 +1480,11 @@ declare enum CreateWebsetSearchParametersExcludeSource {
     import = "import",
     webset = "webset"
 }
+declare enum EnrichmentResultStatus {
+    pending = "pending",
+    completed = "completed",
+    canceled = "canceled"
+}
 declare enum EventType {
     webset_created = "webset.created",
     webset_deleted = "webset.deleted",
@@ -1564,6 +1600,11 @@ declare enum WebsetSearchExcludeSource {
     import = "import",
     webset = "webset"
 }
+declare enum WebsetSearchRecallExpectedConfidence {
+    high = "high",
+    medium = "medium",
+    low = "low"
+}
 declare enum WebsetSearchStatus {
     created = "created",
     running = "running",