Run results endpoint (Deprecated)

1
url = url_base + '/api/v1/flow_binary/results'
2
3
args = {
4
  'ibresults_path': "/jaydoe/my_repo/fs/Instabase Drive/flow_proj/out/batch.ibflowresults",
5
  'options': {
6
    'refined_phrases_features': ['provenance_info'],
7
    'include_page_layouts': True,
8
  },
9
  'file_offset': 0
10
}
11
json_data = json.dumps(args)
12
13
headers = {
14
  'Authorization': 'Bearer {0}'.format(token)
15
}
16
17
r = requests.post(url, data=json_data, headers=headers)
18
resp_data = json.loads(r.content)

1
url = url_base + '/api/v1/flow_binary/results'
2
3
args = {
4
  'ibresults_path': "/jaydoe/my_repo/fs/Instabase Drive/flow_proj/out/batch.ibflowresults",
5
  'options': {
6
    'refined_phrases_features': ['provenance_info'],
7
    'include_page_layouts': True,
8
  },
9
  'file_offset': 0
10
}
11
json_data = json.dumps(args)
12
13
headers = {
14
  'Authorization': 'Bearer {0}'.format(token)
15
}
16
17
r = requests.post(url, data=json_data, headers=headers)
18
resp_data = json.loads(r.content)
19
20
# Parse through pages until no more pages left to look through
21
all_records = [resp_data.get('records', [])]
22
while len(resp_data) > 0:
23
  # Retrieve the last file_index from the last record returned
24
  next_file_offset = resp_data['records'][-1]['file_index'] + 1
25
  args['file_offset'] = next_file_offset
26
  json_data = json.dumps(args)
27
28
  r = requests.post(url, data=json_data, headers=headers)
29
  resp_data = json.loads(r.content)
30
  resp_records = resp_data.get('records', [])
31
32
  all_records.extend(resp_records)

1
HTTP STATUS CODE 200
2
3
{
4
  records: [
5
    {
6
      "output_file_path": "path/to/my/output.ibdoc",
7
      "results": [
8
        {
9
          "key": "field1",
10
          "value": "value1",
11
          "model_confidence": 0.43
12
        }...,
13
        {
14
          "key": "field2",
15
          "value": "ERROR",
16
          "error_msg": "Some error happened (line: 120)",
17
          "ocr_confidence": 0.98
18
        },
19
        {
20
          "key": "__hidden_field3",
21
          "value": "value3"
22
        },
23
      ],
24
      "record_index": 0,
25
      "file_name": "document.pdf",
26
      "layout": {
27
        "page_layouts": [
28
          {
29
            "page_number": 0,
30
            "processed_image_path": "path/to/generated/image",
31
            "width": 600,
32
            "height": 800,
33
            "corrected_rotation": 0,
34
            "is_image_page": false,
35
            "origin_pos": {
36
              "x": 0.0,
37
              "y": 0.0
38
            }
39
          }..., //more pages
40
        ]
41
      },
42
      "document_path": "path/to/my/original/document.pdf"
43
    },
44
    {
45
      "error": {
46
        "error_message": "Columns failed: field1",
47
        "error_type": "process_files_failed",
48
        "step_name": "process_files"
49
      },
50
      "file_name": "error.pdf"
51
    }..., // more records
52
  ]
53
}