exa-js 1.8.10 → 1.8.12

package/dist/index.d.mts

@@ -1749,7 +1749,7 @@ declare class ResearchClient extends ResearchBaseClient {
      */
     createTask(params: {
         instructions: string;
-        model?: ResearchCreateOpenAIResponseDtoModel;
+        model?: "exa-research" | "exa-research-pro";
         output?: {
             inferSchema?: boolean;
             schema?: JSONSchema;
@@ -1771,7 +1771,7 @@ declare class ResearchClient extends ResearchBaseClient {
     }): Promise<SchemaResearchTaskDto>;
     getTask(id: string, options: {
         stream: true;
-    }): Promise<AsyncGenerator<ResearchTaskEventDtoType, any, any>>;
+    }): Promise<AsyncGenerator<ResearchTaskEvent, any, any>>;
     /**
      * @deprecated This method is deprecated and may be removed in a future release.
      * @see getTask(id, {stream: true})
@@ -1811,12 +1811,12 @@ interface components {
             input: string;
             instructions?: string;
             /** @enum {string} */
-            model: ResearchCreateOpenAIResponseDtoModel;
+            model: "exa-research" | "exa-research-pro";
             stream?: boolean;
             text?: {
                 format?: {
                     /** @enum {string} */
-                    type: ResearchCreateOpenAIResponseDtoTextFormatType;
+                    type: "text";
                 } | {
                     description?: string;
                     name?: string;
@@ -1825,7 +1825,7 @@ interface components {
                     };
                     strict?: boolean;
                     /** @enum {string} */
-                    type: ResearchCreateOpenAIResponseDtoTextFormatType;
+                    type: "json_schema";
                 };
             };
         };
