Function JobsApiFactory

Returns {
    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>;
}

• jobsCreate:function

  • jobsCreate(
        requestParameters: JobsApiJobsCreateRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<JobRead>

    Parameters

    • requestParameters: JobsApiJobsCreateRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<JobRead>

    Throws

• jobsCreateAnnotations:function

  • jobsCreateAnnotations(
        requestParameters: JobsApiJobsCreateAnnotationsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>

    The request POST /api/jobs/id/annotations initiates a background process to import annotations into a job. Please, use the GET /api/requests/<rq_id> endpoint for checking status of the process. The rq_id parameter can be found in the response on initiating request.

    Parameters

    • requestParameters: JobsApiJobsCreateAnnotationsRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Throws

• jobsCreateDatasetExport:function

  • jobsCreateDatasetExport(
        requestParameters: JobsApiJobsCreateDatasetExportRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<RqId>

    The request POST /api/<projects|tasks|jobs>/id/dataset/export will initialize a background process to export a dataset. To check status of the process please, use GET /api/requests/<rq_id> where rq_id is request ID returned in the response for this endpoint.

    Parameters

    • requestParameters: JobsApiJobsCreateDatasetExportRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<RqId>

    Throws

• jobsDestroy:function

  • jobsDestroy(
        requestParameters: JobsApiJobsDestroyRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>

    Related annotations will be deleted as well. Please note, that not every job can be removed. Currently, it is only available for Ground Truth jobs.

    Parameters

    • requestParameters: JobsApiJobsDestroyRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Throws

• jobsDestroyAnnotations:function

  • jobsDestroyAnnotations(
        requestParameters: JobsApiJobsDestroyAnnotationsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>

    Parameters

    • requestParameters: JobsApiJobsDestroyAnnotationsRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Throws

• jobsList:function

  • jobsList(
        requestParameters?: JobsApiJobsListRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<PaginatedJobReadList>

    Parameters

    • requestParameters: JobsApiJobsListRequest = {}

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<PaginatedJobReadList>

    Throws

• jobsPartialUpdate:function

  • jobsPartialUpdate(
        requestParameters: JobsApiJobsPartialUpdateRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<JobRead>

    Parameters

    • requestParameters: JobsApiJobsPartialUpdateRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<JobRead>

    Throws

• jobsPartialUpdateAnnotations:function

  • jobsPartialUpdateAnnotations(
        requestParameters: JobsApiJobsPartialUpdateAnnotationsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>

    Parameters

    • requestParameters: JobsApiJobsPartialUpdateAnnotationsRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Throws

• jobsPartialUpdateDataMeta:function

  • jobsPartialUpdateDataMeta(
        requestParameters: JobsApiJobsPartialUpdateDataMetaRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<DataMetaRead>

    Parameters

    • requestParameters: JobsApiJobsPartialUpdateDataMetaRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<DataMetaRead>

    Throws

• jobsPartialUpdateValidationLayout:function

  • jobsPartialUpdateValidationLayout(
        requestParameters: JobsApiJobsPartialUpdateValidationLayoutRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<JobValidationLayoutRead>

    WARNING: this operation is not protected from race conditions. It's up to the user to ensure no parallel calls to this operation happen. It affects image access, including exports with images, backups, chunk downloading etc.

    Parameters

    • requestParameters: JobsApiJobsPartialUpdateValidationLayoutRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<JobValidationLayoutRead>

    Throws

• jobsRetrieve:function

  • jobsRetrieve(
        requestParameters: JobsApiJobsRetrieveRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<JobRead>

    Parameters

    • requestParameters: JobsApiJobsRetrieveRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<JobRead>

    Throws

• jobsRetrieveAnnotations:function

  • jobsRetrieveAnnotations(
        requestParameters: JobsApiJobsRetrieveAnnotationsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<AnnotationsRead>

    If format is specified, a ZIP archive will be returned. Otherwise, the annotations will be returned as a JSON document. Deprecation warning: Utilizing this endpoint to export annotations as a dataset in a specific format will be deprecated in one of the next releases. Consider using new API: - POST /api/jobs/<job_id>/dataset/export?save_images=False to initiate export process - GET /api/requests/<rq_id> to check process status, where rq_id is request id returned on initializing request

    Parameters

    • requestParameters: JobsApiJobsRetrieveAnnotationsRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<AnnotationsRead>

    Throws

• jobsRetrieveData:function

  • jobsRetrieveData(
        requestParameters: JobsApiJobsRetrieveDataRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<File>

    Parameters

    • requestParameters: JobsApiJobsRetrieveDataRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<File>

    Throws

• jobsRetrieveDataMeta:function

  • jobsRetrieveDataMeta(
        requestParameters: JobsApiJobsRetrieveDataMetaRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<DataMetaRead>

    Parameters

    • requestParameters: JobsApiJobsRetrieveDataMetaRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<DataMetaRead>

    Throws

• jobsRetrieveDataset:function

  • jobsRetrieveDataset(
        requestParameters: JobsApiJobsRetrieveDatasetRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<File>

    Deprecation warning: This endpoint will be deprecated in one of the next releases. Consider using new API: - POST /api/jobs/<job_id>/dataset/export?save_images=True to initiate export process - GET /api/requests/<rq_id> to check process status, where rq_id is request id returned on initializing request

    Parameters

    • requestParameters: JobsApiJobsRetrieveDatasetRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<File>

    Throws

• jobsRetrievePreview:function

  • jobsRetrievePreview(
        requestParameters: JobsApiJobsRetrievePreviewRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>

    Parameters

    • requestParameters: JobsApiJobsRetrievePreviewRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Throws

• jobsRetrieveValidationLayout:function

  • jobsRetrieveValidationLayout(
        requestParameters: JobsApiJobsRetrieveValidationLayoutRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<JobValidationLayoutRead>

    Parameters

    • requestParameters: JobsApiJobsRetrieveValidationLayoutRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<JobValidationLayoutRead>

    Throws

• jobsUpdateAnnotations:function

  • jobsUpdateAnnotations(
        requestParameters: JobsApiJobsUpdateAnnotationsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>

    Utilizing this endpoint to check status of the import process is deprecated in favor of the new requests API: GET /api/requests/<rq_id>, where rq_id parameter is returned in the response on initializing request.

    Parameters

    • requestParameters: JobsApiJobsUpdateAnnotationsRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Throws