@knowledge-stack/ksapi 1.153.0 → 1.154.1

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 (8) hide show
  1. package/README.md +2 -2
  2. package/dist/apis/DocumentsApi.d.ts +6 -6
  3. package/dist/apis/DocumentsApi.js +6 -6
  4. package/dist/esm/apis/DocumentsApi.d.ts +6 -6
  5. package/dist/esm/apis/DocumentsApi.js +6 -6
  6. package/docs/DocumentsApi.md +7 -7
  7. package/package.json +1 -1
  8. package/src/apis/DocumentsApi.ts +14 -14
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- # @knowledge-stack/ksapi@1.153.0
1
+ # @knowledge-stack/ksapi@1.154.1
2
2
 
3
3
  A TypeScript SDK client for the localhost API.
4
4
 
@@ -690,7 +690,7 @@ and is automatically generated by the
690
690
  [OpenAPI Generator](https://openapi-generator.tech) project:
691
691
 
692
692
  - API version: `0.1.0`
693
- - Package version: `1.153.0`
693
+ - Package version: `1.154.1`
694
694
  - Generator version: `7.21.0`
695
695
  - Build package: `org.openapitools.codegen.languages.TypeScriptFetchClientCodegen`
696
696
 
package/dist/apis/DocumentsApi.d.ts CHANGED
@@ -41,13 +41,13 @@ export interface IngestDocumentRequest {
41
41
  file: Blob;
42
42
  pathPartId: string;
43
43
  name?: string | null;
44
+ tagIds?: Array<string>;
45
+ idempotencyKey?: string | null;
44
46
  ingestionMode?: IngestionMode;
45
47
  chunkType?: ChunkType;
46
48
  secondaryTaxonomy?: ImageTaxonomy;
47
49
  pageDpi?: number;
48
50
  workflowRunId?: string | null;
49
- tagIds?: Array<string>;
50
- idempotencyKey?: string | null;
51
51
  workflowDefinitionId?: string | null;
52
52
  }
53
53
  export interface IngestDocumentVersionRequest {
@@ -272,13 +272,13 @@ export interface DocumentsApiInterface {
272
272
  * @param {Blob} file
273
273
  * @param {string} pathPartId Parent path part ID (must be a FOLDER type)
274
274
  * @param {string} [name] Document name (defaults to filename)
275
+ * @param {Array<string>} [tagIds] Tag IDs applied to the created document.
276
+ * @param {string} [idempotencyKey] Opt-in key: a repeat with the same key at the same (parent, name) replays the existing document instead of a 409.
275
277
  * @param {IngestionMode} [ingestionMode]
276
278
  * @param {ChunkType} [chunkType]
277
279
  * @param {ImageTaxonomy} [secondaryTaxonomy]
278
280
  * @param {number} [pageDpi] DPI for PDF page screenshots (default 72, min 36, max 216).
279
281
  * @param {string} [workflowRunId] Workflow run context for assumed agent uploads.
280
- * @param {Array<string>} [tagIds] Tag IDs applied to the created document.
281
- * @param {string} [idempotencyKey] Opt-in key: a repeat with the same key at the same (parent, name) replays the existing document instead of a 409.
282
282
  * @param {string} [workflowDefinitionId] Workflow definition context for assumed agent uploads.
283
283
  * @throws {RequiredError}
284
284
  * @memberof DocumentsApiInterface
@@ -290,13 +290,13 @@ export interface DocumentsApiInterface {
290
290
  * @param {Blob} file
291
291
  * @param {string} pathPartId Parent path part ID (must be a FOLDER type)
292
292
  * @param {string} [name] Document name (defaults to filename)
293
+ * @param {Array<string>} [tagIds] Tag IDs applied to the created document.
294
+ * @param {string} [idempotencyKey] Opt-in key: a repeat with the same key at the same (parent, name) replays the existing document instead of a 409.
293
295
  * @param {IngestionMode} [ingestionMode]
294
296
  * @param {ChunkType} [chunkType]
295
297
  * @param {ImageTaxonomy} [secondaryTaxonomy]
296
298
  * @param {number} [pageDpi] DPI for PDF page screenshots (default 72, min 36, max 216).
297
299
  * @param {string} [workflowRunId] Workflow run context for assumed agent uploads.
298
- * @param {Array<string>} [tagIds] Tag IDs applied to the created document.
299
- * @param {string} [idempotencyKey] Opt-in key: a repeat with the same key at the same (parent, name) replays the existing document instead of a 409.
300
300
  * @param {string} [workflowDefinitionId] Workflow definition context for assumed agent uploads.
301
301
  * @param {*} [options] Override http request option.
302
302
  * @throws {RequiredError}
package/dist/apis/DocumentsApi.js CHANGED
@@ -499,6 +499,12 @@ class DocumentsApi extends runtime.BaseAPI {
499
499
  if (requestParameters['name'] != null) {
500
500
  formParams.append('name', requestParameters['name']);
501
501
  }
502
+ if (requestParameters['tagIds'] != null) {
503
+ formParams.append('tag_ids', requestParameters['tagIds'].join(runtime.COLLECTION_FORMATS["csv"]));
504
+ }
505
+ if (requestParameters['idempotencyKey'] != null) {
506
+ formParams.append('idempotency_key', requestParameters['idempotencyKey']);
507
+ }
502
508
  if (requestParameters['ingestionMode'] != null) {
503
509
  formParams.append('ingestion_mode', requestParameters['ingestionMode']);
504
510
  }
@@ -514,12 +520,6 @@ class DocumentsApi extends runtime.BaseAPI {
514
520
  if (requestParameters['workflowRunId'] != null) {
515
521
  formParams.append('workflow_run_id', requestParameters['workflowRunId']);
516
522
  }
517
- if (requestParameters['tagIds'] != null) {
518
- formParams.append('tag_ids', requestParameters['tagIds'].join(runtime.COLLECTION_FORMATS["csv"]));
519
- }
520
- if (requestParameters['idempotencyKey'] != null) {
521
- formParams.append('idempotency_key', requestParameters['idempotencyKey']);
522
- }
523
523
  if (requestParameters['workflowDefinitionId'] != null) {
524
524
  formParams.append('workflow_definition_id', requestParameters['workflowDefinitionId']);
525
525
  }
package/dist/esm/apis/DocumentsApi.d.ts CHANGED
@@ -41,13 +41,13 @@ export interface IngestDocumentRequest {
41
41
  file: Blob;
42
42
  pathPartId: string;
43
43
  name?: string | null;
44
+ tagIds?: Array<string>;
45
+ idempotencyKey?: string | null;
44
46
  ingestionMode?: IngestionMode;
45
47
  chunkType?: ChunkType;
46
48
  secondaryTaxonomy?: ImageTaxonomy;
47
49
  pageDpi?: number;
48
50
  workflowRunId?: string | null;
49
- tagIds?: Array<string>;
50
- idempotencyKey?: string | null;
51
51
  workflowDefinitionId?: string | null;
52
52
  }
53
53
  export interface IngestDocumentVersionRequest {
@@ -272,13 +272,13 @@ export interface DocumentsApiInterface {
272
272
  * @param {Blob} file
273
273
  * @param {string} pathPartId Parent path part ID (must be a FOLDER type)
274
274
  * @param {string} [name] Document name (defaults to filename)
275
+ * @param {Array<string>} [tagIds] Tag IDs applied to the created document.
276
+ * @param {string} [idempotencyKey] Opt-in key: a repeat with the same key at the same (parent, name) replays the existing document instead of a 409.
275
277
  * @param {IngestionMode} [ingestionMode]
276
278
  * @param {ChunkType} [chunkType]
277
279
  * @param {ImageTaxonomy} [secondaryTaxonomy]
278
280
  * @param {number} [pageDpi] DPI for PDF page screenshots (default 72, min 36, max 216).
279
281
  * @param {string} [workflowRunId] Workflow run context for assumed agent uploads.
280
- * @param {Array<string>} [tagIds] Tag IDs applied to the created document.
281
- * @param {string} [idempotencyKey] Opt-in key: a repeat with the same key at the same (parent, name) replays the existing document instead of a 409.
282
282
  * @param {string} [workflowDefinitionId] Workflow definition context for assumed agent uploads.
283
283
  * @throws {RequiredError}
284
284
  * @memberof DocumentsApiInterface
@@ -290,13 +290,13 @@ export interface DocumentsApiInterface {
290
290
  * @param {Blob} file
291
291
  * @param {string} pathPartId Parent path part ID (must be a FOLDER type)
292
292
  * @param {string} [name] Document name (defaults to filename)
293
+ * @param {Array<string>} [tagIds] Tag IDs applied to the created document.
294
+ * @param {string} [idempotencyKey] Opt-in key: a repeat with the same key at the same (parent, name) replays the existing document instead of a 409.
293
295
  * @param {IngestionMode} [ingestionMode]
294
296
  * @param {ChunkType} [chunkType]
295
297
  * @param {ImageTaxonomy} [secondaryTaxonomy]
296
298
  * @param {number} [pageDpi] DPI for PDF page screenshots (default 72, min 36, max 216).
297
299
  * @param {string} [workflowRunId] Workflow run context for assumed agent uploads.
298
- * @param {Array<string>} [tagIds] Tag IDs applied to the created document.
299
- * @param {string} [idempotencyKey] Opt-in key: a repeat with the same key at the same (parent, name) replays the existing document instead of a 409.
300
300
  * @param {string} [workflowDefinitionId] Workflow definition context for assumed agent uploads.
301
301
  * @param {*} [options] Override http request option.
302
302
  * @throws {RequiredError}
package/dist/esm/apis/DocumentsApi.js CHANGED
@@ -463,6 +463,12 @@ export class DocumentsApi extends runtime.BaseAPI {
463
463
  if (requestParameters['name'] != null) {
464
464
  formParams.append('name', requestParameters['name']);
465
465
  }
466
+ if (requestParameters['tagIds'] != null) {
467
+ formParams.append('tag_ids', requestParameters['tagIds'].join(runtime.COLLECTION_FORMATS["csv"]));
468
+ }
469
+ if (requestParameters['idempotencyKey'] != null) {
470
+ formParams.append('idempotency_key', requestParameters['idempotencyKey']);
471
+ }
466
472
  if (requestParameters['ingestionMode'] != null) {
467
473
  formParams.append('ingestion_mode', requestParameters['ingestionMode']);
468
474
  }
@@ -478,12 +484,6 @@ export class DocumentsApi extends runtime.BaseAPI {
478
484
  if (requestParameters['workflowRunId'] != null) {
479
485
  formParams.append('workflow_run_id', requestParameters['workflowRunId']);
480
486
  }
481
- if (requestParameters['tagIds'] != null) {
482
- formParams.append('tag_ids', requestParameters['tagIds'].join(runtime.COLLECTION_FORMATS["csv"]));
483
- }
484
- if (requestParameters['idempotencyKey'] != null) {
485
- formParams.append('idempotency_key', requestParameters['idempotencyKey']);
486
- }
487
487
  if (requestParameters['workflowDefinitionId'] != null) {
488
488
  formParams.append('workflow_definition_id', requestParameters['workflowDefinitionId']);
489
489
  }
package/docs/DocumentsApi.md CHANGED
@@ -627,7 +627,7 @@ example().catch(console.error);
627
627
 
628
628
  ## ingestDocument
629
629
 
630
- > IngestDocumentResponse ingestDocument(file, pathPartId, name, ingestionMode, chunkType, secondaryTaxonomy, pageDpi, workflowRunId, tagIds, idempotencyKey, workflowDefinitionId)
630
+ > IngestDocumentResponse ingestDocument(file, pathPartId, name, tagIds, idempotencyKey, ingestionMode, chunkType, secondaryTaxonomy, pageDpi, workflowRunId, workflowDefinitionId)
631
631
 
632
632
  Ingest Document Handler
633
633
 
@@ -659,6 +659,10 @@ async function example() {
659
659
  pathPartId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
660
660
  // string | Document name (defaults to filename) (optional)
661
661
  name: name_example,
662
+ // Array<string> | Tag IDs applied to the created document. (optional)
663
+ tagIds: ...,
664
+ // string | Opt-in key: a repeat with the same key at the same (parent, name) replays the existing document instead of a 409. (optional)
665
+ idempotencyKey: idempotencyKey_example,
662
666
  // IngestionMode (optional)
663
667
  ingestionMode: ...,
664
668
  // ChunkType (optional)
@@ -669,10 +673,6 @@ async function example() {
669
673
  pageDpi: 56,
670
674
  // string | Workflow run context for assumed agent uploads. (optional)
671
675
  workflowRunId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
672
- // Array<string> | Tag IDs applied to the created document. (optional)
673
- tagIds: ...,
674
- // string | Opt-in key: a repeat with the same key at the same (parent, name) replays the existing document instead of a 409. (optional)
675
- idempotencyKey: idempotencyKey_example,
676
676
  // string | Workflow definition context for assumed agent uploads. (optional)
677
677
  workflowDefinitionId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
678
678
  } satisfies IngestDocumentRequest;
@@ -697,13 +697,13 @@ example().catch(console.error);
697
697
  | **file** | `Blob` | | [Defaults to `undefined`] |
698
698
  | **pathPartId** | `string` | Parent path part ID (must be a FOLDER type) | [Defaults to `undefined`] |
699
699
  | **name** | `string` | Document name (defaults to filename) | [Optional] [Defaults to `undefined`] |
700
+ | **tagIds** | `Array<string>` | Tag IDs applied to the created document. | [Optional] |
701
+ | **idempotencyKey** | `string` | Opt-in key: a repeat with the same key at the same (parent, name) replays the existing document instead of a 409. | [Optional] [Defaults to `undefined`] |
700
702
  | **ingestionMode** | `IngestionMode` | | [Optional] [Defaults to `undefined`] [Enum: high_accuracy, standard, single_chunk, media] |
701
703
  | **chunkType** | `ChunkType` | | [Optional] [Defaults to `undefined`] [Enum: TEXT, TABLE, IMAGE, HTML, UNKNOWN] |
702
704
  | **secondaryTaxonomy** | `ImageTaxonomy` | | [Optional] [Defaults to `undefined`] [Enum: picture, flowchart] |
703
705
  | **pageDpi** | `number` | DPI for PDF page screenshots (default 72, min 36, max 216). | [Optional] [Defaults to `72`] |
704
706
  | **workflowRunId** | `string` | Workflow run context for assumed agent uploads. | [Optional] [Defaults to `undefined`] |
705
- | **tagIds** | `Array<string>` | Tag IDs applied to the created document. | [Optional] |
706
- | **idempotencyKey** | `string` | Opt-in key: a repeat with the same key at the same (parent, name) replays the existing document instead of a 409. | [Optional] [Defaults to `undefined`] |
707
707
  | **workflowDefinitionId** | `string` | Workflow definition context for assumed agent uploads. | [Optional] [Defaults to `undefined`] |
708
708
 
709
709
  ### Return type
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@knowledge-stack/ksapi",
3
- "version": "1.153.0",
3
+ "version": "1.154.1",
4
4
  "description": "OpenAPI client for @knowledge-stack/ksapi",
5
5
  "author": "OpenAPI-Generator",
6
6
  "repository": {
package/src/apis/DocumentsApi.ts CHANGED
@@ -120,13 +120,13 @@ export interface IngestDocumentRequest {
120
120
  file: Blob;
121
121
  pathPartId: string;
122
122
  name?: string | null;
123
+ tagIds?: Array<string>;
124
+ idempotencyKey?: string | null;
123
125
  ingestionMode?: IngestionMode;
124
126
  chunkType?: ChunkType;
125
127
  secondaryTaxonomy?: ImageTaxonomy;
126
128
  pageDpi?: number;
127
129
  workflowRunId?: string | null;
128
- tagIds?: Array<string>;
129
- idempotencyKey?: string | null;
130
130
  workflowDefinitionId?: string | null;
131
131
  }
132
132
 
@@ -381,13 +381,13 @@ export interface DocumentsApiInterface {
381
381
  * @param {Blob} file
382
382
  * @param {string} pathPartId Parent path part ID (must be a FOLDER type)
383
383
  * @param {string} [name] Document name (defaults to filename)
384
+ * @param {Array<string>} [tagIds] Tag IDs applied to the created document.
385
+ * @param {string} [idempotencyKey] Opt-in key: a repeat with the same key at the same (parent, name) replays the existing document instead of a 409.
384
386
  * @param {IngestionMode} [ingestionMode]
385
387
  * @param {ChunkType} [chunkType]
386
388
  * @param {ImageTaxonomy} [secondaryTaxonomy]
387
389
  * @param {number} [pageDpi] DPI for PDF page screenshots (default 72, min 36, max 216).
388
390
  * @param {string} [workflowRunId] Workflow run context for assumed agent uploads.
389
- * @param {Array<string>} [tagIds] Tag IDs applied to the created document.
390
- * @param {string} [idempotencyKey] Opt-in key: a repeat with the same key at the same (parent, name) replays the existing document instead of a 409.
391
391
  * @param {string} [workflowDefinitionId] Workflow definition context for assumed agent uploads.
392
392
  * @throws {RequiredError}
393
393
  * @memberof DocumentsApiInterface
@@ -400,13 +400,13 @@ export interface DocumentsApiInterface {
400
400
  * @param {Blob} file
401
401
  * @param {string} pathPartId Parent path part ID (must be a FOLDER type)
402
402
  * @param {string} [name] Document name (defaults to filename)
403
+ * @param {Array<string>} [tagIds] Tag IDs applied to the created document.
404
+ * @param {string} [idempotencyKey] Opt-in key: a repeat with the same key at the same (parent, name) replays the existing document instead of a 409.
403
405
  * @param {IngestionMode} [ingestionMode]
404
406
  * @param {ChunkType} [chunkType]
405
407
  * @param {ImageTaxonomy} [secondaryTaxonomy]
406
408
  * @param {number} [pageDpi] DPI for PDF page screenshots (default 72, min 36, max 216).
407
409
  * @param {string} [workflowRunId] Workflow run context for assumed agent uploads.
408
- * @param {Array<string>} [tagIds] Tag IDs applied to the created document.
409
- * @param {string} [idempotencyKey] Opt-in key: a repeat with the same key at the same (parent, name) replays the existing document instead of a 409.
410
410
  * @param {string} [workflowDefinitionId] Workflow definition context for assumed agent uploads.
411
411
  * @param {*} [options] Override http request option.
412
412
  * @throws {RequiredError}
@@ -1109,6 +1109,14 @@ export class DocumentsApi extends runtime.BaseAPI implements DocumentsApiInterfa
1109
1109
  formParams.append('name', requestParameters['name'] as any);
1110
1110
  }
1111
1111
 
1112
+ if (requestParameters['tagIds'] != null) {
1113
+ formParams.append('tag_ids', requestParameters['tagIds']!.join(runtime.COLLECTION_FORMATS["csv"]));
1114
+ }
1115
+
1116
+ if (requestParameters['idempotencyKey'] != null) {
1117
+ formParams.append('idempotency_key', requestParameters['idempotencyKey'] as any);
1118
+ }
1119
+
1112
1120
  if (requestParameters['ingestionMode'] != null) {
1113
1121
  formParams.append('ingestion_mode', requestParameters['ingestionMode'] as any);
1114
1122
  }
@@ -1129,14 +1137,6 @@ export class DocumentsApi extends runtime.BaseAPI implements DocumentsApiInterfa
1129
1137
  formParams.append('workflow_run_id', requestParameters['workflowRunId'] as any);
1130
1138
  }
1131
1139
 
1132
- if (requestParameters['tagIds'] != null) {
1133
- formParams.append('tag_ids', requestParameters['tagIds']!.join(runtime.COLLECTION_FORMATS["csv"]));
1134
- }
1135
-
1136
- if (requestParameters['idempotencyKey'] != null) {
1137
- formParams.append('idempotency_key', requestParameters['idempotencyKey'] as any);
1138
- }
1139
-
1140
1140
  if (requestParameters['workflowDefinitionId'] != null) {
1141
1141
  formParams.append('workflow_definition_id', requestParameters['workflowDefinitionId'] as any);
1142
1142
  }