@knowledge-stack/ksapi 1.59.1 → 1.61.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 (61) hide show
  1. package/.openapi-generator/FILES +4 -0
  2. package/README.md +5 -2
  3. package/dist/apis/DocumentsApi.d.ts +7 -1
  4. package/dist/apis/DocumentsApi.js +6 -0
  5. package/dist/apis/SectionsApi.d.ts +45 -1
  6. package/dist/apis/SectionsApi.js +44 -0
  7. package/dist/esm/apis/DocumentsApi.d.ts +7 -1
  8. package/dist/esm/apis/DocumentsApi.js +6 -0
  9. package/dist/esm/apis/SectionsApi.d.ts +45 -1
  10. package/dist/esm/apis/SectionsApi.js +45 -1
  11. package/dist/esm/models/ConversionEngine.d.ts +25 -0
  12. package/dist/esm/models/ConversionEngine.js +43 -0
  13. package/dist/esm/models/DissolveSectionResponse.d.ts +53 -0
  14. package/dist/esm/models/DissolveSectionResponse.js +48 -0
  15. package/dist/esm/models/DocumentType.d.ts +2 -1
  16. package/dist/esm/models/DocumentType.js +2 -1
  17. package/dist/esm/models/DocumentVersionMetadata.d.ts +6 -2
  18. package/dist/esm/models/DocumentVersionMetadata.js +2 -2
  19. package/dist/esm/models/DocumentVersionMetadataUpdate.d.ts +19 -1
  20. package/dist/esm/models/DocumentVersionMetadataUpdate.js +8 -2
  21. package/dist/esm/models/DocumentVersionResponse.d.ts +6 -0
  22. package/dist/esm/models/DocumentVersionResponse.js +2 -0
  23. package/dist/esm/models/PipelineState.d.ts +7 -0
  24. package/dist/esm/models/PipelineState.js +3 -0
  25. package/dist/esm/models/index.d.ts +2 -0
  26. package/dist/esm/models/index.js +2 -0
  27. package/dist/models/ConversionEngine.d.ts +25 -0
  28. package/dist/models/ConversionEngine.js +51 -0
  29. package/dist/models/DissolveSectionResponse.d.ts +53 -0
  30. package/dist/models/DissolveSectionResponse.js +56 -0
  31. package/dist/models/DocumentType.d.ts +2 -1
  32. package/dist/models/DocumentType.js +2 -1
  33. package/dist/models/DocumentVersionMetadata.d.ts +6 -2
  34. package/dist/models/DocumentVersionMetadata.js +2 -2
  35. package/dist/models/DocumentVersionMetadataUpdate.d.ts +19 -1
  36. package/dist/models/DocumentVersionMetadataUpdate.js +8 -2
  37. package/dist/models/DocumentVersionResponse.d.ts +6 -0
  38. package/dist/models/DocumentVersionResponse.js +2 -0
  39. package/dist/models/PipelineState.d.ts +7 -0
  40. package/dist/models/PipelineState.js +3 -0
  41. package/dist/models/index.d.ts +2 -0
  42. package/dist/models/index.js +2 -0
  43. package/docs/ConversionEngine.md +33 -0
  44. package/docs/DissolveSectionResponse.md +37 -0
  45. package/docs/DocumentVersionMetadata.md +3 -3
  46. package/docs/DocumentVersionMetadataUpdate.md +8 -2
  47. package/docs/DocumentVersionResponse.md +2 -0
  48. package/docs/DocumentsApi.md +8 -2
  49. package/docs/PipelineState.md +2 -0
  50. package/docs/SectionsApi.md +75 -0
  51. package/package.json +1 -1
  52. package/src/apis/DocumentsApi.ts +17 -0
  53. package/src/apis/SectionsApi.ts +88 -0
  54. package/src/models/ConversionEngine.ts +53 -0
  55. package/src/models/DissolveSectionResponse.ts +92 -0
  56. package/src/models/DocumentType.ts +2 -1
  57. package/src/models/DocumentVersionMetadata.ts +8 -4
  58. package/src/models/DocumentVersionMetadataUpdate.ts +27 -3
  59. package/src/models/DocumentVersionResponse.ts +8 -0
  60. package/src/models/PipelineState.ts +15 -0
  61. package/src/models/index.ts +2 -0
