@knowledge-stack/ksapi 1.25.0 → 1.26.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 (20) hide show
  1. package/README.md +2 -2
  2. package/dist/esm/models/ChunkMetadataInput.d.ts +6 -0
  3. package/dist/esm/models/ChunkMetadataInput.js +2 -0
  4. package/dist/esm/models/ChunkMetadataOutput.d.ts +6 -0
  5. package/dist/esm/models/ChunkMetadataOutput.js +2 -0
  6. package/dist/esm/models/ChunkSearchRequest.d.ts +3 -3
  7. package/dist/esm/models/ChunkSearchRequest.js +6 -2
  8. package/dist/models/ChunkMetadataInput.d.ts +6 -0
  9. package/dist/models/ChunkMetadataInput.js +2 -0
  10. package/dist/models/ChunkMetadataOutput.d.ts +6 -0
  11. package/dist/models/ChunkMetadataOutput.js +2 -0
  12. package/dist/models/ChunkSearchRequest.d.ts +3 -3
  13. package/dist/models/ChunkSearchRequest.js +6 -2
  14. package/docs/ChunkMetadataInput.md +2 -0
  15. package/docs/ChunkMetadataOutput.md +2 -0
  16. package/docs/ChunkSearchRequest.md +2 -2
  17. package/package.json +1 -1
  18. package/src/models/ChunkMetadataInput.ts +8 -0
  19. package/src/models/ChunkMetadataOutput.ts +8 -0
  20. package/src/models/ChunkSearchRequest.ts +9 -5
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- # @knowledge-stack/ksapi@1.25.0
1
+ # @knowledge-stack/ksapi@1.26.0
2
2
 
3
3
  A TypeScript SDK client for the localhost API.
4
4
 
@@ -257,7 +257,7 @@ and is automatically generated by the
257
257
  [OpenAPI Generator](https://openapi-generator.tech) project:
258
258
 
259
259
  - API version: `0.1.0`
260
- - Package version: `1.25.0`
260
+ - Package version: `1.26.0`
261
261
  - Generator version: `7.20.0`
262
262
  - Build package: `org.openapitools.codegen.languages.TypeScriptFetchClientCodegen`
263
263
 
package/dist/esm/models/ChunkMetadataInput.d.ts CHANGED
@@ -28,6 +28,12 @@ export interface ChunkMetadataInput {
28
28
  * @memberof ChunkMetadataInput
29
29
  */
30
30
  s3Url?: string | null;
31
+ /**
32
+ * LLM-generated summary of the chunk content. Used for TABLE chunks to enrich embedding text.
33
+ * @type {string}
34
+ * @memberof ChunkMetadataInput
35
+ */
36
+ summary?: string | null;
31
37
  }
32
38
  /**
33
39
  * Check if a given object implements the ChunkMetadataInput interface.
package/dist/esm/models/ChunkMetadataInput.js CHANGED
@@ -28,6 +28,7 @@ export function ChunkMetadataInputFromJSONTyped(json, ignoreDiscriminator) {
28
28
  return {
29
29
  'polygons': json['polygons'] == null ? undefined : (json['polygons'].map(PolygonReferenceFromJSON)),
30
30
  's3Url': json['s3_url'] == null ? undefined : json['s3_url'],
31
+ 'summary': json['summary'] == null ? undefined : json['summary'],
31
32
  };
32
33
  }
33
34
  export function ChunkMetadataInputToJSON(json) {
@@ -40,6 +41,7 @@ export function ChunkMetadataInputToJSONTyped(value, ignoreDiscriminator = false
40
41
  return {
41
42
  'polygons': value['polygons'] == null ? undefined : (value['polygons'].map(PolygonReferenceToJSON)),
42
43
  's3_url': value['s3Url'],
44
+ 'summary': value['summary'],
43
45
  };
44
46
  }
45
47
  export const ChunkMetadataInputPropertyValidationAttributesMap = {};
package/dist/esm/models/ChunkMetadataOutput.d.ts CHANGED
@@ -28,6 +28,12 @@ export interface ChunkMetadataOutput {
28
28
  * @memberof ChunkMetadataOutput
29
29
  */
30
30
  s3Url?: string | null;
31
+ /**
32
+ * LLM-generated summary of the chunk content. Used for TABLE chunks to enrich embedding text.
33
+ * @type {string}
34
+ * @memberof ChunkMetadataOutput
35
+ */
36
+ summary?: string | null;
31
37
  }