@@ -1839,7 +1839,7 @@ interface components {
              * @default exa-research
              * @enum {string}
              */
-            model: ResearchCreateOpenAIResponseDtoModel;
+            model: "exa-research" | "exa-research-pro";
             output?: {
                 /**
                  * @description When true and an output schema is omitted, an output schema will be intelligently generated. Otherwise, if this is false and there is no output schema, a generic markdown report will be generated.
@@ -1886,13 +1886,13 @@ interface components {
             /** @description The instructions or query for the research task */
             instructions: string;
             /** @enum {string} */
-            model?: ResearchCreateOpenAIResponseDtoModel;
+            model?: "exa-research" | "exa-research-pro";
             operations: ({
                 stepId: string;
                 /** @description Agent generated plan or reasoning for upcoming actions. */
                 text: string;
                 /** @enum {string} */
-                type: ResearchTaskDtoOperationsType;
+                type: "step-plan";
             } | {
                 /** @description A completed subfield */
                 data: {
@@ -1900,7 +1900,7 @@ interface components {
                 };
                 stepId: string;
                 /** @enum {string} */
-                type: ResearchTaskDtoOperationsType;
+                type: "step-data";
             } | {
                 /** @description What the agent hopes to find with this search query */
                 goal?: string;
@@ -1912,24 +1912,24 @@ interface components {
                     title?: string;
                     url: string;
                     /** @enum {number} */
-                    version: ResearchTaskDtoOperationsResultsVersion;
+                    version: 1;
                 }[];
                 stepId: string;
                 /** @enum {string} */
-                type: ResearchTaskDtoOperationsType;
+                type: "search";
             } | {
                 /** @description What the agent hopes to find with this crawl */
                 goal?: string;
                 stepId: string;
                 /** @enum {string} */
-                type: ResearchTaskDtoOperationsType;
+                type: "crawl";
                 url: string;
             } | {
                 stepId: string;
                 /** @description Intermediate chain-of-thought style reasoning output */
                 thought: string;
                 /** @enum {string} */
-                type: ResearchTaskDtoOperationsType;
+                type: "think";
             })[];
             /** @description The JSON schema specification for the expected output format */
             schema?: {
@@ -1939,52 +1939,56 @@ interface components {
              * @description The current status of the research task
              * @enum {string}
              */
-            status: ResearchTaskDtoStatus;
+            status: "running" | "completed" | "failed";
             timeMs?: number;
         };
         ResearchTaskEventDto: {
-            stepId: string;
-            /** @description Agent generated plan or reasoning for upcoming actions. */
-            text: string;
-            /** @enum {string} */
-            type: ResearchTaskDtoOperationsType;
-        } | {
-            /** @description A completed subfield */
-            data: {
-                [key: string]: unknown;
-            };
-            stepId: string;
-            /** @enum {string} */
-            type: ResearchTaskDtoOperationsType;
-        } | {
-            /** @description What the agent hopes to find with this search query */
-            goal?: string;
-            /** @description Search query used */
-            query: string;
-            results?: {
-                id: string;
-                snippet: string;
-                title?: string;
+            operation: {
+                stepId: string;
+                /** @description Agent generated plan or reasoning for upcoming actions. */
+                text: string;
+                /** @enum {string} */
+                type: "step-plan";
+            } | {
+                /** @description A completed subfield */
+                data: {
+                    [key: string]: unknown;
+                };
+                stepId: string;
+                /** @enum {string} */
+                type: "step-data";
+            } | {
+                /** @description What the agent hopes to find with this search query */
+                goal?: string;
+                /** @description Search query used */
+                query: string;
+                results?: {
+                    id: string;
+                    snippet: string;
+                    title?: string;
+                    url: string;
+                    /** @enum {number} */
+                    version: 1;
+                }[];
+                stepId: string;
+                /** @enum {string} */
+                type: "search";
+            } | {
+                /** @description What the agent hopes to find with this crawl */
+                goal?: string;
+                stepId: string;
+                /** @enum {string} */
+                type: "crawl";
                 url: string;
-                /** @enum {number} */
-                version: ResearchTaskDtoOperationsResultsVersion;
-            }[];
-            stepId: string;
-            /** @enum {string} */
-            type: ResearchTaskDtoOperationsType;
-        } | {
-            /** @description What the agent hopes to find with this crawl */
-            goal?: string;
-            stepId: string;
-            /** @enum {string} */
-            type: ResearchTaskDtoOperationsType;
-            url: string;
-        } | {
-            stepId: string;
-            /** @description Intermediate chain-of-thought style reasoning output */
-            thought: string;
+            } | {
+                stepId: string;
+                /** @description Intermediate chain-of-thought style reasoning output */
+                thought: string;
+                /** @enum {string} */
+                type: "think";
+            };
             /** @enum {string} */
-            type: ResearchTaskDtoOperationsType;
+            type: "operation";
         } | {
             task: {
                 /** @description Citations grouped by the root field they were used in */
@@ -2015,13 +2019,13 @@ interface components {
                 /** @description The instructions or query for the research task */
                 instructions: string;
                 /** @enum {string} */
-                model?: ResearchCreateOpenAIResponseDtoModel;
+                model?: "exa-research" | "exa-research-pro";
                 operations: ({
                     stepId: string;
                     /** @description Agent generated plan or reasoning for upcoming actions. */
                     text: string;
                     /** @enum {string} */
-                    type: ResearchTaskDtoOperationsType;
+                    type: "step-plan";
                 } | {
                     /** @description A completed subfield */
                     data: {
@@ -2029,7 +2033,7 @@ interface components {
                     };
                     stepId: string;
                     /** @enum {string} */
-                    type: ResearchTaskDtoOperationsType;
+                    type: "step-data";
                 } | {
                     /** @description What the agent hopes to find with this search query */
                     goal?: string;
@@ -2041,24 +2045,24 @@ interface components {
                         title?: string;
                         url: string;
                         /** @enum {number} */
-                        version: ResearchTaskDtoOperationsResultsVersion;
+                        version: 1;
                     }[];
                     stepId: string;
                     /** @enum {string} */
-                    type: ResearchTaskDtoOperationsType;
+                    type: "search";
                 } | {
                     /** @description What the agent hopes to find with this crawl */
                     goal?: string;
                     stepId: string;
                     /** @enum {string} */
-                    type: ResearchTaskDtoOperationsType;
+                    type: "crawl";
                     url: string;
                 } | {
                     stepId: string;
                     /** @description Intermediate chain-of-thought style reasoning output */
                     thought: string;
                     /** @enum {string} */
-                    type: ResearchTaskDtoOperationsType;
+                    type: "think";
                 })[];
                 /** @description The JSON schema specification for the expected output format */
                 schema?: {
@@ -2068,11 +2072,55 @@ interface components {
                  * @description The current status of the research task
                  * @enum {string}
                  */
-                status: ResearchTaskDtoStatus;
+                status: "running" | "completed" | "failed";
                 timeMs?: number;
             };
             /** @enum {string} */
-            type: ResearchTaskEventDtoType;
+            type: "completed";
+        };
+        ResearchTaskOperationDto: {
+            stepId: string;
+            /** @description Agent generated plan or reasoning for upcoming actions. */
+            text: string;
+            /** @enum {string} */
+            type: "step-plan";
+        } | {
+            /** @description A completed subfield */
+            data: {
+                [key: string]: unknown;
+            };
+            stepId: string;
+            /** @enum {string} */
+            type: "step-data";
+        } | {
+            /** @description What the agent hopes to find with this search query */
+            goal?: string;
+            /** @description Search query used */
+            query: string;
+            results?: {
+                id: string;
+                snippet: string;
+                title?: string;
+                url: string;
+                /** @enum {number} */
+                version: 1;
+            }[];
+            stepId: string;
+            /** @enum {string} */
+            type: "search";
+        } | {
+            /** @description What the agent hopes to find with this crawl */
+            goal?: string;
+            stepId: string;
+            /** @enum {string} */
+            type: "crawl";
+            url: string;
+        } | {
+            stepId: string;
+            /** @description Intermediate chain-of-thought style reasoning output */
+            thought: string;
+            /** @enum {string} */
+            type: "think";
         };
     };
     responses: never;
@@ -2086,42 +2134,9 @@ type SchemaListResearchTasksResponseDto = components["schemas"]["ListResearchTas
 type SchemaResearchCreateTaskRequestDto = components["schemas"]["ResearchCreateTaskRequestDto"];
 type SchemaResearchCreateTaskResponseDto = components["schemas"]["ResearchCreateTaskResponseDto"];
 type SchemaResearchTaskDto = components["schemas"]["ResearchTaskDto"];
-declare enum ResearchCreateOpenAIResponseDtoModel {
-    exa_research = "exa-research",
-    exa_research_pro = "exa-research-pro"
-}
-declare enum ResearchCreateOpenAIResponseDtoTextFormatType {
-    text = "text"
-}
-declare enum ResearchCreateOpenAIResponseDtoTextFormatType {
-    json_schema = "json_schema"
-}
-declare enum ResearchTaskDtoOperationsResultsVersion {
-    Value1 = 1
-}
-declare enum ResearchTaskDtoOperationsType {
-    step_plan = "step-plan"
-}
-declare enum ResearchTaskDtoOperationsType {
-    step_data = "step-data"
-}
-declare enum ResearchTaskDtoOperationsType {
-    search = "search"
-}
-declare enum ResearchTaskDtoOperationsType {
-    crawl = "crawl"
-}
-declare enum ResearchTaskDtoOperationsType {
-    think = "think"
-}
-declare enum ResearchTaskDtoStatus {
-    running = "running",
-    completed = "completed",
-    failed = "failed"
-}
-declare enum ResearchTaskEventDtoType {
-    completed = "completed"
-}
+
+type ResearchTaskEvent = components["schemas"]["ResearchTaskEventDto"];
+type ResearchTaskOperation = SchemaResearchTaskDto["operations"][0];
 
 /**
  * HTTP status codes
@@ -2619,4 +2634,4 @@ declare class Exa {
     private parseSSEStream;
 }
 
-export { type AnswerOptions, type AnswerResponse, type AnswerStreamChunk, type AnswerStreamResponse, type BaseSearchOptions, type ContentsOptions, type ContentsResultComponent, type ContextOptions, type CostDollars, type CostDollarsContents, type CostDollarsSeearch, type CreateCriterionParameters, type CreateEnrichmentParameters, CreateEnrichmentParametersFormat, type CreateMonitorParameters, type CreateWebhookParameters, type CreateWebsetParameters, type CreateWebsetSearchParameters, type Default, type EnrichmentResult, type Event, EventType, EventsClient, Exa, ExaError, type ExtrasOptions, type ExtrasResponse, type FindSimilarOptions, type GetWebsetResponse, type HighlightsContentsOptions, type HighlightsResponse, HttpStatusCode, type JSONSchema, type ListEventsResponse, type ListMonitorRunsResponse, type ListMonitorsOptions, type ListMonitorsResponse, type SchemaListResearchTasksRequestDto as ListResearchTasksRequest, type SchemaListResearchTasksResponseDto as ListResearchTasksResponse, type ListWebhookAttemptsResponse, type ListWebhooksResponse, type ListWebsetItemResponse, type ListWebsetsResponse, type LivecrawlOptions, type Monitor, type MonitorBehaviorRefresh, type MonitorBehaviorSearch, type MonitorCadence, MonitorObject, type MonitorRefreshBehaviorContentsConfig, type MonitorRefreshBehaviorEnrichmentsConfig, type MonitorRun, MonitorRunObject, MonitorRunStatus, MonitorRunType, MonitorStatus, type RegularSearchOptions, ResearchClient, type SchemaResearchCreateTaskRequestDto as ResearchCreateTaskRequest, type SchemaResearchCreateTaskResponseDto as ResearchCreateTaskResponse, ResearchTaskEventDtoType as ResearchEvent, ResearchCreateOpenAIResponseDtoModel as ResearchModel, ResearchTaskDtoStatus as ResearchStatus, type SchemaResearchTaskDto as ResearchTask, type SearchResponse, type SearchResult, type Status, type SubpagesResponse, type SummaryContentsOptions, type SummaryResponse, type TextContentsOptions, type TextResponse, type UpdateMonitor, UpdateMonitorStatus, type UpdateWebhookParameters, type UpdateWebsetRequest, type Webhook, type WebhookAttempt, WebhookStatus, type Webset, type WebsetArticleEntity, type WebsetCompanyEntity, type WebsetCustomEntity, type WebsetEnrichment, WebsetEnrichmentFormat, WebsetEnrichmentStatus, WebsetEnrichmentsClient, type WebsetEntity, type WebsetItem, type WebsetItemArticleProperties, type WebsetItemCompanyProperties, type WebsetItemCustomProperties, type WebsetItemEvaluation, WebsetItemEvaluationSatisfied, type WebsetItemPersonProperties, type WebsetItemResearchPaperProperties, WebsetItemSource, WebsetItemsClient, WebsetMonitorsClient, type WebsetPersonEntity, type WebsetResearchPaperEntity, type WebsetSearch, WebsetSearchBehavior, WebsetSearchCanceledReason, WebsetSearchStatus, WebsetSearchesClient, WebsetStatus, WebsetWebhooksClient, WebsetsClient, Exa as default };
+export { type AnswerOptions, type AnswerResponse, type AnswerStreamChunk, type AnswerStreamResponse, type BaseSearchOptions, type ContentsOptions, type ContentsResultComponent, type ContextOptions, type CostDollars, type CostDollarsContents, type CostDollarsSeearch, type CreateCriterionParameters, type CreateEnrichmentParameters, CreateEnrichmentParametersFormat, type CreateMonitorParameters, type CreateWebhookParameters, type CreateWebsetParameters, type CreateWebsetSearchParameters, type Default, type EnrichmentResult, type Event, EventType, EventsClient, Exa, ExaError, type ExtrasOptions, type ExtrasResponse, type FindSimilarOptions, type GetWebsetResponse, type HighlightsContentsOptions, type HighlightsResponse, HttpStatusCode, type JSONSchema, type ListEventsResponse, type ListMonitorRunsResponse, type ListMonitorsOptions, type ListMonitorsResponse, type SchemaListResearchTasksRequestDto as ListResearchTasksRequest, type SchemaListResearchTasksResponseDto as ListResearchTasksResponse, type ListWebhookAttemptsResponse, type ListWebhooksResponse, type ListWebsetItemResponse, type ListWebsetsResponse, type LivecrawlOptions, type Monitor, type MonitorBehaviorRefresh, type MonitorBehaviorSearch, type MonitorCadence, MonitorObject, type MonitorRefreshBehaviorContentsConfig, type MonitorRefreshBehaviorEnrichmentsConfig, type MonitorRun, MonitorRunObject, MonitorRunStatus, MonitorRunType, MonitorStatus, type RegularSearchOptions, ResearchClient, type SchemaResearchCreateTaskRequestDto as ResearchCreateTaskRequest, type SchemaResearchCreateTaskResponseDto as ResearchCreateTaskResponse, type SchemaResearchTaskDto as ResearchTask, type ResearchTaskEvent, type ResearchTaskOperation, type SearchResponse, type SearchResult, type Status, type SubpagesResponse, type SummaryContentsOptions, type SummaryResponse, type TextContentsOptions, type TextResponse, type UpdateMonitor, UpdateMonitorStatus, type UpdateWebhookParameters, type UpdateWebsetRequest, type Webhook, type WebhookAttempt, WebhookStatus, type Webset, type WebsetArticleEntity, type WebsetCompanyEntity, type WebsetCustomEntity, type WebsetEnrichment, WebsetEnrichmentFormat, WebsetEnrichmentStatus, WebsetEnrichmentsClient, type WebsetEntity, type WebsetItem, type WebsetItemArticleProperties, type WebsetItemCompanyProperties, type WebsetItemCustomProperties, type WebsetItemEvaluation, WebsetItemEvaluationSatisfied, type WebsetItemPersonProperties, type WebsetItemResearchPaperProperties, WebsetItemSource, WebsetItemsClient, WebsetMonitorsClient, type WebsetPersonEntity, type WebsetResearchPaperEntity, type WebsetSearch, WebsetSearchBehavior, WebsetSearchCanceledReason, WebsetSearchStatus, WebsetSearchesClient, WebsetStatus, WebsetWebhooksClient, WebsetsClient, Exa as default };