@alien_intelligence/data-api-client 1.4.15 → 1.11.0

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 (288) hide show
  1. package/dist/src/apis/AdminApi.d.ts +1 -1
  2. package/dist/src/apis/AdminApi.js +1 -1
  3. package/dist/src/apis/DatasetsApi.d.ts +1 -1
  4. package/dist/src/apis/DatasetsApi.js +1 -1
  5. package/dist/src/apis/DefaultApi.d.ts +1 -1
  6. package/dist/src/apis/DefaultApi.js +1 -1
  7. package/dist/src/apis/EmbeddingsApi.d.ts +1 -1
  8. package/dist/src/apis/EmbeddingsApi.js +1 -1
  9. package/dist/src/apis/EntriesApi.d.ts +33 -6
  10. package/dist/src/apis/EntriesApi.js +29 -3
  11. package/dist/src/apis/HealthApi.d.ts +1 -1
  12. package/dist/src/apis/HealthApi.js +1 -1
  13. package/dist/src/apis/PipelinesApi.d.ts +1 -1
  14. package/dist/src/apis/PipelinesApi.js +1 -1
  15. package/dist/src/apis/SearchApi.d.ts +1 -1
  16. package/dist/src/apis/SearchApi.js +1 -1
  17. package/dist/src/apis/SyncApi.d.ts +1 -1
  18. package/dist/src/apis/SyncApi.js +1 -1
  19. package/dist/src/apis/WebhooksApi.d.ts +1 -1
  20. package/dist/src/apis/WebhooksApi.js +1 -1
  21. package/dist/src/apis/WeightsApi.d.ts +1 -1
  22. package/dist/src/apis/WeightsApi.js +1 -1
  23. package/dist/src/models/ArtifactInputConfig.d.ts +1 -1
  24. package/dist/src/models/ArtifactInputConfig.js +1 -1
  25. package/dist/src/models/BatchContentRequest.d.ts +1 -1
  26. package/dist/src/models/BatchContentRequest.js +1 -1
  27. package/dist/src/models/BatchContentResponse.d.ts +1 -1
  28. package/dist/src/models/BatchContentResponse.js +1 -1
  29. package/dist/src/models/BatchGetEntriesRequest.d.ts +1 -1
  30. package/dist/src/models/BatchGetEntriesRequest.js +1 -1
  31. package/dist/src/models/BatchGetEntriesResponse.d.ts +1 -1
  32. package/dist/src/models/BatchGetEntriesResponse.js +1 -1
  33. package/dist/src/models/ChunkSearchResponse.d.ts +1 -1
  34. package/dist/src/models/ChunkSearchResponse.js +1 -1
  35. package/dist/src/models/ChunkSearchResult.d.ts +1 -1
  36. package/dist/src/models/ChunkSearchResult.js +1 -1
  37. package/dist/src/models/CollectionInfo.d.ts +1 -1
  38. package/dist/src/models/CollectionInfo.js +1 -1
  39. package/dist/src/models/ComponentArtifact.d.ts +1 -1
  40. package/dist/src/models/ComponentArtifact.js +1 -1
  41. package/dist/src/models/ComponentListResponse.d.ts +1 -1
  42. package/dist/src/models/ComponentListResponse.js +1 -1
  43. package/dist/src/models/ComponentMetadata.d.ts +1 -1
  44. package/dist/src/models/ComponentMetadata.js +1 -1
  45. package/dist/src/models/ComponentParameter.d.ts +1 -1
  46. package/dist/src/models/ComponentParameter.js +1 -1
  47. package/dist/src/models/Dataset.d.ts +1 -1
  48. package/dist/src/models/Dataset.js +1 -1
  49. package/dist/src/models/DatasetCreateRequest.d.ts +1 -1
  50. package/dist/src/models/DatasetCreateRequest.js +1 -1
  51. package/dist/src/models/DatasetListResponse.d.ts +1 -1
  52. package/dist/src/models/DatasetListResponse.js +1 -1
  53. package/dist/src/models/DatasetPipelineConfig.d.ts +1 -1
  54. package/dist/src/models/DatasetPipelineConfig.js +1 -1
  55. package/dist/src/models/DatasetResponse.d.ts +1 -1
  56. package/dist/src/models/DatasetResponse.js +1 -1
  57. package/dist/src/models/DatasetSchemaDefinition.d.ts +1 -1
  58. package/dist/src/models/DatasetSchemaDefinition.js +1 -1
  59. package/dist/src/models/DatasetSchemaOriginal.d.ts +1 -1
  60. package/dist/src/models/DatasetSchemaOriginal.js +1 -1
  61. package/dist/src/models/DatasetSchemaProcessed.d.ts +1 -1
  62. package/dist/src/models/DatasetSchemaProcessed.js +1 -1
  63. package/dist/src/models/DatasetSchemaProcessing.d.ts +1 -1
  64. package/dist/src/models/DatasetSchemaProcessing.js +1 -1
  65. package/dist/src/models/DatasetType.d.ts +1 -1
  66. package/dist/src/models/DatasetType.js +1 -1
  67. package/dist/src/models/DatasetUpdateRequest.d.ts +1 -1
  68. package/dist/src/models/DatasetUpdateRequest.js +1 -1
  69. package/dist/src/models/DatasetUpdateSchemaRequest.d.ts +1 -1
  70. package/dist/src/models/DatasetUpdateSchemaRequest.js +1 -1
  71. package/dist/src/models/Default.d.ts +1 -1
  72. package/dist/src/models/Default.js +1 -1
  73. package/dist/src/models/DeprecationNotice.d.ts +42 -0
  74. package/dist/src/models/DeprecationNotice.js +54 -0
  75. package/dist/src/models/DerivedPageReport.d.ts +85 -0
  76. package/dist/src/models/DerivedPageReport.js +74 -0
  77. package/dist/src/models/EmbeddingProvider.d.ts +1 -1
  78. package/dist/src/models/EmbeddingProvider.js +1 -1
  79. package/dist/src/models/EmbeddingResponse.d.ts +1 -1
  80. package/dist/src/models/EmbeddingResponse.js +1 -1
  81. package/dist/src/models/Entry.d.ts +1 -1
  82. package/dist/src/models/Entry.js +1 -1
  83. package/dist/src/models/EntryContentResponse.d.ts +1 -1
  84. package/dist/src/models/EntryContentResponse.js +1 -1
  85. package/dist/src/models/EntryCreateRequest.d.ts +1 -1
  86. package/dist/src/models/EntryCreateRequest.js +1 -1
  87. package/dist/src/models/EntryCreateResponse.d.ts +1 -1
  88. package/dist/src/models/EntryCreateResponse.js +1 -1
  89. package/dist/src/models/EntryManifest.d.ts +1 -1
  90. package/dist/src/models/EntryManifest.js +1 -1
  91. package/dist/src/models/EntrySearchResponse.d.ts +1 -1
  92. package/dist/src/models/EntrySearchResponse.js +1 -1
  93. package/dist/src/models/EntrySearchResult.d.ts +1 -1
  94. package/dist/src/models/EntrySearchResult.js +1 -1
  95. package/dist/src/models/EntryStatus.d.ts +1 -1
  96. package/dist/src/models/EntryStatus.js +1 -1
  97. package/dist/src/models/EntryUpdateRequest.d.ts +7 -1
  98. package/dist/src/models/EntryUpdateRequest.js +3 -1
  99. package/dist/src/models/EntryWithContent.d.ts +1 -1
  100. package/dist/src/models/EntryWithContent.js +1 -1
  101. package/dist/src/models/FigureImage.d.ts +80 -0
  102. package/dist/src/models/FigureImage.js +62 -0
  103. package/dist/src/models/FileMetadata.d.ts +1 -1
  104. package/dist/src/models/FileMetadata.js +1 -1
  105. package/dist/src/models/GenerateEmbeddingsRequest.d.ts +1 -1
  106. package/dist/src/models/GenerateEmbeddingsRequest.js +1 -1
  107. package/dist/src/models/HTTPValidationError.d.ts +1 -1
  108. package/dist/src/models/HTTPValidationError.js +1 -1
  109. package/dist/src/models/HealthResponse.d.ts +1 -1
  110. package/dist/src/models/HealthResponse.js +1 -1
  111. package/dist/src/models/IngestContractUsageResponse.d.ts +49 -0
  112. package/dist/src/models/IngestContractUsageResponse.js +59 -0
  113. package/dist/src/models/IngestContractUsageRow.d.ts +56 -0
  114. package/dist/src/models/IngestContractUsageRow.js +66 -0
  115. package/dist/src/models/KeywordSearchHit.d.ts +1 -1
  116. package/dist/src/models/KeywordSearchHit.js +1 -1
  117. package/dist/src/models/KeywordSearchRequest.d.ts +1 -1
  118. package/dist/src/models/KeywordSearchRequest.js +1 -1
  119. package/dist/src/models/KeywordSearchRequestMetadataFiltersValue.d.ts +1 -1
  120. package/dist/src/models/KeywordSearchRequestMetadataFiltersValue.js +1 -1
  121. package/dist/src/models/KeywordSearchResponse.d.ts +1 -1
  122. package/dist/src/models/KeywordSearchResponse.js +1 -1
  123. package/dist/src/models/MissingPageRange.d.ts +57 -0
  124. package/dist/src/models/MissingPageRange.js +58 -0
  125. package/dist/src/models/ModelInfo.d.ts +1 -1
  126. package/dist/src/models/ModelInfo.js +1 -1
  127. package/dist/src/models/MoveEntryRequest.d.ts +1 -1
  128. package/dist/src/models/MoveEntryRequest.js +1 -1
  129. package/dist/src/models/MoveEntryResponse.d.ts +1 -1
  130. package/dist/src/models/MoveEntryResponse.js +1 -1
  131. package/dist/src/models/OriginalManifest.d.ts +1 -1
  132. package/dist/src/models/OriginalManifest.js +1 -1
  133. package/dist/src/models/PageDimensions.d.ts +38 -0
  134. package/dist/src/models/PageDimensions.js +54 -0
  135. package/dist/src/models/PipelineStepConfig.d.ts +1 -1
  136. package/dist/src/models/PipelineStepConfig.js +1 -1
  137. package/dist/src/models/PresetListResponse.d.ts +1 -1
  138. package/dist/src/models/PresetListResponse.js +1 -1
  139. package/dist/src/models/ProcessedManifest.d.ts +29 -3
  140. package/dist/src/models/ProcessedManifest.js +15 -1
  141. package/dist/src/models/ProcessingManifest.d.ts +1 -1
  142. package/dist/src/models/ProcessingManifest.js +1 -1
  143. package/dist/src/models/ReconcileSchemaFieldsResponse.d.ts +1 -1
  144. package/dist/src/models/ReconcileSchemaFieldsResponse.js +1 -1
  145. package/dist/src/models/RetryFailedWebhooksResponse.d.ts +1 -1
  146. package/dist/src/models/RetryFailedWebhooksResponse.js +1 -1
  147. package/dist/src/models/SaveProcessedContentRequest.d.ts +35 -2
  148. package/dist/src/models/SaveProcessedContentRequest.js +7 -1
  149. package/dist/src/models/SaveProcessedContentResponse.d.ts +29 -1
  150. package/dist/src/models/SaveProcessedContentResponse.js +17 -1
  151. package/dist/src/models/SearchSnippet.d.ts +1 -1
  152. package/dist/src/models/SearchSnippet.js +1 -1
  153. package/dist/src/models/Segment.d.ts +93 -0
  154. package/dist/src/models/Segment.js +93 -0
  155. package/dist/src/models/SnippetContext.d.ts +1 -1
  156. package/dist/src/models/SnippetContext.js +1 -1
  157. package/dist/src/models/Transcription.d.ts +63 -0
  158. package/dist/src/models/Transcription.js +68 -0
  159. package/dist/src/models/TranscriptionDocumentInfo.d.ts +66 -0
  160. package/dist/src/models/TranscriptionDocumentInfo.js +76 -0
  161. package/dist/src/models/TranscriptionPage.d.ts +82 -0
  162. package/dist/src/models/TranscriptionPage.js +81 -0
  163. package/dist/src/models/TranscriptionUsage.d.ts +56 -0
  164. package/dist/src/models/TranscriptionUsage.js +62 -0
  165. package/dist/src/models/TranscriptionWarnings.d.ts +113 -0
  166. package/dist/src/models/TranscriptionWarnings.js +68 -0
  167. package/dist/src/models/UploadFileResponse.d.ts +1 -1
  168. package/dist/src/models/UploadFileResponse.js +1 -1
  169. package/dist/src/models/ValidationError.d.ts +1 -1
  170. package/dist/src/models/ValidationError.js +1 -1
  171. package/dist/src/models/ValidationErrorLocInner.d.ts +1 -1
  172. package/dist/src/models/ValidationErrorLocInner.js +1 -1
  173. package/dist/src/models/VectorSearchRequest.d.ts +1 -1
  174. package/dist/src/models/VectorSearchRequest.js +1 -1
  175. package/dist/src/models/WebhookEndpointCreate.d.ts +1 -1
  176. package/dist/src/models/WebhookEndpointCreate.js +1 -1
  177. package/dist/src/models/WebhookEndpointResponse.d.ts +1 -1
  178. package/dist/src/models/WebhookEndpointResponse.js +1 -1
  179. package/dist/src/models/Weight.d.ts +1 -1
  180. package/dist/src/models/Weight.js +1 -1
  181. package/dist/src/models/WeightListResponse.d.ts +1 -1
  182. package/dist/src/models/WeightListResponse.js +1 -1
  183. package/dist/src/models/WeightResponse.d.ts +1 -1
  184. package/dist/src/models/WeightResponse.js +1 -1
  185. package/dist/src/models/WeightType.d.ts +1 -1
  186. package/dist/src/models/WeightType.js +1 -1
  187. package/dist/src/models/index.d.ts +13 -0
  188. package/dist/src/models/index.js +13 -0
  189. package/dist/src/runtime.d.ts +1 -1
  190. package/dist/src/runtime.js +1 -1
  191. package/package.json +1 -1
  192. package/src/README.md +2 -2
  193. package/src/package.json +1 -1
  194. package/src/src/apis/AdminApi.ts +1 -1
  195. package/src/src/apis/DatasetsApi.ts +1 -1
  196. package/src/src/apis/DefaultApi.ts +1 -1
  197. package/src/src/apis/EmbeddingsApi.ts +1 -1
  198. package/src/src/apis/EntriesApi.ts +60 -5
  199. package/src/src/apis/HealthApi.ts +1 -1
  200. package/src/src/apis/PipelinesApi.ts +1 -1
  201. package/src/src/apis/SearchApi.ts +1 -1
  202. package/src/src/apis/SyncApi.ts +1 -1
  203. package/src/src/apis/WebhooksApi.ts +1 -1
  204. package/src/src/apis/WeightsApi.ts +1 -1
  205. package/src/src/models/ArtifactInputConfig.ts +1 -1
  206. package/src/src/models/BatchContentRequest.ts +1 -1
  207. package/src/src/models/BatchContentResponse.ts +1 -1
  208. package/src/src/models/BatchGetEntriesRequest.ts +1 -1
  209. package/src/src/models/BatchGetEntriesResponse.ts +1 -1
  210. package/src/src/models/ChunkSearchResponse.ts +1 -1
  211. package/src/src/models/ChunkSearchResult.ts +1 -1
  212. package/src/src/models/CollectionInfo.ts +1 -1
  213. package/src/src/models/ComponentArtifact.ts +1 -1
  214. package/src/src/models/ComponentListResponse.ts +1 -1
  215. package/src/src/models/ComponentMetadata.ts +1 -1
  216. package/src/src/models/ComponentParameter.ts +1 -1
  217. package/src/src/models/Dataset.ts +1 -1
  218. package/src/src/models/DatasetCreateRequest.ts +1 -1
  219. package/src/src/models/DatasetListResponse.ts +1 -1
  220. package/src/src/models/DatasetPipelineConfig.ts +1 -1
  221. package/src/src/models/DatasetResponse.ts +1 -1
  222. package/src/src/models/DatasetSchemaDefinition.ts +1 -1
  223. package/src/src/models/DatasetSchemaOriginal.ts +1 -1
  224. package/src/src/models/DatasetSchemaProcessed.ts +1 -1
  225. package/src/src/models/DatasetSchemaProcessing.ts +1 -1
  226. package/src/src/models/DatasetType.ts +1 -1
  227. package/src/src/models/DatasetUpdateRequest.ts +1 -1
  228. package/src/src/models/DatasetUpdateSchemaRequest.ts +1 -1
  229. package/src/src/models/Default.ts +1 -1
  230. package/src/src/models/DeprecationNotice.ts +79 -0
  231. package/src/src/models/DerivedPageReport.ts +137 -0
  232. package/src/src/models/EmbeddingProvider.ts +1 -1
  233. package/src/src/models/EmbeddingResponse.ts +1 -1
  234. package/src/src/models/Entry.ts +1 -1
  235. package/src/src/models/EntryContentResponse.ts +1 -1
  236. package/src/src/models/EntryCreateRequest.ts +1 -1
  237. package/src/src/models/EntryCreateResponse.ts +1 -1
  238. package/src/src/models/EntryManifest.ts +1 -1
  239. package/src/src/models/EntrySearchResponse.ts +1 -1
  240. package/src/src/models/EntrySearchResult.ts +1 -1
  241. package/src/src/models/EntryStatus.ts +1 -1
  242. package/src/src/models/EntryUpdateRequest.ts +9 -1
  243. package/src/src/models/EntryWithContent.ts +1 -1
  244. package/src/src/models/FigureImage.ts +126 -0
  245. package/src/src/models/FileMetadata.ts +1 -1
  246. package/src/src/models/GenerateEmbeddingsRequest.ts +1 -1
  247. package/src/src/models/HTTPValidationError.ts +1 -1
  248. package/src/src/models/HealthResponse.ts +1 -1
  249. package/src/src/models/IngestContractUsageResponse.ts +96 -0
  250. package/src/src/models/IngestContractUsageRow.ts +102 -0
  251. package/src/src/models/KeywordSearchHit.ts +1 -1
  252. package/src/src/models/KeywordSearchRequest.ts +1 -1
  253. package/src/src/models/KeywordSearchRequestMetadataFiltersValue.ts +1 -1
  254. package/src/src/models/KeywordSearchResponse.ts +1 -1
  255. package/src/src/models/MissingPageRange.ts +100 -0
  256. package/src/src/models/ModelInfo.ts +1 -1
  257. package/src/src/models/MoveEntryRequest.ts +1 -1
  258. package/src/src/models/MoveEntryResponse.ts +1 -1
  259. package/src/src/models/OriginalManifest.ts +1 -1
  260. package/src/src/models/PageDimensions.ts +75 -0
  261. package/src/src/models/PipelineStepConfig.ts +1 -1
  262. package/src/src/models/PresetListResponse.ts +1 -1
  263. package/src/src/models/ProcessedManifest.ts +42 -3
  264. package/src/src/models/ProcessingManifest.ts +1 -1
  265. package/src/src/models/ReconcileSchemaFieldsResponse.ts +1 -1
  266. package/src/src/models/RetryFailedWebhooksResponse.ts +1 -1
  267. package/src/src/models/SaveProcessedContentRequest.ts +52 -2
  268. package/src/src/models/SaveProcessedContentResponse.ts +44 -1
  269. package/src/src/models/SearchSnippet.ts +1 -1
  270. package/src/src/models/Segment.ts +148 -0
  271. package/src/src/models/SnippetContext.ts +1 -1
  272. package/src/src/models/Transcription.ts +133 -0
  273. package/src/src/models/TranscriptionDocumentInfo.ts +115 -0
  274. package/src/src/models/TranscriptionPage.ts +144 -0
  275. package/src/src/models/TranscriptionUsage.ts +100 -0
  276. package/src/src/models/TranscriptionWarnings.ts +171 -0
  277. package/src/src/models/UploadFileResponse.ts +1 -1
  278. package/src/src/models/ValidationError.ts +1 -1
  279. package/src/src/models/ValidationErrorLocInner.ts +1 -1
  280. package/src/src/models/VectorSearchRequest.ts +1 -1
  281. package/src/src/models/WebhookEndpointCreate.ts +1 -1
  282. package/src/src/models/WebhookEndpointResponse.ts +1 -1
  283. package/src/src/models/Weight.ts +1 -1
  284. package/src/src/models/WeightListResponse.ts +1 -1
  285. package/src/src/models/WeightResponse.ts +1 -1
  286. package/src/src/models/WeightType.ts +1 -1
  287. package/src/src/models/index.ts +13 -0
  288. package/src/src/runtime.ts +1 -1
