@knowledge-stack/ksapi 1.106.3 → 1.108.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -2
- package/dist/apis/TenantsApi.d.ts +4 -4
- package/dist/apis/TenantsApi.js +2 -2
- package/dist/esm/apis/TenantsApi.d.ts +4 -4
- package/dist/esm/apis/TenantsApi.js +2 -2
- package/dist/esm/models/ChunkMetadata.d.ts +7 -1
- package/dist/esm/models/ChunkMetadata.js +2 -0
- package/dist/esm/models/DocumentType.d.ts +2 -0
- package/dist/esm/models/DocumentType.js +2 -0
- package/dist/esm/models/TenantUserEditRequest.d.ts +17 -1
- package/dist/esm/models/TenantUserEditRequest.js +12 -1
- package/dist/models/ChunkMetadata.d.ts +7 -1
- package/dist/models/ChunkMetadata.js +2 -0
- package/dist/models/DocumentType.d.ts +2 -0
- package/dist/models/DocumentType.js +2 -0
- package/dist/models/TenantUserEditRequest.d.ts +17 -1
- package/dist/models/TenantUserEditRequest.js +12 -1
- package/docs/ChunkMetadata.md +2 -0
- package/docs/DocumentsApi.md +1 -1
- package/docs/TenantUserEditRequest.md +5 -1
- package/docs/TenantsApi.md +1 -1
- package/package.json +1 -1
- package/src/apis/TenantsApi.ts +4 -4
- package/src/models/ChunkMetadata.ts +9 -1
- package/src/models/DocumentType.ts +2 -0
- package/src/models/TenantUserEditRequest.ts +27 -1
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# @knowledge-stack/ksapi@1.
|
|
1
|
+
# @knowledge-stack/ksapi@1.108.0
|
|
2
2
|
|
|
3
3
|
A TypeScript SDK client for the localhost API.
|
|
4
4
|
|
|
@@ -577,7 +577,7 @@ and is automatically generated by the
|
|
|
577
577
|
[OpenAPI Generator](https://openapi-generator.tech) project:
|
|
578
578
|
|
|
579
579
|
- API version: `0.1.0`
|
|
580
|
-
- Package version: `1.
|
|
580
|
+
- Package version: `1.108.0`
|
|
581
581
|
- Generator version: `7.21.0`
|
|
582
582
|
- Build package: `org.openapitools.codegen.languages.TypeScriptFetchClientCodegen`
|
|
583
583
|
|
|
@@ -317,7 +317,7 @@ export interface TenantsApiInterface {
|
|
|
317
317
|
*/
|
|
318
318
|
updateTenantUserRequestOpts(requestParameters: UpdateTenantUserRequest): Promise<runtime.RequestOpts>;
|
|
319
319
|
/**
|
|
320
|
-
* Update a user\'s role in a tenant. Requires OWNER or ADMIN role. Cannot create a duplicate owner.
|
|
320
|
+
* Update a user\'s role and optional profile fields in a tenant. Requires OWNER or ADMIN role. Cannot create a duplicate owner.
|
|
321
321
|
* @summary Update Tenant User
|
|
322
322
|
* @param {string} tenantId
|
|
323
323
|
* @param {string} userId
|
|
@@ -328,7 +328,7 @@ export interface TenantsApiInterface {
|
|
|
328
328
|
*/
|
|
329
329
|
updateTenantUserRaw(requestParameters: UpdateTenantUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TenantUserResponse>>;
|
|
330
330
|
/**
|
|
331
|
-
* Update a user\'s role in a tenant. Requires OWNER or ADMIN role. Cannot create a duplicate owner.
|
|
331
|
+
* Update a user\'s role and optional profile fields in a tenant. Requires OWNER or ADMIN role. Cannot create a duplicate owner.
|
|
332
332
|
* Update Tenant User
|
|
333
333
|
*/
|
|
334
334
|
updateTenantUser(requestParameters: UpdateTenantUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TenantUserResponse>;
|
|
@@ -507,12 +507,12 @@ export declare class TenantsApi extends runtime.BaseAPI implements TenantsApiInt
|
|
|
507
507
|
*/
|
|
508
508
|
updateTenantUserRequestOpts(requestParameters: UpdateTenantUserRequest): Promise<runtime.RequestOpts>;
|
|
509
509
|
/**
|
|
510
|
-
* Update a user\'s role in a tenant. Requires OWNER or ADMIN role. Cannot create a duplicate owner.
|
|
510
|
+
* Update a user\'s role and optional profile fields in a tenant. Requires OWNER or ADMIN role. Cannot create a duplicate owner.
|
|
511
511
|
* Update Tenant User
|
|
512
512
|
*/
|
|
513
513
|
updateTenantUserRaw(requestParameters: UpdateTenantUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TenantUserResponse>>;
|
|
514
514
|
/**
|
|
515
|
-
* Update a user\'s role in a tenant. Requires OWNER or ADMIN role. Cannot create a duplicate owner.
|
|
515
|
+
* Update a user\'s role and optional profile fields in a tenant. Requires OWNER or ADMIN role. Cannot create a duplicate owner.
|
|
516
516
|
* Update Tenant User
|
|
517
517
|
*/
|
|
518
518
|
updateTenantUser(requestParameters: UpdateTenantUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TenantUserResponse>;
|
package/dist/apis/TenantsApi.js
CHANGED
|
@@ -620,7 +620,7 @@ class TenantsApi extends runtime.BaseAPI {
|
|
|
620
620
|
});
|
|
621
621
|
}
|
|
622
622
|
/**
|
|
623
|
-
* Update a user\'s role in a tenant. Requires OWNER or ADMIN role. Cannot create a duplicate owner.
|
|
623
|
+
* Update a user\'s role and optional profile fields in a tenant. Requires OWNER or ADMIN role. Cannot create a duplicate owner.
|
|
624
624
|
* Update Tenant User
|
|
625
625
|
*/
|
|
626
626
|
updateTenantUserRaw(requestParameters, initOverrides) {
|
|
@@ -631,7 +631,7 @@ class TenantsApi extends runtime.BaseAPI {
|
|
|
631
631
|
});
|
|
632
632
|
}
|
|
633
633
|
/**
|
|
634
|
-
* Update a user\'s role in a tenant. Requires OWNER or ADMIN role. Cannot create a duplicate owner.
|
|
634
|
+
* Update a user\'s role and optional profile fields in a tenant. Requires OWNER or ADMIN role. Cannot create a duplicate owner.
|
|
635
635
|
* Update Tenant User
|
|
636
636
|
*/
|
|
637
637
|
updateTenantUser(requestParameters, initOverrides) {
|
|
@@ -317,7 +317,7 @@ export interface TenantsApiInterface {
|
|
|
317
317
|
*/
|
|
318
318
|
updateTenantUserRequestOpts(requestParameters: UpdateTenantUserRequest): Promise<runtime.RequestOpts>;
|
|
319
319
|
/**
|
|
320
|
-
* Update a user\'s role in a tenant. Requires OWNER or ADMIN role. Cannot create a duplicate owner.
|
|
320
|
+
* Update a user\'s role and optional profile fields in a tenant. Requires OWNER or ADMIN role. Cannot create a duplicate owner.
|
|
321
321
|
* @summary Update Tenant User
|
|
322
322
|
* @param {string} tenantId
|
|
323
323
|
* @param {string} userId
|
|
@@ -328,7 +328,7 @@ export interface TenantsApiInterface {
|
|
|
328
328
|
*/
|
|
329
329
|
updateTenantUserRaw(requestParameters: UpdateTenantUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TenantUserResponse>>;
|
|
330
330
|
/**
|
|
331
|
-
* Update a user\'s role in a tenant. Requires OWNER or ADMIN role. Cannot create a duplicate owner.
|
|
331
|
+
* Update a user\'s role and optional profile fields in a tenant. Requires OWNER or ADMIN role. Cannot create a duplicate owner.
|
|
332
332
|
* Update Tenant User
|
|
333
333
|
*/
|
|
334
334
|
updateTenantUser(requestParameters: UpdateTenantUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TenantUserResponse>;
|
|
@@ -507,12 +507,12 @@ export declare class TenantsApi extends runtime.BaseAPI implements TenantsApiInt
|
|
|
507
507
|
*/
|
|
508
508
|
updateTenantUserRequestOpts(requestParameters: UpdateTenantUserRequest): Promise<runtime.RequestOpts>;
|
|
509
509
|
/**
|
|
510
|
-
* Update a user\'s role in a tenant. Requires OWNER or ADMIN role. Cannot create a duplicate owner.
|
|
510
|
+
* Update a user\'s role and optional profile fields in a tenant. Requires OWNER or ADMIN role. Cannot create a duplicate owner.
|
|
511
511
|
* Update Tenant User
|
|
512
512
|
*/
|
|
513
513
|
updateTenantUserRaw(requestParameters: UpdateTenantUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TenantUserResponse>>;
|
|
514
514
|
/**
|
|
515
|
-
* Update a user\'s role in a tenant. Requires OWNER or ADMIN role. Cannot create a duplicate owner.
|
|
515
|
+
* Update a user\'s role and optional profile fields in a tenant. Requires OWNER or ADMIN role. Cannot create a duplicate owner.
|
|
516
516
|
* Update Tenant User
|
|
517
517
|
*/
|
|
518
518
|
updateTenantUser(requestParameters: UpdateTenantUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TenantUserResponse>;
|
|
@@ -584,7 +584,7 @@ export class TenantsApi extends runtime.BaseAPI {
|
|
|
584
584
|
});
|
|
585
585
|
}
|
|
586
586
|
/**
|
|
587
|
-
* Update a user\'s role in a tenant. Requires OWNER or ADMIN role. Cannot create a duplicate owner.
|
|
587
|
+
* Update a user\'s role and optional profile fields in a tenant. Requires OWNER or ADMIN role. Cannot create a duplicate owner.
|
|
588
588
|
* Update Tenant User
|
|
589
589
|
*/
|
|
590
590
|
updateTenantUserRaw(requestParameters, initOverrides) {
|
|
@@ -595,7 +595,7 @@ export class TenantsApi extends runtime.BaseAPI {
|
|
|
595
595
|
});
|
|
596
596
|
}
|
|
597
597
|
/**
|
|
598
|
-
* Update a user\'s role in a tenant. Requires OWNER or ADMIN role. Cannot create a duplicate owner.
|
|
598
|
+
* Update a user\'s role and optional profile fields in a tenant. Requires OWNER or ADMIN role. Cannot create a duplicate owner.
|
|
599
599
|
* Update Tenant User
|
|
600
600
|
*/
|
|
601
601
|
updateTenantUser(requestParameters, initOverrides) {
|
|
@@ -30,11 +30,17 @@ export interface ChunkMetadata {
|
|
|
30
30
|
*/
|
|
31
31
|
s3Urls?: Array<string>;
|
|
32
32
|
/**
|
|
33
|
-
* LLM-generated summary of the chunk content. Used for TABLE and HTML chunks to enrich embedding text.
|
|
33
|
+
* LLM-generated summary of the chunk content. Used for TABLE and HTML chunks to enrich embedding text, and for JSON/YAML chunks (with summarize_for_embedding) as the sole dense embedding text.
|
|
34
34
|
* @type {string}
|
|
35
35
|
* @memberof ChunkMetadata
|
|
36
36
|
*/
|
|
37
37
|
summary?: string | null;
|
|
38
|
+
/**
|
|
39
|
+
* When True, this chunk's dense embedding is built from its LLM-generated summary (see summary) instead of its raw content. Set for parsed JSON/YAML single chunks so noisy structured text does not dominate the vector; the raw content is still kept for display and sparse (keyword) retrieval. Enrichment generates the summary when this is set and summary is empty.
|
|
40
|
+
* @type {boolean}
|
|
41
|
+
* @memberof ChunkMetadata
|
|
42
|
+
*/
|
|
43
|
+
summarizeForEmbedding?: boolean;
|
|
38
44
|
/**
|
|
39
45
|
* S3 URI to extracted PDF text used for LLM grounding during enrichment
|
|
40
46
|
* @type {string}
|
|
@@ -31,6 +31,7 @@ export function ChunkMetadataFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
31
31
|
'polygons': json['polygons'] == null ? undefined : (json['polygons'].map(PolygonReferenceFromJSON)),
|
|
32
32
|
's3Urls': json['s3_urls'] == null ? undefined : json['s3_urls'],
|
|
33
33
|
'summary': json['summary'] == null ? undefined : json['summary'],
|
|
34
|
+
'summarizeForEmbedding': json['summarize_for_embedding'] == null ? undefined : json['summarize_for_embedding'],
|
|
34
35
|
'extractedTextS3Uri': json['extracted_text_s3_uri'] == null ? undefined : json['extracted_text_s3_uri'],
|
|
35
36
|
'secondaryTaxonomy': json['secondary_taxonomy'] == null ? undefined : ImageTaxonomyFromJSON(json['secondary_taxonomy']),
|
|
36
37
|
'sheetName': json['sheet_name'] == null ? undefined : json['sheet_name'],
|
|
@@ -55,6 +56,7 @@ export function ChunkMetadataToJSONTyped(value, ignoreDiscriminator = false) {
|
|
|
55
56
|
'polygons': value['polygons'] == null ? undefined : (value['polygons'].map(PolygonReferenceToJSON)),
|
|
56
57
|
's3_urls': value['s3Urls'],
|
|
57
58
|
'summary': value['summary'],
|
|
59
|
+
'summarize_for_embedding': value['summarizeForEmbedding'],
|
|
58
60
|
'extracted_text_s3_uri': value['extractedTextS3Uri'],
|
|
59
61
|
'secondary_taxonomy': ImageTaxonomyToJSON(value['secondaryTaxonomy']),
|
|
60
62
|
'sheet_name': value['sheetName'],
|
|
@@ -21,6 +21,8 @@ export declare const DocumentType: {
|
|
|
21
21
|
readonly Xlsx: "XLSX";
|
|
22
22
|
readonly Csv: "CSV";
|
|
23
23
|
readonly Pptx: "PPTX";
|
|
24
|
+
readonly Json: "JSON";
|
|
25
|
+
readonly Yaml: "YAML";
|
|
24
26
|
readonly Unknown: "UNKNOWN";
|
|
25
27
|
};
|
|
26
28
|
export type DocumentType = typeof DocumentType[keyof typeof DocumentType];
|
|
@@ -11,7 +11,11 @@
|
|
|
11
11
|
*/
|
|
12
12
|
import type { TenantUserRole } from './TenantUserRole';
|
|
13
13
|
/**
|
|
14
|
-
* Request to update a tenant user's role.
|
|
14
|
+
* Request to update a tenant user's role and optional profile fields.
|
|
15
|
+
*
|
|
16
|
+
* ``job_title`` and ``department`` follow partial-update semantics: omit
|
|
17
|
+
* (or send null) to leave the field unchanged, send an empty string to
|
|
18
|
+
* clear it to NULL.
|
|
15
19
|
* @export
|
|
16
20
|
* @interface TenantUserEditRequest
|
|
17
21
|
*/
|
|
@@ -22,6 +26,18 @@ export interface TenantUserEditRequest {
|
|
|
22
26
|
* @memberof TenantUserEditRequest
|
|
23
27
|
*/
|
|
24
28
|
role: TenantUserRole;
|
|
29
|
+
/**
|
|
30
|
+
* User's job title; omit to leave unchanged, empty string to clear
|
|
31
|
+
* @type {string}
|
|
32
|
+
* @memberof TenantUserEditRequest
|
|
33
|
+
*/
|
|
34
|
+
jobTitle?: string | null;
|
|
35
|
+
/**
|
|
36
|
+
* User's department; omit to leave unchanged, empty string to clear
|
|
37
|
+
* @type {string}
|
|
38
|
+
* @memberof TenantUserEditRequest
|
|
39
|
+
*/
|
|
40
|
+
department?: string | null;
|
|
25
41
|
}
|
|
26
42
|
export declare const TenantUserEditRequestPropertyValidationAttributesMap: {
|
|
27
43
|
[property: string]: {
|
|
@@ -12,7 +12,14 @@
|
|
|
12
12
|
* Do not edit the class manually.
|
|
13
13
|
*/
|
|
14
14
|
import { TenantUserRoleFromJSON, TenantUserRoleToJSON, } from './TenantUserRole';
|
|
15
|
-
export const TenantUserEditRequestPropertyValidationAttributesMap = {
|
|
15
|
+
export const TenantUserEditRequestPropertyValidationAttributesMap = {
|
|
16
|
+
jobTitle: {
|
|
17
|
+
maxLength: 120,
|
|
18
|
+
},
|
|
19
|
+
department: {
|
|
20
|
+
maxLength: 120,
|
|
21
|
+
},
|
|
22
|
+
};
|
|
16
23
|
/**
|
|
17
24
|
* Check if a given object implements the TenantUserEditRequest interface.
|
|
18
25
|
*/
|
|
@@ -30,6 +37,8 @@ export function TenantUserEditRequestFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
30
37
|
}
|
|
31
38
|
return {
|
|
32
39
|
'role': TenantUserRoleFromJSON(json['role']),
|
|
40
|
+
'jobTitle': json['job_title'] == null ? undefined : json['job_title'],
|
|
41
|
+
'department': json['department'] == null ? undefined : json['department'],
|
|
33
42
|
};
|
|
34
43
|
}
|
|
35
44
|
export function TenantUserEditRequestToJSON(json) {
|
|
@@ -41,5 +50,7 @@ export function TenantUserEditRequestToJSONTyped(value, ignoreDiscriminator = fa
|
|
|
41
50
|
}
|
|
42
51
|
return {
|
|
43
52
|
'role': TenantUserRoleToJSON(value['role']),
|
|
53
|
+
'job_title': value['jobTitle'],
|
|
54
|
+
'department': value['department'],
|
|
44
55
|
};
|
|
45
56
|
}
|
|
@@ -30,11 +30,17 @@ export interface ChunkMetadata {
|
|
|
30
30
|
*/
|
|
31
31
|
s3Urls?: Array<string>;
|
|
32
32
|
/**
|
|
33
|
-
* LLM-generated summary of the chunk content. Used for TABLE and HTML chunks to enrich embedding text.
|
|
33
|
+
* LLM-generated summary of the chunk content. Used for TABLE and HTML chunks to enrich embedding text, and for JSON/YAML chunks (with summarize_for_embedding) as the sole dense embedding text.
|
|
34
34
|
* @type {string}
|
|
35
35
|
* @memberof ChunkMetadata
|
|
36
36
|
*/
|
|
37
37
|
summary?: string | null;
|
|
38
|
+
/**
|
|
39
|
+
* When True, this chunk's dense embedding is built from its LLM-generated summary (see summary) instead of its raw content. Set for parsed JSON/YAML single chunks so noisy structured text does not dominate the vector; the raw content is still kept for display and sparse (keyword) retrieval. Enrichment generates the summary when this is set and summary is empty.
|
|
40
|
+
* @type {boolean}
|
|
41
|
+
* @memberof ChunkMetadata
|
|
42
|
+
*/
|
|
43
|
+
summarizeForEmbedding?: boolean;
|
|
38
44
|
/**
|
|
39
45
|
* S3 URI to extracted PDF text used for LLM grounding during enrichment
|
|
40
46
|
* @type {string}
|
|
@@ -39,6 +39,7 @@ function ChunkMetadataFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
39
39
|
'polygons': json['polygons'] == null ? undefined : (json['polygons'].map(PolygonReference_1.PolygonReferenceFromJSON)),
|
|
40
40
|
's3Urls': json['s3_urls'] == null ? undefined : json['s3_urls'],
|
|
41
41
|
'summary': json['summary'] == null ? undefined : json['summary'],
|
|
42
|
+
'summarizeForEmbedding': json['summarize_for_embedding'] == null ? undefined : json['summarize_for_embedding'],
|
|
42
43
|
'extractedTextS3Uri': json['extracted_text_s3_uri'] == null ? undefined : json['extracted_text_s3_uri'],
|
|
43
44
|
'secondaryTaxonomy': json['secondary_taxonomy'] == null ? undefined : (0, ImageTaxonomy_1.ImageTaxonomyFromJSON)(json['secondary_taxonomy']),
|
|
44
45
|
'sheetName': json['sheet_name'] == null ? undefined : json['sheet_name'],
|
|
@@ -63,6 +64,7 @@ function ChunkMetadataToJSONTyped(value, ignoreDiscriminator = false) {
|
|
|
63
64
|
'polygons': value['polygons'] == null ? undefined : (value['polygons'].map(PolygonReference_1.PolygonReferenceToJSON)),
|
|
64
65
|
's3_urls': value['s3Urls'],
|
|
65
66
|
'summary': value['summary'],
|
|
67
|
+
'summarize_for_embedding': value['summarizeForEmbedding'],
|
|
66
68
|
'extracted_text_s3_uri': value['extractedTextS3Uri'],
|
|
67
69
|
'secondary_taxonomy': (0, ImageTaxonomy_1.ImageTaxonomyToJSON)(value['secondaryTaxonomy']),
|
|
68
70
|
'sheet_name': value['sheetName'],
|
|
@@ -21,6 +21,8 @@ export declare const DocumentType: {
|
|
|
21
21
|
readonly Xlsx: "XLSX";
|
|
22
22
|
readonly Csv: "CSV";
|
|
23
23
|
readonly Pptx: "PPTX";
|
|
24
|
+
readonly Json: "JSON";
|
|
25
|
+
readonly Yaml: "YAML";
|
|
24
26
|
readonly Unknown: "UNKNOWN";
|
|
25
27
|
};
|
|
26
28
|
export type DocumentType = typeof DocumentType[keyof typeof DocumentType];
|
|
@@ -11,7 +11,11 @@
|
|
|
11
11
|
*/
|
|
12
12
|
import type { TenantUserRole } from './TenantUserRole';
|
|
13
13
|
/**
|
|
14
|
-
* Request to update a tenant user's role.
|
|
14
|
+
* Request to update a tenant user's role and optional profile fields.
|
|
15
|
+
*
|
|
16
|
+
* ``job_title`` and ``department`` follow partial-update semantics: omit
|
|
17
|
+
* (or send null) to leave the field unchanged, send an empty string to
|
|
18
|
+
* clear it to NULL.
|
|
15
19
|
* @export
|
|
16
20
|
* @interface TenantUserEditRequest
|
|
17
21
|
*/
|
|
@@ -22,6 +26,18 @@ export interface TenantUserEditRequest {
|
|
|
22
26
|
* @memberof TenantUserEditRequest
|
|
23
27
|
*/
|
|
24
28
|
role: TenantUserRole;
|
|
29
|
+
/**
|
|
30
|
+
* User's job title; omit to leave unchanged, empty string to clear
|
|
31
|
+
* @type {string}
|
|
32
|
+
* @memberof TenantUserEditRequest
|
|
33
|
+
*/
|
|
34
|
+
jobTitle?: string | null;
|
|
35
|
+
/**
|
|
36
|
+
* User's department; omit to leave unchanged, empty string to clear
|
|
37
|
+
* @type {string}
|
|
38
|
+
* @memberof TenantUserEditRequest
|
|
39
|
+
*/
|
|
40
|
+
department?: string | null;
|
|
25
41
|
}
|
|
26
42
|
export declare const TenantUserEditRequestPropertyValidationAttributesMap: {
|
|
27
43
|
[property: string]: {
|
|
@@ -20,7 +20,14 @@ exports.TenantUserEditRequestFromJSONTyped = TenantUserEditRequestFromJSONTyped;
|
|
|
20
20
|
exports.TenantUserEditRequestToJSON = TenantUserEditRequestToJSON;
|
|
21
21
|
exports.TenantUserEditRequestToJSONTyped = TenantUserEditRequestToJSONTyped;
|
|
22
22
|
const TenantUserRole_1 = require("./TenantUserRole");
|
|
23
|
-
exports.TenantUserEditRequestPropertyValidationAttributesMap = {
|
|
23
|
+
exports.TenantUserEditRequestPropertyValidationAttributesMap = {
|
|
24
|
+
jobTitle: {
|
|
25
|
+
maxLength: 120,
|
|
26
|
+
},
|
|
27
|
+
department: {
|
|
28
|
+
maxLength: 120,
|
|
29
|
+
},
|
|
30
|
+
};
|
|
24
31
|
/**
|
|
25
32
|
* Check if a given object implements the TenantUserEditRequest interface.
|
|
26
33
|
*/
|
|
@@ -38,6 +45,8 @@ function TenantUserEditRequestFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
38
45
|
}
|
|
39
46
|
return {
|
|
40
47
|
'role': (0, TenantUserRole_1.TenantUserRoleFromJSON)(json['role']),
|
|
48
|
+
'jobTitle': json['job_title'] == null ? undefined : json['job_title'],
|
|
49
|
+
'department': json['department'] == null ? undefined : json['department'],
|
|
41
50
|
};
|
|
42
51
|
}
|
|
43
52
|
function TenantUserEditRequestToJSON(json) {
|
|
@@ -49,5 +58,7 @@ function TenantUserEditRequestToJSONTyped(value, ignoreDiscriminator = false) {
|
|
|
49
58
|
}
|
|
50
59
|
return {
|
|
51
60
|
'role': (0, TenantUserRole_1.TenantUserRoleToJSON)(value['role']),
|
|
61
|
+
'job_title': value['jobTitle'],
|
|
62
|
+
'department': value['department'],
|
|
52
63
|
};
|
|
53
64
|
}
|
package/docs/ChunkMetadata.md
CHANGED
|
@@ -10,6 +10,7 @@ Name | Type
|
|
|
10
10
|
`polygons` | [Array<PolygonReference>](PolygonReference.md)
|
|
11
11
|
`s3Urls` | Array<string>
|
|
12
12
|
`summary` | string
|
|
13
|
+
`summarizeForEmbedding` | boolean
|
|
13
14
|
`extractedTextS3Uri` | string
|
|
14
15
|
`secondaryTaxonomy` | [ImageTaxonomy](ImageTaxonomy.md)
|
|
15
16
|
`sheetName` | string
|
|
@@ -32,6 +33,7 @@ const example = {
|
|
|
32
33
|
"polygons": null,
|
|
33
34
|
"s3Urls": null,
|
|
34
35
|
"summary": null,
|
|
36
|
+
"summarizeForEmbedding": null,
|
|
35
37
|
"extractedTextS3Uri": null,
|
|
36
38
|
"secondaryTaxonomy": null,
|
|
37
39
|
"sheetName": null,
|
package/docs/DocumentsApi.md
CHANGED
|
@@ -589,7 +589,7 @@ example().catch(console.error);
|
|
|
589
589
|
| **sortOrder** | `PathOrder` | Sort order for results (default: LOGICAL) | [Optional] [Defaults to `undefined`] [Enum: LOGICAL, NAME, UPDATED_AT, CREATED_AT] |
|
|
590
590
|
| **sortDir** | `SortDirection` | Sort direction; overrides the column\'s natural default | [Optional] [Defaults to `undefined`] [Enum: ASC, DESC] |
|
|
591
591
|
| **ownerId** | `string` | Filter to documents owned by this user | [Optional] [Defaults to `undefined`] |
|
|
592
|
-
| **documentType** | `DocumentType` | Filter to documents of this type | [Optional] [Defaults to `undefined`] [Enum: PDF, DOCX, PLAINTEXT, IMAGE, XLSX, CSV, PPTX, UNKNOWN] |
|
|
592
|
+
| **documentType** | `DocumentType` | Filter to documents of this type | [Optional] [Defaults to `undefined`] [Enum: PDF, DOCX, PLAINTEXT, IMAGE, XLSX, CSV, PPTX, JSON, YAML, UNKNOWN] |
|
|
593
593
|
| **withTags** | `boolean` | Include tags in the response (default: false) | [Optional] [Defaults to `false`] |
|
|
594
594
|
| **limit** | `number` | Number of items per page | [Optional] [Defaults to `20`] |
|
|
595
595
|
| **offset** | `number` | Number of items to skip | [Optional] [Defaults to `0`] |
|
|
@@ -1,13 +1,15 @@
|
|
|
1
1
|
|
|
2
2
|
# TenantUserEditRequest
|
|
3
3
|
|
|
4
|
-
Request to update a tenant user\'s role.
|
|
4
|
+
Request to update a tenant user\'s role and optional profile fields. ``job_title`` and ``department`` follow partial-update semantics: omit (or send null) to leave the field unchanged, send an empty string to clear it to NULL.
|
|
5
5
|
|
|
6
6
|
## Properties
|
|
7
7
|
|
|
8
8
|
Name | Type
|
|
9
9
|
------------ | -------------
|
|
10
10
|
`role` | [TenantUserRole](TenantUserRole.md)
|
|
11
|
+
`jobTitle` | string
|
|
12
|
+
`department` | string
|
|
11
13
|
|
|
12
14
|
## Example
|
|
13
15
|
|
|
@@ -17,6 +19,8 @@ import type { TenantUserEditRequest } from '@knowledge-stack/ksapi'
|
|
|
17
19
|
// TODO: Update the object below with actual values
|
|
18
20
|
const example = {
|
|
19
21
|
"role": null,
|
|
22
|
+
"jobTitle": null,
|
|
23
|
+
"department": null,
|
|
20
24
|
} satisfies TenantUserEditRequest
|
|
21
25
|
|
|
22
26
|
console.log(example)
|
package/docs/TenantsApi.md
CHANGED
|
@@ -814,7 +814,7 @@ example().catch(console.error);
|
|
|
814
814
|
|
|
815
815
|
Update Tenant User
|
|
816
816
|
|
|
817
|
-
Update a user\'s role in a tenant. Requires OWNER or ADMIN role. Cannot create a duplicate owner.
|
|
817
|
+
Update a user\'s role and optional profile fields in a tenant. Requires OWNER or ADMIN role. Cannot create a duplicate owner.
|
|
818
818
|
|
|
819
819
|
### Example
|
|
820
820
|
|
package/package.json
CHANGED
package/src/apis/TenantsApi.ts
CHANGED
|
@@ -407,7 +407,7 @@ export interface TenantsApiInterface {
|
|
|
407
407
|
updateTenantUserRequestOpts(requestParameters: UpdateTenantUserRequest): Promise<runtime.RequestOpts>;
|
|
408
408
|
|
|
409
409
|
/**
|
|
410
|
-
* Update a user\'s role in a tenant. Requires OWNER or ADMIN role. Cannot create a duplicate owner.
|
|
410
|
+
* Update a user\'s role and optional profile fields in a tenant. Requires OWNER or ADMIN role. Cannot create a duplicate owner.
|
|
411
411
|
* @summary Update Tenant User
|
|
412
412
|
* @param {string} tenantId
|
|
413
413
|
* @param {string} userId
|
|
@@ -419,7 +419,7 @@ export interface TenantsApiInterface {
|
|
|
419
419
|
updateTenantUserRaw(requestParameters: UpdateTenantUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TenantUserResponse>>;
|
|
420
420
|
|
|
421
421
|
/**
|
|
422
|
-
* Update a user\'s role in a tenant. Requires OWNER or ADMIN role. Cannot create a duplicate owner.
|
|
422
|
+
* Update a user\'s role and optional profile fields in a tenant. Requires OWNER or ADMIN role. Cannot create a duplicate owner.
|
|
423
423
|
* Update Tenant User
|
|
424
424
|
*/
|
|
425
425
|
updateTenantUser(requestParameters: UpdateTenantUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TenantUserResponse>;
|
|
@@ -1127,7 +1127,7 @@ export class TenantsApi extends runtime.BaseAPI implements TenantsApiInterface {
|
|
|
1127
1127
|
}
|
|
1128
1128
|
|
|
1129
1129
|
/**
|
|
1130
|
-
* Update a user\'s role in a tenant. Requires OWNER or ADMIN role. Cannot create a duplicate owner.
|
|
1130
|
+
* Update a user\'s role and optional profile fields in a tenant. Requires OWNER or ADMIN role. Cannot create a duplicate owner.
|
|
1131
1131
|
* Update Tenant User
|
|
1132
1132
|
*/
|
|
1133
1133
|
async updateTenantUserRaw(requestParameters: UpdateTenantUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TenantUserResponse>> {
|
|
@@ -1138,7 +1138,7 @@ export class TenantsApi extends runtime.BaseAPI implements TenantsApiInterface {
|
|
|
1138
1138
|
}
|
|
1139
1139
|
|
|
1140
1140
|
/**
|
|
1141
|
-
* Update a user\'s role in a tenant. Requires OWNER or ADMIN role. Cannot create a duplicate owner.
|
|
1141
|
+
* Update a user\'s role and optional profile fields in a tenant. Requires OWNER or ADMIN role. Cannot create a duplicate owner.
|
|
1142
1142
|
* Update Tenant User
|
|
1143
1143
|
*/
|
|
1144
1144
|
async updateTenantUser(requestParameters: UpdateTenantUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TenantUserResponse> {
|
|
@@ -47,11 +47,17 @@ export interface ChunkMetadata {
|
|
|
47
47
|
*/
|
|
48
48
|
s3Urls?: Array<string>;
|
|
49
49
|
/**
|
|
50
|
-
* LLM-generated summary of the chunk content. Used for TABLE and HTML chunks to enrich embedding text.
|
|
50
|
+
* LLM-generated summary of the chunk content. Used for TABLE and HTML chunks to enrich embedding text, and for JSON/YAML chunks (with summarize_for_embedding) as the sole dense embedding text.
|
|
51
51
|
* @type {string}
|
|
52
52
|
* @memberof ChunkMetadata
|
|
53
53
|
*/
|
|
54
54
|
summary?: string | null;
|
|
55
|
+
/**
|
|
56
|
+
* When True, this chunk's dense embedding is built from its LLM-generated summary (see summary) instead of its raw content. Set for parsed JSON/YAML single chunks so noisy structured text does not dominate the vector; the raw content is still kept for display and sparse (keyword) retrieval. Enrichment generates the summary when this is set and summary is empty.
|
|
57
|
+
* @type {boolean}
|
|
58
|
+
* @memberof ChunkMetadata
|
|
59
|
+
*/
|
|
60
|
+
summarizeForEmbedding?: boolean;
|
|
55
61
|
/**
|
|
56
62
|
* S3 URI to extracted PDF text used for LLM grounding during enrichment
|
|
57
63
|
* @type {string}
|
|
@@ -159,6 +165,7 @@ export function ChunkMetadataFromJSONTyped(json: any, ignoreDiscriminator: boole
|
|
|
159
165
|
'polygons': json['polygons'] == null ? undefined : ((json['polygons'] as Array<any>).map(PolygonReferenceFromJSON)),
|
|
160
166
|
's3Urls': json['s3_urls'] == null ? undefined : json['s3_urls'],
|
|
161
167
|
'summary': json['summary'] == null ? undefined : json['summary'],
|
|
168
|
+
'summarizeForEmbedding': json['summarize_for_embedding'] == null ? undefined : json['summarize_for_embedding'],
|
|
162
169
|
'extractedTextS3Uri': json['extracted_text_s3_uri'] == null ? undefined : json['extracted_text_s3_uri'],
|
|
163
170
|
'secondaryTaxonomy': json['secondary_taxonomy'] == null ? undefined : ImageTaxonomyFromJSON(json['secondary_taxonomy']),
|
|
164
171
|
'sheetName': json['sheet_name'] == null ? undefined : json['sheet_name'],
|
|
@@ -187,6 +194,7 @@ export function ChunkMetadataToJSONTyped(value?: ChunkMetadata | null, ignoreDis
|
|
|
187
194
|
'polygons': value['polygons'] == null ? undefined : ((value['polygons'] as Array<any>).map(PolygonReferenceToJSON)),
|
|
188
195
|
's3_urls': value['s3Urls'],
|
|
189
196
|
'summary': value['summary'],
|
|
197
|
+
'summarize_for_embedding': value['summarizeForEmbedding'],
|
|
190
198
|
'extracted_text_s3_uri': value['extractedTextS3Uri'],
|
|
191
199
|
'secondary_taxonomy': ImageTaxonomyToJSON(value['secondaryTaxonomy']),
|
|
192
200
|
'sheet_name': value['sheetName'],
|
|
@@ -22,7 +22,11 @@ import {
|
|
|
22
22
|
} from './TenantUserRole';
|
|
23
23
|
|
|
24
24
|
/**
|
|
25
|
-
* Request to update a tenant user's role.
|
|
25
|
+
* Request to update a tenant user's role and optional profile fields.
|
|
26
|
+
*
|
|
27
|
+
* ``job_title`` and ``department`` follow partial-update semantics: omit
|
|
28
|
+
* (or send null) to leave the field unchanged, send an empty string to
|
|
29
|
+
* clear it to NULL.
|
|
26
30
|
* @export
|
|
27
31
|
* @interface TenantUserEditRequest
|
|
28
32
|
*/
|
|
@@ -33,6 +37,18 @@ export interface TenantUserEditRequest {
|
|
|
33
37
|
* @memberof TenantUserEditRequest
|
|
34
38
|
*/
|
|
35
39
|
role: TenantUserRole;
|
|
40
|
+
/**
|
|
41
|
+
* User's job title; omit to leave unchanged, empty string to clear
|
|
42
|
+
* @type {string}
|
|
43
|
+
* @memberof TenantUserEditRequest
|
|
44
|
+
*/
|
|
45
|
+
jobTitle?: string | null;
|
|
46
|
+
/**
|
|
47
|
+
* User's department; omit to leave unchanged, empty string to clear
|
|
48
|
+
* @type {string}
|
|
49
|
+
* @memberof TenantUserEditRequest
|
|
50
|
+
*/
|
|
51
|
+
department?: string | null;
|
|
36
52
|
}
|
|
37
53
|
|
|
38
54
|
|
|
@@ -51,6 +67,12 @@ export const TenantUserEditRequestPropertyValidationAttributesMap: {
|
|
|
51
67
|
uniqueItems?: boolean
|
|
52
68
|
}
|
|
53
69
|
} = {
|
|
70
|
+
jobTitle: {
|
|
71
|
+
maxLength: 120,
|
|
72
|
+
},
|
|
73
|
+
department: {
|
|
74
|
+
maxLength: 120,
|
|
75
|
+
},
|
|
54
76
|
}
|
|
55
77
|
|
|
56
78
|
|
|
@@ -73,6 +95,8 @@ export function TenantUserEditRequestFromJSONTyped(json: any, ignoreDiscriminato
|
|
|
73
95
|
return {
|
|
74
96
|
|
|
75
97
|
'role': TenantUserRoleFromJSON(json['role']),
|
|
98
|
+
'jobTitle': json['job_title'] == null ? undefined : json['job_title'],
|
|
99
|
+
'department': json['department'] == null ? undefined : json['department'],
|
|
76
100
|
};
|
|
77
101
|
}
|
|
78
102
|
|
|
@@ -88,6 +112,8 @@ export function TenantUserEditRequestToJSONTyped(value?: TenantUserEditRequest |
|
|
|
88
112
|
return {
|
|
89
113
|
|
|
90
114
|
'role': TenantUserRoleToJSON(value['role']),
|
|
115
|
+
'job_title': value['jobTitle'],
|
|
116
|
+
'department': value['department'],
|
|
91
117
|
};
|
|
92
118
|
}
|
|
93
119
|
|