exa-js 1.8.11 → 1.8.12
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.d.mts +36 -75
- package/dist/index.d.ts +36 -75
- package/dist/index.js +1 -50
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +1 -46
- package/dist/index.mjs.map +1 -1
- package/package.json +1 -1
package/dist/index.d.mts
CHANGED
|
@@ -1749,7 +1749,7 @@ declare class ResearchClient extends ResearchBaseClient {
|
|
|
1749
1749
|
*/
|
|
1750
1750
|
createTask(params: {
|
|
1751
1751
|
instructions: string;
|
|
1752
|
-
model?: "exa-research" | "exa-research-pro"
|
|
1752
|
+
model?: "exa-research" | "exa-research-pro";
|
|
1753
1753
|
output?: {
|
|
1754
1754
|
inferSchema?: boolean;
|
|
1755
1755
|
schema?: JSONSchema;
|
|
@@ -1811,12 +1811,12 @@ interface components {
|
|
|
1811
1811
|
input: string;
|
|
1812
1812
|
instructions?: string;
|
|
1813
1813
|
/** @enum {string} */
|
|
1814
|
-
model:
|
|
1814
|
+
model: "exa-research" | "exa-research-pro";
|
|
1815
1815
|
stream?: boolean;
|
|
1816
1816
|
text?: {
|
|
1817
1817
|
format?: {
|
|
1818
1818
|
/** @enum {string} */
|
|
1819
|
-
type:
|
|
1819
|
+
type: "text";
|
|
1820
1820
|
} | {
|
|
1821
1821
|
description?: string;
|
|
1822
1822
|
name?: string;
|
|
@@ -1825,7 +1825,7 @@ interface components {
|
|
|
1825
1825
|
};
|
|
1826
1826
|
strict?: boolean;
|
|
1827
1827
|
/** @enum {string} */
|
|
1828
|
-
type:
|
|
1828
|
+
type: "json_schema";
|
|
1829
1829
|
};
|
|
1830
1830
|
};
|
|
1831
1831
|
};
|
|
@@ -1839,7 +1839,7 @@ interface components {
|
|
|
1839
1839
|
* @default exa-research
|
|
1840
1840
|
* @enum {string}
|
|
1841
1841
|
*/
|
|
1842
|
-
model:
|
|
1842
|
+
model: "exa-research" | "exa-research-pro";
|
|
1843
1843
|
output?: {
|
|
1844
1844
|
/**
|
|
1845
1845
|
* @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 {
|
|
|
1886
1886
|
/** @description The instructions or query for the research task */
|
|
1887
1887
|
instructions: string;
|
|
1888
1888
|
/** @enum {string} */
|
|
1889
|
-
model?:
|
|
1889
|
+
model?: "exa-research" | "exa-research-pro";
|
|
1890
1890
|
operations: ({
|
|
1891
1891
|
stepId: string;
|
|
1892
1892
|
/** @description Agent generated plan or reasoning for upcoming actions. */
|
|
1893
1893
|
text: string;
|
|
1894
1894
|
/** @enum {string} */
|
|
1895
|
-
type:
|
|
1895
|
+
type: "step-plan";
|
|
1896
1896
|
} | {
|
|
1897
1897
|
/** @description A completed subfield */
|
|
1898
1898
|
data: {
|
|
@@ -1900,7 +1900,7 @@ interface components {
|
|
|
1900
1900
|
};
|
|
1901
1901
|
stepId: string;
|
|
1902
1902
|
/** @enum {string} */
|
|
1903
|
-
type:
|
|
1903
|
+
type: "step-data";
|
|
1904
1904
|
} | {
|
|
1905
1905
|
/** @description What the agent hopes to find with this search query */
|
|
1906
1906
|
goal?: string;
|
|
@@ -1912,24 +1912,24 @@ interface components {
|
|
|
1912
1912
|
title?: string;
|
|
1913
1913
|
url: string;
|
|
1914
1914
|
/** @enum {number} */
|
|
1915
|
-
version:
|
|
1915
|
+
version: 1;
|
|
1916
1916
|
}[];
|
|
1917
1917
|
stepId: string;
|
|
1918
1918
|
/** @enum {string} */
|
|
1919
|
-
type:
|
|
1919
|
+
type: "search";
|
|
1920
1920
|
} | {
|
|
1921
1921
|
/** @description What the agent hopes to find with this crawl */
|
|
1922
1922
|
goal?: string;
|
|
1923
1923
|
stepId: string;
|
|
1924
1924
|
/** @enum {string} */
|
|
1925
|
-
type:
|
|
1925
|
+
type: "crawl";
|
|
1926
1926
|
url: string;
|
|
1927
1927
|
} | {
|
|
1928
1928
|
stepId: string;
|
|
1929
1929
|
/** @description Intermediate chain-of-thought style reasoning output */
|
|
1930
1930
|
thought: string;
|
|
1931
1931
|
/** @enum {string} */
|
|
1932
|
-
type:
|
|
1932
|
+
type: "think";
|
|
1933
1933
|
})[];
|
|
1934
1934
|
/** @description The JSON schema specification for the expected output format */
|
|
1935
1935
|
schema?: {
|
|
@@ -1939,7 +1939,7 @@ interface components {
|
|
|
1939
1939
|
* @description The current status of the research task
|
|
1940
1940
|
* @enum {string}
|
|
1941
1941
|
*/
|
|
1942
|
-
status:
|
|
1942
|
+
status: "running" | "completed" | "failed";
|
|
1943
1943
|
timeMs?: number;
|
|
1944
1944
|
};
|
|
1945
1945
|
ResearchTaskEventDto: {
|
|
@@ -1948,7 +1948,7 @@ interface components {
|
|
|
1948
1948
|
/** @description Agent generated plan or reasoning for upcoming actions. */
|
|
1949
1949
|
text: string;
|
|
1950
1950
|
/** @enum {string} */
|
|
1951
|
-
type:
|
|
1951
|
+
type: "step-plan";
|
|
1952
1952
|
} | {
|
|
1953
1953
|
/** @description A completed subfield */
|
|
1954
1954
|
data: {
|
|
@@ -1956,7 +1956,7 @@ interface components {
|
|
|
1956
1956
|
};
|
|
1957
1957
|
stepId: string;
|
|
1958
1958
|
/** @enum {string} */
|
|
1959
|
-
type:
|
|
1959
|
+
type: "step-data";
|
|
1960
1960
|
} | {
|
|
1961
1961
|
/** @description What the agent hopes to find with this search query */
|
|
1962
1962
|
goal?: string;
|
|
@@ -1968,27 +1968,27 @@ interface components {
|
|
|
1968
1968
|
title?: string;
|
|
1969
1969
|
url: string;
|
|
1970
1970
|
/** @enum {number} */
|
|
1971
|
-
version:
|
|
1971
|
+
version: 1;
|
|
1972
1972
|
}[];
|
|
1973
1973
|
stepId: string;
|
|
1974
1974
|
/** @enum {string} */
|
|
1975
|
-
type:
|
|
1975
|
+
type: "search";
|
|
1976
1976
|
} | {
|
|
1977
1977
|
/** @description What the agent hopes to find with this crawl */
|
|
1978
1978
|
goal?: string;
|
|
1979
1979
|
stepId: string;
|
|
1980
1980
|
/** @enum {string} */
|
|
1981
|
-
type:
|
|
1981
|
+
type: "crawl";
|
|
1982
1982
|
url: string;
|
|
1983
1983
|
} | {
|
|
1984
1984
|
stepId: string;
|
|
1985
1985
|
/** @description Intermediate chain-of-thought style reasoning output */
|
|
1986
1986
|
thought: string;
|
|
1987
1987
|
/** @enum {string} */
|
|
1988
|
-
type:
|
|
1988
|
+
type: "think";
|
|
1989
1989
|
};
|
|
1990
1990
|
/** @enum {string} */
|
|
1991
|
-
type:
|
|
1991
|
+
type: "operation";
|
|
1992
1992
|
} | {
|
|
1993
1993
|
task: {
|
|
1994
1994
|
/** @description Citations grouped by the root field they were used in */
|
|
@@ -2019,13 +2019,13 @@ interface components {
|
|
|
2019
2019
|
/** @description The instructions or query for the research task */
|
|
2020
2020
|
instructions: string;
|
|
2021
2021
|
/** @enum {string} */
|
|
2022
|
-
model?:
|
|
2022
|
+
model?: "exa-research" | "exa-research-pro";
|
|
2023
2023
|
operations: ({
|
|
2024
2024
|
stepId: string;
|
|
2025
2025
|
/** @description Agent generated plan or reasoning for upcoming actions. */
|
|
2026
2026
|
text: string;
|
|
2027
2027
|
/** @enum {string} */
|
|
2028
|
-
type:
|
|
2028
|
+
type: "step-plan";
|
|
2029
2029
|
} | {
|
|
2030
2030
|
/** @description A completed subfield */
|
|
2031
2031
|
data: {
|
|
@@ -2033,7 +2033,7 @@ interface components {
|
|
|
2033
2033
|
};
|
|
2034
2034
|
stepId: string;
|
|
2035
2035
|
/** @enum {string} */
|
|
2036
|
-
type:
|
|
2036
|
+
type: "step-data";
|
|
2037
2037
|
} | {
|
|
2038
2038
|
/** @description What the agent hopes to find with this search query */
|
|
2039
2039
|
goal?: string;
|
|
@@ -2045,24 +2045,24 @@ interface components {
|
|
|
2045
2045
|
title?: string;
|
|
2046
2046
|
url: string;
|
|
2047
2047
|
/** @enum {number} */
|
|
2048
|
-
version:
|
|
2048
|
+
version: 1;
|
|
2049
2049
|
}[];
|
|
2050
2050
|
stepId: string;
|
|
2051
2051
|
/** @enum {string} */
|
|
2052
|
-
type:
|
|
2052
|
+
type: "search";
|
|
2053
2053
|
} | {
|
|
2054
2054
|
/** @description What the agent hopes to find with this crawl */
|
|
2055
2055
|
goal?: string;
|
|
2056
2056
|
stepId: string;
|
|
2057
2057
|
/** @enum {string} */
|
|
2058
|
-
type:
|
|
2058
|
+
type: "crawl";
|
|
2059
2059
|
url: string;
|
|
2060
2060
|
} | {
|
|
2061
2061
|
stepId: string;
|
|
2062
2062
|
/** @description Intermediate chain-of-thought style reasoning output */
|
|
2063
2063
|
thought: string;
|
|
2064
2064
|
/** @enum {string} */
|
|
2065
|
-
type:
|
|
2065
|
+
type: "think";
|
|
2066
2066
|
})[];
|
|
2067
2067
|
/** @description The JSON schema specification for the expected output format */
|
|
2068
2068
|
schema?: {
|
|
@@ -2072,18 +2072,18 @@ interface components {
|
|
|
2072
2072
|
* @description The current status of the research task
|
|
2073
2073
|
* @enum {string}
|
|
2074
2074
|
*/
|
|
2075
|
-
status:
|
|
2075
|
+
status: "running" | "completed" | "failed";
|
|
2076
2076
|
timeMs?: number;
|
|
2077
2077
|
};
|
|
2078
2078
|
/** @enum {string} */
|
|
2079
|
-
type:
|
|
2079
|
+
type: "completed";
|
|
2080
2080
|
};
|
|
2081
2081
|
ResearchTaskOperationDto: {
|
|
2082
2082
|
stepId: string;
|
|
2083
2083
|
/** @description Agent generated plan or reasoning for upcoming actions. */
|
|
2084
2084
|
text: string;
|
|
2085
2085
|
/** @enum {string} */
|
|
2086
|
-
type:
|
|
2086
|
+
type: "step-plan";
|
|
2087
2087
|
} | {
|
|
2088
2088
|
/** @description A completed subfield */
|
|
2089
2089
|
data: {
|
|
@@ -2091,7 +2091,7 @@ interface components {
|
|
|
2091
2091
|
};
|
|
2092
2092
|
stepId: string;
|
|
2093
2093
|
/** @enum {string} */
|
|
2094
|
-
type:
|
|
2094
|
+
type: "step-data";
|
|
2095
2095
|
} | {
|
|
2096
2096
|
/** @description What the agent hopes to find with this search query */
|
|
2097
2097
|
goal?: string;
|
|
@@ -2103,24 +2103,24 @@ interface components {
|
|
|
2103
2103
|
title?: string;
|
|
2104
2104
|
url: string;
|
|
2105
2105
|
/** @enum {number} */
|
|
2106
|
-
version:
|
|
2106
|
+
version: 1;
|
|
2107
2107
|
}[];
|
|
2108
2108
|
stepId: string;
|
|
2109
2109
|
/** @enum {string} */
|
|
2110
|
-
type:
|
|
2110
|
+
type: "search";
|
|
2111
2111
|
} | {
|
|
2112
2112
|
/** @description What the agent hopes to find with this crawl */
|
|
2113
2113
|
goal?: string;
|
|
2114
2114
|
stepId: string;
|
|
2115
2115
|
/** @enum {string} */
|
|
2116
|
-
type:
|
|
2116
|
+
type: "crawl";
|
|
2117
2117
|
url: string;
|
|
2118
2118
|
} | {
|
|
2119
2119
|
stepId: string;
|
|
2120
2120
|
/** @description Intermediate chain-of-thought style reasoning output */
|
|
2121
2121
|
thought: string;
|
|
2122
2122
|
/** @enum {string} */
|
|
2123
|
-
type:
|
|
2123
|
+
type: "think";
|
|
2124
2124
|
};
|
|
2125
2125
|
};
|
|
2126
2126
|
responses: never;
|
|
@@ -2134,45 +2134,6 @@ type SchemaListResearchTasksResponseDto = components["schemas"]["ListResearchTas
|
|
|
2134
2134
|
type SchemaResearchCreateTaskRequestDto = components["schemas"]["ResearchCreateTaskRequestDto"];
|
|
2135
2135
|
type SchemaResearchCreateTaskResponseDto = components["schemas"]["ResearchCreateTaskResponseDto"];
|
|
2136
2136
|
type SchemaResearchTaskDto = components["schemas"]["ResearchTaskDto"];
|
|
2137
|
-
declare enum ResearchCreateOpenAIResponseDtoModel {
|
|
2138
|
-
exa_research = "exa-research",
|
|
2139
|
-
exa_research_pro = "exa-research-pro"
|
|
2140
|
-
}
|
|
2141
|
-
declare enum ResearchCreateOpenAIResponseDtoTextFormatType {
|
|
2142
|
-
text = "text"
|
|
2143
|
-
}
|
|
2144
|
-
declare enum ResearchCreateOpenAIResponseDtoTextFormatType {
|
|
2145
|
-
json_schema = "json_schema"
|
|
2146
|
-
}
|
|
2147
|
-
declare enum ResearchTaskDtoOperationsResultsVersion {
|
|
2148
|
-
Value1 = 1
|
|
2149
|
-
}
|
|
2150
|
-
declare enum ResearchTaskDtoOperationsType {
|
|
2151
|
-
step_plan = "step-plan"
|
|
2152
|
-
}
|
|
2153
|
-
declare enum ResearchTaskDtoOperationsType {
|
|
2154
|
-
step_data = "step-data"
|
|
2155
|
-
}
|
|
2156
|
-
declare enum ResearchTaskDtoOperationsType {
|
|
2157
|
-
search = "search"
|
|
2158
|
-
}
|
|
2159
|
-
declare enum ResearchTaskDtoOperationsType {
|
|
2160
|
-
crawl = "crawl"
|
|
2161
|
-
}
|
|
2162
|
-
declare enum ResearchTaskDtoOperationsType {
|
|
2163
|
-
think = "think"
|
|
2164
|
-
}
|
|
2165
|
-
declare enum ResearchTaskDtoStatus {
|
|
2166
|
-
running = "running",
|
|
2167
|
-
completed = "completed",
|
|
2168
|
-
failed = "failed"
|
|
2169
|
-
}
|
|
2170
|
-
declare enum ResearchTaskEventDtoType {
|
|
2171
|
-
operation = "operation"
|
|
2172
|
-
}
|
|
2173
|
-
declare enum ResearchTaskEventDtoType {
|
|
2174
|
-
completed = "completed"
|
|
2175
|
-
}
|
|
2176
2137
|
|
|
2177
2138
|
type ResearchTaskEvent = components["schemas"]["ResearchTaskEventDto"];
|
|
2178
2139
|
type ResearchTaskOperation = SchemaResearchTaskDto["operations"][0];
|
|
@@ -2673,4 +2634,4 @@ declare class Exa {
|
|
|
2673
2634
|
private parseSSEStream;
|
|
2674
2635
|
}
|
|
2675
2636
|
|
|
2676
|
-
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,
|
|
2637
|
+
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 };
|
package/dist/index.d.ts
CHANGED
|
@@ -1749,7 +1749,7 @@ declare class ResearchClient extends ResearchBaseClient {
|
|
|
1749
1749
|
*/
|
|
1750
1750
|
createTask(params: {
|
|
1751
1751
|
instructions: string;
|
|
1752
|
-
model?: "exa-research" | "exa-research-pro"
|
|
1752
|
+
model?: "exa-research" | "exa-research-pro";
|
|
1753
1753
|
output?: {
|
|
1754
1754
|
inferSchema?: boolean;
|
|
1755
1755
|
schema?: JSONSchema;
|
|
@@ -1811,12 +1811,12 @@ interface components {
|
|
|
1811
1811
|
input: string;
|
|
1812
1812
|
instructions?: string;
|
|
1813
1813
|
/** @enum {string} */
|
|
1814
|
-
model:
|
|
1814
|
+
model: "exa-research" | "exa-research-pro";
|
|
1815
1815
|
stream?: boolean;
|
|
1816
1816
|
text?: {
|
|
1817
1817
|
format?: {
|
|
1818
1818
|
/** @enum {string} */
|
|
1819
|
-
type:
|
|
1819
|
+
type: "text";
|
|
1820
1820
|
} | {
|
|
1821
1821
|
description?: string;
|
|
1822
1822
|
name?: string;
|
|
@@ -1825,7 +1825,7 @@ interface components {
|
|
|
1825
1825
|
};
|
|
1826
1826
|
strict?: boolean;
|
|
1827
1827
|
/** @enum {string} */
|
|
1828
|
-
type:
|
|
1828
|
+
type: "json_schema";
|
|
1829
1829
|
};
|
|
1830
1830
|
};
|
|
1831
1831
|
};
|
|
@@ -1839,7 +1839,7 @@ interface components {
|
|
|
1839
1839
|
* @default exa-research
|
|
1840
1840
|
* @enum {string}
|
|
1841
1841
|
*/
|
|
1842
|
-
model:
|
|
1842
|
+
model: "exa-research" | "exa-research-pro";
|
|
1843
1843
|
output?: {
|
|
1844
1844
|
/**
|
|
1845
1845
|
* @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 {
|
|
|
1886
1886
|
/** @description The instructions or query for the research task */
|
|
1887
1887
|
instructions: string;
|
|
1888
1888
|
/** @enum {string} */
|
|
1889
|
-
model?:
|
|
1889
|
+
model?: "exa-research" | "exa-research-pro";
|
|
1890
1890
|
operations: ({
|
|
1891
1891
|
stepId: string;
|
|
1892
1892
|
/** @description Agent generated plan or reasoning for upcoming actions. */
|
|
1893
1893
|
text: string;
|
|
1894
1894
|
/** @enum {string} */
|
|
1895
|
-
type:
|
|
1895
|
+
type: "step-plan";
|
|
1896
1896
|
} | {
|
|
1897
1897
|
/** @description A completed subfield */
|
|
1898
1898
|
data: {
|
|
@@ -1900,7 +1900,7 @@ interface components {
|
|
|
1900
1900
|
};
|
|
1901
1901
|
stepId: string;
|
|
1902
1902
|
/** @enum {string} */
|
|
1903
|
-
type:
|
|
1903
|
+
type: "step-data";
|
|
1904
1904
|
} | {
|
|
1905
1905
|
/** @description What the agent hopes to find with this search query */
|
|
1906
1906
|
goal?: string;
|
|
@@ -1912,24 +1912,24 @@ interface components {
|
|
|
1912
1912
|
title?: string;
|
|
1913
1913
|
url: string;
|
|
1914
1914
|
/** @enum {number} */
|
|
1915
|
-
version:
|
|
1915
|
+
version: 1;
|
|
1916
1916
|
}[];
|
|
1917
1917
|
stepId: string;
|
|
1918
1918
|
/** @enum {string} */
|
|
1919
|
-
type:
|
|
1919
|
+
type: "search";
|
|
1920
1920
|
} | {
|
|
1921
1921
|
/** @description What the agent hopes to find with this crawl */
|
|
1922
1922
|
goal?: string;
|
|
1923
1923
|
stepId: string;
|
|
1924
1924
|
/** @enum {string} */
|
|
1925
|
-
type:
|
|
1925
|
+
type: "crawl";
|
|
1926
1926
|
url: string;
|
|
1927
1927
|
} | {
|
|
1928
1928
|
stepId: string;
|
|
1929
1929
|
/** @description Intermediate chain-of-thought style reasoning output */
|
|
1930
1930
|
thought: string;
|
|
1931
1931
|
/** @enum {string} */
|
|
1932
|
-
type:
|
|
1932
|
+
type: "think";
|
|
1933
1933
|
})[];
|
|
1934
1934
|
/** @description The JSON schema specification for the expected output format */
|
|
1935
1935
|
schema?: {
|
|
@@ -1939,7 +1939,7 @@ interface components {
|
|
|
1939
1939
|
* @description The current status of the research task
|
|
1940
1940
|
* @enum {string}
|
|
1941
1941
|
*/
|
|
1942
|
-
status:
|
|
1942
|
+
status: "running" | "completed" | "failed";
|
|
1943
1943
|
timeMs?: number;
|
|
1944
1944
|
};
|
|
1945
1945
|
ResearchTaskEventDto: {
|
|
@@ -1948,7 +1948,7 @@ interface components {
|
|
|
1948
1948
|
/** @description Agent generated plan or reasoning for upcoming actions. */
|
|
1949
1949
|
text: string;
|
|
1950
1950
|
/** @enum {string} */
|
|
1951
|
-
type:
|
|
1951
|
+
type: "step-plan";
|
|
1952
1952
|
} | {
|
|
1953
1953
|
/** @description A completed subfield */
|
|
1954
1954
|
data: {
|
|
@@ -1956,7 +1956,7 @@ interface components {
|
|
|
1956
1956
|
};
|
|
1957
1957
|
stepId: string;
|
|
1958
1958
|
/** @enum {string} */
|
|
1959
|
-
type:
|
|
1959
|
+
type: "step-data";
|
|
1960
1960
|
} | {
|
|
1961
1961
|
/** @description What the agent hopes to find with this search query */
|
|
1962
1962
|
goal?: string;
|
|
@@ -1968,27 +1968,27 @@ interface components {
|
|
|
1968
1968
|
title?: string;
|
|
1969
1969
|
url: string;
|
|
1970
1970
|
/** @enum {number} */
|
|
1971
|
-
version:
|
|
1971
|
+
version: 1;
|
|
1972
1972
|
}[];
|
|
1973
1973
|
stepId: string;
|
|
1974
1974
|
/** @enum {string} */
|
|
1975
|
-
type:
|
|
1975
|
+
type: "search";
|
|
1976
1976
|
} | {
|
|
1977
1977
|
/** @description What the agent hopes to find with this crawl */
|
|
1978
1978
|
goal?: string;
|
|
1979
1979
|
stepId: string;
|
|
1980
1980
|
/** @enum {string} */
|
|
1981
|
-
type:
|
|
1981
|
+
type: "crawl";
|
|
1982
1982
|
url: string;
|
|
1983
1983
|
} | {
|
|
1984
1984
|
stepId: string;
|
|
1985
1985
|
/** @description Intermediate chain-of-thought style reasoning output */
|
|
1986
1986
|
thought: string;
|
|
1987
1987
|
/** @enum {string} */
|
|
1988
|
-
type:
|
|
1988
|
+
type: "think";
|
|
1989
1989
|
};
|
|
1990
1990
|
/** @enum {string} */
|
|
1991
|
-
type:
|
|
1991
|
+
type: "operation";
|
|
1992
1992
|
} | {
|
|
1993
1993
|
task: {
|
|
1994
1994
|
/** @description Citations grouped by the root field they were used in */
|
|
@@ -2019,13 +2019,13 @@ interface components {
|
|
|
2019
2019
|
/** @description The instructions or query for the research task */
|
|
2020
2020
|
instructions: string;
|
|
2021
2021
|
/** @enum {string} */
|
|
2022
|
-
model?:
|
|
2022
|
+
model?: "exa-research" | "exa-research-pro";
|
|
2023
2023
|
operations: ({
|
|
2024
2024
|
stepId: string;
|
|
2025
2025
|
/** @description Agent generated plan or reasoning for upcoming actions. */
|
|
2026
2026
|
text: string;
|
|
2027
2027
|
/** @enum {string} */
|
|
2028
|
-
type:
|
|
2028
|
+
type: "step-plan";
|
|
2029
2029
|
} | {
|
|
2030
2030
|
/** @description A completed subfield */
|
|
2031
2031
|
data: {
|
|
@@ -2033,7 +2033,7 @@ interface components {
|
|
|
2033
2033
|
};
|
|
2034
2034
|
stepId: string;
|
|
2035
2035
|
/** @enum {string} */
|
|
2036
|
-
type:
|
|
2036
|
+
type: "step-data";
|
|
2037
2037
|
} | {
|
|
2038
2038
|
/** @description What the agent hopes to find with this search query */
|
|
2039
2039
|
goal?: string;
|
|
@@ -2045,24 +2045,24 @@ interface components {
|
|
|
2045
2045
|
title?: string;
|
|
2046
2046
|
url: string;
|
|
2047
2047
|
/** @enum {number} */
|
|
2048
|
-
version:
|
|
2048
|
+
version: 1;
|
|
2049
2049
|
}[];
|
|
2050
2050
|
stepId: string;
|
|
2051
2051
|
/** @enum {string} */
|
|
2052
|
-
type:
|
|
2052
|
+
type: "search";
|
|
2053
2053
|
} | {
|
|
2054
2054
|
/** @description What the agent hopes to find with this crawl */
|
|
2055
2055
|
goal?: string;
|
|
2056
2056
|
stepId: string;
|
|
2057
2057
|
/** @enum {string} */
|
|
2058
|
-
type:
|
|
2058
|
+
type: "crawl";
|
|
2059
2059
|
url: string;
|
|
2060
2060
|
} | {
|
|
2061
2061
|
stepId: string;
|
|
2062
2062
|
/** @description Intermediate chain-of-thought style reasoning output */
|
|
2063
2063
|
thought: string;
|
|
2064
2064
|
/** @enum {string} */
|
|
2065
|
-
type:
|
|
2065
|
+
type: "think";
|
|
2066
2066
|
})[];
|
|
2067
2067
|
/** @description The JSON schema specification for the expected output format */
|
|
2068
2068
|
schema?: {
|
|
@@ -2072,18 +2072,18 @@ interface components {
|
|
|
2072
2072
|
* @description The current status of the research task
|
|
2073
2073
|
* @enum {string}
|
|
2074
2074
|
*/
|
|
2075
|
-
status:
|
|
2075
|
+
status: "running" | "completed" | "failed";
|
|
2076
2076
|
timeMs?: number;
|
|
2077
2077
|
};
|
|
2078
2078
|
/** @enum {string} */
|
|
2079
|
-
type:
|
|
2079
|
+
type: "completed";
|
|
2080
2080
|
};
|
|
2081
2081
|
ResearchTaskOperationDto: {
|
|
2082
2082
|
stepId: string;
|
|
2083
2083
|
/** @description Agent generated plan or reasoning for upcoming actions. */
|
|
2084
2084
|
text: string;
|
|
2085
2085
|
/** @enum {string} */
|
|
2086
|
-
type:
|
|
2086
|
+
type: "step-plan";
|
|
2087
2087
|
} | {
|
|
2088
2088
|
/** @description A completed subfield */
|
|
2089
2089
|
data: {
|
|
@@ -2091,7 +2091,7 @@ interface components {
|
|
|
2091
2091
|
};
|
|
2092
2092
|
stepId: string;
|
|
2093
2093
|
/** @enum {string} */
|
|
2094
|
-
type:
|
|
2094
|
+
type: "step-data";
|
|
2095
2095
|
} | {
|
|
2096
2096
|
/** @description What the agent hopes to find with this search query */
|
|
2097
2097
|
goal?: string;
|
|
@@ -2103,24 +2103,24 @@ interface components {
|
|
|
2103
2103
|
title?: string;
|
|
2104
2104
|
url: string;
|
|
2105
2105
|
/** @enum {number} */
|
|
2106
|
-
version:
|
|
2106
|
+
version: 1;
|
|
2107
2107
|
}[];
|
|
2108
2108
|
stepId: string;
|
|
2109
2109
|
/** @enum {string} */
|
|
2110
|
-
type:
|
|
2110
|
+
type: "search";
|
|
2111
2111
|
} | {
|
|
2112
2112
|
/** @description What the agent hopes to find with this crawl */
|
|
2113
2113
|
goal?: string;
|
|
2114
2114
|
stepId: string;
|
|
2115
2115
|
/** @enum {string} */
|
|
2116
|
-
type:
|
|
2116
|
+
type: "crawl";
|
|
2117
2117
|
url: string;
|
|
2118
2118
|
} | {
|
|
2119
2119
|
stepId: string;
|
|
2120
2120
|
/** @description Intermediate chain-of-thought style reasoning output */
|
|
2121
2121
|
thought: string;
|
|
2122
2122
|
/** @enum {string} */
|
|
2123
|
-
type:
|
|
2123
|
+
type: "think";
|
|
2124
2124
|
};
|
|
2125
2125
|
};
|
|
2126
2126
|
responses: never;
|
|
@@ -2134,45 +2134,6 @@ type SchemaListResearchTasksResponseDto = components["schemas"]["ListResearchTas
|
|
|
2134
2134
|
type SchemaResearchCreateTaskRequestDto = components["schemas"]["ResearchCreateTaskRequestDto"];
|
|
2135
2135
|
type SchemaResearchCreateTaskResponseDto = components["schemas"]["ResearchCreateTaskResponseDto"];
|
|
2136
2136
|
type SchemaResearchTaskDto = components["schemas"]["ResearchTaskDto"];
|
|
2137
|
-
declare enum ResearchCreateOpenAIResponseDtoModel {
|
|
2138
|
-
exa_research = "exa-research",
|
|
2139
|
-
exa_research_pro = "exa-research-pro"
|
|
2140
|
-
}
|
|
2141
|
-
declare enum ResearchCreateOpenAIResponseDtoTextFormatType {
|
|
2142
|
-
text = "text"
|
|
2143
|
-
}
|
|
2144
|
-
declare enum ResearchCreateOpenAIResponseDtoTextFormatType {
|
|
2145
|
-
json_schema = "json_schema"
|
|
2146
|
-
}
|
|
2147
|
-
declare enum ResearchTaskDtoOperationsResultsVersion {
|
|
2148
|
-
Value1 = 1
|
|
2149
|
-
}
|
|
2150
|
-
declare enum ResearchTaskDtoOperationsType {
|
|
2151
|
-
step_plan = "step-plan"
|
|
2152
|
-
}
|
|
2153
|
-
declare enum ResearchTaskDtoOperationsType {
|
|
2154
|
-
step_data = "step-data"
|
|
2155
|
-
}
|
|
2156
|
-
declare enum ResearchTaskDtoOperationsType {
|
|
2157
|
-
search = "search"
|
|
2158
|
-
}
|
|
2159
|
-
declare enum ResearchTaskDtoOperationsType {
|
|
2160
|
-
crawl = "crawl"
|
|
2161
|
-
}
|
|
2162
|
-
declare enum ResearchTaskDtoOperationsType {
|
|
2163
|
-
think = "think"
|
|
2164
|
-
}
|
|
2165
|
-
declare enum ResearchTaskDtoStatus {
|
|
2166
|
-
running = "running",
|
|
2167
|
-
completed = "completed",
|
|
2168
|
-
failed = "failed"
|
|
2169
|
-
}
|
|
2170
|
-
declare enum ResearchTaskEventDtoType {
|
|
2171
|
-
operation = "operation"
|
|
2172
|
-
}
|
|
2173
|
-
declare enum ResearchTaskEventDtoType {
|
|
2174
|
-
completed = "completed"
|
|
2175
|
-
}
|
|
2176
2137
|
|
|
2177
2138
|
type ResearchTaskEvent = components["schemas"]["ResearchTaskEventDto"];
|
|
2178
2139
|
type ResearchTaskOperation = SchemaResearchTaskDto["operations"][0];
|
|
@@ -2673,4 +2634,4 @@ declare class Exa {
|
|
|
2673
2634
|
private parseSSEStream;
|
|
2674
2635
|
}
|
|
2675
2636
|
|
|
2676
|
-
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,
|
|
2637
|
+
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 };
|