To create a submission, you need to upload a file or a set of files into Hyperscience. There are two ways to upload files into Hyperscience:
Through the Hyperscience application
Through the Hyperscience API
Upload files through the Hyperscience application
To be able to upload files through the Hyperscience application, you need to have Submission Upload enabled in the System Settings section:
Go to Administration > System Settings.
In the General section, click Edit next to the Submission Upload card.
Set the Submission upload setting to Enabled.
Click Save.
You can upload files by following the steps below:
Go to Submissions.
Click Create Submission.
Upload a file or a set of files. You have two ways to upload your files:
If you are submitting multiple files, you need to select one of the following two options
Select One Submission per file if you’d like each file to become its own submission.
Select Single Submission if you’d like to create a single submission from all the files.
Drag and drop your files into the box.
Click Choose Files and select your files.
Click Next.
Select a flow from the Submit to flow drop-down menu. Optionally, you can also:
Select a layout (for Semi-structured documents only).
Add to case - to learn more about this setting, see Case Collation.
Enable Machine extract only - if you enable this setting, the system will not create any Supervision, Consensus, or QA tasks for the submission.
Click Upload.
Once the files are uploaded, a submission is created. You can find the submission on the Submissions page. To learn more about the Submissions page, see Navigating the Submissions Page.
Upload files through the Hyperscience API
You can upload a file or a set of files through the API. Upon successful upload, these files will form a submission and you will be able to find them on the Submissions page.
To upload files through the API, you need to authenticate your user and make a POST request to /api/v5/submissions. The only required parameter of the request is:
file for multipart/form-data and application/x-www-form-urlencode encoding. This parameter accepts either a file as multipart/form-data or a string that defines a path of a file to be retrieved and included in the submission.
files for application/json encoding. For each file, this parameter can have one of the following:
JSON object with keys: file_content_base64, which accepts Base64-encoded file data as either a plain text string or a data URI scheme string, and filename, which contains the name of the file.
JSON object with key: file_url, which accepts the URL of the file's location. The supported file types are JPEG, PNG, TIFF, PDF, and XPS.
You can also add additional parameters. To learn more, see the Submission Creation API documentation.
What happens next?
Once a file has become a submission, the system then interprets each submission’s image as a page and matches each page to a live layout in the system. Pages are grouped into a document based on the matched layout. If the machine fails to classify the pages automatically, you need to perform Document Classification Supervision. To learn more, see What is a Submission? and Document Classification.