@knowledge-stack/ksapi 1.46.0 → 1.48.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 +8 -0
  2. package/README.md +6 -2
  3. package/dist/esm/models/ChunkBulkResponse.d.ts +8 -6
  4. package/dist/esm/models/ChunkBulkResponse.js +6 -4
  5. package/dist/esm/models/ChunkDocumentResponse.d.ts +67 -0
  6. package/dist/esm/models/ChunkDocumentResponse.js +58 -0
  7. package/dist/esm/models/ChunkDocumentVersionResponse.d.ts +59 -0
  8. package/dist/esm/models/ChunkDocumentVersionResponse.js +52 -0
  9. package/dist/esm/models/ChunkResponse.d.ts +8 -6
  10. package/dist/esm/models/ChunkResponse.js +6 -4
  11. package/dist/esm/models/DocumentType.d.ts +1 -0
  12. package/dist/esm/models/DocumentType.js +1 -0
  13. package/dist/esm/models/EnrichedCitation.d.ts +101 -0
  14. package/dist/esm/models/EnrichedCitation.js +73 -0
  15. package/dist/esm/models/EnrichedThreadMessageContent.d.ts +54 -0
  16. package/dist/esm/models/EnrichedThreadMessageContent.js +47 -0
  17. package/dist/esm/models/ScoredChunkResponse.d.ts +8 -6
  18. package/dist/esm/models/ScoredChunkResponse.js +6 -4
  19. package/dist/esm/models/ThreadMessageResponse.d.ts +3 -3
  20. package/dist/esm/models/ThreadMessageResponse.js +3 -3
  21. package/dist/esm/models/index.d.ts +4 -0
  22. package/dist/esm/models/index.js +4 -0
  23. package/dist/models/ChunkBulkResponse.d.ts +8 -6
  24. package/dist/models/ChunkBulkResponse.js +6 -4
  25. package/dist/models/ChunkDocumentResponse.d.ts +67 -0
  26. package/dist/models/ChunkDocumentResponse.js +66 -0
  27. package/dist/models/ChunkDocumentVersionResponse.d.ts +59 -0
  28. package/dist/models/ChunkDocumentVersionResponse.js +60 -0
  29. package/dist/models/ChunkResponse.d.ts +8 -6
  30. package/dist/models/ChunkResponse.js +6 -4
  31. package/dist/models/DocumentType.d.ts +1 -0
  32. package/dist/models/DocumentType.js +1 -0
  33. package/dist/models/EnrichedCitation.d.ts +101 -0
  34. package/dist/models/EnrichedCitation.js +81 -0
  35. package/dist/models/EnrichedThreadMessageContent.d.ts +54 -0
  36. package/dist/models/EnrichedThreadMessageContent.js +55 -0
  37. package/dist/models/ScoredChunkResponse.d.ts +8 -6
  38. package/dist/models/ScoredChunkResponse.js +6 -4
  39. package/dist/models/ThreadMessageResponse.d.ts +3 -3
  40. package/dist/models/ThreadMessageResponse.js +3 -3
  41. package/dist/models/index.d.ts +4 -0
  42. package/dist/models/index.js +4 -0
  43. package/docs/ChunkBulkResponse.md +4 -4
  44. package/docs/ChunkDocumentResponse.md +41 -0
  45. package/docs/ChunkDocumentVersionResponse.md +39 -0
  46. package/docs/ChunkResponse.md +4 -4
  47. package/docs/EnrichedCitation.md +53 -0
  48. package/docs/EnrichedThreadMessageContent.md +37 -0
  49. package/docs/ScoredChunkResponse.md +4 -4
  50. package/docs/ThreadMessageResponse.md +1 -1
  51. package/package.json +1 -1
  52. package/src/models/ChunkBulkResponse.ts +24 -10
  53. package/src/models/ChunkDocumentResponse.ts +127 -0
  54. package/src/models/ChunkDocumentVersionResponse.ts +101 -0
  55. package/src/models/ChunkResponse.ts +24 -10
  56. package/src/models/DocumentType.ts +1 -0
  57. package/src/models/EnrichedCitation.ts +162 -0
  58. package/src/models/EnrichedThreadMessageContent.ts +99 -0
  59. package/src/models/ScoredChunkResponse.ts +24 -10
  60. package/src/models/ThreadMessageResponse.ts +11 -11
  61. package/src/models/index.ts +4 -0
