@knowledge-stack/ksapi 1.60.0 → 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.
- package/.openapi-generator/FILES +4 -0
- package/README.md +5 -2
- package/dist/apis/DocumentsApi.d.ts +7 -1
- package/dist/apis/DocumentsApi.js +6 -0
- package/dist/apis/SectionsApi.d.ts +45 -1
- package/dist/apis/SectionsApi.js +44 -0
- package/dist/esm/apis/DocumentsApi.d.ts +7 -1
- package/dist/esm/apis/DocumentsApi.js +6 -0
- package/dist/esm/apis/SectionsApi.d.ts +45 -1
- package/dist/esm/apis/SectionsApi.js +45 -1
- package/dist/esm/models/ConversionEngine.d.ts +25 -0
- package/dist/esm/models/ConversionEngine.js +43 -0
- package/dist/esm/models/DissolveSectionResponse.d.ts +53 -0
- package/dist/esm/models/DissolveSectionResponse.js +48 -0
- package/dist/esm/models/DocumentVersionMetadata.d.ts +4 -6
- package/dist/esm/models/DocumentVersionMetadata.js +0 -2
- package/dist/esm/models/DocumentVersionMetadataUpdate.d.ts +13 -1
- package/dist/esm/models/DocumentVersionMetadataUpdate.js +6 -2
- package/dist/esm/models/PipelineState.d.ts +7 -0
- package/dist/esm/models/PipelineState.js +3 -0
- package/dist/esm/models/index.d.ts +2 -0
- package/dist/esm/models/index.js +2 -0
- package/dist/models/ConversionEngine.d.ts +25 -0
- package/dist/models/ConversionEngine.js +51 -0
- package/dist/models/DissolveSectionResponse.d.ts +53 -0
- package/dist/models/DissolveSectionResponse.js +56 -0
- package/dist/models/DocumentVersionMetadata.d.ts +4 -6
- package/dist/models/DocumentVersionMetadata.js +0 -2
- package/dist/models/DocumentVersionMetadataUpdate.d.ts +13 -1
- package/dist/models/DocumentVersionMetadataUpdate.js +6 -2
- package/dist/models/PipelineState.d.ts +7 -0
- package/dist/models/PipelineState.js +3 -0
- package/dist/models/index.d.ts +2 -0
- package/dist/models/index.js +2 -0
- package/docs/ConversionEngine.md +33 -0
- package/docs/DissolveSectionResponse.md +37 -0
- package/docs/DocumentVersionMetadata.md +1 -3
- package/docs/DocumentVersionMetadataUpdate.md +6 -2
- package/docs/DocumentsApi.md +8 -2
- package/docs/PipelineState.md +2 -0
- package/docs/SectionsApi.md +75 -0
- package/package.json +1 -1
- package/src/apis/DocumentsApi.ts +17 -0
- package/src/apis/SectionsApi.ts +88 -0
- package/src/models/ConversionEngine.ts +53 -0
- package/src/models/DissolveSectionResponse.ts +92 -0
- package/src/models/DocumentVersionMetadata.ts +4 -8
- package/src/models/DocumentVersionMetadataUpdate.ts +19 -3
- package/src/models/PipelineState.ts +15 -0
- package/src/models/index.ts +2 -0
|
@@ -18,6 +18,10 @@ import type { InformationStatistics } from './InformationStatistics';
|
|
|
18
18
|
* and document statistics. Convention-based paths (images, page screenshots)
|
|
19
19
|
* are derived from document_id/document_version_id via s3_paths helpers,
|
|
20
20
|
* using a flat S3 layout: documents/{document_id}/{document_version_id}/...
|
|
21
|
+
*
|
|
22
|
+
* Internal conversion artifact paths (standard_pipeline_json_s3, high_accuracy_*_s3) are
|
|
23
|
+
* excluded from API responses via ``Field(exclude=True)`` so we don't
|
|
24
|
+
* expose underlying technology names to external consumers.
|
|
21
25
|
* @export
|
|
22
26
|
* @interface DocumentVersionMetadata
|
|
23
27
|
*/
|
|
@@ -34,12 +38,6 @@ export interface DocumentVersionMetadata {
|
|
|
34
38
|
* @memberof DocumentVersionMetadata
|
|
35
39
|
*/
|
|
36
40
|
cleanedSourceS3?: string | null;
|
|
37
|
-
/**
|
|
38
|
-
* S3 URL to the Docling JSON conversion output
|
|
39
|
-
* @type {string}
|
|
40
|
-
* @memberof DocumentVersionMetadata
|
|
41
|
-
*/
|
|
42
|
-
doclingJsonS3?: string | null;
|
|
43
41
|
/**
|
|
44
42
|
* S3 URL to the fast plaintext export of the document
|
|
45
43
|
* @type {string}
|
|
@@ -29,7 +29,6 @@ export function DocumentVersionMetadataFromJSONTyped(json, ignoreDiscriminator)
|
|
|
29
29
|
return {
|
|
30
30
|
'sourceS3': json['source_s3'] == null ? undefined : json['source_s3'],
|
|
31
31
|
'cleanedSourceS3': json['cleaned_source_s3'] == null ? undefined : json['cleaned_source_s3'],
|
|
32
|
-
'doclingJsonS3': json['docling_json_s3'] == null ? undefined : json['docling_json_s3'],
|
|
33
32
|
'fastPlaintextS3': json['fast_plaintext_s3'] == null ? undefined : json['fast_plaintext_s3'],
|
|
34
33
|
'hash': json['hash'] == null ? undefined : json['hash'],
|
|
35
34
|
'pipelineState': json['pipeline_state'] == null ? undefined : PipelineStateFromJSON(json['pipeline_state']),
|
|
@@ -53,7 +52,6 @@ export function DocumentVersionMetadataToJSONTyped(value, ignoreDiscriminator =
|
|
|
53
52
|
return {
|
|
54
53
|
'source_s3': value['sourceS3'],
|
|
55
54
|
'cleaned_source_s3': value['cleanedSourceS3'],
|
|
56
|
-
'docling_json_s3': value['doclingJsonS3'],
|
|
57
55
|
'fast_plaintext_s3': value['fastPlaintextS3'],
|
|
58
56
|
'hash': value['hash'],
|
|
59
57
|
'pipeline_state': PipelineStateToJSON(value['pipelineState']),
|
|
@@ -37,13 +37,25 @@ export interface DocumentVersionMetadataUpdate {
|
|
|
37
37
|
* @type {string}
|
|
38
38
|
* @memberof DocumentVersionMetadataUpdate
|
|
39
39
|
*/
|
|
40
|
-
|
|
40
|
+
standardPipelineJsonS3?: string | null;
|
|
41
41
|
/**
|
|
42
42
|
*
|
|
43
43
|
* @type {string}
|
|
44
44
|
* @memberof DocumentVersionMetadataUpdate
|
|
45
45
|
*/
|
|
46
46
|
fastPlaintextS3?: string | null;
|
|
47
|
+
/**
|
|
48
|
+
*
|
|
49
|
+
* @type {string}
|
|
50
|
+
* @memberof DocumentVersionMetadataUpdate
|
|
51
|
+
*/
|
|
52
|
+
highAccuracyContentListS3?: string | null;
|
|
53
|
+
/**
|
|
54
|
+
*
|
|
55
|
+
* @type {string}
|
|
56
|
+
* @memberof DocumentVersionMetadataUpdate
|
|
57
|
+
*/
|
|
58
|
+
highAccuracyMiddleS3?: string | null;
|
|
47
59
|
/**
|
|
48
60
|
*
|
|
49
61
|
* @type {string}
|
|
@@ -29,8 +29,10 @@ export function DocumentVersionMetadataUpdateFromJSONTyped(json, ignoreDiscrimin
|
|
|
29
29
|
return {
|
|
30
30
|
'sourceS3': json['source_s3'] == null ? undefined : json['source_s3'],
|
|
31
31
|
'cleanedSourceS3': json['cleaned_source_s3'] == null ? undefined : json['cleaned_source_s3'],
|
|
32
|
-
'
|
|
32
|
+
'standardPipelineJsonS3': json['standard_pipeline_json_s3'] == null ? undefined : json['standard_pipeline_json_s3'],
|
|
33
33
|
'fastPlaintextS3': json['fast_plaintext_s3'] == null ? undefined : json['fast_plaintext_s3'],
|
|
34
|
+
'highAccuracyContentListS3': json['high_accuracy_content_list_s3'] == null ? undefined : json['high_accuracy_content_list_s3'],
|
|
35
|
+
'highAccuracyMiddleS3': json['high_accuracy_middle_s3'] == null ? undefined : json['high_accuracy_middle_s3'],
|
|
34
36
|
'hash': json['hash'] == null ? undefined : json['hash'],
|
|
35
37
|
'pipelineState': json['pipeline_state'] == null ? undefined : PipelineStateFromJSON(json['pipeline_state']),
|
|
36
38
|
'totalPages': json['total_pages'] == null ? undefined : json['total_pages'],
|
|
@@ -53,8 +55,10 @@ export function DocumentVersionMetadataUpdateToJSONTyped(value, ignoreDiscrimina
|
|
|
53
55
|
return {
|
|
54
56
|
'source_s3': value['sourceS3'],
|
|
55
57
|
'cleaned_source_s3': value['cleanedSourceS3'],
|
|
56
|
-
'
|
|
58
|
+
'standard_pipeline_json_s3': value['standardPipelineJsonS3'],
|
|
57
59
|
'fast_plaintext_s3': value['fastPlaintextS3'],
|
|
60
|
+
'high_accuracy_content_list_s3': value['highAccuracyContentListS3'],
|
|
61
|
+
'high_accuracy_middle_s3': value['highAccuracyMiddleS3'],
|
|
58
62
|
'hash': value['hash'],
|
|
59
63
|
'pipeline_state': PipelineStateToJSON(value['pipelineState']),
|
|
60
64
|
'total_pages': value['totalPages'],
|
|
@@ -10,6 +10,7 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
import type { PipelineStatus } from './PipelineStatus';
|
|
13
|
+
import type { ConversionEngine } from './ConversionEngine';
|
|
13
14
|
import type { IngestionMode } from './IngestionMode';
|
|
14
15
|
import type { ChunkType } from './ChunkType';
|
|
15
16
|
/**
|
|
@@ -78,6 +79,12 @@ export interface PipelineState {
|
|
|
78
79
|
* @memberof PipelineState
|
|
79
80
|
*/
|
|
80
81
|
chunkType?: ChunkType;
|
|
82
|
+
/**
|
|
83
|
+
*
|
|
84
|
+
* @type {ConversionEngine}
|
|
85
|
+
* @memberof PipelineState
|
|
86
|
+
*/
|
|
87
|
+
conversionEngine?: ConversionEngine;
|
|
81
88
|
}
|
|
82
89
|
/**
|
|
83
90
|
* Check if a given object implements the PipelineState interface.
|
|
@@ -12,6 +12,7 @@
|
|
|
12
12
|
* Do not edit the class manually.
|
|
13
13
|
*/
|
|
14
14
|
import { PipelineStatusFromJSON, PipelineStatusToJSON, } from './PipelineStatus';
|
|
15
|
+
import { ConversionEngineFromJSON, ConversionEngineToJSON, } from './ConversionEngine';
|
|
15
16
|
import { IngestionModeFromJSON, IngestionModeToJSON, } from './IngestionMode';
|
|
16
17
|
import { ChunkTypeFromJSON, ChunkTypeToJSON, } from './ChunkType';
|
|
17
18
|
/**
|
|
@@ -40,6 +41,7 @@ export function PipelineStateFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
40
41
|
'pageDpi': json['page_dpi'] == null ? undefined : json['page_dpi'],
|
|
41
42
|
'ingestionMode': json['ingestion_mode'] == null ? undefined : IngestionModeFromJSON(json['ingestion_mode']),
|
|
42
43
|
'chunkType': json['chunk_type'] == null ? undefined : ChunkTypeFromJSON(json['chunk_type']),
|
|
44
|
+
'conversionEngine': json['conversion_engine'] == null ? undefined : ConversionEngineFromJSON(json['conversion_engine']),
|
|
43
45
|
};
|
|
44
46
|
}
|
|
45
47
|
export function PipelineStateToJSON(json) {
|
|
@@ -60,6 +62,7 @@ export function PipelineStateToJSONTyped(value, ignoreDiscriminator = false) {
|
|
|
60
62
|
'page_dpi': value['pageDpi'],
|
|
61
63
|
'ingestion_mode': IngestionModeToJSON(value['ingestionMode']),
|
|
62
64
|
'chunk_type': ChunkTypeToJSON(value['chunkType']),
|
|
65
|
+
'conversion_engine': ConversionEngineToJSON(value['conversionEngine']),
|
|
63
66
|
};
|
|
64
67
|
}
|
|
65
68
|
export const PipelineStatePropertyValidationAttributesMap = {};
|
|
@@ -16,6 +16,7 @@ export * from './ChunkSearchRequest';
|
|
|
16
16
|
export * from './ChunkType';
|
|
17
17
|
export * from './Citation';
|
|
18
18
|
export * from './ClearVersionContentsResponse';
|
|
19
|
+
export * from './ConversionEngine';
|
|
19
20
|
export * from './CreateApiKeyRequest';
|
|
20
21
|
export * from './CreateApiKeyResponse';
|
|
21
22
|
export * from './CreateChunkLineageRequest';
|
|
@@ -29,6 +30,7 @@ export * from './CreateTagRequest';
|
|
|
29
30
|
export * from './CreateTenantRequest';
|
|
30
31
|
export * from './CreateThreadMessageRequest';
|
|
31
32
|
export * from './CreateThreadRequest';
|
|
33
|
+
export * from './DissolveSectionResponse';
|
|
32
34
|
export * from './DocumentOrigin';
|
|
33
35
|
export * from './DocumentResponse';
|
|
34
36
|
export * from './DocumentType';
|
package/dist/esm/models/index.js
CHANGED
|
@@ -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';
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Knowledge Stack API
|
|
3
|
+
* Knowledge Stack backend API for authentication and knowledge management
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 0.1.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
|
+
* Document conversion engine selection.
|
|
14
|
+
* @export
|
|
15
|
+
*/
|
|
16
|
+
export declare const ConversionEngine: {
|
|
17
|
+
readonly Standard: "standard";
|
|
18
|
+
readonly HighAccuracy: "high_accuracy";
|
|
19
|
+
};
|
|
20
|
+
export type ConversionEngine = typeof ConversionEngine[keyof typeof ConversionEngine];
|
|
21
|
+
export declare function instanceOfConversionEngine(value: any): boolean;
|
|
22
|
+
export declare function ConversionEngineFromJSON(json: any): ConversionEngine;
|
|
23
|
+
export declare function ConversionEngineFromJSONTyped(json: any, ignoreDiscriminator: boolean): ConversionEngine;
|
|
24
|
+
export declare function ConversionEngineToJSON(value?: ConversionEngine | null): any;
|
|
25
|
+
export declare function ConversionEngineToJSONTyped(value: any, ignoreDiscriminator: boolean): ConversionEngine;
|
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* Knowledge Stack API
|
|
6
|
+
* Knowledge Stack backend API for authentication and knowledge management
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 0.1.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.ConversionEngine = void 0;
|
|
17
|
+
exports.instanceOfConversionEngine = instanceOfConversionEngine;
|
|
18
|
+
exports.ConversionEngineFromJSON = ConversionEngineFromJSON;
|
|
19
|
+
exports.ConversionEngineFromJSONTyped = ConversionEngineFromJSONTyped;
|
|
20
|
+
exports.ConversionEngineToJSON = ConversionEngineToJSON;
|
|
21
|
+
exports.ConversionEngineToJSONTyped = ConversionEngineToJSONTyped;
|
|
22
|
+
/**
|
|
23
|
+
* Document conversion engine selection.
|
|
24
|
+
* @export
|
|
25
|
+
*/
|
|
26
|
+
exports.ConversionEngine = {
|
|
27
|
+
Standard: 'standard',
|
|
28
|
+
HighAccuracy: 'high_accuracy'
|
|
29
|
+
};
|
|
30
|
+
function instanceOfConversionEngine(value) {
|
|
31
|
+
for (const key in exports.ConversionEngine) {
|
|
32
|
+
if (Object.prototype.hasOwnProperty.call(exports.ConversionEngine, key)) {
|
|
33
|
+
if (exports.ConversionEngine[key] === value) {
|
|
34
|
+
return true;
|
|
35
|
+
}
|
|
36
|
+
}
|
|
37
|
+
}
|
|
38
|
+
return false;
|
|
39
|
+
}
|
|
40
|
+
function ConversionEngineFromJSON(json) {
|
|
41
|
+
return ConversionEngineFromJSONTyped(json, false);
|
|
42
|
+
}
|
|
43
|
+
function ConversionEngineFromJSONTyped(json, ignoreDiscriminator) {
|
|
44
|
+
return json;
|
|
45
|
+
}
|
|
46
|
+
function ConversionEngineToJSON(value) {
|
|
47
|
+
return value;
|
|
48
|
+
}
|
|
49
|
+
function ConversionEngineToJSONTyped(value, ignoreDiscriminator) {
|
|
50
|
+
return value;
|
|
51
|
+
}
|
|
@@ -0,0 +1,53 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Knowledge Stack API
|
|
3
|
+
* Knowledge Stack backend API for authentication and knowledge management
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 0.1.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
|
+
* Response from dissolving a section into a text chunk.
|
|
14
|
+
* @export
|
|
15
|
+
* @interface DissolveSectionResponse
|
|
16
|
+
*/
|
|
17
|
+
export interface DissolveSectionResponse {
|
|
18
|
+
/**
|
|
19
|
+
* ID of the created text chunk
|
|
20
|
+
* @type {string}
|
|
21
|
+
* @memberof DissolveSectionResponse
|
|
22
|
+
*/
|
|
23
|
+
textChunkId: string;
|
|
24
|
+
/**
|
|
25
|
+
* Number of children reparented to the parent
|
|
26
|
+
* @type {number}
|
|
27
|
+
* @memberof DissolveSectionResponse
|
|
28
|
+
*/
|
|
29
|
+
reparentedChildren: number;
|
|
30
|
+
}
|
|
31
|
+
/**
|
|
32
|
+
* Check if a given object implements the DissolveSectionResponse interface.
|
|
33
|
+
*/
|
|
34
|
+
export declare function instanceOfDissolveSectionResponse(value: object): value is DissolveSectionResponse;
|
|
35
|
+
export declare function DissolveSectionResponseFromJSON(json: any): DissolveSectionResponse;
|
|
36
|
+
export declare function DissolveSectionResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): DissolveSectionResponse;
|
|
37
|
+
export declare function DissolveSectionResponseToJSON(json: any): DissolveSectionResponse;
|
|
38
|
+
export declare function DissolveSectionResponseToJSONTyped(value?: DissolveSectionResponse | null, ignoreDiscriminator?: boolean): any;
|
|
39
|
+
export declare const DissolveSectionResponsePropertyValidationAttributesMap: {
|
|
40
|
+
[property: string]: {
|
|
41
|
+
maxLength?: number;
|
|
42
|
+
minLength?: number;
|
|
43
|
+
pattern?: string;
|
|
44
|
+
maximum?: number;
|
|
45
|
+
exclusiveMaximum?: boolean;
|
|
46
|
+
minimum?: number;
|
|
47
|
+
exclusiveMinimum?: boolean;
|
|
48
|
+
multipleOf?: number;
|
|
49
|
+
maxItems?: number;
|
|
50
|
+
minItems?: number;
|
|
51
|
+
uniqueItems?: boolean;
|
|
52
|
+
};
|
|
53
|
+
};
|
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* Knowledge Stack API
|
|
6
|
+
* Knowledge Stack backend API for authentication and knowledge management
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 0.1.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.DissolveSectionResponsePropertyValidationAttributesMap = void 0;
|
|
17
|
+
exports.instanceOfDissolveSectionResponse = instanceOfDissolveSectionResponse;
|
|
18
|
+
exports.DissolveSectionResponseFromJSON = DissolveSectionResponseFromJSON;
|
|
19
|
+
exports.DissolveSectionResponseFromJSONTyped = DissolveSectionResponseFromJSONTyped;
|
|
20
|
+
exports.DissolveSectionResponseToJSON = DissolveSectionResponseToJSON;
|
|
21
|
+
exports.DissolveSectionResponseToJSONTyped = DissolveSectionResponseToJSONTyped;
|
|
22
|
+
/**
|
|
23
|
+
* Check if a given object implements the DissolveSectionResponse interface.
|
|
24
|
+
*/
|
|
25
|
+
function instanceOfDissolveSectionResponse(value) {
|
|
26
|
+
if (!('textChunkId' in value) || value['textChunkId'] === undefined)
|
|
27
|
+
return false;
|
|
28
|
+
if (!('reparentedChildren' in value) || value['reparentedChildren'] === undefined)
|
|
29
|
+
return false;
|
|
30
|
+
return true;
|
|
31
|
+
}
|
|
32
|
+
function DissolveSectionResponseFromJSON(json) {
|
|
33
|
+
return DissolveSectionResponseFromJSONTyped(json, false);
|
|
34
|
+
}
|
|
35
|
+
function DissolveSectionResponseFromJSONTyped(json, ignoreDiscriminator) {
|
|
36
|
+
if (json == null) {
|
|
37
|
+
return json;
|
|
38
|
+
}
|
|
39
|
+
return {
|
|
40
|
+
'textChunkId': json['text_chunk_id'],
|
|
41
|
+
'reparentedChildren': json['reparented_children'],
|
|
42
|
+
};
|
|
43
|
+
}
|
|
44
|
+
function DissolveSectionResponseToJSON(json) {
|
|
45
|
+
return DissolveSectionResponseToJSONTyped(json, false);
|
|
46
|
+
}
|
|
47
|
+
function DissolveSectionResponseToJSONTyped(value, ignoreDiscriminator = false) {
|
|
48
|
+
if (value == null) {
|
|
49
|
+
return value;
|
|
50
|
+
}
|
|
51
|
+
return {
|
|
52
|
+
'text_chunk_id': value['textChunkId'],
|
|
53
|
+
'reparented_children': value['reparentedChildren'],
|
|
54
|
+
};
|
|
55
|
+
}
|
|
56
|
+
exports.DissolveSectionResponsePropertyValidationAttributesMap = {};
|
|
@@ -18,6 +18,10 @@ import type { InformationStatistics } from './InformationStatistics';
|
|
|
18
18
|
* and document statistics. Convention-based paths (images, page screenshots)
|
|
19
19
|
* are derived from document_id/document_version_id via s3_paths helpers,
|
|
20
20
|
* using a flat S3 layout: documents/{document_id}/{document_version_id}/...
|
|
21
|
+
*
|
|
22
|
+
* Internal conversion artifact paths (standard_pipeline_json_s3, high_accuracy_*_s3) are
|
|
23
|
+
* excluded from API responses via ``Field(exclude=True)`` so we don't
|
|
24
|
+
* expose underlying technology names to external consumers.
|
|
21
25
|
* @export
|
|
22
26
|
* @interface DocumentVersionMetadata
|
|
23
27
|
*/
|
|
@@ -34,12 +38,6 @@ export interface DocumentVersionMetadata {
|
|
|
34
38
|
* @memberof DocumentVersionMetadata
|
|
35
39
|
*/
|
|
36
40
|
cleanedSourceS3?: string | null;
|
|
37
|
-
/**
|
|
38
|
-
* S3 URL to the Docling JSON conversion output
|
|
39
|
-
* @type {string}
|
|
40
|
-
* @memberof DocumentVersionMetadata
|
|
41
|
-
*/
|
|
42
|
-
doclingJsonS3?: string | null;
|
|
43
41
|
/**
|
|
44
42
|
* S3 URL to the fast plaintext export of the document
|
|
45
43
|
* @type {string}
|
|
@@ -37,7 +37,6 @@ function DocumentVersionMetadataFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
37
37
|
return {
|
|
38
38
|
'sourceS3': json['source_s3'] == null ? undefined : json['source_s3'],
|
|
39
39
|
'cleanedSourceS3': json['cleaned_source_s3'] == null ? undefined : json['cleaned_source_s3'],
|
|
40
|
-
'doclingJsonS3': json['docling_json_s3'] == null ? undefined : json['docling_json_s3'],
|
|
41
40
|
'fastPlaintextS3': json['fast_plaintext_s3'] == null ? undefined : json['fast_plaintext_s3'],
|
|
42
41
|
'hash': json['hash'] == null ? undefined : json['hash'],
|
|
43
42
|
'pipelineState': json['pipeline_state'] == null ? undefined : (0, PipelineState_1.PipelineStateFromJSON)(json['pipeline_state']),
|
|
@@ -61,7 +60,6 @@ function DocumentVersionMetadataToJSONTyped(value, ignoreDiscriminator = false)
|
|
|
61
60
|
return {
|
|
62
61
|
'source_s3': value['sourceS3'],
|
|
63
62
|
'cleaned_source_s3': value['cleanedSourceS3'],
|
|
64
|
-
'docling_json_s3': value['doclingJsonS3'],
|
|
65
63
|
'fast_plaintext_s3': value['fastPlaintextS3'],
|
|
66
64
|
'hash': value['hash'],
|
|
67
65
|
'pipeline_state': (0, PipelineState_1.PipelineStateToJSON)(value['pipelineState']),
|
|
@@ -37,13 +37,25 @@ export interface DocumentVersionMetadataUpdate {
|
|
|
37
37
|
* @type {string}
|
|
38
38
|
* @memberof DocumentVersionMetadataUpdate
|
|
39
39
|
*/
|
|
40
|
-
|
|
40
|
+
standardPipelineJsonS3?: string | null;
|
|
41
41
|
/**
|
|
42
42
|
*
|
|
43
43
|
* @type {string}
|
|
44
44
|
* @memberof DocumentVersionMetadataUpdate
|
|
45
45
|
*/
|
|
46
46
|
fastPlaintextS3?: string | null;
|
|
47
|
+
/**
|
|
48
|
+
*
|
|
49
|
+
* @type {string}
|
|
50
|
+
* @memberof DocumentVersionMetadataUpdate
|
|
51
|
+
*/
|
|
52
|
+
highAccuracyContentListS3?: string | null;
|
|
53
|
+
/**
|
|
54
|
+
*
|
|
55
|
+
* @type {string}
|
|
56
|
+
* @memberof DocumentVersionMetadataUpdate
|
|
57
|
+
*/
|
|
58
|
+
highAccuracyMiddleS3?: string | null;
|
|
47
59
|
/**
|
|
48
60
|
*
|
|
49
61
|
* @type {string}
|
|
@@ -37,8 +37,10 @@ function DocumentVersionMetadataUpdateFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
37
37
|
return {
|
|
38
38
|
'sourceS3': json['source_s3'] == null ? undefined : json['source_s3'],
|
|
39
39
|
'cleanedSourceS3': json['cleaned_source_s3'] == null ? undefined : json['cleaned_source_s3'],
|
|
40
|
-
'
|
|
40
|
+
'standardPipelineJsonS3': json['standard_pipeline_json_s3'] == null ? undefined : json['standard_pipeline_json_s3'],
|
|
41
41
|
'fastPlaintextS3': json['fast_plaintext_s3'] == null ? undefined : json['fast_plaintext_s3'],
|
|
42
|
+
'highAccuracyContentListS3': json['high_accuracy_content_list_s3'] == null ? undefined : json['high_accuracy_content_list_s3'],
|
|
43
|
+
'highAccuracyMiddleS3': json['high_accuracy_middle_s3'] == null ? undefined : json['high_accuracy_middle_s3'],
|
|
42
44
|
'hash': json['hash'] == null ? undefined : json['hash'],
|
|
43
45
|
'pipelineState': json['pipeline_state'] == null ? undefined : (0, PipelineState_1.PipelineStateFromJSON)(json['pipeline_state']),
|
|
44
46
|
'totalPages': json['total_pages'] == null ? undefined : json['total_pages'],
|
|
@@ -61,8 +63,10 @@ function DocumentVersionMetadataUpdateToJSONTyped(value, ignoreDiscriminator = f
|
|
|
61
63
|
return {
|
|
62
64
|
'source_s3': value['sourceS3'],
|
|
63
65
|
'cleaned_source_s3': value['cleanedSourceS3'],
|
|
64
|
-
'
|
|
66
|
+
'standard_pipeline_json_s3': value['standardPipelineJsonS3'],
|
|
65
67
|
'fast_plaintext_s3': value['fastPlaintextS3'],
|
|
68
|
+
'high_accuracy_content_list_s3': value['highAccuracyContentListS3'],
|
|
69
|
+
'high_accuracy_middle_s3': value['highAccuracyMiddleS3'],
|
|
66
70
|
'hash': value['hash'],
|
|
67
71
|
'pipeline_state': (0, PipelineState_1.PipelineStateToJSON)(value['pipelineState']),
|
|
68
72
|
'total_pages': value['totalPages'],
|
|
@@ -10,6 +10,7 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
import type { PipelineStatus } from './PipelineStatus';
|
|
13
|
+
import type { ConversionEngine } from './ConversionEngine';
|
|
13
14
|
import type { IngestionMode } from './IngestionMode';
|
|
14
15
|
import type { ChunkType } from './ChunkType';
|
|
15
16
|
/**
|
|
@@ -78,6 +79,12 @@ export interface PipelineState {
|
|
|
78
79
|
* @memberof PipelineState
|
|
79
80
|
*/
|
|
80
81
|
chunkType?: ChunkType;
|
|
82
|
+
/**
|
|
83
|
+
*
|
|
84
|
+
* @type {ConversionEngine}
|
|
85
|
+
* @memberof PipelineState
|
|
86
|
+
*/
|
|
87
|
+
conversionEngine?: ConversionEngine;
|
|
81
88
|
}
|
|
82
89
|
/**
|
|
83
90
|
* Check if a given object implements the PipelineState interface.
|
|
@@ -20,6 +20,7 @@ exports.PipelineStateFromJSONTyped = PipelineStateFromJSONTyped;
|
|
|
20
20
|
exports.PipelineStateToJSON = PipelineStateToJSON;
|
|
21
21
|
exports.PipelineStateToJSONTyped = PipelineStateToJSONTyped;
|
|
22
22
|
const PipelineStatus_1 = require("./PipelineStatus");
|
|
23
|
+
const ConversionEngine_1 = require("./ConversionEngine");
|
|
23
24
|
const IngestionMode_1 = require("./IngestionMode");
|
|
24
25
|
const ChunkType_1 = require("./ChunkType");
|
|
25
26
|
/**
|
|
@@ -48,6 +49,7 @@ function PipelineStateFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
48
49
|
'pageDpi': json['page_dpi'] == null ? undefined : json['page_dpi'],
|
|
49
50
|
'ingestionMode': json['ingestion_mode'] == null ? undefined : (0, IngestionMode_1.IngestionModeFromJSON)(json['ingestion_mode']),
|
|
50
51
|
'chunkType': json['chunk_type'] == null ? undefined : (0, ChunkType_1.ChunkTypeFromJSON)(json['chunk_type']),
|
|
52
|
+
'conversionEngine': json['conversion_engine'] == null ? undefined : (0, ConversionEngine_1.ConversionEngineFromJSON)(json['conversion_engine']),
|
|
51
53
|
};
|
|
52
54
|
}
|
|
53
55
|
function PipelineStateToJSON(json) {
|
|
@@ -68,6 +70,7 @@ function PipelineStateToJSONTyped(value, ignoreDiscriminator = false) {
|
|
|
68
70
|
'page_dpi': value['pageDpi'],
|
|
69
71
|
'ingestion_mode': (0, IngestionMode_1.IngestionModeToJSON)(value['ingestionMode']),
|
|
70
72
|
'chunk_type': (0, ChunkType_1.ChunkTypeToJSON)(value['chunkType']),
|
|
73
|
+
'conversion_engine': (0, ConversionEngine_1.ConversionEngineToJSON)(value['conversionEngine']),
|
|
71
74
|
};
|
|
72
75
|
}
|
|
73
76
|
exports.PipelineStatePropertyValidationAttributesMap = {};
|
package/dist/models/index.d.ts
CHANGED
|
@@ -16,6 +16,7 @@ export * from './ChunkSearchRequest';
|
|
|
16
16
|
export * from './ChunkType';
|
|
17
17
|
export * from './Citation';
|
|
18
18
|
export * from './ClearVersionContentsResponse';
|
|
19
|
+
export * from './ConversionEngine';
|
|
19
20
|
export * from './CreateApiKeyRequest';
|
|
20
21
|
export * from './CreateApiKeyResponse';
|
|
21
22
|
export * from './CreateChunkLineageRequest';
|
|
@@ -29,6 +30,7 @@ export * from './CreateTagRequest';
|
|
|
29
30
|
export * from './CreateTenantRequest';
|
|
30
31
|
export * from './CreateThreadMessageRequest';
|
|
31
32
|
export * from './CreateThreadRequest';
|
|
33
|
+
export * from './DissolveSectionResponse';
|
|
32
34
|
export * from './DocumentOrigin';
|
|
33
35
|
export * from './DocumentResponse';
|
|
34
36
|
export * from './DocumentType';
|
package/dist/models/index.js
CHANGED
|
@@ -34,6 +34,7 @@ __exportStar(require("./ChunkSearchRequest"), exports);
|
|
|
34
34
|
__exportStar(require("./ChunkType"), exports);
|
|
35
35
|
__exportStar(require("./Citation"), exports);
|
|
36
36
|
__exportStar(require("./ClearVersionContentsResponse"), exports);
|
|
37
|
+
__exportStar(require("./ConversionEngine"), exports);
|
|
37
38
|
__exportStar(require("./CreateApiKeyRequest"), exports);
|
|
38
39
|
__exportStar(require("./CreateApiKeyResponse"), exports);
|
|
39
40
|
__exportStar(require("./CreateChunkLineageRequest"), exports);
|
|
@@ -47,6 +48,7 @@ __exportStar(require("./CreateTagRequest"), exports);
|
|
|
47
48
|
__exportStar(require("./CreateTenantRequest"), exports);
|
|
48
49
|
__exportStar(require("./CreateThreadMessageRequest"), exports);
|
|
49
50
|
__exportStar(require("./CreateThreadRequest"), exports);
|
|
51
|
+
__exportStar(require("./DissolveSectionResponse"), exports);
|
|
50
52
|
__exportStar(require("./DocumentOrigin"), exports);
|
|
51
53
|
__exportStar(require("./DocumentResponse"), exports);
|
|
52
54
|
__exportStar(require("./DocumentType"), exports);
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
|
|
2
|
+
# ConversionEngine
|
|
3
|
+
|
|
4
|
+
Document conversion engine selection.
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
Name | Type
|
|
9
|
+
------------ | -------------
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import type { ConversionEngine } from '@knowledge-stack/ksapi'
|
|
15
|
+
|
|
16
|
+
// TODO: Update the object below with actual values
|
|
17
|
+
const example = {
|
|
18
|
+
} satisfies ConversionEngine
|
|
19
|
+
|
|
20
|
+
console.log(example)
|
|
21
|
+
|
|
22
|
+
// Convert the instance to a JSON string
|
|
23
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
24
|
+
console.log(exampleJSON)
|
|
25
|
+
|
|
26
|
+
// Parse the JSON string back to an object
|
|
27
|
+
const exampleParsed = JSON.parse(exampleJSON) as ConversionEngine
|
|
28
|
+
console.log(exampleParsed)
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
32
|
+
|
|
33
|
+
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
|
|
2
|
+
# DissolveSectionResponse
|
|
3
|
+
|
|
4
|
+
Response from dissolving a section into a text chunk.
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
Name | Type
|
|
9
|
+
------------ | -------------
|
|
10
|
+
`textChunkId` | string
|
|
11
|
+
`reparentedChildren` | number
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import type { DissolveSectionResponse } from '@knowledge-stack/ksapi'
|
|
17
|
+
|
|
18
|
+
// TODO: Update the object below with actual values
|
|
19
|
+
const example = {
|
|
20
|
+
"textChunkId": null,
|
|
21
|
+
"reparentedChildren": null,
|
|
22
|
+
} satisfies DissolveSectionResponse
|
|
23
|
+
|
|
24
|
+
console.log(example)
|
|
25
|
+
|
|
26
|
+
// Convert the instance to a JSON string
|
|
27
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
28
|
+
console.log(exampleJSON)
|
|
29
|
+
|
|
30
|
+
// Parse the JSON string back to an object
|
|
31
|
+
const exampleParsed = JSON.parse(exampleJSON) as DissolveSectionResponse
|
|
32
|
+
console.log(exampleParsed)
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
36
|
+
|
|
37
|
+
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
|
|
2
2
|
# DocumentVersionMetadata
|
|
3
3
|
|
|
4
|
-
Schema for document_version.system_metadata JSONB field. Tracks S3 URLs for generated artifacts, pipeline execution state, and document statistics. Convention-based paths (images, page screenshots) are derived from document_id/document_version_id via s3_paths helpers, using a flat S3 layout: documents/{document_id}/{document_version_id}/...
|
|
4
|
+
Schema for document_version.system_metadata JSONB field. Tracks S3 URLs for generated artifacts, pipeline execution state, and document statistics. Convention-based paths (images, page screenshots) are derived from document_id/document_version_id via s3_paths helpers, using a flat S3 layout: documents/{document_id}/{document_version_id}/... Internal conversion artifact paths (standard_pipeline_json_s3, high_accuracy_*_s3) are excluded from API responses via ``Field(exclude=True)`` so we don\'t expose underlying technology names to external consumers.
|
|
5
5
|
|
|
6
6
|
## Properties
|
|
7
7
|
|
|
@@ -9,7 +9,6 @@ Name | Type
|
|
|
9
9
|
------------ | -------------
|
|
10
10
|
`sourceS3` | string
|
|
11
11
|
`cleanedSourceS3` | string
|
|
12
|
-
`doclingJsonS3` | string
|
|
13
12
|
`fastPlaintextS3` | string
|
|
14
13
|
`hash` | string
|
|
15
14
|
`pipelineState` | [PipelineState](PipelineState.md)
|
|
@@ -31,7 +30,6 @@ import type { DocumentVersionMetadata } from '@knowledge-stack/ksapi'
|
|
|
31
30
|
const example = {
|
|
32
31
|
"sourceS3": null,
|
|
33
32
|
"cleanedSourceS3": null,
|
|
34
|
-
"doclingJsonS3": null,
|
|
35
33
|
"fastPlaintextS3": null,
|
|
36
34
|
"hash": null,
|
|
37
35
|
"pipelineState": null,
|
|
@@ -9,8 +9,10 @@ Name | Type
|
|
|
9
9
|
------------ | -------------
|
|
10
10
|
`sourceS3` | string
|
|
11
11
|
`cleanedSourceS3` | string
|
|
12
|
-
`
|
|
12
|
+
`standardPipelineJsonS3` | string
|
|
13
13
|
`fastPlaintextS3` | string
|
|
14
|
+
`highAccuracyContentListS3` | string
|
|
15
|
+
`highAccuracyMiddleS3` | string
|
|
14
16
|
`hash` | string
|
|
15
17
|
`pipelineState` | [PipelineState](PipelineState.md)
|
|
16
18
|
`totalPages` | number
|
|
@@ -31,8 +33,10 @@ import type { DocumentVersionMetadataUpdate } from '@knowledge-stack/ksapi'
|
|
|
31
33
|
const example = {
|
|
32
34
|
"sourceS3": null,
|
|
33
35
|
"cleanedSourceS3": null,
|
|
34
|
-
"
|
|
36
|
+
"standardPipelineJsonS3": null,
|
|
35
37
|
"fastPlaintextS3": null,
|
|
38
|
+
"highAccuracyContentListS3": null,
|
|
39
|
+
"highAccuracyMiddleS3": null,
|
|
36
40
|
"hash": null,
|
|
37
41
|
"pipelineState": null,
|
|
38
42
|
"totalPages": null,
|