Function JobsApiFp

Returns {
    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?: "download",
        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?: "download",
        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>,
    >;
}

• jobsCreate:function

  • jobsCreate(
        jobWriteRequest: JobWriteRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<JobRead>,
    >

    Parameters

    • jobWriteRequest: JobWriteRequest
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JobRead>>

    Throws

• jobsCreateAnnotations:function

  • jobsCreateAnnotations(
        id: number,
        cloudStorageId?: number,
        filename?: string,
        format?: string,
        location?: JobsCreateAnnotationsLocationEnum,
        useDefaultLocation?: boolean,
        annotationFileRequest?: AnnotationFileRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<(axios?: AxiosInstance, basePath?: string) => 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

    • id: number

      A unique integer value identifying this job.
    • OptionalcloudStorageId: number

      Storage id
    • Optionalfilename: string

      Annotation file name
    • Optionalformat: string

      Input format name You can get the list of supported formats at: /server/annotation/formats
    • Optionallocation: JobsCreateAnnotationsLocationEnum

      where to import the annotation from
    • OptionaluseDefaultLocation: boolean

      Use the location that was configured in the task to import annotation
    • OptionalannotationFileRequest: AnnotationFileRequest
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

    Throws

• jobsCreateDatasetExport:function

  • jobsCreateDatasetExport(
        format: string,
        id: number,
        cloudStorageId?: number,
        filename?: string,
        location?: JobsCreateDatasetExportLocationEnum,
        saveImages?: boolean,
        options?: RawAxiosRequestConfig,
    ): Promise<(axios?: AxiosInstance, basePath?: string) => 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

    • format: string

      Desired output format name You can get the list of supported formats at: /server/annotation/formats
    • id: number

      A unique integer value identifying this job.
    • OptionalcloudStorageId: number

      Storage id
    • Optionalfilename: string

      Desired output file name
    • Optionallocation: JobsCreateDatasetExportLocationEnum

      Where need to save downloaded dataset
    • OptionalsaveImages: boolean

      Include images or not
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RqId>>

    Throws

• jobsDestroy:function

  • jobsDestroy(
        id: number,
        options?: RawAxiosRequestConfig,
    ): Promise<(axios?: AxiosInstance, basePath?: string) => 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

    • id: number

      A unique integer value identifying this job.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

    Throws

• jobsDestroyAnnotations:function

  • jobsDestroyAnnotations(
        id: number,
        options?: RawAxiosRequestConfig,
    ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

    Parameters

    • id: number

      A unique integer value identifying this job.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

    Throws

• jobsList:function

  • 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>,
    >

    Parameters

    • OptionalxOrganization: string

      Organization unique slug
    • Optionalassignee: string

      A simple equality filter for the assignee field
    • Optionaldimension: JobsListDimensionEnum

      A simple equality filter for the dimension field
    • Optionalfilter: string

      JSON Logic filter. This filter can be used to perform complex filtering by grouping rules. For example, using such a filter you can get all resources created by you: - {&quot;and&quot;:[{&quot;==&quot;:[{&quot;var&quot;:&quot;owner&quot;},&quot;<user>&quot;]}]} Details about the syntax used can be found at the link: https://jsonlogic.com/ Available filter_fields: [&#39;task_name&#39;, &#39;project_name&#39;, &#39;assignee&#39;, &#39;state&#39;, &#39;stage&#39;, &#39;id&#39;, &#39;task_id&#39;, &#39;project_id&#39;, &#39;updated_date&#39;, &#39;dimension&#39;, &#39;type&#39;, &#39;parent_job_id&#39;].
    • Optionalorg: string

      Organization unique slug
    • OptionalorgId: number

      Organization identifier
    • Optionalpage: number

      A page number within the paginated result set.
    • OptionalpageSize: number

      Number of results to return per page.
    • OptionalparentJobId: number

      A simple equality filter for the parent_job_id field
    • OptionalprojectId: number

      A simple equality filter for the project_id field
    • OptionalprojectName: string

      A simple equality filter for the project_name field
    • Optionalsearch: string

      A search term. Available search_fields: (&#39;task_name&#39;, &#39;project_name&#39;, &#39;assignee&#39;, &#39;state&#39;, &#39;stage&#39;)
    • Optionalsort: string

      Which field to use when ordering the results. Available ordering_fields: [&#39;task_name&#39;, &#39;project_name&#39;, &#39;assignee&#39;, &#39;state&#39;, &#39;stage&#39;, &#39;id&#39;, &#39;task_id&#39;, &#39;project_id&#39;, &#39;updated_date&#39;, &#39;dimension&#39;, &#39;type&#39;, &#39;parent_job_id&#39;]
    • Optionalstage: JobsListStageEnum

      A simple equality filter for the stage field
    • Optionalstate: JobsListStateEnum

      A simple equality filter for the state field
    • OptionaltaskId: number

      A simple equality filter for the task_id field
    • OptionaltaskName: string

      A simple equality filter for the task_name field
    • Optionaltype: JobsListTypeEnum

      A simple equality filter for the type field
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<PaginatedJobReadList>,
    >

    Throws

• jobsPartialUpdate:function

  • jobsPartialUpdate(
        id: number,
        patchedJobWriteRequest?: PatchedJobWriteRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<JobRead>,
    >

    Parameters

    • id: number

      A unique integer value identifying this job.
    • OptionalpatchedJobWriteRequest: PatchedJobWriteRequest
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JobRead>>

    Throws

• jobsPartialUpdateAnnotations:function

  • jobsPartialUpdateAnnotations(
        action: JobsPartialUpdateAnnotationsActionEnum,
        id: number,
        patchedLabeledDataRequest?: PatchedLabeledDataRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

    Parameters

    • action: JobsPartialUpdateAnnotationsActionEnum
    • id: number

      A unique integer value identifying this job.
    • OptionalpatchedLabeledDataRequest: PatchedLabeledDataRequest
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

    Throws

• jobsPartialUpdateDataMeta:function

  • jobsPartialUpdateDataMeta(
        id: number,
        patchedJobDataMetaWriteRequest?: PatchedJobDataMetaWriteRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataMetaRead>,
    >

    Parameters

    • id: number

      A unique integer value identifying this job.
    • OptionalpatchedJobDataMetaWriteRequest: PatchedJobDataMetaWriteRequest
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataMetaRead>,
    >

    Throws

• jobsPartialUpdateValidationLayout:function

  • jobsPartialUpdateValidationLayout(
        id: number,
        patchedJobValidationLayoutWriteRequest?: PatchedJobValidationLayoutWriteRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => 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

    • id: number

      A unique integer value identifying this job.
    • OptionalpatchedJobValidationLayoutWriteRequest: PatchedJobValidationLayoutWriteRequest
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<JobValidationLayoutRead>,
    >

    Throws

• jobsRetrieve:function

  • jobsRetrieve(
        id: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<JobRead>,
    >

    Parameters

    • id: number

      A unique integer value identifying this job.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JobRead>>

    Throws

• jobsRetrieveAnnotations:function

  • jobsRetrieveAnnotations(
        id: number,
        action?: "download",
        cloudStorageId?: number,
        filename?: string,
        format?: string,
        location?: JobsRetrieveAnnotationsLocationEnum,
        useDefaultLocation?: boolean,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => 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

    • id: number

      A unique integer value identifying this job.
    • Optionalaction: "download"

      Used to start downloading process locally after annotation file has been created
    • OptionalcloudStorageId: number

      Storage id
    • Optionalfilename: string

      Desired output file name
    • Optionalformat: string

      Desired output format name You can get the list of supported formats at: /server/annotation/formats
    • Optionallocation: JobsRetrieveAnnotationsLocationEnum

      Where need to save downloaded annotation
    • OptionaluseDefaultLocation: boolean

      Use the location that was configured in the task to export annotation
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<AnnotationsRead>,
    >

    Throws

• jobsRetrieveData:function

  • jobsRetrieveData(
        id: number,
        index?: number,
        number?: number,
        quality?: JobsRetrieveDataQualityEnum,
        type?: JobsRetrieveDataTypeEnum,
        options?: RawAxiosRequestConfig,
    ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>

    Parameters

    • id: number

      A unique integer value identifying this job.
    • Optionalindex: number

      A unique number value identifying chunk, starts from 0 for each job
    • Optionalnumber: number

      A unique number value identifying chunk or frame. The numbers are the same as for the task. Deprecated for chunks in favor of &#39;index&#39;
    • Optionalquality: JobsRetrieveDataQualityEnum

      Specifies the quality level of the requested data
    • Optionaltype: JobsRetrieveDataTypeEnum

      Specifies the type of the requested data
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>

    Throws

• jobsRetrieveDataMeta:function

  • jobsRetrieveDataMeta(
        id: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataMetaRead>,
    >

    Parameters

    • id: number

      A unique integer value identifying this job.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataMetaRead>,
    >

    Throws

• jobsRetrieveDataset:function

  • jobsRetrieveDataset(
        format: string,
        id: number,
        action?: "download",
        cloudStorageId?: number,
        filename?: string,
        location?: JobsRetrieveDatasetLocationEnum,
        useDefaultLocation?: boolean,
        options?: RawAxiosRequestConfig,
    ): Promise<(axios?: AxiosInstance, basePath?: string) => 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

    • format: string

      Desired output format name You can get the list of supported formats at: /server/annotation/formats
    • id: number

      A unique integer value identifying this job.
    • Optionalaction: "download"

      Used to start downloading process locally after annotation file has been created
    • OptionalcloudStorageId: number

      Storage id
    • Optionalfilename: string

      Desired output file name
    • Optionallocation: JobsRetrieveDatasetLocationEnum

      Where need to save downloaded dataset
    • OptionaluseDefaultLocation: boolean

      Use the location that was configured in the task to export dataset
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>

    Throws

• jobsRetrievePreview:function

  • jobsRetrievePreview(
        id: number,
        options?: RawAxiosRequestConfig,
    ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

    Parameters

    • id: number

      A unique integer value identifying this job.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

    Throws

• jobsRetrieveValidationLayout:function

  • jobsRetrieveValidationLayout(
        id: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<JobValidationLayoutRead>,
    >

    Parameters

    • id: number

      A unique integer value identifying this job.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<JobValidationLayoutRead>,
    >

    Throws

• jobsUpdateAnnotations:function

  • jobsUpdateAnnotations(
        id: number,
        cloudStorageId?: number,
        filename?: string,
        format?: string,
        location?: JobsUpdateAnnotationsLocationEnum,
        rqId?: string,
        jobAnnotationsUpdateRequest?: JobAnnotationsUpdateRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<(axios?: AxiosInstance, basePath?: string) => 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

    • id: number

      A unique integer value identifying this job.
    • OptionalcloudStorageId: number

      Storage id
    • Optionalfilename: string

      Annotation file name
    • Optionalformat: string

      Input format name You can get the list of supported formats at: /server/annotation/formats
    • Optionallocation: JobsUpdateAnnotationsLocationEnum

      where to import the annotation from
    • OptionalrqId: string

      rq id
    • OptionaljobAnnotationsUpdateRequest: JobAnnotationsUpdateRequest
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

    Throws