UNPKG

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.

280 lines (279 loc) 21.9 kB
import type { Configuration } from '../configuration'; import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; import { type RequestArgs, BaseAPI } from '../base'; import type { AnnotationFileRequest } from '../models'; import type { AnnotationsRead } from '../models'; import type { DataMetaRead } from '../models'; import type { JobAnnotationsUpdateRequest } from '../models'; import type { JobRead } from '../models'; import type { JobValidationLayoutRead } from '../models'; import type { JobWriteRequest } from '../models'; import type { PaginatedJobReadList } from '../models'; import type { PatchedJobDataMetaWriteRequest } from '../models'; import type { PatchedJobValidationLayoutWriteRequest } from '../models'; import type { PatchedJobWriteRequest } from '../models'; import type { PatchedLabeledDataRequest } from '../models'; import type { RqId } from '../models'; export declare const JobsApiAxiosParamCreator: (configuration?: Configuration) => { jobsCreate: (jobWriteRequest: JobWriteRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>; jobsCreateAnnotations: (id: number, cloudStorageId?: number, filename?: string, format?: string, location?: JobsCreateAnnotationsLocationEnum, useDefaultLocation?: boolean, annotationFileRequest?: AnnotationFileRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>; jobsCreateDatasetExport: (format: string, id: number, cloudStorageId?: number, filename?: string, location?: JobsCreateDatasetExportLocationEnum, saveImages?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>; jobsDestroy: (id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>; jobsDestroyAnnotations: (id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>; jobsList: (xOrganization?: string, assignee?: string, dimension?: JobsListDimensionEnum, filter?: string, org?: string, orgId?: number, page?: number, pageSize?: number, parentJobId?: number, projectId?: number, projectName?: string, search?: string, sort?: string, stage?: JobsListStageEnum, state?: JobsListStateEnum, taskId?: number, taskName?: string, type?: JobsListTypeEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>; jobsPartialUpdate: (id: number, patchedJobWriteRequest?: PatchedJobWriteRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>; jobsPartialUpdateAnnotations: (action: JobsPartialUpdateAnnotationsActionEnum, id: number, patchedLabeledDataRequest?: PatchedLabeledDataRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>; jobsPartialUpdateDataMeta: (id: number, patchedJobDataMetaWriteRequest?: PatchedJobDataMetaWriteRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>; jobsPartialUpdateValidationLayout: (id: number, patchedJobValidationLayoutWriteRequest?: PatchedJobValidationLayoutWriteRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>; jobsRetrieve: (id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>; jobsRetrieveAnnotations: (id: number, action?: JobsRetrieveAnnotationsActionEnum, cloudStorageId?: number, filename?: string, format?: string, location?: JobsRetrieveAnnotationsLocationEnum, useDefaultLocation?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>; jobsRetrieveData: (id: number, index?: number, number?: number, quality?: JobsRetrieveDataQualityEnum, type?: JobsRetrieveDataTypeEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>; jobsRetrieveDataMeta: (id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>; jobsRetrieveDataset: (format: string, id: number, action?: JobsRetrieveDatasetActionEnum, cloudStorageId?: number, filename?: string, location?: JobsRetrieveDatasetLocationEnum, useDefaultLocation?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>; jobsRetrievePreview: (id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>; jobsRetrieveValidationLayout: (id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>; jobsUpdateAnnotations: (id: number, cloudStorageId?: number, filename?: string, format?: string, location?: JobsUpdateAnnotationsLocationEnum, rqId?: string, jobAnnotationsUpdateRequest?: JobAnnotationsUpdateRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>; }; export declare const JobsApiFp: (configuration?: Configuration) => { jobsCreate(jobWriteRequest: JobWriteRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JobRead>>; jobsCreateAnnotations(id: number, cloudStorageId?: number, filename?: string, format?: string, location?: JobsCreateAnnotationsLocationEnum, useDefaultLocation?: boolean, annotationFileRequest?: AnnotationFileRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>; jobsCreateDatasetExport(format: string, id: number, cloudStorageId?: number, filename?: string, location?: JobsCreateDatasetExportLocationEnum, saveImages?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RqId>>; jobsDestroy(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>; jobsDestroyAnnotations(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>; jobsList(xOrganization?: string, assignee?: string, dimension?: JobsListDimensionEnum, filter?: string, org?: string, orgId?: number, page?: number, pageSize?: number, parentJobId?: number, projectId?: number, projectName?: string, search?: string, sort?: string, stage?: JobsListStageEnum, state?: JobsListStateEnum, taskId?: number, taskName?: string, type?: JobsListTypeEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedJobReadList>>; jobsPartialUpdate(id: number, patchedJobWriteRequest?: PatchedJobWriteRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JobRead>>; jobsPartialUpdateAnnotations(action: JobsPartialUpdateAnnotationsActionEnum, id: number, patchedLabeledDataRequest?: PatchedLabeledDataRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>; jobsPartialUpdateDataMeta(id: number, patchedJobDataMetaWriteRequest?: PatchedJobDataMetaWriteRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataMetaRead>>; jobsPartialUpdateValidationLayout(id: number, patchedJobValidationLayoutWriteRequest?: PatchedJobValidationLayoutWriteRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JobValidationLayoutRead>>; jobsRetrieve(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JobRead>>; jobsRetrieveAnnotations(id: number, action?: JobsRetrieveAnnotationsActionEnum, cloudStorageId?: number, filename?: string, format?: string, location?: JobsRetrieveAnnotationsLocationEnum, useDefaultLocation?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AnnotationsRead>>; jobsRetrieveData(id: number, index?: number, number?: number, quality?: JobsRetrieveDataQualityEnum, type?: JobsRetrieveDataTypeEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>; jobsRetrieveDataMeta(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataMetaRead>>; jobsRetrieveDataset(format: string, id: number, action?: JobsRetrieveDatasetActionEnum, cloudStorageId?: number, filename?: string, location?: JobsRetrieveDatasetLocationEnum, useDefaultLocation?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>; jobsRetrievePreview(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>; jobsRetrieveValidationLayout(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JobValidationLayoutRead>>; jobsUpdateAnnotations(id: number, cloudStorageId?: number, filename?: string, format?: string, location?: JobsUpdateAnnotationsLocationEnum, rqId?: string, jobAnnotationsUpdateRequest?: JobAnnotationsUpdateRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>; }; export declare const JobsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { jobsCreate(requestParameters: JobsApiJobsCreateRequest, options?: RawAxiosRequestConfig): AxiosPromise<JobRead>; jobsCreateAnnotations(requestParameters: JobsApiJobsCreateAnnotationsRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>; jobsCreateDatasetExport(requestParameters: JobsApiJobsCreateDatasetExportRequest, options?: RawAxiosRequestConfig): AxiosPromise<RqId>; jobsDestroy(requestParameters: JobsApiJobsDestroyRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>; jobsDestroyAnnotations(requestParameters: JobsApiJobsDestroyAnnotationsRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>; jobsList(requestParameters?: JobsApiJobsListRequest, options?: RawAxiosRequestConfig): AxiosPromise<PaginatedJobReadList>; jobsPartialUpdate(requestParameters: JobsApiJobsPartialUpdateRequest, options?: RawAxiosRequestConfig): AxiosPromise<JobRead>; jobsPartialUpdateAnnotations(requestParameters: JobsApiJobsPartialUpdateAnnotationsRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>; jobsPartialUpdateDataMeta(requestParameters: JobsApiJobsPartialUpdateDataMetaRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataMetaRead>; jobsPartialUpdateValidationLayout(requestParameters: JobsApiJobsPartialUpdateValidationLayoutRequest, options?: RawAxiosRequestConfig): AxiosPromise<JobValidationLayoutRead>; jobsRetrieve(requestParameters: JobsApiJobsRetrieveRequest, options?: RawAxiosRequestConfig): AxiosPromise<JobRead>; jobsRetrieveAnnotations(requestParameters: JobsApiJobsRetrieveAnnotationsRequest, options?: RawAxiosRequestConfig): AxiosPromise<AnnotationsRead>; jobsRetrieveData(requestParameters: JobsApiJobsRetrieveDataRequest, options?: RawAxiosRequestConfig): AxiosPromise<File>; jobsRetrieveDataMeta(requestParameters: JobsApiJobsRetrieveDataMetaRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataMetaRead>; jobsRetrieveDataset(requestParameters: JobsApiJobsRetrieveDatasetRequest, options?: RawAxiosRequestConfig): AxiosPromise<File>; jobsRetrievePreview(requestParameters: JobsApiJobsRetrievePreviewRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>; jobsRetrieveValidationLayout(requestParameters: JobsApiJobsRetrieveValidationLayoutRequest, options?: RawAxiosRequestConfig): AxiosPromise<JobValidationLayoutRead>; jobsUpdateAnnotations(requestParameters: JobsApiJobsUpdateAnnotationsRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>; }; export interface JobsApiJobsCreateRequest { readonly jobWriteRequest: JobWriteRequest; } export interface JobsApiJobsCreateAnnotationsRequest { readonly id: number; readonly cloudStorageId?: number; readonly filename?: string; readonly format?: string; readonly location?: JobsCreateAnnotationsLocationEnum; readonly useDefaultLocation?: boolean; readonly annotationFileRequest?: AnnotationFileRequest; } export interface JobsApiJobsCreateDatasetExportRequest { readonly format: string; readonly id: number; readonly cloudStorageId?: number; readonly filename?: string; readonly location?: JobsCreateDatasetExportLocationEnum; readonly saveImages?: boolean; } export interface JobsApiJobsDestroyRequest { readonly id: number; } export interface JobsApiJobsDestroyAnnotationsRequest { readonly id: number; } export interface JobsApiJobsListRequest { readonly xOrganization?: string; readonly assignee?: string; readonly dimension?: JobsListDimensionEnum; readonly filter?: string; readonly org?: string; readonly orgId?: number; readonly page?: number; readonly pageSize?: number; readonly parentJobId?: number; readonly projectId?: number; readonly projectName?: string; readonly search?: string; readonly sort?: string; readonly stage?: JobsListStageEnum; readonly state?: JobsListStateEnum; readonly taskId?: number; readonly taskName?: string; readonly type?: JobsListTypeEnum; } export interface JobsApiJobsPartialUpdateRequest { readonly id: number; readonly patchedJobWriteRequest?: PatchedJobWriteRequest; } export interface JobsApiJobsPartialUpdateAnnotationsRequest { readonly action: JobsPartialUpdateAnnotationsActionEnum; readonly id: number; readonly patchedLabeledDataRequest?: PatchedLabeledDataRequest; } export interface JobsApiJobsPartialUpdateDataMetaRequest { readonly id: number; readonly patchedJobDataMetaWriteRequest?: PatchedJobDataMetaWriteRequest; } export interface JobsApiJobsPartialUpdateValidationLayoutRequest { readonly id: number; readonly patchedJobValidationLayoutWriteRequest?: PatchedJobValidationLayoutWriteRequest; } export interface JobsApiJobsRetrieveRequest { readonly id: number; } export interface JobsApiJobsRetrieveAnnotationsRequest { readonly id: number; readonly action?: JobsRetrieveAnnotationsActionEnum; readonly cloudStorageId?: number; readonly filename?: string; readonly format?: string; readonly location?: JobsRetrieveAnnotationsLocationEnum; readonly useDefaultLocation?: boolean; } export interface JobsApiJobsRetrieveDataRequest { readonly id: number; readonly index?: number; readonly number?: number; readonly quality?: JobsRetrieveDataQualityEnum; readonly type?: JobsRetrieveDataTypeEnum; } export interface JobsApiJobsRetrieveDataMetaRequest { readonly id: number; } export interface JobsApiJobsRetrieveDatasetRequest { readonly format: string; readonly id: number; readonly action?: JobsRetrieveDatasetActionEnum; readonly cloudStorageId?: number; readonly filename?: string; readonly location?: JobsRetrieveDatasetLocationEnum; readonly useDefaultLocation?: boolean; } export interface JobsApiJobsRetrievePreviewRequest { readonly id: number; } export interface JobsApiJobsRetrieveValidationLayoutRequest { readonly id: number; } export interface JobsApiJobsUpdateAnnotationsRequest { readonly id: number; readonly cloudStorageId?: number; readonly filename?: string; readonly format?: string; readonly location?: JobsUpdateAnnotationsLocationEnum; readonly rqId?: string; readonly jobAnnotationsUpdateRequest?: JobAnnotationsUpdateRequest; } export declare class JobsApi extends BaseAPI { jobsCreate(requestParameters: JobsApiJobsCreateRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<JobRead, any>>; jobsCreateAnnotations(requestParameters: JobsApiJobsCreateAnnotationsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>; jobsCreateDatasetExport(requestParameters: JobsApiJobsCreateDatasetExportRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RqId, any>>; jobsDestroy(requestParameters: JobsApiJobsDestroyRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>; jobsDestroyAnnotations(requestParameters: JobsApiJobsDestroyAnnotationsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>; jobsList(requestParameters?: JobsApiJobsListRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaginatedJobReadList, any>>; jobsPartialUpdate(requestParameters: JobsApiJobsPartialUpdateRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<JobRead, any>>; jobsPartialUpdateAnnotations(requestParameters: JobsApiJobsPartialUpdateAnnotationsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>; jobsPartialUpdateDataMeta(requestParameters: JobsApiJobsPartialUpdateDataMetaRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataMetaRead, any>>; jobsPartialUpdateValidationLayout(requestParameters: JobsApiJobsPartialUpdateValidationLayoutRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<JobValidationLayoutRead, any>>; jobsRetrieve(requestParameters: JobsApiJobsRetrieveRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<JobRead, any>>; jobsRetrieveAnnotations(requestParameters: JobsApiJobsRetrieveAnnotationsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AnnotationsRead, any>>; jobsRetrieveData(requestParameters: JobsApiJobsRetrieveDataRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any>>; jobsRetrieveDataMeta(requestParameters: JobsApiJobsRetrieveDataMetaRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataMetaRead, any>>; jobsRetrieveDataset(requestParameters: JobsApiJobsRetrieveDatasetRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any>>; jobsRetrievePreview(requestParameters: JobsApiJobsRetrievePreviewRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>; jobsRetrieveValidationLayout(requestParameters: JobsApiJobsRetrieveValidationLayoutRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<JobValidationLayoutRead, any>>; jobsUpdateAnnotations(requestParameters: JobsApiJobsUpdateAnnotationsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>; } export declare const JobsCreateAnnotationsLocationEnum: { readonly CloudStorage: "cloud_storage"; readonly Local: "local"; }; export type JobsCreateAnnotationsLocationEnum = typeof JobsCreateAnnotationsLocationEnum[keyof typeof JobsCreateAnnotationsLocationEnum]; export declare const JobsCreateDatasetExportLocationEnum: { readonly CloudStorage: "cloud_storage"; readonly Local: "local"; }; export type JobsCreateDatasetExportLocationEnum = typeof JobsCreateDatasetExportLocationEnum[keyof typeof JobsCreateDatasetExportLocationEnum]; export declare const JobsListDimensionEnum: { readonly _3d: "3d"; readonly _2d: "2d"; }; export type JobsListDimensionEnum = typeof JobsListDimensionEnum[keyof typeof JobsListDimensionEnum]; export declare const JobsListStageEnum: { readonly Annotation: "annotation"; readonly Validation: "validation"; readonly Acceptance: "acceptance"; }; export type JobsListStageEnum = typeof JobsListStageEnum[keyof typeof JobsListStageEnum]; export declare const JobsListStateEnum: { readonly New: "new"; readonly InProgress: "in progress"; readonly Completed: "completed"; readonly Rejected: "rejected"; }; export type JobsListStateEnum = typeof JobsListStateEnum[keyof typeof JobsListStateEnum]; export declare const JobsListTypeEnum: { readonly Annotation: "annotation"; readonly GroundTruth: "ground_truth"; readonly ConsensusReplica: "consensus_replica"; }; export type JobsListTypeEnum = typeof JobsListTypeEnum[keyof typeof JobsListTypeEnum]; export declare const JobsPartialUpdateAnnotationsActionEnum: { readonly Create: "create"; readonly Delete: "delete"; readonly Update: "update"; }; export type JobsPartialUpdateAnnotationsActionEnum = typeof JobsPartialUpdateAnnotationsActionEnum[keyof typeof JobsPartialUpdateAnnotationsActionEnum]; export declare const JobsRetrieveAnnotationsActionEnum: { readonly Download: "download"; }; export type JobsRetrieveAnnotationsActionEnum = typeof JobsRetrieveAnnotationsActionEnum[keyof typeof JobsRetrieveAnnotationsActionEnum]; export declare const JobsRetrieveAnnotationsLocationEnum: { readonly CloudStorage: "cloud_storage"; readonly Local: "local"; }; export type JobsRetrieveAnnotationsLocationEnum = typeof JobsRetrieveAnnotationsLocationEnum[keyof typeof JobsRetrieveAnnotationsLocationEnum]; export declare const JobsRetrieveDataQualityEnum: { readonly Compressed: "compressed"; readonly Original: "original"; }; export type JobsRetrieveDataQualityEnum = typeof JobsRetrieveDataQualityEnum[keyof typeof JobsRetrieveDataQualityEnum]; export declare const JobsRetrieveDataTypeEnum: { readonly Chunk: "chunk"; readonly ContextImage: "context_image"; readonly Frame: "frame"; }; export type JobsRetrieveDataTypeEnum = typeof JobsRetrieveDataTypeEnum[keyof typeof JobsRetrieveDataTypeEnum]; export declare const JobsRetrieveDatasetActionEnum: { readonly Download: "download"; }; export type JobsRetrieveDatasetActionEnum = typeof JobsRetrieveDatasetActionEnum[keyof typeof JobsRetrieveDatasetActionEnum]; export declare const JobsRetrieveDatasetLocationEnum: { readonly CloudStorage: "cloud_storage"; readonly Local: "local"; }; export type JobsRetrieveDatasetLocationEnum = typeof JobsRetrieveDatasetLocationEnum[keyof typeof JobsRetrieveDatasetLocationEnum]; export declare const JobsUpdateAnnotationsLocationEnum: { readonly CloudStorage: "cloud_storage"; readonly Local: "local"; }; export type JobsUpdateAnnotationsLocationEnum = typeof JobsUpdateAnnotationsLocationEnum[keyof typeof JobsUpdateAnnotationsLocationEnum];