@knowledge-stack/ksapi 1.156.0 → 1.157.0

package/src/models/DocumentVersionMetadataUpdate.ts

@@ -80,6 +80,12 @@ export interface DocumentVersionMetadataUpdate {
      * @memberof DocumentVersionMetadataUpdate
      */
     fastPlaintextS3?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof DocumentVersionMetadataUpdate
+     */
+    transcriptS3?: string | null;
     /**
      * 
      * @type {string}
@@ -188,6 +194,12 @@ export interface DocumentVersionMetadataUpdate {
      * @memberof DocumentVersionMetadataUpdate
      */
     quotaPageCount?: number | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof DocumentVersionMetadataUpdate
+     */
+    quotaMediaMinutes?: number | null;
     /**
      * 
      * @type {string}
@@ -242,6 +254,7 @@ export function DocumentVersionMetadataUpdateFromJSONTyped(json: any, ignoreDisc
         'citedSourceS3': json['cited_source_s3'] == null ? undefined : json['cited_source_s3'],
         'standardPipelineJsonS3': json['standard_pipeline_json_s3'] == null ? undefined : json['standard_pipeline_json_s3'],
         'fastPlaintextS3': json['fast_plaintext_s3'] == null ? undefined : json['fast_plaintext_s3'],
+        'transcriptS3': json['transcript_s3'] == null ? undefined : json['transcript_s3'],
         'highAccuracyContentListS3': json['high_accuracy_content_list_s3'] == null ? undefined : json['high_accuracy_content_list_s3'],
         'highAccuracyMiddleS3': json['high_accuracy_middle_s3'] == null ? undefined : json['high_accuracy_middle_s3'],
         'hash': json['hash'] == null ? undefined : json['hash'],
@@ -260,6 +273,7 @@ export function DocumentVersionMetadataUpdateFromJSONTyped(json: any, ignoreDisc
         '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'],
+        'quotaMediaMinutes': json['quota_media_minutes'] == null ? undefined : json['quota_media_minutes'],
         'quotaIdempotencyKey': json['quota_idempotency_key'] == null ? undefined : json['quota_idempotency_key'],
         'fileMd5': json['file_md5'] == null ? undefined : json['file_md5'],
     };
@@ -282,6 +296,7 @@ export function DocumentVersionMetadataUpdateToJSONTyped(value?: DocumentVersion
         'cited_source_s3': value['citedSourceS3'],
         'standard_pipeline_json_s3': value['standardPipelineJsonS3'],
         'fast_plaintext_s3': value['fastPlaintextS3'],
+        'transcript_s3': value['transcriptS3'],
         'high_accuracy_content_list_s3': value['highAccuracyContentListS3'],
         'high_accuracy_middle_s3': value['highAccuracyMiddleS3'],
         'hash': value['hash'],
@@ -300,6 +315,7 @@ export function DocumentVersionMetadataUpdateToJSONTyped(value?: DocumentVersion
         'information_statistics': InformationStatisticsToJSON(value['informationStatistics']),
         'quota_charged': value['quotaCharged'],
         'quota_page_count': value['quotaPageCount'],
+        'quota_media_minutes': value['quotaMediaMinutes'],
         'quota_idempotency_key': value['quotaIdempotencyKey'],
         'file_md5': value['fileMd5'],
     };

package/src/models/DocumentVersionResponse.ts

@@ -121,6 +121,12 @@ export interface DocumentVersionResponse {
      * @memberof DocumentVersionResponse
      */
     fastPlaintextUrl?: string | null;
+    /**
+     * Presigned URL (6-hour validity) to the ASR transcript JSON with per-segment start_ms/end_ms/text; null for non-media. Chunks pack many segments into one, so this is what a client reads to follow a recording line by line.
+     * @type {string}
+     * @memberof DocumentVersionResponse
+     */
+    transcriptUrl?: string | null;
     /**
      * Presigned URLs (6-hour validity) to per-page WEBP screenshots in page order: index 0 is page 1, index N-1 is page N. Populated only when the request includes include_page_screenshots=true; null otherwise.
      * @type {Array<string>}
@@ -194,6 +200,7 @@ export function DocumentVersionResponseFromJSONTyped(json: any, ignoreDiscrimina
         'assetS3Url': json['asset_s3_url'] == null ? undefined : json['asset_s3_url'],
         'citedAssetS3Url': json['cited_asset_s3_url'] == null ? undefined : json['cited_asset_s3_url'],
         'fastPlaintextUrl': json['fast_plaintext_url'] == null ? undefined : json['fast_plaintext_url'],
+        'transcriptUrl': json['transcript_url'] == null ? undefined : json['transcript_url'],
         'pageScreenshotUrls': json['page_screenshot_urls'] == null ? undefined : json['page_screenshot_urls'],
         'systemMetadata': json['system_metadata'] == null ? undefined : DocumentVersionMetadataFromJSON(json['system_metadata']),
     };
@@ -224,6 +231,7 @@ export function DocumentVersionResponseToJSONTyped(value?: DocumentVersionRespon
         'asset_s3_url': value['assetS3Url'],
         'cited_asset_s3_url': value['citedAssetS3Url'],
         'fast_plaintext_url': value['fastPlaintextUrl'],
+        'transcript_url': value['transcriptUrl'],
         'page_screenshot_urls': value['pageScreenshotUrls'],
         'system_metadata': DocumentVersionMetadataToJSON(value['systemMetadata']),
     };

package/src/models/DownloadArtifact.ts

@@ -19,7 +19,8 @@
  */
 export const DownloadArtifact = {
     Source: 'source',
-    FastPlaintext: 'fast_plaintext'
+    FastPlaintext: 'fast_plaintext',
+    Transcript: 'transcript'
 } as const;
 export type DownloadArtifact = typeof DownloadArtifact[keyof typeof DownloadArtifact];
 

package/src/models/SegmentSpan.ts

@@ -0,0 +1,104 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Knowledge Stack API
+ * Knowledge Stack backend API for authentication and knowledge management.  ## Integrating (RPA / machine clients)  **Base URL.** Knowledge Stack is self-hosted — point at your own deployment host (see `servers`). The `localhost` entry is for local development only.  **Authentication.** Send `Authorization: Bearer <api-key>` on every request. Mint an API key once via `POST /v1/api-keys` from a signed-in browser session; the raw `sk-user-...` secret is returned **only** at creation, so store it then. A key inherits its owning user\'s live tenant role and path permissions — create RPA keys from a least-privilege user, and set `expires_at` for rotation. The `ks_uat` cookie scheme is browser-only and cannot be used by headless clients.  **Async work is polled, not pushed.** There are no outbound webhooks. - `POST /v1/documents/ingest` returns `201` immediately with a `workflow_id`;   poll `GET /v1/system-jobs/document_versions/{workflow_id}` until `status` is   terminal (anything other than `pending`/`processing`). The `Location` response   header points at this poll resource. - `POST /v1/workflow-runs/{run_id}/start` returns `202`; poll   `GET /v1/workflow-runs/{run_id}` until `execution_state` is `COMPLETED` or   `FAILED`. The `Location` header points at the run resource. - `POST /v1/agent/ask` is **synchronous** — it blocks until the agent finishes   and returns the answer inline. Use a generous HTTP timeout.  **Pagination.** List endpoints accept `limit`/`offset` and return `{items, total, limit, offset}`.  **Errors.** Every non-2xx body is `{detail, code, request_id}`. `code` is a stable value from a closed set (see the `ErrorResponse` schema\'s `code` enum) — branch on it rather than parsing `detail`. Quota rejections return `429` with a `Retry-After` header; transient lock contention returns a retryable `503`. Quote `request_id` (also the `x-request-id` response header) to support.  **Idempotency.** `POST /v1/workflow-runs` accepts an `idempotency_key` to dedupe retried run creation. `agent/ask` charges one message *before* running and does not refund a client-cancelled call. 
+ *
+ * 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';
+/**
+ * One ASR segment's span inside a media chunk (media chunks only).
+ * 
+ * Field names are deliberately compact — a media document stores hundreds
+ * of chunks x up to ~15 spans each in ``chunk_metadata`` JSONB.
+ * @export
+ * @interface SegmentSpan
+ */
+export interface SegmentSpan {
+    /**
+     * Segment start in the media, ms from start.
+     * @type {number}
+     * @memberof SegmentSpan
+     */
+    s: number;
+    /**
+     * Segment end in the media, ms from start.
+     * @type {number}
+     * @memberof SegmentSpan
+     */
+    e: number;
+    /**
+     * Character offset of this segment's text within the chunk's joined content — maps a position in the chunk text back to a moment in the recording.
+     * @type {number}
+     * @memberof SegmentSpan
+     */
+    c: number;
+}
+export const SegmentSpanPropertyValidationAttributesMap: {
+    [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 SegmentSpan interface.
+ */
+export function instanceOfSegmentSpan(value: object): value is SegmentSpan {
+    if (!('s' in value) || value['s'] === undefined) return false;
+    if (!('e' in value) || value['e'] === undefined) return false;
+    if (!('c' in value) || value['c'] === undefined) return false;
+    return true;
+}
+
+export function SegmentSpanFromJSON(json: any): SegmentSpan {
+    return SegmentSpanFromJSONTyped(json, false);
+}
+
+export function SegmentSpanFromJSONTyped(json: any, ignoreDiscriminator: boolean): SegmentSpan {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        's': json['s'],
+        'e': json['e'],
+        'c': json['c'],
+    };
+}
+
+export function SegmentSpanToJSON(json: any): SegmentSpan {
+    return SegmentSpanToJSONTyped(json, false);
+}
+
+export function SegmentSpanToJSONTyped(value?: SegmentSpan | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        's': value['s'],
+        'e': value['e'],
+        'c': value['c'],
+    };
+}
+

package/src/models/UploadConstraints.ts

@@ -45,6 +45,18 @@ export interface UploadConstraints {
      * @memberof UploadConstraints
      */
     maxImageBytes: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof UploadConstraints
+     */
+    maxMediaBytes: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof UploadConstraints
+     */
+    maxVideoBytes: number;
 }
 export const UploadConstraintsPropertyValidationAttributesMap: {
     [property: string]: {
@@ -71,6 +83,8 @@ export function instanceOfUploadConstraints(value: object): value is UploadConst
     if (!('formats' in value) || value['formats'] === undefined) return false;
     if (!('maxBytes' in value) || value['maxBytes'] === undefined) return false;
     if (!('maxImageBytes' in value) || value['maxImageBytes'] === undefined) return false;
+    if (!('maxMediaBytes' in value) || value['maxMediaBytes'] === undefined) return false;
+    if (!('maxVideoBytes' in value) || value['maxVideoBytes'] === undefined) return false;
     return true;
 }
 
@@ -87,6 +101,8 @@ export function UploadConstraintsFromJSONTyped(json: any, ignoreDiscriminator: b
         'formats': ((json['formats'] as Array<any>).map(UploadFormatFromJSON)),
         'maxBytes': json['max_bytes'],
         'maxImageBytes': json['max_image_bytes'],
+        'maxMediaBytes': json['max_media_bytes'],
+        'maxVideoBytes': json['max_video_bytes'],
     };
 }
 
@@ -104,6 +120,8 @@ export function UploadConstraintsToJSONTyped(value?: UploadConstraints | null, i
         'formats': ((value['formats'] as Array<any>).map(UploadFormatToJSON)),
         'max_bytes': value['maxBytes'],
         'max_image_bytes': value['maxImageBytes'],
+        'max_media_bytes': value['maxMediaBytes'],
+        'max_video_bytes': value['maxVideoBytes'],
     };
 }
 

package/src/models/index.ts

@@ -267,6 +267,7 @@ export * from './SectionContentItem';
 export * from './SectionContentItemOrChunkContentItem';
 export * from './SectionResponse';
 export * from './SectionSystemMetadata';
+export * from './SegmentSpan';
 export * from './SendPasswordResetRequest';
 export * from './SetApprovalStateRequest';
 export * from './SetWorkflowRunApprovalRequest';