extractObjectFromPage

export declare function extractObjectFromPage(
  page: Page,
  options: {
    label: string;
    entityName: string;
    entitySchema: SimpleObjectSchema;
    strategy?: ImageStrategy | HtmlStrategy;
    prompt?: string;
    optionalPropertiesInvalidator?: (
      result: Record<string, string | null> | null
    ) => string[];
    variantKey?: string;
    apiKey?: string;
  }
): Promise<Record<string, string | null> | null>;

Deprecated: This function is deprecated and will be removed in the future.

Extracts a structured object from a web page.

Examples

extractObjectFromPage

 import { extractObjectFromPage } from "@intuned/sdk/optimized-extractors";

 await page.goto("https://books.toscrape.com/catalogue/a-light-in-the-attic_1000/index.html")
 const book = await extractObjectFromPage(page,
   {
     entityName: "book",
     label: "book-extraction",
     entitySchema: {
       type: "object",
       required: ["name","price","reviews"],
       properties: {
         name: {
           type: "string",
           description: "book name",
         },
         price: {
           type: "string",
           description: "book price"
         },
         reviews: {
           type: "string",
           description: "Number of reviews"
         }

       }
     }
   },
 )

 console.log(book)

 // output:
 // { name: 'A Light in the Attic', price: '£51.77', reviews: '0' }

Arguments

page · any · required

The Playwright Page object from which to extract the data.

options · object · required

Show options

options.label · any

A label for this extraction process, used for billing and monitoring.

options.entityName · any

The name of the entity being extracted. it must be between 1 and 50 characters long and can only contain letters, digits, periods, underscores, and hyphens.

options.entitySchema · any

The schema of the entity being extracted.

options.strategy · any

Optional. The strategy to use for extraction, if not provided, the html strategy with claude haiku will be used.

options.prompt · any

Optional. A prompt to guide the extraction process.

options.optionalPropertiesInvalidator · any

Optional. A function to invalidate optional properties.

options.variantKey · any

Optional. A variant key for the extraction process.

options.apiKey · any

Optional. An API key to use for the AI extraction. Extractions made with you API key will not be billed to your account.

Returns: any

A promise that resolves to the extracted object.