Deprecated: This function is deprecated and will be removed in the future.
export declare function extractArrayFromLocator(
locator: Locator,
options: {
label: string;
itemEntityName: string;
itemEntitySchema: SimpleArrayItemSchema;
strategy?: ImageStrategy | HtmlStrategy;
prompt?: string;
optionalPropertiesInvalidator?: (
result: Record<string, string>[]
) => string[];
variantKey?: string;
apiKey?: string;
}
): Promise<Record<string, string>[]>;
Examples
import { extractArrayFromLocator } from "@intuned/browser/optimized-extractors";
await page.goto("https://books.toscrape.com/");
const books = await extractArrayFromLocator(page.locator("section"), {
itemEntityName: "book",
label: "books-extraction",
itemEntitySchema: {
type: "object",
required: ["name"],
properties: {
name: {
type: "string",
description: "book name",
primary: true,
},
},
},
});
console.log(books);
// output:
// [
// ...
// { name: 'Olio' },
// { name: 'Mesaerion: The Best Science Fiction Stories 1800-1849' },
// { name: 'Libertarianism for Beginners' },
// { name: "It's Only the Himalayas" }
// ...
// ]
Arguments
any
required
The Playwright Locator object from which to extract the data.
object
required
Hide properties
Hide properties
any
required
A label for this extraction process, used for billing and monitoring.
any
required
The name of the entity items being extracted. Must be 1–50 characters long and can only contain letters, digits, periods, underscores, and hyphens.
any
required
The schema of the entity items being extracted.
any
required
Optional. The strategy to use for extraction, if not provided, the html strategy with claude haiku will be used.
any
required
Optional. A prompt to guide the extraction process.
any
required
Optional. A function to invalidate optional properties.
any
required
Optional. A variant key for the extraction process.
any
required
Optional. An API key for AI extraction. Extractions made with your API key won’t be billed to your account.