32
38
  /**
33
39
  * Check if a given object implements the ChunkMetadataOutput interface.
package/dist/esm/models/ChunkMetadataOutput.js CHANGED
@@ -28,6 +28,7 @@ export function ChunkMetadataOutputFromJSONTyped(json, ignoreDiscriminator) {
28
28
  return {
29
29
  'polygons': json['polygons'] == null ? undefined : (json['polygons'].map(PolygonReferenceFromJSON)),
30
30
  's3Url': json['s3_url'] == null ? undefined : json['s3_url'],
31
+ 'summary': json['summary'] == null ? undefined : json['summary'],
31
32
  };
32
33
  }
33
34
  export function ChunkMetadataOutputToJSON(json) {
@@ -40,6 +41,7 @@ export function ChunkMetadataOutputToJSONTyped(value, ignoreDiscriminator = fals
40
41
  return {
41
42
  'polygons': value['polygons'] == null ? undefined : (value['polygons'].map(PolygonReferenceToJSON)),
42
43
  's3_url': value['s3Url'],
44
+ 'summary': value['summary'],
43
45
  };
44
46
  }
45
47
  export const ChunkMetadataOutputPropertyValidationAttributesMap = {};
package/dist/esm/models/ChunkSearchRequest.d.ts CHANGED
@@ -42,11 +42,11 @@ export interface ChunkSearchRequest {
42
42
  */
43
43
  tagIds?: Array<string> | null;
44
44
  /**
45
- *
46
- * @type {ChunkType}
45
+ * Filter by chunk types (TEXT, TABLE, IMAGE, UNKNOWN). Only chunks matching one of the listed types are returned.
46
+ * @type {Array<ChunkType>}
47
47
  * @memberof ChunkSearchRequest
48
48
  */
49
- chunkType?: ChunkType;
49
+ chunkTypes?: Array<ChunkType> | null;
50
50
  /**
51
51
  * Only chunks ingested after this timestamp
52
52
  * @type {Date}
package/dist/esm/models/ChunkSearchRequest.js CHANGED
@@ -33,7 +33,7 @@ export function ChunkSearchRequestFromJSONTyped(json, ignoreDiscriminator) {
33
33
  'model': json['model'] == null ? undefined : EmbeddingModelFromJSON(json['model']),
34
34
  'parentPathIds': json['parent_path_ids'] == null ? undefined : json['parent_path_ids'],
35
35
  'tagIds': json['tag_ids'] == null ? undefined : json['tag_ids'],
36
- 'chunkType': json['chunk_type'] == null ? undefined : ChunkTypeFromJSON(json['chunk_type']),
36
+ 'chunkTypes': json['chunk_types'] == null ? undefined : (json['chunk_types'].map(ChunkTypeFromJSON)),
37
37
  'ingestionTimeAfter': json['ingestion_time_after'] == null ? undefined : (new Date(json['ingestion_time_after'])),
38
38
  'activeVersionOnly': json['active_version_only'] == null ? undefined : json['active_version_only'],
39
39
  'topK': json['top_k'] == null ? undefined : json['top_k'],
@@ -52,7 +52,7 @@ export function ChunkSearchRequestToJSONTyped(value, ignoreDiscriminator = false
52
52
  'model': EmbeddingModelToJSON(value['model']),
53
53
  'parent_path_ids': value['parentPathIds'],
54
54
  'tag_ids': value['tagIds'],
55
- 'chunk_type': ChunkTypeToJSON(value['chunkType']),
55
+ 'chunk_types': value['chunkTypes'] == null ? undefined : (value['chunkTypes'].map(ChunkTypeToJSON)),
56
56
  'ingestion_time_after': value['ingestionTimeAfter'] == null ? value['ingestionTimeAfter'] : value['ingestionTimeAfter'].toISOString(),
57
57
  'active_version_only': value['activeVersionOnly'],
58
58
  'top_k': value['topK'],
@@ -63,6 +63,10 @@ export const ChunkSearchRequestPropertyValidationAttributesMap = {
63
63
  query: {
64
64
  minLength: 1,
65
65
  },
66
+ chunkTypes: {
67
+ minItems: 1,
68
+ uniqueItems: false,
69
+ },
66
70
  topK: {
67
71
  maximum: 50,
68
72
  exclusiveMaximum: false,
package/dist/models/ChunkMetadataInput.d.ts CHANGED
@@ -28,6 +28,12 @@ export interface ChunkMetadataInput {
28
28
  * @memberof ChunkMetadataInput
29
29
  */
