@knowledge-stack/ksapi 2.12.0 → 2.13.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 (43) hide show
  1. package/.openapi-generator/FILES +2 -0
  2. package/README.md +3 -2
  3. package/dist/apis/FoldersApi.d.ts +10 -10
  4. package/dist/apis/FoldersApi.js +4 -4
  5. package/dist/esm/apis/FoldersApi.d.ts +10 -10
  6. package/dist/esm/apis/FoldersApi.js +5 -5
  7. package/dist/esm/models/ResolvedReferenceInput.d.ts +7 -0
  8. package/dist/esm/models/ResolvedReferenceInput.js +3 -0
  9. package/dist/esm/models/ResolvedReferenceOutput.d.ts +7 -0
  10. package/dist/esm/models/ResolvedReferenceOutput.js +3 -0
  11. package/dist/esm/models/SearchItemsResponse.d.ts +77 -0
  12. package/dist/esm/models/SearchItemsResponse.js +72 -0
  13. package/dist/esm/models/SearchSortOrder.d.ts +6 -1
  14. package/dist/esm/models/SearchSortOrder.js +6 -1
  15. package/dist/esm/models/SearchablePartType.d.ts +1 -0
  16. package/dist/esm/models/SearchablePartType.js +2 -1
  17. package/dist/esm/models/index.d.ts +1 -0
  18. package/dist/esm/models/index.js +1 -0
  19. package/dist/models/ResolvedReferenceInput.d.ts +7 -0
  20. package/dist/models/ResolvedReferenceInput.js +3 -0
  21. package/dist/models/ResolvedReferenceOutput.d.ts +7 -0
  22. package/dist/models/ResolvedReferenceOutput.js +3 -0
  23. package/dist/models/SearchItemsResponse.d.ts +77 -0
  24. package/dist/models/SearchItemsResponse.js +80 -0
  25. package/dist/models/SearchSortOrder.d.ts +6 -1
  26. package/dist/models/SearchSortOrder.js +6 -1
  27. package/dist/models/SearchablePartType.d.ts +1 -0
  28. package/dist/models/SearchablePartType.js +2 -1
  29. package/dist/models/index.d.ts +1 -0
  30. package/dist/models/index.js +1 -0
  31. package/docs/FoldersApi.md +7 -7
  32. package/docs/ResolvedReferenceInput.md +2 -0
  33. package/docs/ResolvedReferenceOutput.md +2 -0
  34. package/docs/SearchItemsResponse.md +43 -0
  35. package/docs/SearchSortOrder.md +1 -1
  36. package/package.json +1 -1
  37. package/src/apis/FoldersApi.ts +17 -14
  38. package/src/models/ResolvedReferenceInput.ts +15 -0
  39. package/src/models/ResolvedReferenceOutput.ts +18 -0
  40. package/src/models/SearchItemsResponse.ts +141 -0
  41. package/src/models/SearchSortOrder.ts +6 -1
  42. package/src/models/SearchablePartType.ts +2 -1
  43. package/src/models/index.ts +1 -0
@@ -293,6 +293,7 @@ docs/RunTimeseriesResponse.md
293
293
  docs/SSOInitiateResponse.md
294
294
  docs/ScheduleCadence.md
295
295
  docs/ScoredChunkResponse.md
296
+ docs/SearchItemsResponse.md
296
297
  docs/SearchSkillsRequest.md
297
298
  docs/SearchSkillsResponse.md
298
299
  docs/SearchSortOrder.md
@@ -748,6 +749,7 @@ src/models/RunTimeseriesResponse.ts
748
749
  src/models/SSOInitiateResponse.ts
749
750
  src/models/ScheduleCadence.ts
750
751
  src/models/ScoredChunkResponse.ts
752
+ src/models/SearchItemsResponse.ts
751
753
  src/models/SearchSkillsRequest.ts
752
754
  src/models/SearchSkillsResponse.ts
753
755
  src/models/SearchSortOrder.ts
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- # @knowledge-stack/ksapi@2.12.0
1
+ # @knowledge-stack/ksapi@2.13.0
2
2
 
3
3
  A TypeScript SDK client for the localhost API.
4
4
 
@@ -570,6 +570,7 @@ All URIs are relative to *http://localhost:8000*
570
570
  - [SSOInitiateResponse](docs/SSOInitiateResponse.md)
571
571
  - [ScheduleCadence](docs/ScheduleCadence.md)
572
572
  - [ScoredChunkResponse](docs/ScoredChunkResponse.md)
573
+ - [SearchItemsResponse](docs/SearchItemsResponse.md)
573
574
  - [SearchSkillsRequest](docs/SearchSkillsRequest.md)
574
575
  - [SearchSkillsResponse](docs/SearchSkillsResponse.md)
575
576
  - [SearchSortOrder](docs/SearchSortOrder.md)
