boostrs api
Search…
Batch Extract Skills
Submit batches of documents (courses) and have them automatically processed to get the matching skills for each of them.
Each document in the batch will be processed automatically and the corresponding skills will be extracted based on the document's content.
post
https://apigateway.boost.rs
/skillfinder/batch
Submit a batch of documents for automated text analysis and skill extraction

Batch details & upload limits

The limits are as follows:
  • max 7,500 characters per content field of a document
  • max 50,000 documents per batch
  • max request size 10 MB
The batch will be rejected if at least one of the limits is exceeded.
The maximum size of a request means the entire JSON content counts against the limit, including the field labels, optional fields, length of field values (ex: external_id, provider etc.).
Examples of batch values 1. Batch of 1,300 documents, with 7,500 characters per document content field value. 2. Batch 2,000 documents with 5,000 characters per document content field value.

Request body (sample)

1
{
2
"name": "",
3
"category_id": 12345,
4
"documents": [
5
{
6
"title": "internal name 1",
7
"content": "",
8
"language_code": "en",
9
"provider": "",
10
"external_id": ""
11
},
12
{
13
"title": "doc 2",
14
"content": "",
15
"language_code": "fr",
16
"provider": "",
17
"external_id": ""
18
}
19
]
20
}
Copied!

Response fields

id
Batch ID
name
The name given to the batch.
status
Batch status.
'active' - all documents have been processed.
'queued' - documents will start processing based on arrival.
'processing' - some documents have been processed and some documents are being processed right now.
total_documents
Total number of documents request in the batch.
processed_documents
Number of documents for which the processing is complete.
pending_documents
Number of documents which are queued.
Last modified 11d ago