@@ -5,7 +5,7 @@
5
5
  * Client Data API
6
6
  * Client Cluster Data API - Manifest-based storage service
7
7
  *
8
- * The version of the OpenAPI document: 1.4.15
8
+ * The version of the OpenAPI document: 1.11.0
9
9
  *
10
10
  *
11
11
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -13,12 +13,22 @@
13
13
  * Do not edit the class manually.
14
14
  */
15
15
  Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.SaveProcessedContentResponseSegmentsSourceEnum = void 0;
16
17
  exports.instanceOfSaveProcessedContentResponse = instanceOfSaveProcessedContentResponse;
17
18
  exports.SaveProcessedContentResponseFromJSON = SaveProcessedContentResponseFromJSON;
18
19
  exports.SaveProcessedContentResponseFromJSONTyped = SaveProcessedContentResponseFromJSONTyped;
19
20
  exports.SaveProcessedContentResponseToJSON = SaveProcessedContentResponseToJSON;
20
21
  exports.SaveProcessedContentResponseToJSONTyped = SaveProcessedContentResponseToJSONTyped;
22
+ const DeprecationNotice_1 = require("./DeprecationNotice");
21
23
  const EntryManifest_1 = require("./EntryManifest");
24
+ /**
25
+ * @export
26
+ */
27
+ exports.SaveProcessedContentResponseSegmentsSourceEnum = {
28
+ ProducerPages: 'producer_pages',
29
+ DerivedMarkdown: 'derived_markdown',
30
+ DerivedFixed: 'derived_fixed'
31
+ };
22
32
  /**
23
33
  * Check if a given object implements the SaveProcessedContentResponse interface.
24
34
  */
