Retrieve data from webpage based on a url and natural language command that guides agents data extraction process.
The function can create a new session or be used as part of a session.
A specific natural language instruction on data the agent should extract.
The URL to create or continue session from.
Continues the session with session_id if provided.
Boolean flag to indicate if session to be run locally or in the cloud (Default: False). If set to true, the session will be run locally via your chrome extension. If set to false, the session will be run in the cloud.
List of fields (columns) to be outputted in data.
The format of the response data. (Default: json)
Maximum number of data items to retrieve. (Default: 100)
Flag to retrieve full page (Default: True). If set to false, the data will only be retrieved from the current session viewport.
Flag to include rich JS and ARIA elements in data retrieved. (Default: False)
Flag to scroll to the bottom of the page (Default: False). If set to true, the page will be scrolled to the bottom for a maximum of 5 seconds before data is retrieved.
The mode you would like to use for the session. ‘standard’, ‘fast’ or ‘ludicrous’
Flag to include a screenshot with the response. (Default: False)
Additional optional parameters for the session.
information relating to response
The last accessed URL during the session.
The current status of the session.
Array of data objects, each containing data requested in fields.
image url of the screenshot taken during the session.
The unique identifier for the session.