@knowledge-stack/ksapi 1.47.0 → 1.48.0

package/docs/ScoredChunkResponse.md

@@ -22,8 +22,8 @@ Name | Type
 `createdAt` | Date
 `updatedAt` | Date
 `assetS3Urls` | Array<string>
-`documentId` | string
-`documentVersionId` | string
+`document` | [ChunkDocumentResponse](ChunkDocumentResponse.md)
+`documentVersion` | [ChunkDocumentVersionResponse](ChunkDocumentVersionResponse.md)
 `score` | number
 
 ## Example
@@ -48,8 +48,8 @@ const example = {
   "createdAt": null,
   "updatedAt": null,
   "assetS3Urls": null,
-  "documentId": null,
-  "documentVersionId": null,
+  "document": null,
+  "documentVersion": null,
   "score": null,
 } satisfies ScoredChunkResponse
 

package/docs/ThreadMessageResponse.md

@@ -11,7 +11,7 @@ Name | Type
 `pathPartId` | string
 `sequence` | number
 `role` | [MessageRole](MessageRole.md)
-`content` | [ThreadMessageContent](ThreadMessageContent.md)
+`content` | [EnrichedThreadMessageContent](EnrichedThreadMessageContent.md)
 `details` | [ThreadMessageDetailsOutput](ThreadMessageDetailsOutput.md)
 `parentPathId` | string
 `materializedPath` | string

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@knowledge-stack/ksapi",
-  "version": "1.47.0",
+  "version": "1.48.0",
   "description": "OpenAPI client for @knowledge-stack/ksapi",
   "author": "OpenAPI-Generator",
   "repository": {

package/src/models/ChunkBulkResponse.ts

@@ -13,6 +13,13 @@
  */
 
 import { mapValues } from '../runtime';
+import type { ChunkDocumentResponse } from './ChunkDocumentResponse';
+import {
+    ChunkDocumentResponseFromJSON,
+    ChunkDocumentResponseFromJSONTyped,
+    ChunkDocumentResponseToJSON,
+    ChunkDocumentResponseToJSONTyped,
+} from './ChunkDocumentResponse';
 import type { ChunkMetadataOutput } from './ChunkMetadataOutput';
 import {
     ChunkMetadataOutputFromJSON,
@@ -27,6 +34,13 @@ import {
     ChunkTypeToJSON,
     ChunkTypeToJSONTyped,
 } from './ChunkType';
+import type { ChunkDocumentVersionResponse } from './ChunkDocumentVersionResponse';
+import {
+    ChunkDocumentVersionResponseFromJSON,
+    ChunkDocumentVersionResponseFromJSONTyped,
+    ChunkDocumentVersionResponseToJSON,
+    ChunkDocumentVersionResponseToJSONTyped,
+} from './ChunkDocumentVersionResponse';
 
 /**
  * Chunk response with ancestor path part IDs for Qdrant payload construction.
@@ -125,17 +139,17 @@ export interface ChunkBulkResponse {
      */
     assetS3Urls?: Array<string>;
     /**
-     * ID of the ancestor document (populated when with_document=true)
-     * @type {string}
+     * 
+     * @type {ChunkDocumentResponse}
      * @memberof ChunkBulkResponse
      */
-    documentId?: string | null;
+    document?: ChunkDocumentResponse;
     /**
-     * ID of the ancestor document version (populated when with_document=true)
-     * @type {string}
+     * 
+     * @type {ChunkDocumentVersionResponse}
      * @memberof ChunkBulkResponse
      */
-    documentVersionId?: string | null;
+    documentVersion?: ChunkDocumentVersionResponse;
     /**
      * Ordered ancestor PathPart IDs from root to chunk
      * @type {Array<string>}
@@ -191,8 +205,8 @@ export function ChunkBulkResponseFromJSONTyped(json: any, ignoreDiscriminator: b
         'createdAt': (new Date(json['created_at'])),
         'updatedAt': (new Date(json['updated_at'])),
         'assetS3Urls': json['asset_s3_urls'] == null ? undefined : json['asset_s3_urls'],
-        'documentId': json['document_id'] == null ? undefined : json['document_id'],
-        'documentVersionId': json['document_version_id'] == null ? undefined : json['document_version_id'],
+        'document': json['document'] == null ? undefined : ChunkDocumentResponseFromJSON(json['document']),
+        'documentVersion': json['document_version'] == null ? undefined : ChunkDocumentVersionResponseFromJSON(json['document_version']),
         'pathPartIdSegments': json['path_part_id_segments'],
     };
 }
@@ -223,8 +237,8 @@ export function ChunkBulkResponseToJSONTyped(value?: ChunkBulkResponse | null, i
         'created_at': value['createdAt'].toISOString(),
         'updated_at': value['updatedAt'].toISOString(),
         'asset_s3_urls': value['assetS3Urls'],
-        'document_id': value['documentId'],
-        'document_version_id': value['documentVersionId'],
+        'document': ChunkDocumentResponseToJSON(value['document']),
+        'document_version': ChunkDocumentVersionResponseToJSON(value['documentVersion']),
         'path_part_id_segments': value['pathPartIdSegments'],
     };
 }

package/src/models/ChunkDocumentResponse.ts

@@ -0,0 +1,127 @@
+/* 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';
+import type { DocumentOrigin } from './DocumentOrigin';
+import {
+    DocumentOriginFromJSON,
+    DocumentOriginFromJSONTyped,
+    DocumentOriginToJSON,
+    DocumentOriginToJSONTyped,
+} from './DocumentOrigin';
+import type { DocumentType } from './DocumentType';
+import {
+    DocumentTypeFromJSON,
+    DocumentTypeFromJSONTyped,
+    DocumentTypeToJSON,
+    DocumentTypeToJSONTyped,
+} from './DocumentType';
+
+/**
+ * Lightweight document info attached to a chunk response.
+ * @export
+ * @interface ChunkDocumentResponse
+ */
+export interface ChunkDocumentResponse {
+    /**
+     * Document ID
+     * @type {string}
+     * @memberof ChunkDocumentResponse
+     */
+    id: string;
+    /**
+     * Document name
+     * @type {string}
+     * @memberof ChunkDocumentResponse
+     */
+    name: string;
+    /**
+     * 
+     * @type {DocumentType}
+     * @memberof ChunkDocumentResponse
+     */
+    documentType: DocumentType;
+    /**
+     * 
+     * @type {DocumentOrigin}
+     * @memberof ChunkDocumentResponse
+     */
+    documentOrigin: DocumentOrigin;
+}
+
+
+
+/**
+ * Check if a given object implements the ChunkDocumentResponse interface.
+ */
+export function instanceOfChunkDocumentResponse(value: object): value is ChunkDocumentResponse {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('name' in value) || value['name'] === undefined) return false;
+    if (!('documentType' in value) || value['documentType'] === undefined) return false;
+    if (!('documentOrigin' in value) || value['documentOrigin'] === undefined) return false;
+    return true;
+}
+
+export function ChunkDocumentResponseFromJSON(json: any): ChunkDocumentResponse {
+    return ChunkDocumentResponseFromJSONTyped(json, false);
+}
+
+export function ChunkDocumentResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ChunkDocumentResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'name': json['name'],
+        'documentType': DocumentTypeFromJSON(json['document_type']),
+        'documentOrigin': DocumentOriginFromJSON(json['document_origin']),
+    };
+}
+
+export function ChunkDocumentResponseToJSON(json: any): ChunkDocumentResponse {
+    return ChunkDocumentResponseToJSONTyped(json, false);
+}
+
+export function ChunkDocumentResponseToJSONTyped(value?: ChunkDocumentResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'name': value['name'],
+        'document_type': DocumentTypeToJSON(value['documentType']),
+        'document_origin': DocumentOriginToJSON(value['documentOrigin']),
+    };
+}
+
+export const ChunkDocumentResponsePropertyValidationAttributesMap: {
+    [property: string]: {
+        maxLength?: number,
+        minLength?: number,
+        pattern?: string,
+        maximum?: number,
+        exclusiveMaximum?: boolean,
+        minimum?: number,
+        exclusiveMinimum?: boolean,
+        multipleOf?: number,
+        maxItems?: number,
+        minItems?: number,
+        uniqueItems?: boolean
+    }
+} = {
+}
+