30
30
  s3Url?: string | null;
31
+ /**
32
+ * LLM-generated summary of the chunk content. Used for TABLE chunks to enrich embedding text.
33
+ * @type {string}
34
+ * @memberof ChunkMetadataInput
35
+ */
36
+ summary?: string | null;
31
37
  }
32
38
  /**
33
39
  * Check if a given object implements the ChunkMetadataInput interface.
package/dist/models/ChunkMetadataInput.js CHANGED
@@ -36,6 +36,7 @@ function ChunkMetadataInputFromJSONTyped(json, ignoreDiscriminator) {
36
36
  return {
37
37
  'polygons': json['polygons'] == null ? undefined : (json['polygons'].map(PolygonReference_1.PolygonReferenceFromJSON)),
38
38
  's3Url': json['s3_url'] == null ? undefined : json['s3_url'],
39
+ 'summary': json['summary'] == null ? undefined : json['summary'],
39
40
  };
40
41
  }
41
42
  function ChunkMetadataInputToJSON(json) {
@@ -48,6 +49,7 @@ function ChunkMetadataInputToJSONTyped(value, ignoreDiscriminator = false) {
48
49
  return {
49
50
  'polygons': value['polygons'] == null ? undefined : (value['polygons'].map(PolygonReference_1.PolygonReferenceToJSON)),
50
51
  's3_url': value['s3Url'],
52
+ 'summary': value['summary'],
51
53
  };
52
54
  }
53
55
  exports.ChunkMetadataInputPropertyValidationAttributesMap = {};
package/dist/models/ChunkMetadataOutput.d.ts CHANGED
@@ -28,6 +28,12 @@ export interface ChunkMetadataOutput {
28
28
  * @memberof ChunkMetadataOutput
29
29
  */
30
30
  s3Url?: string | null;
31
+ /**
32
+ * LLM-generated summary of the chunk content. Used for TABLE chunks to enrich embedding text.
33
+ * @type {string}
34
+ * @memberof ChunkMetadataOutput
35
+ */
36
+ summary?: string | null;
31
37
  }
32
38
  /**
33
39
  * Check if a given object implements the ChunkMetadataOutput interface.
package/dist/models/ChunkMetadataOutput.js CHANGED
@@ -36,6 +36,7 @@ function ChunkMetadataOutputFromJSONTyped(json, ignoreDiscriminator) {
36
36
  return {
37
37
  'polygons': json['polygons'] == null ? undefined : (json['polygons'].map(PolygonReference_1.PolygonReferenceFromJSON)),
38
38
  's3Url': json['s3_url'] == null ? undefined : json['s3_url'],
39
+ 'summary': json['summary'] == null ? undefined : json['summary'],
39
40
  };
40
41
  }
41
42
  function ChunkMetadataOutputToJSON(json) {
@@ -48,6 +49,7 @@ function ChunkMetadataOutputToJSONTyped(value, ignoreDiscriminator = false) {
48
49
  return {
49
50
  'polygons': value['polygons'] == null ? undefined : (value['polygons'].map(PolygonReference_1.PolygonReferenceToJSON)),
50
51
  's3_url': value['s3Url'],
52
+ 'summary': value['summary'],
51
53
  };
52
54
  }
53
55
  exports.ChunkMetadataOutputPropertyValidationAttributesMap = {};
package/dist/models/ChunkSearchRequest.d.ts CHANGED
@@ -42,11 +42,11 @@ export interface ChunkSearchRequest {
42
42
  */
