@knowledge-stack/ksapi 1.23.5 → 1.25.0

package/docs/RootResponse.md

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

@@ -0,0 +1,65 @@
+
+# ScoredChunkResponse
+
+Chunk response with similarity score.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`pathPartId` | string
+`contentId` | string
+`content` | string
+`chunkType` | [ChunkType](ChunkType.md)
+`chunkMetadata` | [ChunkMetadataOutput](ChunkMetadataOutput.md)
+`parentPathId` | string
+`prevSiblingPathId` | string
+`nextSiblingPathId` | string
+`materializedPath` | string
+`systemManaged` | boolean
+`tenantId` | string
+`createdAt` | Date
+`updatedAt` | Date
+`assetS3Url` | string
+`score` | number
+
+## Example
+
+```typescript
+import type { ScoredChunkResponse } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "pathPartId": null,
+  "contentId": null,
+  "content": null,
+  "chunkType": null,
+  "chunkMetadata": null,
+  "parentPathId": null,
+  "prevSiblingPathId": null,
+  "nextSiblingPathId": null,
+  "materializedPath": null,
+  "systemManaged": null,
+  "tenantId": null,
+  "createdAt": null,
+  "updatedAt": null,
+  "assetS3Url": null,
+  "score": null,
+} satisfies ScoredChunkResponse
+
+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 ScoredChunkResponse
+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/SectionContentItem.md

@@ -0,0 +1,55 @@
+
+# SectionContentItem
+
+Response model for a section item in document version contents.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`partType` | string
+`pathPartId` | string
+`name` | string
+`parentPathId` | string
+`metadataObjId` | string
+`depth` | number
+`pageNumber` | number
+`materializedPath` | string
+`systemManaged` | boolean
+`createdAt` | Date
+`updatedAt` | Date
+
+## Example
+
+```typescript
+import type { SectionContentItem } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "partType": null,
+  "pathPartId": null,
+  "name": null,
+  "parentPathId": null,
+  "metadataObjId": null,
+  "depth": null,
+  "pageNumber": null,
+  "materializedPath": null,
+  "systemManaged": null,
+  "createdAt": null,
+  "updatedAt": null,
+} satisfies SectionContentItem
+
+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 SectionContentItem
+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/SectionContentItemOrChunkContentItem.md

@@ -0,0 +1,60 @@
+
+# SectionContentItemOrChunkContentItem
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`partType` | string
+`pathPartId` | string
+`name` | string
+`parentPathId` | string
+`metadataObjId` | string
+`depth` | number
+`pageNumber` | number
+`materializedPath` | string
+`systemManaged` | boolean
+`createdAt` | Date
+`updatedAt` | Date
+`content` | string
+`chunkType` | [ChunkType](ChunkType.md)
+`chunkMetadata` | [ChunkMetadataOutput](ChunkMetadataOutput.md)
+
+## Example
+
+```typescript
+import type { SectionContentItemOrChunkContentItem } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "partType": null,
+  "pathPartId": null,
+  "name": null,
+  "parentPathId": null,
+  "metadataObjId": null,
+  "depth": null,
+  "pageNumber": null,
+  "materializedPath": null,
+  "systemManaged": null,
+  "createdAt": null,
+  "updatedAt": null,
+  "content": null,
+  "chunkType": null,
+  "chunkMetadata": null,
+} satisfies SectionContentItemOrChunkContentItem
+
+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 SectionContentItemOrChunkContentItem
+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/SectionResponse.md

@@ -0,0 +1,57 @@
+
+# SectionResponse
+
+Section response model.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`pathPartId` | string
+`name` | string
+`pageNumber` | number
+`parentPathId` | string
+`prevSiblingPathId` | string
+`nextSiblingPathId` | string
+`materializedPath` | string
+`systemManaged` | boolean
+`tenantId` | string
+`createdAt` | Date
+`updatedAt` | Date
+
+## Example
+
+```typescript
+import type { SectionResponse } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "pathPartId": null,
+  "name": null,
+  "pageNumber": null,
+  "parentPathId": null,
+  "prevSiblingPathId": null,
+  "nextSiblingPathId": null,
+  "materializedPath": null,
+  "systemManaged": null,
+  "tenantId": null,
+  "createdAt": null,
+  "updatedAt": null,
+} satisfies SectionResponse
+
+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 SectionResponse
+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/SectionsApi.md

@@ -0,0 +1,299 @@
+# SectionsApi
+
+All URIs are relative to *http://localhost:8000*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**createSection**](SectionsApi.md#createsectionoperation) | **POST** /v1/sections | Create Section Handler |
+| [**deleteSection**](SectionsApi.md#deletesection) | **DELETE** /v1/sections/{section_id} | Delete Section Handler |
+| [**getSection**](SectionsApi.md#getsection) | **GET** /v1/sections/{section_id} | Get Section Handler |
+| [**updateSection**](SectionsApi.md#updatesectionoperation) | **PATCH** /v1/sections/{section_id} | Update Section Handler |
+
+
+
+## createSection
+
+> SectionResponse createSection(createSectionRequest, ksUat)
+
+Create Section Handler
+
+Create a new section.  The section is created as a child of the specified parent (must be DOCUMENT_VERSION or SECTION). If prev_sibling_path_id is provided, the section is inserted after that sibling; otherwise it is appended to the end of the sibling list.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  SectionsApi,
+} from '@knowledge-stack/ksapi';
+import type { CreateSectionOperationRequest } from '@knowledge-stack/ksapi';
+
+async function example() {
+  console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
+  const api = new SectionsApi();
+
+  const body = {
+    // CreateSectionRequest
+    createSectionRequest: ...,
+    // string (optional)
+    ksUat: ksUat_example,
+  } satisfies CreateSectionOperationRequest;
+
+  try {
+    const data = await api.createSection(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **createSectionRequest** | [CreateSectionRequest](CreateSectionRequest.md) |  | |
+| **ksUat** | `string` |  | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**SectionResponse**](SectionResponse.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)
+
+
+## deleteSection
+
+> deleteSection(sectionId, ksUat)
+
+Delete Section Handler
+
+Delete a section and all its children.  WARNING: This cascades to all child sections due to parent_id ON DELETE CASCADE.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  SectionsApi,
+} from '@knowledge-stack/ksapi';
+import type { DeleteSectionRequest } from '@knowledge-stack/ksapi';
+
+async function example() {
+  console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
+  const api = new SectionsApi();
+
+  const body = {
+    // string
+    sectionId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // string (optional)
+    ksUat: ksUat_example,
+  } satisfies DeleteSectionRequest;
+
+  try {
+    const data = await api.deleteSection(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **sectionId** | `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)
+
+
+## getSection
+
+> SectionResponse getSection(sectionId, ksUat)
+
+Get Section Handler
+
+Get a section by its ID.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  SectionsApi,
+} from '@knowledge-stack/ksapi';
+import type { GetSectionRequest } from '@knowledge-stack/ksapi';
+
+async function example() {
+  console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
+  const api = new SectionsApi();
+
+  const body = {
+    // string
+    sectionId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // string (optional)
+    ksUat: ksUat_example,
+  } satisfies GetSectionRequest;
+
+  try {
+    const data = await api.getSection(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **sectionId** | `string` |  | [Defaults to `undefined`] |
+| **ksUat** | `string` |  | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**SectionResponse**](SectionResponse.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)
+
+
+## updateSection
+
+> SectionResponse updateSection(sectionId, updateSectionRequest, ksUat)
+
+Update Section Handler
+
+Update a section.  Can update name, page_number, and/or reorder within siblings. To move: provide prev_sibling_path_id OR move_to_head (not both). Moving is only allowed within the same document version.  Note: Section names can contain any characters. The corresponding path_part.name will be automatically normalized by a database trigger.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  SectionsApi,
+} from '@knowledge-stack/ksapi';
+import type { UpdateSectionOperationRequest } from '@knowledge-stack/ksapi';
+
+async function example() {
+  console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
+  const api = new SectionsApi();
+
+  const body = {
+    // string
+    sectionId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // UpdateSectionRequest
+    updateSectionRequest: ...,
+    // string (optional)
+    ksUat: ksUat_example,
+  } satisfies UpdateSectionOperationRequest;
+
+  try {
+    const data = await api.updateSection(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **sectionId** | `string` |  | [Defaults to `undefined`] |
+| **updateSectionRequest** | [UpdateSectionRequest](UpdateSectionRequest.md) |  | |
+| **ksUat** | `string` |  | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**SectionResponse**](SectionResponse.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/SignInRequest.md

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

@@ -0,0 +1,39 @@
+
+# SubtreeChunkGroup
+
+A group of chunks sharing identical path_part_ids and tag_ids.  Used by PathPartCRUDService.resolve_subtree_chunks to batch downstream Qdrant set_payload calls.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`chunkIds` | Array<string>
+`pathPartIds` | Array<string>
+`tagIds` | Array<string>
+
+## Example
+
+```typescript
+import type { SubtreeChunkGroup } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "chunkIds": null,
+  "pathPartIds": null,
+  "tagIds": null,
+} satisfies SubtreeChunkGroup
+
+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 SubtreeChunkGroup
+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/SubtreeChunksResponse.md

@@ -0,0 +1,35 @@
+
+# SubtreeChunksResponse
+
+Response for subtree resolution.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`groups` | [Array<SubtreeChunkGroup>](SubtreeChunkGroup.md)
+
+## Example
+
+```typescript
+import type { SubtreeChunksResponse } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "groups": null,
+} satisfies SubtreeChunksResponse
+
+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 SubtreeChunksResponse
+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)
+
+