@@ -0,0 +1,99 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Knowledge Stack API
5
+ * Knowledge Stack backend API for authentication and knowledge management
6
+ *
7
+ * The version of the OpenAPI document: 0.1.0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+ import { mapValues } from '../runtime';
16
+ import type { EnrichedCitation } from './EnrichedCitation';
17
+ import {
18
+ EnrichedCitationFromJSON,
19
+ EnrichedCitationFromJSONTyped,
20
+ EnrichedCitationToJSON,
21
+ EnrichedCitationToJSONTyped,
22
+ } from './EnrichedCitation';
23
+
24
+ /**
25
+ * ThreadMessageContent with enriched citations for API responses.
26
+ * @export
27
+ * @interface EnrichedThreadMessageContent
28
+ */
29
+ export interface EnrichedThreadMessageContent {
30
+ /**
31
+ * The text content of the message
32
+ * @type {string}
33
+ * @memberof EnrichedThreadMessageContent
34
+ */
35
+ text: string;
36
+ /**
37
+ * A list of citations with document context
38
+ * @type {Array<EnrichedCitation>}
39
+ * @memberof EnrichedThreadMessageContent
40
+ */
41
+ citations?: Array<EnrichedCitation> | null;
42
+ }
43
+
44
+ /**
45
+ * Check if a given object implements the EnrichedThreadMessageContent interface.
46
+ */
47
+ export function instanceOfEnrichedThreadMessageContent(value: object): value is EnrichedThreadMessageContent {
48
+ if (!('text' in value) || value['text'] === undefined) return false;
49
+ return true;
50
+ }
51
+
52
+ export function EnrichedThreadMessageContentFromJSON(json: any): EnrichedThreadMessageContent {
53
+ return EnrichedThreadMessageContentFromJSONTyped(json, false);
54
+ }
55
+
56
+ export function EnrichedThreadMessageContentFromJSONTyped(json: any, ignoreDiscriminator: boolean): EnrichedThreadMessageContent {
57
+ if (json == null) {
58
+ return json;
59
+ }
60
+ return {
61
+
62
+ 'text': json['text'],
63
+ 'citations': json['citations'] == null ? undefined : ((json['citations'] as Array<any>).map(EnrichedCitationFromJSON)),
64
+ };
65
+ }
66
+
67
+ export function EnrichedThreadMessageContentToJSON(json: any): EnrichedThreadMessageContent {
68
+ return EnrichedThreadMessageContentToJSONTyped(json, false);
69
+ }
70
+
71
+ export function EnrichedThreadMessageContentToJSONTyped(value?: EnrichedThreadMessageContent | null, ignoreDiscriminator: boolean = false): any {
72
+ if (value == null) {
73
+ return value;
74
+ }
75
+
76
+ return {
77
+
78
+ 'text': value['text'],
79
+ 'citations': value['citations'] == null ? undefined : ((value['citations'] as Array<any>).map(EnrichedCitationToJSON)),
80
+ };
81
+ }
82
+
83
+ export const EnrichedThreadMessageContentPropertyValidationAttributesMap: {
84
+ [property: string]: {
85
+ maxLength?: number,
86
+ minLength?: number,
87
+ pattern?: string,
88
+ maximum?: number,
89
+ exclusiveMaximum?: boolean,
90
+ minimum?: number,
91
+ exclusiveMinimum?: boolean,
92
+ multipleOf?: number,
93
+ maxItems?: number,
94
+ minItems?: number,
95
+ uniqueItems?: boolean
96
+ }
97
+ } = {
98
+ }
99
+
@@ -13,6 +13,13 @@
13
13
  */
