Quickstart
Learn the ParseX console workflow and quickly try out platform features.
Document processing path
Choose Parse or Extract for your task.
Compare parsed content or extracted fields with the source.
Record the generated config_id.
Choose saved configuration or direct parameters.
Inspect status, results, and usage.
Prerequisites
- Obtain console access and enter the target Workspace through the officially authorized entry. If you do not have that entry, contact the service provider or administrator first; see REST API integration prerequisites.
- Prepare a local file or sample document and the content to check or fields to extract. The playground supports a single document up to 200 MB and a single image up to 20 MB; for file size limits on API calls, see the corresponding API documentation.
- Parse turns documents into readable, structured content; Extract extracts information using configured fields. For configuration requirements, see Configure Document Parsing and Field Extraction Console.
Step 1: Select and Upload a Document
Select a local file or sample document in the Parse or Extract console, configure parsing capabilities or the fields to extract for your task, and start processing.
Step 2: Check the Results Item by Item
Wait for processing to complete, then compare the run results against the original document and your expectations, checking content completeness, structural accuracy, extraction accuracy, and other information.
- Parse: Check the parsed content and structure for completeness against the source; see Document Parsing.
- Extract: The result area offers two views: "Extraction Result JSON" and "Extracted Field Details"; the field details view lists each field value with its source page numbers. Check the extracted values against their source pages.
Step 3: Save the Configuration (Optional)
You can save the configured parsing/extraction settings as a configuration on the playground page, generating a unique config_id for API calls. Record the configuration ID for the selected Parse or Extract capability.
Step 4: Call with the Saved Configuration or Parameters
The API can be called with the same config_id, or you can directly pass parsing/extraction configuration parameters to run tasks. Choose saved configuration or inline processing parameters; do not send both in the same call.
NoteThe production Base URL is not yet publicly confirmed. Prepare integration using REST API Integration, and make REST calls after the official production endpoint is published.
- Parse: Submit a parsing task → Query parsing results.
- Extract: Submit an extraction task → Query extraction results.
ImportantYou can also complete the task with the Bailian CLI: bl parsex parse submit --workspace-id <workspace-id> --file-url "https://example.com/document.pdf" --output json, then retrieve results with bl parsex parse result --biz-id <biz-id> --follow; for field extraction, use bl parsex extract submit and bl parsex extract result. See Use the CLI.
Step 5: View Tasks
For console operations, you can view the status, results, and usage provided by the page in "Task Records"; see Task Records. After an API submission, save the returned biz_id and poll processing status through the corresponding result API.
NoteThe completed console task produces parsed content or extracted fields that you can check against the source. If you saved a configuration, also record its config_id. biz_id identifies an asynchronous task, not a configuration. Confirm processing has completed before checking the content.