Files
firecrawl/apps/api/src/controllers/v1/extract.ts
T

271 lines
7.9 KiB
TypeScript
Raw Normal View History

2024-10-28 16:02:07 -03:00
import { Request, Response } from "express";
import {
2024-11-12 18:44:14 -03:00
// Document,
2024-10-28 16:02:07 -03:00
RequestWithAuth,
ExtractRequest,
extractRequestSchema,
ExtractResponse,
MapDocument,
2024-11-12 18:44:14 -03:00
scrapeOptions,
2024-10-28 16:02:07 -03:00
} from "./types";
2024-11-12 18:44:14 -03:00
import { Document } from "../../lib/entities";
import Redis from "ioredis";
import { configDotenv } from "dotenv";
import { performRanking } from "../../lib/ranker";
import { billTeam } from "../../services/billing/credit_billing";
import { logJob } from "../../services/logging/log_job";
import { logger } from "../../lib/logger";
import { getScrapeQueue } from "../../services/queue-service";
import { waitForJob } from "../../services/queue-jobs";
import { addScrapeJob } from "../../services/queue-jobs";
import { PlanType } from "../../types";
import { getJobPriority } from "../../lib/job-priority";
2024-11-13 18:06:20 -03:00
import { generateOpenAICompletions } from "../../scraper/scrapeURL/transformers/llmExtract";
import { isUrlBlocked } from "../../scraper/WebScraper/utils/blocklist";
2024-11-14 14:57:38 -05:00
import { getMapResults } from "./map";
2024-11-20 12:48:10 -08:00
import { buildDocument } from "../../lib/extract/build-document";
2024-11-12 18:44:14 -03:00
configDotenv();
const redis = new Redis(process.env.REDIS_URL!);
const MAX_EXTRACT_LIMIT = 100;
2024-11-14 15:26:15 -05:00
const MAX_RANKING_LIMIT = 10;
2024-11-14 15:34:02 -05:00
const SCORE_THRESHOLD = 0.75;
2024-10-28 16:02:07 -03:00
export async function extractController(
req: RequestWithAuth<{}, ExtractResponse, ExtractRequest>,
2024-11-13 18:06:20 -03:00
res: Response<ExtractResponse>
2024-10-28 16:02:07 -03:00
) {
req.body = extractRequestSchema.parse(req.body);
2024-11-12 18:44:14 -03:00
const id = crypto.randomUUID();
2024-11-14 14:57:38 -05:00
let links: string[] = [];
let docs: Document[] = [];
const earlyReturn = false;
2024-11-14 15:03:06 -05:00
// Process all URLs in parallel
const urlPromises = req.body.urls.map(async (url) => {
2024-11-14 15:41:42 -05:00
if (url.includes('/*') || req.body.allowExternalLinks) {
2024-11-14 14:57:38 -05:00
// Handle glob pattern URLs
const baseUrl = url.replace('/*', '');
2024-11-20 12:48:10 -08:00
// const pathPrefix = baseUrl.split('/').slice(3).join('/'); // Get path after domain if any
2024-11-14 14:57:38 -05:00
const allowExternalLinks = req.body.allowExternalLinks ?? true;
let urlWithoutWww = baseUrl.replace("www.", "");
let mapUrl = req.body.prompt && allowExternalLinks
? `${req.body.prompt} ${urlWithoutWww}`
: req.body.prompt ? `${req.body.prompt} site:${urlWithoutWww}`
: `site:${urlWithoutWww}`;
const mapResults = await getMapResults({
url: baseUrl,
search: req.body.prompt,
teamId: req.auth.team_id,
plan: req.auth.plan,
allowExternalLinks,
origin: req.body.origin,
limit: req.body.limit,
2024-11-14 15:26:15 -05:00
ignoreSitemap: true,
2024-11-14 14:57:38 -05:00
includeMetadata: true,
includeSubdomains: req.body.includeSubdomains,
2024-11-13 18:06:20 -03:00
});
2024-11-12 18:44:14 -03:00
2024-11-14 15:26:15 -05:00
let mappedLinks = mapResults.links as MapDocument[];
// Limit number of links to MAX_EXTRACT_LIMIT
mappedLinks = mappedLinks.slice(0, MAX_EXTRACT_LIMIT);
let mappedLinksRerank = mappedLinks.map(x => `url: ${x.url}, title: ${x.title}, description: ${x.description}`);
2024-11-14 14:57:38 -05:00
// Filter by path prefix if present
2024-11-20 12:48:10 -08:00
// console.log("pathPrefix", pathPrefix);
// wrong
// if (pathPrefix) {
// mappedLinks = mappedLinks.filter(x => x.url && x.url.includes(`/${pathPrefix}/`));
// }
2024-11-12 18:44:14 -03:00
2024-11-14 14:57:38 -05:00
if (req.body.prompt) {
2024-11-14 15:26:15 -05:00
const linksAndScores : { link: string, linkWithContext: string, score: number, originalIndex: number }[] = await performRanking(mappedLinksRerank, mappedLinks.map(l => l.url), mapUrl);
2024-11-14 14:57:38 -05:00
mappedLinks = linksAndScores
.filter(x => x.score > SCORE_THRESHOLD)
2024-11-14 15:26:15 -05:00
.map(x => mappedLinks.find(link => link.url === x.link))
.filter((x): x is MapDocument => x !== undefined && x.url !== undefined && !isUrlBlocked(x.url))
2024-11-14 14:57:38 -05:00
.slice(0, MAX_RANKING_LIMIT);
2024-11-14 15:26:15 -05:00
console.log("linksAndScores", linksAndScores);
console.log("linksAndScores", linksAndScores.length);
2024-11-14 14:57:38 -05:00
}
2024-11-13 18:06:20 -03:00
2024-11-14 15:26:15 -05:00
return mappedLinks.map(x => x.url) as string[];
2024-11-12 18:44:14 -03:00
2024-11-14 14:57:38 -05:00
} else {
// Handle direct URLs without glob pattern
if (!isUrlBlocked(url)) {
2024-11-14 15:03:06 -05:00
return [url];
2024-11-14 14:57:38 -05:00
}
2024-11-14 15:03:06 -05:00
return [];
2024-11-14 14:57:38 -05:00
}
2024-11-14 15:03:06 -05:00
});
// Wait for all URL processing to complete and flatten results
const processedUrls = await Promise.all(urlPromises);
links.push(...processedUrls.flat());
2024-11-12 18:44:14 -03:00
2024-11-14 15:26:15 -05:00
console.log("links", links.length);
2024-11-14 14:59:34 -05:00
// Scrape all links in parallel
const scrapePromises = links.map(async (url) => {
2024-11-12 18:44:14 -03:00
const origin = req.body.origin || "api";
2024-11-13 18:06:20 -03:00
const timeout = req.body.timeout ?? 30000;
2024-11-12 18:44:14 -03:00
const jobId = crypto.randomUUID();
const jobPriority = await getJobPriority({
plan: req.auth.plan as PlanType,
team_id: req.auth.team_id,
basePriority: 10,
});
await addScrapeJob(
{
url,
2024-11-14 14:59:34 -05:00
mode: "single_urls",
2024-11-12 18:44:14 -03:00
team_id: req.auth.team_id,
scrapeOptions: scrapeOptions.parse({}),
internalOptions: {},
plan: req.auth.plan!,
origin,
is_scrape: true,
},
{},
jobId,
jobPriority
);
2024-11-14 14:57:38 -05:00
const totalWait = 0;
2024-11-12 18:44:14 -03:00
try {
2024-11-14 14:59:34 -05:00
const doc = await waitForJob<Document>(jobId, timeout + totalWait);
await getScrapeQueue().remove(jobId);
if (earlyReturn) {
return null;
}
return doc;
2024-11-12 18:44:14 -03:00
} catch (e) {
logger.error(`Error in scrapeController: ${e}`);
if (e instanceof Error && (e.message.startsWith("Job wait") || e.message === "timeout")) {
2024-11-14 14:59:34 -05:00
throw {
status: 408,
error: "Request timed out"
};
2024-11-12 18:44:14 -03:00
} else {
2024-11-14 14:59:34 -05:00
throw {
status: 500,
error: `(Internal server error) - ${(e && e.message) ? e.message : e}`
};
2024-11-12 18:44:14 -03:00
}
}
2024-11-14 14:59:34 -05:00
});
try {
const results = await Promise.all(scrapePromises);
docs.push(...results.filter(doc => doc !== null).map(x => x!));
} catch (e) {
return res.status(e.status).json({
success: false,
error: e.error
});
2024-11-12 18:44:14 -03:00
}
2024-11-13 18:06:20 -03:00
const completions = await generateOpenAICompletions(
logger.child({ method: "extractController/generateOpenAICompletions" }),
{
mode: "llm",
systemPrompt: "Only use the provided content to answer the question.",
2024-11-14 14:57:38 -05:00
prompt: req.body.prompt,
2024-11-13 18:06:20 -03:00
schema: req.body.schema,
},
2024-11-20 12:48:10 -08:00
docs.map(x => buildDocument(x)).join('\n')
2024-11-13 18:06:20 -03:00
);
2024-11-12 18:44:14 -03:00
2024-11-14 14:57:38 -05:00
// console.log("completions", completions);
2024-11-12 18:44:14 -03:00
// if(req.body.extract && req.body.formats.includes("extract")) {
// creditsToBeBilled = 5;
// }
// billTeam(req.auth.team_id, req.acuc?.sub_id, creditsToBeBilled).catch(error => {
// logger.error(`Failed to bill team ${req.auth.team_id} for ${creditsToBeBilled} credits: ${error}`);
// // Optionally, you could notify an admin or add to a retry queue here
// });
// if (!req.body.formats.includes("rawHtml")) {
// if (doc && doc.rawHtml) {
// delete doc.rawHtml;
// }
// }
// logJob({
// job_id: jobId,
// success: true,
// message: "Scrape completed",
// num_docs: 1,
// docs: [doc],
// time_taken: timeTakenInSeconds,
// team_id: req.auth.team_id,
// mode: "scrape",
// url: req.body.url,
// scrapeOptions: req.body,
// origin: origin,
// num_tokens: numTokens,
// });
// billTeam(teamId, subId, 1).catch((error) => {
// logger.error(
// `Failed to bill team ${teamId} for 1 credit: ${error}`
// );
// });
// const linksToReturn = links.slice(0, limit);
// logJob({
// job_id: id,
// success: links.length > 0,
// message: "Extract completed",
// num_docs: linksToReturn.length,
// docs: linksToReturn,
// time_taken: (new Date().getTime() - Date.now()) / 1000,
// team_id: teamId,
// mode: "extract",
// url: urls[0],
// crawlerOptions: {},
// scrapeOptions: {},
// origin: origin ?? "api",
// num_tokens: 0,
// });
// return {
// };
// const response = {
// success: true as const,
// data: result.data,
// scrape_id: result.scrape_id
// };
2024-11-13 18:06:20 -03:00
console.log("completions.extract", completions.extract);
let data: any;
try {
data = JSON.parse(completions.extract);
} catch (e) {
data = completions.extract;
}
2024-10-28 16:02:07 -03:00
return res.status(200).json({
success: true,
2024-11-14 14:57:38 -05:00
data: data,
scrape_id: id,
2024-10-28 16:02:07 -03:00
});
2024-11-12 18:44:14 -03:00
}