@knowledge-stack/ksapi 1.72.4 → 1.78.0

package/dist/models/UpdateInviteRequest.js

@@ -0,0 +1,57 @@
+"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.UpdateInviteRequestPropertyValidationAttributesMap = void 0;
+exports.instanceOfUpdateInviteRequest = instanceOfUpdateInviteRequest;
+exports.UpdateInviteRequestFromJSON = UpdateInviteRequestFromJSON;
+exports.UpdateInviteRequestFromJSONTyped = UpdateInviteRequestFromJSONTyped;
+exports.UpdateInviteRequestToJSON = UpdateInviteRequestToJSON;
+exports.UpdateInviteRequestToJSONTyped = UpdateInviteRequestToJSONTyped;
+exports.UpdateInviteRequestPropertyValidationAttributesMap = {
+    groups: {
+        maxItems: 10,
+        uniqueItems: false,
+    },
+};
+/**
+ * Check if a given object implements the UpdateInviteRequest interface.
+ */
+function instanceOfUpdateInviteRequest(value) {
+    return true;
+}
+function UpdateInviteRequestFromJSON(json) {
+    return UpdateInviteRequestFromJSONTyped(json, false);
+}
+function UpdateInviteRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'expiresAt': json['expires_at'] == null ? undefined : (new Date(json['expires_at'])),
+        'groups': json['groups'] == null ? undefined : json['groups'],
+    };
+}
+function UpdateInviteRequestToJSON(json) {
+    return UpdateInviteRequestToJSONTyped(json, false);
+}
+function UpdateInviteRequestToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'expires_at': value['expiresAt'] == null ? value['expiresAt'] : value['expiresAt'].toISOString(),
+        'groups': value['groups'],
+    };
+}

package/dist/models/UsageMetric.d.ts

@@ -0,0 +1,26 @@
+/**
+ * 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.
+ */
+/**
+ *
+ * @export
+ */
+export declare const UsageMetric: {
+    readonly Page: "PAGE";
+    readonly Search: "SEARCH";
+    readonly Message: "MESSAGE";
+};
+export type UsageMetric = typeof UsageMetric[keyof typeof UsageMetric];
+export declare function instanceOfUsageMetric(value: any): boolean;
+export declare function UsageMetricFromJSON(json: any): UsageMetric;
+export declare function UsageMetricFromJSONTyped(json: any, ignoreDiscriminator: boolean): UsageMetric;
+export declare function UsageMetricToJSON(value?: UsageMetric | null): any;
+export declare function UsageMetricToJSONTyped(value: any, ignoreDiscriminator: boolean): UsageMetric;

