@knowledge-stack/ksapi 1.152.0 → 1.154.1

package/dist/models/UploadStatusResponse.d.ts

@@ -0,0 +1,54 @@
+/**
+ * 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 type { UploadPartResponse } from './UploadPartResponse';
+/**
+ * Parts S3 already holds — resume by re-sending the rest.
+ * @export
+ * @interface UploadStatusResponse
+ */
+export interface UploadStatusResponse {
+    /**
+     *
+     * @type {Array<UploadPartResponse>}
+     * @memberof UploadStatusResponse
+     */
+    parts: Array<UploadPartResponse>;
+    /**
+     *
+     * @type {number}
+     * @memberof UploadStatusResponse
+     */
+    uploadedBytes: number;
+}
+export declare const UploadStatusResponsePropertyValidationAttributesMap: {
+    [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 UploadStatusResponse interface.
+ */
+export declare function instanceOfUploadStatusResponse(value: object): value is UploadStatusResponse;
+export declare function UploadStatusResponseFromJSON(json: any): UploadStatusResponse;
+export declare function UploadStatusResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): UploadStatusResponse;
+export declare function UploadStatusResponseToJSON(json: any): UploadStatusResponse;
+export declare function UploadStatusResponseToJSONTyped(value?: UploadStatusResponse | null, ignoreDiscriminator?: boolean): any;

package/dist/models/UploadStatusResponse.js

@@ -0,0 +1,57 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UploadStatusResponsePropertyValidationAttributesMap = void 0;
+exports.instanceOfUploadStatusResponse = instanceOfUploadStatusResponse;
+exports.UploadStatusResponseFromJSON = UploadStatusResponseFromJSON;
+exports.UploadStatusResponseFromJSONTyped = UploadStatusResponseFromJSONTyped;
+exports.UploadStatusResponseToJSON = UploadStatusResponseToJSON;
+exports.UploadStatusResponseToJSONTyped = UploadStatusResponseToJSONTyped;
+const UploadPartResponse_1 = require("./UploadPartResponse");
+exports.UploadStatusResponsePropertyValidationAttributesMap = {};
+/**
+ * Check if a given object implements the UploadStatusResponse interface.
+ */
+function instanceOfUploadStatusResponse(value) {
+    if (!('parts' in value) || value['parts'] === undefined)
+        return false;
+    if (!('uploadedBytes' in value) || value['uploadedBytes'] === undefined)
+        return false;
+    return true;
+}
+function UploadStatusResponseFromJSON(json) {
+    return UploadStatusResponseFromJSONTyped(json, false);
+}
+function UploadStatusResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'parts': (json['parts'].map(UploadPartResponse_1.UploadPartResponseFromJSON)),
+        'uploadedBytes': json['uploaded_bytes'],
+    };
+}
+function UploadStatusResponseToJSON(json) {
+    return UploadStatusResponseToJSONTyped(json, false);
+}
+function UploadStatusResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'parts': (value['parts'].map(UploadPartResponse_1.UploadPartResponseToJSON)),
+        'uploaded_bytes': value['uploadedBytes'],
+    };
+}

package/dist/models/UsageMetric.d.ts

@@ -17,6 +17,7 @@ export declare const UsageMetric: {
     readonly Page: 'PAGE';
     readonly Search: 'SEARCH';
     readonly Message: 'MESSAGE';
+    readonly MediaMinute: 'MEDIA_MINUTE';
 };
 export type UsageMetric = typeof UsageMetric[keyof typeof UsageMetric];
 export declare function instanceOfUsageMetric(value: any): boolean;

package/dist/models/UsageMetric.js