package/src/models/ChunkDocumentVersionResponse.ts

@@ -0,0 +1,101 @@
+/* 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';
+/**
+ * Lightweight document version info attached to a chunk response.
+ * @export
+ * @interface ChunkDocumentVersionResponse
+ */
+export interface ChunkDocumentVersionResponse {
+    /**
+     * DocumentVersion ID
+     * @type {string}
+     * @memberof ChunkDocumentVersionResponse
+     */
+    id: string;
+    /**
+     * Version number
+     * @type {number}
+     * @memberof ChunkDocumentVersionResponse
+     */
+    version: number;
+    /**
+     * Version path name (e.g. v0)
+     * @type {string}
+     * @memberof ChunkDocumentVersionResponse
+     */
+    name: string;
+}
+
+/**
+ * Check if a given object implements the ChunkDocumentVersionResponse interface.
+ */
+export function instanceOfChunkDocumentVersionResponse(value: object): value is ChunkDocumentVersionResponse {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('version' in value) || value['version'] === undefined) return false;
+    if (!('name' in value) || value['name'] === undefined) return false;
+    return true;
+}
+
+export function ChunkDocumentVersionResponseFromJSON(json: any): ChunkDocumentVersionResponse {
+    return ChunkDocumentVersionResponseFromJSONTyped(json, false);
+}
+
+export function ChunkDocumentVersionResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ChunkDocumentVersionResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'version': json['version'],
+        'name': json['name'],
+    };
+}
+
+export function ChunkDocumentVersionResponseToJSON(json: any): ChunkDocumentVersionResponse {
+    return ChunkDocumentVersionResponseToJSONTyped(json, false);
+}
+
+export function ChunkDocumentVersionResponseToJSONTyped(value?: ChunkDocumentVersionResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'version': value['version'],
+        'name': value['name'],
+    };
+}
+
+export const ChunkDocumentVersionResponsePropertyValidationAttributesMap: {
+    [property: string]: {
+        maxLength?: number,
+        minLength?: number,
+        pattern?: string,
+        maximum?: number,
+        exclusiveMaximum?: boolean,
+        minimum?: number,
+        exclusiveMinimum?: boolean,
+        multipleOf?: number,
+        maxItems?: number,
+        minItems?: number,
+        uniqueItems?: boolean
+    }
+} = {
+}
+

