@knowledge-stack/ksapi 1.72.4 → 1.78.0

package/dist/esm/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/esm/models/index.js

@@ -6,15 +6,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';
@@ -51,6 +54,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';
@@ -71,6 +76,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';
@@ -81,6 +88,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';
@@ -124,6 +132,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';
@@ -135,6 +144,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';
@@ -142,6 +152,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';
@@ -159,6 +170,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';
@@ -166,6 +178,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/AcceptInviteResponse.d.ts

@@ -28,6 +28,12 @@ export interface AcceptInviteResponse {
      * @memberof AcceptInviteResponse
      */
     role: TenantUserRole;
+    /**
+     * Groups configured on the invite/tenant link that no longer exist and were therefore skipped.
+     * @type {Array<string>}
+     * @memberof AcceptInviteResponse
+     */
+    skippedGroups?: Array<string>;
 }
 export declare const AcceptInviteResponsePropertyValidationAttributesMap: {
     [property: string]: {

package/dist/models/AcceptInviteResponse.js

@@ -41,6 +41,7 @@ function AcceptInviteResponseFromJSONTyped(json, ignoreDiscriminator) {
     return {
         'tenantId': json['tenant_id'],
         'role': (0, TenantUserRole_1.TenantUserRoleFromJSON)(json['role']),
+        'skippedGroups': json['skipped_groups'] == null ? undefined : json['skipped_groups'],
     };
 }
 function AcceptInviteResponseToJSON(json) {
@@ -53,5 +54,6 @@ function AcceptInviteResponseToJSONTyped(value, ignoreDiscriminator = false) {
     return {
         'tenant_id': value['tenantId'],
         'role': (0, TenantUserRole_1.TenantUserRoleToJSON)(value['role']),
+        'skipped_groups': value['skippedGroups'],
     };
 }

package/dist/models/AskRequest.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 body for POST /v1/agent/ask.
+ * @export
+ * @interface AskRequest
+ */
+export interface AskRequest {
+    /**
+     * User prompt passed directly to the agent
+     * @type {string}
+     * @memberof AskRequest
+     */
+    prompt: string;
+}
+export declare const AskRequestPropertyValidationAttributesMap: {
+    [property: string]: {
+        maxLength?: number;
+        minLength?: number;
+        pattern?: string;
+        maximum?: number;
+        exclusiveMaximum?: boolean;
+        minimum?: number;
+        exclusiveMinimum?: boolean;
+        multipleOf?: number;
+        maxItems?: number;
+        minItems?: number;
+        uniqueItems?: boolean;
+    };
+};
+/**
+ * Check if a given object implements the AskRequest interface.
+ */
+export declare function instanceOfAskRequest(value: object): value is AskRequest;
+export declare function AskRequestFromJSON(json: any): AskRequest;
+export declare function AskRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): AskRequest;
+export declare function AskRequestToJSON(json: any): AskRequest;
+export declare function AskRequestToJSONTyped(value?: AskRequest | null, ignoreDiscriminator?: boolean): any;

package/dist/models/AskRequest.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.AskRequestPropertyValidationAttributesMap = void 0;
+exports.instanceOfAskRequest = instanceOfAskRequest;
+exports.AskRequestFromJSON = AskRequestFromJSON;
+exports.AskRequestFromJSONTyped = AskRequestFromJSONTyped;
+exports.AskRequestToJSON = AskRequestToJSON;
+exports.AskRequestToJSONTyped = AskRequestToJSONTyped;
+exports.AskRequestPropertyValidationAttributesMap = {};
+/**
+ * Check if a given object implements the AskRequest interface.
+ */
+function instanceOfAskRequest(value) {
+    if (!('prompt' in value) || value['prompt'] === undefined)
+        return false;
+    return true;
+}
+function AskRequestFromJSON(json) {
+    return AskRequestFromJSONTyped(json, false);
+}
+function AskRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'prompt': json['prompt'],
+    };
+}
+function AskRequestToJSON(json) {
+    return AskRequestToJSONTyped(json, false);
+}
+function AskRequestToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'prompt': value['prompt'],
+    };
+}