14
14
 
15
15
  import { mapValues } from '../runtime';
16
+ import type { ChunkDocumentResponse } from './ChunkDocumentResponse';
17
+ import {
18
+ ChunkDocumentResponseFromJSON,
19
+ ChunkDocumentResponseFromJSONTyped,
20
+ ChunkDocumentResponseToJSON,
21
+ ChunkDocumentResponseToJSONTyped,
22
+ } from './ChunkDocumentResponse';
16
23
  import type { ChunkMetadataOutput } from './ChunkMetadataOutput';
17
24
  import {
18
25
  ChunkMetadataOutputFromJSON,
@@ -27,6 +34,13 @@ import {
27
34
  ChunkTypeToJSON,
28
35
  ChunkTypeToJSONTyped,
29
36
  } from './ChunkType';
37
+ import type { ChunkDocumentVersionResponse } from './ChunkDocumentVersionResponse';
38
+ import {
39
+ ChunkDocumentVersionResponseFromJSON,
40
+ ChunkDocumentVersionResponseFromJSONTyped,
41
+ ChunkDocumentVersionResponseToJSON,
42
+ ChunkDocumentVersionResponseToJSONTyped,
43
+ } from './ChunkDocumentVersionResponse';
30
44
 
31
45
  /**
32
46
  * Chunk response with similarity score.
@@ -125,17 +139,17 @@ export interface ScoredChunkResponse {
125
139
  */
126
140
  assetS3Urls?: Array<string>;
127
141
  /**
128
- * ID of the ancestor document (populated when with_document=true)
129
- * @type {string}
142
+ *
143
+ * @type {ChunkDocumentResponse}
130
144
  * @memberof ScoredChunkResponse
131
145
  */
132
- documentId?: string | null;
146
+ document?: ChunkDocumentResponse;
133
147
  /**
134
- * ID of the ancestor document version (populated when with_document=true)
135
- * @type {string}
148
+ *
149
+ * @type {ChunkDocumentVersionResponse}
136
150
  * @memberof ScoredChunkResponse
137
151
  */
138
- documentVersionId?: string | null;
152
+ documentVersion?: ChunkDocumentVersionResponse;
139
153
  /**
140
154
  * Cosine similarity score (1 - cosine_distance)
141
155
  * @type {number}
@@ -191,8 +205,8 @@ export function ScoredChunkResponseFromJSONTyped(json: any, ignoreDiscriminator:
191
205
  'createdAt': (new Date(json['created_at'])),
192
206
  'updatedAt': (new Date(json['updated_at'])),
193
207
  'assetS3Urls': json['asset_s3_urls'] == null ? undefined : json['asset_s3_urls'],
194
- 'documentId': json['document_id'] == null ? undefined : json['document_id'],
195
- 'documentVersionId': json['document_version_id'] == null ? undefined : json['document_version_id'],
208
+ 'document': json['document'] == null ? undefined : ChunkDocumentResponseFromJSON(json['document']),
209
+ 'documentVersion': json['document_version'] == null ? undefined : ChunkDocumentVersionResponseFromJSON(json['document_version']),
196
210
  'score': json['score'],
197
211
  };
198
212
  }
@@ -223,8 +237,8 @@ export function ScoredChunkResponseToJSONTyped(value?: ScoredChunkResponse | nul
223
237
  'created_at': value['createdAt'].toISOString(),
224
238
  'updated_at': value['updatedAt'].toISOString(),
225
239
  'asset_s3_urls': value['assetS3Urls'],
226
- 'document_id': value['documentId'],
227
- 'document_version_id': value['documentVersionId'],
240
+ 'document': ChunkDocumentResponseToJSON(value['document']),
241
+ 'document_version': ChunkDocumentVersionResponseToJSON(value['documentVersion']),
228
242
  'score': value['score'],
229
243
  };
230
244
  }
@@ -13,6 +13,13 @@
13
13
  */
14
14
 
15
15
  import { mapValues } from '../runtime';
16
+ import type { EnrichedThreadMessageContent } from './EnrichedThreadMessageContent';
17
+ import {
18
+ EnrichedThreadMessageContentFromJSON,
19
+ EnrichedThreadMessageContentFromJSONTyped,
20
+ EnrichedThreadMessageContentToJSON,
21
+ EnrichedThreadMessageContentToJSONTyped,
22
+ } from './EnrichedThreadMessageContent';
16
23
  import type { MessageRole } from './MessageRole';
17
24
  import {
18
25
  MessageRoleFromJSON,
@@ -27,13 +34,6 @@ import {
27
34
  ThreadMessageDetailsOutputToJSON,
28
35
  ThreadMessageDetailsOutputToJSONTyped,
29
36
  } from './ThreadMessageDetailsOutput';
30
- import type { ThreadMessageContent } from './ThreadMessageContent';
31
- import {
32
- ThreadMessageContentFromJSON,
33
- ThreadMessageContentFromJSONTyped,
34
- ThreadMessageContentToJSON,
35
- ThreadMessageContentToJSONTyped,
36
- } from './ThreadMessageContent';
37
37
 
38
38
  /**
39
39
  * Thread message response model.
@@ -67,10 +67,10 @@ export interface ThreadMessageResponse {
67
67
  role: MessageRole;
68
68
  /**
69
69
  *
70
- * @type {ThreadMessageContent}
70
+ * @type {EnrichedThreadMessageContent}
71
71
  * @memberof ThreadMessageResponse
72
72
  */
73
- content: ThreadMessageContent;
73
+ content: EnrichedThreadMessageContent;
74
74
  /**
75
75
  *
76
76
  * @type {ThreadMessageDetailsOutput}
@@ -142,7 +142,7 @@ export function ThreadMessageResponseFromJSONTyped(json: any, ignoreDiscriminato
142
142
  'pathPartId': json['path_part_id'],
143
143
  'sequence': json['sequence'],
144
144
  'role': MessageRoleFromJSON(json['role']),
145
- 'content': ThreadMessageContentFromJSON(json['content']),
145
+ 'content': EnrichedThreadMessageContentFromJSON(json['content']),
146
146
  'details': json['details'] == null ? undefined : ThreadMessageDetailsOutputFromJSON(json['details']),
147
147
  'parentPathId': json['parent_path_id'],
148
148
  'materializedPath': json['materialized_path'],
@@ -167,7 +167,7 @@ export function ThreadMessageResponseToJSONTyped(value?: ThreadMessageResponse |
167
167
  'path_part_id': value['pathPartId'],
168
168
  'sequence': value['sequence'],
169
169
  'role': MessageRoleToJSON(value['role']),
170
- 'content': ThreadMessageContentToJSON(value['content']),
170
+ 'content': EnrichedThreadMessageContentToJSON(value['content']),
171
171
  'details': ThreadMessageDetailsOutputToJSON(value['details']),
172
172
  'parent_path_id': value['parentPathId'],
173
173
  'materialized_path': value['materializedPath'],
@@ -6,6 +6,8 @@ export * from './Args';
6
6
  export * from './BulkTagRequest';
7
7
  export * from './ChunkBulkResponse';
8
8
  export * from './ChunkContentItem';
9
+ export * from './ChunkDocumentResponse';
10
+ export * from './ChunkDocumentVersionResponse';
9
11
  export * from './ChunkLineageResponse';
10
12
  export * from './ChunkMetadataInput';
11
13
  export * from './ChunkMetadataOutput';
@@ -35,6 +37,8 @@ export * from './DocumentVersionMetadataUpdate';
35
37
  export * from './DocumentVersionResponse';
36
38
  export * from './EmailSentResponse';
37
39
  export * from './EmailVerificationRequest';
40
+ export * from './EnrichedCitation';
41
+ export * from './EnrichedThreadMessageContent';
38
42
  export * from './FolderAction';
39
43
  export * from './FolderActionResponse';
40
44
  export * from './FolderResponse';