gbox-sdk
    Preparing search index...

    Interface ActionExtractParams

    interface ActionExtractParams {
        instruction: string;
        schema?: unknown;
    }
    Index

    Properties

    Properties

    instruction: string

    The instruction of the action to extract data from the UI interface

    schema?: unknown

    JSON Schema defining the structure of data to extract. Supports object, array, string, number, boolean types with validation rules.

    Common use cases:

    • Extract text content: { "type": "string" }
    • Extract structured data: { "type": "object", "properties": {...} }
    • Extract lists: { "type": "array", "items": {...} }
    • Extract with validation: Add constraints like "required", "enum", "pattern", etc.