@knowledge-stack/ksapi 1.66.2 → 1.66.3

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

@@ -0,0 +1,385 @@
+/**
+ * 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 { ChunkType, CreateDocumentRequest, DocumentResponse, ImageTaxonomy, IngestDocumentResponse, IngestionMode, PaginatedResponseDocumentResponse, PathOrder, UpdateDocumentRequest } from '../models/index';
+export interface CreateDocumentOperationRequest {
+    createDocumentRequest: CreateDocumentRequest;
+    authorization?: string | null;
+    ksUat?: string | null;
+}
+export interface DeleteDocumentRequest {
+    documentId: string;
+    authorization?: string | null;
+    ksUat?: string | null;
+}
+export interface GetDocumentRequest {
+    documentId: string;
+    withTags?: boolean;
+    authorization?: string | null;
+    ksUat?: string | null;
+}
+export interface IngestDocumentRequest {
+    file: Blob;
+    pathPartId: string;
+    authorization?: string | null;
+    ksUat?: string | null;
+    name?: string | null;
+    ingestionMode?: IngestionMode;
+    chunkType?: ChunkType;
+    secondaryTaxonomy?: ImageTaxonomy;
+    pageDpi?: number;
+}
+export interface IngestDocumentVersionRequest {
+    documentId: string;
+    file: Blob;
+    authorization?: string | null;
+    ksUat?: string | null;
+    ingestionMode?: IngestionMode;
+    chunkType?: ChunkType;
+    secondaryTaxonomy?: ImageTaxonomy;
+    pageDpi?: number;
+}
+export interface ListDocumentsRequest {
+    parentPathPartId?: string | null;
+    sortOrder?: PathOrder;
+    withTags?: boolean;
+    limit?: number;
+    offset?: number;
+    authorization?: string | null;
+    ksUat?: string | null;
+}
+export interface UpdateDocumentOperationRequest {
+    documentId: string;
+    updateDocumentRequest: UpdateDocumentRequest;
+    authorization?: string | null;
+    ksUat?: string | null;
+}
+/**
+ * DocumentsApi - interface
+ *
+ * @export
+ * @interface DocumentsApiInterface
+ */
+export interface DocumentsApiInterface {
+    /**
+     * Creates request options for createDocument without sending the request
+     * @param {CreateDocumentRequest} createDocumentRequest
+     * @param {string} [authorization]
+     * @param {string} [ksUat]
+     * @throws {RequiredError}
+     * @memberof DocumentsApiInterface
+     */
+    createDocumentRequestOpts(requestParameters: CreateDocumentOperationRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Create a new document with initial v0 version.  The document is created as a child of the specified parent folder. An initial version (v0) is automatically created.
+     * @summary Create Document Handler
+     * @param {CreateDocumentRequest} createDocumentRequest
+     * @param {string} [authorization]
+     * @param {string} [ksUat]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DocumentsApiInterface
+     */
+    createDocumentRaw(requestParameters: CreateDocumentOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DocumentResponse>>;
+    /**
+     * Create a new document with initial v0 version.  The document is created as a child of the specified parent folder. An initial version (v0) is automatically created.
+     * Create Document Handler
+     */
+    createDocument(requestParameters: CreateDocumentOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DocumentResponse>;
+    /**
+     * Creates request options for deleteDocument without sending the request
+     * @param {string} documentId
+     * @param {string} [authorization]
+     * @param {string} [ksUat]
+     * @throws {RequiredError}
+     * @memberof DocumentsApiInterface
+     */
+    deleteDocumentRequestOpts(requestParameters: DeleteDocumentRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Delete a document and all its contents.  WARNING: This cascades to all children (versions, sections, chunks, etc.) due to parent_id ON DELETE CASCADE.
+     * @summary Delete Document Handler
+     * @param {string} documentId
+     * @param {string} [authorization]
+     * @param {string} [ksUat]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DocumentsApiInterface
+     */
+    deleteDocumentRaw(requestParameters: DeleteDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Delete a document and all its contents.  WARNING: This cascades to all children (versions, sections, chunks, etc.) due to parent_id ON DELETE CASCADE.
+     * Delete Document Handler
+     */
+    deleteDocument(requestParameters: DeleteDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for getDocument without sending the request
+     * @param {string} documentId
+     * @param {boolean} [withTags] Include tags in the response (default: false)
+     * @param {string} [authorization]
+     * @param {string} [ksUat]
+     * @throws {RequiredError}
+     * @memberof DocumentsApiInterface
+     */
+    getDocumentRequestOpts(requestParameters: GetDocumentRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Get a document by its document ID.
+     * @summary Get Document Handler
+     * @param {string} documentId
+     * @param {boolean} [withTags] Include tags in the response (default: false)
+     * @param {string} [authorization]
+     * @param {string} [ksUat]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DocumentsApiInterface
+     */
+    getDocumentRaw(requestParameters: GetDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DocumentResponse>>;
+    /**
+     * Get a document by its document ID.
+     * Get Document Handler
+     */
+    getDocument(requestParameters: GetDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DocumentResponse>;
+    /**
+     * Creates request options for ingestDocument without sending the request
+     * @param {Blob} file
+     * @param {string} pathPartId Parent path part ID (must be a FOLDER type)
+     * @param {string} [authorization]
+     * @param {string} [ksUat]
+     * @param {string} [name] Document name (defaults to filename)
+     * @param {IngestionMode} [ingestionMode]
+     * @param {ChunkType} [chunkType]
+     * @param {ImageTaxonomy} [secondaryTaxonomy]
+     * @param {number} [pageDpi] DPI for PDF page screenshots (default 72, min 36, max 216).
+     * @throws {RequiredError}
+     * @memberof DocumentsApiInterface
+     */
+    ingestDocumentRequestOpts(requestParameters: IngestDocumentRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Upload a file, create document + version, and trigger ingestion workflow.  Returns 201 with the Temporal workflow ID.
+     * @summary Ingest Document Handler
+     * @param {Blob} file
+     * @param {string} pathPartId Parent path part ID (must be a FOLDER type)
+     * @param {string} [authorization]
+     * @param {string} [ksUat]
+     * @param {string} [name] Document name (defaults to filename)
+     * @param {IngestionMode} [ingestionMode]
+     * @param {ChunkType} [chunkType]
+     * @param {ImageTaxonomy} [secondaryTaxonomy]
+     * @param {number} [pageDpi] DPI for PDF page screenshots (default 72, min 36, max 216).
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DocumentsApiInterface
+     */
+    ingestDocumentRaw(requestParameters: IngestDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<IngestDocumentResponse>>;
+    /**
+     * Upload a file, create document + version, and trigger ingestion workflow.  Returns 201 with the Temporal workflow ID.
+     * Ingest Document Handler
+     */
+    ingestDocument(requestParameters: IngestDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<IngestDocumentResponse>;
+    /**
+     * Creates request options for ingestDocumentVersion without sending the request
+     * @param {string} documentId Document ID
+     * @param {Blob} file
+     * @param {string} [authorization]
+     * @param {string} [ksUat]
+     * @param {IngestionMode} [ingestionMode]
+     * @param {ChunkType} [chunkType]
+     * @param {ImageTaxonomy} [secondaryTaxonomy]
+     * @param {number} [pageDpi] DPI for PDF page screenshots (default 72, min 36, max 216).
+     * @throws {RequiredError}
+     * @memberof DocumentsApiInterface
+     */
+    ingestDocumentVersionRequestOpts(requestParameters: IngestDocumentVersionRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Upload a new file for an existing document, creating a new version and triggering ingestion.  Creates a new document version (incrementing the highest version number), uploads the file to S3, and starts the ingestion workflow. Upon successful ingestion, the new version is automatically activated (set as the document\'s active_version) and the old version\'s Qdrant points are deactivated.  Returns 201 with the Temporal workflow ID.
+     * @summary Ingest Document Version Handler
+     * @param {string} documentId Document ID
+     * @param {Blob} file
+     * @param {string} [authorization]
+     * @param {string} [ksUat]
+     * @param {IngestionMode} [ingestionMode]
+     * @param {ChunkType} [chunkType]
+     * @param {ImageTaxonomy} [secondaryTaxonomy]
+     * @param {number} [pageDpi] DPI for PDF page screenshots (default 72, min 36, max 216).
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DocumentsApiInterface
+     */
+    ingestDocumentVersionRaw(requestParameters: IngestDocumentVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<IngestDocumentResponse>>;
+    /**
+     * Upload a new file for an existing document, creating a new version and triggering ingestion.  Creates a new document version (incrementing the highest version number), uploads the file to S3, and starts the ingestion workflow. Upon successful ingestion, the new version is automatically activated (set as the document\'s active_version) and the old version\'s Qdrant points are deactivated.  Returns 201 with the Temporal workflow ID.
+     * Ingest Document Version Handler
+     */
+    ingestDocumentVersion(requestParameters: IngestDocumentVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<IngestDocumentResponse>;
+    /**
+     * Creates request options for listDocuments without sending the request
+     * @param {string} [parentPathPartId] Parent PathPart ID (defaults to root)
+     * @param {PathOrder} [sortOrder] Sort order for results (default: LOGICAL)
+     * @param {boolean} [withTags] Include tags in the response (default: false)
+     * @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 DocumentsApiInterface
+     */
+    listDocumentsRequestOpts(requestParameters: ListDocumentsRequest): Promise<runtime.RequestOpts>;
+    /**
+     * List documents in a folder.  Returns only direct child documents (depth=1) of the specified parent folder. If parent_path_part_id is not provided, lists top-level documents.
+     * @summary List Documents Handler
+     * @param {string} [parentPathPartId] Parent PathPart ID (defaults to root)
+     * @param {PathOrder} [sortOrder] Sort order for results (default: LOGICAL)
+     * @param {boolean} [withTags] Include tags in the response (default: false)
+     * @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 DocumentsApiInterface
+     */
+    listDocumentsRaw(requestParameters: ListDocumentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseDocumentResponse>>;
+    /**
+     * List documents in a folder.  Returns only direct child documents (depth=1) of the specified parent folder. If parent_path_part_id is not provided, lists top-level documents.
+     * List Documents Handler
+     */
+    listDocuments(requestParameters: ListDocumentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseDocumentResponse>;
+    /**
+     * Creates request options for updateDocument without sending the request
+     * @param {string} documentId
+     * @param {UpdateDocumentRequest} updateDocumentRequest
+     * @param {string} [authorization]
+     * @param {string} [ksUat]
+     * @throws {RequiredError}
+     * @memberof DocumentsApiInterface
+     */
+    updateDocumentRequestOpts(requestParameters: UpdateDocumentOperationRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Update a document (rename, move, and/or change active version).  To rename: provide `name` field. To move: provide `parent_path_part_id` field. To change active version: provide `active_version_id` field. All can be done in a single request.
+     * @summary Update Document Handler
+     * @param {string} documentId
+     * @param {UpdateDocumentRequest} updateDocumentRequest
+     * @param {string} [authorization]
+     * @param {string} [ksUat]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DocumentsApiInterface
+     */
+    updateDocumentRaw(requestParameters: UpdateDocumentOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DocumentResponse>>;
+    /**
+     * Update a document (rename, move, and/or change active version).  To rename: provide `name` field. To move: provide `parent_path_part_id` field. To change active version: provide `active_version_id` field. All can be done in a single request.
+     * Update Document Handler
+     */
+    updateDocument(requestParameters: UpdateDocumentOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DocumentResponse>;
+}
+/**
+ *
+ */
+export declare class DocumentsApi extends runtime.BaseAPI implements DocumentsApiInterface {
+    /**
+     * Creates request options for createDocument without sending the request
+     */
+    createDocumentRequestOpts(requestParameters: CreateDocumentOperationRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Create a new document with initial v0 version.  The document is created as a child of the specified parent folder. An initial version (v0) is automatically created.
+     * Create Document Handler
+     */
+    createDocumentRaw(requestParameters: CreateDocumentOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DocumentResponse>>;
+    /**
+     * Create a new document with initial v0 version.  The document is created as a child of the specified parent folder. An initial version (v0) is automatically created.
+     * Create Document Handler
+     */
+    createDocument(requestParameters: CreateDocumentOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DocumentResponse>;
+    /**
+     * Creates request options for deleteDocument without sending the request
+     */
+    deleteDocumentRequestOpts(requestParameters: DeleteDocumentRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Delete a document and all its contents.  WARNING: This cascades to all children (versions, sections, chunks, etc.) due to parent_id ON DELETE CASCADE.
+     * Delete Document Handler
+     */
+    deleteDocumentRaw(requestParameters: DeleteDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Delete a document and all its contents.  WARNING: This cascades to all children (versions, sections, chunks, etc.) due to parent_id ON DELETE CASCADE.
+     * Delete Document Handler
+     */
+    deleteDocument(requestParameters: DeleteDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for getDocument without sending the request
+     */
+    getDocumentRequestOpts(requestParameters: GetDocumentRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Get a document by its document ID.
+     * Get Document Handler
+     */
+    getDocumentRaw(requestParameters: GetDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DocumentResponse>>;
+    /**
+     * Get a document by its document ID.
+     * Get Document Handler
+     */
+    getDocument(requestParameters: GetDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DocumentResponse>;
+    /**
+     * Creates request options for ingestDocument without sending the request
+     */
+    ingestDocumentRequestOpts(requestParameters: IngestDocumentRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Upload a file, create document + version, and trigger ingestion workflow.  Returns 201 with the Temporal workflow ID.
+     * Ingest Document Handler
+     */
+    ingestDocumentRaw(requestParameters: IngestDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<IngestDocumentResponse>>;
+    /**
+     * Upload a file, create document + version, and trigger ingestion workflow.  Returns 201 with the Temporal workflow ID.
+     * Ingest Document Handler
+     */
+    ingestDocument(requestParameters: IngestDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<IngestDocumentResponse>;
+    /**
+     * Creates request options for ingestDocumentVersion without sending the request
+     */
+    ingestDocumentVersionRequestOpts(requestParameters: IngestDocumentVersionRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Upload a new file for an existing document, creating a new version and triggering ingestion.  Creates a new document version (incrementing the highest version number), uploads the file to S3, and starts the ingestion workflow. Upon successful ingestion, the new version is automatically activated (set as the document\'s active_version) and the old version\'s Qdrant points are deactivated.  Returns 201 with the Temporal workflow ID.
+     * Ingest Document Version Handler
+     */
+    ingestDocumentVersionRaw(requestParameters: IngestDocumentVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<IngestDocumentResponse>>;
+    /**
+     * Upload a new file for an existing document, creating a new version and triggering ingestion.  Creates a new document version (incrementing the highest version number), uploads the file to S3, and starts the ingestion workflow. Upon successful ingestion, the new version is automatically activated (set as the document\'s active_version) and the old version\'s Qdrant points are deactivated.  Returns 201 with the Temporal workflow ID.
+     * Ingest Document Version Handler
+     */
+    ingestDocumentVersion(requestParameters: IngestDocumentVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<IngestDocumentResponse>;
+    /**
+     * Creates request options for listDocuments without sending the request
+     */
+    listDocumentsRequestOpts(requestParameters: ListDocumentsRequest): Promise<runtime.RequestOpts>;
+    /**
+     * List documents in a folder.  Returns only direct child documents (depth=1) of the specified parent folder. If parent_path_part_id is not provided, lists top-level documents.
+     * List Documents Handler
+     */
+    listDocumentsRaw(requestParameters: ListDocumentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseDocumentResponse>>;
+    /**
+     * List documents in a folder.  Returns only direct child documents (depth=1) of the specified parent folder. If parent_path_part_id is not provided, lists top-level documents.
+     * List Documents Handler
+     */
+    listDocuments(requestParameters?: ListDocumentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseDocumentResponse>;
+    /**
+     * Creates request options for updateDocument without sending the request
+     */
+    updateDocumentRequestOpts(requestParameters: UpdateDocumentOperationRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Update a document (rename, move, and/or change active version).  To rename: provide `name` field. To move: provide `parent_path_part_id` field. To change active version: provide `active_version_id` field. All can be done in a single request.
+     * Update Document Handler
+     */
+    updateDocumentRaw(requestParameters: UpdateDocumentOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DocumentResponse>>;
+    /**
+     * Update a document (rename, move, and/or change active version).  To rename: provide `name` field. To move: provide `parent_path_part_id` field. To change active version: provide `active_version_id` field. All can be done in a single request.
+     * Update Document Handler
+     */
+    updateDocument(requestParameters: UpdateDocumentOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DocumentResponse>;
+}