ApiField¶

class ApiField[source]¶

Bases: object

ApiField

Methods

Attributes

`ACCEPTED_IMAGES_COUNT`
`ACCOUNT_TYPE`
`ACTION`
`ADVANCED`
`ADVANCED_SETTINGS`
`AGENT_ID`
`ANNOTATION`
`ANNOTATIONS`
`ANNOTATION_DATA`
`ANNOTATION_OBJECTS`
`ANNOTATION_OBJECTS_TAGS`
`ANNOTATION_OBJECT_ID`
`ANN_ARCHIVE_URL`
`ANN_OBJECTS_COUNT`
`ANN_URL`
`APPEND`
`APP_ID`
`APP_VERSION`
`ARCHIVE_URL`
`AREA`
`ASSIGNED_TO_ID`
`ASSIGNED_TO_LOGIN`
`ASSIGNEES`
`BACKUP_ARCHIVE`
`BINDINGS`
`BITMAP`
`CAPABILITIES`
`CLASSES`
`CLASSES_TO_LABEL`
`CLASS_ID`
`CLEAR_LOCAL_DATA_SOURCE`
`CLOUD_MIME`
`COLOR`
`COMMAND`
`COMMENT`
`COMMENTS`
`COMMIT_TOKEN`
`COMPLETE_EXISTING`
`CONFIG`
`CONFIGS`
`CONTENT`
`CONTEXT`
`CREATED_AT`
`CREATED_BY_ID`
`CREATED_BY_LOGIN`
`CREATED_BY_USER`
`CURRENT`
`CUSTOM_DATA`
`CUSTOM_SORT`
`DATA`
`DATASETS`
`DATASETS_COUNT`
`DATASET_ID`
`DATASET_NAME`
`DATE`
`DECOMPRESS_BITMAP`
`DEFAULT_VALUE`
`DEFAULT_VERSION`
`DESCRIPTION`
`DEST_ID`
`DISABLE`
`DISABLED`
`DISABLED_AT`
`DISABLED_BY`
`DOCKER_IMAGE`
`DURATION`
`ECOSYSTEM_ITEM_ID`
`EMAIL`
`ENTITIES`
`ENTITY_ID`
`ERROR`
`EVENTS`
`EXCLUDE_IMAGES_WITH_TAGS`
`EXPERIMENT`
`EXPLORE_PATH`
`EXT`
`EXT2`
`EXTRA`
`EXTRA_FIELDS`
`FIELD`
`FIELDS`
`FIGURES`
`FIGURES_COUNT`
`FIGURES_TAGS`
`FIGURE_CLASS_ID`
`FIGURE_CLASS_TITLE`
`FIGURE_ID`
`FIGURE_IDS`
`FIGURE_IMAGE_ID`
`FIGURE_STATE`
`FILENAME`
`FILES`
`FILE_META`
`FILTER`
`FILTERS`
`FILTER_IMAGES_BY_TAGS`
`FINISHED_AT`
`FINISHED_IMAGES_COUNT`
`FOLDERS`
`FORCE_METADATA_FOR_LINKS`
`FRAME`
`FRAMES`
`FRAMES_COUNT`
`FRAMES_TO_TIMECODES`
`FRAME_HEIGHT`
`FRAME_INDEX`
`FRAME_RANGE`
`FRAME_WIDTH`
`FROM`
`FULL_STORAGE_URL`
`GENERAL`
`GEOMETRY`
`GEOMETRY_META`
`GEOMETRY_TYPE`
`GPU_INFO`
`GROUP_ID`
`HASH`
`HASHES`
`HEIGHT`
`HIDDEN`
`ID`
`IDS`
`IGNORE_AGENT`
`IMAGES`
`IMAGES_COUNT`
`IMAGES_RANGE`
`IMAGES_TAGS`
`IMAGE_ID`
`IMAGE_IDS`
`IMAGE_NAME`
`IMPORT_SETTINGS`
`INCLUDE`
`INCLUDE_IMAGES_WITH_TAGS`
`INTEGER_COORDS`
`ISSUE_ID`
`IS_BRANCH`
`IS_DIR`
`IS_LOCAL`
`IS_PINNED`
`IS_PUBLIC`
`IS_RESTRICTED`
`IS_SHARED`
`ITEMS_COUNT`
`JOB_ENTITY_STATUS`
`JOB_ID`
`LABELING_EXAM_ID`
`LABELING_QUEUE_ID`
`LABELING_TOOL`
`LABELS_COUNT`
`LAST_LOGIN`
`LAYOUT`
`LEFT`
`LIMIT`
`LIMIT_BY_WORKSPACE`
`LINK`
`LINKS`
`LOGIN`
`LOGINS`
`LOGS`
`LOG_LEVEL`
`MESSAGE`
`META`
`MIME`
`MIME2`
`MODE`
`MODEL_ID`
`MODULE_ID`
`NAME`
`NODE`
`OBJECTS_COUNT`
`OBJECTS_LIMIT_PER_IMAGE`
`OBJECT_ID`
`ONLY_RUNNING`
`ONLY_TRAIN`
`OPERATOR`
`OPTION`
`OPTIONS`
`OUTPUT`
`PAGE`
`PAGINATION_MODE`
`PARAMS`
`PARENT_ID`
`PASSWORD`
`PATH`
`PATHS`
`PATH_ORIGINAL`
`PAYLOAD`
`PER_PAGE`
`PLUGIN_ID`
`PLUGIN_VERSION`
`POINTCLOUDS`
`POINTCLOUD_ID`
`POINTCLOUD_IDS`
`POSITION`
`PRESERVE_PROJECT_CARD`
`PREVIEW`
`PRIORITY`
`PROCESSING_PATH`
`PROGRESS`
`PROGRESS_IMAGES_COUNT`
`PROJECT`
`PROJECTS`
`PROJECT_ID`
`PROJECT_NAME`
`PROJECT_TAGS`
`PROJECT_UPDATED_AT`
`PROXY_KEEP_URL`
`RAW_VIDEO_META`
`README`
`RECURSIVE`
`REDIRECT_REQUESTS`
`REFERENCE_IMAGE_URL`
`REJECTED_IMAGES_COUNT`
`REPO`
`REPORT_ID`
`RESTART_POLICY`
`REVIEWER_ID`
`REVIEWER_LOGIN`
`ROLE`
`ROLE_ID`
`SCRIPT`
`SESSION_ID`
`SETTINGS`
`SHAPE`
`SHARED_LINK`
`SHOW_DISABLED`
`SILENT`
`SIZE`
`SIZEB`
`SIZEB2`
`SIZEB3`
`SKIP_BOUNDS_VALIDATION`
`SKIP_EXPORTED`
`SKIP_VALIDATION`
`SLUG`
`SMART_TOOL_INPUT`
`SORT`
`SORT_ORDER`
`SRC_ID`
`STARTED_AT`
`STATE`
`STATUS`
`STOPPED`
`STORAGE_PATH`
`STREAMS`
`SUBTITLE`
`TAGS`
`TAGS_LIMIT_PER_IMAGE`
`TAGS_TO_LABEL`
`TAG_ID`
`TAG_IDS`
`TASKS`
`TASK_ID`
`TASK_NAME`
`TEAMS`
`TEAM_FILE_ID`
`TEAM_ID`
`TITLE`
`TO`
`TOKEN`
`TOOL_CLASS_ID`
`TOOL_STATE`
`TOP`
`TOTAL`
`TRACK_ID`
`TYPE`
`UPDATED_AT`
`URL`
`USAGE`
`USERS_IDS`
`USER_ID`
`USER_IDS`
`USER_LOGIN`
`USE_DIRECT_PROGRESS_MESSAGES`
`VALUE`
`VERSION`
`VERSIONS`
`VIDEOS`
`VIDEO_ID`
`VIDEO_IDS`
`VIDEO_NAME`
`VOLUMES`
`VOLUME_ID`
`VOLUME_IDS`
`VOLUME_NAME`
`VOLUME_SLICES`
`WEIGHTS_LOCATION`
`WIDGET`
`WIDGETS`
`WIDTH`
`WITH_CUSTOM_DATA`
`WITH_METADATA`
`WITH_SHARED`
`WORKSPACE_ID`
`WORKSPACE_NAME`
`ZOOM_FACTOR`

ACCEPTED_IMAGES_COUNT = 'acceptedImagesCount'¶

ACCOUNT_TYPE = 'plan'¶

ACTION = 'action'¶

ADVANCED = 'advanced'¶

ADVANCED_SETTINGS = 'advancedSettings'¶

AGENT_ID = 'agentId'¶

ANNOTATION = 'annotation'¶

ANNOTATIONS = 'annotations'¶

ANNOTATION_DATA = 'annotationData'¶

ANNOTATION_OBJECTS = 'annotationObjects'¶

ANNOTATION_OBJECTS_TAGS = 'annotationObjectsTags'¶

ANNOTATION_OBJECT_ID = 'annotationObjectId'¶

ANN_ARCHIVE_URL = 'annotationsArchiveUrl'¶

ANN_OBJECTS_COUNT = (['annotationObjectsCount'], 'objects_count')¶

ANN_URL = 'annotationsUrl'¶

APPEND = 'append'¶

APP_ID = 'appId'¶

APP_VERSION = 'appVersion'¶

ARCHIVE_URL = 'archiveUrl'¶

AREA = 'area'¶

ASSIGNED_TO_ID = (['userId'], 'assigned_to_id')¶

ASSIGNED_TO_LOGIN = (['labelerLogin'], 'assigned_to_login')¶