@@ -26,7 +26,8 @@ exports.UsageMetricToJSONTyped = UsageMetricToJSONTyped;
 exports.UsageMetric = {
     Page: 'PAGE',
     Search: 'SEARCH',
-    Message: 'MESSAGE'
+    Message: 'MESSAGE',
+    MediaMinute: 'MEDIA_MINUTE'
 };
 function instanceOfUsageMetric(value) {
     for (const key in exports.UsageMetric) {

package/dist/models/index.d.ts

@@ -47,6 +47,7 @@ export * from './CloneWorkflowRunRequest';
 export * from './ColumnConfig';
 export * from './ColumnReference';
 export * from './CommonFileExclusionReason';
+export * from './CompleteUploadRequest';
 export * from './ConnectionConfig';
 export * from './ContentsSortOrder';
 export * from './CreateApiConnectionRequest';
@@ -67,6 +68,8 @@ export * from './CreateSkillRequest';
 export * from './CreateTagRequest';
 export * from './CreateThreadMessageRequest';
 export * from './CreateThreadRequest';
+export * from './CreateUploadRequest';
+export * from './CreateUploadResponse';
 export * from './CreateWorkflowDefinitionRequest';
 export * from './DataSourceCatalogResponse';
 export * from './DataSourceDescribeResponse';
@@ -328,6 +331,8 @@ export * from './UpdateWorkflowDefinitionRequest';
 export * from './UpdateWorkflowRunRequest';
 export * from './UploadConstraints';
 export * from './UploadFormat';
+export * from './UploadPartResponse';
+export * from './UploadStatusResponse';
 export * from './UsageMetric';
 export * from './UserInfo';
 export * from './UserMessageRequest';

package/dist/models/index.js

@@ -65,6 +65,7 @@ __exportStar(require("./CloneWorkflowRunRequest"), exports);
 __exportStar(require("./ColumnConfig"), exports);
 __exportStar(require("./ColumnReference"), exports);
 __exportStar(require("./CommonFileExclusionReason"), exports);
+__exportStar(require("./CompleteUploadRequest"), exports);
 __exportStar(require("./ConnectionConfig"), exports);
 __exportStar(require("./ContentsSortOrder"), exports);
 __exportStar(require("./CreateApiConnectionRequest"), exports);
@@ -85,6 +86,8 @@ __exportStar(require("./CreateSkillRequest"), exports);
 __exportStar(require("./CreateTagRequest"), exports);
 __exportStar(require("./CreateThreadMessageRequest"), exports);
 __exportStar(require("./CreateThreadRequest"), exports);
+__exportStar(require("./CreateUploadRequest"), exports);
+__exportStar(require("./CreateUploadResponse"), exports);
 __exportStar(require("./CreateWorkflowDefinitionRequest"), exports);
 __exportStar(require("./DataSourceCatalogResponse"), exports);
 __exportStar(require("./DataSourceDescribeResponse"), exports);
@@ -346,6 +349,8 @@ __exportStar(require("./UpdateWorkflowDefinitionRequest"), exports);
 __exportStar(require("./UpdateWorkflowRunRequest"), exports);
 __exportStar(require("./UploadConstraints"), exports);
 __exportStar(require("./UploadFormat"), exports);
+__exportStar(require("./UploadPartResponse"), exports);
+__exportStar(require("./UploadStatusResponse"), exports);
 __exportStar(require("./UsageMetric"), exports);
 __exportStar(require("./UserInfo"), exports);
 __exportStar(require("./UserMessageRequest"), exports);

package/docs/ChunkMetadata.md

@@ -13,6 +13,8 @@ Name | Type
 `summarizeForEmbedding` | boolean
 `extractedTextS3Uri` | string
 `secondaryTaxonomy` | [ImageTaxonomy](ImageTaxonomy.md)
+`startMs` | number
+`endMs` | number
 `sheetName` | string
 `blockType` | string
 `sourceUri` | string
@@ -36,6 +38,8 @@ const example = {
   "summarizeForEmbedding": null,
   "extractedTextS3Uri": null,
   "secondaryTaxonomy": null,
+  "startMs": null,
+  "endMs": null,
   "sheetName": null,
   "blockType": null,
   "sourceUri": null,

package/docs/Citation.md

@@ -10,6 +10,8 @@ Name | Type
 `quote` | string
 `startChar` | number
 `length` | number
+`startMs` | number
+`endMs` | number
 
 ## Example
 
@@ -22,6 +24,8 @@ const example = {
   "quote": null,
   "startChar": null,
   "length": null,
+  "startMs": null,
+  "endMs": null,
 } satisfies Citation
 
 console.log(example)

package/docs/CompleteUploadRequest.md

@@ -0,0 +1,35 @@
+
+# CompleteUploadRequest
+
+Finalize a resumable upload and start ingestion.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`uploadToken` | string
+
+## Example
+
+```typescript
+import type { CompleteUploadRequest } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "uploadToken": null,
+} satisfies CompleteUploadRequest
+
+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 CompleteUploadRequest
+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/docs/CreateUploadRequest.md

@@ -0,0 +1,41 @@
+
+# CreateUploadRequest
+
+Begin a resumable upload.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`parentPathId` | string
+`name` | string
+`filename` | string
+`sizeBytes` | number
+
+## Example
+
+```typescript
+import type { CreateUploadRequest } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "parentPathId": null,
+  "name": null,
+  "filename": null,
+  "sizeBytes": null,
+} satisfies CreateUploadRequest
+
+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 CreateUploadRequest
+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/docs/CreateUploadResponse.md

@@ -0,0 +1,41 @@
+
+# CreateUploadResponse
+
+Handles for a started resumable upload.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`documentId` | string
+`documentVersionId` | string
+`uploadToken` | string
+`partSize` | number
+
+## Example
+
+```typescript
+import type { CreateUploadResponse } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "documentId": null,
+  "documentVersionId": null,
+  "uploadToken": null,
+  "partSize": null,
+} satisfies CreateUploadResponse
+
+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 CreateUploadResponse
+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)
+
+