package/dist/models/UsageMetric.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.UsageMetric = void 0;
+exports.instanceOfUsageMetric = instanceOfUsageMetric;
+exports.UsageMetricFromJSON = UsageMetricFromJSON;
+exports.UsageMetricFromJSONTyped = UsageMetricFromJSONTyped;
+exports.UsageMetricToJSON = UsageMetricToJSON;
+exports.UsageMetricToJSONTyped = UsageMetricToJSONTyped;
+/**
+ *
+ * @export
+ */
+exports.UsageMetric = {
+    Page: 'PAGE',
+    Search: 'SEARCH',
+    Message: 'MESSAGE'
+};
+function instanceOfUsageMetric(value) {
+    for (const key in exports.UsageMetric) {
+        if (Object.prototype.hasOwnProperty.call(exports.UsageMetric, key)) {
+            if (exports.UsageMetric[key] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+function UsageMetricFromJSON(json) {
+    return UsageMetricFromJSONTyped(json, false);
+}
+function UsageMetricFromJSONTyped(json, ignoreDiscriminator) {
+    return json;
+}
+function UsageMetricToJSON(value) {
+    return value;
+}
+function UsageMetricToJSONTyped(value, ignoreDiscriminator) {
+    return value;
+}

package/dist/models/index.d.ts

@@ -4,15 +4,18 @@ export * from './AddMemberRequest';
 export * from './AncestryResponse';
 export * from './ApiKeyResponse';
 export * from './Args';
+export * from './AskRequest';
+export * from './AskResponse';
 export * from './BrandingLogoType';
 export * from './BulkTagRequest';
+export * from './ChangeSubscriptionRequest';
+export * from './CheckpointDetails';
 export * from './ChunkBulkResponse';
 export * from './ChunkContentItem';
 export * from './ChunkDocumentResponse';
 export * from './ChunkDocumentVersionResponse';
 export * from './ChunkLineageResponse';
-export * from './ChunkMetadataInput';
-export * from './ChunkMetadataOutput';
+export * from './ChunkMetadata';
 export * from './ChunkNeighborsResponse';
 export * from './ChunkResponse';
 export * from './ChunkSearchRequest';
@@ -49,6 +52,8 @@ export * from './EmailSentResponse';
 export * from './EmailVerificationRequest';
 export * from './EnrichedCitation';
 export * from './EnrichedThreadMessageContent';
+export * from './ExtractRequest';
+export * from './ExtractResponse';
 export * from './FeaturesResponse';
 export * from './FeedbackEventResponse';
 export * from './FeedbackRating';
@@ -69,6 +74,8 @@ export * from './ImageTaxonomy';
 export * from './InformationStatistics';
 export * from './IngestDocumentResponse';
 export * from './IngestionMode';
+export * from './InviteLinkSettingsRequest';
+export * from './InviteLinkSettingsResponse';
 export * from './InviteResponse';
 export * from './InviteStatus';
 export * from './InviteUserRequest';
@@ -79,6 +86,7 @@ export * from './LineageNodeResponse';
 export * from './LocationInner';
 export * from './MembershipResponse';
 export * from './MessageRole';
+export * from './MeteredQuotaStatus';
 export * from './NonFilesystemReferenceType';
 export * from './PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseDiscriminator';
 export * from './PaginatedResponseAnnotatedUnionSectionContentItemChunkContentItemDiscriminator';
@@ -122,6 +130,7 @@ export * from './ScoredChunkResponse';
 export * from './SearchSortOrder';
 export * from './SearchType';
 export * from './SearchablePartType';
+export * from './SeatQuotaStatus';
 export * from './SectionContentItem';
 export * from './SectionContentItemOrChunkContentItem';
 export * from './SectionResponse';
@@ -133,6 +142,7 @@ export * from './StepInput';
 export * from './StepKind';
 export * from './StepOutput';
 export * from './SubmitFeedbackRequest';
+export * from './SubscriptionPlanResponse';
 export * from './SubtreeChunkGroup';
 export * from './SubtreeChunksResponse';
 export * from './SupportedIdP';
@@ -140,6 +150,7 @@ export * from './SupportedLanguage';
 export * from './TagResponse';
 export * from './TemporalWorkflowStatusResponse';
 export * from './TenantBrandingResponse';
+export * from './TenantQuotaStateResponse';
 export * from './TenantResponse';
 export * from './TenantSettingsResponse';
 export * from './TenantSettingsUpdate';
@@ -157,6 +168,7 @@ export * from './UpdateDocumentRequest';
 export * from './UpdateFolderRequest';
 export * from './UpdateGroupPermissionRequest';
 export * from './UpdateGroupRequest';
+export * from './UpdateInviteRequest';
 export * from './UpdatePermissionRequest';
 export * from './UpdateSectionRequest';
 export * from './UpdateTagRequest';
@@ -164,6 +176,7 @@ export * from './UpdateTenantRequest';
 export * from './UpdateThreadRequest';
 export * from './UpdateUserRequest';
 export * from './UpdateWorkflowDefinitionRequest';
+export * from './UsageMetric';
 export * from './UserMessageRequest';
 export * from './UserMessageResponse';
 export * from './UserResponse';

package/dist/models/index.js

@@ -22,15 +22,18 @@ __exportStar(require("./AddMemberRequest"), exports);
 __exportStar(require("./AncestryResponse"), exports);
 __exportStar(require("./ApiKeyResponse"), exports);
 __exportStar(require("./Args"), exports);
+__exportStar(require("./AskRequest"), exports);
+__exportStar(require("./AskResponse"), exports);
 __exportStar(require("./BrandingLogoType"), exports);
 __exportStar(require("./BulkTagRequest"), exports);
+__exportStar(require("./ChangeSubscriptionRequest"), exports);
+__exportStar(require("./CheckpointDetails"), exports);
 __exportStar(require("./ChunkBulkResponse"), exports);
 __exportStar(require("./ChunkContentItem"), exports);
 __exportStar(require("./ChunkDocumentResponse"), exports);
 __exportStar(require("./ChunkDocumentVersionResponse"), exports);
 __exportStar(require("./ChunkLineageResponse"), exports);
-__exportStar(require("./ChunkMetadataInput"), exports);
-__exportStar(require("./ChunkMetadataOutput"), exports);
+__exportStar(require("./ChunkMetadata"), exports);
 __exportStar(require("./ChunkNeighborsResponse"), exports);
 __exportStar(require("./ChunkResponse"), exports);
 __exportStar(require("./ChunkSearchRequest"), exports);
@@ -67,6 +70,8 @@ __exportStar(require("./EmailSentResponse"), exports);
 __exportStar(require("./EmailVerificationRequest"), exports);
 __exportStar(require("./EnrichedCitation"), exports);
 __exportStar(require("./EnrichedThreadMessageContent"), exports);
+__exportStar(require("./ExtractRequest"), exports);
+__exportStar(require("./ExtractResponse"), exports);
 __exportStar(require("./FeaturesResponse"), exports);
 __exportStar(require("./FeedbackEventResponse"), exports);
 __exportStar(require("./FeedbackRating"), exports);
@@ -87,6 +92,8 @@ __exportStar(require("./ImageTaxonomy"), exports);
 __exportStar(require("./InformationStatistics"), exports);
 __exportStar(require("./IngestDocumentResponse"), exports);
 __exportStar(require("./IngestionMode"), exports);
+__exportStar(require("./InviteLinkSettingsRequest"), exports);
+__exportStar(require("./InviteLinkSettingsResponse"), exports);
 __exportStar(require("./InviteResponse"), exports);
 __exportStar(require("./InviteStatus"), exports);
 __exportStar(require("./InviteUserRequest"), exports);
@@ -97,6 +104,7 @@ __exportStar(require("./LineageNodeResponse"), exports);
 __exportStar(require("./LocationInner"), exports);
 __exportStar(require("./MembershipResponse"), exports);
 __exportStar(require("./MessageRole"), exports);
+__exportStar(require("./MeteredQuotaStatus"), exports);
 __exportStar(require("./NonFilesystemReferenceType"), exports);
 __exportStar(require("./PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseDiscriminator"), exports);
 __exportStar(require("./PaginatedResponseAnnotatedUnionSectionContentItemChunkContentItemDiscriminator"), exports);
@@ -140,6 +148,7 @@ __exportStar(require("./ScoredChunkResponse"), exports);
 __exportStar(require("./SearchSortOrder"), exports);
 __exportStar(require("./SearchType"), exports);
 __exportStar(require("./SearchablePartType"), exports);
+__exportStar(require("./SeatQuotaStatus"), exports);
 __exportStar(require("./SectionContentItem"), exports);
 __exportStar(require("./SectionContentItemOrChunkContentItem"), exports);
 __exportStar(require("./SectionResponse"), exports);
@@ -151,6 +160,7 @@ __exportStar(require("./StepInput"), exports);
 __exportStar(require("./StepKind"), exports);
 __exportStar(require("./StepOutput"), exports);
 __exportStar(require("./SubmitFeedbackRequest"), exports);
+__exportStar(require("./SubscriptionPlanResponse"), exports);
 __exportStar(require("./SubtreeChunkGroup"), exports);
 __exportStar(require("./SubtreeChunksResponse"), exports);
 __exportStar(require("./SupportedIdP"), exports);
@@ -158,6 +168,7 @@ __exportStar(require("./SupportedLanguage"), exports);
 __exportStar(require("./TagResponse"), exports);
 __exportStar(require("./TemporalWorkflowStatusResponse"), exports);
 __exportStar(require("./TenantBrandingResponse"), exports);
+__exportStar(require("./TenantQuotaStateResponse"), exports);
 __exportStar(require("./TenantResponse"), exports);
 __exportStar(require("./TenantSettingsResponse"), exports);
 __exportStar(require("./TenantSettingsUpdate"), exports);
@@ -175,6 +186,7 @@ __exportStar(require("./UpdateDocumentRequest"), exports);
 __exportStar(require("./UpdateFolderRequest"), exports);
 __exportStar(require("./UpdateGroupPermissionRequest"), exports);
 __exportStar(require("./UpdateGroupRequest"), exports);
+__exportStar(require("./UpdateInviteRequest"), exports);
 __exportStar(require("./UpdatePermissionRequest"), exports);
 __exportStar(require("./UpdateSectionRequest"), exports);
 __exportStar(require("./UpdateTagRequest"), exports);
@@ -182,6 +194,7 @@ __exportStar(require("./UpdateTenantRequest"), exports);
 __exportStar(require("./UpdateThreadRequest"), exports);
 __exportStar(require("./UpdateUserRequest"), exports);
 __exportStar(require("./UpdateWorkflowDefinitionRequest"), exports);
+__exportStar(require("./UsageMetric"), exports);
 __exportStar(require("./UserMessageRequest"), exports);
 __exportStar(require("./UserMessageResponse"), exports);
 __exportStar(require("./UserResponse"), exports);

package/docs/AcceptInviteResponse.md

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

package/docs/AgentApi.md

@@ -0,0 +1,158 @@
+# AgentApi
+
+All URIs are relative to *http://localhost:8000*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**agentAsk**](AgentApi.md#agentask) | **POST** /v1/agent/ask | Agent Ask Handler |
+| [**agentExtract**](AgentApi.md#agentextract) | **POST** /v1/agent/extract | Agent Extract Handler |
+
+
+
+## agentAsk
+
+> AskResponse agentAsk(askRequest, authorization, ksUat)
+
+Agent Ask Handler
+
+Run a one-shot text agent request to completion and return the payload.  The request blocks until the underlying Temporal workflow finishes. Clients should set a generous HTTP timeout to accommodate tool-heavy runs.  Quota: consumes one MESSAGE before ``start_workflow``. Refunds on any failure between consume and ``handle.result()`` returning — pre-enqueue ``start_workflow`` raises and post-enqueue workflow failures both refund.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AgentApi,
+} from '@knowledge-stack/ksapi';
+import type { AgentAskRequest } from '@knowledge-stack/ksapi';
+
+async function example() {
+  console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
+  const api = new AgentApi();
+
+  const body = {
+    // AskRequest
+    askRequest: ...,
+    // string (optional)
+    authorization: authorization_example,
+    // string (optional)
+    ksUat: ksUat_example,
+  } satisfies AgentAskRequest;
+
+  try {
+    const data = await api.agentAsk(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **askRequest** | [AskRequest](AskRequest.md) |  | |
+| **authorization** | `string` |  | [Optional] [Defaults to `undefined`] |
+| **ksUat** | `string` |  | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**AskResponse**](AskResponse.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)
+
+
+## agentExtract
+
+> ExtractResponse agentExtract(extractRequest, authorization, ksUat)
+
+Agent Extract Handler
+
+Run a one-shot structured extraction request and return the payload.  Validates the schema input on the route side (DOCUMENT → active version → valid JSON object) BEFORE consuming quota or starting the workflow. Bad schema → 400 with no quota debit. The workflow activity trusts the input and does not re-validate.  Quota: consumes one MESSAGE before ``start_workflow``. Refunds on any failure between consume and ``handle.result()`` returning — pre-enqueue ``start_workflow`` raises and post-enqueue workflow failures both refund.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AgentApi,
+} from '@knowledge-stack/ksapi';
+import type { AgentExtractRequest } from '@knowledge-stack/ksapi';
+
+async function example() {
+  console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
+  const api = new AgentApi();
+
+  const body = {
+    // ExtractRequest
+    extractRequest: ...,
+    // string (optional)
+    authorization: authorization_example,
+    // string (optional)
+    ksUat: ksUat_example,
+  } satisfies AgentExtractRequest;
+
+  try {
+    const data = await api.agentExtract(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **extractRequest** | [ExtractRequest](ExtractRequest.md) |  | |
+| **authorization** | `string` |  | [Optional] [Defaults to `undefined`] |
+| **ksUat** | `string` |  | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**ExtractResponse**](ExtractResponse.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/AskRequest.md

@@ -0,0 +1,35 @@
+
+# AskRequest
+
+Request body for POST /v1/agent/ask.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`prompt` | string
+
+## Example
+
+```typescript
+import type { AskRequest } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "prompt": null,
+} satisfies AskRequest
+
+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 AskRequest
+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/AskResponse.md

@@ -0,0 +1,35 @@
+
+# AskResponse
+
+Response body for POST /v1/agent/ask.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`text` | string
+
+## Example
+
+```typescript
+import type { AskResponse } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "text": null,
+} satisfies AskResponse
+
+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 AskResponse
+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/AuthApi.md

@@ -279,7 +279,7 @@ example().catch(console.error);
 
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
-| **provider** | `IdpType` | Provider to initiate SSO with | [Defaults to `undefined`] [Enum: PASSWORD, GOOGLE, TENANT] |
+| **provider** | `IdpType` | Provider to initiate SSO with | [Defaults to `undefined`] [Enum: PASSWORD, GOOGLE, MICROSOFT, GITHUB, TENANT] |
 | **tenantId** | `string` | Tenant ID to initiate SSO with | [Optional] [Defaults to `undefined`] |
 
 ### Return type
@@ -358,7 +358,7 @@ example().catch(console.error);
 
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
-| **provider** | `IdpType` | Provider to initiate SSO with | [Defaults to `undefined`] [Enum: PASSWORD, GOOGLE, TENANT] |
+| **provider** | `IdpType` | Provider to initiate SSO with | [Defaults to `undefined`] [Enum: PASSWORD, GOOGLE, MICROSOFT, GITHUB, TENANT] |
 | **code** | `string` | Authorization code from provider | [Optional] [Defaults to `undefined`] |
 | **state** | `string` | State parameter for CSRF protection | [Optional] [Defaults to `undefined`] |
 | **error** | `string` | Error code if authorization failed | [Optional] [Defaults to `undefined`] |

package/docs/ChangeSubscriptionRequest.md

@@ -0,0 +1,37 @@
+
+# ChangeSubscriptionRequest
+
+Body for ``POST /v1/tenants/{tenant_id}/subscriptions``.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`subscriptionId` | string
+`numSeats` | number
+
+## Example
+
+```typescript
+import type { ChangeSubscriptionRequest } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "subscriptionId": null,
+  "numSeats": null,
+} satisfies ChangeSubscriptionRequest
+
+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 ChangeSubscriptionRequest
+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/CheckpointDetails.md

@@ -0,0 +1,49 @@
+
+# CheckpointDetails
+
+Agent-internal overlay that replaces older messages in the loaded history.  Written as ``details.checkpoint`` on ``role=SYSTEM`` ThreadMessages. The boundary is explicit via ``upto_message_id`` + ``upto_message_created_at`` so the agent can keep recent messages uncompacted even though the checkpoint message itself is inserted at \"now\".
+
+## Properties
+
+Name | Type
+------------ | -------------
+`uptoMessageId` | string
+`uptoMessageCreatedAt` | Date
+`summary` | { [key: string]: any; }
+`coveredMessageCount` | number
+`tokensBefore` | number
+`tokensAfter` | number
+`summarizerModel` | string
+`promptVersion` | string
+
+## Example
+
+```typescript
+import type { CheckpointDetails } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "uptoMessageId": null,
+  "uptoMessageCreatedAt": null,
+  "summary": null,
+  "coveredMessageCount": null,
+  "tokensBefore": null,
+  "tokensAfter": null,
+  "summarizerModel": null,
+  "promptVersion": null,
+} satisfies CheckpointDetails
+
+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 CheckpointDetails
+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/ChunkBulkResponse.md

@@ -12,7 +12,7 @@ Name | Type
 `contentId` | string
 `content` | string
 `chunkType` | [ChunkType](ChunkType.md)
-`chunkMetadata` | [ChunkMetadataOutput](ChunkMetadataOutput.md)
+`chunkMetadata` | [ChunkMetadata](ChunkMetadata.md)
 `numTokens` | number
 `parentPathId` | string
 `prevSiblingPathId` | string

package/docs/ChunkContentItem.md

@@ -15,7 +15,7 @@ Name | Type
 `depth` | number
 `content` | string
 `chunkType` | [ChunkType](ChunkType.md)
-`chunkMetadata` | [ChunkMetadataOutput](ChunkMetadataOutput.md)
+`chunkMetadata` | [ChunkMetadata](ChunkMetadata.md)
 `materializedPath` | string
 `systemManaged` | boolean
 `createdAt` | Date