@knowledge-stack/ksapi 1.72.3 → 1.77.1

package/src/models/AskResponse.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/ask.
+ * @export
+ * @interface AskResponse
+ */
+export interface AskResponse {
+    /**
+     * 
+     * @type {string}
+     * @memberof AskResponse
+     */
+    text: string;
+}
+export const AskResponsePropertyValidationAttributesMap: {
+    [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 AskResponse interface.
+ */
+export function instanceOfAskResponse(value: object): value is AskResponse {
+    if (!('text' in value) || value['text'] === undefined) return false;
+    return true;
+}
+
+export function AskResponseFromJSON(json: any): AskResponse {
+    return AskResponseFromJSONTyped(json, false);
+}
+
+export function AskResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): AskResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'text': json['text'],
+    };
+}
+
+export function AskResponseToJSON(json: any): AskResponse {
+    return AskResponseToJSONTyped(json, false);
+}
+
+export function AskResponseToJSONTyped(value?: AskResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'text': value['text'],
+    };
+}
+

package/src/models/ChangeSubscriptionRequest.ts

@@ -0,0 +1,96 @@
+/* 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';
+/**
+ * Body for ``POST /v1/tenants/{tenant_id}/subscriptions``.
+ * @export
+ * @interface ChangeSubscriptionRequest
+ */
+export interface ChangeSubscriptionRequest {
+    /**
+     * Target plan to switch to.
+     * @type {string}
+     * @memberof ChangeSubscriptionRequest
+     */
+    subscriptionId: string;
+    /**
+     * Desired seat cap. Must be <= plan.max_seats and >= the count of active TenantUser rows.
+     * @type {number}
+     * @memberof ChangeSubscriptionRequest
+     */
+    numSeats: number;
+}
+export const ChangeSubscriptionRequestPropertyValidationAttributesMap: {
+    [property: string]: {
+        maxLength?: number,
+        minLength?: number,
+        pattern?: string,
+        maximum?: number,
+        exclusiveMaximum?: boolean,
+        minimum?: number,
+        exclusiveMinimum?: boolean,
+        multipleOf?: number,
+        maxItems?: number,
+        minItems?: number,
+        uniqueItems?: boolean
+    }
+} = {
+    numSeats: {
+        minimum: 1,
+        exclusiveMinimum: false,
+    },
+}
+
+
+/**
+ * Check if a given object implements the ChangeSubscriptionRequest interface.
+ */
+export function instanceOfChangeSubscriptionRequest(value: object): value is ChangeSubscriptionRequest {
+    if (!('subscriptionId' in value) || value['subscriptionId'] === undefined) return false;
+    if (!('numSeats' in value) || value['numSeats'] === undefined) return false;
+    return true;
+}
+
+export function ChangeSubscriptionRequestFromJSON(json: any): ChangeSubscriptionRequest {
+    return ChangeSubscriptionRequestFromJSONTyped(json, false);
+}
+
+export function ChangeSubscriptionRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): ChangeSubscriptionRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'subscriptionId': json['subscription_id'],
+        'numSeats': json['num_seats'],
+    };
+}
+
+export function ChangeSubscriptionRequestToJSON(json: any): ChangeSubscriptionRequest {
+    return ChangeSubscriptionRequestToJSONTyped(json, false);
+}
+
+export function ChangeSubscriptionRequestToJSONTyped(value?: ChangeSubscriptionRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'subscription_id': value['subscriptionId'],
+        'num_seats': value['numSeats'],
+    };
+}
+

package/src/models/CheckpointDetails.ts

