@knowledge-stack/ksapi 1.25.1 → 1.27.0

package/dist/models/UserMessageRequest.d.ts

@@ -0,0 +1,47 @@
+/**
+ * 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.
+ */
+/**
+ * Request to send a user message and trigger agent generation.
+ * @export
+ * @interface UserMessageRequest
+ */
+export interface UserMessageRequest {
+    /**
+     * User input text. Mock agent dev controls may be embedded here (e.g. /mock duration=5 wps=3 scenario=tool_call_once).
+     * @type {string}
+     * @memberof UserMessageRequest
+     */
+    inputText?: string;
+}
+/**
+ * Check if a given object implements the UserMessageRequest interface.
+ */
+export declare function instanceOfUserMessageRequest(value: object): value is UserMessageRequest;
+export declare function UserMessageRequestFromJSON(json: any): UserMessageRequest;
+export declare function UserMessageRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): UserMessageRequest;
+export declare function UserMessageRequestToJSON(json: any): UserMessageRequest;
+export declare function UserMessageRequestToJSONTyped(value?: UserMessageRequest | null, ignoreDiscriminator?: boolean): any;
+export declare const UserMessageRequestPropertyValidationAttributesMap: {
+    [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/dist/models/UserMessageRequest.js

@@ -0,0 +1,50 @@
+"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.UserMessageRequestPropertyValidationAttributesMap = void 0;
+exports.instanceOfUserMessageRequest = instanceOfUserMessageRequest;
+exports.UserMessageRequestFromJSON = UserMessageRequestFromJSON;
+exports.UserMessageRequestFromJSONTyped = UserMessageRequestFromJSONTyped;
+exports.UserMessageRequestToJSON = UserMessageRequestToJSON;
+exports.UserMessageRequestToJSONTyped = UserMessageRequestToJSONTyped;
+/**
+ * Check if a given object implements the UserMessageRequest interface.
+ */
+function instanceOfUserMessageRequest(value) {
+    return true;
+}
+function UserMessageRequestFromJSON(json) {
+    return UserMessageRequestFromJSONTyped(json, false);
+}
+function UserMessageRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'inputText': json['input_text'] == null ? undefined : json['input_text'],
+    };
+}
+function UserMessageRequestToJSON(json) {
+    return UserMessageRequestToJSONTyped(json, false);
+}
+function UserMessageRequestToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'input_text': value['inputText'],
+    };
+}
+exports.UserMessageRequestPropertyValidationAttributesMap = {};

package/dist/models/UserMessageResponse.d.ts

@@ -0,0 +1,47 @@
+/**
+ * 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.
+ */
+/**
+ * 202 response from POST /{thread_id}/user_message.
+ * @export
+ * @interface UserMessageResponse
+ */
+export interface UserMessageResponse {
+    /**
+     *
+     * @type {string}
+     * @memberof UserMessageResponse
+     */
+    workflowId: string;
+}
+/**
+ * Check if a given object implements the UserMessageResponse interface.
+ */
+export declare function instanceOfUserMessageResponse(value: object): value is UserMessageResponse;
+export declare function UserMessageResponseFromJSON(json: any): UserMessageResponse;
+export declare function UserMessageResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): UserMessageResponse;
+export declare function UserMessageResponseToJSON(json: any): UserMessageResponse;
+export declare function UserMessageResponseToJSONTyped(value?: UserMessageResponse | null, ignoreDiscriminator?: boolean): any;
+export declare const UserMessageResponsePropertyValidationAttributesMap: {
+    [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/dist/models/UserMessageResponse.js

@@ -0,0 +1,52 @@
+"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.UserMessageResponsePropertyValidationAttributesMap = void 0;
+exports.instanceOfUserMessageResponse = instanceOfUserMessageResponse;
+exports.UserMessageResponseFromJSON = UserMessageResponseFromJSON;
+exports.UserMessageResponseFromJSONTyped = UserMessageResponseFromJSONTyped;
+exports.UserMessageResponseToJSON = UserMessageResponseToJSON;
+exports.UserMessageResponseToJSONTyped = UserMessageResponseToJSONTyped;
+/**
+ * Check if a given object implements the UserMessageResponse interface.
+ */
+function instanceOfUserMessageResponse(value) {
+    if (!('workflowId' in value) || value['workflowId'] === undefined)
+        return false;
+    return true;
+}
+function UserMessageResponseFromJSON(json) {
+    return UserMessageResponseFromJSONTyped(json, false);
+}
+function UserMessageResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'workflowId': json['workflow_id'],
+    };
+}
+function UserMessageResponseToJSON(json) {
+    return UserMessageResponseToJSONTyped(json, false);
+}
+function UserMessageResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'workflow_id': value['workflowId'],
+    };
+}
+exports.UserMessageResponsePropertyValidationAttributesMap = {};

package/dist/models/index.d.ts

@@ -94,6 +94,8 @@ export * from './UpdateTagRequest';
 export * from './UpdateTenantRequest';
 export * from './UpdateThreadRequest';
 export * from './UpdateUserRequest';
+export * from './UserMessageRequest';
+export * from './UserMessageResponse';
 export * from './UserResponse';
 export * from './ValidationError';
 export * from './VersionChunkIdsResponse';

package/dist/models/index.js

@@ -112,6 +112,8 @@ __exportStar(require("./UpdateTagRequest"), exports);
 __exportStar(require("./UpdateTenantRequest"), exports);
 __exportStar(require("./UpdateThreadRequest"), exports);
 __exportStar(require("./UpdateUserRequest"), exports);
+__exportStar(require("./UserMessageRequest"), exports);
+__exportStar(require("./UserMessageResponse"), exports);
 __exportStar(require("./UserResponse"), exports);
 __exportStar(require("./ValidationError"), exports);
 __exportStar(require("./VersionChunkIdsResponse"), exports);

package/docs/ChunkMetadataInput.md

@@ -9,6 +9,7 @@ Name | Type
 ------------ | -------------
 `polygons` | [Array<PolygonReference>](PolygonReference.md)
 `s3Url` | string
+`summary` | string
 
 ## Example
 
@@ -19,6 +20,7 @@ import type { ChunkMetadataInput } from '@knowledge-stack/ksapi'
 const example = {
   "polygons": null,
   "s3Url": null,
+  "summary": null,
 } satisfies ChunkMetadataInput
 
 console.log(example)

package/docs/ChunkMetadataOutput.md

@@ -9,6 +9,7 @@ Name | Type
 ------------ | -------------
 `polygons` | [Array<PolygonReference>](PolygonReference.md)
 `s3Url` | string
+`summary` | string
 
 ## Example
 
@@ -19,6 +20,7 @@ import type { ChunkMetadataOutput } from '@knowledge-stack/ksapi'
 const example = {
   "polygons": null,
   "s3Url": null,
+  "summary": null,
 } satisfies ChunkMetadataOutput
 
 console.log(example)

package/docs/ThreadsApi.md

@@ -8,6 +8,7 @@ All URIs are relative to *http://localhost:8000*
 | [**deleteThread**](ThreadsApi.md#deletethread) | **DELETE** /v1/threads/{thread_id} | Delete Thread Handler |
 | [**getThread**](ThreadsApi.md#getthread) | **GET** /v1/threads/{thread_id} | Get Thread Handler |
 | [**listThreads**](ThreadsApi.md#listthreads) | **GET** /v1/threads | List Threads Handler |
+| [**sendUserMessage**](ThreadsApi.md#sendusermessage) | **POST** /v1/threads/{thread_id}/user_message | Send User Message Handler |
 | [**streamThread**](ThreadsApi.md#streamthread) | **GET** /v1/threads/{thread_id}/stream | Stream Thread Handler |
 | [**updateThread**](ThreadsApi.md#updatethreadoperation) | **PATCH** /v1/threads/{thread_id} | Update Thread Handler |
 
@@ -303,6 +304,80 @@ No authorization required
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
 
+## sendUserMessage
+
+> UserMessageResponse sendUserMessage(threadId, userMessageRequest, ksUat)
+
+Send User Message Handler
+
+Send a user message and trigger agent generation. Returns immediately with a workflow_id.  Connect to GET /{thread_id}/stream (SSE) before or after calling this endpoint to receive the streamed output.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ThreadsApi,
+} from '@knowledge-stack/ksapi';
+import type { SendUserMessageRequest } from '@knowledge-stack/ksapi';
+
+async function example() {
+  console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
+  const api = new ThreadsApi();
+
+  const body = {
+    // string
+    threadId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // UserMessageRequest
+    userMessageRequest: ...,
+    // string (optional)
+    ksUat: ksUat_example,
+  } satisfies SendUserMessageRequest;
+
+  try {
+    const data = await api.sendUserMessage(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **threadId** | `string` |  | [Defaults to `undefined`] |
+| **userMessageRequest** | [UserMessageRequest](UserMessageRequest.md) |  | |
+| **ksUat** | `string` |  | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**UserMessageResponse**](UserMessageResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **202** | Successful Response |  -  |
+| **422** | Validation Error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
 ## streamThread
 
 > streamThread(threadId, lastMessageId, lastEntryId, ksUat)

package/docs/UserMessageRequest.md

@@ -0,0 +1,35 @@
+
+# UserMessageRequest
+
+Request to send a user message and trigger agent generation.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`inputText` | string
+
+## Example
+
+```typescript
+import type { UserMessageRequest } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "inputText": null,
+} satisfies UserMessageRequest
+
+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 UserMessageRequest
+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/UserMessageResponse.md

@@ -0,0 +1,35 @@
+
+# UserMessageResponse
+
+202 response from POST /{thread_id}/user_message.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`workflowId` | string
+
+## Example
+
+```typescript
+import type { UserMessageResponse } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "workflowId": null,
+} satisfies UserMessageResponse
+
+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 UserMessageResponse
+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/package.json

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

package/src/apis/ThreadsApi.ts

@@ -20,6 +20,8 @@ import type {
   PaginatedResponseThreadResponse,
   ThreadResponse,
   UpdateThreadRequest,
+  UserMessageRequest,
+  UserMessageResponse,
 } from '../models/index';
 import {
     CreateThreadRequestFromJSON,
@@ -32,6 +34,10 @@ import {
     ThreadResponseToJSON,
     UpdateThreadRequestFromJSON,
     UpdateThreadRequestToJSON,
+    UserMessageRequestFromJSON,
+    UserMessageRequestToJSON,
+    UserMessageResponseFromJSON,
+    UserMessageResponseToJSON,
 } from '../models/index';
 
 export interface CreateThreadOperationRequest {
@@ -56,6 +62,12 @@ export interface ListThreadsRequest {
     ksUat?: string | null;
 }
 
+export interface SendUserMessageRequest {
+    threadId: string;
+    userMessageRequest: UserMessageRequest;
+    ksUat?: string | null;
+}
+
 export interface StreamThreadRequest {
     threadId: string;
     lastMessageId?: string | null;
@@ -184,6 +196,34 @@ export interface ThreadsApiInterface {
      */
     listThreads(requestParameters: ListThreadsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseThreadResponse>;
 
+    /**
+     * Creates request options for sendUserMessage without sending the request
+     * @param {string} threadId 
+     * @param {UserMessageRequest} userMessageRequest 
+     * @param {string} [ksUat] 
+     * @throws {RequiredError}
+     * @memberof ThreadsApiInterface
+     */
+    sendUserMessageRequestOpts(requestParameters: SendUserMessageRequest): Promise<runtime.RequestOpts>;
+
+    /**
+     * Send a user message and trigger agent generation. Returns immediately with a workflow_id.  Connect to GET /{thread_id}/stream (SSE) before or after calling this endpoint to receive the streamed output.
+     * @summary Send User Message Handler
+     * @param {string} threadId 
+     * @param {UserMessageRequest} userMessageRequest 
+     * @param {string} [ksUat] 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ThreadsApiInterface
+     */
+    sendUserMessageRaw(requestParameters: SendUserMessageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserMessageResponse>>;
+
+    /**
+     * Send a user message and trigger agent generation. Returns immediately with a workflow_id.  Connect to GET /{thread_id}/stream (SSE) before or after calling this endpoint to receive the streamed output.
+     * Send User Message Handler
+     */
+    sendUserMessage(requestParameters: SendUserMessageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserMessageResponse>;
+
     /**
      * Creates request options for streamThread without sending the request
      * @param {string} threadId 
@@ -442,6 +482,63 @@ export class ThreadsApi extends runtime.BaseAPI implements ThreadsApiInterface {
         return await response.value();
     }
 
+    /**
+     * Creates request options for sendUserMessage without sending the request
+     */
+    async sendUserMessageRequestOpts(requestParameters: SendUserMessageRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['threadId'] == null) {
+            throw new runtime.RequiredError(
+                'threadId',
+                'Required parameter "threadId" was null or undefined when calling sendUserMessage().'
+            );
+        }
+
+        if (requestParameters['userMessageRequest'] == null) {
+            throw new runtime.RequiredError(
+                'userMessageRequest',
+                'Required parameter "userMessageRequest" was null or undefined when calling sendUserMessage().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+
+        let urlPath = `/v1/threads/{thread_id}/user_message`;
+        urlPath = urlPath.replace(`{${"thread_id"}}`, encodeURIComponent(String(requestParameters['threadId'])));
+
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: UserMessageRequestToJSON(requestParameters['userMessageRequest']),
+        };
+    }
+
+    /**
+     * Send a user message and trigger agent generation. Returns immediately with a workflow_id.  Connect to GET /{thread_id}/stream (SSE) before or after calling this endpoint to receive the streamed output.
+     * Send User Message Handler
+     */
+    async sendUserMessageRaw(requestParameters: SendUserMessageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserMessageResponse>> {
+        const requestOptions = await this.sendUserMessageRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => UserMessageResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Send a user message and trigger agent generation. Returns immediately with a workflow_id.  Connect to GET /{thread_id}/stream (SSE) before or after calling this endpoint to receive the streamed output.
+     * Send User Message Handler
+     */
+    async sendUserMessage(requestParameters: SendUserMessageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserMessageResponse> {
+        const response = await this.sendUserMessageRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Creates request options for streamThread without sending the request
      */

package/src/models/ChunkMetadataInput.ts

@@ -39,6 +39,12 @@ export interface ChunkMetadataInput {
      * @memberof ChunkMetadataInput
      */
     s3Url?: string | null;
+    /**
+     * LLM-generated summary of the chunk content. Used for TABLE chunks to enrich embedding text.
+     * @type {string}
+     * @memberof ChunkMetadataInput
+     */
+    summary?: string | null;
 }
 
 /**
@@ -60,6 +66,7 @@ export function ChunkMetadataInputFromJSONTyped(json: any, ignoreDiscriminator:
         
         'polygons': json['polygons'] == null ? undefined : ((json['polygons'] as Array<any>).map(PolygonReferenceFromJSON)),
         's3Url': json['s3_url'] == null ? undefined : json['s3_url'],
+        'summary': json['summary'] == null ? undefined : json['summary'],
     };
 }
 
@@ -76,6 +83,7 @@ export function ChunkMetadataInputToJSONTyped(value?: ChunkMetadataInput | null,
         
         'polygons': value['polygons'] == null ? undefined : ((value['polygons'] as Array<any>).map(PolygonReferenceToJSON)),
         's3_url': value['s3Url'],
+        'summary': value['summary'],
     };
 }
 

package/src/models/ChunkMetadataOutput.ts

@@ -39,6 +39,12 @@ export interface ChunkMetadataOutput {
      * @memberof ChunkMetadataOutput
      */
     s3Url?: string | null;
+    /**
+     * LLM-generated summary of the chunk content. Used for TABLE chunks to enrich embedding text.
+     * @type {string}
+     * @memberof ChunkMetadataOutput
+     */
+    summary?: string | null;
 }
 
 /**
@@ -60,6 +66,7 @@ export function ChunkMetadataOutputFromJSONTyped(json: any, ignoreDiscriminator:
         
         'polygons': json['polygons'] == null ? undefined : ((json['polygons'] as Array<any>).map(PolygonReferenceFromJSON)),
         's3Url': json['s3_url'] == null ? undefined : json['s3_url'],
+        'summary': json['summary'] == null ? undefined : json['summary'],
     };
 }
 
@@ -76,6 +83,7 @@ export function ChunkMetadataOutputToJSONTyped(value?: ChunkMetadataOutput | nul
         
         'polygons': value['polygons'] == null ? undefined : ((value['polygons'] as Array<any>).map(PolygonReferenceToJSON)),
         's3_url': value['s3Url'],
+        'summary': value['summary'],
     };
 }