@knowledge-stack/ksapi 1.72.4 → 1.77.1

package/src/models/ChunkResponse.ts

@@ -13,6 +13,13 @@
  */
 
 import { mapValues } from '../runtime';
+import type { ChunkMetadata } from './ChunkMetadata';
+import {
+    ChunkMetadataFromJSON,
+    ChunkMetadataFromJSONTyped,
+    ChunkMetadataToJSON,
+    ChunkMetadataToJSONTyped,
+} from './ChunkMetadata';
 import type { ChunkDocumentResponse } from './ChunkDocumentResponse';
 import {
     ChunkDocumentResponseFromJSON,
@@ -20,13 +27,6 @@ import {
     ChunkDocumentResponseToJSON,
     ChunkDocumentResponseToJSONTyped,
 } from './ChunkDocumentResponse';
-import type { ChunkMetadataOutput } from './ChunkMetadataOutput';
-import {
-    ChunkMetadataOutputFromJSON,
-    ChunkMetadataOutputFromJSONTyped,
-    ChunkMetadataOutputToJSON,
-    ChunkMetadataOutputToJSONTyped,
-} from './ChunkMetadataOutput';
 import type { ChunkType } from './ChunkType';
 import {
     ChunkTypeFromJSON,
@@ -80,10 +80,10 @@ export interface ChunkResponse {
     chunkType: ChunkType;
     /**
      * 
-     * @type {ChunkMetadataOutput}
+     * @type {ChunkMetadata}
      * @memberof ChunkResponse
      */
-    chunkMetadata: ChunkMetadataOutput;
+    chunkMetadata: ChunkMetadata;
     /**
      * Number of tokens in chunk content
      * @type {number}
@@ -211,7 +211,7 @@ export function ChunkResponseFromJSONTyped(json: any, ignoreDiscriminator: boole
         'contentId': json['content_id'],
         'content': json['content'],
         'chunkType': ChunkTypeFromJSON(json['chunk_type']),
-        'chunkMetadata': ChunkMetadataOutputFromJSON(json['chunk_metadata']),
+        'chunkMetadata': ChunkMetadataFromJSON(json['chunk_metadata']),
         'numTokens': json['num_tokens'] == null ? undefined : json['num_tokens'],
         'parentPathId': json['parent_path_id'],
         'prevSiblingPathId': json['prev_sibling_path_id'] == null ? undefined : json['prev_sibling_path_id'],
@@ -243,7 +243,7 @@ export function ChunkResponseToJSONTyped(value?: ChunkResponse | null, ignoreDis
         'content_id': value['contentId'],
         'content': value['content'],
         'chunk_type': ChunkTypeToJSON(value['chunkType']),
-        'chunk_metadata': ChunkMetadataOutputToJSON(value['chunkMetadata']),
+        'chunk_metadata': ChunkMetadataToJSON(value['chunkMetadata']),
         'num_tokens': value['numTokens'],
         'parent_path_id': value['parentPathId'],
         'prev_sibling_path_id': value['prevSiblingPathId'],

package/src/models/CreateChunkRequest.ts

@@ -13,13 +13,13 @@
  */
 
 import { mapValues } from '../runtime';
-import type { ChunkMetadataInput } from './ChunkMetadataInput';
+import type { ChunkMetadata } from './ChunkMetadata';
 import {
-    ChunkMetadataInputFromJSON,
-    ChunkMetadataInputFromJSONTyped,
-    ChunkMetadataInputToJSON,
-    ChunkMetadataInputToJSONTyped,
-} from './ChunkMetadataInput';
+    ChunkMetadataFromJSON,
+    ChunkMetadataFromJSONTyped,
+    ChunkMetadataToJSON,
+    ChunkMetadataToJSONTyped,
+} from './ChunkMetadata';
 import type { ChunkType } from './ChunkType';
 import {
     ChunkTypeFromJSON,
@@ -54,10 +54,10 @@ export interface CreateChunkRequest {
     chunkType: ChunkType;
     /**
      * 
-     * @type {ChunkMetadataInput}
+     * @type {ChunkMetadata}
      * @memberof CreateChunkRequest
      */
-    chunkMetadata: ChunkMetadataInput;
+    chunkMetadata: ChunkMetadata;
     /**
      * PathPart ID to insert after (null = append to tail)
      * @type {string}
@@ -112,7 +112,7 @@ export function CreateChunkRequestFromJSONTyped(json: any, ignoreDiscriminator:
         'parentPathId': json['parent_path_id'],
         'content': json['content'],
         'chunkType': ChunkTypeFromJSON(json['chunk_type']),
-        'chunkMetadata': ChunkMetadataInputFromJSON(json['chunk_metadata']),
+        'chunkMetadata': ChunkMetadataFromJSON(json['chunk_metadata']),
         'prevSiblingPathId': json['prev_sibling_path_id'] == null ? undefined : json['prev_sibling_path_id'],
     };
 }
@@ -131,7 +131,7 @@ export function CreateChunkRequestToJSONTyped(value?: CreateChunkRequest | null,
         'parent_path_id': value['parentPathId'],
         'content': value['content'],
         'chunk_type': ChunkTypeToJSON(value['chunkType']),
-        'chunk_metadata': ChunkMetadataInputToJSON(value['chunkMetadata']),
+        'chunk_metadata': ChunkMetadataToJSON(value['chunkMetadata']),
         'prev_sibling_path_id': value['prevSiblingPathId'],
     };
 }

package/src/models/DocumentResponse.ts

@@ -114,6 +114,12 @@ export interface DocumentResponse {
      * @memberof DocumentResponse
      */
     systemManaged: boolean;
+    /**
+     * Direct exclusion flag on this document's path part only. The effective exclusion also applies when any ancestor folder has the flag set — fetch the ancestry to determine effective state.
+     * @type {boolean}
+     * @memberof DocumentResponse
+     */
+    excludeFromQdrant: boolean;
     /**
      * Tenant ID
      * @type {string}
@@ -182,6 +188,7 @@ export function instanceOfDocumentResponse(value: object): value is DocumentResp
     if (!('activeVersion' in value) || value['activeVersion'] === undefined) return false;
     if (!('materializedPath' in value) || value['materializedPath'] === undefined) return false;
     if (!('systemManaged' in value) || value['systemManaged'] === undefined) return false;
+    if (!('excludeFromQdrant' in value) || value['excludeFromQdrant'] === undefined) return false;
     if (!('tenantId' in value) || value['tenantId'] === undefined) return false;
     if (!('createdAt' in value) || value['createdAt'] === undefined) return false;
     if (!('updatedAt' in value) || value['updatedAt'] === undefined) return false;
@@ -209,6 +216,7 @@ export function DocumentResponseFromJSONTyped(json: any, ignoreDiscriminator: bo
         'activeVersion': DocumentVersionResponseFromJSON(json['active_version']),
         'materializedPath': json['materialized_path'],
         'systemManaged': json['system_managed'],
+        'excludeFromQdrant': json['exclude_from_qdrant'],
         'tenantId': json['tenant_id'],
         'createdAt': (new Date(json['created_at'])),
         'updatedAt': (new Date(json['updated_at'])),
@@ -238,6 +246,7 @@ export function DocumentResponseToJSONTyped(value?: DocumentResponse | null, ign
         'active_version': DocumentVersionResponseToJSON(value['activeVersion']),
         'materialized_path': value['materializedPath'],
         'system_managed': value['systemManaged'],
+        'exclude_from_qdrant': value['excludeFromQdrant'],
         'tenant_id': value['tenantId'],
         'created_at': value['createdAt'].toISOString(),
         'updated_at': value['updatedAt'].toISOString(),

package/src/models/DocumentVersionMetadata.ts

@@ -121,6 +121,30 @@ export interface DocumentVersionMetadata {
      * @memberof DocumentVersionMetadata
      */
     informationStatistics?: InformationStatistics;
+    /**
+     * True once the conversion activity successfully consumed PAGE quota
+     * @type {boolean}
+     * @memberof DocumentVersionMetadata
+     */
+    quotaCharged?: boolean;
+    /**
+     * Page quantity charged at conversion start; 0 if not yet charged
+     * @type {number}
+     * @memberof DocumentVersionMetadata
+     */
+    quotaPageCount?: number;
+    /**
+     * Stable consume key (matches workflow_id); 'UNSET' for pre-Phase-2 docs so refund logic short-circuits
+     * @type {string}
+     * @memberof DocumentVersionMetadata
+     */
+    quotaIdempotencyKey?: string;
+    /**
+     * MD5 of source bytes; 'UNSET' for pre-Phase-2 docs, real hex digest after first prep run
+     * @type {string}
+     * @memberof DocumentVersionMetadata
+     */
+    fileMd5?: string;
 }
 export const DocumentVersionMetadataPropertyValidationAttributesMap: {
     [property: string]: {
@@ -170,6 +194,10 @@ export function DocumentVersionMetadataFromJSONTyped(json: any, ignoreDiscrimina
         'xlsxNamedRanges': json['xlsx_named_ranges'] == null ? undefined : json['xlsx_named_ranges'],
         'xlsxKpiCatalog': json['xlsx_kpi_catalog'] == null ? undefined : json['xlsx_kpi_catalog'],
         'informationStatistics': json['information_statistics'] == null ? undefined : InformationStatisticsFromJSON(json['information_statistics']),
+        'quotaCharged': json['quota_charged'] == null ? undefined : json['quota_charged'],
+        'quotaPageCount': json['quota_page_count'] == null ? undefined : json['quota_page_count'],
+        'quotaIdempotencyKey': json['quota_idempotency_key'] == null ? undefined : json['quota_idempotency_key'],
+        'fileMd5': json['file_md5'] == null ? undefined : json['file_md5'],
     };
 }
 
@@ -197,6 +225,10 @@ export function DocumentVersionMetadataToJSONTyped(value?: DocumentVersionMetada
         'xlsx_named_ranges': value['xlsxNamedRanges'],
         'xlsx_kpi_catalog': value['xlsxKpiCatalog'],
         'information_statistics': InformationStatisticsToJSON(value['informationStatistics']),
+        'quota_charged': value['quotaCharged'],
+        'quota_page_count': value['quotaPageCount'],
+        'quota_idempotency_key': value['quotaIdempotencyKey'],
+        'file_md5': value['fileMd5'],
     };
 }
 

package/src/models/DocumentVersionMetadataUpdate.ts

@@ -133,6 +133,30 @@ export interface DocumentVersionMetadataUpdate {
      * @memberof DocumentVersionMetadataUpdate
      */
     informationStatistics?: InformationStatistics;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof DocumentVersionMetadataUpdate
+     */
+    quotaCharged?: boolean | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof DocumentVersionMetadataUpdate
+     */
+    quotaPageCount?: number | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof DocumentVersionMetadataUpdate
+     */
+    quotaIdempotencyKey?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof DocumentVersionMetadataUpdate
+     */
+    fileMd5?: string | null;
 }
 export const DocumentVersionMetadataUpdatePropertyValidationAttributesMap: {
     [property: string]: {
@@ -185,6 +209,10 @@ export function DocumentVersionMetadataUpdateFromJSONTyped(json: any, ignoreDisc
         'xlsxNamedRanges': json['xlsx_named_ranges'] == null ? undefined : json['xlsx_named_ranges'],
         'xlsxKpiCatalog': json['xlsx_kpi_catalog'] == null ? undefined : json['xlsx_kpi_catalog'],
         'informationStatistics': json['information_statistics'] == null ? undefined : InformationStatisticsFromJSON(json['information_statistics']),
+        'quotaCharged': json['quota_charged'] == null ? undefined : json['quota_charged'],
+        'quotaPageCount': json['quota_page_count'] == null ? undefined : json['quota_page_count'],
+        'quotaIdempotencyKey': json['quota_idempotency_key'] == null ? undefined : json['quota_idempotency_key'],
+        'fileMd5': json['file_md5'] == null ? undefined : json['file_md5'],
     };
 }
 
@@ -215,6 +243,10 @@ export function DocumentVersionMetadataUpdateToJSONTyped(value?: DocumentVersion
         'xlsx_named_ranges': value['xlsxNamedRanges'],
         'xlsx_kpi_catalog': value['xlsxKpiCatalog'],
         'information_statistics': InformationStatisticsToJSON(value['informationStatistics']),
+        'quota_charged': value['quotaCharged'],
+        'quota_page_count': value['quotaPageCount'],
+        'quota_idempotency_key': value['quotaIdempotencyKey'],
+        'file_md5': value['fileMd5'],
     };
 }
 

package/src/models/ExtractRequest.ts

@@ -0,0 +1,99 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Knowledge Stack API
+ * Knowledge Stack backend API for authentication and knowledge management
+ *
+ * The version of the OpenAPI document: 0.1.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * Request body for POST /v1/agent/extract.
+ * @export
+ * @interface ExtractRequest
+ */
+export interface ExtractRequest {
+    /**
+     * User prompt passed directly to the agent
+     * @type {string}
+     * @memberof ExtractRequest
+     */
+    prompt: string;
+    /**
+     * PathPart ID of a KS document whose content is a JSON schema.
+     * @type {string}
+     * @memberof ExtractRequest
+     */
+    schemaPathPartId?: string | null;
+    /**
+     * JSON schema provided inline as a dict. Mutually exclusive with schema_path_part_id; exactly one is required.
+     * @type {{ [key: string]: any; }}
+     * @memberof ExtractRequest
+     */
+    outputSchema?: { [key: string]: any; } | null;
+}
+export const ExtractRequestPropertyValidationAttributesMap: {
+    [property: string]: {
+        maxLength?: number,
+        minLength?: number,
+        pattern?: string,
+        maximum?: number,
+        exclusiveMaximum?: boolean,
+        minimum?: number,
+        exclusiveMinimum?: boolean,
+        multipleOf?: number,
+        maxItems?: number,
+        minItems?: number,
+        uniqueItems?: boolean
+    }
+} = {
+}
+
+
+/**
+ * Check if a given object implements the ExtractRequest interface.
+ */
+export function instanceOfExtractRequest(value: object): value is ExtractRequest {
+    if (!('prompt' in value) || value['prompt'] === undefined) return false;
+    return true;
+}
+
+export function ExtractRequestFromJSON(json: any): ExtractRequest {
+    return ExtractRequestFromJSONTyped(json, false);
+}
+
+export function ExtractRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): ExtractRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'prompt': json['prompt'],
+        'schemaPathPartId': json['schema_path_part_id'] == null ? undefined : json['schema_path_part_id'],
+        'outputSchema': json['output_schema'] == null ? undefined : json['output_schema'],
+    };
+}
+
+export function ExtractRequestToJSON(json: any): ExtractRequest {
+    return ExtractRequestToJSONTyped(json, false);
+}
+
+export function ExtractRequestToJSONTyped(value?: ExtractRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'prompt': value['prompt'],
+        'schema_path_part_id': value['schemaPathPartId'],
+        'output_schema': value['outputSchema'],
+    };
+}
+