@@ -35,6 +35,10 @@ import {
35
35
  * and document statistics. Convention-based paths (images, page screenshots)
36
36
  * are derived from document_id/document_version_id via s3_paths helpers,
37
37
  * using a flat S3 layout: documents/{document_id}/{document_version_id}/...
38
+ *
39
+ * Internal conversion artifact paths (standard_pipeline_json_s3, high_accuracy_*_s3) are
40
+ * excluded from API responses via ``Field(exclude=True)`` so we don't
41
+ * expose underlying technology names to external consumers.
38
42
  * @export
39
43
  * @interface DocumentVersionMetadata
40
44
  */
@@ -52,11 +56,11 @@ export interface DocumentVersionMetadata {
52
56
  */
53
57
  cleanedSourceS3?: string | null;
54
58
  /**
55
- * S3 URL to the Docling JSON conversion output
59
+ * S3 URL to the fast plaintext export of the document
56
60
  * @type {string}
57
61
  * @memberof DocumentVersionMetadata
58
62
  */
59
- doclingJsonS3?: string | null;
63
+ fastPlaintextS3?: string | null;
60
64
  /**
61
65
  * Base64-encoded SHA256 hash of the uploaded source file
62
66
  * @type {string}
@@ -138,7 +142,7 @@ export function DocumentVersionMetadataFromJSONTyped(json: any, ignoreDiscrimina
138
142
 
139
143
  'sourceS3': json['source_s3'] == null ? undefined : json['source_s3'],
140
144
  'cleanedSourceS3': json['cleaned_source_s3'] == null ? undefined : json['cleaned_source_s3'],
141
- 'doclingJsonS3': json['docling_json_s3'] == null ? undefined : json['docling_json_s3'],
145
+ 'fastPlaintextS3': json['fast_plaintext_s3'] == null ? undefined : json['fast_plaintext_s3'],
142
146
  'hash': json['hash'] == null ? undefined : json['hash'],
143
147
  'pipelineState': json['pipeline_state'] == null ? undefined : PipelineStateFromJSON(json['pipeline_state']),
144
148
  'totalPages': json['total_pages'] == null ? undefined : json['total_pages'],
@@ -165,7 +169,7 @@ export function DocumentVersionMetadataToJSONTyped(value?: DocumentVersionMetada
165
169
 
166
170
  'source_s3': value['sourceS3'],
167
171
  'cleaned_source_s3': value['cleanedSourceS3'],
168
- 'docling_json_s3': value['doclingJsonS3'],
172
+ 'fast_plaintext_s3': value['fastPlaintextS3'],
169
173
  'hash': value['hash'],
170
174
  'pipeline_state': PipelineStateToJSON(value['pipelineState']),
171
175
  'total_pages': value['totalPages'],
@@ -54,7 +54,25 @@ export interface DocumentVersionMetadataUpdate {
54
54
  * @type {string}
55
55
  * @memberof DocumentVersionMetadataUpdate
56
56
  */
57
- doclingJsonS3?: string | null;
57
+ standardPipelineJsonS3?: string | null;
58
+ /**
59
+ *
60
+ * @type {string}
61
+ * @memberof DocumentVersionMetadataUpdate
62
+ */
63
+ fastPlaintextS3?: string | null;
64
+ /**
65
+ *
66
+ * @type {string}
67
+ * @memberof DocumentVersionMetadataUpdate
68
+ */
69
+ highAccuracyContentListS3?: string | null;
70
+ /**
71
+ *
72
+ * @type {string}
73
+ * @memberof DocumentVersionMetadataUpdate
74
+ */
75
+ highAccuracyMiddleS3?: string | null;
58
76
  /**
59
77
  *
60
78
  * @type {string}
@@ -136,7 +154,10 @@ export function DocumentVersionMetadataUpdateFromJSONTyped(json: any, ignoreDisc
136
154
 
137
155
  'sourceS3': json['source_s3'] == null ? undefined : json['source_s3'],
138
156
  'cleanedSourceS3': json['cleaned_source_s3'] == null ? undefined : json['cleaned_source_s3'],
139
- 'doclingJsonS3': json['docling_json_s3'] == null ? undefined : json['docling_json_s3'],
157
+ 'standardPipelineJsonS3': json['standard_pipeline_json_s3'] == null ? undefined : json['standard_pipeline_json_s3'],
158
+ 'fastPlaintextS3': json['fast_plaintext_s3'] == null ? undefined : json['fast_plaintext_s3'],
159
+ 'highAccuracyContentListS3': json['high_accuracy_content_list_s3'] == null ? undefined : json['high_accuracy_content_list_s3'],
160
+ 'highAccuracyMiddleS3': json['high_accuracy_middle_s3'] == null ? undefined : json['high_accuracy_middle_s3'],
140
161
  'hash': json['hash'] == null ? undefined : json['hash'],
141
162
  'pipelineState': json['pipeline_state'] == null ? undefined : PipelineStateFromJSON(json['pipeline_state']),
142
163
  'totalPages': json['total_pages'] == null ? undefined : json['total_pages'],
@@ -163,7 +184,10 @@ export function DocumentVersionMetadataUpdateToJSONTyped(value?: DocumentVersion
163
184
 
164
185
  'source_s3': value['sourceS3'],
165
186
  'cleaned_source_s3': value['cleanedSourceS3'],
166
- 'docling_json_s3': value['doclingJsonS3'],
187
+ 'standard_pipeline_json_s3': value['standardPipelineJsonS3'],
188
+ 'fast_plaintext_s3': value['fastPlaintextS3'],
189
+ 'high_accuracy_content_list_s3': value['highAccuracyContentListS3'],
190
+ 'high_accuracy_middle_s3': value['highAccuracyMiddleS3'],
167
191
  'hash': value['hash'],
168
192
  'pipeline_state': PipelineStateToJSON(value['pipelineState']),
169
193
  'total_pages': value['totalPages'],
@@ -96,6 +96,12 @@ export interface DocumentVersionResponse {
96
96
  * @memberof DocumentVersionResponse
97
97
  */
98
98
  assetS3Url?: string | null;
99
+ /**
100
+ * Presigned URL to download the fast plaintext export (6-hour validity)
101
+ * @type {string}
102
+ * @memberof DocumentVersionResponse
103
+ */
104
+ fastPlaintextUrl?: string | null;
99
105
  /**
100
106
  *
101
107
  * @type {DocumentVersionMetadata}
@@ -142,6 +148,7 @@ export function DocumentVersionResponseFromJSONTyped(json: any, ignoreDiscrimina
142
148
  'createdAt': (new Date(json['created_at'])),
143
149
  'updatedAt': (new Date(json['updated_at'])),
144
150
  'assetS3Url': json['asset_s3_url'] == null ? undefined : json['asset_s3_url'],
151
+ 'fastPlaintextUrl': json['fast_plaintext_url'] == null ? undefined : json['fast_plaintext_url'],
145
152
  'systemMetadata': json['system_metadata'] == null ? undefined : DocumentVersionMetadataFromJSON(json['system_metadata']),
146
153
  };
147
154
  }
@@ -168,6 +175,7 @@ export function DocumentVersionResponseToJSONTyped(value?: DocumentVersionRespon
168
175
  'created_at': value['createdAt'].toISOString(),
169
176
  'updated_at': value['updatedAt'].toISOString(),
170
177
  'asset_s3_url': value['assetS3Url'],
178
+ 'fast_plaintext_url': value['fastPlaintextUrl'],
171
179
  'system_metadata': DocumentVersionMetadataToJSON(value['systemMetadata']),
172
180
  };
173
181
  }
@@ -20,6 +20,13 @@ import {
20
20
  PipelineStatusToJSON,
21
21
  PipelineStatusToJSONTyped,
22
22
  } from './PipelineStatus';
23
+ import type { ConversionEngine } from './ConversionEngine';
24
+ import {
25
+ ConversionEngineFromJSON,
26
+ ConversionEngineFromJSONTyped,
27
+ ConversionEngineToJSON,
28
+ ConversionEngineToJSONTyped,
29
+ } from './ConversionEngine';
23
30
  import type { IngestionMode } from './IngestionMode';
24
31
  import {
25
32
  IngestionModeFromJSON,
@@ -101,6 +108,12 @@ export interface PipelineState {
101
108
  * @memberof PipelineState
102
109
  */
103
110
  chunkType?: ChunkType;
111
+ /**
112
+ *
113
+ * @type {ConversionEngine}
114
+ * @memberof PipelineState
115
+ */
116
+ conversionEngine?: ConversionEngine;
104
117
  }
105
118
 
106
119
 
@@ -133,6 +146,7 @@ export function PipelineStateFromJSONTyped(json: any, ignoreDiscriminator: boole
133
146
  'pageDpi': json['page_dpi'] == null ? undefined : json['page_dpi'],
134
147
  'ingestionMode': json['ingestion_mode'] == null ? undefined : IngestionModeFromJSON(json['ingestion_mode']),
135
148
  'chunkType': json['chunk_type'] == null ? undefined : ChunkTypeFromJSON(json['chunk_type']),
149
+ 'conversionEngine': json['conversion_engine'] == null ? undefined : ConversionEngineFromJSON(json['conversion_engine']),
136
150
  };
137
151
  }
