@knowledge-stack/ksapi 1.23.4 → 1.24.0

package/docs/BulkTagRequest.md

@@ -0,0 +1,35 @@
+
+# BulkTagRequest
+
+Request to bulk add or remove tags from a path part.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`tagIds` | Array<string>
+
+## Example
+
+```typescript
+import type { BulkTagRequest } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "tagIds": null,
+} satisfies BulkTagRequest
+
+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 BulkTagRequest
+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/ChunkContentItem.md

@@ -0,0 +1,59 @@
+
+# ChunkContentItem
+
+Response model for a chunk item in document version contents.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`partType` | string
+`pathPartId` | string
+`name` | string
+`parentPathId` | string
+`metadataObjId` | string
+`depth` | number
+`content` | string
+`chunkType` | [ChunkType](ChunkType.md)
+`chunkMetadata` | [ChunkMetadataOutput](ChunkMetadataOutput.md)
+`materializedPath` | string
+`systemManaged` | boolean
+`createdAt` | Date
+`updatedAt` | Date
+
+## Example
+
+```typescript
+import type { ChunkContentItem } 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,
+  "content": null,
+  "chunkType": null,
+  "chunkMetadata": null,
+  "materializedPath": null,
+  "systemManaged": null,
+  "createdAt": null,
+  "updatedAt": null,
+} satisfies ChunkContentItem
+
+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 ChunkContentItem
+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/ChunkLineageResponse.md

@@ -0,0 +1,41 @@
+
+# ChunkLineageResponse
+
+Single chunk lineage edge response.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`parentChunkId` | string
+`chunkId` | string
+`tenantId` | string
+`createdAt` | Date
+
+## Example
+
+```typescript
+import type { ChunkLineageResponse } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "parentChunkId": null,
+  "chunkId": null,
+  "tenantId": null,
+  "createdAt": null,
+} satisfies ChunkLineageResponse
+
+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 ChunkLineageResponse
+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/ChunkLineagesApi.md

@@ -0,0 +1,230 @@
+# ChunkLineagesApi
+
+All URIs are relative to *http://localhost:8000*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**createChunkLineage**](ChunkLineagesApi.md#createchunklineageoperation) | **POST** /v1/chunk-lineages | Create Chunk Lineage Handler |
+| [**deleteChunkLineage**](ChunkLineagesApi.md#deletechunklineage) | **DELETE** /v1/chunk-lineages | Delete Chunk Lineage Handler |
+| [**getChunkLineage**](ChunkLineagesApi.md#getchunklineage) | **GET** /v1/chunk-lineages/{chunk_id} | Get Chunk Lineage Handler |
+
+
+
+## createChunkLineage
+
+> Array<ChunkLineageResponse> createChunkLineage(createChunkLineageRequest, ksUat)
+
+Create Chunk Lineage Handler
+
+Batch-create lineage edges for a child chunk.  Creates edges from each parent chunk to the specified child chunk. All chunks must exist in the same tenant.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ChunkLineagesApi,
+} from '@knowledge-stack/ksapi';
+import type { CreateChunkLineageOperationRequest } from '@knowledge-stack/ksapi';
+
+async function example() {
+  console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
+  const api = new ChunkLineagesApi();
+
+  const body = {
+    // CreateChunkLineageRequest
+    createChunkLineageRequest: ...,
+    // string (optional)
+    ksUat: ksUat_example,
+  } satisfies CreateChunkLineageOperationRequest;
+
+  try {
+    const data = await api.createChunkLineage(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **createChunkLineageRequest** | [CreateChunkLineageRequest](CreateChunkLineageRequest.md) |  | |
+| **ksUat** | `string` |  | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**Array<ChunkLineageResponse>**](ChunkLineageResponse.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)
+
+
+## deleteChunkLineage
+
+> deleteChunkLineage(parentChunkId, chunkId, ksUat)
+
+Delete Chunk Lineage Handler
+
+Delete a single lineage edge between parent and child chunks.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ChunkLineagesApi,
+} from '@knowledge-stack/ksapi';
+import type { DeleteChunkLineageRequest } from '@knowledge-stack/ksapi';
+
+async function example() {
+  console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
+  const api = new ChunkLineagesApi();
+
+  const body = {
+    // string | Parent chunk ID
+    parentChunkId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // string | Child chunk ID
+    chunkId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // string (optional)
+    ksUat: ksUat_example,
+  } satisfies DeleteChunkLineageRequest;
+
+  try {
+    const data = await api.deleteChunkLineage(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **parentChunkId** | `string` | Parent chunk ID | [Defaults to `undefined`] |
+| **chunkId** | `string` | Child chunk ID | [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)
+
+
+## getChunkLineage
+
+> LineageGraphResponse getChunkLineage(chunkId, maxDepth, ksUat)
+
+Get Chunk Lineage Handler
+
+Get lineage graph for a chunk.  Traverses both ancestors and descendants up to max_depth, returning enriched nodes and edges.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ChunkLineagesApi,
+} from '@knowledge-stack/ksapi';
+import type { GetChunkLineageRequest } from '@knowledge-stack/ksapi';
+
+async function example() {
+  console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
+  const api = new ChunkLineagesApi();
+
+  const body = {
+    // string
+    chunkId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // number (optional)
+    maxDepth: 56,
+    // string (optional)
+    ksUat: ksUat_example,
+  } satisfies GetChunkLineageRequest;
+
+  try {
+    const data = await api.getChunkLineage(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`] |
+| **maxDepth** | `number` |  | [Optional] [Defaults to `3`] |
+| **ksUat** | `string` |  | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**LineageGraphResponse**](LineageGraphResponse.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)
+

