@mendable/firecrawl 4.13.0 → 4.13.1
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/{chunk-22A4MB4F.js → chunk-37UG5UXZ.js} +3 -2
- package/dist/index.cjs +15 -3
- package/dist/index.d.cts +16 -1
- package/dist/index.d.ts +16 -1
- package/dist/index.js +14 -3
- package/dist/{package-5SIMNZMX.js → package-JD6PB5ZT.js} +1 -1
- package/package.json +1 -1
- package/src/v1/index.ts +6 -1
- package/src/v2/client.ts +6 -0
- package/src/v2/methods/extract.ts +16 -0
|
@@ -8,7 +8,7 @@ var require_package = __commonJS({
|
|
|
8
8
|
"package.json"(exports, module) {
|
|
9
9
|
module.exports = {
|
|
10
10
|
name: "@mendable/firecrawl-js",
|
|
11
|
-
version: "4.13.
|
|
11
|
+
version: "4.13.1",
|
|
12
12
|
description: "JavaScript SDK for Firecrawl API",
|
|
13
13
|
main: "dist/index.js",
|
|
14
14
|
types: "dist/index.d.ts",
|
|
@@ -71,7 +71,8 @@ var require_package = __commonJS({
|
|
|
71
71
|
},
|
|
72
72
|
pnpm: {
|
|
73
73
|
overrides: {
|
|
74
|
-
"@isaacs/brace-expansion@<=5.0.0": ">=5.0.1"
|
|
74
|
+
"@isaacs/brace-expansion@<=5.0.0": ">=5.0.1",
|
|
75
|
+
"minimatch@<10.2.1": ">=10.2.1"
|
|
75
76
|
}
|
|
76
77
|
}
|
|
77
78
|
};
|
package/dist/index.cjs
CHANGED
|
@@ -35,7 +35,7 @@ var require_package = __commonJS({
|
|
|
35
35
|
"package.json"(exports2, module2) {
|
|
36
36
|
module2.exports = {
|
|
37
37
|
name: "@mendable/firecrawl-js",
|
|
38
|
-
version: "4.13.
|
|
38
|
+
version: "4.13.1",
|
|
39
39
|
description: "JavaScript SDK for Firecrawl API",
|
|
40
40
|
main: "dist/index.js",
|
|
41
41
|
types: "dist/index.d.ts",
|
|
@@ -98,7 +98,8 @@ var require_package = __commonJS({
|
|
|
98
98
|
},
|
|
99
99
|
pnpm: {
|
|
100
100
|
overrides: {
|
|
101
|
-
"@isaacs/brace-expansion@<=5.0.0": ">=5.0.1"
|
|
101
|
+
"@isaacs/brace-expansion@<=5.0.0": ">=5.0.1",
|
|
102
|
+
"minimatch@<10.2.1": ">=10.2.1"
|
|
102
103
|
}
|
|
103
104
|
}
|
|
104
105
|
};
|
|
@@ -1428,6 +1429,8 @@ var FirecrawlClient = class {
|
|
|
1428
1429
|
* Start an extract job (async).
|
|
1429
1430
|
* @param args Extraction request (urls, schema or prompt, flags).
|
|
1430
1431
|
* @returns Job id or processing state.
|
|
1432
|
+
* @deprecated The extract endpoint is in maintenance mode and its use is discouraged.
|
|
1433
|
+
* Review https://docs.firecrawl.dev/developer-guides/usage-guides/choosing-the-data-extractor to find a replacement.
|
|
1431
1434
|
*/
|
|
1432
1435
|
async startExtract(args) {
|
|
1433
1436
|
return startExtract(this.http, args);
|
|
@@ -1435,6 +1438,8 @@ var FirecrawlClient = class {
|
|
|
1435
1438
|
/**
|
|
1436
1439
|
* Get extract job status/data.
|
|
1437
1440
|
* @param jobId Extract job id.
|
|
1441
|
+
* @deprecated The extract endpoint is in maintenance mode and its use is discouraged.
|
|
1442
|
+
* Review https://docs.firecrawl.dev/developer-guides/usage-guides/choosing-the-data-extractor to find a replacement.
|
|
1438
1443
|
*/
|
|
1439
1444
|
async getExtractStatus(jobId) {
|
|
1440
1445
|
return getExtractStatus(this.http, jobId);
|
|
@@ -1443,6 +1448,8 @@ var FirecrawlClient = class {
|
|
|
1443
1448
|
* Convenience waiter: start an extract and poll until it finishes.
|
|
1444
1449
|
* @param args Extraction request plus waiter controls (pollInterval, timeout seconds).
|
|
1445
1450
|
* @returns Final extract response.
|
|
1451
|
+
* @deprecated The extract endpoint is in maintenance mode and its use is discouraged.
|
|
1452
|
+
* Review https://docs.firecrawl.dev/developer-guides/usage-guides/choosing-the-data-extractor to find a replacement.
|
|
1446
1453
|
*/
|
|
1447
1454
|
async extract(args) {
|
|
1448
1455
|
return extract(this.http, args);
|
|
@@ -2122,10 +2129,11 @@ var FirecrawlApp = class {
|
|
|
2122
2129
|
}
|
|
2123
2130
|
/**
|
|
2124
2131
|
* Extracts information from URLs using the Firecrawl API.
|
|
2125
|
-
* Currently in Beta. Expect breaking changes on future minor versions.
|
|
2126
2132
|
* @param urls - The URLs to extract information from. Optional if using other methods for data extraction.
|
|
2127
2133
|
* @param params - Additional parameters for the extract request.
|
|
2128
2134
|
* @returns The response from the extract operation.
|
|
2135
|
+
* @deprecated The extract endpoint is in maintenance mode and its use is discouraged.
|
|
2136
|
+
* Review https://docs.firecrawl.dev/developer-guides/usage-guides/choosing-the-data-extractor to find a replacement.
|
|
2129
2137
|
*/
|
|
2130
2138
|
async extract(urls, params) {
|
|
2131
2139
|
const headers = this.prepareHeaders();
|
|
@@ -2177,6 +2185,8 @@ var FirecrawlApp = class {
|
|
|
2177
2185
|
* @param params - Additional parameters for the extract request.
|
|
2178
2186
|
* @param idempotencyKey - Optional idempotency key for the request.
|
|
2179
2187
|
* @returns The response from the extract operation.
|
|
2188
|
+
* @deprecated The extract endpoint is in maintenance mode and its use is discouraged.
|
|
2189
|
+
* Review https://docs.firecrawl.dev/developer-guides/usage-guides/choosing-the-data-extractor to find a replacement.
|
|
2180
2190
|
*/
|
|
2181
2191
|
async asyncExtract(urls, params, idempotencyKey) {
|
|
2182
2192
|
const headers = this.prepareHeaders(idempotencyKey);
|
|
@@ -2202,6 +2212,8 @@ var FirecrawlApp = class {
|
|
|
2202
2212
|
* Retrieves the status of an extract job.
|
|
2203
2213
|
* @param jobId - The ID of the extract job.
|
|
2204
2214
|
* @returns The status of the extract job.
|
|
2215
|
+
* @deprecated The extract endpoint is in maintenance mode and its use is discouraged.
|
|
2216
|
+
* Review https://docs.firecrawl.dev/developer-guides/usage-guides/choosing-the-data-extractor to find a replacement.
|
|
2205
2217
|
*/
|
|
2206
2218
|
async getExtractStatus(jobId) {
|
|
2207
2219
|
try {
|
package/dist/index.d.cts
CHANGED
|
@@ -629,6 +629,10 @@ declare function prepareExtractPayload(args: {
|
|
|
629
629
|
integration?: string;
|
|
630
630
|
agent?: AgentOptions$1;
|
|
631
631
|
}): Record<string, unknown>;
|
|
632
|
+
/**
|
|
633
|
+
* @deprecated The extract endpoint is in maintenance mode and its use is discouraged.
|
|
634
|
+
* Review https://docs.firecrawl.dev/developer-guides/usage-guides/choosing-the-data-extractor to find a replacement.
|
|
635
|
+
*/
|
|
632
636
|
declare function startExtract(http: HttpClient, args: Parameters<typeof prepareExtractPayload>[0]): Promise<ExtractResponse$1>;
|
|
633
637
|
|
|
634
638
|
declare function prepareAgentPayload(args: {
|
|
@@ -820,17 +824,23 @@ declare class FirecrawlClient {
|
|
|
820
824
|
* Start an extract job (async).
|
|
821
825
|
* @param args Extraction request (urls, schema or prompt, flags).
|
|
822
826
|
* @returns Job id or processing state.
|
|
827
|
+
* @deprecated The extract endpoint is in maintenance mode and its use is discouraged.
|
|
828
|
+
* Review https://docs.firecrawl.dev/developer-guides/usage-guides/choosing-the-data-extractor to find a replacement.
|
|
823
829
|
*/
|
|
824
830
|
startExtract(args: Parameters<typeof startExtract>[1]): Promise<ExtractResponse$1>;
|
|
825
831
|
/**
|
|
826
832
|
* Get extract job status/data.
|
|
827
833
|
* @param jobId Extract job id.
|
|
834
|
+
* @deprecated The extract endpoint is in maintenance mode and its use is discouraged.
|
|
835
|
+
* Review https://docs.firecrawl.dev/developer-guides/usage-guides/choosing-the-data-extractor to find a replacement.
|
|
828
836
|
*/
|
|
829
837
|
getExtractStatus(jobId: string): Promise<ExtractResponse$1>;
|
|
830
838
|
/**
|
|
831
839
|
* Convenience waiter: start an extract and poll until it finishes.
|
|
832
840
|
* @param args Extraction request plus waiter controls (pollInterval, timeout seconds).
|
|
833
841
|
* @returns Final extract response.
|
|
842
|
+
* @deprecated The extract endpoint is in maintenance mode and its use is discouraged.
|
|
843
|
+
* Review https://docs.firecrawl.dev/developer-guides/usage-guides/choosing-the-data-extractor to find a replacement.
|
|
834
844
|
*/
|
|
835
845
|
extract(args: Parameters<typeof startExtract>[1] & {
|
|
836
846
|
pollInterval?: number;
|
|
@@ -1599,10 +1609,11 @@ declare class FirecrawlApp {
|
|
|
1599
1609
|
checkBatchScrapeErrors(id: string): Promise<CrawlErrorsResponse | ErrorResponse>;
|
|
1600
1610
|
/**
|
|
1601
1611
|
* Extracts information from URLs using the Firecrawl API.
|
|
1602
|
-
* Currently in Beta. Expect breaking changes on future minor versions.
|
|
1603
1612
|
* @param urls - The URLs to extract information from. Optional if using other methods for data extraction.
|
|
1604
1613
|
* @param params - Additional parameters for the extract request.
|
|
1605
1614
|
* @returns The response from the extract operation.
|
|
1615
|
+
* @deprecated The extract endpoint is in maintenance mode and its use is discouraged.
|
|
1616
|
+
* Review https://docs.firecrawl.dev/developer-guides/usage-guides/choosing-the-data-extractor to find a replacement.
|
|
1606
1617
|
*/
|
|
1607
1618
|
extract<T extends zt.ZodSchema = any>(urls?: string[], params?: ExtractParams<T>): Promise<ExtractResponse<zt.infer<T>> | ErrorResponse>;
|
|
1608
1619
|
/**
|
|
@@ -1611,12 +1622,16 @@ declare class FirecrawlApp {
|
|
|
1611
1622
|
* @param params - Additional parameters for the extract request.
|
|
1612
1623
|
* @param idempotencyKey - Optional idempotency key for the request.
|
|
1613
1624
|
* @returns The response from the extract operation.
|
|
1625
|
+
* @deprecated The extract endpoint is in maintenance mode and its use is discouraged.
|
|
1626
|
+
* Review https://docs.firecrawl.dev/developer-guides/usage-guides/choosing-the-data-extractor to find a replacement.
|
|
1614
1627
|
*/
|
|
1615
1628
|
asyncExtract(urls: string[], params?: ExtractParams, idempotencyKey?: string): Promise<ExtractResponse | ErrorResponse>;
|
|
1616
1629
|
/**
|
|
1617
1630
|
* Retrieves the status of an extract job.
|
|
1618
1631
|
* @param jobId - The ID of the extract job.
|
|
1619
1632
|
* @returns The status of the extract job.
|
|
1633
|
+
* @deprecated The extract endpoint is in maintenance mode and its use is discouraged.
|
|
1634
|
+
* Review https://docs.firecrawl.dev/developer-guides/usage-guides/choosing-the-data-extractor to find a replacement.
|
|
1620
1635
|
*/
|
|
1621
1636
|
getExtractStatus(jobId: string): Promise<any>;
|
|
1622
1637
|
/**
|
package/dist/index.d.ts
CHANGED
|
@@ -629,6 +629,10 @@ declare function prepareExtractPayload(args: {
|
|
|
629
629
|
integration?: string;
|
|
630
630
|
agent?: AgentOptions$1;
|
|
631
631
|
}): Record<string, unknown>;
|
|
632
|
+
/**
|
|
633
|
+
* @deprecated The extract endpoint is in maintenance mode and its use is discouraged.
|
|
634
|
+
* Review https://docs.firecrawl.dev/developer-guides/usage-guides/choosing-the-data-extractor to find a replacement.
|
|
635
|
+
*/
|
|
632
636
|
declare function startExtract(http: HttpClient, args: Parameters<typeof prepareExtractPayload>[0]): Promise<ExtractResponse$1>;
|
|
633
637
|
|
|
634
638
|
declare function prepareAgentPayload(args: {
|
|
@@ -820,17 +824,23 @@ declare class FirecrawlClient {
|
|
|
820
824
|
* Start an extract job (async).
|
|
821
825
|
* @param args Extraction request (urls, schema or prompt, flags).
|
|
822
826
|
* @returns Job id or processing state.
|
|
827
|
+
* @deprecated The extract endpoint is in maintenance mode and its use is discouraged.
|
|
828
|
+
* Review https://docs.firecrawl.dev/developer-guides/usage-guides/choosing-the-data-extractor to find a replacement.
|
|
823
829
|
*/
|
|
824
830
|
startExtract(args: Parameters<typeof startExtract>[1]): Promise<ExtractResponse$1>;
|
|
825
831
|
/**
|
|
826
832
|
* Get extract job status/data.
|
|
827
833
|
* @param jobId Extract job id.
|
|
834
|
+
* @deprecated The extract endpoint is in maintenance mode and its use is discouraged.
|
|
835
|
+
* Review https://docs.firecrawl.dev/developer-guides/usage-guides/choosing-the-data-extractor to find a replacement.
|
|
828
836
|
*/
|
|
829
837
|
getExtractStatus(jobId: string): Promise<ExtractResponse$1>;
|
|
830
838
|
/**
|
|
831
839
|
* Convenience waiter: start an extract and poll until it finishes.
|
|
832
840
|
* @param args Extraction request plus waiter controls (pollInterval, timeout seconds).
|
|
833
841
|
* @returns Final extract response.
|
|
842
|
+
* @deprecated The extract endpoint is in maintenance mode and its use is discouraged.
|
|
843
|
+
* Review https://docs.firecrawl.dev/developer-guides/usage-guides/choosing-the-data-extractor to find a replacement.
|
|
834
844
|
*/
|
|
835
845
|
extract(args: Parameters<typeof startExtract>[1] & {
|
|
836
846
|
pollInterval?: number;
|
|
@@ -1599,10 +1609,11 @@ declare class FirecrawlApp {
|
|
|
1599
1609
|
checkBatchScrapeErrors(id: string): Promise<CrawlErrorsResponse | ErrorResponse>;
|
|
1600
1610
|
/**
|
|
1601
1611
|
* Extracts information from URLs using the Firecrawl API.
|
|
1602
|
-
* Currently in Beta. Expect breaking changes on future minor versions.
|
|
1603
1612
|
* @param urls - The URLs to extract information from. Optional if using other methods for data extraction.
|
|
1604
1613
|
* @param params - Additional parameters for the extract request.
|
|
1605
1614
|
* @returns The response from the extract operation.
|
|
1615
|
+
* @deprecated The extract endpoint is in maintenance mode and its use is discouraged.
|
|
1616
|
+
* Review https://docs.firecrawl.dev/developer-guides/usage-guides/choosing-the-data-extractor to find a replacement.
|
|
1606
1617
|
*/
|
|
1607
1618
|
extract<T extends zt.ZodSchema = any>(urls?: string[], params?: ExtractParams<T>): Promise<ExtractResponse<zt.infer<T>> | ErrorResponse>;
|
|
1608
1619
|
/**
|
|
@@ -1611,12 +1622,16 @@ declare class FirecrawlApp {
|
|
|
1611
1622
|
* @param params - Additional parameters for the extract request.
|
|
1612
1623
|
* @param idempotencyKey - Optional idempotency key for the request.
|
|
1613
1624
|
* @returns The response from the extract operation.
|
|
1625
|
+
* @deprecated The extract endpoint is in maintenance mode and its use is discouraged.
|
|
1626
|
+
* Review https://docs.firecrawl.dev/developer-guides/usage-guides/choosing-the-data-extractor to find a replacement.
|
|
1614
1627
|
*/
|
|
1615
1628
|
asyncExtract(urls: string[], params?: ExtractParams, idempotencyKey?: string): Promise<ExtractResponse | ErrorResponse>;
|
|
1616
1629
|
/**
|
|
1617
1630
|
* Retrieves the status of an extract job.
|
|
1618
1631
|
* @param jobId - The ID of the extract job.
|
|
1619
1632
|
* @returns The status of the extract job.
|
|
1633
|
+
* @deprecated The extract endpoint is in maintenance mode and its use is discouraged.
|
|
1634
|
+
* Review https://docs.firecrawl.dev/developer-guides/usage-guides/choosing-the-data-extractor to find a replacement.
|
|
1620
1635
|
*/
|
|
1621
1636
|
getExtractStatus(jobId: string): Promise<any>;
|
|
1622
1637
|
/**
|
package/dist/index.js
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import {
|
|
2
2
|
require_package
|
|
3
|
-
} from "./chunk-
|
|
3
|
+
} from "./chunk-37UG5UXZ.js";
|
|
4
4
|
|
|
5
5
|
// src/v2/utils/httpClient.ts
|
|
6
6
|
import axios from "axios";
|
|
@@ -1312,6 +1312,8 @@ var FirecrawlClient = class {
|
|
|
1312
1312
|
* Start an extract job (async).
|
|
1313
1313
|
* @param args Extraction request (urls, schema or prompt, flags).
|
|
1314
1314
|
* @returns Job id or processing state.
|
|
1315
|
+
* @deprecated The extract endpoint is in maintenance mode and its use is discouraged.
|
|
1316
|
+
* Review https://docs.firecrawl.dev/developer-guides/usage-guides/choosing-the-data-extractor to find a replacement.
|
|
1315
1317
|
*/
|
|
1316
1318
|
async startExtract(args) {
|
|
1317
1319
|
return startExtract(this.http, args);
|
|
@@ -1319,6 +1321,8 @@ var FirecrawlClient = class {
|
|
|
1319
1321
|
/**
|
|
1320
1322
|
* Get extract job status/data.
|
|
1321
1323
|
* @param jobId Extract job id.
|
|
1324
|
+
* @deprecated The extract endpoint is in maintenance mode and its use is discouraged.
|
|
1325
|
+
* Review https://docs.firecrawl.dev/developer-guides/usage-guides/choosing-the-data-extractor to find a replacement.
|
|
1322
1326
|
*/
|
|
1323
1327
|
async getExtractStatus(jobId) {
|
|
1324
1328
|
return getExtractStatus(this.http, jobId);
|
|
@@ -1327,6 +1331,8 @@ var FirecrawlClient = class {
|
|
|
1327
1331
|
* Convenience waiter: start an extract and poll until it finishes.
|
|
1328
1332
|
* @param args Extraction request plus waiter controls (pollInterval, timeout seconds).
|
|
1329
1333
|
* @returns Final extract response.
|
|
1334
|
+
* @deprecated The extract endpoint is in maintenance mode and its use is discouraged.
|
|
1335
|
+
* Review https://docs.firecrawl.dev/developer-guides/usage-guides/choosing-the-data-extractor to find a replacement.
|
|
1330
1336
|
*/
|
|
1331
1337
|
async extract(args) {
|
|
1332
1338
|
return extract(this.http, args);
|
|
@@ -1465,7 +1471,7 @@ var FirecrawlApp = class {
|
|
|
1465
1471
|
if (typeof process !== "undefined" && process.env && process.env.npm_package_version) {
|
|
1466
1472
|
return process.env.npm_package_version;
|
|
1467
1473
|
}
|
|
1468
|
-
const packageJson = await import("./package-
|
|
1474
|
+
const packageJson = await import("./package-JD6PB5ZT.js");
|
|
1469
1475
|
return packageJson.default.version;
|
|
1470
1476
|
} catch (error) {
|
|
1471
1477
|
const isTest = typeof process !== "undefined" && (process.env.JEST_WORKER_ID != null || false);
|
|
@@ -2006,10 +2012,11 @@ var FirecrawlApp = class {
|
|
|
2006
2012
|
}
|
|
2007
2013
|
/**
|
|
2008
2014
|
* Extracts information from URLs using the Firecrawl API.
|
|
2009
|
-
* Currently in Beta. Expect breaking changes on future minor versions.
|
|
2010
2015
|
* @param urls - The URLs to extract information from. Optional if using other methods for data extraction.
|
|
2011
2016
|
* @param params - Additional parameters for the extract request.
|
|
2012
2017
|
* @returns The response from the extract operation.
|
|
2018
|
+
* @deprecated The extract endpoint is in maintenance mode and its use is discouraged.
|
|
2019
|
+
* Review https://docs.firecrawl.dev/developer-guides/usage-guides/choosing-the-data-extractor to find a replacement.
|
|
2013
2020
|
*/
|
|
2014
2021
|
async extract(urls, params) {
|
|
2015
2022
|
const headers = this.prepareHeaders();
|
|
@@ -2061,6 +2068,8 @@ var FirecrawlApp = class {
|
|
|
2061
2068
|
* @param params - Additional parameters for the extract request.
|
|
2062
2069
|
* @param idempotencyKey - Optional idempotency key for the request.
|
|
2063
2070
|
* @returns The response from the extract operation.
|
|
2071
|
+
* @deprecated The extract endpoint is in maintenance mode and its use is discouraged.
|
|
2072
|
+
* Review https://docs.firecrawl.dev/developer-guides/usage-guides/choosing-the-data-extractor to find a replacement.
|
|
2064
2073
|
*/
|
|
2065
2074
|
async asyncExtract(urls, params, idempotencyKey) {
|
|
2066
2075
|
const headers = this.prepareHeaders(idempotencyKey);
|
|
@@ -2086,6 +2095,8 @@ var FirecrawlApp = class {
|
|
|
2086
2095
|
* Retrieves the status of an extract job.
|
|
2087
2096
|
* @param jobId - The ID of the extract job.
|
|
2088
2097
|
* @returns The status of the extract job.
|
|
2098
|
+
* @deprecated The extract endpoint is in maintenance mode and its use is discouraged.
|
|
2099
|
+
* Review https://docs.firecrawl.dev/developer-guides/usage-guides/choosing-the-data-extractor to find a replacement.
|
|
2089
2100
|
*/
|
|
2090
2101
|
async getExtractStatus(jobId) {
|
|
2091
2102
|
try {
|
package/package.json
CHANGED
package/src/v1/index.ts
CHANGED
|
@@ -1278,10 +1278,11 @@ export default class FirecrawlApp {
|
|
|
1278
1278
|
|
|
1279
1279
|
/**
|
|
1280
1280
|
* Extracts information from URLs using the Firecrawl API.
|
|
1281
|
-
* Currently in Beta. Expect breaking changes on future minor versions.
|
|
1282
1281
|
* @param urls - The URLs to extract information from. Optional if using other methods for data extraction.
|
|
1283
1282
|
* @param params - Additional parameters for the extract request.
|
|
1284
1283
|
* @returns The response from the extract operation.
|
|
1284
|
+
* @deprecated The extract endpoint is in maintenance mode and its use is discouraged.
|
|
1285
|
+
* Review https://docs.firecrawl.dev/developer-guides/usage-guides/choosing-the-data-extractor to find a replacement.
|
|
1285
1286
|
*/
|
|
1286
1287
|
async extract<T extends zt.ZodSchema = any>(urls?: string[], params?: ExtractParams<T>): Promise<ExtractResponse<zt.infer<T>> | ErrorResponse> {
|
|
1287
1288
|
const headers = this.prepareHeaders();
|
|
@@ -1337,6 +1338,8 @@ export default class FirecrawlApp {
|
|
|
1337
1338
|
* @param params - Additional parameters for the extract request.
|
|
1338
1339
|
* @param idempotencyKey - Optional idempotency key for the request.
|
|
1339
1340
|
* @returns The response from the extract operation.
|
|
1341
|
+
* @deprecated The extract endpoint is in maintenance mode and its use is discouraged.
|
|
1342
|
+
* Review https://docs.firecrawl.dev/developer-guides/usage-guides/choosing-the-data-extractor to find a replacement.
|
|
1340
1343
|
*/
|
|
1341
1344
|
async asyncExtract(
|
|
1342
1345
|
urls: string[],
|
|
@@ -1369,6 +1372,8 @@ export default class FirecrawlApp {
|
|
|
1369
1372
|
* Retrieves the status of an extract job.
|
|
1370
1373
|
* @param jobId - The ID of the extract job.
|
|
1371
1374
|
* @returns The status of the extract job.
|
|
1375
|
+
* @deprecated The extract endpoint is in maintenance mode and its use is discouraged.
|
|
1376
|
+
* Review https://docs.firecrawl.dev/developer-guides/usage-guides/choosing-the-data-extractor to find a replacement.
|
|
1372
1377
|
*/
|
|
1373
1378
|
async getExtractStatus(jobId: string): Promise<any> {
|
|
1374
1379
|
try {
|
package/src/v2/client.ts
CHANGED
|
@@ -255,6 +255,8 @@ export class FirecrawlClient {
|
|
|
255
255
|
* Start an extract job (async).
|
|
256
256
|
* @param args Extraction request (urls, schema or prompt, flags).
|
|
257
257
|
* @returns Job id or processing state.
|
|
258
|
+
* @deprecated The extract endpoint is in maintenance mode and its use is discouraged.
|
|
259
|
+
* Review https://docs.firecrawl.dev/developer-guides/usage-guides/choosing-the-data-extractor to find a replacement.
|
|
258
260
|
*/
|
|
259
261
|
async startExtract(args: Parameters<typeof startExtract>[1]): Promise<ExtractResponse> {
|
|
260
262
|
return startExtract(this.http, args);
|
|
@@ -262,6 +264,8 @@ export class FirecrawlClient {
|
|
|
262
264
|
/**
|
|
263
265
|
* Get extract job status/data.
|
|
264
266
|
* @param jobId Extract job id.
|
|
267
|
+
* @deprecated The extract endpoint is in maintenance mode and its use is discouraged.
|
|
268
|
+
* Review https://docs.firecrawl.dev/developer-guides/usage-guides/choosing-the-data-extractor to find a replacement.
|
|
265
269
|
*/
|
|
266
270
|
async getExtractStatus(jobId: string): Promise<ExtractResponse> {
|
|
267
271
|
return getExtractStatus(this.http, jobId);
|
|
@@ -270,6 +274,8 @@ export class FirecrawlClient {
|
|
|
270
274
|
* Convenience waiter: start an extract and poll until it finishes.
|
|
271
275
|
* @param args Extraction request plus waiter controls (pollInterval, timeout seconds).
|
|
272
276
|
* @returns Final extract response.
|
|
277
|
+
* @deprecated The extract endpoint is in maintenance mode and its use is discouraged.
|
|
278
|
+
* Review https://docs.firecrawl.dev/developer-guides/usage-guides/choosing-the-data-extractor to find a replacement.
|
|
273
279
|
*/
|
|
274
280
|
async extract(args: Parameters<typeof startExtract>[1] & { pollInterval?: number; timeout?: number }): Promise<ExtractResponse> {
|
|
275
281
|
return extractWaiter(this.http, args);
|
|
@@ -38,6 +38,10 @@ function prepareExtractPayload(args: {
|
|
|
38
38
|
return body;
|
|
39
39
|
}
|
|
40
40
|
|
|
41
|
+
/**
|
|
42
|
+
* @deprecated The extract endpoint is in maintenance mode and its use is discouraged.
|
|
43
|
+
* Review https://docs.firecrawl.dev/developer-guides/usage-guides/choosing-the-data-extractor to find a replacement.
|
|
44
|
+
*/
|
|
41
45
|
export async function startExtract(http: HttpClient, args: Parameters<typeof prepareExtractPayload>[0]): Promise<ExtractResponse> {
|
|
42
46
|
const payload = prepareExtractPayload(args);
|
|
43
47
|
try {
|
|
@@ -50,6 +54,10 @@ export async function startExtract(http: HttpClient, args: Parameters<typeof pre
|
|
|
50
54
|
}
|
|
51
55
|
}
|
|
52
56
|
|
|
57
|
+
/**
|
|
58
|
+
* @deprecated The extract endpoint is in maintenance mode and its use is discouraged.
|
|
59
|
+
* Review https://docs.firecrawl.dev/developer-guides/usage-guides/choosing-the-data-extractor to find a replacement.
|
|
60
|
+
*/
|
|
53
61
|
export async function getExtractStatus(http: HttpClient, jobId: string): Promise<ExtractResponse> {
|
|
54
62
|
try {
|
|
55
63
|
const res = await http.get<ExtractResponse>(`/v2/extract/${jobId}`);
|
|
@@ -61,6 +69,10 @@ export async function getExtractStatus(http: HttpClient, jobId: string): Promise
|
|
|
61
69
|
}
|
|
62
70
|
}
|
|
63
71
|
|
|
72
|
+
/**
|
|
73
|
+
* @deprecated The extract endpoint is in maintenance mode and its use is discouraged.
|
|
74
|
+
* Review https://docs.firecrawl.dev/developer-guides/usage-guides/choosing-the-data-extractor to find a replacement.
|
|
75
|
+
*/
|
|
64
76
|
export async function waitExtract(
|
|
65
77
|
http: HttpClient,
|
|
66
78
|
jobId: string,
|
|
@@ -76,6 +88,10 @@ export async function waitExtract(
|
|
|
76
88
|
}
|
|
77
89
|
}
|
|
78
90
|
|
|
91
|
+
/**
|
|
92
|
+
* @deprecated The extract endpoint is in maintenance mode and its use is discouraged.
|
|
93
|
+
* Review https://docs.firecrawl.dev/developer-guides/usage-guides/choosing-the-data-extractor to find a replacement.
|
|
94
|
+
*/
|
|
79
95
|
export async function extract(
|
|
80
96
|
http: HttpClient,
|
|
81
97
|
args: Parameters<typeof prepareExtractPayload>[0] & { pollInterval?: number; timeout?: number }
|