138
152
 
@@ -157,6 +171,7 @@ export function PipelineStateToJSONTyped(value?: PipelineState | null, ignoreDis
157
171
  'page_dpi': value['pageDpi'],
158
172
  'ingestion_mode': IngestionModeToJSON(value['ingestionMode']),
159
173
  'chunk_type': ChunkTypeToJSON(value['chunkType']),
174
+ 'conversion_engine': ConversionEngineToJSON(value['conversionEngine']),
160
175
  };
161
176
  }
162
177
 
@@ -18,6 +18,7 @@ export * from './ChunkSearchRequest';
18
18
  export * from './ChunkType';
19
19
  export * from './Citation';
20
20
  export * from './ClearVersionContentsResponse';
21
+ export * from './ConversionEngine';
21
22
  export * from './CreateApiKeyRequest';
22
23
  export * from './CreateApiKeyResponse';
23
24
  export * from './CreateChunkLineageRequest';
@@ -31,6 +32,7 @@ export * from './CreateTagRequest';
31
32
  export * from './CreateTenantRequest';
32
33
  export * from './CreateThreadMessageRequest';
33
34
  export * from './CreateThreadRequest';
35
+ export * from './DissolveSectionResponse';
34
36
  export * from './DocumentOrigin';
35
37
  export * from './DocumentResponse';
36
38
  export * from './DocumentType';