package/docs/ChunkMetadataInput.md

@@ -0,0 +1,37 @@
+
+# ChunkMetadataInput
+
+Metadata for a chunk including source document references.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`polygons` | [Array<PolygonReference>](PolygonReference.md)
+`s3Url` | string
+
+## Example
+
+```typescript
+import type { ChunkMetadataInput } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "polygons": null,
+  "s3Url": null,
+} satisfies ChunkMetadataInput
+
+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 ChunkMetadataInput
+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/ChunkMetadataOutput.md

@@ -0,0 +1,37 @@
+
+# ChunkMetadataOutput
+
+Metadata for a chunk including source document references.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`polygons` | [Array<PolygonReference>](PolygonReference.md)
+`s3Url` | string
+
+## Example
+
+```typescript
+import type { ChunkMetadataOutput } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "polygons": null,
+  "s3Url": null,
+} satisfies ChunkMetadataOutput
+
+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 ChunkMetadataOutput
+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/ChunkResponse.md

@@ -0,0 +1,63 @@
+
+# ChunkResponse
+
+Chunk response model.
+
+## 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
+
+## Example
+
+```typescript
+import type { ChunkResponse } 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,
+} satisfies ChunkResponse
+
+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 ChunkResponse
+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/ChunkSearchRequest.md

@@ -0,0 +1,47 @@
+
+# ChunkSearchRequest
+
+Request body for semantic chunk search.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`query` | string
+`model` | [EmbeddingModel](EmbeddingModel.md)
+`parentPathIds` | Array<string>
+`chunkType` | [ChunkType](ChunkType.md)
+`updatedAt` | Date
+`topK` | number
+`scoreThreshold` | number
+
+## Example
+
+```typescript
+import type { ChunkSearchRequest } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "query": null,
+  "model": null,
+  "parentPathIds": null,
+  "chunkType": null,
+  "updatedAt": null,
+  "topK": null,
+  "scoreThreshold": null,
+} satisfies ChunkSearchRequest
+
+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 ChunkSearchRequest
+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/ChunkType.md

@@ -0,0 +1,33 @@
+
+# ChunkType
+
+Type of chunk content.
+
+## Properties
+
+Name | Type
+------------ | -------------
+
+## Example
+
+```typescript
+import type { ChunkType } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+} satisfies ChunkType
+
+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 ChunkType
+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)
+
+