package/dist/models/AskResponse.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.
+ */
+/**
+ * Response body for POST /v1/agent/ask.
+ * @export
+ * @interface AskResponse
+ */
+export interface AskResponse {
+    /**
+     *
+     * @type {string}
+     * @memberof AskResponse
+     */
+    text: string;
+}
+export declare const AskResponsePropertyValidationAttributesMap: {
+    [property: string]: {
+        maxLength?: number;
+        minLength?: number;
+        pattern?: string;
+        maximum?: number;
+        exclusiveMaximum?: boolean;
+        minimum?: number;
+        exclusiveMinimum?: boolean;
+        multipleOf?: number;
+        maxItems?: number;
+        minItems?: number;
+        uniqueItems?: boolean;
+    };
+};
+/**
+ * Check if a given object implements the AskResponse interface.
+ */
+export declare function instanceOfAskResponse(value: object): value is AskResponse;
+export declare function AskResponseFromJSON(json: any): AskResponse;
+export declare function AskResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): AskResponse;
+export declare function AskResponseToJSON(json: any): AskResponse;
+export declare function AskResponseToJSONTyped(value?: AskResponse | null, ignoreDiscriminator?: boolean): any;

package/dist/models/AskResponse.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.AskResponsePropertyValidationAttributesMap = void 0;
+exports.instanceOfAskResponse = instanceOfAskResponse;
+exports.AskResponseFromJSON = AskResponseFromJSON;
+exports.AskResponseFromJSONTyped = AskResponseFromJSONTyped;
+exports.AskResponseToJSON = AskResponseToJSON;
+exports.AskResponseToJSONTyped = AskResponseToJSONTyped;
+exports.AskResponsePropertyValidationAttributesMap = {};
+/**
+ * Check if a given object implements the AskResponse interface.
+ */
+function instanceOfAskResponse(value) {
+    if (!('text' in value) || value['text'] === undefined)
+        return false;
+    return true;
+}
+function AskResponseFromJSON(json) {
+    return AskResponseFromJSONTyped(json, false);
+}
+function AskResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'text': json['text'],
+    };
+}
+function AskResponseToJSON(json) {
+    return AskResponseToJSONTyped(json, false);
+}
+function AskResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'text': value['text'],
+    };
+}

package/dist/models/ChangeSubscriptionRequest.d.ts

@@ -0,0 +1,53 @@
+/**
+ * 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.
+ */
+/**
+ * Body for ``POST /v1/tenants/{tenant_id}/subscriptions``.
+ * @export
+ * @interface ChangeSubscriptionRequest
+ */
+export interface ChangeSubscriptionRequest {
+    /**
+     * Target plan to switch to.
+     * @type {string}
+     * @memberof ChangeSubscriptionRequest
+     */
+    subscriptionId: string;
+    /**
+     * Desired seat cap. Must be <= plan.max_seats and >= the count of active TenantUser rows.
+     * @type {number}
+     * @memberof ChangeSubscriptionRequest
+     */
+    numSeats: number;
+}
+export declare const ChangeSubscriptionRequestPropertyValidationAttributesMap: {
+    [property: string]: {
+        maxLength?: number;
+        minLength?: number;
+        pattern?: string;
+        maximum?: number;
+        exclusiveMaximum?: boolean;
+        minimum?: number;
+        exclusiveMinimum?: boolean;
+        multipleOf?: number;
+        maxItems?: number;
+        minItems?: number;
+        uniqueItems?: boolean;
+    };
+};
+/**
+ * Check if a given object implements the ChangeSubscriptionRequest interface.
+ */
+export declare function instanceOfChangeSubscriptionRequest(value: object): value is ChangeSubscriptionRequest;
+export declare function ChangeSubscriptionRequestFromJSON(json: any): ChangeSubscriptionRequest;
+export declare function ChangeSubscriptionRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): ChangeSubscriptionRequest;
+export declare function ChangeSubscriptionRequestToJSON(json: any): ChangeSubscriptionRequest;
+export declare function ChangeSubscriptionRequestToJSONTyped(value?: ChangeSubscriptionRequest | null, ignoreDiscriminator?: boolean): any;

package/dist/models/ChangeSubscriptionRequest.js

@@ -0,0 +1,61 @@
+"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.ChangeSubscriptionRequestPropertyValidationAttributesMap = void 0;
+exports.instanceOfChangeSubscriptionRequest = instanceOfChangeSubscriptionRequest;
+exports.ChangeSubscriptionRequestFromJSON = ChangeSubscriptionRequestFromJSON;
+exports.ChangeSubscriptionRequestFromJSONTyped = ChangeSubscriptionRequestFromJSONTyped;
+exports.ChangeSubscriptionRequestToJSON = ChangeSubscriptionRequestToJSON;
+exports.ChangeSubscriptionRequestToJSONTyped = ChangeSubscriptionRequestToJSONTyped;
+exports.ChangeSubscriptionRequestPropertyValidationAttributesMap = {
+    numSeats: {
+        minimum: 1,
+        exclusiveMinimum: false,
+    },
+};
+/**
+ * Check if a given object implements the ChangeSubscriptionRequest interface.
+ */
+function instanceOfChangeSubscriptionRequest(value) {
+    if (!('subscriptionId' in value) || value['subscriptionId'] === undefined)
+        return false;
+    if (!('numSeats' in value) || value['numSeats'] === undefined)
+        return false;
+    return true;
+}
+function ChangeSubscriptionRequestFromJSON(json) {
+    return ChangeSubscriptionRequestFromJSONTyped(json, false);
+}
+function ChangeSubscriptionRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'subscriptionId': json['subscription_id'],
+        'numSeats': json['num_seats'],
+    };
+}
+function ChangeSubscriptionRequestToJSON(json) {
+    return ChangeSubscriptionRequestToJSONTyped(json, false);
+}
+function ChangeSubscriptionRequestToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'subscription_id': value['subscriptionId'],
+        'num_seats': value['numSeats'],
+    };
+}

package/dist/models/CheckpointDetails.d.ts

@@ -0,0 +1,96 @@
+/**
+ * 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.
+ */
+/**
+ * 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".
+ * @export
+ * @interface CheckpointDetails
+ */
+export interface CheckpointDetails {
+    /**
+     * Last message covered by this summary (inclusive).
+     * @type {string}
+     * @memberof CheckpointDetails
+     */
+    uptoMessageId: string;
+    /**
+     * created_at of upto_message_id; tiebreaker for identical timestamps.
+     * @type {Date}
+     * @memberof CheckpointDetails
+     */
+    uptoMessageCreatedAt: Date;
+    /**
+     * Agent-internal CompressionSummary as a JSON blob. Server does not interpret this; the agent serializes/deserializes via its own model.
+     * @type {{ [key: string]: any; }}
+     * @memberof CheckpointDetails
+     */
+    summary: {
+        [key: string]: any;
+    };
+    /**
+     *
+     * @type {number}
+     * @memberof CheckpointDetails
+     */
+    coveredMessageCount: number;
+    /**
+     *
+     * @type {number}
+     * @memberof CheckpointDetails
+     */
+    tokensBefore: number;
+    /**
+     *
+     * @type {number}
+     * @memberof CheckpointDetails
+     */
+    tokensAfter: number;
+    /**
+     *
+     * @type {string}
+     * @memberof CheckpointDetails
+     */
+    summarizerModel: string;
+    /**
+     *
+     * @type {string}
+     * @memberof CheckpointDetails
+     */
+    promptVersion: string;
+}
+export declare const CheckpointDetailsPropertyValidationAttributesMap: {
+    [property: string]: {
+        maxLength?: number;
+        minLength?: number;
+        pattern?: string;
+        maximum?: number;
+        exclusiveMaximum?: boolean;
+        minimum?: number;
+        exclusiveMinimum?: boolean;
+        multipleOf?: number;
+        maxItems?: number;
+        minItems?: number;
+        uniqueItems?: boolean;
+    };
+};
+/**
+ * Check if a given object implements the CheckpointDetails interface.
+ */
+export declare function instanceOfCheckpointDetails(value: object): value is CheckpointDetails;
+export declare function CheckpointDetailsFromJSON(json: any): CheckpointDetails;
+export declare function CheckpointDetailsFromJSONTyped(json: any, ignoreDiscriminator: boolean): CheckpointDetails;
+export declare function CheckpointDetailsToJSON(json: any): CheckpointDetails;
+export declare function CheckpointDetailsToJSONTyped(value?: CheckpointDetails | null, ignoreDiscriminator?: boolean): any;