/** * openfilz-api * API for Document Management System * * The version of the OpenAPI document: 1.0.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 type { Configuration } from '../configuration'; import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; import { type RequestArgs, BaseAPI } from '../base'; import type { DocumentInsightView } from '../models'; import type { InsightBackfillRequest } from '../models'; import type { InsightBackfillStatus } from '../models'; import type { InsightCategoryUpdate } from '../models'; import type { InsightFacets } from '../models'; /** * DocumentInsightsApi - axios parameter creator */ export declare const DocumentInsightsApiAxiosParamCreator: (configuration?: Configuration) => { /** * Queues every FILE without a tier-2 insight (or with an older prompt version when force), optionally under one folder, and returns the job at once. Poll GET /backfill/{jobId}. * @summary Enrich existing documents * @param {InsightBackfillRequest} [insightBackfillRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ backfill: (insightBackfillRequest?: InsightBackfillRequest, options?: RawAxiosRequestConfig) => Promise; /** * * @summary Progress of a backfill job * @param {string} jobId * @param {*} [options] Override http request option. * @throws {RequiredError} */ backfillStatus: (jobId: string, options?: RawAxiosRequestConfig) => Promise; /** * How many active files carry each tier-2 category and each detected language, from the document insights (largest first). The keys are what searchDocuments accepts in its \'category\' / \'language\' filters. 404 when the AI features are off (openfilz.ai.active); READER. * @summary The category and language facets of the library * @param {*} [options] Override http request option. * @throws {RequiredError} */ facets: (options?: RawAxiosRequestConfig) => Promise; /** * Tier 1: the file\'s own metadata (title, author, dates, page count, language) captured at upload. Tier 2: the AI-derived category, summary, keywords and entities when openfilz.ai.insights.active is on. 404 when the document is not visible or has no insights yet. * @summary Get the insights of a document * @param {string} documentId * @param {*} [options] Override http request option. * @throws {RequiredError} */ getInsights: (documentId: string, options?: RawAxiosRequestConfig) => Promise; /** * Sets the tier-2 category to one of the deployment\'s kinds (the category taxonomy: openfilz.ai.insights.categories, or \'other\'), recorded as written by the user: it is never overwritten by a non-forced backfill, it teaches the learned classifier, and the by-kind reorganisation and smart filing use it like a model\'s label. 400 for a kind the deployment does not know; 403 without modify access. * @summary Correct the kind of a document * @param {string} documentId * @param {InsightCategoryUpdate} insightCategoryUpdate * @param {*} [options] Override http request option. * @throws {RequiredError} */ setCategory: (documentId: string, insightCategoryUpdate: InsightCategoryUpdate, options?: RawAxiosRequestConfig) => Promise; }; /** * DocumentInsightsApi - functional programming interface */ export declare const DocumentInsightsApiFp: (configuration?: Configuration) => { /** * Queues every FILE without a tier-2 insight (or with an older prompt version when force), optionally under one folder, and returns the job at once. Poll GET /backfill/{jobId}. * @summary Enrich existing documents * @param {InsightBackfillRequest} [insightBackfillRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ backfill(insightBackfillRequest?: InsightBackfillRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Progress of a backfill job * @param {string} jobId * @param {*} [options] Override http request option. * @throws {RequiredError} */ backfillStatus(jobId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * How many active files carry each tier-2 category and each detected language, from the document insights (largest first). The keys are what searchDocuments accepts in its \'category\' / \'language\' filters. 404 when the AI features are off (openfilz.ai.active); READER. * @summary The category and language facets of the library * @param {*} [options] Override http request option. * @throws {RequiredError} */ facets(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Tier 1: the file\'s own metadata (title, author, dates, page count, language) captured at upload. Tier 2: the AI-derived category, summary, keywords and entities when openfilz.ai.insights.active is on. 404 when the document is not visible or has no insights yet. * @summary Get the insights of a document * @param {string} documentId * @param {*} [options] Override http request option. * @throws {RequiredError} */ getInsights(documentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Sets the tier-2 category to one of the deployment\'s kinds (the category taxonomy: openfilz.ai.insights.categories, or \'other\'), recorded as written by the user: it is never overwritten by a non-forced backfill, it teaches the learned classifier, and the by-kind reorganisation and smart filing use it like a model\'s label. 400 for a kind the deployment does not know; 403 without modify access. * @summary Correct the kind of a document * @param {string} documentId * @param {InsightCategoryUpdate} insightCategoryUpdate * @param {*} [options] Override http request option. * @throws {RequiredError} */ setCategory(documentId: string, insightCategoryUpdate: InsightCategoryUpdate, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * DocumentInsightsApi - factory interface */ export declare const DocumentInsightsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Queues every FILE without a tier-2 insight (or with an older prompt version when force), optionally under one folder, and returns the job at once. Poll GET /backfill/{jobId}. * @summary Enrich existing documents * @param {InsightBackfillRequest} [insightBackfillRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ backfill(insightBackfillRequest?: InsightBackfillRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * * @summary Progress of a backfill job * @param {string} jobId * @param {*} [options] Override http request option. * @throws {RequiredError} */ backfillStatus(jobId: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * How many active files carry each tier-2 category and each detected language, from the document insights (largest first). The keys are what searchDocuments accepts in its \'category\' / \'language\' filters. 404 when the AI features are off (openfilz.ai.active); READER. * @summary The category and language facets of the library * @param {*} [options] Override http request option. * @throws {RequiredError} */ facets(options?: RawAxiosRequestConfig): AxiosPromise; /** * Tier 1: the file\'s own metadata (title, author, dates, page count, language) captured at upload. Tier 2: the AI-derived category, summary, keywords and entities when openfilz.ai.insights.active is on. 404 when the document is not visible or has no insights yet. * @summary Get the insights of a document * @param {string} documentId * @param {*} [options] Override http request option. * @throws {RequiredError} */ getInsights(documentId: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Sets the tier-2 category to one of the deployment\'s kinds (the category taxonomy: openfilz.ai.insights.categories, or \'other\'), recorded as written by the user: it is never overwritten by a non-forced backfill, it teaches the learned classifier, and the by-kind reorganisation and smart filing use it like a model\'s label. 400 for a kind the deployment does not know; 403 without modify access. * @summary Correct the kind of a document * @param {string} documentId * @param {InsightCategoryUpdate} insightCategoryUpdate * @param {*} [options] Override http request option. * @throws {RequiredError} */ setCategory(documentId: string, insightCategoryUpdate: InsightCategoryUpdate, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * DocumentInsightsApi - object-oriented interface */ export declare class DocumentInsightsApi extends BaseAPI { /** * Queues every FILE without a tier-2 insight (or with an older prompt version when force), optionally under one folder, and returns the job at once. Poll GET /backfill/{jobId}. * @summary Enrich existing documents * @param {InsightBackfillRequest} [insightBackfillRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ backfill(insightBackfillRequest?: InsightBackfillRequest, options?: RawAxiosRequestConfig): Promise>; /** * * @summary Progress of a backfill job * @param {string} jobId * @param {*} [options] Override http request option. * @throws {RequiredError} */ backfillStatus(jobId: string, options?: RawAxiosRequestConfig): Promise>; /** * How many active files carry each tier-2 category and each detected language, from the document insights (largest first). The keys are what searchDocuments accepts in its \'category\' / \'language\' filters. 404 when the AI features are off (openfilz.ai.active); READER. * @summary The category and language facets of the library * @param {*} [options] Override http request option. * @throws {RequiredError} */ facets(options?: RawAxiosRequestConfig): Promise>; /** * Tier 1: the file\'s own metadata (title, author, dates, page count, language) captured at upload. Tier 2: the AI-derived category, summary, keywords and entities when openfilz.ai.insights.active is on. 404 when the document is not visible or has no insights yet. * @summary Get the insights of a document * @param {string} documentId * @param {*} [options] Override http request option. * @throws {RequiredError} */ getInsights(documentId: string, options?: RawAxiosRequestConfig): Promise>; /** * Sets the tier-2 category to one of the deployment\'s kinds (the category taxonomy: openfilz.ai.insights.categories, or \'other\'), recorded as written by the user: it is never overwritten by a non-forced backfill, it teaches the learned classifier, and the by-kind reorganisation and smart filing use it like a model\'s label. 400 for a kind the deployment does not know; 403 without modify access. * @summary Correct the kind of a document * @param {string} documentId * @param {InsightCategoryUpdate} insightCategoryUpdate * @param {*} [options] Override http request option. * @throws {RequiredError} */ setCategory(documentId: string, insightCategoryUpdate: InsightCategoryUpdate, options?: RawAxiosRequestConfig): Promise>; }