ASSIGNEES = 'assignees'¶

BACKUP_ARCHIVE = 'backupArchive'¶

BINDINGS = 'bindings'¶

BITMAP = 'bitmap'¶

CAPABILITIES = 'capabilities'¶

CLASSES = 'classes'¶

CLASSES_TO_LABEL = (['meta', 'classes'], 'classes_to_label')¶

CLASS_ID = 'classId'¶

CLEAR_LOCAL_DATA_SOURCE = 'clearLocalDataSource'¶

CLOUD_MIME = (['fileMeta', 'mime'], 'cloud_mime')¶

COLOR = 'color'¶

COMMAND = 'command'¶

COMMENT = 'comment'¶

COMMENTS = 'comments'¶

COMMIT_TOKEN = 'commitToken'¶

COMPLETE_EXISTING = 'completeExisting'¶

CONFIG = 'config'¶

CONFIGS = 'configs'¶

CONTENT = 'content'¶

CONTEXT = 'context'¶

CREATED_AT = 'createdAt'¶

CREATED_BY_ID = (['createdBy'], 'created_by_id')¶

CREATED_BY_LOGIN = (['managerLogin'], 'created_by_login')¶

CREATED_BY_USER = 'createdByUser'¶

CURRENT = 'current'¶

CUSTOM_DATA = 'customData'¶

CUSTOM_SORT = 'customSort'¶

DATA = 'data'¶

DATASETS = 'datasets'¶

DATASETS_COUNT = 'datasetsCount'¶

DATASET_ID = 'datasetId'¶

DATASET_NAME = (['datasetTitle'], 'dataset_name')¶

DATE = 'date'¶

DECOMPRESS_BITMAP = 'decompressBitmap'¶

DEFAULT_VALUE = 'defaultValue'¶

DEFAULT_VERSION = 'defaultVersion'¶

DESCRIPTION = 'description'¶

DEST_ID = 'destId'¶

DISABLE = 'disable'¶

DISABLED = 'disabled'¶

DISABLED_AT = 'disabledAt'¶

DISABLED_BY = 'disabledBy'¶

DOCKER_IMAGE = 'dockerImage'¶

DURATION = 'duration'¶

ECOSYSTEM_ITEM_ID = 'moduleId'¶

EMAIL = 'email'¶

ENTITIES = 'entities'¶

ENTITY_ID = 'entityId'¶

ERROR = 'error'¶

EVENTS = 'events'¶

EXCLUDE_IMAGES_WITH_TAGS = ([], 'exclude_images_with_tags')¶

EXPERIMENT = 'experiment'¶

EXPLORE_PATH = 'explorePath'¶

EXT = 'ext'¶

EXT2 = (['meta', 'ext'], 'ext')¶

EXTRA = 'extra'¶

EXTRA_FIELDS = 'extraFields'¶

FIELD = 'field'¶

FIELDS = 'fields'¶

FIGURES = 'figures'¶

FIGURES_COUNT = 'figuresCount'¶

FIGURES_TAGS = 'figuresTags'¶

FIGURE_CLASS_ID = 'figureClassId'¶

FIGURE_CLASS_TITLE = 'figureClassTitle'¶

FIGURE_ID = 'figureId'¶

FIGURE_IDS = 'figureIds'¶

FIGURE_IMAGE_ID = 'figureImageId'¶

FIGURE_STATE = 'figureState'¶

FILENAME = 'filename'¶

FILES = 'files'¶

FILE_META = 'fileMeta'¶

FILTER = 'filter'¶

FILTERS = 'filters'¶

FILTER_IMAGES_BY_TAGS = (['meta', 'imageTags'], 'filter_images_by_tags')¶

FINISHED_AT = 'finishedAt'¶

FINISHED_IMAGES_COUNT = 'finishedImagesCount'¶

FOLDERS = 'folders'¶

FORCE_METADATA_FOR_LINKS = 'forceMetadataForLinks'¶

FRAME = 'frame'¶

FRAMES = 'frames'¶

FRAMES_COUNT = (['fileMeta', 'framesCount'], 'frames_count')¶

FRAMES_TO_TIMECODES = (['fileMeta', 'framesToTimecodes'], 'frames_to_timecodes')¶