43
43
  tagIds?: Array<string> | null;
44
44
  /**
45
- *
46
- * @type {ChunkType}
45
+ * Filter by chunk types (TEXT, TABLE, IMAGE, UNKNOWN). Only chunks matching one of the listed types are returned.
46
+ * @type {Array<ChunkType>}
47
47
  * @memberof ChunkSearchRequest
48
48
  */
49
- chunkType?: ChunkType;
49
+ chunkTypes?: Array<ChunkType> | null;
50
50
  /**
51
51
  * Only chunks ingested after this timestamp
52
52
  * @type {Date}
package/dist/models/ChunkSearchRequest.js CHANGED
@@ -41,7 +41,7 @@ function ChunkSearchRequestFromJSONTyped(json, ignoreDiscriminator) {
41
41
  'model': json['model'] == null ? undefined : (0, EmbeddingModel_1.EmbeddingModelFromJSON)(json['model']),
42
42
  'parentPathIds': json['parent_path_ids'] == null ? undefined : json['parent_path_ids'],
43
43
  'tagIds': json['tag_ids'] == null ? undefined : json['tag_ids'],
44
- 'chunkType': json['chunk_type'] == null ? undefined : (0, ChunkType_1.ChunkTypeFromJSON)(json['chunk_type']),
44
+ 'chunkTypes': json['chunk_types'] == null ? undefined : (json['chunk_types'].map(ChunkType_1.ChunkTypeFromJSON)),
45
45
  'ingestionTimeAfter': json['ingestion_time_after'] == null ? undefined : (new Date(json['ingestion_time_after'])),
46
46
  'activeVersionOnly': json['active_version_only'] == null ? undefined : json['active_version_only'],
47
47
  'topK': json['top_k'] == null ? undefined : json['top_k'],
@@ -60,7 +60,7 @@ function ChunkSearchRequestToJSONTyped(value, ignoreDiscriminator = false) {
60
60
  'model': (0, EmbeddingModel_1.EmbeddingModelToJSON)(value['model']),
61
61
  'parent_path_ids': value['parentPathIds'],
62
62
  'tag_ids': value['tagIds'],
63
- 'chunk_type': (0, ChunkType_1.ChunkTypeToJSON)(value['chunkType']),
63
+ 'chunk_types': value['chunkTypes'] == null ? undefined : (value['chunkTypes'].map(ChunkType_1.ChunkTypeToJSON)),
64
64
  'ingestion_time_after': value['ingestionTimeAfter'] == null ? value['ingestionTimeAfter'] : value['ingestionTimeAfter'].toISOString(),
65
65
  'active_version_only': value['activeVersionOnly'],
66
66
  'top_k': value['topK'],
@@ -71,6 +71,10 @@ exports.ChunkSearchRequestPropertyValidationAttributesMap = {
71
71
  query: {
72
72
  minLength: 1,
73
73
  },
74
+ chunkTypes: {
75
+ minItems: 1,
76
+ uniqueItems: false,
77
+ },
74
78
  topK: {
75
79
  maximum: 50,
76
80
  exclusiveMaximum: false,
package/docs/ChunkMetadataInput.md CHANGED
@@ -9,6 +9,7 @@ Name | Type
9
9
  ------------ | -------------
10
10
  `polygons` | [Array&lt;PolygonReference&gt;](PolygonReference.md)
11
11
  `s3Url` | string
12
+ `summary` | string
12
13
 
13
14
  ## Example
14
15
 
@@ -19,6 +20,7 @@ import type { ChunkMetadataInput } from '@knowledge-stack/ksapi'
19
20
  const example = {
20
21
  "polygons": null,
21
22
  "s3Url": null,
23
+ "summary": null,
22
24
  } satisfies ChunkMetadataInput
23
25
 
24
26
  console.log(example)
package/docs/ChunkMetadataOutput.md CHANGED
@@ -9,6 +9,7 @@ Name | Type
9
9
  ------------ | -------------
10
10
  `polygons` | [Array&lt;PolygonReference&gt;](PolygonReference.md)
11
11
  `s3Url` | string
12
+ `summary` | string
12
13
 
13
14
  ## Example
14
15
 
@@ -19,6 +20,7 @@ import type { ChunkMetadataOutput } from '@knowledge-stack/ksapi'
19
20
  const example = {
20
21
  "polygons": null,
21
22
  "s3Url": null,
23
+ "summary": null,
22
24
  } satisfies ChunkMetadataOutput
23
25
 
24
26
  console.log(example)
package/docs/ChunkSearchRequest.md CHANGED
@@ -11,7 +11,7 @@ Name | Type
11
11
  `model` | [EmbeddingModel](EmbeddingModel.md)
12
12
  `parentPathIds` | Array&lt;string&gt;
13
13
  `tagIds` | Array&lt;string&gt;
14
- `chunkType` | [ChunkType](ChunkType.md)
14
+ `chunkTypes` | [Array&lt;ChunkType&gt;](ChunkType.md)
15
15
  `ingestionTimeAfter` | Date
16
16
  `activeVersionOnly` | boolean
17
17
  `topK` | number
@@ -28,7 +28,7 @@ const example = {
28
28
  "model": null,
29
29
  "parentPathIds": null,
30
30
  "tagIds": null,
31
- "chunkType": null,
31
+ "chunkTypes": null,
32
32
  "ingestionTimeAfter": null,
33
33
  "activeVersionOnly": null,
34
34
  "topK": null,
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@knowledge-stack/ksapi",
3
- "version": "1.25.0",
3
+ "version": "1.26.0",
4
4
  "description": "OpenAPI client for @knowledge-stack/ksapi",
5
5
  "author": "OpenAPI-Generator",
6
6
  "repository": {
package/src/models/ChunkMetadataInput.ts CHANGED
@@ -39,6 +39,12 @@ export interface ChunkMetadataInput {
39
39
  * @memberof ChunkMetadataInput
40
40
  */
