yujunjun/firecrawl
1
0
Fork 0
mirror of https://github.com/mendableai/firecrawl.git synced 2025-11-13 16:57:28 +00:00
Code Issues Packages Projects Releases Wiki Activity

feat(js-sdk): actions integration

Browse Source
This commit is contained in:
Gergő Móricz 2024-09-18 20:47:56 +02:00
parent 093c064bff
commit 20d1855ad5
1 changed files with 23 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
apps/js-sdk/firecrawl/src/index.ts
View File

@ -58,7 +58,7 @@ export interface FirecrawlDocumentMetadata {
* Document interface for Firecrawl. * Document interface for Firecrawl.
* Represents a document retrieved or processed by Firecrawl. * Represents a document retrieved or processed by Firecrawl.
*/ */
export interface FirecrawlDocument<T = any> { export interface FirecrawlDocument<T = any, ActionsSchema extends (ActionsResult | never) = never> {
url?: string; url?: string;
markdown?: string; markdown?: string;
html?: string; html?: string;
@ -67,6 +67,7 @@ export interface FirecrawlDocument<T = any> {
extract?: T; extract?: T;
screenshot?: string; screenshot?: string;
metadata?: FirecrawlDocumentMetadata; metadata?: FirecrawlDocumentMetadata;
actions: ActionsSchema;
} }
/** /**
@ -83,19 +84,35 @@ export interface CrawlScrapeOptions {
timeout?: number; timeout?: number;
} }
export interface ScrapeParams<LLMSchema extends zt.ZodSchema = any> extends CrawlScrapeOptions { export type Action = {
type: "wait",
milliseconds: number,
} | {
type: "click",
selector: string,
} | {
type: "screenshot",
fullPage?: boolean,
};
export interface ScrapeParams<LLMSchema extends zt.ZodSchema = any, ActionsSchema extends (Action[] | undefined) = undefined> extends CrawlScrapeOptions {
extract?: { extract?: {
prompt?: string; prompt?: string;
schema?: LLMSchema; schema?: LLMSchema;
systemPrompt?: string; systemPrompt?: string;
}; };
actions?: ActionsSchema;
}
export interface ActionsResult {
screenshots: string[];
} }
/** /**
* Response interface for scraping operations. * Response interface for scraping operations.
* Defines the structure of the response received after a scraping operation. * Defines the structure of the response received after a scraping operation.
*/ */
export interface ScrapeResponse<LLMResult = any> extends FirecrawlDocument<LLMResult> { export interface ScrapeResponse<LLMResult = any, ActionsSchema extends (ActionsResult | never) = never> extends FirecrawlDocument<LLMResult, ActionsSchema> {
success: true; success: true;
warning?: string; warning?: string;
error?: string; error?: string;
@ -200,10 +217,10 @@ export default class FirecrawlApp {
* @param params - Additional parameters for the scrape request. * @param params - Additional parameters for the scrape request.
* @returns The response from the scrape operation. * @returns The response from the scrape operation.
*/ */
async scrapeUrl<T extends zt.ZodSchema>( async scrapeUrl<T extends zt.ZodSchema, ActionsSchema extends (Action[] | undefined) = undefined>(
url: string, url: string,
params?: ScrapeParams<T> params?: ScrapeParams<T, ActionsSchema>
): Promise<ScrapeResponse<zt.infer<T>> | ErrorResponse> { ): Promise<ScrapeResponse<zt.infer<T>, ActionsSchema extends Action[] ? ActionsResult : never> | ErrorResponse> {
const headers: AxiosRequestHeaders = { const headers: AxiosRequestHeaders = {
"Content-Type": "application/json", "Content-Type": "application/json",
Authorization: `Bearer ${this.apiKey}`, Authorization: `Bearer ${this.apiKey}`,