openparser-sdk 0.0.1__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (173) hide show
  1. openparser/__init__.py +54 -0
  2. openparser/_files.py +43 -0
  3. openparser/_generated/__init__.py +8 -0
  4. openparser/_generated/api/__init__.py +1 -0
  5. openparser/_generated/api/extract/__init__.py +1 -0
  6. openparser/_generated/api/extract/extract_async.py +280 -0
  7. openparser/_generated/api/extract/extract_batch.py +284 -0
  8. openparser/_generated/api/extract/extract_sync.py +315 -0
  9. openparser/_generated/api/extract/suggest_schema.py +260 -0
  10. openparser/_generated/api/files/__init__.py +1 -0
  11. openparser/_generated/api/files/create_file.py +237 -0
  12. openparser/_generated/api/files/delete_file.py +200 -0
  13. openparser/_generated/api/files/get_file.py +200 -0
  14. openparser/_generated/api/files/get_file_content.py +198 -0
  15. openparser/_generated/api/jobs/__init__.py +1 -0
  16. openparser/_generated/api/jobs/get_job.py +261 -0
  17. openparser/_generated/api/jobs/get_job_result.py +305 -0
  18. openparser/_generated/api/jobs/get_job_source.py +233 -0
  19. openparser/_generated/api/jobs/list_jobs.py +340 -0
  20. openparser/_generated/api/models/__init__.py +1 -0
  21. openparser/_generated/api/models/list_llm_models.py +288 -0
  22. openparser/_generated/api/models/list_ocr_models.py +184 -0
  23. openparser/_generated/api/parse/__init__.py +1 -0
  24. openparser/_generated/api/parse/parse_async.py +316 -0
  25. openparser/_generated/api/parse/parse_batch.py +280 -0
  26. openparser/_generated/api/parse/parse_sync.py +369 -0
  27. openparser/_generated/api/pipelines/__init__.py +1 -0
  28. openparser/_generated/api/pipelines/create_extraction_pipeline.py +242 -0
  29. openparser/_generated/api/pipelines/delete_extraction_pipeline.py +212 -0
  30. openparser/_generated/api/pipelines/get_extraction_pipeline.py +212 -0
  31. openparser/_generated/api/pipelines/list_extraction_pipelines.py +180 -0
  32. openparser/_generated/api/pipelines/update_extraction_pipeline.py +258 -0
  33. openparser/_generated/client.py +270 -0
  34. openparser/_generated/errors.py +14 -0
  35. openparser/_generated/models/__init__.py +261 -0
  36. openparser/_generated/models/batch_child_page.py +97 -0
  37. openparser/_generated/models/batch_child_summary.py +195 -0
  38. openparser/_generated/models/batch_job_accepted.py +139 -0
  39. openparser/_generated/models/batch_job_accepted_operation.py +8 -0
  40. openparser/_generated/models/batch_summary_counts.py +97 -0
  41. openparser/_generated/models/bounding_box.py +82 -0
  42. openparser/_generated/models/chunk_provenance_span.py +97 -0
  43. openparser/_generated/models/content_kind.py +10 -0
  44. openparser/_generated/models/create_extraction_pipeline_request.py +177 -0
  45. openparser/_generated/models/create_extraction_pipeline_request_grounding.py +8 -0
  46. openparser/_generated/models/create_extraction_pipeline_request_llm_options.py +84 -0
  47. openparser/_generated/models/create_extraction_pipeline_request_llm_options_reasoning_effort_type_1.py +13 -0
  48. openparser/_generated/models/create_extraction_pipeline_request_ocr_options.py +78 -0
  49. openparser/_generated/models/create_extraction_pipeline_request_schema.py +68 -0
  50. openparser/_generated/models/create_file_body.py +78 -0
  51. openparser/_generated/models/delete_extraction_pipeline_response.py +66 -0
  52. openparser/_generated/models/delete_file_response.py +57 -0
  53. openparser/_generated/models/error_body.py +106 -0
  54. openparser/_generated/models/error_body_details.py +65 -0
  55. openparser/_generated/models/error_response.py +65 -0
  56. openparser/_generated/models/extract_async_body.py +136 -0
  57. openparser/_generated/models/extract_batch_body.py +143 -0
  58. openparser/_generated/models/extract_batch_item.py +207 -0
  59. openparser/_generated/models/extract_batch_item_grounding.py +8 -0
  60. openparser/_generated/models/extract_batch_item_llm_options.py +84 -0
  61. openparser/_generated/models/extract_batch_item_llm_options_reasoning_effort_type_1.py +13 -0
  62. openparser/_generated/models/extract_batch_item_ocr_options.py +78 -0
  63. openparser/_generated/models/extract_batch_item_schema.py +65 -0
  64. openparser/_generated/models/extract_batch_request.py +99 -0
  65. openparser/_generated/models/extract_batch_request_items_item.py +201 -0
  66. openparser/_generated/models/extract_batch_request_items_item_grounding.py +8 -0
  67. openparser/_generated/models/extract_batch_request_items_item_llm_options.py +84 -0
  68. openparser/_generated/models/extract_batch_request_items_item_llm_options_reasoning_effort_type_1.py +13 -0
  69. openparser/_generated/models/extract_batch_request_items_item_ocr_options.py +78 -0
  70. openparser/_generated/models/extract_batch_request_items_item_schema.py +65 -0
  71. openparser/_generated/models/extract_batch_request_output_format.py +8 -0
  72. openparser/_generated/models/extract_request.py +226 -0
  73. openparser/_generated/models/extract_request_grounding.py +8 -0
  74. openparser/_generated/models/extract_request_llm_options.py +84 -0
  75. openparser/_generated/models/extract_request_llm_options_reasoning_effort_type_1.py +13 -0
  76. openparser/_generated/models/extract_request_ocr_options.py +78 -0
  77. openparser/_generated/models/extract_request_output_format.py +8 -0
  78. openparser/_generated/models/extract_request_schema.py +65 -0
  79. openparser/_generated/models/extract_sync_body.py +136 -0
  80. openparser/_generated/models/extraction_attempt.py +122 -0
  81. openparser/_generated/models/extraction_attempt_kind.py +8 -0
  82. openparser/_generated/models/extraction_attempt_status.py +9 -0
  83. openparser/_generated/models/extraction_chunk.py +184 -0
  84. openparser/_generated/models/extraction_citation.py +169 -0
  85. openparser/_generated/models/extraction_citation_granularity.py +8 -0
  86. openparser/_generated/models/extraction_citation_source_type.py +16 -0
  87. openparser/_generated/models/extraction_grounding_field.py +102 -0
  88. openparser/_generated/models/extraction_grounding_mode.py +8 -0
  89. openparser/_generated/models/extraction_grounding_result.py +87 -0
  90. openparser/_generated/models/extraction_pipeline.py +201 -0
  91. openparser/_generated/models/extraction_pipeline_list_response.py +76 -0
  92. openparser/_generated/models/extraction_pipeline_llm_options.py +84 -0
  93. openparser/_generated/models/extraction_pipeline_llm_options_reasoning_effort_type_0_type_1.py +13 -0
  94. openparser/_generated/models/extraction_pipeline_ocr_options.py +73 -0
  95. openparser/_generated/models/extraction_pipeline_schema.py +67 -0
  96. openparser/_generated/models/extraction_terminal_result.py +206 -0
  97. openparser/_generated/models/extraction_terminal_result_reasoning_effort_type_0.py +13 -0
  98. openparser/_generated/models/extraction_usage_totals.py +80 -0
  99. openparser/_generated/models/job.py +437 -0
  100. openparser/_generated/models/job_accepted.py +131 -0
  101. openparser/_generated/models/job_accepted_operation.py +8 -0
  102. openparser/_generated/models/job_extraction_schema.py +65 -0
  103. openparser/_generated/models/job_failure.py +98 -0
  104. openparser/_generated/models/job_failure_details.py +65 -0
  105. openparser/_generated/models/job_list_response.py +91 -0
  106. openparser/_generated/models/job_operation.py +10 -0
  107. openparser/_generated/models/job_progress.py +68 -0
  108. openparser/_generated/models/job_related_extractions_item.py +145 -0
  109. openparser/_generated/models/job_status.py +11 -0
  110. openparser/_generated/models/job_summary.py +264 -0
  111. openparser/_generated/models/json_schema_object.py +66 -0
  112. openparser/_generated/models/list_llm_models_mode.py +8 -0
  113. openparser/_generated/models/ocr_llm_model_catalog_entry.py +257 -0
  114. openparser/_generated/models/ocr_llm_model_catalog_entry_pricing.py +76 -0
  115. openparser/_generated/models/ocr_llm_model_catalog_entry_reasoning_type_0.py +134 -0
  116. openparser/_generated/models/ocr_llm_model_catalog_entry_reasoning_type_0_default_effort_type_0.py +13 -0
  117. openparser/_generated/models/ocr_llm_model_catalog_entry_reasoning_type_0_supported_efforts_type_0_item.py +13 -0
  118. openparser/_generated/models/ocr_llm_model_catalog_entry_recommendation.py +8 -0
  119. openparser/_generated/models/ocr_llm_models_response.py +150 -0
  120. openparser/_generated/models/ocr_llm_models_response_mode.py +8 -0
  121. openparser/_generated/models/ocr_model.py +7 -0
  122. openparser/_generated/models/ocr_model_catalog_entry.py +131 -0
  123. openparser/_generated/models/ocr_model_catalog_entry_availability.py +9 -0
  124. openparser/_generated/models/ocr_model_catalog_entry_capabilities.py +97 -0
  125. openparser/_generated/models/ocr_model_catalog_entry_capabilities_options.py +73 -0
  126. openparser/_generated/models/ocr_model_catalog_entry_option_defaults.py +73 -0
  127. openparser/_generated/models/ocr_model_catalog_entry_pricing.py +68 -0
  128. openparser/_generated/models/ocr_models_response.py +76 -0
  129. openparser/_generated/models/ocr_output_format.py +8 -0
  130. openparser/_generated/models/paddle_raw_profile.py +76 -0
  131. openparser/_generated/models/paddle_raw_profile_options.py +115 -0
  132. openparser/_generated/models/page_block.py +332 -0
  133. openparser/_generated/models/page_block_kind.py +9 -0
  134. openparser/_generated/models/page_block_polygon_type_0_item.py +65 -0
  135. openparser/_generated/models/parse_async_body.py +133 -0
  136. openparser/_generated/models/parse_batch_body.py +143 -0
  137. openparser/_generated/models/parse_batch_item.py +109 -0
  138. openparser/_generated/models/parse_batch_item_ocr_options.py +78 -0
  139. openparser/_generated/models/parse_batch_request.py +100 -0
  140. openparser/_generated/models/parse_batch_request_items_item.py +108 -0
  141. openparser/_generated/models/parse_batch_request_items_item_ocr_options.py +78 -0
  142. openparser/_generated/models/parse_batch_request_output_format.py +8 -0
  143. openparser/_generated/models/parse_request.py +112 -0
  144. openparser/_generated/models/parse_request_ocr_options.py +78 -0
  145. openparser/_generated/models/parse_request_output_format.py +8 -0
  146. openparser/_generated/models/parse_sync_body.py +133 -0
  147. openparser/_generated/models/parsed_document.py +187 -0
  148. openparser/_generated/models/public_file.py +117 -0
  149. openparser/_generated/models/raw_parse_result.py +110 -0
  150. openparser/_generated/models/raw_parse_result_result.py +65 -0
  151. openparser/_generated/models/region.py +224 -0
  152. openparser/_generated/models/region_content.py +155 -0
  153. openparser/_generated/models/region_polygon_type_0_item.py +65 -0
  154. openparser/_generated/models/region_type.py +16 -0
  155. openparser/_generated/models/suggest_schema_request.py +69 -0
  156. openparser/_generated/models/suggest_schema_response.py +74 -0
  157. openparser/_generated/models/suggest_schema_response_schema.py +66 -0
  158. openparser/_generated/models/update_extraction_pipeline_request.py +227 -0
  159. openparser/_generated/models/update_extraction_pipeline_request_grounding.py +8 -0
  160. openparser/_generated/models/update_extraction_pipeline_request_llm_options_type_0.py +84 -0
  161. openparser/_generated/models/update_extraction_pipeline_request_llm_options_type_0_reasoning_effort_type_1.py +13 -0
  162. openparser/_generated/models/update_extraction_pipeline_request_ocr_options_type_0.py +78 -0
  163. openparser/_generated/models/update_extraction_pipeline_request_schema.py +67 -0
  164. openparser/_generated/py.typed +1 -0
  165. openparser/_generated/types.py +53 -0
  166. openparser/_telemetry.py +34 -0
  167. openparser/client.py +541 -0
  168. openparser/errors.py +172 -0
  169. openparser/py.typed +0 -0
  170. openparser_sdk-0.0.1.dist-info/METADATA +178 -0
  171. openparser_sdk-0.0.1.dist-info/RECORD +173 -0
  172. openparser_sdk-0.0.1.dist-info/WHEEL +4 -0
  173. openparser_sdk-0.0.1.dist-info/licenses/LICENSE +201 -0
