@knowledge-stack/ksapi 1.65.8 → 1.66.1

package/dist/esm/apis/DocumentVersionsApi.d.ts

@@ -1,402 +0,0 @@
-/**
- * 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.
- */
-import * as runtime from '../runtime';
-import type { ClearVersionContentsResponse, DocumentVersionAction, DocumentVersionActionResponse, DocumentVersionContentTypeFilter, DocumentVersionMetadataUpdate, DocumentVersionResponse, PaginatedResponseAnnotatedUnionSectionContentItemChunkContentItemDiscriminator, PaginatedResponseDocumentVersionResponse } from '../models/index';
-export interface ClearDocumentVersionContentsRequest {
-    versionId: string;
-    authorization?: string | null;
-    ksUat?: string | null;
-}
-export interface CreateDocumentVersionRequest {
-    documentId: string;
-    authorization?: string | null;
-    ksUat?: string | null;
-}
-export interface DeleteDocumentVersionRequest {
-    versionId: string;
-    authorization?: string | null;
-    ksUat?: string | null;
-}
-export interface DocumentVersionActionRequest {
-    versionId: string;
-    action: DocumentVersionAction;
-    authorization?: string | null;
-    ksUat?: string | null;
-}
-export interface GetDocumentVersionRequest {
-    versionId: string;
-    authorization?: string | null;
-    ksUat?: string | null;
-}
-export interface GetDocumentVersionContentsRequest {
-    versionId: string;
-    sectionId?: string | null;
-    contentType?: DocumentVersionContentTypeFilter;
-    limit?: number;
-    offset?: number;
-    authorization?: string | null;
-    ksUat?: string | null;
-}
-export interface ListDocumentVersionsRequest {
-    documentId: string;
-    limit?: number;
-    offset?: number;
-    authorization?: string | null;
-    ksUat?: string | null;
-}
-export interface UpdateDocumentVersionMetadataRequest {
-    versionId: string;
-    documentVersionMetadataUpdate: DocumentVersionMetadataUpdate;
-    authorization?: string | null;
-    ksUat?: string | null;
-}
-/**
- * DocumentVersionsApi - interface
- *
- * @export
- * @interface DocumentVersionsApiInterface
- */
-export interface DocumentVersionsApiInterface {
-    /**
-     * Creates request options for clearDocumentVersionContents without sending the request
-     * @param {string} versionId DocumentVersion ID
-     * @param {string} [authorization]
-     * @param {string} [ksUat]
-     * @throws {RequiredError}
-     * @memberof DocumentVersionsApiInterface
-     */
-    clearDocumentVersionContentsRequestOpts(requestParameters: ClearDocumentVersionContentsRequest): Promise<runtime.RequestOpts>;
-    /**
-     * Delete all sections and chunks under a document version.  Removes all content (sections and chunks) from the version while keeping the version itself intact. Used by the ingestion pipeline for idempotent re-processing.
-     * @summary Clear Document Version Contents Handler
-     * @param {string} versionId DocumentVersion ID
-     * @param {string} [authorization]
-     * @param {string} [ksUat]
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof DocumentVersionsApiInterface
-     */
-    clearDocumentVersionContentsRaw(requestParameters: ClearDocumentVersionContentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ClearVersionContentsResponse>>;
-    /**
-     * Delete all sections and chunks under a document version.  Removes all content (sections and chunks) from the version while keeping the version itself intact. Used by the ingestion pipeline for idempotent re-processing.
-     * Clear Document Version Contents Handler
-     */
-    clearDocumentVersionContents(requestParameters: ClearDocumentVersionContentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ClearVersionContentsResponse>;
-    /**
-     * Creates request options for createDocumentVersion without sending the request
-     * @param {string} documentId Document ID
-     * @param {string} [authorization]
-     * @param {string} [ksUat]
-     * @throws {RequiredError}
-     * @memberof DocumentVersionsApiInterface
-     */
-    createDocumentVersionRequestOpts(requestParameters: CreateDocumentVersionRequest): Promise<runtime.RequestOpts>;
-    /**
-     * Create a new version for a document.  The version number is automatically incremented from the highest existing version.
-     * @summary Create Document Version Handler
-     * @param {string} documentId Document ID
-     * @param {string} [authorization]
-     * @param {string} [ksUat]
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof DocumentVersionsApiInterface
-     */
-    createDocumentVersionRaw(requestParameters: CreateDocumentVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DocumentVersionResponse>>;
-    /**
-     * Create a new version for a document.  The version number is automatically incremented from the highest existing version.
-     * Create Document Version Handler
-     */
-    createDocumentVersion(requestParameters: CreateDocumentVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DocumentVersionResponse>;
-    /**
-     * Creates request options for deleteDocumentVersion without sending the request
-     * @param {string} versionId DocumentVersion ID
-     * @param {string} [authorization]
-     * @param {string} [ksUat]
-     * @throws {RequiredError}
-     * @memberof DocumentVersionsApiInterface
-     */
-    deleteDocumentVersionRequestOpts(requestParameters: DeleteDocumentVersionRequest): Promise<runtime.RequestOpts>;
-    /**
-     * Delete a document version by its ID.  Cannot delete the active version of a document.
-     * @summary Delete Document Version Handler
-     * @param {string} versionId DocumentVersion ID
-     * @param {string} [authorization]
-     * @param {string} [ksUat]
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof DocumentVersionsApiInterface
-     */
-    deleteDocumentVersionRaw(requestParameters: DeleteDocumentVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
-    /**
-     * Delete a document version by its ID.  Cannot delete the active version of a document.
-     * Delete Document Version Handler
-     */
-    deleteDocumentVersion(requestParameters: DeleteDocumentVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
-    /**
-     * Creates request options for documentVersionAction without sending the request
-     * @param {string} versionId DocumentVersion ID
-     * @param {DocumentVersionAction} action Action to perform
-     * @param {string} [authorization]
-     * @param {string} [ksUat]
-     * @throws {RequiredError}
-     * @memberof DocumentVersionsApiInterface
-     */
-    documentVersionActionRequestOpts(requestParameters: DocumentVersionActionRequest): Promise<runtime.RequestOpts>;
-    /**
-     * Perform an action on a document version.  Supported actions: - `reembed`: Re-embed all chunks for this version into Qdrant.
-     * @summary Document Version Action Handler
-     * @param {string} versionId DocumentVersion ID
-     * @param {DocumentVersionAction} action Action to perform
-     * @param {string} [authorization]
-     * @param {string} [ksUat]
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof DocumentVersionsApiInterface
-     */
-    documentVersionActionRaw(requestParameters: DocumentVersionActionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DocumentVersionActionResponse>>;
-    /**
-     * Perform an action on a document version.  Supported actions: - `reembed`: Re-embed all chunks for this version into Qdrant.
-     * Document Version Action Handler
-     */
-    documentVersionAction(requestParameters: DocumentVersionActionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DocumentVersionActionResponse>;
-    /**
-     * Creates request options for getDocumentVersion without sending the request
-     * @param {string} versionId DocumentVersion ID
-     * @param {string} [authorization]
-     * @param {string} [ksUat]
-     * @throws {RequiredError}
-     * @memberof DocumentVersionsApiInterface
-     */
-    getDocumentVersionRequestOpts(requestParameters: GetDocumentVersionRequest): Promise<runtime.RequestOpts>;
-    /**
-     * Get a document version by its ID.
-     * @summary Get Document Version Handler
-     * @param {string} versionId DocumentVersion ID
-     * @param {string} [authorization]
-     * @param {string} [ksUat]
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof DocumentVersionsApiInterface
-     */
-    getDocumentVersionRaw(requestParameters: GetDocumentVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DocumentVersionResponse>>;
-    /**
-     * Get a document version by its ID.
-     * Get Document Version Handler
-     */
-    getDocumentVersion(requestParameters: GetDocumentVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DocumentVersionResponse>;
-    /**
-     * Creates request options for getDocumentVersionContents without sending the request
-     * @param {string} versionId DocumentVersion ID
-     * @param {string} [sectionId] Optional section ID to scope traversal to a subtree
-     * @param {DocumentVersionContentTypeFilter} [contentType] Filter by content type: SECTION or CHUNK. Omit to return both types.
-     * @param {number} [limit] Number of items per page
-     * @param {number} [offset] Number of items to skip
-     * @param {string} [authorization]
-     * @param {string} [ksUat]
-     * @throws {RequiredError}
-     * @memberof DocumentVersionsApiInterface
-     */
-    getDocumentVersionContentsRequestOpts(requestParameters: GetDocumentVersionContentsRequest): Promise<runtime.RequestOpts>;
-    /**
-     * List all sections and chunks for a document version in depth-first logical order.  Returns a discriminated union of SectionContentItem and ChunkContentItem, distinguished by the `part_type` field (\"SECTION\" or \"CHUNK\").  Use `content_type` to return only one type (e.g. `content_type=CHUNK` for chunk-only pagination where offset/limit apply only to chunks).
-     * @summary Get Document Version Contents Handler
-     * @param {string} versionId DocumentVersion ID
-     * @param {string} [sectionId] Optional section ID to scope traversal to a subtree
-     * @param {DocumentVersionContentTypeFilter} [contentType] Filter by content type: SECTION or CHUNK. Omit to return both types.
-     * @param {number} [limit] Number of items per page
-     * @param {number} [offset] Number of items to skip
-     * @param {string} [authorization]
-     * @param {string} [ksUat]
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof DocumentVersionsApiInterface
-     */
-    getDocumentVersionContentsRaw(requestParameters: GetDocumentVersionContentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseAnnotatedUnionSectionContentItemChunkContentItemDiscriminator>>;
-    /**
-     * List all sections and chunks for a document version in depth-first logical order.  Returns a discriminated union of SectionContentItem and ChunkContentItem, distinguished by the `part_type` field (\"SECTION\" or \"CHUNK\").  Use `content_type` to return only one type (e.g. `content_type=CHUNK` for chunk-only pagination where offset/limit apply only to chunks).
-     * Get Document Version Contents Handler
-     */
-    getDocumentVersionContents(requestParameters: GetDocumentVersionContentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseAnnotatedUnionSectionContentItemChunkContentItemDiscriminator>;
-    /**
-     * Creates request options for listDocumentVersions without sending the request
-     * @param {string} documentId Document ID to list versions for
-     * @param {number} [limit] Number of items per page
-     * @param {number} [offset] Number of items to skip
-     * @param {string} [authorization]
-     * @param {string} [ksUat]
-     * @throws {RequiredError}
-     * @memberof DocumentVersionsApiInterface
-     */
-    listDocumentVersionsRequestOpts(requestParameters: ListDocumentVersionsRequest): Promise<runtime.RequestOpts>;
-    /**
-     * List all versions for a document.  Returns versions ordered by version number ascending (v0, v1, v2...).
-     * @summary List Document Versions Handler
-     * @param {string} documentId Document ID to list versions for
-     * @param {number} [limit] Number of items per page
-     * @param {number} [offset] Number of items to skip
-     * @param {string} [authorization]
-     * @param {string} [ksUat]
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof DocumentVersionsApiInterface
-     */
-    listDocumentVersionsRaw(requestParameters: ListDocumentVersionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseDocumentVersionResponse>>;
-    /**
-     * List all versions for a document.  Returns versions ordered by version number ascending (v0, v1, v2...).
-     * List Document Versions Handler
-     */
-    listDocumentVersions(requestParameters: ListDocumentVersionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseDocumentVersionResponse>;
-    /**
-     * Creates request options for updateDocumentVersionMetadata without sending the request
-     * @param {string} versionId DocumentVersion ID
-     * @param {DocumentVersionMetadataUpdate} documentVersionMetadataUpdate
-     * @param {string} [authorization]
-     * @param {string} [ksUat]
-     * @throws {RequiredError}
-     * @memberof DocumentVersionsApiInterface
-     */
-    updateDocumentVersionMetadataRequestOpts(requestParameters: UpdateDocumentVersionMetadataRequest): Promise<runtime.RequestOpts>;
-    /**
-     * Merge metadata fields into an existing document version\'s metadata.  Only non-null fields in the request body are merged; existing metadata fields not present in the request are preserved.
-     * @summary Update Document Version Metadata Handler
-     * @param {string} versionId DocumentVersion ID
-     * @param {DocumentVersionMetadataUpdate} documentVersionMetadataUpdate
-     * @param {string} [authorization]
-     * @param {string} [ksUat]
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof DocumentVersionsApiInterface
-     */
-    updateDocumentVersionMetadataRaw(requestParameters: UpdateDocumentVersionMetadataRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DocumentVersionResponse>>;
-    /**
-     * Merge metadata fields into an existing document version\'s metadata.  Only non-null fields in the request body are merged; existing metadata fields not present in the request are preserved.
-     * Update Document Version Metadata Handler
-     */
-    updateDocumentVersionMetadata(requestParameters: UpdateDocumentVersionMetadataRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DocumentVersionResponse>;
-}
-/**
- *
- */
-export declare class DocumentVersionsApi extends runtime.BaseAPI implements DocumentVersionsApiInterface {
-    /**
-     * Creates request options for clearDocumentVersionContents without sending the request
-     */
-    clearDocumentVersionContentsRequestOpts(requestParameters: ClearDocumentVersionContentsRequest): Promise<runtime.RequestOpts>;
-    /**
-     * Delete all sections and chunks under a document version.  Removes all content (sections and chunks) from the version while keeping the version itself intact. Used by the ingestion pipeline for idempotent re-processing.
-     * Clear Document Version Contents Handler
-     */
-    clearDocumentVersionContentsRaw(requestParameters: ClearDocumentVersionContentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ClearVersionContentsResponse>>;
-    /**
-     * Delete all sections and chunks under a document version.  Removes all content (sections and chunks) from the version while keeping the version itself intact. Used by the ingestion pipeline for idempotent re-processing.
-     * Clear Document Version Contents Handler
-     */
-    clearDocumentVersionContents(requestParameters: ClearDocumentVersionContentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ClearVersionContentsResponse>;
-    /**
-     * Creates request options for createDocumentVersion without sending the request
-     */
-    createDocumentVersionRequestOpts(requestParameters: CreateDocumentVersionRequest): Promise<runtime.RequestOpts>;
-    /**
-     * Create a new version for a document.  The version number is automatically incremented from the highest existing version.
-     * Create Document Version Handler
-     */
-    createDocumentVersionRaw(requestParameters: CreateDocumentVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DocumentVersionResponse>>;
-    /**
-     * Create a new version for a document.  The version number is automatically incremented from the highest existing version.
-     * Create Document Version Handler
-     */
-    createDocumentVersion(requestParameters: CreateDocumentVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DocumentVersionResponse>;
-    /**
-     * Creates request options for deleteDocumentVersion without sending the request
-     */
-    deleteDocumentVersionRequestOpts(requestParameters: DeleteDocumentVersionRequest): Promise<runtime.RequestOpts>;
-    /**
-     * Delete a document version by its ID.  Cannot delete the active version of a document.
-     * Delete Document Version Handler
-     */
-    deleteDocumentVersionRaw(requestParameters: DeleteDocumentVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
-    /**
-     * Delete a document version by its ID.  Cannot delete the active version of a document.
-     * Delete Document Version Handler
-     */
-    deleteDocumentVersion(requestParameters: DeleteDocumentVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
-    /**
-     * Creates request options for documentVersionAction without sending the request
-     */
-    documentVersionActionRequestOpts(requestParameters: DocumentVersionActionRequest): Promise<runtime.RequestOpts>;
-    /**
-     * Perform an action on a document version.  Supported actions: - `reembed`: Re-embed all chunks for this version into Qdrant.
-     * Document Version Action Handler
-     */
-    documentVersionActionRaw(requestParameters: DocumentVersionActionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DocumentVersionActionResponse>>;
-    /**
-     * Perform an action on a document version.  Supported actions: - `reembed`: Re-embed all chunks for this version into Qdrant.
-     * Document Version Action Handler
-     */
-    documentVersionAction(requestParameters: DocumentVersionActionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DocumentVersionActionResponse>;
-    /**
-     * Creates request options for getDocumentVersion without sending the request
-     */
-    getDocumentVersionRequestOpts(requestParameters: GetDocumentVersionRequest): Promise<runtime.RequestOpts>;
-    /**
-     * Get a document version by its ID.
-     * Get Document Version Handler
-     */
-    getDocumentVersionRaw(requestParameters: GetDocumentVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DocumentVersionResponse>>;
-    /**
-     * Get a document version by its ID.
-     * Get Document Version Handler
-     */
-    getDocumentVersion(requestParameters: GetDocumentVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DocumentVersionResponse>;
-    /**
-     * Creates request options for getDocumentVersionContents without sending the request
-     */
-    getDocumentVersionContentsRequestOpts(requestParameters: GetDocumentVersionContentsRequest): Promise<runtime.RequestOpts>;
-    /**
-     * List all sections and chunks for a document version in depth-first logical order.  Returns a discriminated union of SectionContentItem and ChunkContentItem, distinguished by the `part_type` field (\"SECTION\" or \"CHUNK\").  Use `content_type` to return only one type (e.g. `content_type=CHUNK` for chunk-only pagination where offset/limit apply only to chunks).
-     * Get Document Version Contents Handler
-     */
-    getDocumentVersionContentsRaw(requestParameters: GetDocumentVersionContentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseAnnotatedUnionSectionContentItemChunkContentItemDiscriminator>>;
-    /**
-     * List all sections and chunks for a document version in depth-first logical order.  Returns a discriminated union of SectionContentItem and ChunkContentItem, distinguished by the `part_type` field (\"SECTION\" or \"CHUNK\").  Use `content_type` to return only one type (e.g. `content_type=CHUNK` for chunk-only pagination where offset/limit apply only to chunks).
-     * Get Document Version Contents Handler
-     */
-    getDocumentVersionContents(requestParameters: GetDocumentVersionContentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseAnnotatedUnionSectionContentItemChunkContentItemDiscriminator>;
-    /**
-     * Creates request options for listDocumentVersions without sending the request
-     */
-    listDocumentVersionsRequestOpts(requestParameters: ListDocumentVersionsRequest): Promise<runtime.RequestOpts>;
-    /**
-     * List all versions for a document.  Returns versions ordered by version number ascending (v0, v1, v2...).
-     * List Document Versions Handler
-     */
-    listDocumentVersionsRaw(requestParameters: ListDocumentVersionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseDocumentVersionResponse>>;
-    /**
-     * List all versions for a document.  Returns versions ordered by version number ascending (v0, v1, v2...).
-     * List Document Versions Handler
-     */
-    listDocumentVersions(requestParameters: ListDocumentVersionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseDocumentVersionResponse>;
-    /**
-     * Creates request options for updateDocumentVersionMetadata without sending the request
-     */
-    updateDocumentVersionMetadataRequestOpts(requestParameters: UpdateDocumentVersionMetadataRequest): Promise<runtime.RequestOpts>;
-    /**
-     * Merge metadata fields into an existing document version\'s metadata.  Only non-null fields in the request body are merged; existing metadata fields not present in the request are preserved.
-     * Update Document Version Metadata Handler
-     */
-    updateDocumentVersionMetadataRaw(requestParameters: UpdateDocumentVersionMetadataRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DocumentVersionResponse>>;
-    /**
-     * Merge metadata fields into an existing document version\'s metadata.  Only non-null fields in the request body are merged; existing metadata fields not present in the request are preserved.
-     * Update Document Version Metadata Handler
-     */
-    updateDocumentVersionMetadata(requestParameters: UpdateDocumentVersionMetadataRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DocumentVersionResponse>;
-}