@@ -724,7 +725,7 @@ and is automatically generated by the
724
725
  [OpenAPI Generator](https://openapi-generator.tech) project:
725
726
 
726
727
  - API version: `0.1.0`
727
- - Package version: `2.12.0`
728
+ - Package version: `2.13.0`
728
729
  - Generator version: `7.21.0`
729
730
  - Build package: `org.openapitools.codegen.languages.TypeScriptFetchClientCodegen`
730
731
 
@@ -10,7 +10,7 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  import * as runtime from '../runtime';
13
- import type { ContentsSortOrder, CreateFolderRequest, FolderAction, FolderActionResponse, FolderResponse, PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDat, PaginatedResponseFolderResponse, PathOrder, PathPartApprovalState, SearchSortOrder, SearchablePartType, SortDirection, UpdateFolderRequest } from '../models/index';
13
+ import type { ContentsSortOrder, CreateFolderRequest, FolderAction, FolderActionResponse, FolderResponse, PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDat, PaginatedResponseFolderResponse, PathOrder, PathPartApprovalState, SearchItemsResponse, SearchSortOrder, SearchablePartType, SortDirection, UpdateFolderRequest } from '../models/index';
14
14
  export interface CreateFolderOperationRequest {
15
15
  createFolderRequest: CreateFolderRequest;
16
16
  }
@@ -58,8 +58,8 @@ export interface ListFoldersRequest {
58
58
  }
59
59
  export interface SearchItemsRequest {
60
60
  nameLike: string;
61
+ partType?: Array<SearchablePartType>;
61
62
  sortOrder?: SearchSortOrder;
62
- partType?: SearchablePartType;
63
63
  withTags?: boolean;
64
64
  parentPathPartId?: string | null;
65
65
  limit?: number;
@@ -258,8 +258,8 @@ export interface FoldersApiInterface {
258
258
  /**
259
259
  * Creates request options for searchItems without sending the request
260
260
  * @param {string} nameLike Case-insensitive partial name search
261
- * @param {SearchSortOrder} [sortOrder] Sort order for results (default: NAME)
262
- * @param {SearchablePartType} [partType] Filter by item type (default: all searchable types)
261
+ * @param {Array<SearchablePartType>} [partType] Filter by item type; repeat the parameter to select several (default: all searchable types)
262
+ * @param {SearchSortOrder} [sortOrder] Sort order for results (default: RELEVANCE)
263
263
  * @param {boolean} [withTags] Include tags in the response (default: false)
264
264
  * @param {string} [parentPathPartId] Scope search to descendants of this folder\&#39;s path part
265
265
  * @param {number} [limit] Number of items per page
@@ -272,8 +272,8 @@ export interface FoldersApiInterface {
272
272
  * Search for folders, documents, and connectors by name. Performs a case-insensitive partial name match using trigram indexing. Results are filtered by the current user\'s path permissions. When parent_path_part_id is provided, only items under that folder are searched. Otherwise, all accessible items across the tenant are searched.
273
273
  * @summary Search Items Handler
274
274
  * @param {string} nameLike Case-insensitive partial name search
275
- * @param {SearchSortOrder} [sortOrder] Sort order for results (default: NAME)
276
- * @param {SearchablePartType} [partType] Filter by item type (default: all searchable types)
275
+ * @param {Array<SearchablePartType>} [partType] Filter by item type; repeat the parameter to select several (default: all searchable types)
276
+ * @param {SearchSortOrder} [sortOrder] Sort order for results (default: RELEVANCE)
277
277
  * @param {boolean} [withTags] Include tags in the response (default: false)
278
278
  * @param {string} [parentPathPartId] Scope search to descendants of this folder\&#39;s path part
279
279
  * @param {number} [limit] Number of items per page
@@ -282,12 +282,12 @@ export interface FoldersApiInterface {
282
282
  * @throws {RequiredError}
283
283
  * @memberof FoldersApiInterface
284
284
  */
285
- searchItemsRaw(requestParameters: SearchItemsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDat>>;
285
+ searchItemsRaw(requestParameters: SearchItemsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SearchItemsResponse>>;
286
286
  /**
287
287
  * Search for folders, documents, and connectors by name. Performs a case-insensitive partial name match using trigram indexing. Results are filtered by the current user\'s path permissions. When parent_path_part_id is provided, only items under that folder are searched. Otherwise, all accessible items across the tenant are searched.
288
288
  * Search Items Handler
289
289
  */
290
- searchItems(requestParameters: SearchItemsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDat>;
290
+ searchItems(requestParameters: SearchItemsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SearchItemsResponse>;
291
291
  /**
292
292
  * Creates request options for updateFolder without sending the request
293
293
  * @param {string} folderId
@@ -406,12 +406,12 @@ export declare class FoldersApi extends runtime.BaseAPI implements FoldersApiInt
406
406
  * Search for folders, documents, and connectors by name. Performs a case-insensitive partial name match using trigram indexing. Results are filtered by the current user\'s path permissions. When parent_path_part_id is provided, only items under that folder are searched. Otherwise, all accessible items across the tenant are searched.
407
407
  * Search Items Handler
408
408
  */
409
- searchItemsRaw(requestParameters: SearchItemsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDat>>;
409
+ searchItemsRaw(requestParameters: SearchItemsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SearchItemsResponse>>;
410
410
  /**
411
411
  * Search for folders, documents, and connectors by name. Performs a case-insensitive partial name match using trigram indexing. Results are filtered by the current user\'s path permissions. When parent_path_part_id is provided, only items under that folder are searched. Otherwise, all accessible items across the tenant are searched.
412
412
  * Search Items Handler
413
413
  */
414
- searchItems(requestParameters: SearchItemsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDat>;
414
+ searchItems(requestParameters: SearchItemsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SearchItemsResponse>;
415
415
  /**
416
416
  * Creates request options for updateFolder without sending the request
417
417
  */
@@ -443,12 +443,12 @@ class FoldersApi extends runtime.BaseAPI {
443
443
  if (requestParameters['nameLike'] != null) {
444
444
  queryParameters['name_like'] = requestParameters['nameLike'];
445
445
  }
446
- if (requestParameters['sortOrder'] != null) {
447
- queryParameters['sort_order'] = requestParameters['sortOrder'];
448
- }
449
446
  if (requestParameters['partType'] != null) {
450
447
  queryParameters['part_type'] = requestParameters['partType'];
451
448
  }
449
+ if (requestParameters['sortOrder'] != null) {
450
+ queryParameters['sort_order'] = requestParameters['sortOrder'];
451
+ }
452
452
  if (requestParameters['withTags'] != null) {
453
453
  queryParameters['with_tags'] = requestParameters['withTags'];
454
454
  }
@@ -486,7 +486,7 @@ class FoldersApi extends runtime.BaseAPI {
486
486
  return __awaiter(this, void 0, void 0, function* () {
487
487
  const requestOptions = yield this.searchItemsRequestOpts(requestParameters);
488
488
  const response = yield this.request(requestOptions, initOverrides);
489
- return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDatFromJSON)(jsonValue));
489
+ return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.SearchItemsResponseFromJSON)(jsonValue));
490
490
  });
491
491
  }
492
492
  /**
@@ -10,7 +10,7 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  import * as runtime from '../runtime';
13
- import type { ContentsSortOrder, CreateFolderRequest, FolderAction, FolderActionResponse, FolderResponse, PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDat, PaginatedResponseFolderResponse, PathOrder, PathPartApprovalState, SearchSortOrder, SearchablePartType, SortDirection, UpdateFolderRequest } from '../models/index';
13
+ import type { ContentsSortOrder, CreateFolderRequest, FolderAction, FolderActionResponse, FolderResponse, PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDat, PaginatedResponseFolderResponse, PathOrder, PathPartApprovalState, SearchItemsResponse, SearchSortOrder, SearchablePartType, SortDirection, UpdateFolderRequest } from '../models/index';
14
14
  export interface CreateFolderOperationRequest {
15
15
  createFolderRequest: CreateFolderRequest;
16
16
  }
@@ -58,8 +58,8 @@ export interface ListFoldersRequest {
58
58
  }
59
59
  export interface SearchItemsRequest {
60
60
  nameLike: string;
61
+ partType?: Array<SearchablePartType>;
61
62
  sortOrder?: SearchSortOrder;
62
- partType?: SearchablePartType;
63
63
  withTags?: boolean;
64
64
  parentPathPartId?: string | null;
65
65
  limit?: number;
@@ -258,8 +258,8 @@ export interface FoldersApiInterface {
258
258
  /**
259
259
  * Creates request options for searchItems without sending the request
260
260
  * @param {string} nameLike Case-insensitive partial name search
261
- * @param {SearchSortOrder} [sortOrder] Sort order for results (default: NAME)
262
- * @param {SearchablePartType} [partType] Filter by item type (default: all searchable types)
261
+ * @param {Array<SearchablePartType>} [partType] Filter by item type; repeat the parameter to select several (default: all searchable types)
262
+ * @param {SearchSortOrder} [sortOrder] Sort order for results (default: RELEVANCE)
263
263
  * @param {boolean} [withTags] Include tags in the response (default: false)
264
264
  * @param {string} [parentPathPartId] Scope search to descendants of this folder\&#39;s path part
265
265
  * @param {number} [limit] Number of items per page
@@ -272,8 +272,8 @@ export interface FoldersApiInterface {
272
272
  * Search for folders, documents, and connectors by name. Performs a case-insensitive partial name match using trigram indexing. Results are filtered by the current user\'s path permissions. When parent_path_part_id is provided, only items under that folder are searched. Otherwise, all accessible items across the tenant are searched.
273
273
  * @summary Search Items Handler
274
274
  * @param {string} nameLike Case-insensitive partial name search
275
- * @param {SearchSortOrder} [sortOrder] Sort order for results (default: NAME)
276
- * @param {SearchablePartType} [partType] Filter by item type (default: all searchable types)
275
+ * @param {Array<SearchablePartType>} [partType] Filter by item type; repeat the parameter to select several (default: all searchable types)
276
+ * @param {SearchSortOrder} [sortOrder] Sort order for results (default: RELEVANCE)
277
277
  * @param {boolean} [withTags] Include tags in the response (default: false)
278
278
  * @param {string} [parentPathPartId] Scope search to descendants of this folder\&#39;s path part
279
279
  * @param {number} [limit] Number of items per page
@@ -282,12 +282,12 @@ export interface FoldersApiInterface {
282
282
  * @throws {RequiredError}
283
283
  * @memberof FoldersApiInterface
284
284
  */
285
- searchItemsRaw(requestParameters: SearchItemsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDat>>;
285
+ searchItemsRaw(requestParameters: SearchItemsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SearchItemsResponse>>;
286
286
  /**
287
287
  * Search for folders, documents, and connectors by name. Performs a case-insensitive partial name match using trigram indexing. Results are filtered by the current user\'s path permissions. When parent_path_part_id is provided, only items under that folder are searched. Otherwise, all accessible items across the tenant are searched.
288
288
  * Search Items Handler
289
289
  */
290
- searchItems(requestParameters: SearchItemsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDat>;
290
+ searchItems(requestParameters: SearchItemsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SearchItemsResponse>;
291
291
  /**
292
292
  * Creates request options for updateFolder without sending the request
293
293
  * @param {string} folderId
@@ -406,12 +406,12 @@ export declare class FoldersApi extends runtime.BaseAPI implements FoldersApiInt
406
406
  * Search for folders, documents, and connectors by name. Performs a case-insensitive partial name match using trigram indexing. Results are filtered by the current user\'s path permissions. When parent_path_part_id is provided, only items under that folder are searched. Otherwise, all accessible items across the tenant are searched.
407
407
  * Search Items Handler
408
408
  */
409
- searchItemsRaw(requestParameters: SearchItemsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDat>>;
409
+ searchItemsRaw(requestParameters: SearchItemsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SearchItemsResponse>>;
410
410
  /**
411
411
  * Search for folders, documents, and connectors by name. Performs a case-insensitive partial name match using trigram indexing. Results are filtered by the current user\'s path permissions. When parent_path_part_id is provided, only items under that folder are searched. Otherwise, all accessible items across the tenant are searched.
412
412
  * Search Items Handler
413
413
  */
414
- searchItems(requestParameters: SearchItemsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDat>;
414
+ searchItems(requestParameters: SearchItemsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SearchItemsResponse>;
415
415
  /**
416
416
  * Creates request options for updateFolder without sending the request
417
417
  */
@@ -21,7 +21,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
21
21
  });
22
22
  };
23
23
  import * as runtime from '../runtime';
24
- import { CreateFolderRequestToJSON, FolderActionResponseFromJSON, FolderResponseFromJSON, PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDatFromJSON, PaginatedResponseFolderResponseFromJSON, UpdateFolderRequestToJSON, } from '../models/index';
24
+ import { CreateFolderRequestToJSON, FolderActionResponseFromJSON, FolderResponseFromJSON, PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDatFromJSON, PaginatedResponseFolderResponseFromJSON, SearchItemsResponseFromJSON, UpdateFolderRequestToJSON, } from '../models/index';
25
25
  /**
26
26
  *
27
27
  */
@@ -407,12 +407,12 @@ export class FoldersApi extends runtime.BaseAPI {
407
407
  if (requestParameters['nameLike'] != null) {
408
408
  queryParameters['name_like'] = requestParameters['nameLike'];
409
409
  }
410
- if (requestParameters['sortOrder'] != null) {
411
- queryParameters['sort_order'] = requestParameters['sortOrder'];
412
- }
413
410
  if (requestParameters['partType'] != null) {
414
411
  queryParameters['part_type'] = requestParameters['partType'];
415
412
  }
413
+ if (requestParameters['sortOrder'] != null) {
414
+ queryParameters['sort_order'] = requestParameters['sortOrder'];
415
+ }
416
416
  if (requestParameters['withTags'] != null) {
417
417
  queryParameters['with_tags'] = requestParameters['withTags'];
418
418
  }
@@ -450,7 +450,7 @@ export class FoldersApi extends runtime.BaseAPI {
450
450
  return __awaiter(this, void 0, void 0, function* () {
451
451
  const requestOptions = yield this.searchItemsRequestOpts(requestParameters);
452
452
  const response = yield this.request(requestOptions, initOverrides);
453
- return new runtime.JSONApiResponse(response, (jsonValue) => PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDatFromJSON(jsonValue));
453
+ return new runtime.JSONApiResponse(response, (jsonValue) => SearchItemsResponseFromJSON(jsonValue));
454
454
  });
455
455
  }
456
456
  /**
@@ -9,6 +9,7 @@
9
9
  * https://openapi-generator.tech
10
10
  * Do not edit the class manually.
11
11
  */
12
+ import type { DocumentType } from './DocumentType';
12
13
  import type { ReferenceType } from './ReferenceType';
13
14
  /**
14
15
  * A parsed reference enriched with display name and path from the database.
@@ -44,6 +45,12 @@ export interface ResolvedReferenceInput {
44
45
  * @memberof ResolvedReferenceInput
45
46
  */
46
47
  materializedPath?: string | null;
48
+ /**
49
+ *
50
+ * @type {DocumentType}
51
+ * @memberof ResolvedReferenceInput
52
+ */
53
+ documentType?: DocumentType;
47
54
  }
48
55
  export declare const ResolvedReferenceInputPropertyValidationAttributesMap: {
49
56
  [property: string]: {
@@ -11,6 +11,7 @@
11
11
  * https://openapi-generator.tech
12
12
  * Do not edit the class manually.
13
13
  */
14
+ import { DocumentTypeFromJSON, DocumentTypeToJSON, } from './DocumentType';
14
15
  import { ReferenceTypeFromJSON, ReferenceTypeToJSON, } from './ReferenceType';
15
16
  export const ResolvedReferenceInputPropertyValidationAttributesMap = {};
16
17
  /**
@@ -37,6 +38,7 @@ export function ResolvedReferenceInputFromJSONTyped(json, ignoreDiscriminator) {
37
38
  'entityId': json['entity_id'],
38
39
  'displayName': json['display_name'],
39
40
  'materializedPath': json['materialized_path'] == null ? undefined : json['materialized_path'],
41
+ 'documentType': json['document_type'] == null ? undefined : DocumentTypeFromJSON(json['document_type']),
40
42
  };
41
43
  }
42
44
  export function ResolvedReferenceInputToJSON(json) {
@@ -51,5 +53,6 @@ export function ResolvedReferenceInputToJSONTyped(value, ignoreDiscriminator = f
51
53
  'entity_id': value['entityId'],
52
54
  'display_name': value['displayName'],
53
55
  'materialized_path': value['materializedPath'],
56
+ 'document_type': DocumentTypeToJSON(value['documentType']),
54
57
  };
55
58
  }
@@ -9,6 +9,7 @@
9
9
  * https://openapi-generator.tech
10
10
  * Do not edit the class manually.
11
11
  */
12
+ import type { DocumentType } from './DocumentType';
12
13
  /**
13
14
  * A parsed reference enriched with display name and path from the database.
14
15
  *
@@ -43,6 +44,12 @@ export interface ResolvedReferenceOutput {
43
44
  * @memberof ResolvedReferenceOutput
44
45
  */
45
46
  materializedPath?: string | null;
47
+ /**
48
+ *
49
+ * @type {DocumentType}
50
+ * @memberof ResolvedReferenceOutput
51
+ */
52
+ documentType?: DocumentType;
46
53
  }
47
54
  export declare const ResolvedReferenceOutputPropertyValidationAttributesMap: {
48
55
  [property: string]: {
@@ -11,6 +11,7 @@
11
11
  * https://openapi-generator.tech
12
12
  * Do not edit the class manually.
13
13
  */
14
+ import { DocumentTypeFromJSON, DocumentTypeToJSON, } from './DocumentType';
14
15
  export const ResolvedReferenceOutputPropertyValidationAttributesMap = {};
15
16
  /**
16
17
  * Check if a given object implements the ResolvedReferenceOutput interface.
@@ -36,6 +37,7 @@ export function ResolvedReferenceOutputFromJSONTyped(json, ignoreDiscriminator)
36
37
  'entityId': json['entity_id'],
37
38
  'displayName': json['display_name'],
38
39
  'materializedPath': json['materialized_path'] == null ? undefined : json['materialized_path'],
40
+ 'documentType': json['document_type'] == null ? undefined : DocumentTypeFromJSON(json['document_type']),
39
41
  };
40
42
  }
41
43
  export function ResolvedReferenceOutputToJSON(json) {
@@ -50,5 +52,6 @@ export function ResolvedReferenceOutputToJSONTyped(value, ignoreDiscriminator =
50
52
  'entity_id': value['entityId'],
51
53
  'display_name': value['displayName'],
52
54
  'materialized_path': value['materializedPath'],
55
+ 'document_type': DocumentTypeToJSON(value['documentType']),
53
56
  };
54
57
  }
@@ -0,0 +1,77 @@
1
+ /**
2
+ * Knowledge Stack API
3
+ * Knowledge Stack backend API for authentication and knowledge management. ## Integrating (RPA / machine clients) **Base URL.** Knowledge Stack is self-hosted — point at your own deployment host (see `servers`). The `localhost` entry is for local development only. **Authentication.** Send `Authorization: Bearer <api-key>` on every request. Mint an API key once via `POST /v1/api-keys` from a signed-in browser session; the raw `sk-user-...` secret is returned **only** at creation, so store it then. A key inherits its owning user\'s live tenant role and path permissions — create RPA keys from a least-privilege user, and set `expires_at` for rotation. The `ks_uat` cookie scheme is browser-only and cannot be used by headless clients. **Async work is polled, not pushed.** There are no outbound webhooks. - `POST /v1/documents/ingest` returns `201` immediately with a `workflow_id`; poll `GET /v1/system-jobs/document_versions/{workflow_id}` until `status` is terminal (anything other than `pending`/`processing`). The `Location` response header points at this poll resource. - `POST /v1/workflow-runs/{run_id}/start` returns `202`; poll `GET /v1/workflow-runs/{run_id}` until `execution_state` is `COMPLETED` or `FAILED`. The `Location` header points at the run resource. - `POST /v1/agent/ask` is **synchronous** — it blocks until the agent finishes and returns the answer inline. Use a generous HTTP timeout. **Pagination.** List endpoints accept `limit`/`offset` and return `{items, total, limit, offset}`. **Errors.** Every non-2xx body is `{detail, code, request_id}`. `code` is a stable value from a closed set (see the `ErrorResponse` schema\'s `code` enum) — branch on it rather than parsing `detail`. Quota rejections return `429` with a `Retry-After` header; transient lock contention returns a retryable `503`. Quote `request_id` (also the `x-request-id` response header) to support. **Idempotency.** `POST /v1/workflow-runs` accepts an `idempotency_key` to dedupe retried run creation. `agent/ask` charges one message *before* running and does not refund a client-cancelled call.
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
+ import type { FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceSchemaR } from './FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceSchemaR';
13
+ /**
14
+ * A search page plus how many items of each type the query matched.
15
+ *
16
+ * ``counts_by_type`` ignores any ``part_type`` filter so the filter chips can
17
+ * keep showing every type's count while one of them is selected.
18
+ * @export
19
+ * @interface SearchItemsResponse
20
+ */
21
+ export interface SearchItemsResponse {
22
+ /**
23
+ * List of items
24
+ * @type {Array<FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceSchemaR>}
25
+ * @memberof SearchItemsResponse
26
+ */
27
+ items: Array<FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceSchemaR>;
28
+ /**
29
+ * Total number of items
30
+ * @type {number}
31
+ * @memberof SearchItemsResponse
32
+ */
33
+ total: number;
34
+ /**
35
+ * Number of items per page
36
+ * @type {number}
37
+ * @memberof SearchItemsResponse
38
+ */
39
+ limit: number;
40
+ /**
41
+ * Number of items to skip
42
+ * @type {number}
43
+ * @memberof SearchItemsResponse
44
+ */
45
+ offset: number;
46
+ /**
47
+ * Matches per item type, keyed by SearchablePartType and unaffected by the part_type filter
48
+ * @type {{ [key: string]: number; }}
49
+ * @memberof SearchItemsResponse
50
+ */
51
+ countsByType?: {
52
+ [key: string]: number;
53
+ };
54
+ }
55
+ export declare const SearchItemsResponsePropertyValidationAttributesMap: {
56
+ [property: string]: {
57
+ maxLength?: number;
58
+ minLength?: number;
59
+ pattern?: string;
60
+ maximum?: number;
61
+ exclusiveMaximum?: boolean;
62
+ minimum?: number;
63
+ exclusiveMinimum?: boolean;
64
+ multipleOf?: number;
65
+ maxItems?: number;
66
+ minItems?: number;
67
+ uniqueItems?: boolean;
68
+ };
69
+ };
70
+ /**
71
+ * Check if a given object implements the SearchItemsResponse interface.
72
+ */
73
+ export declare function instanceOfSearchItemsResponse(value: object): value is SearchItemsResponse;
74
+ export declare function SearchItemsResponseFromJSON(json: any): SearchItemsResponse;
75
+ export declare function SearchItemsResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): SearchItemsResponse;
76
+ export declare function SearchItemsResponseToJSON(json: any): SearchItemsResponse;
77
+ export declare function SearchItemsResponseToJSONTyped(value?: SearchItemsResponse | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,72 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Knowledge Stack API
5
+ * Knowledge Stack backend API for authentication and knowledge management. ## Integrating (RPA / machine clients) **Base URL.** Knowledge Stack is self-hosted — point at your own deployment host (see `servers`). The `localhost` entry is for local development only. **Authentication.** Send `Authorization: Bearer <api-key>` on every request. Mint an API key once via `POST /v1/api-keys` from a signed-in browser session; the raw `sk-user-...` secret is returned **only** at creation, so store it then. A key inherits its owning user\'s live tenant role and path permissions — create RPA keys from a least-privilege user, and set `expires_at` for rotation. The `ks_uat` cookie scheme is browser-only and cannot be used by headless clients. **Async work is polled, not pushed.** There are no outbound webhooks. - `POST /v1/documents/ingest` returns `201` immediately with a `workflow_id`; poll `GET /v1/system-jobs/document_versions/{workflow_id}` until `status` is terminal (anything other than `pending`/`processing`). The `Location` response header points at this poll resource. - `POST /v1/workflow-runs/{run_id}/start` returns `202`; poll `GET /v1/workflow-runs/{run_id}` until `execution_state` is `COMPLETED` or `FAILED`. The `Location` header points at the run resource. - `POST /v1/agent/ask` is **synchronous** — it blocks until the agent finishes and returns the answer inline. Use a generous HTTP timeout. **Pagination.** List endpoints accept `limit`/`offset` and return `{items, total, limit, offset}`. **Errors.** Every non-2xx body is `{detail, code, request_id}`. `code` is a stable value from a closed set (see the `ErrorResponse` schema\'s `code` enum) — branch on it rather than parsing `detail`. Quota rejections return `429` with a `Retry-After` header; transient lock contention returns a retryable `503`. Quote `request_id` (also the `x-request-id` response header) to support. **Idempotency.** `POST /v1/workflow-runs` accepts an `idempotency_key` to dedupe retried run creation. `agent/ask` charges one message *before* running and does not refund a client-cancelled call.
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
+ import { FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceSchemaRFromJSON, FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceSchemaRToJSON, } from './FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceSchemaR';
15
+ export const SearchItemsResponsePropertyValidationAttributesMap = {
16
+ total: {
17
+ minimum: 0,
18
+ exclusiveMinimum: false,
19
+ },
20
+ limit: {
21
+ minimum: 1,
22
+ exclusiveMinimum: false,
23
+ },
24
+ offset: {
25
+ minimum: 0,
26
+ exclusiveMinimum: false,
27
+ },
28
+ };
29
+ /**
30
+ * Check if a given object implements the SearchItemsResponse interface.
31
+ */
32
+ export function instanceOfSearchItemsResponse(value) {
33
+ if (!('items' in value) || value['items'] === undefined)
34
+ return false;
35
+ if (!('total' in value) || value['total'] === undefined)
36
+ return false;
37
+ if (!('limit' in value) || value['limit'] === undefined)
38
+ return false;
39
+ if (!('offset' in value) || value['offset'] === undefined)
40
+ return false;
41
+ return true;
42
+ }
43
+ export function SearchItemsResponseFromJSON(json) {
44
+ return SearchItemsResponseFromJSONTyped(json, false);
45
+ }
46
+ export function SearchItemsResponseFromJSONTyped(json, ignoreDiscriminator) {
47
+ if (json == null) {
48
+ return json;
49
+ }
50
+ return {
51
+ 'items': (json['items'].map(FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceSchemaRFromJSON)),
52
+ 'total': json['total'],
53
+ 'limit': json['limit'],
54
+ 'offset': json['offset'],
55
+ 'countsByType': json['counts_by_type'] == null ? undefined : json['counts_by_type'],
56
+ };
57
+ }
58
+ export function SearchItemsResponseToJSON(json) {
59
+ return SearchItemsResponseToJSONTyped(json, false);
60
+ }
61
+ export function SearchItemsResponseToJSONTyped(value, ignoreDiscriminator = false) {
62
+ if (value == null) {
63
+ return value;
64
+ }
65
+ return {
66
+ 'items': (value['items'].map(FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceSchemaRToJSON)),
67
+ 'total': value['total'],
68
+ 'limit': value['limit'],
69
+ 'offset': value['offset'],
70
+ 'counts_by_type': value['countsByType'],
71
+ };
72
+ }
@@ -10,10 +10,15 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  /**
13
- * Sort order options for search results.
13
+ * Ordering for flat name search.
14
+ *
15
+ * RELEVANCE ranks an exact name match first, then names starting with the
16
+ * query, then by how closely the name matches, then shorter names, then
17
+ * alphabetically.
14
18
  * @export
15
19
  */
16
20
  export declare const SearchSortOrder: {
21
+ readonly Relevance: 'RELEVANCE';
17
22
  readonly Name: 'NAME';
18
23
  readonly UpdatedAt: 'UPDATED_AT';
19
24
  readonly CreatedAt: 'CREATED_AT';
@@ -12,10 +12,15 @@
12
12
  * Do not edit the class manually.
13
13
  */
14
14
  /**
15
- * Sort order options for search results.
15
+ * Ordering for flat name search.
16
+ *
17
+ * RELEVANCE ranks an exact name match first, then names starting with the
18
+ * query, then by how closely the name matches, then shorter names, then
19
+ * alphabetically.
16
20
  * @export
17
21
  */
18
22
  export const SearchSortOrder = {
23
+ Relevance: 'RELEVANCE',
19
24
  Name: 'NAME',
20
25
  UpdatedAt: 'UPDATED_AT',
21
26
  CreatedAt: 'CREATED_AT'
@@ -22,6 +22,7 @@ export declare const SearchablePartType: {
22
22
  readonly DataSourceSchema: 'DATA_SOURCE_SCHEMA';
23
23
  readonly DataSourceTable: 'DATA_SOURCE_TABLE';
24
24
  readonly ApiConnection: 'API_CONNECTION';
25
+ readonly Skill: 'SKILL';
25
26
  };
26
27
  export type SearchablePartType = typeof SearchablePartType[keyof typeof SearchablePartType];
27
28
  export declare function instanceOfSearchablePartType(value: any): boolean;
@@ -23,7 +23,8 @@ export const SearchablePartType = {
23
23
  DataSource: 'DATA_SOURCE',
24
24
  DataSourceSchema: 'DATA_SOURCE_SCHEMA',
25
25
  DataSourceTable: 'DATA_SOURCE_TABLE',
26
- ApiConnection: 'API_CONNECTION'
26
+ ApiConnection: 'API_CONNECTION',
27
+ Skill: 'SKILL'
27
28
  };
28
29
  export function instanceOfSearchablePartType(value) {
29
30
  for (const key in SearchablePartType) {
@@ -263,6 +263,7 @@ export * from './RunTimeseriesResponse';
263
263
  export * from './SSOInitiateResponse';
264
264
  export * from './ScheduleCadence';
265
265
  export * from './ScoredChunkResponse';
266
+ export * from './SearchItemsResponse';
266
267
  export * from './SearchSkillsRequest';
267
268
  export * from './SearchSkillsResponse';
268
269
  export * from './SearchSortOrder';
@@ -265,6 +265,7 @@ export * from './RunTimeseriesResponse';
265
265
  export * from './SSOInitiateResponse';
266
266
  export * from './ScheduleCadence';
267
267
  export * from './ScoredChunkResponse';
268
+ export * from './SearchItemsResponse';
268
269
  export * from './SearchSkillsRequest';
269
270
  export * from './SearchSkillsResponse';
270
271
  export * from './SearchSortOrder';
@@ -9,6 +9,7 @@
9
9
  * https://openapi-generator.tech
10
10
  * Do not edit the class manually.
11
11
  */
12
+ import type { DocumentType } from './DocumentType';
12
13
  import type { ReferenceType } from './ReferenceType';
13
14
  /**
14
15
  * A parsed reference enriched with display name and path from the database.
@@ -44,6 +45,12 @@ export interface ResolvedReferenceInput {
44
45
  * @memberof ResolvedReferenceInput
45
46
  */
46
47
  materializedPath?: string | null;
48
+ /**
49
+ *
50
+ * @type {DocumentType}
51
+ * @memberof ResolvedReferenceInput
52
+ */
53
+ documentType?: DocumentType;
47
54
  }
48
55
  export declare const ResolvedReferenceInputPropertyValidationAttributesMap: {
49
56
  [property: string]: {
@@ -19,6 +19,7 @@ exports.ResolvedReferenceInputFromJSON = ResolvedReferenceInputFromJSON;
19
19
  exports.ResolvedReferenceInputFromJSONTyped = ResolvedReferenceInputFromJSONTyped;
20
20
  exports.ResolvedReferenceInputToJSON = ResolvedReferenceInputToJSON;
21
21
  exports.ResolvedReferenceInputToJSONTyped = ResolvedReferenceInputToJSONTyped;
22
+ const DocumentType_1 = require("./DocumentType");
22
23
  const ReferenceType_1 = require("./ReferenceType");
23
24
  exports.ResolvedReferenceInputPropertyValidationAttributesMap = {};
24
25
  /**
@@ -45,6 +46,7 @@ function ResolvedReferenceInputFromJSONTyped(json, ignoreDiscriminator) {
45
46
  'entityId': json['entity_id'],
46
47
  'displayName': json['display_name'],
47
48
  'materializedPath': json['materialized_path'] == null ? undefined : json['materialized_path'],
49
+ 'documentType': json['document_type'] == null ? undefined : (0, DocumentType_1.DocumentTypeFromJSON)(json['document_type']),
48
50
  };
49
51
  }
50
52
  function ResolvedReferenceInputToJSON(json) {
@@ -59,5 +61,6 @@ function ResolvedReferenceInputToJSONTyped(value, ignoreDiscriminator = false) {
59
61
  'entity_id': value['entityId'],
60
62
  'display_name': value['displayName'],
61
63
  'materialized_path': value['materializedPath'],
64
+ 'document_type': (0, DocumentType_1.DocumentTypeToJSON)(value['documentType']),
62
65
  };
63
66
  }
@@ -9,6 +9,7 @@
9
9
  * https://openapi-generator.tech
10
10
  * Do not edit the class manually.
11
11
  */
12
+ import type { DocumentType } from './DocumentType';
12
13
  /**
13
14
  * A parsed reference enriched with display name and path from the database.
14
15
  *
@@ -43,6 +44,12 @@ export interface ResolvedReferenceOutput {
43
44
  * @memberof ResolvedReferenceOutput
44
45
  */
45
46
  materializedPath?: string | null;
47
+ /**
48
+ *
49
+ * @type {DocumentType}
50
+ * @memberof ResolvedReferenceOutput
51
+ */
52
+ documentType?: DocumentType;
46
53
  }
47
54
  export declare const ResolvedReferenceOutputPropertyValidationAttributesMap: {
48
55
  [property: string]: {