@@ -0,0 +1,169 @@
+/* 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';
+/**
+ * Agent-internal overlay that replaces older messages in the loaded history.
+ * 
+ * Written as ``details.checkpoint`` on ``role=SYSTEM`` ThreadMessages.
+ * The boundary is explicit via ``upto_message_id`` + ``upto_message_created_at``
+ * so the agent can keep recent messages uncompacted even though the checkpoint
+ * message itself is inserted at "now".
+ * @export
+ * @interface CheckpointDetails
+ */
+export interface CheckpointDetails {
+    /**
+     * Last message covered by this summary (inclusive).
+     * @type {string}
+     * @memberof CheckpointDetails
+     */
+    uptoMessageId: string;
+    /**
+     * created_at of upto_message_id; tiebreaker for identical timestamps.
+     * @type {Date}
+     * @memberof CheckpointDetails
+     */
+    uptoMessageCreatedAt: Date;
+    /**
+     * Agent-internal CompressionSummary as a JSON blob. Server does not interpret this; the agent serializes/deserializes via its own model.
+     * @type {{ [key: string]: any; }}
+     * @memberof CheckpointDetails
+     */
+    summary: { [key: string]: any; };
+    /**
+     * 
+     * @type {number}
+     * @memberof CheckpointDetails
+     */
+    coveredMessageCount: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof CheckpointDetails
+     */
+    tokensBefore: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof CheckpointDetails
+     */
+    tokensAfter: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof CheckpointDetails
+     */
+    summarizerModel: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof CheckpointDetails
+     */
+    promptVersion: string;
+}
+export const CheckpointDetailsPropertyValidationAttributesMap: {
+    [property: string]: {
+        maxLength?: number,
+        minLength?: number,
+        pattern?: string,
+        maximum?: number,
+        exclusiveMaximum?: boolean,
+        minimum?: number,
+        exclusiveMinimum?: boolean,
+        multipleOf?: number,
+        maxItems?: number,
+        minItems?: number,
+        uniqueItems?: boolean
+    }
+} = {
+    coveredMessageCount: {
+        minimum: 0,
+        exclusiveMinimum: false,
+    },
+    tokensBefore: {
+        minimum: 0,
+        exclusiveMinimum: false,
+    },
+    tokensAfter: {
+        minimum: 0,
+        exclusiveMinimum: false,
+    },
+    summarizerModel: {
+        maxLength: 128,
+    },
+    promptVersion: {
+        maxLength: 32,
+    },
+}
+
+
+/**
+ * Check if a given object implements the CheckpointDetails interface.
+ */
+export function instanceOfCheckpointDetails(value: object): value is CheckpointDetails {
+    if (!('uptoMessageId' in value) || value['uptoMessageId'] === undefined) return false;
+    if (!('uptoMessageCreatedAt' in value) || value['uptoMessageCreatedAt'] === undefined) return false;
+    if (!('summary' in value) || value['summary'] === undefined) return false;
+    if (!('coveredMessageCount' in value) || value['coveredMessageCount'] === undefined) return false;
+    if (!('tokensBefore' in value) || value['tokensBefore'] === undefined) return false;
+    if (!('tokensAfter' in value) || value['tokensAfter'] === undefined) return false;
+    if (!('summarizerModel' in value) || value['summarizerModel'] === undefined) return false;
+    if (!('promptVersion' in value) || value['promptVersion'] === undefined) return false;
+    return true;
+}
+
+export function CheckpointDetailsFromJSON(json: any): CheckpointDetails {
+    return CheckpointDetailsFromJSONTyped(json, false);
+}
+
+export function CheckpointDetailsFromJSONTyped(json: any, ignoreDiscriminator: boolean): CheckpointDetails {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'uptoMessageId': json['upto_message_id'],
+        'uptoMessageCreatedAt': (new Date(json['upto_message_created_at'])),
+        'summary': json['summary'],
+        'coveredMessageCount': json['covered_message_count'],
+        'tokensBefore': json['tokens_before'],
+        'tokensAfter': json['tokens_after'],
+        'summarizerModel': json['summarizer_model'],
+        'promptVersion': json['prompt_version'],
+    };
+}
+
+export function CheckpointDetailsToJSON(json: any): CheckpointDetails {
+    return CheckpointDetailsToJSONTyped(json, false);
+}
+
+export function CheckpointDetailsToJSONTyped(value?: CheckpointDetails | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'upto_message_id': value['uptoMessageId'],
+        'upto_message_created_at': value['uptoMessageCreatedAt'].toISOString(),
+        'summary': value['summary'],
+        'covered_message_count': value['coveredMessageCount'],
+        'tokens_before': value['tokensBefore'],
+        'tokens_after': value['tokensAfter'],
+        'summarizer_model': value['summarizerModel'],
+        'prompt_version': value['promptVersion'],
+    };
+}
+

