@knowledge-stack/ksapi 1.12.0 → 1.14.0

package/src/models/ScoredChunkResponse.ts

@@ -0,0 +1,215 @@
+/* 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 { ChunkMetadataOutput } from './ChunkMetadataOutput';
+import {
+    ChunkMetadataOutputFromJSON,
+    ChunkMetadataOutputFromJSONTyped,
+    ChunkMetadataOutputToJSON,
+    ChunkMetadataOutputToJSONTyped,
+} from './ChunkMetadataOutput';
+import type { ChunkType } from './ChunkType';
+import {
+    ChunkTypeFromJSON,
+    ChunkTypeFromJSONTyped,
+    ChunkTypeToJSON,
+    ChunkTypeToJSONTyped,
+} from './ChunkType';
+
+/**
+ * Chunk response with similarity score.
+ * @export
+ * @interface ScoredChunkResponse
+ */
+export interface ScoredChunkResponse {
+    /**
+     * Chunk ID
+     * @type {string}
+     * @memberof ScoredChunkResponse
+     */
+    id: string;
+    /**
+     * PathPart ID
+     * @type {string}
+     * @memberof ScoredChunkResponse
+     */
+    pathPartId: string;
+    /**
+     * ChunkContent ID
+     * @type {string}
+     * @memberof ScoredChunkResponse
+     */
+    contentId: string;
+    /**
+     * Chunk text content
+     * @type {string}
+     * @memberof ScoredChunkResponse
+     */
+    content: string;
+    /**
+     * Type of chunk content
+     * @type {ChunkType}
+     * @memberof ScoredChunkResponse
+     */
+    chunkType: ChunkType;
+    /**
+     * Chunk metadata
+     * @type {ChunkMetadataOutput}
+     * @memberof ScoredChunkResponse
+     */
+    chunkMetadata: ChunkMetadataOutput;
+    /**
+     * Parent PathPart ID
+     * @type {string}
+     * @memberof ScoredChunkResponse
+     */
+    parentId: string;
+    /**
+     * Previous sibling PathPart ID
+     * @type {string}
+     * @memberof ScoredChunkResponse
+     */
+    prevSiblingPathId?: string;
+    /**
+     * Next sibling PathPart ID
+     * @type {string}
+     * @memberof ScoredChunkResponse
+     */
+    nextSiblingId?: string;
+    /**
+     * Full materialized path from root
+     * @type {string}
+     * @memberof ScoredChunkResponse
+     */
+    materializedPath: string;
+    /**
+     * Tenant ID
+     * @type {string}
+     * @memberof ScoredChunkResponse
+     */
+    tenantId: string;
+    /**
+     * Creation timestamp
+     * @type {Date}
+     * @memberof ScoredChunkResponse
+     */
+    createdAt: Date;
+    /**
+     * Last update timestamp
+     * @type {Date}
+     * @memberof ScoredChunkResponse
+     */
+    updatedAt: Date;
+    /**
+     * Cosine similarity score (1 - cosine_distance)
+     * @type {number}
+     * @memberof ScoredChunkResponse
+     */
+    score: number;
+}
+
+
+
+/**
+ * Check if a given object implements the ScoredChunkResponse interface.
+ */
+export function instanceOfScoredChunkResponse(value: object): value is ScoredChunkResponse {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('pathPartId' in value) || value['pathPartId'] === undefined) return false;
+    if (!('contentId' in value) || value['contentId'] === undefined) return false;
+    if (!('content' in value) || value['content'] === undefined) return false;
+    if (!('chunkType' in value) || value['chunkType'] === undefined) return false;
+    if (!('chunkMetadata' in value) || value['chunkMetadata'] === undefined) return false;
+    if (!('parentId' in value) || value['parentId'] === undefined) return false;
+    if (!('materializedPath' in value) || value['materializedPath'] === 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;
+    if (!('score' in value) || value['score'] === undefined) return false;
+    return true;
+}
+
+export function ScoredChunkResponseFromJSON(json: any): ScoredChunkResponse {
+    return ScoredChunkResponseFromJSONTyped(json, false);
+}
+
+export function ScoredChunkResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ScoredChunkResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'pathPartId': json['path_part_id'],
+        'contentId': json['content_id'],
+        'content': json['content'],
+        'chunkType': ChunkTypeFromJSON(json['chunk_type']),
+        'chunkMetadata': ChunkMetadataOutputFromJSON(json['chunk_metadata']),
+        'parentId': json['parent_id'],
+        'prevSiblingPathId': json['prev_sibling_path_id'] == null ? undefined : json['prev_sibling_path_id'],
+        'nextSiblingId': json['next_sibling_id'] == null ? undefined : json['next_sibling_id'],
+        'materializedPath': json['materialized_path'],
+        'tenantId': json['tenant_id'],
+        'createdAt': (new Date(json['created_at'])),
+        'updatedAt': (new Date(json['updated_at'])),
+        'score': json['score'],
+    };
+}
+
+export function ScoredChunkResponseToJSON(json: any): ScoredChunkResponse {
+    return ScoredChunkResponseToJSONTyped(json, false);
+}
+
+export function ScoredChunkResponseToJSONTyped(value?: ScoredChunkResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'path_part_id': value['pathPartId'],
+        'content_id': value['contentId'],
+        'content': value['content'],
+        'chunk_type': ChunkTypeToJSON(value['chunkType']),
+        'chunk_metadata': ChunkMetadataOutputToJSON(value['chunkMetadata']),
+        'parent_id': value['parentId'],
+        'prev_sibling_path_id': value['prevSiblingPathId'],
+        'next_sibling_id': value['nextSiblingId'],
+        'materialized_path': value['materializedPath'],
+        'tenant_id': value['tenantId'],
+        'created_at': value['createdAt'].toISOString(),
+        'updated_at': value['updatedAt'].toISOString(),
+        'score': value['score'],
+    };
+}
+
+export const ScoredChunkResponsePropertyValidationAttributesMap: {
+    [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/SectionResponse.ts

@@ -61,6 +61,12 @@ export interface SectionResponse {
      * @memberof SectionResponse
      */
     nextSiblingId?: string;
+    /**
+     * Full materialized path from root
+     * @type {string}
+     * @memberof SectionResponse
+     */
+    materializedPath: string;
     /**
      * Tenant ID
      * @type {string}
@@ -89,6 +95,7 @@ export function instanceOfSectionResponse(value: object): value is SectionRespon
     if (!('pathPartId' in value) || value['pathPartId'] === undefined) return false;
     if (!('name' in value) || value['name'] === undefined) return false;
     if (!('parentId' in value) || value['parentId'] === undefined) return false;
+    if (!('materializedPath' in value) || value['materializedPath'] === 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;
@@ -112,6 +119,7 @@ export function SectionResponseFromJSONTyped(json: any, ignoreDiscriminator: boo
         'parentId': json['parent_id'],
         'prevSiblingPathId': json['prev_sibling_path_id'] == null ? undefined : json['prev_sibling_path_id'],
         'nextSiblingId': json['next_sibling_id'] == null ? undefined : json['next_sibling_id'],
+        'materializedPath': json['materialized_path'],
         'tenantId': json['tenant_id'],
         'createdAt': (new Date(json['created_at'])),
         'updatedAt': (new Date(json['updated_at'])),
@@ -136,6 +144,7 @@ export function SectionResponseToJSONTyped(value?: SectionResponse | null, ignor
         'parent_id': value['parentId'],
         'prev_sibling_path_id': value['prevSiblingPathId'],
         'next_sibling_id': value['nextSiblingId'],
+        'materialized_path': value['materializedPath'],
         'tenant_id': value['tenantId'],
         'created_at': value['createdAt'].toISOString(),
         'updated_at': value['updatedAt'].toISOString(),

package/src/models/ThreadMessageResponse.ts

@@ -63,6 +63,12 @@ export interface ThreadMessageResponse {
      * @memberof ThreadMessageResponse
      */
     parentId: string;
+    /**
+     * Full materialized path from root
+     * @type {string}
+     * @memberof ThreadMessageResponse
+     */
+    materializedPath: string;
     /**
      * Tenant ID
      * @type {string}
@@ -95,6 +101,7 @@ export function instanceOfThreadMessageResponse(value: object): value is ThreadM
     if (!('role' in value) || value['role'] === undefined) return false;
     if (!('content' in value) || value['content'] === undefined) return false;
     if (!('parentId' in value) || value['parentId'] === undefined) return false;
+    if (!('materializedPath' in value) || value['materializedPath'] === 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;
@@ -117,6 +124,7 @@ export function ThreadMessageResponseFromJSONTyped(json: any, ignoreDiscriminato
         'role': MessageRoleFromJSON(json['role']),
         'content': json['content'],
         'parentId': json['parent_id'],
+        'materializedPath': json['materialized_path'],
         'tenantId': json['tenant_id'],
         'createdAt': (new Date(json['created_at'])),
         'updatedAt': (new Date(json['updated_at'])),
@@ -140,6 +148,7 @@ export function ThreadMessageResponseToJSONTyped(value?: ThreadMessageResponse |
         'role': MessageRoleToJSON(value['role']),
         'content': value['content'],
         'parent_id': value['parentId'],
+        'materialized_path': value['materializedPath'],
         'tenant_id': value['tenantId'],
         'created_at': value['createdAt'].toISOString(),
         'updated_at': value['updatedAt'].toISOString(),

package/src/models/ThreadResponse.ts

@@ -43,6 +43,12 @@ export interface ThreadResponse {
      * @memberof ThreadResponse
      */
     parentThreadId?: string;
+    /**
+     * Full materialized path from root
+     * @type {string}
+     * @memberof ThreadResponse
+     */
+    materializedPath: string;
     /**
      * Tenant ID
      * @type {string}
@@ -70,6 +76,7 @@ export function instanceOfThreadResponse(value: object): value is ThreadResponse
     if (!('id' in value) || value['id'] === undefined) return false;
     if (!('pathPartId' in value) || value['pathPartId'] === undefined) return false;
     if (!('title' in value) || value['title'] === undefined) return false;
+    if (!('materializedPath' in value) || value['materializedPath'] === 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;
@@ -90,6 +97,7 @@ export function ThreadResponseFromJSONTyped(json: any, ignoreDiscriminator: bool
         'pathPartId': json['path_part_id'],
         'title': json['title'],
         'parentThreadId': json['parent_thread_id'] == null ? undefined : json['parent_thread_id'],
+        'materializedPath': json['materialized_path'],
         'tenantId': json['tenant_id'],
         'createdAt': (new Date(json['created_at'])),
         'updatedAt': (new Date(json['updated_at'])),
@@ -111,6 +119,7 @@ export function ThreadResponseToJSONTyped(value?: ThreadResponse | null, ignoreD
         'path_part_id': value['pathPartId'],
         'title': value['title'],
         'parent_thread_id': value['parentThreadId'],
+        'materialized_path': value['materializedPath'],
         'tenant_id': value['tenantId'],
         'created_at': value['createdAt'].toISOString(),
         'updated_at': value['updatedAt'].toISOString(),

package/src/models/UpdatePermissionRequest.ts

@@ -0,0 +1,100 @@
+/* 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 { PermissionCapability } from './PermissionCapability';
+import {
+    PermissionCapabilityFromJSON,
+    PermissionCapabilityFromJSONTyped,
+    PermissionCapabilityToJSON,
+    PermissionCapabilityToJSONTyped,
+} from './PermissionCapability';
+
+/**
+ * 
+ * @export
+ * @interface UpdatePermissionRequest
+ */
+export interface UpdatePermissionRequest {
+    /**
+     * 
+     * @type {string}
+     * @memberof UpdatePermissionRequest
+     */
+    path?: string;
+    /**
+     * 
+     * @type {PermissionCapability}
+     * @memberof UpdatePermissionRequest
+     */
+    capability?: PermissionCapability;
+}
+
+
+
+/**
+ * Check if a given object implements the UpdatePermissionRequest interface.
+ */
+export function instanceOfUpdatePermissionRequest(value: object): value is UpdatePermissionRequest {
+    return true;
+}
+
+export function UpdatePermissionRequestFromJSON(json: any): UpdatePermissionRequest {
+    return UpdatePermissionRequestFromJSONTyped(json, false);
+}
+
+export function UpdatePermissionRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): UpdatePermissionRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'path': json['path'] == null ? undefined : json['path'],
+        'capability': json['capability'] == null ? undefined : PermissionCapabilityFromJSON(json['capability']),
+    };
+}
+
+export function UpdatePermissionRequestToJSON(json: any): UpdatePermissionRequest {
+    return UpdatePermissionRequestToJSONTyped(json, false);
+}
+
+export function UpdatePermissionRequestToJSONTyped(value?: UpdatePermissionRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'path': value['path'],
+        'capability': PermissionCapabilityToJSON(value['capability']),
+    };
+}
+
+export const UpdatePermissionRequestPropertyValidationAttributesMap: {
+    [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/index.ts

@@ -4,12 +4,14 @@ export * from './ChunkLineageResponse';
 export * from './ChunkMetadataInput';
 export * from './ChunkMetadataOutput';
 export * from './ChunkResponse';
+export * from './ChunkSearchRequest';
 export * from './ChunkType';
 export * from './CreateChunkLineageRequest';
 export * from './CreateChunkRequest';
 export * from './CreateDocumentRequest';
 export * from './CreateFolderRequest';
 export * from './CreatePasswordUserRequest';
+export * from './CreatePermissionRequest';
 export * from './CreateSectionRequest';
 export * from './CreateTagRequest';
 export * from './CreateTenantRequest';
@@ -22,6 +24,7 @@ export * from './DocumentType';
 export * from './DocumentVersionResponse';
 export * from './EmailSentResponse';
 export * from './EmailVerificationRequest';
+export * from './EmbeddingModel';
 export * from './FolderDocumentResponse';
 export * from './FolderResponse';
 export * from './HTTPValidationError';
@@ -42,6 +45,7 @@ export * from './PaginatedResponseFolderDocumentResponse';
 export * from './PaginatedResponseFolderResponse';
 export * from './PaginatedResponseInviteResponse';
 export * from './PaginatedResponsePathPartResponse';
+export * from './PaginatedResponsePermissionResponse';
 export * from './PaginatedResponseTagResponse';
 export * from './PaginatedResponseTenantResponse';
 export * from './PaginatedResponseTenantUserInTenantResponse';
@@ -52,9 +56,12 @@ export * from './PasswordResetRequest';
 export * from './PasswordResetWithTokenRequest';
 export * from './PathOrder';
 export * from './PathPartResponse';
+export * from './PermissionCapability';
+export * from './PermissionResponse';
 export * from './Polygon';
 export * from './PolygonReference';
 export * from './RootResponse';
+export * from './ScoredChunkResponse';
 export * from './SectionResponse';
 export * from './SignInRequest';
 export * from './TagPathPartRequest';
@@ -68,6 +75,7 @@ export * from './UpdateChunkContentRequest';
 export * from './UpdateChunkMetadataRequest';
 export * from './UpdateDocumentRequest';
 export * from './UpdateFolderRequest';
+export * from './UpdatePermissionRequest';
 export * from './UpdateSectionRequest';
 export * from './UpdateTagRequest';
 export * from './UpdateTenantRequest';