Class JobsApi

JobsApi - object-oriented interface

Export

Hierarchy

  • BaseAPI
    • JobsApi

Constructors

constructor

Properties

axios basePath configuration

Methods

jobsCreate jobsCreateAnnotations jobsDestroy jobsDestroyAnnotations jobsList jobsPartialUpdate jobsPartialUpdateAnnotations jobsRetrieve jobsRetrieveAnnotations jobsRetrieveData jobsRetrieveDataMeta jobsRetrieveDataset jobsRetrievePreview jobsUpdateAnnotations

Constructors

constructor

  • Parameters

    • Optional configuration: Configuration
    • basePath: string = BASE_PATH
    • axios: AxiosInstance = globalAxios

    Returns JobsApi

Properties

Protected axios

axios: AxiosInstance = globalAxios

Protected basePath

basePath: string = BASE_PATH

Protected configuration

configuration: undefined | Configuration

Methods

jobsCreate

  • Parameters

    • requestParameters: JobsApiJobsCreateRequest

      Request parameters.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<AxiosResponse<JobRead, any>>

    Summary

    Method creates a new job in the task

    Throws

    Memberof

    JobsApi

jobsCreateAnnotations

  • The request POST /api/jobs/id/annotations will initiate file upload and will create the rq job on the server in which the process of annotations uploading from file will be carried out. Please, use the PUT /api/jobs/id/annotations endpoint for checking status of the process.

    Parameters

    Returns Promise<AxiosResponse<void, any>>

    Summary

    Method allows to initialize the process of the job annotation upload from a local file or a cloud storage

    Throws

    Memberof

    JobsApi

jobsDestroy

  • Please note, that not every job can be removed. Currently, it is only available for Ground Truth jobs.

    Parameters

    • requestParameters: JobsApiJobsDestroyRequest

      Request parameters.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<AxiosResponse<void, any>>

    Summary

    Method deletes a job and its related annotations

    Throws

    Memberof

    JobsApi

jobsDestroyAnnotations

  • Parameters

    Returns Promise<AxiosResponse<void, any>>

    Summary

    Method deletes all annotations for a specific job

    Throws

    Memberof

    JobsApi

jobsList

jobsPartialUpdate

  • Parameters

    Returns Promise<AxiosResponse<JobRead, any>>

    Summary

    Methods does a partial update of chosen fields in a job

    Throws

    Memberof

    JobsApi

jobsPartialUpdateAnnotations

  • Parameters

    Returns Promise<AxiosResponse<void, any>>

    Summary

    Method performs a partial update of annotations in a specific job

    Throws

    Memberof

    JobsApi

jobsRetrieve

  • Parameters

    • requestParameters: JobsApiJobsRetrieveRequest

      Request parameters.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<AxiosResponse<JobRead, any>>

    Summary

    Method returns details of a job

    Throws

    Memberof

    JobsApi

jobsRetrieveAnnotations

  • Parameters

    Returns Promise<AxiosResponse<AnnotationsRead, any>>

    Summary

    Method returns annotations for a specific job as a JSON document. If format is specified, a zip archive is returned.

    Throws

    Memberof

    JobsApi

jobsRetrieveData

  • Parameters

    Returns Promise<AxiosResponse<File, any>>

    Summary

    Method returns data for a specific job

    Throws

    Memberof

    JobsApi

jobsRetrieveDataMeta

  • Parameters

    Returns Promise<AxiosResponse<DataMetaRead, any>>

    Summary

    Method provides a meta information about media files which are related with the job

    Throws

    Memberof

    JobsApi

jobsRetrieveDataset

  • Parameters

    Returns Promise<AxiosResponse<File, any>>

    Summary

    Export job as a dataset in a specific format

    Throws

    Memberof

    JobsApi

jobsRetrievePreview

  • Parameters

    Returns Promise<AxiosResponse<void, any>>

    Summary

    Method returns a preview image for the job

    Throws

    Memberof

    JobsApi

jobsUpdateAnnotations

  • To check the status of the process of uploading a job annotations from a file: After initiating the annotations upload, you will receive an rq_id parameter. Make sure to include this parameter as a query parameter in your subsequent PUT /api/jobs/id/annotations requests to track the status of the annotations upload.

    Parameters

    Returns Promise<AxiosResponse<void, any>>

    Summary

    Method performs an update of all annotations in a specific job or used for uploading annotations from a file

    Throws

    Memberof

    JobsApi

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc