@knowledge-stack/ksapi 1.23.4 → 1.24.0

package/docs/ChunksApi.md

@@ -0,0 +1,446 @@
+# ChunksApi
+
+All URIs are relative to *http://localhost:8000*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**createChunk**](ChunksApi.md#createchunkoperation) | **POST** /v1/chunks | Create Chunk Handler |
+| [**deleteChunk**](ChunksApi.md#deletechunk) | **DELETE** /v1/chunks/{chunk_id} | Delete Chunk Handler |
+| [**getChunk**](ChunksApi.md#getchunk) | **GET** /v1/chunks/{chunk_id} | Get Chunk Handler |
+| [**searchChunks**](ChunksApi.md#searchchunks) | **POST** /v1/chunks/search | Search Chunks Handler |
+| [**updateChunkContent**](ChunksApi.md#updatechunkcontentoperation) | **PATCH** /v1/chunks/{chunk_id}/content | Update Chunk Content Handler |
+| [**updateChunkMetadata**](ChunksApi.md#updatechunkmetadataoperation) | **PATCH** /v1/chunks/{chunk_id} | Update Chunk Metadata Handler |
+
+
+
+## createChunk
+
+> ChunkResponse createChunk(createChunkRequest, ksUat)
+
+Create Chunk Handler
+
+Create a new chunk with content.  The chunk is created as a child of the specified parent (must be DOCUMENT_VERSION or SECTION). Content is deduplicated by SHA256 hash.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ChunksApi,
+} from '@knowledge-stack/ksapi';
+import type { CreateChunkOperationRequest } from '@knowledge-stack/ksapi';
+
+async function example() {
+  console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
+  const api = new ChunksApi();
+
+  const body = {
+    // CreateChunkRequest
+    createChunkRequest: ...,
+    // string (optional)
+    ksUat: ksUat_example,
+  } satisfies CreateChunkOperationRequest;
+
+  try {
+    const data = await api.createChunk(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **createChunkRequest** | [CreateChunkRequest](CreateChunkRequest.md) |  | |
+| **ksUat** | `string` |  | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**ChunkResponse**](ChunkResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **201** | 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)
+
+
+## deleteChunk
+
+> deleteChunk(chunkId, ksUat)
+
+Delete Chunk Handler
+
+Delete a chunk.  The chunk is deleted via its PathPart (cascading delete). The associated ChunkContent may remain if shared by other chunks.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ChunksApi,
+} from '@knowledge-stack/ksapi';
+import type { DeleteChunkRequest } from '@knowledge-stack/ksapi';
+
+async function example() {
+  console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
+  const api = new ChunksApi();
+
+  const body = {
+    // string
+    chunkId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // string (optional)
+    ksUat: ksUat_example,
+  } satisfies DeleteChunkRequest;
+
+  try {
+    const data = await api.deleteChunk(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **chunkId** | `string` |  | [Defaults to `undefined`] |
+| **ksUat** | `string` |  | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+`void` (Empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **204** | 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)
+
+
+## getChunk
+
+> ChunkResponse getChunk(chunkId, ksUat)
+
+Get Chunk Handler
+
+Get a chunk by its ID, including content.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ChunksApi,
+} from '@knowledge-stack/ksapi';
+import type { GetChunkRequest } from '@knowledge-stack/ksapi';
+
+async function example() {
+  console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
+  const api = new ChunksApi();
+
+  const body = {
+    // string
+    chunkId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // string (optional)
+    ksUat: ksUat_example,
+  } satisfies GetChunkRequest;
+
+  try {
+    const data = await api.getChunk(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **chunkId** | `string` |  | [Defaults to `undefined`] |
+| **ksUat** | `string` |  | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**ChunkResponse**](ChunkResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | 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)
+
+
+## searchChunks
+
+> Array<ScoredChunkResponse> searchChunks(chunkSearchRequest, ksUat)
+
+Search Chunks Handler
+
+Semantic search over chunks using vector similarity.  Combines vector similarity with path-based authorization and optional metadata filters. Uses a two-session design to avoid holding a DB connection during the external embedding API call.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ChunksApi,
+} from '@knowledge-stack/ksapi';
+import type { SearchChunksRequest } from '@knowledge-stack/ksapi';
+
+async function example() {
+  console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
+  const api = new ChunksApi();
+
+  const body = {
+    // ChunkSearchRequest
+    chunkSearchRequest: ...,
+    // string (optional)
+    ksUat: ksUat_example,
+  } satisfies SearchChunksRequest;
+
+  try {
+    const data = await api.searchChunks(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **chunkSearchRequest** | [ChunkSearchRequest](ChunkSearchRequest.md) |  | |
+| **ksUat** | `string` |  | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**Array<ScoredChunkResponse>**](ScoredChunkResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | 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)
+
+
+## updateChunkContent
+
+> ChunkResponse updateChunkContent(chunkId, updateChunkContentRequest, ksUat)
+
+Update Chunk Content Handler
+
+Update chunk content by creating a new content row.  The old content row is preserved (not deleted). If the new content matches an existing content hash, it will be deduplicated.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ChunksApi,
+} from '@knowledge-stack/ksapi';
+import type { UpdateChunkContentOperationRequest } from '@knowledge-stack/ksapi';
+
+async function example() {
+  console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
+  const api = new ChunksApi();
+
+  const body = {
+    // string
+    chunkId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // UpdateChunkContentRequest
+    updateChunkContentRequest: ...,
+    // string (optional)
+    ksUat: ksUat_example,
+  } satisfies UpdateChunkContentOperationRequest;
+
+  try {
+    const data = await api.updateChunkContent(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **chunkId** | `string` |  | [Defaults to `undefined`] |
+| **updateChunkContentRequest** | [UpdateChunkContentRequest](UpdateChunkContentRequest.md) |  | |
+| **ksUat** | `string` |  | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**ChunkResponse**](ChunkResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | 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)
+
+
+## updateChunkMetadata
+
+> ChunkResponse updateChunkMetadata(chunkId, updateChunkMetadataRequest, ksUat)
+
+Update Chunk Metadata Handler
+
+Update chunk metadata by merging with existing metadata.  The provided metadata is shallow-merged into the existing chunk_metadata.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ChunksApi,
+} from '@knowledge-stack/ksapi';
+import type { UpdateChunkMetadataOperationRequest } from '@knowledge-stack/ksapi';
+
+async function example() {
+  console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
+  const api = new ChunksApi();
+
+  const body = {
+    // string
+    chunkId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // UpdateChunkMetadataRequest
+    updateChunkMetadataRequest: ...,
+    // string (optional)
+    ksUat: ksUat_example,
+  } satisfies UpdateChunkMetadataOperationRequest;
+
+  try {
+    const data = await api.updateChunkMetadata(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **chunkId** | `string` |  | [Defaults to `undefined`] |
+| **updateChunkMetadataRequest** | [UpdateChunkMetadataRequest](UpdateChunkMetadataRequest.md) |  | |
+| **ksUat** | `string` |  | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**ChunkResponse**](ChunkResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | 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)
+

package/docs/ClearVersionContentsResponse.md

@@ -0,0 +1,35 @@
+
+# ClearVersionContentsResponse
+
+Response model for the clear version contents endpoint.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`deleted` | number
+
+## Example
+
+```typescript
+import type { ClearVersionContentsResponse } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "deleted": null,
+} satisfies ClearVersionContentsResponse
+
+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 ClearVersionContentsResponse
+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/CreateChunkLineageRequest.md

@@ -0,0 +1,37 @@
+
+# CreateChunkLineageRequest
+
+Request to batch-create lineage edges for a child chunk.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`chunkId` | string
+`parentChunkIds` | Array<string>
+
+## Example
+
+```typescript
+import type { CreateChunkLineageRequest } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "chunkId": null,
+  "parentChunkIds": null,
+} satisfies CreateChunkLineageRequest
+
+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 CreateChunkLineageRequest
+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/CreateChunkRequest.md

@@ -0,0 +1,43 @@
+
+# CreateChunkRequest
+
+Request to create a new chunk.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`parentPathId` | string
+`content` | string
+`chunkType` | [ChunkType](ChunkType.md)
+`chunkMetadata` | [ChunkMetadataInput](ChunkMetadataInput.md)
+`prevSiblingPathId` | string
+
+## Example
+
+```typescript
+import type { CreateChunkRequest } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "parentPathId": null,
+  "content": null,
+  "chunkType": null,
+  "chunkMetadata": null,
+  "prevSiblingPathId": null,
+} satisfies CreateChunkRequest
+
+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 CreateChunkRequest
+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/CreateDocumentRequest.md

@@ -0,0 +1,41 @@
+
+# CreateDocumentRequest
+
+Request to create a new document.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`parentPathPartId` | string
+`documentType` | [DocumentType](DocumentType.md)
+`documentOrigin` | [DocumentOrigin](DocumentOrigin.md)
+
+## Example
+
+```typescript
+import type { CreateDocumentRequest } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+  "parentPathPartId": null,
+  "documentType": null,
+  "documentOrigin": null,
+} satisfies CreateDocumentRequest
+
+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 CreateDocumentRequest
+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/CreateFolderRequest.md

@@ -0,0 +1,37 @@
+
+# CreateFolderRequest
+
+Request to create a new folder.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`parentPathPartId` | string
+
+## Example
+
+```typescript
+import type { CreateFolderRequest } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+  "parentPathPartId": null,
+} satisfies CreateFolderRequest
+
+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 CreateFolderRequest
+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/CreatePasswordUserRequest.md

@@ -0,0 +1,36 @@
+
+# CreatePasswordUserRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`password` | string
+`emailToken` | string
+
+## Example
+
+```typescript
+import type { CreatePasswordUserRequest } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "password": null,
+  "emailToken": null,
+} satisfies CreatePasswordUserRequest
+
+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 CreatePasswordUserRequest
+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)
+
+