package/src/models/ChunkResponse.ts

@@ -13,6 +13,13 @@
  */
 
 import { mapValues } from '../runtime';
+import type { ChunkDocumentResponse } from './ChunkDocumentResponse';
+import {
+    ChunkDocumentResponseFromJSON,
+    ChunkDocumentResponseFromJSONTyped,
+    ChunkDocumentResponseToJSON,
+    ChunkDocumentResponseToJSONTyped,
+} from './ChunkDocumentResponse';
 import type { ChunkMetadataOutput } from './ChunkMetadataOutput';
 import {
     ChunkMetadataOutputFromJSON,
@@ -27,6 +34,13 @@ import {
     ChunkTypeToJSON,
     ChunkTypeToJSONTyped,
 } from './ChunkType';
+import type { ChunkDocumentVersionResponse } from './ChunkDocumentVersionResponse';
+import {
+    ChunkDocumentVersionResponseFromJSON,
+    ChunkDocumentVersionResponseFromJSONTyped,
+    ChunkDocumentVersionResponseToJSON,
+    ChunkDocumentVersionResponseToJSONTyped,
+} from './ChunkDocumentVersionResponse';
 
 /**
  * Chunk response model.
@@ -125,17 +139,17 @@ export interface ChunkResponse {
      */
     assetS3Urls?: Array<string>;
     /**
-     * ID of the ancestor document (populated when with_document=true)
-     * @type {string}
+     * 
+     * @type {ChunkDocumentResponse}
      * @memberof ChunkResponse
      */
-    documentId?: string | null;
+    document?: ChunkDocumentResponse;
     /**
-     * ID of the ancestor document version (populated when with_document=true)
-     * @type {string}
+     * 
+     * @type {ChunkDocumentVersionResponse}
      * @memberof ChunkResponse
      */
-    documentVersionId?: string | null;
+    documentVersion?: ChunkDocumentVersionResponse;
 }
 
 