@@ -40,6 +50,9 @@ function SaveProcessedContentResponseFromJSONTyped(json, ignoreDiscriminator) {
40
50
  'entryId': json['entry_id'],
41
51
  'manifest': (0, EntryManifest_1.EntryManifestFromJSON)(json['manifest']),
42
52
  'success': json['success'] == null ? undefined : json['success'],
53
+ 'segmentsSource': json['segments_source'] == null ? undefined : json['segments_source'],
54
+ 'segmentCount': json['segment_count'] == null ? undefined : json['segment_count'],
55
+ 'deprecation': json['deprecation'] == null ? undefined : (0, DeprecationNotice_1.DeprecationNoticeFromJSON)(json['deprecation']),
43
56
  };
44
57
  }
45
58
  function SaveProcessedContentResponseToJSON(json) {
@@ -53,5 +66,8 @@ function SaveProcessedContentResponseToJSONTyped(value, ignoreDiscriminator = fa
53
66
  'entry_id': value['entryId'],
54
67
  'manifest': (0, EntryManifest_1.EntryManifestToJSON)(value['manifest']),
55
68
  'success': value['success'],
69
+ 'segments_source': value['segmentsSource'],
70
+ 'segment_count': value['segmentCount'],
71
+ 'deprecation': (0, DeprecationNotice_1.DeprecationNoticeToJSON)(value['deprecation']),
56
72
  };
57
73
  }
