DocumentParserInput Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Document Parser
public class DocumentParserInputtype DocumentParserInput = classPublic Class DocumentParserInput- Inheritance
-
DocumentParserInput
Constructors
| Name | Description |
|---|---|
| DocumentParserInput() | |
Properties
| Name | Description |
|---|---|
| Async |
Set async to true for long processes to run in the background, API will then return a jobId which you can use with "Job Check" to check the status of the process and retrieve the output while you can proceed with other tasks without waiting for this process to finish. |
| Expiration |
Set the expiration time for the output link in minutes (default is 60 i.e 60 minutes or 1 hour), After this specified duration, any generated output file(s) will be automatically deleted from PDF.co temporary files storage. The maximum duration for link expiration varies based on your current subscription plan. |
| Inline |
Set to true to return results inside the response. Otherwise, the endpoint will return a link to the output file generated |
| OutputFormat |
Default is JSON. You can override the default output format to CSV or XML to generate CSV or XML output accordingly. |
| Password |
Password of PDF file |
| Profiles |
Use this parameter to set additional configurations for fine-tuning and extra options. Explore PDF.co knowledgebase https://developer.pdf.co/api/profiles/index.html for profile examples, |
| TemplateId |
Set ID of document parser template to be used. View and manage your templates at https://app.pdf.co/document-parser |
| Url |
URL to the source file. Supports links from Google Drive, Dropbox, and PDF.co built-in files storage. To upload files via API, Check out the Files Upload section at https://developer.pdf.co/api/file-upload/index.html |