@@ -184,8 +198,8 @@ export function ChunkResponseFromJSONTyped(json: any, ignoreDiscriminator: boole
         'createdAt': (new Date(json['created_at'])),
         'updatedAt': (new Date(json['updated_at'])),
         'assetS3Urls': json['asset_s3_urls'] == null ? undefined : json['asset_s3_urls'],
-        'documentId': json['document_id'] == null ? undefined : json['document_id'],
-        'documentVersionId': json['document_version_id'] == null ? undefined : json['document_version_id'],
+        'document': json['document'] == null ? undefined : ChunkDocumentResponseFromJSON(json['document']),
+        'documentVersion': json['document_version'] == null ? undefined : ChunkDocumentVersionResponseFromJSON(json['document_version']),
     };
 }
 
@@ -215,8 +229,8 @@ export function ChunkResponseToJSONTyped(value?: ChunkResponse | null, ignoreDis
         'created_at': value['createdAt'].toISOString(),
         'updated_at': value['updatedAt'].toISOString(),
         'asset_s3_urls': value['assetS3Urls'],
-        'document_id': value['documentId'],
-        'document_version_id': value['documentVersionId'],
+        'document': ChunkDocumentResponseToJSON(value['document']),
+        'document_version': ChunkDocumentVersionResponseToJSON(value['documentVersion']),
     };
 }
 

package/src/models/EnrichedCitation.ts

@@ -0,0 +1,162 @@
+/* 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';
+/**
+ * Citation with optional document context, populated at read time.
+ * @export
+ * @interface EnrichedCitation
+ */
+export interface EnrichedCitation {
+    /**
+     * 
+     * @type {string}
+     * @memberof EnrichedCitation
+     */
+    chunkId: string;
+    /**
+     * The quote from the chunk
+     * @type {string}
+     * @memberof EnrichedCitation
+     */
+    quote: string;
+    /**
+     * The 0-based start character of the quote in the chunk
+     * @type {number}
+     * @memberof EnrichedCitation
+     */
+    startChar: number;
+    /**
+     * The length of the quote
+     * @type {number}
+     * @memberof EnrichedCitation
+     */
+    length: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof EnrichedCitation
+     */
+    documentId?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof EnrichedCitation
+     */
+    documentVersionId?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof EnrichedCitation
+     */
+    documentName?: string | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof EnrichedCitation
+     */
+    versionNumber?: number | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof EnrichedCitation
+     */
+    pathPartId?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof EnrichedCitation
+     */
+    materializedPath?: string | null;
+}
+
+/**
+ * Check if a given object implements the EnrichedCitation interface.
+ */
+export function instanceOfEnrichedCitation(value: object): value is EnrichedCitation {
+    if (!('chunkId' in value) || value['chunkId'] === undefined) return false;
+    if (!('quote' in value) || value['quote'] === undefined) return false;
+    if (!('startChar' in value) || value['startChar'] === undefined) return false;
+    if (!('length' in value) || value['length'] === undefined) return false;
+    return true;
+}
+
+export function EnrichedCitationFromJSON(json: any): EnrichedCitation {
+    return EnrichedCitationFromJSONTyped(json, false);
+}
+
+export function EnrichedCitationFromJSONTyped(json: any, ignoreDiscriminator: boolean): EnrichedCitation {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'chunkId': json['chunk_id'],
+        'quote': json['quote'],
+        'startChar': json['start_char'],
+        'length': json['length'],
+        'documentId': json['document_id'] == null ? undefined : json['document_id'],
+        'documentVersionId': json['document_version_id'] == null ? undefined : json['document_version_id'],
+        'documentName': json['document_name'] == null ? undefined : json['document_name'],
+        'versionNumber': json['version_number'] == null ? undefined : json['version_number'],
+        'pathPartId': json['path_part_id'] == null ? undefined : json['path_part_id'],
+        'materializedPath': json['materialized_path'] == null ? undefined : json['materialized_path'],
+    };
+}
+
+export function EnrichedCitationToJSON(json: any): EnrichedCitation {
+    return EnrichedCitationToJSONTyped(json, false);
+}
+
+export function EnrichedCitationToJSONTyped(value?: EnrichedCitation | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'chunk_id': value['chunkId'],
+        'quote': value['quote'],
+        'start_char': value['startChar'],
+        'length': value['length'],
+        'document_id': value['documentId'],
+        'document_version_id': value['documentVersionId'],
+        'document_name': value['documentName'],
+        'version_number': value['versionNumber'],
+        'path_part_id': value['pathPartId'],
+        'materialized_path': value['materializedPath'],
+    };
+}
+
+export const EnrichedCitationPropertyValidationAttributesMap: {
+    [property: string]: {
+        maxLength?: number,
+        minLength?: number,
+        pattern?: string,
+        maximum?: number,
+        exclusiveMaximum?: boolean,
+        minimum?: number,
+        exclusiveMinimum?: boolean,
+        multipleOf?: number,
+        maxItems?: number,
+        minItems?: number,
+        uniqueItems?: boolean
+    }
+} = {
+    startChar: {
+        minimum: 0,
+        exclusiveMinimum: false,
+    },
+}
+