@@ -2,7 +2,7 @@
2
2
  * Client Data API
3
3
  * Client Cluster Data API - Manifest-based storage service
4
4
  *
5
- * The version of the OpenAPI document: 1.4.15
5
+ * The version of the OpenAPI document: 1.11.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -5,7 +5,7 @@
5
5
  * Client Data API
6
6
  * Client Cluster Data API - Manifest-based storage service
7
7
  *
8
- * The version of the OpenAPI document: 1.4.15
8
+ * The version of the OpenAPI document: 1.11.0
9
9
  *
10
10
  *
11
11
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -0,0 +1,93 @@
1
+ /**
2
+ * Client Data API
3
+ * Client Cluster Data API - Manifest-based storage service
4
+ *
5
+ * The version of the OpenAPI document: 1.11.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ * One citable unit of a processed document, as a span of the canonical text.
14
+ * @export
15
+ * @interface Segment
16
+ */
17
+ export interface Segment {
18
+ /**
19
+ * Position in this document's segment list, dense from 0. This is the ordering key and half of the page document's primary key; it is not a page number.
20
+ * @type {number}
21
+ * @memberof Segment
22
+ */
23
+ seq: number;
24
+ /**
25
+ * What this unit is. 'page' covers folios, PDF pages and worksheets.
26
+ * @type {string}
27
+ * @memberof Segment
28
+ */
29
+ kind?: SegmentKindEnum;
30
+ /**
31
+ * What the document calls this unit - the string a citation shows. Sparse and not necessarily numeric: BnF folios skip, ocr-gateway reserves the index of a page it lost. Never derive ordering from it.
32
+ * @type {string}
33
+ * @memberof Segment
34
+ */
35
+ label: string;
36
+ /**
37
+ * 'source' if the document itself drew this boundary, 'derived' if it was invented to fit an indexing budget. Required rather than defaulted: a boundary whose provenance was never stated is not a boundary worth citing.
38
+ * @type {string}
39
+ * @memberof Segment
40
+ */
41
+ origin: SegmentOriginEnum;
42
+ /**
43
+ *
44
+ * @type {string}
45
+ * @memberof Segment
46
+ */
47
+ splitRule?: SegmentSplitRuleEnum | null;
48
+ /**
49
+ * Offset of this segment's first character in the canonical text.
50
+ * @type {number}
51
+ * @memberof Segment
52
+ */
53
+ charStart: number;
54
+ /**
55
+ * Offset one past this segment's last character. Exclusive, so text[char_start:char_end] is the segment.
56
+ * @type {number}
57
+ * @memberof Segment
58
+ */
59
+ charEnd: number;
60
+ }
61
+ /**
62
+ * @export
63
+ */
64
+ export declare const SegmentKindEnum: {
65
+ readonly Page: "page";
66
+ };
67
+ export type SegmentKindEnum = typeof SegmentKindEnum[keyof typeof SegmentKindEnum];
68
+ /**
69
+ * @export
70
+ */
71
+ export declare const SegmentOriginEnum: {
72
+ readonly Source: "source";
73
+ readonly Derived: "derived";
74
+ };
75
+ export type SegmentOriginEnum = typeof SegmentOriginEnum[keyof typeof SegmentOriginEnum];
76
+ /**
77
+ * @export
78
+ */
79
+ export declare const SegmentSplitRuleEnum: {
80
+ readonly Paragraph: "paragraph";
81
+ readonly TableRow: "table_row";
82
+ readonly Line: "line";
83
+ readonly Fixed: "fixed";
84
+ };
85
+ export type SegmentSplitRuleEnum = typeof SegmentSplitRuleEnum[keyof typeof SegmentSplitRuleEnum];
86
+ /**
87
+ * Check if a given object implements the Segment interface.
88
+ */
89
+ export declare function instanceOfSegment(value: object): value is Segment;
90
+ export declare function SegmentFromJSON(json: any): Segment;
91
+ export declare function SegmentFromJSONTyped(json: any, ignoreDiscriminator: boolean): Segment;
92
+ export declare function SegmentToJSON(json: any): Segment;
93
+ export declare function SegmentToJSONTyped(value?: Segment | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,93 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * Client Data API
6
+ * Client Cluster Data API - Manifest-based storage service
7
+ *
8
+ * The version of the OpenAPI document: 1.11.0
9
+ *
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.SegmentSplitRuleEnum = exports.SegmentOriginEnum = exports.SegmentKindEnum = void 0;
17
+ exports.instanceOfSegment = instanceOfSegment;
18
+ exports.SegmentFromJSON = SegmentFromJSON;
19
+ exports.SegmentFromJSONTyped = SegmentFromJSONTyped;
20
+ exports.SegmentToJSON = SegmentToJSON;
21
+ exports.SegmentToJSONTyped = SegmentToJSONTyped;
22
+ /**
23
+ * @export
24
+ */
25
+ exports.SegmentKindEnum = {
26
+ Page: 'page'
27
+ };
28
+ /**
29
+ * @export
30
+ */
31
+ exports.SegmentOriginEnum = {
32
+ Source: 'source',
33
+ Derived: 'derived'
34
+ };
35
+ /**
36
+ * @export
37
+ */
38
+ exports.SegmentSplitRuleEnum = {
39
+ Paragraph: 'paragraph',
40
+ TableRow: 'table_row',
41
+ Line: 'line',
42
+ Fixed: 'fixed'
43
+ };
44
+ /**
45
+ * Check if a given object implements the Segment interface.
46
+ */
47
+ function instanceOfSegment(value) {
48
+ if (!('seq' in value) || value['seq'] === undefined)
49
+ return false;
50
+ if (!('label' in value) || value['label'] === undefined)
51
+ return false;
52
+ if (!('origin' in value) || value['origin'] === undefined)
53
+ return false;
54
+ if (!('charStart' in value) || value['charStart'] === undefined)
55
+ return false;
56
+ if (!('charEnd' in value) || value['charEnd'] === undefined)
57
+ return false;
58
+ return true;
59
+ }
60
+ function SegmentFromJSON(json) {
61
+ return SegmentFromJSONTyped(json, false);
62
+ }
63
+ function SegmentFromJSONTyped(json, ignoreDiscriminator) {
64
+ if (json == null) {
65
+ return json;
66
+ }
67
+ return {
68
+ 'seq': json['seq'],
69
+ 'kind': json['kind'] == null ? undefined : json['kind'],
70
+ 'label': json['label'],
71
+ 'origin': json['origin'],
72
+ 'splitRule': json['split_rule'] == null ? undefined : json['split_rule'],
73
+ 'charStart': json['char_start'],
74
+ 'charEnd': json['char_end'],
75
+ };
76
+ }
77
+ function SegmentToJSON(json) {
78
+ return SegmentToJSONTyped(json, false);
79
+ }
80
+ function SegmentToJSONTyped(value, ignoreDiscriminator = false) {
81
+ if (value == null) {
82
+ return value;
83
+ }
84
+ return {
85
+ 'seq': value['seq'],
86
+ 'kind': value['kind'],
87
+ 'label': value['label'],
88
+ 'origin': value['origin'],
89
+ 'split_rule': value['splitRule'],
90
+ 'char_start': value['charStart'],
91
+ 'char_end': value['charEnd'],
92
+ };
93
+ }
@@ -2,7 +2,7 @@
2
2
  * Client Data API
3
3
  * Client Cluster Data API - Manifest-based storage service
4
4
  *
5
- * The version of the OpenAPI document: 1.4.15
5
+ * The version of the OpenAPI document: 1.11.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -5,7 +5,7 @@
5
5
  * Client Data API
6
6
  * Client Cluster Data API - Manifest-based storage service
7
7
  *
8
- * The version of the OpenAPI document: 1.4.15
8
+ * The version of the OpenAPI document: 1.11.0
9
9
  *
10
10
  *
11
11
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -0,0 +1,63 @@
1
+ /**
2
+ * Client Data API
3
+ * Client Cluster Data API - Manifest-based storage service
4
+ *
5
+ * The version of the OpenAPI document: 1.11.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import type { TranscriptionWarnings } from './TranscriptionWarnings';
13
+ import type { TranscriptionPage } from './TranscriptionPage';
14
+ import type { TranscriptionUsage } from './TranscriptionUsage';
15
+ import type { TranscriptionDocumentInfo } from './TranscriptionDocumentInfo';
16
+ /**
17
+ * A transcribed document: its pages, what produced them, and what it cost.
18
+ *
19
+ * Adopted verbatim from ocr-gateway's ``OcrResponse`` (D4). The *ingest* contract
20
+ * wraps this; it does not reshape it.
21
+ * @export
22
+ * @interface Transcription
23
+ */
24
+ export interface Transcription {
25
+ /**
26
+ * The transcription, ordered by index. Read each page's 'origin' before citing it: 'derived' means the producer drew the boundary, not the document. Never empty - a document with zero pages is the absence of a result, not a degraded one, and must be reported as a failure rather than a 200.
27
+ * @type {Array<TranscriptionPage>}
28
+ * @memberof Transcription
29
+ */
30
+ pages: Array<TranscriptionPage>;
31
+ /**
32
+ * What produced the text: a model identifier, or the route name.
33
+ * @type {string}
34
+ * @memberof Transcription
35
+ */
36
+ model: string;
37
+ /**
38
+ * What the document turned out to be.
39
+ * @type {TranscriptionDocumentInfo}
40
+ * @memberof Transcription
41
+ */
42
+ document: TranscriptionDocumentInfo;
43
+ /**
44
+ * What the transcription cost, and whether a GPU was used.
45
+ * @type {TranscriptionUsage}
46
+ * @memberof Transcription
47
+ */
48
+ usageInfo: TranscriptionUsage;
49
+ /**
50
+ *
51
+ * @type {TranscriptionWarnings}
52
+ * @memberof Transcription
53
+ */
54
+ warnings?: TranscriptionWarnings | null;
55
+ }
56
+ /**
57
+ * Check if a given object implements the Transcription interface.
58
+ */
59
+ export declare function instanceOfTranscription(value: object): value is Transcription;
60
+ export declare function TranscriptionFromJSON(json: any): Transcription;
61
+ export declare function TranscriptionFromJSONTyped(json: any, ignoreDiscriminator: boolean): Transcription;
62
+ export declare function TranscriptionToJSON(json: any): Transcription;
63
+ export declare function TranscriptionToJSONTyped(value?: Transcription | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,68 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * Client Data API
6
+ * Client Cluster Data API - Manifest-based storage service
7
+ *
8
+ * The version of the OpenAPI document: 1.11.0
9
+ *
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.instanceOfTranscription = instanceOfTranscription;
17
+ exports.TranscriptionFromJSON = TranscriptionFromJSON;
18
+ exports.TranscriptionFromJSONTyped = TranscriptionFromJSONTyped;
19
+ exports.TranscriptionToJSON = TranscriptionToJSON;
20
+ exports.TranscriptionToJSONTyped = TranscriptionToJSONTyped;
21
+ const TranscriptionWarnings_1 = require("./TranscriptionWarnings");
22
+ const TranscriptionPage_1 = require("./TranscriptionPage");
23
+ const TranscriptionUsage_1 = require("./TranscriptionUsage");
24
+ const TranscriptionDocumentInfo_1 = require("./TranscriptionDocumentInfo");
25
+ /**
26
+ * Check if a given object implements the Transcription interface.
27
+ */
28
+ function instanceOfTranscription(value) {
29
+ if (!('pages' in value) || value['pages'] === undefined)
30
+ return false;
31
+ if (!('model' in value) || value['model'] === undefined)
32
+ return false;
33
+ if (!('document' in value) || value['document'] === undefined)
34
+ return false;
35
+ if (!('usageInfo' in value) || value['usageInfo'] === undefined)
36
+ return false;
37
+ return true;
38
+ }
39
+ function TranscriptionFromJSON(json) {
40
+ return TranscriptionFromJSONTyped(json, false);
41
+ }
42
+ function TranscriptionFromJSONTyped(json, ignoreDiscriminator) {
43
+ if (json == null) {
44
+ return json;
45
+ }
46
+ return {
47
+ 'pages': (json['pages'].map(TranscriptionPage_1.TranscriptionPageFromJSON)),
48
+ 'model': json['model'],
49
+ 'document': (0, TranscriptionDocumentInfo_1.TranscriptionDocumentInfoFromJSON)(json['document']),
50
+ 'usageInfo': (0, TranscriptionUsage_1.TranscriptionUsageFromJSON)(json['usage_info']),
51
+ 'warnings': json['warnings'] == null ? undefined : (0, TranscriptionWarnings_1.TranscriptionWarningsFromJSON)(json['warnings']),
52
+ };
53
+ }
54
+ function TranscriptionToJSON(json) {
55
+ return TranscriptionToJSONTyped(json, false);
56
+ }
57
+ function TranscriptionToJSONTyped(value, ignoreDiscriminator = false) {
58
+ if (value == null) {
59
+ return value;
60
+ }
61
+ return {
62
+ 'pages': (value['pages'].map(TranscriptionPage_1.TranscriptionPageToJSON)),
63
+ 'model': value['model'],
64
+ 'document': (0, TranscriptionDocumentInfo_1.TranscriptionDocumentInfoToJSON)(value['document']),
65
+ 'usage_info': (0, TranscriptionUsage_1.TranscriptionUsageToJSON)(value['usageInfo']),
66
+ 'warnings': (0, TranscriptionWarnings_1.TranscriptionWarningsToJSON)(value['warnings']),
67
+ };
68
+ }
@@ -0,0 +1,66 @@
1
+ /**
2
+ * Client Data API
3
+ * Client Cluster Data API - Manifest-based storage service
4
+ *
5
+ * The version of the OpenAPI document: 1.11.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ * What the document turned out to be, and how it was handled.
14
+ * @export
15
+ * @interface TranscriptionDocumentInfo
16
+ */
17
+ export interface TranscriptionDocumentInfo {
18
+ /**
19
+ * Canonical extension, e.g. 'xlsx'.
20
+ * @type {string}
21
+ * @memberof TranscriptionDocumentInfo
22
+ */
23
+ format: string;
24
+ /**
25
+ * Detected MIME type, from the signature rather than the name.
26
+ * @type {string}
27
+ * @memberof TranscriptionDocumentInfo
28
+ */
29
+ mime: string;
30
+ /**
31
+ * Size of the source document as received.
32
+ * @type {number}
33
+ * @memberof TranscriptionDocumentInfo
34
+ */
35
+ sizeBytes: number;
36
+ /**
37
+ * Pages the document is accounted for in. On the OCR route this is the source document's own page count, so a gap left by a failed chunk stays visible; on the extraction routes it is the emitted count, derived pages included.
38
+ * @type {number}
39
+ * @memberof TranscriptionDocumentInfo
40
+ */
41
+ totalPages: number;
42
+ /**
43
+ * Which path the document took. Anything but 'ocr' never reached a GPU.
44
+ * @type {string}
45
+ * @memberof TranscriptionDocumentInfo
46
+ */
47
+ route: TranscriptionDocumentInfoRouteEnum;
48
+ }
49
+ /**
50
+ * @export
51
+ */
52
+ export declare const TranscriptionDocumentInfoRouteEnum: {
53
+ readonly Text: "text";
54
+ readonly Tabular: "tabular";
55
+ readonly Html: "html";
56
+ readonly Ocr: "ocr";
57
+ };
58
+ export type TranscriptionDocumentInfoRouteEnum = typeof TranscriptionDocumentInfoRouteEnum[keyof typeof TranscriptionDocumentInfoRouteEnum];
59
+ /**
60
+ * Check if a given object implements the TranscriptionDocumentInfo interface.
61
+ */
62
+ export declare function instanceOfTranscriptionDocumentInfo(value: object): value is TranscriptionDocumentInfo;
63
+ export declare function TranscriptionDocumentInfoFromJSON(json: any): TranscriptionDocumentInfo;
64
+ export declare function TranscriptionDocumentInfoFromJSONTyped(json: any, ignoreDiscriminator: boolean): TranscriptionDocumentInfo;
65
+ export declare function TranscriptionDocumentInfoToJSON(json: any): TranscriptionDocumentInfo;
66
+ export declare function TranscriptionDocumentInfoToJSONTyped(value?: TranscriptionDocumentInfo | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,76 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * Client Data API
6
+ * Client Cluster Data API - Manifest-based storage service
7
+ *
8
+ * The version of the OpenAPI document: 1.11.0
9
+ *
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.TranscriptionDocumentInfoRouteEnum = void 0;
17
+ exports.instanceOfTranscriptionDocumentInfo = instanceOfTranscriptionDocumentInfo;
18
+ exports.TranscriptionDocumentInfoFromJSON = TranscriptionDocumentInfoFromJSON;
19
+ exports.TranscriptionDocumentInfoFromJSONTyped = TranscriptionDocumentInfoFromJSONTyped;
20
+ exports.TranscriptionDocumentInfoToJSON = TranscriptionDocumentInfoToJSON;
21
+ exports.TranscriptionDocumentInfoToJSONTyped = TranscriptionDocumentInfoToJSONTyped;
22
+ /**
23
+ * @export
24
+ */
25
+ exports.TranscriptionDocumentInfoRouteEnum = {
26
+ Text: 'text',
27
+ Tabular: 'tabular',
28
+ Html: 'html',
29
+ Ocr: 'ocr'
30
+ };
31
+ /**
32
+ * Check if a given object implements the TranscriptionDocumentInfo interface.
33
+ */
34
+ function instanceOfTranscriptionDocumentInfo(value) {
35
+ if (!('format' in value) || value['format'] === undefined)
36
+ return false;
37
+ if (!('mime' in value) || value['mime'] === undefined)
38
+ return false;
39
+ if (!('sizeBytes' in value) || value['sizeBytes'] === undefined)
40
+ return false;
41
+ if (!('totalPages' in value) || value['totalPages'] === undefined)
42
+ return false;
43
+ if (!('route' in value) || value['route'] === undefined)
44
+ return false;
45
+ return true;
46
+ }
47
+ function TranscriptionDocumentInfoFromJSON(json) {
48
+ return TranscriptionDocumentInfoFromJSONTyped(json, false);
49
+ }
50
+ function TranscriptionDocumentInfoFromJSONTyped(json, ignoreDiscriminator) {
51
+ if (json == null) {
52
+ return json;
53
+ }
54
+ return {
55
+ 'format': json['format'],
56
+ 'mime': json['mime'],
57
+ 'sizeBytes': json['size_bytes'],
58
+ 'totalPages': json['total_pages'],
59
+ 'route': json['route'],
60
+ };
61
+ }
62
+ function TranscriptionDocumentInfoToJSON(json) {
63
+ return TranscriptionDocumentInfoToJSONTyped(json, false);
64
+ }
65
+ function TranscriptionDocumentInfoToJSONTyped(value, ignoreDiscriminator = false) {
66
+ if (value == null) {
67
+ return value;
68
+ }
69
+ return {
70
+ 'format': value['format'],
71
+ 'mime': value['mime'],
72
+ 'size_bytes': value['sizeBytes'],
73
+ 'total_pages': value['totalPages'],
74
+ 'route': value['route'],
75
+ };
76
+ }
@@ -0,0 +1,82 @@
1
+ /**
2
+ * Client Data API
3
+ * Client Cluster Data API - Manifest-based storage service
4
+ *
5
+ * The version of the OpenAPI document: 1.11.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import type { PageDimensions } from './PageDimensions';
13
+ import type { FigureImage } from './FigureImage';
14
+ /**
15
+ * One page of transcribed content, and whether the document drew its edges.
16
+ * @export
17
+ * @interface TranscriptionPage
18
+ */
19
+ export interface TranscriptionPage {
20
+ /**
21
+ * Zero-indexed page number. Pages keep their source index, so a page lost to a failed chunk leaves a visible gap rather than a silently shorter document.
22
+ * @type {number}
23
+ * @memberof TranscriptionPage
24
+ */
25
+ index: number;
26
+ /**
27
+ * The page's content. Consumers rebuild the document by joining these with a blank line; the join rule is part of the contract (see PAGE_JOIN).
28
+ * @type {string}
29
+ * @memberof TranscriptionPage
30
+ */
31
+ markdown: string;
32
+ /**
33
+ * 'source' if the document itself drew this boundary (a PDF page, a worksheet, a folio); 'derived' if the producer split a unit to keep it inside an indexing position budget.
34
+ * @type {string}
35
+ * @memberof TranscriptionPage
36
+ */
37
+ origin?: TranscriptionPageOriginEnum;
38
+ /**
39
+ *
40
+ * @type {string}
41
+ * @memberof TranscriptionPage
42
+ */
43
+ splitRule?: TranscriptionPageSplitRuleEnum | null;
44
+ /**
45
+ * Figure crops with bounding boxes. Always empty on extraction routes.
46
+ * @type {Array<FigureImage>}
47
+ * @memberof TranscriptionPage
48
+ */
49
+ images?: Array<FigureImage>;
50
+ /**
51
+ *
52
+ * @type {PageDimensions}
53
+ * @memberof TranscriptionPage
54
+ */
55
+ dimensions?: PageDimensions | null;
56
+ }
57
+ /**
58
+ * @export
59
+ */
60
+ export declare const TranscriptionPageOriginEnum: {
61
+ readonly Source: "source";
62
+ readonly Derived: "derived";
63
+ };
64
+ export type TranscriptionPageOriginEnum = typeof TranscriptionPageOriginEnum[keyof typeof TranscriptionPageOriginEnum];
65
+ /**
66
+ * @export
67
+ */
68
+ export declare const TranscriptionPageSplitRuleEnum: {
69
+ readonly Paragraph: "paragraph";
70
+ readonly TableRow: "table_row";
71
+ readonly Line: "line";
72
+ readonly Fixed: "fixed";
73
+ };
74
+ export type TranscriptionPageSplitRuleEnum = typeof TranscriptionPageSplitRuleEnum[keyof typeof TranscriptionPageSplitRuleEnum];
75
+ /**
76
+ * Check if a given object implements the TranscriptionPage interface.
77
+ */
78
+ export declare function instanceOfTranscriptionPage(value: object): value is TranscriptionPage;
79
+ export declare function TranscriptionPageFromJSON(json: any): TranscriptionPage;
80
+ export declare function TranscriptionPageFromJSONTyped(json: any, ignoreDiscriminator: boolean): TranscriptionPage;
81
+ export declare function TranscriptionPageToJSON(json: any): TranscriptionPage;
82
+ export declare function TranscriptionPageToJSONTyped(value?: TranscriptionPage | null, ignoreDiscriminator?: boolean): any;