@@ -0,0 +1,198 @@
1
+ from http import HTTPStatus
2
+ from typing import Any
3
+ from urllib.parse import quote
4
+
5
+ import httpx
6
+
7
+ from ...client import AuthenticatedClient, Client
8
+ from ...types import Response
9
+ from ... import errors
10
+
11
+ from ...models.error_response import ErrorResponse
12
+
13
+
14
+
15
+ def _get_kwargs(
16
+ id: str,
17
+
18
+ ) -> dict[str, Any]:
19
+
20
+
21
+
22
+
23
+
24
+
25
+ _kwargs: dict[str, Any] = {
26
+ "method": "get",
27
+ "url": "/files/{id}/content".format(id=quote(str(id), safe=""),),
28
+ }
29
+
30
+
31
+ return _kwargs
32
+
33
+
34
+
35
+ def _parse_response(*, client: AuthenticatedClient | Client, response: httpx.Response) -> ErrorResponse | bytes | None:
36
+ if response.status_code == 200:
37
+ response_200 = response.content
38
+
39
+
40
+
41
+ return response_200
42
+
43
+ if response.status_code == 401:
44
+ response_401 = ErrorResponse.from_dict(response.json())
45
+
46
+
47
+
48
+ return response_401
49
+
50
+ if response.status_code == 403:
51
+ response_403 = ErrorResponse.from_dict(response.json())
52
+
53
+
54
+
55
+ return response_403
56
+
57
+ if response.status_code == 404:
58
+ response_404 = ErrorResponse.from_dict(response.json())
59
+
60
+
61
+
62
+ return response_404
63
+
64
+ if response.status_code == 429:
65
+ response_429 = ErrorResponse.from_dict(response.json())
66
+
67
+
68
+
69
+ return response_429
70
+
71
+ if client.raise_on_unexpected_status:
72
+ raise errors.UnexpectedStatus(response.status_code, response.content)
73
+ else:
74
+ return None
75
+
76
+
77
+ def _build_response(*, client: AuthenticatedClient | Client, response: httpx.Response) -> Response[ErrorResponse | bytes]:
78
+ return Response(
79
+ status_code=HTTPStatus(response.status_code),
80
+ content=response.content,
81
+ headers=response.headers,
82
+ parsed=_parse_response(client=client, response=response),
83
+ )
84
+
85
+
86
+ def sync_detailed(
87
+ id: str,
88
+ *,
89
+ client: AuthenticatedClient | Client,
90
+
91
+ ) -> Response[ErrorResponse | bytes]:
92
+ """ Download reusable file bytes
93
+
94
+ Args:
95
+ id (str):
96
+
97
+ Raises:
98
+ errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
99
+ httpx.TimeoutException: If the request takes longer than Client.timeout.
100
+
101
+ Returns:
102
+ Response[ErrorResponse | bytes]
103
+ """
104
+
105
+
106
+ kwargs = _get_kwargs(
107
+ id=id,
108
+
109
+ )
110
+
111
+ response = client.get_httpx_client().request(
112
+ **kwargs,
113
+ )
114
+
115
+ return _build_response(client=client, response=response)
116
+
117
+ def sync(
118
+ id: str,
119
+ *,
120
+ client: AuthenticatedClient | Client,
121
+
122
+ ) -> ErrorResponse | bytes | None:
123
+ """ Download reusable file bytes
124
+
125
+ Args:
126
+ id (str):
127
+
128
+ Raises:
129
+ errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
130
+ httpx.TimeoutException: If the request takes longer than Client.timeout.
131
+
132
+ Returns:
133
+ ErrorResponse | bytes
134
+ """
135
+
136
+
137
+ return sync_detailed(
138
+ id=id,
139
+ client=client,
140
+
141
+ ).parsed
142
+
143
+ async def asyncio_detailed(
144
+ id: str,
145
+ *,
146
+ client: AuthenticatedClient | Client,
147
+
148
+ ) -> Response[ErrorResponse | bytes]:
149
+ """ Download reusable file bytes
150
+
151
+ Args:
152
+ id (str):
153
+
154
+ Raises:
155
+ errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
156
+ httpx.TimeoutException: If the request takes longer than Client.timeout.
157
+
158
+ Returns:
159
+ Response[ErrorResponse | bytes]
160
+ """
161
+
162
+
163
+ kwargs = _get_kwargs(
164
+ id=id,
165
+
166
+ )
167
+
168
+ response = await client.get_async_httpx_client().request(
169
+ **kwargs
170
+ )
171
+
172
+ return _build_response(client=client, response=response)
173
+
174
+ async def asyncio(
175
+ id: str,
176
+ *,
177
+ client: AuthenticatedClient | Client,
178
+
179
+ ) -> ErrorResponse | bytes | None:
180
+ """ Download reusable file bytes
181
+
182
+ Args:
183
+ id (str):
184
+
185
+ Raises:
186
+ errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
187
+ httpx.TimeoutException: If the request takes longer than Client.timeout.
188
+
189
+ Returns:
190
+ ErrorResponse | bytes
191
+ """
192
+
193
+
194
+ return (await asyncio_detailed(
195
+ id=id,
196
+ client=client,
197
+
198
+ )).parsed
@@ -0,0 +1 @@
1
+ """ Contains endpoint functions for accessing the API """
@@ -0,0 +1,261 @@
1
+ from http import HTTPStatus
2
+ from typing import Any, cast
3
+ from urllib.parse import quote
4
+
5
+ import httpx
6
+
7
+ from ...client import AuthenticatedClient, Client
8
+ from ...types import Response, UNSET
9
+ from ... import errors
10
+
11
+ from ...models.error_response import ErrorResponse
12
+ from ...models.job import Job
13
+ from ...types import UNSET, Unset
14
+ from typing import cast
15
+
16
+
17
+
18
+ def _get_kwargs(
19
+ id: str,
20
+ *,
21
+ cursor: str | Unset = UNSET,
22
+ limit: int | Unset = 50,
23
+
24
+ ) -> dict[str, Any]:
25
+
26
+
27
+
28
+
29
+ params: dict[str, Any] = {}
30
+
31
+ params["cursor"] = cursor
32
+
33
+ params["limit"] = limit
34
+
35
+
36
+ params = {k: v for k, v in params.items() if v is not UNSET and v is not None}
37
+
38
+
39
+ _kwargs: dict[str, Any] = {
40
+ "method": "get",
41
+ "url": "/jobs/{id}".format(id=quote(str(id), safe=""),),
42
+ "params": params,
43
+ }
44
+
45
+
46
+ return _kwargs
47
+
48
+
49
+
50
+ def _parse_response(*, client: AuthenticatedClient | Client, response: httpx.Response) -> ErrorResponse | Job | None:
51
+ if response.status_code == 200:
52
+ response_200 = Job.from_dict(response.json())
53
+
54
+
55
+
56
+ return response_200
57
+
58
+ if response.status_code == 401:
59
+ response_401 = ErrorResponse.from_dict(response.json())
60
+
61
+
62
+
63
+ return response_401
64
+
65
+ if response.status_code == 403:
66
+ response_403 = ErrorResponse.from_dict(response.json())
67
+
68
+
69
+
70
+ return response_403
71
+
72
+ if response.status_code == 404:
73
+ response_404 = ErrorResponse.from_dict(response.json())
74
+
75
+
76
+
77
+ return response_404
78
+
79
+ if response.status_code == 429:
80
+ response_429 = ErrorResponse.from_dict(response.json())
81
+
82
+
83
+
84
+ return response_429
85
+
86
+ if client.raise_on_unexpected_status:
87
+ raise errors.UnexpectedStatus(response.status_code, response.content)
88
+ else:
89
+ return None
90
+
91
+
92
+ def _build_response(*, client: AuthenticatedClient | Client, response: httpx.Response) -> Response[ErrorResponse | Job]:
93
+ return Response(
94
+ status_code=HTTPStatus(response.status_code),
95
+ content=response.content,
96
+ headers=response.headers,
97
+ parsed=_parse_response(client=client, response=response),
98
+ )
99
+
100
+
101
+ def sync_detailed(
102
+ id: str,
103
+ *,
104
+ client: AuthenticatedClient | Client,
105
+ cursor: str | Unset = UNSET,
106
+ limit: int | Unset = 50,
107
+
108
+ ) -> Response[ErrorResponse | Job]:
109
+ """ Get job status and result
110
+
111
+ Tenant-scoped durable job read. Jobs belonging to another tenant return `404`. Batch jobs
112
+ include cursor-paginated child summaries. Playground tokens (`ocr:playground`) and `ocr:full`
113
+ keys are both accepted. Successful parse jobs return the originally requested `output_format`
114
+ in `result`; use `GET /jobs/{id}/result?format=` to select an alternate stored representation
115
+ without re-running OCR.
116
+
117
+ Args:
118
+ id (str): Prefixed public id for an OCR job (`opj_…`). Example: opj_V1StGXR8_Z5jdHi6B-myT.
119
+ cursor (str | Unset):
120
+ limit (int | Unset): Default: 50.
121
+
122
+ Raises:
123
+ errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
124
+ httpx.TimeoutException: If the request takes longer than Client.timeout.
125
+
126
+ Returns:
127
+ Response[ErrorResponse | Job]
128
+ """
129
+
130
+
131
+ kwargs = _get_kwargs(
132
+ id=id,
133
+ cursor=cursor,
134
+ limit=limit,
135
+
136
+ )
137
+
138
+ response = client.get_httpx_client().request(
139
+ **kwargs,
140
+ )
141
+
142
+ return _build_response(client=client, response=response)
143
+
144
+ def sync(
145
+ id: str,
146
+ *,
147
+ client: AuthenticatedClient | Client,
148
+ cursor: str | Unset = UNSET,
149
+ limit: int | Unset = 50,
150
+
151
+ ) -> ErrorResponse | Job | None:
152
+ """ Get job status and result
153
+
154
+ Tenant-scoped durable job read. Jobs belonging to another tenant return `404`. Batch jobs
155
+ include cursor-paginated child summaries. Playground tokens (`ocr:playground`) and `ocr:full`
156
+ keys are both accepted. Successful parse jobs return the originally requested `output_format`
157
+ in `result`; use `GET /jobs/{id}/result?format=` to select an alternate stored representation
158
+ without re-running OCR.
159
+
160
+ Args:
161
+ id (str): Prefixed public id for an OCR job (`opj_…`). Example: opj_V1StGXR8_Z5jdHi6B-myT.
162
+ cursor (str | Unset):
163
+ limit (int | Unset): Default: 50.
164
+
165
+ Raises:
166
+ errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
167
+ httpx.TimeoutException: If the request takes longer than Client.timeout.
168
+
169
+ Returns:
170
+ ErrorResponse | Job
171
+ """
172
+
173
+
174
+ return sync_detailed(
175
+ id=id,
176
+ client=client,
177
+ cursor=cursor,
178
+ limit=limit,
179
+
180
+ ).parsed
181
+
182
+ async def asyncio_detailed(
183
+ id: str,
184
+ *,
185
+ client: AuthenticatedClient | Client,
186
+ cursor: str | Unset = UNSET,
187
+ limit: int | Unset = 50,
188
+
189
+ ) -> Response[ErrorResponse | Job]:
190
+ """ Get job status and result
191
+
192
+ Tenant-scoped durable job read. Jobs belonging to another tenant return `404`. Batch jobs
193
+ include cursor-paginated child summaries. Playground tokens (`ocr:playground`) and `ocr:full`
194
+ keys are both accepted. Successful parse jobs return the originally requested `output_format`
195
+ in `result`; use `GET /jobs/{id}/result?format=` to select an alternate stored representation
196
+ without re-running OCR.
197
+
198
+ Args:
199
+ id (str): Prefixed public id for an OCR job (`opj_…`). Example: opj_V1StGXR8_Z5jdHi6B-myT.
200
+ cursor (str | Unset):
201
+ limit (int | Unset): Default: 50.
202
+
203
+ Raises:
204
+ errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
205
+ httpx.TimeoutException: If the request takes longer than Client.timeout.
206
+
207
+ Returns:
208
+ Response[ErrorResponse | Job]
209
+ """
210
+
211
+
212
+ kwargs = _get_kwargs(
213
+ id=id,
214
+ cursor=cursor,
215
+ limit=limit,
216
+
217
+ )
218
+
219
+ response = await client.get_async_httpx_client().request(
220
+ **kwargs
221
+ )
222
+
223
+ return _build_response(client=client, response=response)
224
+
225
+ async def asyncio(
226
+ id: str,
227
+ *,
228
+ client: AuthenticatedClient | Client,
229
+ cursor: str | Unset = UNSET,
230
+ limit: int | Unset = 50,
231
+
232
+ ) -> ErrorResponse | Job | None:
233
+ """ Get job status and result
234
+
235
+ Tenant-scoped durable job read. Jobs belonging to another tenant return `404`. Batch jobs
236
+ include cursor-paginated child summaries. Playground tokens (`ocr:playground`) and `ocr:full`
237
+ keys are both accepted. Successful parse jobs return the originally requested `output_format`
238
+ in `result`; use `GET /jobs/{id}/result?format=` to select an alternate stored representation
239
+ without re-running OCR.
240
+
241
+ Args:
242
+ id (str): Prefixed public id for an OCR job (`opj_…`). Example: opj_V1StGXR8_Z5jdHi6B-myT.
243
+ cursor (str | Unset):
244
+ limit (int | Unset): Default: 50.
245
+
246
+ Raises:
247
+ errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
248
+ httpx.TimeoutException: If the request takes longer than Client.timeout.
249
+
250
+ Returns:
251
+ ErrorResponse | Job
252
+ """
253
+
254
+
255
+ return (await asyncio_detailed(
256
+ id=id,
257
+ client=client,
258
+ cursor=cursor,
259
+ limit=limit,
260
+
261
+ )).parsed