package/src/models/EnrichedThreadMessageContent.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';
+import type { EnrichedCitation } from './EnrichedCitation';
+import {
+    EnrichedCitationFromJSON,
+    EnrichedCitationFromJSONTyped,
+    EnrichedCitationToJSON,
+    EnrichedCitationToJSONTyped,
+} from './EnrichedCitation';
+
+/**
+ * ThreadMessageContent with enriched citations for API responses.
+ * @export
+ * @interface EnrichedThreadMessageContent
+ */
+export interface EnrichedThreadMessageContent {
+    /**
+     * The text content of the message
+     * @type {string}
+     * @memberof EnrichedThreadMessageContent
+     */
+    text: string;
+    /**
+     * A list of citations with document context
+     * @type {Array<EnrichedCitation>}
+     * @memberof EnrichedThreadMessageContent
+     */
+    citations?: Array<EnrichedCitation> | null;
+}
+
+/**
+ * Check if a given object implements the EnrichedThreadMessageContent interface.
+ */
+export function instanceOfEnrichedThreadMessageContent(value: object): value is EnrichedThreadMessageContent {
+    if (!('text' in value) || value['text'] === undefined) return false;
+    return true;
+}
+
+export function EnrichedThreadMessageContentFromJSON(json: any): EnrichedThreadMessageContent {
+    return EnrichedThreadMessageContentFromJSONTyped(json, false);
+}
+
+export function EnrichedThreadMessageContentFromJSONTyped(json: any, ignoreDiscriminator: boolean): EnrichedThreadMessageContent {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'text': json['text'],
+        'citations': json['citations'] == null ? undefined : ((json['citations'] as Array<any>).map(EnrichedCitationFromJSON)),
+    };
+}
+
+export function EnrichedThreadMessageContentToJSON(json: any): EnrichedThreadMessageContent {
+    return EnrichedThreadMessageContentToJSONTyped(json, false);
+}
+
+export function EnrichedThreadMessageContentToJSONTyped(value?: EnrichedThreadMessageContent | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'text': value['text'],
+        'citations': value['citations'] == null ? undefined : ((value['citations'] as Array<any>).map(EnrichedCitationToJSON)),
+    };
+}
+
+export const EnrichedThreadMessageContentPropertyValidationAttributesMap: {
+    [property: string]: {
+        maxLength?: number,
+        minLength?: number,
+        pattern?: string,
+        maximum?: number,
+        exclusiveMaximum?: boolean,
+        minimum?: number,
+        exclusiveMinimum?: boolean,
+        multipleOf?: number,
+        maxItems?: number,
+        minItems?: number,
+        uniqueItems?: boolean
+    }
+} = {
+}
+