FRAME_HEIGHT = (['fileMeta', 'height'], 'frame_height')¶

FRAME_INDEX = (['meta', 'frame'], 'frame_index')¶

FRAME_RANGE = 'frameRange'¶

FRAME_WIDTH = (['fileMeta', 'width'], 'frame_width')¶

FROM = 'from'¶

FULL_STORAGE_URL = 'fullStorageUrl'¶

GENERAL = 'general'¶

GEOMETRY = 'geometry'¶

GEOMETRY_META = 'geometryMeta'¶

GEOMETRY_TYPE = 'geometryType'¶

GPU_INFO = 'gpuInfo'¶

GROUP_ID = 'groupId'¶

HASH = 'hash'¶

HASHES = 'hashes'¶

HEIGHT = 'height'¶

HIDDEN = 'hidden'¶

ID = 'id'¶

IDS = 'ids'¶

IGNORE_AGENT = 'ignoreAgent'¶

IMAGES = 'images'¶

IMAGES_COUNT = 'imagesCount'¶

IMAGES_RANGE = (['meta', 'range'], 'images_range')¶

IMAGES_TAGS = 'imagesTags'¶

IMAGE_ID = 'imageId'¶

IMAGE_IDS = 'imageIds'¶

IMAGE_NAME = 'imageName'¶

IMPORT_SETTINGS = 'importSettings'¶

INCLUDE = 'include'¶

INCLUDE_IMAGES_WITH_TAGS = ([], 'include_images_with_tags')¶

INTEGER_COORDS = 'integerCoords'¶

ISSUE_ID = 'issueId'¶

IS_BRANCH = 'isBranch'¶

IS_DIR = 'isDir'¶

IS_LOCAL = 'isLocal'¶

IS_PINNED = 'isPinned'¶

IS_PUBLIC = 'isPublic'¶

IS_RESTRICTED = 'isRestricted'¶

IS_SHARED = 'isShared'¶

ITEMS_COUNT = 'itemsCount'¶

JOB_ENTITY_STATUS = 'jobEntityStatus'¶

JOB_ID = 'jobId'¶

LABELING_EXAM_ID = 'labelingExamId'¶

LABELING_QUEUE_ID = 'labelingQueueId'¶

LABELING_TOOL = 'tool'¶

LABELS_COUNT = 'labelsCount'¶

LAST_LOGIN = 'lastLogin'¶

LAYOUT = 'layout'¶

LEFT = 'left'¶

LIMIT = 'limit'¶

LIMIT_BY_WORKSPACE = 'limitByWorkspace'¶

LINK = 'link'¶

LINKS = 'links'¶

LOGIN = 'login'¶

LOGINS = 'logins'¶

LOGS = 'logs'¶

LOG_LEVEL = 'logLevel'¶

MESSAGE = 'message'¶

META = 'meta'¶

MIME = 'mime'¶

MIME2 = (['meta', 'mime'], 'mime')¶

MODE = 'mode'¶

MODEL_ID = 'modelId'¶

MODULE_ID = 'moduleId'¶

NAME = 'name'¶

NODE = 'node'¶

OBJECTS_COUNT = 'objectsCount'¶

OBJECTS_LIMIT_PER_IMAGE = (['meta', 'imageFiguresLimit'], 'objects_limit_per_image')¶

OBJECT_ID = 'objectId'¶

ONLY_RUNNING = 'onlyRunning'¶

ONLY_TRAIN = 'onlyTrain'¶

OPERATOR = 'operator'¶

OPTION = 'option'¶

OPTIONS = 'options'¶

OUTPUT = 'output'¶

PAGE = 'page'¶

PAGINATION_MODE = 'pagination_mode'¶

PARAMS = 'params'¶

PARENT_ID = 'parentId'¶

PASSWORD = 'password'¶

PATH = 'path'¶

PATHS = 'paths'¶

PATH_ORIGINAL = 'pathOriginal'¶

PAYLOAD = 'payload'¶

PER_PAGE = 'per_page'¶

PLUGIN_ID = 'pluginId'¶

PLUGIN_VERSION = 'pluginVersion'¶

POINTCLOUDS = 'pointClouds'¶

POINTCLOUD_ID = 'pointCloudId'¶

POINTCLOUD_IDS = 'pointCloudIds'¶

POSITION = 'position'¶

PRESERVE_PROJECT_CARD = 'preserveProjectCard'¶

PREVIEW = 'preview'¶

PRIORITY = 'priority'¶

PROCESSING_PATH = 'processingPath'¶

PROGRESS = 'progress'¶

PROGRESS_IMAGES_COUNT = 'progressImagesCount'¶