package/src/models/ExtractResponse.ts

@@ -0,0 +1,83 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Knowledge Stack API
+ * Knowledge Stack backend API for authentication and knowledge management
+ *
+ * The version of the OpenAPI document: 0.1.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * Response body for POST /v1/agent/extract.
+ * @export
+ * @interface ExtractResponse
+ */
+export interface ExtractResponse {
+    /**
+     * 
+     * @type {{ [key: string]: any; }}
+     * @memberof ExtractResponse
+     */
+    structured: { [key: string]: any; };
+}
+export const ExtractResponsePropertyValidationAttributesMap: {
+    [property: string]: {
+        maxLength?: number,
+        minLength?: number,
+        pattern?: string,
+        maximum?: number,
+        exclusiveMaximum?: boolean,
+        minimum?: number,
+        exclusiveMinimum?: boolean,
+        multipleOf?: number,
+        maxItems?: number,
+        minItems?: number,
+        uniqueItems?: boolean
+    }
+} = {
+}
+
+
+/**
+ * Check if a given object implements the ExtractResponse interface.
+ */
+export function instanceOfExtractResponse(value: object): value is ExtractResponse {
+    if (!('structured' in value) || value['structured'] === undefined) return false;
+    return true;
+}
+
+export function ExtractResponseFromJSON(json: any): ExtractResponse {
+    return ExtractResponseFromJSONTyped(json, false);
+}
+
+export function ExtractResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ExtractResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'structured': json['structured'],
+    };
+}
+
+export function ExtractResponseToJSON(json: any): ExtractResponse {
+    return ExtractResponseToJSONTyped(json, false);
+}
+
+export function ExtractResponseToJSONTyped(value?: ExtractResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'structured': value['structured'],
+    };
+}
+

