Function JobsApiAxiosParamCreator

JobsApi - axios parameter creator

Export

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

    Parameters

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

    • jobsCreate: (
          jobWriteRequest: JobWriteRequest,
          options?: RawAxiosRequestConfig,
      ) => Promise<RequestArgs>

      Throws

    • jobsCreateAnnotations: (
          id: number,
          cloudStorageId?: number,
          filename?: string,
          format?: string,
          location?: JobsCreateAnnotationsLocationEnum,
          useDefaultLocation?: boolean,
          annotationFileRequest?: AnnotationFileRequest,
          options?: RawAxiosRequestConfig,
      ) => Promise<RequestArgs>

      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.

      Throws

    • jobsCreateDatasetExport: (
          format: string,
          id: number,
          cloudStorageId?: number,
          filename?: string,
          location?: JobsCreateDatasetExportLocationEnum,
          saveImages?: boolean,
          options?: RawAxiosRequestConfig,
      ) => Promise<RequestArgs>

      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.

      Throws

    • jobsDestroy: (id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>

      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.

      Throws

    • jobsDestroyAnnotations: (id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>

      Throws

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

      Throws

    • jobsPartialUpdate: (
          id: number,
          patchedJobWriteRequest?: PatchedJobWriteRequest,
          options?: RawAxiosRequestConfig,
      ) => Promise<RequestArgs>

      Throws

    • jobsPartialUpdateAnnotations: (
          action: JobsPartialUpdateAnnotationsActionEnum,
          id: number,
          patchedLabeledDataRequest?: PatchedLabeledDataRequest,
          options?: RawAxiosRequestConfig,
      ) => Promise<RequestArgs>

      Throws

    • jobsPartialUpdateDataMeta: (
          id: number,
          patchedJobDataMetaWriteRequest?: PatchedJobDataMetaWriteRequest,
          options?: RawAxiosRequestConfig,
      ) => Promise<RequestArgs>

      Throws

    • jobsPartialUpdateValidationLayout: (
          id: number,
          patchedJobValidationLayoutWriteRequest?: PatchedJobValidationLayoutWriteRequest,
          options?: RawAxiosRequestConfig,
      ) => Promise<RequestArgs>

      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.

      Throws

    • jobsRetrieve: (id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>

      Throws

    • jobsRetrieveAnnotations: (
          id: number,
          action?: "download",
          cloudStorageId?: number,
          filename?: string,
          format?: string,
          location?: JobsRetrieveAnnotationsLocationEnum,
          useDefaultLocation?: boolean,
          options?: RawAxiosRequestConfig,
      ) => Promise<RequestArgs>

      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

      Throws

    • jobsRetrieveData: (
          id: number,
          index?: number,
          number?: number,
          quality?: JobsRetrieveDataQualityEnum,
          type?: JobsRetrieveDataTypeEnum,
          options?: RawAxiosRequestConfig,
      ) => Promise<RequestArgs>

      Throws

    • jobsRetrieveDataMeta: (id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>

      Throws

    • jobsRetrieveDataset: (
          format: string,
          id: number,
          action?: "download",
          cloudStorageId?: number,
          filename?: string,
          location?: JobsRetrieveDatasetLocationEnum,
          useDefaultLocation?: boolean,
          options?: RawAxiosRequestConfig,
      ) => Promise<RequestArgs>

      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

      Throws

    • jobsRetrievePreview: (id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>

      Throws

    • jobsRetrieveValidationLayout: (id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>

      Throws

    • jobsUpdateAnnotations: (
          id: number,
          cloudStorageId?: number,
          filename?: string,
          format?: string,
          location?: JobsUpdateAnnotationsLocationEnum,
          rqId?: string,
          jobAnnotationsUpdateRequest?: JobAnnotationsUpdateRequest,
          options?: RawAxiosRequestConfig,
      ) => Promise<RequestArgs>

      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.

      Throws

Settings

Member Visibility