package/src/models/ChunkBulkResponse.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 ChunkBulkResponse {
     chunkType: ChunkType;
     /**
      * 
-     * @type {ChunkMetadataOutput}
+     * @type {ChunkMetadata}
      * @memberof ChunkBulkResponse
      */
-    chunkMetadata: ChunkMetadataOutput;
+    chunkMetadata: ChunkMetadata;
     /**
      * Number of tokens in chunk content
      * @type {number}
@@ -218,7 +218,7 @@ export function ChunkBulkResponseFromJSONTyped(json: any, ignoreDiscriminator: b
         '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'],
@@ -251,7 +251,7 @@ export function ChunkBulkResponseToJSONTyped(value?: ChunkBulkResponse | null, i
         '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/ChunkContentItem.ts

@@ -13,13 +13,13 @@
  */
 
 import { mapValues } from '../runtime';
-import type { ChunkMetadataOutput } from './ChunkMetadataOutput';
+import type { ChunkMetadata } from './ChunkMetadata';
 import {
-    ChunkMetadataOutputFromJSON,
-    ChunkMetadataOutputFromJSONTyped,
-    ChunkMetadataOutputToJSON,
-    ChunkMetadataOutputToJSONTyped,
-} from './ChunkMetadataOutput';
+    ChunkMetadataFromJSON,
+    ChunkMetadataFromJSONTyped,
+    ChunkMetadataToJSON,
+    ChunkMetadataToJSONTyped,
+} from './ChunkMetadata';
 import type { ChunkType } from './ChunkType';
 import {
     ChunkTypeFromJSON,
@@ -84,10 +84,10 @@ export interface ChunkContentItem {
     chunkType?: ChunkType;
     /**
      * 
-     * @type {ChunkMetadataOutput}
+     * @type {ChunkMetadata}
      * @memberof ChunkContentItem
      */
-    chunkMetadata?: ChunkMetadataOutput;
+    chunkMetadata?: ChunkMetadata;
     /**
      * Full materialized path from root
      * @type {string}
@@ -176,7 +176,7 @@ export function ChunkContentItemFromJSONTyped(json: any, ignoreDiscriminator: bo
         'depth': json['depth'],
         'content': json['content'] == null ? undefined : json['content'],
         'chunkType': json['chunk_type'] == null ? undefined : ChunkTypeFromJSON(json['chunk_type']),
-        'chunkMetadata': json['chunk_metadata'] == null ? undefined : ChunkMetadataOutputFromJSON(json['chunk_metadata']),
+        'chunkMetadata': json['chunk_metadata'] == null ? undefined : ChunkMetadataFromJSON(json['chunk_metadata']),
         'materializedPath': json['materialized_path'],
         'systemManaged': json['system_managed'],
         'createdAt': (new Date(json['created_at'])),
@@ -203,7 +203,7 @@ export function ChunkContentItemToJSONTyped(value?: ChunkContentItem | null, ign
         'depth': value['depth'],
         'content': value['content'],
         'chunk_type': ChunkTypeToJSON(value['chunkType']),
-        'chunk_metadata': ChunkMetadataOutputToJSON(value['chunkMetadata']),
+        'chunk_metadata': ChunkMetadataToJSON(value['chunkMetadata']),
         'materialized_path': value['materializedPath'],
         'system_managed': value['systemManaged'],
         'created_at': value['createdAt'].toISOString(),

package/src/models/{ChunkMetadataInput.ts → ChunkMetadata.ts}

@@ -31,97 +31,97 @@ import {
 /**
  * Metadata for a chunk including source document references.
  * @export
- * @interface ChunkMetadataInput
+ * @interface ChunkMetadata
  */
-export interface ChunkMetadataInput {
+export interface ChunkMetadata {
     /**
      * List of bounding boxes in the source document for the chunk, potentially from multiple areas of multiple pages.
      * @type {Array<PolygonReference>}
-     * @memberof ChunkMetadataInput
+     * @memberof ChunkMetadata
      */
     polygons?: Array<PolygonReference>;
     /**
      * Ordered s3:// URIs to visual assets for this chunk. Single-element for standard IMAGE/TABLE/HTML chunks, multi-element for multi-page single-chunk ingestion.
      * @type {Array<string>}
-     * @memberof ChunkMetadataInput
+     * @memberof ChunkMetadata
      */
     s3Urls?: Array<string>;
     /**
      * LLM-generated summary of the chunk content. Used for TABLE and HTML chunks to enrich embedding text.
      * @type {string}
-     * @memberof ChunkMetadataInput
+     * @memberof ChunkMetadata
      */
     summary?: string | null;
     /**
      * S3 URI to extracted PDF text used for LLM grounding during enrichment
      * @type {string}
-     * @memberof ChunkMetadataInput
+     * @memberof ChunkMetadata
      */
     extractedTextS3Uri?: string | null;
     /**
      * 
      * @type {ImageTaxonomy}
-     * @memberof ChunkMetadataInput
+     * @memberof ChunkMetadata
      */
     secondaryTaxonomy?: ImageTaxonomy;
     /**
      * Worksheet name this chunk was extracted from (XLSX only)
      * @type {string}
-     * @memberof ChunkMetadataInput
+     * @memberof ChunkMetadata
      */
     sheetName?: string | null;
     /**
      * XLSXParser block type (e.g. table, calculation_block, chart_anchor)
      * @type {string}
-     * @memberof ChunkMetadataInput
+     * @memberof ChunkMetadata
      */
     blockType?: string | null;
     /**
      * Cell range URI reference in the source workbook (XLSX only)
      * @type {string}
-     * @memberof ChunkMetadataInput
+     * @memberof ChunkMetadata
      */
     sourceUri?: string | null;
     /**
      * Rendered HTML for non-table XLSX chunks (tables use render_html as content)
      * @type {string}
-     * @memberof ChunkMetadataInput
+     * @memberof ChunkMetadata
      */
     enrichedHtml?: string | null;
     /**
      * Cell address range, e.g. 'A1:D10' (XLSX only)
      * @type {string}
-     * @memberof ChunkMetadataInput
+     * @memberof ChunkMetadata
      */
     cellRange?: string | null;
     /**
      * Upstream/downstream/cross-sheet cell references for audit reasoning (XLSX only)
      * @type {{ [key: string]: any; }}
-     * @memberof ChunkMetadataInput
+     * @memberof ChunkMetadata
      */
     dependencySummary?: { [key: string]: any; } | null;
     /**
      * Formula cells in this chunk as [{address, formula, value}] (XLSX only)
      * @type {Array<{ [key: string]: string; }>}
-     * @memberof ChunkMetadataInput
+     * @memberof ChunkMetadata
      */
     formulas?: Array<{ [key: string]: string; }> | null;
     /**
      * Notable output/header cells for quick identification (XLSX only)
      * @type {Array<{ [key: string]: any; }>}
-     * @memberof ChunkMetadataInput
+     * @memberof ChunkMetadata
      */
     keyCells?: Array<{ [key: string]: any; }> | null;
     /**
      * Named ranges overlapping this chunk (XLSX only)
      * @type {Array<{ [key: string]: any; }>}
-     * @memberof ChunkMetadataInput
+     * @memberof ChunkMetadata
      */
     namedRanges?: Array<{ [key: string]: any; }> | null;
 }
 
 
-export const ChunkMetadataInputPropertyValidationAttributesMap: {
+export const ChunkMetadataPropertyValidationAttributesMap: {
     [property: string]: {
         maxLength?: number,
         minLength?: number,
@@ -140,17 +140,17 @@ export const ChunkMetadataInputPropertyValidationAttributesMap: {
 
 
 /**
- * Check if a given object implements the ChunkMetadataInput interface.
+ * Check if a given object implements the ChunkMetadata interface.
  */
-export function instanceOfChunkMetadataInput(value: object): value is ChunkMetadataInput {
+export function instanceOfChunkMetadata(value: object): value is ChunkMetadata {
     return true;
 }
 
-export function ChunkMetadataInputFromJSON(json: any): ChunkMetadataInput {
-    return ChunkMetadataInputFromJSONTyped(json, false);
+export function ChunkMetadataFromJSON(json: any): ChunkMetadata {
+    return ChunkMetadataFromJSONTyped(json, false);
 }
 
-export function ChunkMetadataInputFromJSONTyped(json: any, ignoreDiscriminator: boolean): ChunkMetadataInput {
+export function ChunkMetadataFromJSONTyped(json: any, ignoreDiscriminator: boolean): ChunkMetadata {
     if (json == null) {
         return json;
     }
@@ -173,11 +173,11 @@ export function ChunkMetadataInputFromJSONTyped(json: any, ignoreDiscriminator:
     };
 }
 
-export function ChunkMetadataInputToJSON(json: any): ChunkMetadataInput {
-    return ChunkMetadataInputToJSONTyped(json, false);
+export function ChunkMetadataToJSON(json: any): ChunkMetadata {
+    return ChunkMetadataToJSONTyped(json, false);
 }
 
-export function ChunkMetadataInputToJSONTyped(value?: ChunkMetadataInput | null, ignoreDiscriminator: boolean = false): any {
+export function ChunkMetadataToJSONTyped(value?: ChunkMetadata | null, ignoreDiscriminator: boolean = false): any {
     if (value == null) {
         return value;
     }

package/src/models/ChunkNeighborsResponse.ts

@@ -42,6 +42,24 @@ export interface ChunkNeighborsResponse {
      * @memberof ChunkNeighborsResponse
      */
     anchorIndex: number;
+    /**
+     * 0-based position of the anchor in the traversal scope under the active content_type filter. With within_section=true the scope is the parent's filtered sibling chain; with within_section=false it is the entire document version in DFS order.
+     * @type {number}
+     * @memberof ChunkNeighborsResponse
+     */
+    anchorOffset: number;
+    /**
+     * Total items in the traversal scope under the active filter. Within-section: filtered direct children of the anchor's parent. Cross-section: filtered DFS items in the document version.
+     * @type {number}
+     * @memberof ChunkNeighborsResponse
+     */
+    total: number;
+    /**
+     * ID of the enclosing document version. Populated only when within_section=false (where it is required to scope the DFS traversal); null when within_section=true.
+     * @type {string}
+     * @memberof ChunkNeighborsResponse
+     */
+    documentVersionId?: string | null;
 }
 export const ChunkNeighborsResponsePropertyValidationAttributesMap: {
     [property: string]: {
@@ -67,6 +85,8 @@ export const ChunkNeighborsResponsePropertyValidationAttributesMap: {
 export function instanceOfChunkNeighborsResponse(value: object): value is ChunkNeighborsResponse {
     if (!('items' in value) || value['items'] === undefined) return false;
     if (!('anchorIndex' in value) || value['anchorIndex'] === undefined) return false;
+    if (!('anchorOffset' in value) || value['anchorOffset'] === undefined) return false;
+    if (!('total' in value) || value['total'] === undefined) return false;
     return true;
 }
 
@@ -82,6 +102,9 @@ export function ChunkNeighborsResponseFromJSONTyped(json: any, ignoreDiscriminat
         
         'items': ((json['items'] as Array<any>).map(SectionContentItemOrChunkContentItemFromJSON)),
         'anchorIndex': json['anchor_index'],
+        'anchorOffset': json['anchor_offset'],
+        'total': json['total'],
+        'documentVersionId': json['document_version_id'] == null ? undefined : json['document_version_id'],
     };
 }
 
@@ -98,6 +121,9 @@ export function ChunkNeighborsResponseToJSONTyped(value?: ChunkNeighborsResponse
         
         'items': ((value['items'] as Array<any>).map(SectionContentItemOrChunkContentItemToJSON)),
         'anchor_index': value['anchorIndex'],
+        'anchor_offset': value['anchorOffset'],
+        'total': value['total'],
+        'document_version_id': value['documentVersionId'],
     };
 }