41
41
  s3Url?: string | null;
42
+ /**
43
+ * LLM-generated summary of the chunk content. Used for TABLE chunks to enrich embedding text.
44
+ * @type {string}
45
+ * @memberof ChunkMetadataInput
46
+ */
47
+ summary?: string | null;
42
48
  }
43
49
 
44
50
  /**
@@ -60,6 +66,7 @@ export function ChunkMetadataInputFromJSONTyped(json: any, ignoreDiscriminator:
60
66
 
61
67
  'polygons': json['polygons'] == null ? undefined : ((json['polygons'] as Array<any>).map(PolygonReferenceFromJSON)),
62
68
  's3Url': json['s3_url'] == null ? undefined : json['s3_url'],
69
+ 'summary': json['summary'] == null ? undefined : json['summary'],
63
70
  };
64
71
  }
65
72
 
@@ -76,6 +83,7 @@ export function ChunkMetadataInputToJSONTyped(value?: ChunkMetadataInput | null,
76
83
 
77
84
  'polygons': value['polygons'] == null ? undefined : ((value['polygons'] as Array<any>).map(PolygonReferenceToJSON)),
78
85
  's3_url': value['s3Url'],
86
+ 'summary': value['summary'],
79
87
  };
80
88
  }
81
89
 
package/src/models/ChunkMetadataOutput.ts CHANGED
@@ -39,6 +39,12 @@ export interface ChunkMetadataOutput {
39
39
  * @memberof ChunkMetadataOutput
40
40
  */
41
41
  s3Url?: string | null;
42
+ /**
43
+ * LLM-generated summary of the chunk content. Used for TABLE chunks to enrich embedding text.
44
+ * @type {string}
45
+ * @memberof ChunkMetadataOutput
46
+ */
47
+ summary?: string | null;
42
48
  }
43
49
 
44
50
  /**
@@ -60,6 +66,7 @@ export function ChunkMetadataOutputFromJSONTyped(json: any, ignoreDiscriminator:
60
66
 
61
67
  'polygons': json['polygons'] == null ? undefined : ((json['polygons'] as Array<any>).map(PolygonReferenceFromJSON)),
62
68
  's3Url': json['s3_url'] == null ? undefined : json['s3_url'],
69
+ 'summary': json['summary'] == null ? undefined : json['summary'],
63
70
  };
64
71
  }
65
72
 
@@ -76,6 +83,7 @@ export function ChunkMetadataOutputToJSONTyped(value?: ChunkMetadataOutput | nul
76
83
 
77
84
  'polygons': value['polygons'] == null ? undefined : ((value['polygons'] as Array<any>).map(PolygonReferenceToJSON)),
78
85
  's3_url': value['s3Url'],
86
+ 'summary': value['summary'],
79
87
  };
80
88
  }
81
89
 
package/src/models/ChunkSearchRequest.ts CHANGED
@@ -59,11 +59,11 @@ export interface ChunkSearchRequest {
59
59
  */
60
60
  tagIds?: Array<string> | null;
61
61
  /**
62
- *
63
- * @type {ChunkType}
62
+ * Filter by chunk types (TEXT, TABLE, IMAGE, UNKNOWN). Only chunks matching one of the listed types are returned.
63
+ * @type {Array<ChunkType>}
64
64
  * @memberof ChunkSearchRequest
65
65
  */
66
- chunkType?: ChunkType;
66
+ chunkTypes?: Array<ChunkType> | null;
67
67
  /**
68
68
  * Only chunks ingested after this timestamp
69
69
  * @type {Date}
@@ -114,7 +114,7 @@ export function ChunkSearchRequestFromJSONTyped(json: any, ignoreDiscriminator:
114
114
  'model': json['model'] == null ? undefined : EmbeddingModelFromJSON(json['model']),
115
115
  'parentPathIds': json['parent_path_ids'] == null ? undefined : json['parent_path_ids'],
116
116
  'tagIds': json['tag_ids'] == null ? undefined : json['tag_ids'],
117
- 'chunkType': json['chunk_type'] == null ? undefined : ChunkTypeFromJSON(json['chunk_type']),
117
+ 'chunkTypes': json['chunk_types'] == null ? undefined : ((json['chunk_types'] as Array<any>).map(ChunkTypeFromJSON)),
118
118
  'ingestionTimeAfter': json['ingestion_time_after'] == null ? undefined : (new Date(json['ingestion_time_after'])),
119
119
  'activeVersionOnly': json['active_version_only'] == null ? undefined : json['active_version_only'],
120
120
  'topK': json['top_k'] == null ? undefined : json['top_k'],
@@ -137,7 +137,7 @@ export function ChunkSearchRequestToJSONTyped(value?: ChunkSearchRequest | null,
137
137
  'model': EmbeddingModelToJSON(value['model']),
138
138
  'parent_path_ids': value['parentPathIds'],
139
139
  'tag_ids': value['tagIds'],
140
- 'chunk_type': ChunkTypeToJSON(value['chunkType']),
140
+ 'chunk_types': value['chunkTypes'] == null ? undefined : ((value['chunkTypes'] as Array<any>).map(ChunkTypeToJSON)),
141
141
  'ingestion_time_after': value['ingestionTimeAfter'] == null ? value['ingestionTimeAfter'] : value['ingestionTimeAfter'].toISOString(),
142
142
  'active_version_only': value['activeVersionOnly'],
143
143
  'top_k': value['topK'],
@@ -163,6 +163,10 @@ export const ChunkSearchRequestPropertyValidationAttributesMap: {
163
163
  query: {
164
164
  minLength: 1,
165
165
  },
166
+ chunkTypes: {
167
+ minItems: 1,
168
+ uniqueItems: false,
169
+ },
166
170
  topK: {
167
171
  maximum: 50,
168
172
  exclusiveMaximum: false,