package/src/models/FolderResponse.ts

@@ -69,6 +69,12 @@ export interface FolderResponse {
      * @memberof FolderResponse
      */
     systemManaged: boolean;
+    /**
+     * Direct exclusion flag on this folder's path part only. The effective exclusion also applies when any ancestor folder has the flag set — fetch the ancestry to determine effective state.
+     * @type {boolean}
+     * @memberof FolderResponse
+     */
+    excludeFromQdrant: boolean;
     /**
      * Tenant ID
      * @type {string}
@@ -133,6 +139,7 @@ export function instanceOfFolderResponse(value: object): value is FolderResponse
     if (!('parentPathPartId' in value) || value['parentPathPartId'] === undefined) return false;
     if (!('materializedPath' in value) || value['materializedPath'] === undefined) return false;
     if (!('systemManaged' in value) || value['systemManaged'] === undefined) return false;
+    if (!('excludeFromQdrant' in value) || value['excludeFromQdrant'] === undefined) return false;
     if (!('tenantId' in value) || value['tenantId'] === undefined) return false;
     if (!('createdAt' in value) || value['createdAt'] === undefined) return false;
     if (!('updatedAt' in value) || value['updatedAt'] === undefined) return false;
@@ -156,6 +163,7 @@ export function FolderResponseFromJSONTyped(json: any, ignoreDiscriminator: bool
         'parentPathPartId': json['parent_path_part_id'],
         'materializedPath': json['materialized_path'],
         'systemManaged': json['system_managed'],
+        'excludeFromQdrant': json['exclude_from_qdrant'],
         'tenantId': json['tenant_id'],
         'createdAt': (new Date(json['created_at'])),
         'updatedAt': (new Date(json['updated_at'])),
@@ -181,6 +189,7 @@ export function FolderResponseToJSONTyped(value?: FolderResponse | null, ignoreD
         'parent_path_part_id': value['parentPathPartId'],
         'materialized_path': value['materializedPath'],
         'system_managed': value['systemManaged'],
+        'exclude_from_qdrant': value['excludeFromQdrant'],
         'tenant_id': value['tenantId'],
         'created_at': value['createdAt'].toISOString(),
         'updated_at': value['updatedAt'].toISOString(),

package/src/models/InviteLinkSettingsRequest.ts

@@ -0,0 +1,116 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Knowledge Stack API
+ * Knowledge Stack backend API for authentication and knowledge management
+ *
+ * The version of the OpenAPI document: 0.1.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * Partial invite-link settings update.
+ * 
+ * ``role`` is constrained to USER/ADMIN by the shared ``InviteLinkRole``
+ * Literal — Pydantic raises a 422 for any other value.
+ * @export
+ * @interface InviteLinkSettingsRequest
+ */
+export interface InviteLinkSettingsRequest {
+    /**
+     * 
+     * @type {boolean}
+     * @memberof InviteLinkSettingsRequest
+     */
+    enabled?: boolean | null;
+    /**
+     * 
+     * @type {InviteLinkSettingsRequestRoleEnum}
+     * @memberof InviteLinkSettingsRequest
+     */
+    role?: InviteLinkSettingsRequestRoleEnum | null;
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof InviteLinkSettingsRequest
+     */
+    groups?: Array<string> | null;
+}
+
+
+/**
+ * @export
+ */
+export const InviteLinkSettingsRequestRoleEnum = {
+    User: 'USER',
+    Admin: 'ADMIN'
+} as const;
+export type InviteLinkSettingsRequestRoleEnum = typeof InviteLinkSettingsRequestRoleEnum[keyof typeof InviteLinkSettingsRequestRoleEnum];
+
+export const InviteLinkSettingsRequestPropertyValidationAttributesMap: {
+    [property: string]: {
+        maxLength?: number,
+        minLength?: number,
+        pattern?: string,
+        maximum?: number,
+        exclusiveMaximum?: boolean,
+        minimum?: number,
+        exclusiveMinimum?: boolean,
+        multipleOf?: number,
+        maxItems?: number,
+        minItems?: number,
+        uniqueItems?: boolean
+    }
+} = {
+    groups: {
+        maxItems: 10,
+        uniqueItems: false,
+    },
+}
+
+
+/**
+ * Check if a given object implements the InviteLinkSettingsRequest interface.
+ */
+export function instanceOfInviteLinkSettingsRequest(value: object): value is InviteLinkSettingsRequest {
+    return true;
+}
+
+export function InviteLinkSettingsRequestFromJSON(json: any): InviteLinkSettingsRequest {
+    return InviteLinkSettingsRequestFromJSONTyped(json, false);
+}
+
+export function InviteLinkSettingsRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): InviteLinkSettingsRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'enabled': json['enabled'] == null ? undefined : json['enabled'],
+        'role': json['role'] == null ? undefined : json['role'],
+        'groups': json['groups'] == null ? undefined : json['groups'],
+    };
+}
+
+export function InviteLinkSettingsRequestToJSON(json: any): InviteLinkSettingsRequest {
+    return InviteLinkSettingsRequestToJSONTyped(json, false);
+}
+
+export function InviteLinkSettingsRequestToJSONTyped(value?: InviteLinkSettingsRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'enabled': value['enabled'],
+        'role': value['role'],
+        'groups': value['groups'],
+    };
+}
+