@knowledge-stack/ksapi 1.72.4 → 1.78.0

package/dist/models/ChunkMetadataOutput.d.ts

@@ -1,135 +0,0 @@
-/**
- * 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 type { ImageTaxonomy } from './ImageTaxonomy';
-import type { PolygonReference } from './PolygonReference';
-/**
- * Metadata for a chunk including source document references.
- * @export
- * @interface ChunkMetadataOutput
- */
-export interface ChunkMetadataOutput {
-    /**
-     * List of bounding boxes in the source document for the chunk, potentially from multiple areas of multiple pages.
-     * @type {Array<PolygonReference>}
-     * @memberof ChunkMetadataOutput
-     */
-    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 ChunkMetadataOutput
-     */
-    s3Urls?: Array<string>;
-    /**
-     * LLM-generated summary of the chunk content. Used for TABLE and HTML chunks to enrich embedding text.
-     * @type {string}
-     * @memberof ChunkMetadataOutput
-     */
-    summary?: string | null;
-    /**
-     * S3 URI to extracted PDF text used for LLM grounding during enrichment
-     * @type {string}
-     * @memberof ChunkMetadataOutput
-     */
-    extractedTextS3Uri?: string | null;
-    /**
-     *
-     * @type {ImageTaxonomy}
-     * @memberof ChunkMetadataOutput
-     */
-    secondaryTaxonomy?: ImageTaxonomy;
-    /**
-     * Worksheet name this chunk was extracted from (XLSX only)
-     * @type {string}
-     * @memberof ChunkMetadataOutput
-     */
-    sheetName?: string | null;
-    /**
-     * XLSXParser block type (e.g. table, calculation_block, chart_anchor)
-     * @type {string}
-     * @memberof ChunkMetadataOutput
-     */
-    blockType?: string | null;
-    /**
-     * Cell range URI reference in the source workbook (XLSX only)
-     * @type {string}
-     * @memberof ChunkMetadataOutput
-     */
-    sourceUri?: string | null;
-    /**
-     * Rendered HTML for non-table XLSX chunks (tables use render_html as content)
-     * @type {string}
-     * @memberof ChunkMetadataOutput
-     */
-    enrichedHtml?: string | null;
-    /**
-     * Cell address range, e.g. 'A1:D10' (XLSX only)
-     * @type {string}
-     * @memberof ChunkMetadataOutput
-     */
-    cellRange?: string | null;
-    /**
-     * Upstream/downstream/cross-sheet cell references for audit reasoning (XLSX only)
-     * @type {{ [key: string]: any; }}
-     * @memberof ChunkMetadataOutput
-     */
-    dependencySummary?: {
-        [key: string]: any;
-    } | null;
-    /**
-     * Formula cells in this chunk as [{address, formula, value}] (XLSX only)
-     * @type {Array<{ [key: string]: string; }>}
-     * @memberof ChunkMetadataOutput
-     */
-    formulas?: Array<{
-        [key: string]: string;
-    }> | null;
-    /**
-     * Notable output/header cells for quick identification (XLSX only)
-     * @type {Array<{ [key: string]: any; }>}
-     * @memberof ChunkMetadataOutput
-     */
-    keyCells?: Array<{
-        [key: string]: any;
-    }> | null;
-    /**
-     * Named ranges overlapping this chunk (XLSX only)
-     * @type {Array<{ [key: string]: any; }>}
-     * @memberof ChunkMetadataOutput
-     */
-    namedRanges?: Array<{
-        [key: string]: any;
-    }> | null;
-}
-export declare const ChunkMetadataOutputPropertyValidationAttributesMap: {
-    [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 ChunkMetadataOutput interface.
- */
-export declare function instanceOfChunkMetadataOutput(value: object): value is ChunkMetadataOutput;
-export declare function ChunkMetadataOutputFromJSON(json: any): ChunkMetadataOutput;
-export declare function ChunkMetadataOutputFromJSONTyped(json: any, ignoreDiscriminator: boolean): ChunkMetadataOutput;
-export declare function ChunkMetadataOutputToJSON(json: any): ChunkMetadataOutput;
-export declare function ChunkMetadataOutputToJSONTyped(value?: ChunkMetadataOutput | null, ignoreDiscriminator?: boolean): any;

package/dist/models/ChunkMetadataOutput.js

@@ -1,78 +0,0 @@
-"use strict";
-/* 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.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ChunkMetadataOutputPropertyValidationAttributesMap = void 0;
-exports.instanceOfChunkMetadataOutput = instanceOfChunkMetadataOutput;
-exports.ChunkMetadataOutputFromJSON = ChunkMetadataOutputFromJSON;
-exports.ChunkMetadataOutputFromJSONTyped = ChunkMetadataOutputFromJSONTyped;
-exports.ChunkMetadataOutputToJSON = ChunkMetadataOutputToJSON;
-exports.ChunkMetadataOutputToJSONTyped = ChunkMetadataOutputToJSONTyped;
-const ImageTaxonomy_1 = require("./ImageTaxonomy");
-const PolygonReference_1 = require("./PolygonReference");
-exports.ChunkMetadataOutputPropertyValidationAttributesMap = {};
-/**
- * Check if a given object implements the ChunkMetadataOutput interface.
- */
-function instanceOfChunkMetadataOutput(value) {
-    return true;
-}
-function ChunkMetadataOutputFromJSON(json) {
-    return ChunkMetadataOutputFromJSONTyped(json, false);
-}
-function ChunkMetadataOutputFromJSONTyped(json, ignoreDiscriminator) {
-    if (json == null) {
-        return json;
-    }
-    return {
-        'polygons': json['polygons'] == null ? undefined : (json['polygons'].map(PolygonReference_1.PolygonReferenceFromJSON)),
-        's3Urls': json['s3_urls'] == null ? undefined : json['s3_urls'],
-        'summary': json['summary'] == null ? undefined : json['summary'],
-        'extractedTextS3Uri': json['extracted_text_s3_uri'] == null ? undefined : json['extracted_text_s3_uri'],
-        'secondaryTaxonomy': json['secondary_taxonomy'] == null ? undefined : (0, ImageTaxonomy_1.ImageTaxonomyFromJSON)(json['secondary_taxonomy']),
-        'sheetName': json['sheet_name'] == null ? undefined : json['sheet_name'],
-        'blockType': json['block_type'] == null ? undefined : json['block_type'],
-        'sourceUri': json['source_uri'] == null ? undefined : json['source_uri'],
-        'enrichedHtml': json['enriched_html'] == null ? undefined : json['enriched_html'],
-        'cellRange': json['cell_range'] == null ? undefined : json['cell_range'],
-        'dependencySummary': json['dependency_summary'] == null ? undefined : json['dependency_summary'],
-        'formulas': json['formulas'] == null ? undefined : json['formulas'],
-        'keyCells': json['key_cells'] == null ? undefined : json['key_cells'],
-        'namedRanges': json['named_ranges'] == null ? undefined : json['named_ranges'],
-    };
-}
-function ChunkMetadataOutputToJSON(json) {
-    return ChunkMetadataOutputToJSONTyped(json, false);
-}
-function ChunkMetadataOutputToJSONTyped(value, ignoreDiscriminator = false) {
-    if (value == null) {
-        return value;
-    }
-    return {
-        'polygons': value['polygons'] == null ? undefined : (value['polygons'].map(PolygonReference_1.PolygonReferenceToJSON)),
-        's3_urls': value['s3Urls'],
-        'summary': value['summary'],
-        'extracted_text_s3_uri': value['extractedTextS3Uri'],
-        'secondary_taxonomy': (0, ImageTaxonomy_1.ImageTaxonomyToJSON)(value['secondaryTaxonomy']),
-        'sheet_name': value['sheetName'],
-        'block_type': value['blockType'],
-        'source_uri': value['sourceUri'],
-        'enriched_html': value['enrichedHtml'],
-        'cell_range': value['cellRange'],
-        'dependency_summary': value['dependencySummary'],
-        'formulas': value['formulas'],
-        'key_cells': value['keyCells'],
-        'named_ranges': value['namedRanges'],
-    };
-}

package/docs/ChunkMetadataOutput.md

@@ -1,61 +0,0 @@
-
-# ChunkMetadataOutput
-
-Metadata for a chunk including source document references.
-
-## Properties
-
-Name | Type
------------- | -------------
-`polygons` | [Array<PolygonReference>](PolygonReference.md)
-`s3Urls` | Array<string>
-`summary` | string
-`extractedTextS3Uri` | string
-`secondaryTaxonomy` | [ImageTaxonomy](ImageTaxonomy.md)
-`sheetName` | string
-`blockType` | string
-`sourceUri` | string
-`enrichedHtml` | string
-`cellRange` | string
-`dependencySummary` | { [key: string]: any; }
-`formulas` | Array<{ [key: string]: string; }>
-`keyCells` | Array<{ [key: string]: any; }>
-`namedRanges` | Array<{ [key: string]: any; }>
-
-## Example
-
-```typescript
-import type { ChunkMetadataOutput } from '@knowledge-stack/ksapi'
-
-// TODO: Update the object below with actual values
-const example = {
-  "polygons": null,
-  "s3Urls": null,
-  "summary": null,
-  "extractedTextS3Uri": null,
-  "secondaryTaxonomy": null,
-  "sheetName": null,
-  "blockType": null,
-  "sourceUri": null,
-  "enrichedHtml": null,
-  "cellRange": null,
-  "dependencySummary": null,
-  "formulas": null,
-  "keyCells": null,
-  "namedRanges": null,
-} satisfies ChunkMetadataOutput
-
-console.log(example)
-
-// Convert the instance to a JSON string
-const exampleJSON: string = JSON.stringify(example)
-console.log(exampleJSON)
-
-// Parse the JSON string back to an object
-const exampleParsed = JSON.parse(exampleJSON) as ChunkMetadataOutput
-console.log(exampleParsed)
-```
-
-[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
-
-

package/src/models/ChunkMetadataOutput.ts

@@ -1,203 +0,0 @@
-/* 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 { ImageTaxonomy } from './ImageTaxonomy';
-import {
-    ImageTaxonomyFromJSON,
-    ImageTaxonomyFromJSONTyped,
-    ImageTaxonomyToJSON,
-    ImageTaxonomyToJSONTyped,
-} from './ImageTaxonomy';
-import type { PolygonReference } from './PolygonReference';
-import {
-    PolygonReferenceFromJSON,
-    PolygonReferenceFromJSONTyped,
-    PolygonReferenceToJSON,
-    PolygonReferenceToJSONTyped,
-} from './PolygonReference';
-
-/**
- * Metadata for a chunk including source document references.
- * @export
- * @interface ChunkMetadataOutput
- */
-export interface ChunkMetadataOutput {
-    /**
-     * List of bounding boxes in the source document for the chunk, potentially from multiple areas of multiple pages.
-     * @type {Array<PolygonReference>}
-     * @memberof ChunkMetadataOutput
-     */
-    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 ChunkMetadataOutput
-     */
-    s3Urls?: Array<string>;
-    /**
-     * LLM-generated summary of the chunk content. Used for TABLE and HTML chunks to enrich embedding text.
-     * @type {string}
-     * @memberof ChunkMetadataOutput
-     */
-    summary?: string | null;
-    /**
-     * S3 URI to extracted PDF text used for LLM grounding during enrichment
-     * @type {string}
-     * @memberof ChunkMetadataOutput
-     */
-    extractedTextS3Uri?: string | null;
-    /**
-     * 
-     * @type {ImageTaxonomy}
-     * @memberof ChunkMetadataOutput
-     */
-    secondaryTaxonomy?: ImageTaxonomy;
-    /**
-     * Worksheet name this chunk was extracted from (XLSX only)
-     * @type {string}
-     * @memberof ChunkMetadataOutput
-     */
-    sheetName?: string | null;
-    /**
-     * XLSXParser block type (e.g. table, calculation_block, chart_anchor)
-     * @type {string}
-     * @memberof ChunkMetadataOutput
-     */
-    blockType?: string | null;
-    /**
-     * Cell range URI reference in the source workbook (XLSX only)
-     * @type {string}
-     * @memberof ChunkMetadataOutput
-     */
-    sourceUri?: string | null;
-    /**
-     * Rendered HTML for non-table XLSX chunks (tables use render_html as content)
-     * @type {string}
-     * @memberof ChunkMetadataOutput
-     */
-    enrichedHtml?: string | null;
-    /**
-     * Cell address range, e.g. 'A1:D10' (XLSX only)
-     * @type {string}
-     * @memberof ChunkMetadataOutput
-     */
-    cellRange?: string | null;
-    /**
-     * Upstream/downstream/cross-sheet cell references for audit reasoning (XLSX only)
-     * @type {{ [key: string]: any; }}
-     * @memberof ChunkMetadataOutput
-     */
-    dependencySummary?: { [key: string]: any; } | null;
-    /**
-     * Formula cells in this chunk as [{address, formula, value}] (XLSX only)
-     * @type {Array<{ [key: string]: string; }>}
-     * @memberof ChunkMetadataOutput
-     */
-    formulas?: Array<{ [key: string]: string; }> | null;
-    /**
-     * Notable output/header cells for quick identification (XLSX only)
-     * @type {Array<{ [key: string]: any; }>}
-     * @memberof ChunkMetadataOutput
-     */
-    keyCells?: Array<{ [key: string]: any; }> | null;
-    /**
-     * Named ranges overlapping this chunk (XLSX only)
-     * @type {Array<{ [key: string]: any; }>}
-     * @memberof ChunkMetadataOutput
-     */
-    namedRanges?: Array<{ [key: string]: any; }> | null;
-}
-
-
-export const ChunkMetadataOutputPropertyValidationAttributesMap: {
-    [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 ChunkMetadataOutput interface.
- */
-export function instanceOfChunkMetadataOutput(value: object): value is ChunkMetadataOutput {
-    return true;
-}
-
-export function ChunkMetadataOutputFromJSON(json: any): ChunkMetadataOutput {
-    return ChunkMetadataOutputFromJSONTyped(json, false);
-}
-
-export function ChunkMetadataOutputFromJSONTyped(json: any, ignoreDiscriminator: boolean): ChunkMetadataOutput {
-    if (json == null) {
-        return json;
-    }
-    return {
-        
-        'polygons': json['polygons'] == null ? undefined : ((json['polygons'] as Array<any>).map(PolygonReferenceFromJSON)),
-        's3Urls': json['s3_urls'] == null ? undefined : json['s3_urls'],
-        'summary': json['summary'] == null ? undefined : json['summary'],
-        'extractedTextS3Uri': json['extracted_text_s3_uri'] == null ? undefined : json['extracted_text_s3_uri'],
-        'secondaryTaxonomy': json['secondary_taxonomy'] == null ? undefined : ImageTaxonomyFromJSON(json['secondary_taxonomy']),
-        'sheetName': json['sheet_name'] == null ? undefined : json['sheet_name'],
-        'blockType': json['block_type'] == null ? undefined : json['block_type'],
-        'sourceUri': json['source_uri'] == null ? undefined : json['source_uri'],
-        'enrichedHtml': json['enriched_html'] == null ? undefined : json['enriched_html'],
-        'cellRange': json['cell_range'] == null ? undefined : json['cell_range'],
-        'dependencySummary': json['dependency_summary'] == null ? undefined : json['dependency_summary'],
-        'formulas': json['formulas'] == null ? undefined : json['formulas'],
-        'keyCells': json['key_cells'] == null ? undefined : json['key_cells'],
-        'namedRanges': json['named_ranges'] == null ? undefined : json['named_ranges'],
-    };
-}
-
-export function ChunkMetadataOutputToJSON(json: any): ChunkMetadataOutput {
-    return ChunkMetadataOutputToJSONTyped(json, false);
-}
-
-export function ChunkMetadataOutputToJSONTyped(value?: ChunkMetadataOutput | null, ignoreDiscriminator: boolean = false): any {
-    if (value == null) {
-        return value;
-    }
-
-    return {
-        
-        'polygons': value['polygons'] == null ? undefined : ((value['polygons'] as Array<any>).map(PolygonReferenceToJSON)),
-        's3_urls': value['s3Urls'],
-        'summary': value['summary'],
-        'extracted_text_s3_uri': value['extractedTextS3Uri'],
-        'secondary_taxonomy': ImageTaxonomyToJSON(value['secondaryTaxonomy']),
-        'sheet_name': value['sheetName'],
-        'block_type': value['blockType'],
-        'source_uri': value['sourceUri'],
-        'enriched_html': value['enrichedHtml'],
-        'cell_range': value['cellRange'],
-        'dependency_summary': value['dependencySummary'],
-        'formulas': value['formulas'],
-        'key_cells': value['keyCells'],
-        'named_ranges': value['namedRanges'],
-    };
-}
-