PROJECT = 'project'¶

PROJECTS = 'projects'¶

PROJECT_ID = 'projectId'¶

PROJECT_NAME = (['projectTitle'], 'project_name')¶

PROJECT_TAGS = 'projectTags'¶

PROJECT_UPDATED_AT = 'projectUpdatedAt'¶

PROXY_KEEP_URL = 'proxyKeepUrl'¶

RAW_VIDEO_META = 'rawVideoMeta'¶

README = 'readme'¶

RECURSIVE = 'recursive'¶

REDIRECT_REQUESTS = 'redirectRequests'¶

REFERENCE_IMAGE_URL = 'referenceImageUrl'¶

REJECTED_IMAGES_COUNT = 'rejectedImagesCount'¶

REPO = 'repo'¶

REPORT_ID = 'reportId'¶

RESTART_POLICY = 'restartPolicy'¶

REVIEWER_ID = 'reviewerId'¶

REVIEWER_LOGIN = 'reviewerLogin'¶

ROLE = 'role'¶

ROLE_ID = 'roleId'¶

SCRIPT = 'script'¶

SESSION_ID = 'sessionId'¶

SETTINGS = 'settings'¶

SHAPE = 'shape'¶

SHARED_LINK = 'sharedLinkToken'¶

SHOW_DISABLED = 'showDisabled'¶

SILENT = 'silent'¶

SIZE = 'size'¶

SIZEB = (['size'], 'sizeb')¶

SIZEB2 = (['meta', 'size'], 'sizeb')¶

SIZEB3 = (['fileMeta', 'size'], 'sizeb')¶

SKIP_BOUNDS_VALIDATION = 'skipBoundsValidation'¶

SKIP_EXPORTED = 'skipExported'¶

SKIP_VALIDATION = 'skipValidation'¶

SLUG = 'slug'¶

SMART_TOOL_INPUT = 'smartToolInput'¶

SORT = 'sort'¶

SORT_ORDER = 'sort_order'¶

SRC_ID = 'srcId'¶

STARTED_AT = 'startedAt'¶

STATE = 'state'¶

STATUS = 'status'¶

STOPPED = 'stopped'¶

STORAGE_PATH = 'storagePath'¶

STREAMS = 'streams'¶

SUBTITLE = 'subtitle'¶

TAGS = 'tags'¶

TAGS_LIMIT_PER_IMAGE = (['meta', 'imageTagsLimit'], 'tags_limit_per_image')¶

TAGS_TO_LABEL = (['meta', 'projectTags'], 'tags_to_label')¶

TAG_ID = 'tagId'¶

TAG_IDS = 'tagIds'¶

TASKS = 'tasks'¶

TASK_ID = 'taskId'¶

TASK_NAME = 'taskName'¶

TEAMS = 'teams'¶

TEAM_FILE_ID = 'teamFileId'¶

TEAM_ID = 'teamId'¶

TITLE = 'title'¶

TO = 'to'¶

TOKEN = 'token'¶

TOOL_CLASS_ID = 'toolClassId'¶

TOOL_STATE = 'toolState'¶

TOP = 'top'¶

TOTAL = 'total'¶

TRACK_ID = 'trackId'¶

TYPE = 'type'¶

UPDATED_AT = 'updatedAt'¶

URL = 'url'¶

USAGE = 'usage'¶

USERS_IDS = 'usersIds'¶

USER_ID = 'userId'¶

USER_IDS = 'userIds'¶

USER_LOGIN = 'userLogin'¶

USE_DIRECT_PROGRESS_MESSAGES = 'useDirectProgressMessages'¶

VALUE = 'value'¶

VERSION = 'version'¶

VERSIONS = 'versions'¶

VIDEOS = 'videos'¶

VIDEO_ID = 'videoId'¶

VIDEO_IDS = 'videoIds'¶

VIDEO_NAME = 'videoName'¶

VOLUMES = 'volumes'¶

VOLUME_ID = 'volumeId'¶

VOLUME_IDS = 'volumeIds'¶

VOLUME_NAME = 'volumeName'¶

VOLUME_SLICES = 'volumeSlices'¶

WEIGHTS_LOCATION = 'weightsLocation'¶

WIDGET = 'widget'¶

WIDGETS = 'widgets'¶

WIDTH = 'width'¶

WITH_CUSTOM_DATA = 'withCustomBigData'¶

WITH_METADATA = 'withMetadata'¶

WITH_SHARED = 'withShared'¶

WORKSPACE_ID = 'workspaceId'¶

WORKSPACE_NAME = (['workspaceTitle'], 'workspace_name')¶

ZOOM_FACTOR = 'zoomFactor'¶