cvat-sdk
Version:
CVAT SDK is a Javascript library. It provides you access to Javascript functions and objects that simplify server interaction and provide additional functionality like data validation and serialization.
122 lines (121 loc) • 9.76 kB
TypeScript
import type { Configuration } from '../configuration';
import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
import { type RequestArgs, BaseAPI } from '../base';
import type { PaginatedAnnotationConflictList } from '../models';
import type { PaginatedQualityReportList } from '../models';
import type { PaginatedQualitySettingsList } from '../models';
import type { PatchedQualitySettingsRequest } from '../models';
import type { QualityReport } from '../models';
import type { QualityReportCreateRequest } from '../models';
import type { QualitySettings } from '../models';
export declare const QualityApiAxiosParamCreator: (configuration?: Configuration) => {
qualityCreateReport: (rqId?: string, qualityReportCreateRequest?: QualityReportCreateRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
qualityListConflicts: (xOrganization?: string, filter?: string, frame?: number, jobId?: number, org?: string, orgId?: number, page?: number, pageSize?: number, reportId?: number, severity?: QualityListConflictsSeverityEnum, sort?: string, taskId?: number, type?: QualityListConflictsTypeEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
qualityListReports: (xOrganization?: string, filter?: string, jobId?: number, org?: string, orgId?: number, page?: number, pageSize?: number, parentId?: number, sort?: string, target?: string, taskId?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
qualityListSettings: (xOrganization?: string, filter?: string, org?: string, orgId?: number, page?: number, pageSize?: number, sort?: string, taskId?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
qualityPartialUpdateSettings: (id: number, patchedQualitySettingsRequest?: PatchedQualitySettingsRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
qualityRetrieveReport: (id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
qualityRetrieveReportData: (id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
qualityRetrieveSettings: (id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
};
export declare const QualityApiFp: (configuration?: Configuration) => {
qualityCreateReport(rqId?: string, qualityReportCreateRequest?: QualityReportCreateRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<QualityReport>>;
qualityListConflicts(xOrganization?: string, filter?: string, frame?: number, jobId?: number, org?: string, orgId?: number, page?: number, pageSize?: number, reportId?: number, severity?: QualityListConflictsSeverityEnum, sort?: string, taskId?: number, type?: QualityListConflictsTypeEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedAnnotationConflictList>>;
qualityListReports(xOrganization?: string, filter?: string, jobId?: number, org?: string, orgId?: number, page?: number, pageSize?: number, parentId?: number, sort?: string, target?: string, taskId?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedQualityReportList>>;
qualityListSettings(xOrganization?: string, filter?: string, org?: string, orgId?: number, page?: number, pageSize?: number, sort?: string, taskId?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedQualitySettingsList>>;
qualityPartialUpdateSettings(id: number, patchedQualitySettingsRequest?: PatchedQualitySettingsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<QualitySettings>>;
qualityRetrieveReport(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<QualityReport>>;
qualityRetrieveReportData(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
qualityRetrieveSettings(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<QualitySettings>>;
};
export declare const QualityApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
qualityCreateReport(requestParameters?: QualityApiQualityCreateReportRequest, options?: RawAxiosRequestConfig): AxiosPromise<QualityReport>;
qualityListConflicts(requestParameters?: QualityApiQualityListConflictsRequest, options?: RawAxiosRequestConfig): AxiosPromise<PaginatedAnnotationConflictList>;
qualityListReports(requestParameters?: QualityApiQualityListReportsRequest, options?: RawAxiosRequestConfig): AxiosPromise<PaginatedQualityReportList>;
qualityListSettings(requestParameters?: QualityApiQualityListSettingsRequest, options?: RawAxiosRequestConfig): AxiosPromise<PaginatedQualitySettingsList>;
qualityPartialUpdateSettings(requestParameters: QualityApiQualityPartialUpdateSettingsRequest, options?: RawAxiosRequestConfig): AxiosPromise<QualitySettings>;
qualityRetrieveReport(requestParameters: QualityApiQualityRetrieveReportRequest, options?: RawAxiosRequestConfig): AxiosPromise<QualityReport>;
qualityRetrieveReportData(requestParameters: QualityApiQualityRetrieveReportDataRequest, options?: RawAxiosRequestConfig): AxiosPromise<object>;
qualityRetrieveSettings(requestParameters: QualityApiQualityRetrieveSettingsRequest, options?: RawAxiosRequestConfig): AxiosPromise<QualitySettings>;
};
export interface QualityApiQualityCreateReportRequest {
readonly rqId?: string;
readonly qualityReportCreateRequest?: QualityReportCreateRequest;
}
export interface QualityApiQualityListConflictsRequest {
readonly xOrganization?: string;
readonly filter?: string;
readonly frame?: number;
readonly jobId?: number;
readonly org?: string;
readonly orgId?: number;
readonly page?: number;
readonly pageSize?: number;
readonly reportId?: number;
readonly severity?: QualityListConflictsSeverityEnum;
readonly sort?: string;
readonly taskId?: number;
readonly type?: QualityListConflictsTypeEnum;
}
export interface QualityApiQualityListReportsRequest {
readonly xOrganization?: string;
readonly filter?: string;
readonly jobId?: number;
readonly org?: string;
readonly orgId?: number;
readonly page?: number;
readonly pageSize?: number;
readonly parentId?: number;
readonly sort?: string;
readonly target?: string;
readonly taskId?: number;
}
export interface QualityApiQualityListSettingsRequest {
readonly xOrganization?: string;
readonly filter?: string;
readonly org?: string;
readonly orgId?: number;
readonly page?: number;
readonly pageSize?: number;
readonly sort?: string;
readonly taskId?: number;
}
export interface QualityApiQualityPartialUpdateSettingsRequest {
readonly id: number;
readonly patchedQualitySettingsRequest?: PatchedQualitySettingsRequest;
}
export interface QualityApiQualityRetrieveReportRequest {
readonly id: number;
}
export interface QualityApiQualityRetrieveReportDataRequest {
readonly id: number;
}
export interface QualityApiQualityRetrieveSettingsRequest {
readonly id: number;
}
export declare class QualityApi extends BaseAPI {
qualityCreateReport(requestParameters?: QualityApiQualityCreateReportRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<QualityReport, any>>;
qualityListConflicts(requestParameters?: QualityApiQualityListConflictsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaginatedAnnotationConflictList, any>>;
qualityListReports(requestParameters?: QualityApiQualityListReportsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaginatedQualityReportList, any>>;
qualityListSettings(requestParameters?: QualityApiQualityListSettingsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaginatedQualitySettingsList, any>>;
qualityPartialUpdateSettings(requestParameters: QualityApiQualityPartialUpdateSettingsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<QualitySettings, any>>;
qualityRetrieveReport(requestParameters: QualityApiQualityRetrieveReportRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<QualityReport, any>>;
qualityRetrieveReportData(requestParameters: QualityApiQualityRetrieveReportDataRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
qualityRetrieveSettings(requestParameters: QualityApiQualityRetrieveSettingsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<QualitySettings, any>>;
}
export declare const QualityListConflictsSeverityEnum: {
readonly Warning: "warning";
readonly Error: "error";
};
export type QualityListConflictsSeverityEnum = typeof QualityListConflictsSeverityEnum[keyof typeof QualityListConflictsSeverityEnum];
export declare const QualityListConflictsTypeEnum: {
readonly MissingAnnotation: "missing_annotation";
readonly ExtraAnnotation: "extra_annotation";
readonly MismatchingLabel: "mismatching_label";
readonly LowOverlap: "low_overlap";
readonly MismatchingDirection: "mismatching_direction";
readonly MismatchingAttributes: "mismatching_attributes";
readonly MismatchingGroups: "mismatching_groups";
readonly CoveredAnnotation: "covered_annotation";
};
export type QualityListConflictsTypeEnum = typeof QualityListConflictsTypeEnum[keyof typeof QualityListConflictsTypeEnum];