diff --git a/.fernignore b/.fernignore index 0b4059bb5..c10518a6e 100644 --- a/.fernignore +++ b/.fernignore @@ -31,7 +31,7 @@ tests/custom/converter tests/custom/label_studio_tools tests/custom/legacy tests/custom/test_interface -# TODO: fix webhooks ! +# TODO: remove all tests from fernignore so that they can be regenerated tests/test_webhooks.py tests/test_refresh_token.py diff --git a/.mock/definition/__package__.yml b/.mock/definition/__package__.yml index 7558ed180..326f7fc23 100644 --- a/.mock/definition/__package__.yml +++ b/.mock/definition/__package__.yml @@ -1,20 +1,33 @@ errors: - BadRequestError: - status-code: 400 - type: unknown - docs: Invalid project ID supplied - examples: - - value: string NotFoundError: status-code: 404 type: unknown - docs: Project not found + docs: No more logs found + examples: + - value: + key: value + NotImplementedError: + status-code: 501 + type: unknown + docs: KPI depends on other KPIs - not implemented InternalServerError: status-code: 500 type: string docs: Predicting error examples: - value: Server responded with an error. + BadRequestError: + status-code: 400 + type: unknown + docs: Bad Request + examples: + - value: string + - value: + key: value + ForbiddenError: + status-code: 403 + type: unknown + docs: Permission Denied MethodNotAllowedError: status-code: 405 type: unknown @@ -22,17 +35,9 @@ errors: UnauthorizedError: status-code: 401 type: unknown - docs: Invalid refresh token + docs: Unauthorized - authentication required types: - AnnotationCompletedBy: - discriminated: false - union: - - UserSimple - - integer - source: - openapi: openapi/openapi.yaml - inline: true - AnnotationLastAction: + ActionEnum: enum: - prediction - propagated_annotation @@ -44,30 +49,355 @@ types: - rejected - fixed_and_accepted - deleted_review - docs: Action which was performed in the last annotation history item + docs: |- + * `prediction` - Created from prediction + * `propagated_annotation` - Created from another annotation + * `imported` - Imported + * `submitted` - Submitted + * `updated` - Updated + * `skipped` - Skipped + * `accepted` - Accepted + * `rejected` - Rejected + * `fixed_and_accepted` - Fixed and accepted + * `deleted_review` - Deleted review + source: + openapi: openapi/openapi.yaml + ActionsEnum: + enum: + - PROJECT_CREATED + - PROJECT_UPDATED + - PROJECT_DELETED + - TASKS_CREATED + - TASKS_DELETED + - ANNOTATION_CREATED + - ANNOTATIONS_CREATED + - ANNOTATION_UPDATED + - ANNOTATIONS_DELETED + - LABEL_LINK_CREATED + - LABEL_LINK_UPDATED + - LABEL_LINK_DELETED + - REVIEW_CREATED + - REVIEW_UPDATED + - REVIEWS_DELETED + docs: |- + * `PROJECT_CREATED` - PROJECT_CREATED + * `PROJECT_UPDATED` - PROJECT_UPDATED + * `PROJECT_DELETED` - PROJECT_DELETED + * `TASKS_CREATED` - TASKS_CREATED + * `TASKS_DELETED` - TASKS_DELETED + * `ANNOTATION_CREATED` - ANNOTATION_CREATED + * `ANNOTATIONS_CREATED` - ANNOTATIONS_CREATED + * `ANNOTATION_UPDATED` - ANNOTATION_UPDATED + * `ANNOTATIONS_DELETED` - ANNOTATIONS_DELETED + * `LABEL_LINK_CREATED` - LABEL_LINK_CREATED + * `LABEL_LINK_UPDATED` - LABEL_LINK_UPDATED + * `LABEL_LINK_DELETED` - LABEL_LINK_DELETED + * `REVIEW_CREATED` - REVIEW_CREATED + * `REVIEW_UPDATED` - REVIEW_UPDATED + * `REVIEWS_DELETED` - REVIEWS_DELETED + source: + openapi: openapi/openapi.yaml + ActivityLog: + properties: + id: integer + user_id: + type: integer + validation: + min: -2147483648 + max: 2147483647 + email: + type: string + validation: + maxLength: 256 + user_agent: + type: optional + validation: + maxLength: 1024 + http_referer: + type: optional + validation: + maxLength: 1024 + request_url: + type: string + validation: + maxLength: 256 + request_method: + type: string + validation: + maxLength: 10 + response_code: + type: string + validation: + maxLength: 3 + datetime: datetime + ip_address: optional + extra_data: optional + duration: + type: optional + docs: Duration of response generation in ms + validation: + min: -2147483648 + max: 2147483647 + project_id: + type: optional + docs: Project id if request has it + validation: + min: -2147483648 + max: 2147483647 + workspace_owner_id: + type: optional + docs: Owner id of workspace where action performed + validation: + min: -2147483648 + max: 2147483647 + organization_id: + type: optional + docs: Organization id + validation: + min: -2147483648 + max: 2147483647 + source: + openapi: openapi/openapi.yaml + ActivityLogResponse: + docs: Serializer for ActivityLogAPI response. + properties: + data: list + recordsTotal: integer + recordsFiltered: integer + source: + openapi: openapi/openapi.yaml + AllRolesProjectListSkipQueue: + discriminated: false + union: + - SkipQueueEnum + - NullEnum + source: + openapi: openapi/openapi.yaml + inline: true + AllRolesProjectListSampling: + discriminated: false + union: + - SamplingEnum + - NullEnum + source: + openapi: openapi/openapi.yaml inline: true + AllRolesProjectList: + docs: |- + Serializer get numbers from project queryset annotation, + make sure, that you use correct one(Project.objects.with_counts()) + properties: + label_config: + type: optional + docs: Label config in XML format. See more about it in documentation + control_weights: optional + description_short: string + rejected: string + description: + type: optional + docs: Project description + total_predictions_number: integer + workspace: string + created_by: + type: optional + docs: Project owner + config_suitable_for_bulk_annotation: + type: boolean + docs: Flag to detect is project ready for bulk annotation + custom_script: optional + duplication_status: optional + workspace_title: string + allow_stream: string + show_annotation_history: + type: optional + docs: Show annotation history to annotator + assignment_settings: AssignmentSettings + review_total_tasks: string + reviewed_number: string + show_skip_button: + type: optional + docs: Show a skip button in interface and allow annotators to skip the task + skip_queue: optional + finished_task_number: integer + annotation_limit_count: + type: optional + validation: + min: 1 + ground_truth_number: + type: integer + docs: Honeypot annotation number in project + min_annotations_to_start_training: + type: optional + docs: >- + Minimum number of completed tasks after which model training is + started + validation: + min: -2147483648 + max: 2147483647 + show_collab_predictions: + type: optional + docs: If set, the annotator can view model predictions + show_overlap_first: optional + start_training_on_annotation_update: + type: boolean + docs: Start model training after any annotations are submitted or updated + id: integer + data_types: unknown + is_published: + type: optional + docs: Whether or not the project is published to annotators + parsed_label_config: unknown + expert_instruction: + type: optional + docs: Labeling instructions in HTML format + model_version: + type: optional + docs: Machine learning model version + enable_empty_annotation: + type: optional + docs: Allow annotators to submit empty annotations + is_draft: + type: optional + docs: Whether or not the project is in the middle of being created + total_annotations_number: string + custom_task_lock_ttl: + type: optional + docs: TTL in seconds for task reservations, on new and existing tasks + validation: + min: 1 + max: 86400 + prompts: string + annotation_limit_percent: + type: optional + validation: + pattern: ^-?\d{0,3}(?:\.\d{0,2})?$ + maximum_annotations: + type: optional + docs: >- + Maximum number of annotations for one task. If the number of + annotations per task is equal or greater to this value, the task is + completed (is_labeled=True) + validation: + min: -2147483648 + max: 2147483647 + reviewer_queue_total: string + members_count: string + members: string + overlap_cohort_percentage: + type: optional + validation: + min: -2147483648 + max: 2147483647 + show_ground_truth_first: optional + show_instruction: + type: optional + docs: Show instructions to the annotator before they start + review_settings: ReviewSettings + annotator_evaluation_minimum_tasks: + type: optional + default: 10 + validation: + min: 0 + queue_total: string + comment_classification_config: optional + annotator_evaluation_minimum_score: + type: optional + default: '95.00' + validation: + pattern: ^-?\d{0,3}(?:\.\d{0,2})?$ + require_comment_on_skip: + type: optional + default: false + sampling: optional + config_has_control_tags: + type: boolean + docs: Flag to detect is project ready for labeling + organization: optional + pinned_at: + type: optional + docs: Pinned date and time + created_at: datetime + queue_done: string + queue_left: string + pause_on_failed_annotator_evaluation: + type: optional + default: false + has_blueprints: string + num_tasks_with_annotations: string + task_number: + type: integer + docs: Total task number in project + evaluate_predictions_automatically: + type: optional + docs: Retrieve and display predictions when loading a task + ready: string + blueprints: list + color: + type: optional + validation: + maxLength: 16 + duplication_done: + type: optional + default: false + skipped_annotations_number: string + reveal_preannotations_interactively: + type: optional + docs: Reveal pre-annotations interactively + useful_annotation_number: string + title: + type: optional + docs: Project name. Must be between 3 and 50 characters long. + validation: + minLength: 3 + maxLength: 50 + source: + openapi: openapi/openapi.yaml + AnnotatedEnum: + enum: + - only + - exclude + docs: |- + * `only` - only + * `exclude` - exclude + * `None` - None + source: + openapi: openapi/openapi.yaml + AnnotationLastAction: + discriminated: false + docs: |- + Action which was performed in the last annotation history item + + * `prediction` - Created from prediction + * `propagated_annotation` - Created from another annotation + * `imported` - Imported + * `submitted` - Submitted + * `updated` - Updated + * `skipped` - Skipped + * `accepted` - Accepted + * `rejected` - Rejected + * `fixed_and_accepted` - Fixed and accepted + * `deleted_review` - Deleted review + union: + - LastActionEnum + - NullEnum source: openapi: openapi/openapi.yaml + inline: true Annotation: properties: - id: optional + id: integer result: type: optional>> docs: List of annotation results for the task created_username: - type: optional + type: string docs: Username string + default: '' created_ago: - type: optional + type: string docs: Time delta from creation time default: '' - validation: - minLength: 1 - completed_by: optional - unique_id: - type: optional - validation: - minLength: 1 + completed_by: optional was_cancelled: type: optional docs: User skipped the task @@ -75,10 +405,10 @@ types: type: optional docs: This annotation is a Ground Truth (ground_truth) created_at: - type: optional + type: datetime docs: Creation time updated_at: - type: optional + type: datetime docs: Last updated time draft_created_at: type: optional @@ -87,13 +417,28 @@ types: type: optional docs: How much time it took to annotate the task import_id: - type: optional + type: optional docs: >- Original annotation ID that was at the import step or NULL if this annotation wasn't imported last_action: type: optional - docs: Action which was performed in the last annotation history item + docs: |- + Action which was performed in the last annotation history item + + * `prediction` - Created from prediction + * `propagated_annotation` - Created from another annotation + * `imported` - Imported + * `submitted` - Submitted + * `updated` - Updated + * `skipped` - Skipped + * `accepted` - Accepted + * `rejected` - Rejected + * `fixed_and_accepted` - Fixed and accepted + * `deleted_review` - Deleted review + bulk_created: + type: optional + docs: Annotation was created in bulk mode task: type: optional docs: Corresponding task for this annotation @@ -114,612 +459,750 @@ types: docs: User who created the last annotation history item source: openapi: openapi/openapi.yaml - BaseUser: + AnnotationHistoryAction: + discriminated: false + union: + - ActionEnum + - NullEnum + source: + openapi: openapi/openapi.yaml + inline: true + AnnotationHistory: + docs: |- + A ModelSerializer that takes additional arguments for + "fields", "omit" and "expand" in order to + control which fields are displayed, and whether to replace simple + values with complex, nested serializations properties: - id: optional - first_name: - type: optional + id: integer + comment: optional + organization_id: + type: optional + docs: Organization for this annotation history validation: - maxLength: 256 - last_name: - type: optional + min: -2147483648 + max: 2147483647 + project_id: + type: optional + docs: Project for this annotation history validation: - maxLength: 256 - username: - type: string + min: -2147483648 + max: 2147483647 + annotation_id: + type: optional + docs: Corresponding annotation for this historical annotation validation: - minLength: 1 - maxLength: 256 - email: - type: optional + min: -2147483648 + max: 2147483647 + draft_id: + type: optional + docs: Corresponding draft for this historical annotation validation: - format: email - maxLength: 254 - last_activity: optional - avatar: optional - initials: optional - phone: - type: optional + min: -2147483648 + max: 2147483647 + review_id: + type: optional + docs: AnnotationReview ID, using with review field validation: - maxLength: 256 - active_organization: optional - allow_newsletters: - type: optional - docs: Allow sending newsletters to user - date_joined: optional - source: - openapi: openapi/openapi.yaml - Filter: - properties: - id: optional - index: + min: -2147483648 + max: 2147483647 + task_id: type: optional - docs: To keep filter order - column: - type: string - docs: Field name + docs: Task id validation: - minLength: 1 - maxLength: 1024 - type: - type: string - docs: Field type + min: -2147483648 + max: 2147483647 + result: optional + lead_time: + type: optional + docs: How much time it took to annotate the task + action: optional + started_at: + type: optional + docs: >- + The time that a user started working on this revision of the + annotation + created_at: datetime + created_by: + type: optional + docs: Created by user id validation: - minLength: 1 - maxLength: 1024 - operator: - type: string - docs: Filter operator + min: -2147483648 + max: 2147483647 + comment_id: + type: optional + docs: Comment id sent with result validation: - minLength: 1 - maxLength: 1024 - value: - type: optional> - docs: Filter value + min: -2147483648 + max: 2147483647 source: openapi: openapi/openapi.yaml - FilterGroup: - properties: - id: optional - filters: list - conjunction: - type: string - docs: Type of conjunction - validation: - minLength: 1 - maxLength: 1024 + AnnotationRequestLastAction: + discriminated: false + docs: |- + Action which was performed in the last annotation history item + + * `prediction` - Created from prediction + * `propagated_annotation` - Created from another annotation + * `imported` - Imported + * `submitted` - Submitted + * `updated` - Updated + * `skipped` - Skipped + * `accepted` - Accepted + * `rejected` - Rejected + * `fixed_and_accepted` - Fixed and accepted + * `deleted_review` - Deleted review + union: + - LastActionEnum + - NullEnum source: openapi: openapi/openapi.yaml - View: + inline: true + AnnotationRequest: properties: - id: optional - filter_group: optional - data: - type: optional> - docs: Custom view data - ordering: - type: optional> - docs: Ordering parameters - selected_items: - type: optional> - docs: Selected items - user: + result: + type: optional>> + docs: List of annotation results for the task + completed_by: optional + unique_id: + type: optional + validation: + minLength: 1 + was_cancelled: + type: optional + docs: User skipped the task + ground_truth: + type: optional + docs: This annotation is a Ground Truth (ground_truth) + draft_created_at: + type: optional + docs: Draft creation time + lead_time: + type: optional + docs: How much time it took to annotate the task + import_id: + type: optional + docs: >- + Original annotation ID that was at the import step or NULL if this + annotation wasn't imported + last_action: + type: optional + docs: |- + Action which was performed in the last annotation history item + + * `prediction` - Created from prediction + * `propagated_annotation` - Created from another annotation + * `imported` - Imported + * `submitted` - Submitted + * `updated` - Updated + * `skipped` - Skipped + * `accepted` - Accepted + * `rejected` - Rejected + * `fixed_and_accepted` - Fixed and accepted + * `deleted_review` - Deleted review + bulk_created: + type: optional + docs: Annotation was created in bulk mode + task: type: optional - docs: User who made this view + docs: Corresponding task for this annotation project: - type: integer - docs: Project ID + type: optional + docs: Project ID for this annotation + updated_by: + type: optional + docs: Last user who updated this annotation + parent_prediction: + type: optional + docs: Points to the prediction from which this annotation was created + parent_annotation: + type: optional + docs: Points to the parent annotation from which this annotation was created + last_created_by: + type: optional + docs: User who created the last annotation history item source: openapi: openapi/openapi.yaml - FileUpload: + AnnotationReview: + docs: |- + A ModelSerializer that takes additional arguments for + "fields", "omit" and "expand" in order to + control which fields are displayed, and whether to replace simple + values with complex, nested serializations properties: - id: optional - file: optional + id: integer + created_by: + type: integer + docs: User who made this review + created_at: + type: datetime + docs: Creation time + accepted: + type: optional + docs: Accepted or rejected (if false) flag + result: optional + annotation: + type: integer + docs: Corresponding annotation + fixed_annotation_history: + type: optional + docs: Fixed annotation history item by the reviewer + previous_annotation_history: + type: optional + docs: Previous annotation history item by the annotator + last_annotation_history: optional + remove_from_queue: optional + started_at: optional source: openapi: openapi/openapi.yaml - OrganizationInvite: + AnnotationReviewRequest: + docs: |- + A ModelSerializer that takes additional arguments for + "fields", "omit" and "expand" in order to + control which fields are displayed, and whether to replace simple + values with complex, nested serializations properties: - token: - type: optional - validation: - minLength: 1 - invite_url: + accepted: + type: optional + docs: Accepted or rejected (if false) flag + result: optional + annotation: + type: integer + docs: Corresponding annotation + last_annotation_history: optional + comment: type: optional validation: minLength: 1 + remove_from_queue: optional + started_at: optional source: openapi: openapi/openapi.yaml - LabelLink: + AssignmentSettingsLabelStreamTaskDistribution: + discriminated: false + docs: >- + Modes for distributing tasks to annotators + + + * `auto_distribution` - Label Stream distributes tasks automatically to + annotators + + * `assigned_only` - Label Stream shows tasks only to assigned users + union: + - LabelStreamTaskDistributionEnum + - NullEnum + source: + openapi: openapi/openapi.yaml + inline: true + AssignmentSettings: properties: - id: optional - annotations_count: optional - from_name: - type: string - docs: Tag name - validation: - minLength: 1 - maxLength: 2048 - project: integer - label: integer + id: integer + label_stream_task_distribution: + type: optional + docs: >- + Modes for distributing tasks to annotators + + + * `auto_distribution` - Label Stream distributes tasks automatically + to annotators + + * `assigned_only` - Label Stream shows tasks only to assigned users + project: optional source: openapi: openapi/openapi.yaml - Label: + AssignmentSettingsRequestLabelStreamTaskDistribution: + discriminated: false + docs: >- + Modes for distributing tasks to annotators + + + * `auto_distribution` - Label Stream distributes tasks automatically to + annotators + + * `assigned_only` - Label Stream shows tasks only to assigned users + union: + - LabelStreamTaskDistributionEnum + - NullEnum + source: + openapi: openapi/openapi.yaml + inline: true + AssignmentSettingsRequest: properties: - id: optional - links: optional> - created_at: - type: optional - docs: Time of label creation - updated_at: - type: optional - docs: Time of label modification - value: - type: map - docs: Label value - title: - type: string - docs: Label title - validation: - minLength: 1 - maxLength: 2048 - description: - type: optional - docs: Label description - approved: - type: optional - docs: Status of label - created_by: - type: integer - docs: User who made this label - approved_by: - type: optional - docs: User who approved this label - organization: integer - projects: optional> + label_stream_task_distribution: + type: optional + docs: >- + Modes for distributing tasks to annotators + + + * `auto_distribution` - Label Stream distributes tasks automatically + to annotators + + * `assigned_only` - Label Stream shows tasks only to assigned users + project: optional source: openapi: openapi/openapi.yaml - LabelCreate: + AssociatedProject: + docs: |- + A ModelSerializer that takes additional arguments for + "fields", "omit" and "expand" in order to + control which fields are displayed, and whether to replace simple + values with complex, nested serializations properties: - id: optional - created_by: optional - organization: optional - project: integer - from_name: - type: string - validation: - minLength: 1 - created_at: - type: optional - docs: Time of label creation - updated_at: - type: optional - docs: Time of label modification - value: - type: map - docs: Label value + id: integer title: - type: string - docs: Label title - validation: - minLength: 1 - maxLength: 2048 - description: type: optional - docs: Label description - approved: - type: optional - docs: Status of label - approved_by: - type: optional - docs: User who approved this label - projects: optional> - source: - openapi: openapi/openapi.yaml - MlBackendState: - enum: - - CO - - DI - - ER - - TR - - PR - inline: true + docs: Project name. Must be between 3 and 50 characters long. + validation: + minLength: 3 + maxLength: 50 source: openapi: openapi/openapi.yaml - MlBackendAuthMethod: + AuthMethodEnum: enum: - NONE - BASIC_AUTH - inline: true + docs: |- + * `NONE` - None + * `BASIC_AUTH` - Basic Auth source: openapi: openapi/openapi.yaml - MlBackend: + AzureBlobExportStorage: properties: - id: optional - state: optional - readable_state: optional - is_interactive: - type: optional - docs: >- - Used to interactively annotate tasks. If true, model returns one list - with results - url: + id: integer + type: type: string - docs: URL for the machine learning model server - validation: - minLength: 1 - error_message: + default: azure + synchronizable: + type: optional + default: true + container: type: optional - docs: Error message in error state - title: + docs: Azure blob container + prefix: type: optional - docs: Name of the machine learning backend - auth_method: optional - basic_auth_user: + docs: Azure blob prefix name + regex_filter: type: optional - docs: HTTP Basic Auth user - basic_auth_pass: optional - basic_auth_pass_is_set: optional - description: + docs: Cloud storage regex for filtering objects + use_blob_urls: + type: optional + docs: Interpret objects as BLOBs and generate URLs + account_name: type: optional - docs: Description for the machine learning backend - extra_params: - type: optional> - docs: Any extra parameters passed to the ML Backend during the setup - model_version: + docs: Azure Blob account name + account_key: type: optional - docs: Current model version associated with this machine learning backend - timeout: - type: optional - docs: Response model timeout - created_at: optional - updated_at: optional - auto_update: - type: optional - docs: >- - If false, model version is set by the user, if true - getting latest - version from backend. - project: integer - source: - openapi: openapi/openapi.yaml - OrganizationId: - properties: - id: optional - title: - type: string + docs: Azure Blob account key + last_sync: + type: optional + docs: Last sync finished time + last_sync_count: + type: optional + docs: Count of tasks synced last time validation: - minLength: 1 - maxLength: 1000 - contact_info: + min: 0 + max: 2147483647 + last_sync_job: type: optional + docs: Last sync job ID validation: - format: email - maxLength: 254 - created_at: optional + maxLength: 256 + status: optional + traceback: + type: optional + docs: Traceback report for the last failed sync + meta: optional + title: + type: optional + docs: Cloud storage title + validation: + maxLength: 256 + description: + type: optional + docs: Cloud storage description + created_at: + type: datetime + docs: Creation time + can_delete_objects: + type: optional + docs: Deletion from storage enabled + project: + type: integer + docs: A unique integer value identifying this project. source: openapi: openapi/openapi.yaml - Organization: + AzureBlobImportStorage: properties: - id: optional - title: + id: integer + type: type: string + default: azure + synchronizable: + type: optional + default: true + presign: + type: optional + default: true + container: + type: optional + docs: Azure blob container + prefix: + type: optional + docs: Azure blob prefix name + regex_filter: + type: optional + docs: Cloud storage regex for filtering objects + use_blob_urls: + type: optional + docs: Interpret objects as BLOBs and generate URLs + account_name: + type: optional + docs: Azure Blob account name + account_key: + type: optional + docs: Azure Blob account key + last_sync: + type: optional + docs: Last sync finished time + last_sync_count: + type: optional + docs: Count of tasks synced last time validation: - minLength: 1 - maxLength: 1000 - token: + min: 0 + max: 2147483647 + last_sync_job: type: optional + docs: Last sync job ID validation: maxLength: 256 - created_at: optional - updated_at: optional - contact_info: + status: optional + traceback: + type: optional + docs: Traceback report for the last failed sync + meta: optional + title: type: optional + docs: Cloud storage title validation: - format: email - maxLength: 254 - created_by: optional - users: optional> + maxLength: 256 + description: + type: optional + docs: Cloud storage description + created_at: + type: datetime + docs: Creation time + presign_ttl: + type: optional + docs: Presigned URLs TTL (in minutes) + validation: + min: 0 + max: 32767 + project: + type: integer + docs: A unique integer value identifying this project. source: openapi: openapi/openapi.yaml - UserSerializerWithProjects: + AzureDatasetStorage: properties: - id: optional - first_name: + id: integer + type: + type: string + default: azure + synchronizable: + type: optional + default: true + presign: + type: optional + default: true + container: + type: optional + docs: Azure blob container + prefix: + type: optional + docs: Azure blob prefix name + regex_filter: + type: optional + docs: Cloud storage regex for filtering objects + use_blob_urls: + type: optional + docs: Interpret objects as BLOBs and generate URLs + account_name: + type: optional + docs: Azure Blob account name + account_key: type: optional + docs: Azure Blob account key + last_sync: + type: optional + docs: Last sync finished time + last_sync_count: + type: optional + docs: Count of tasks synced last time validation: - maxLength: 256 - last_name: + min: 0 + max: 2147483647 + last_sync_job: type: optional + docs: Last sync job ID validation: maxLength: 256 - username: - type: string + status: optional + traceback: + type: optional + docs: Traceback report for the last failed sync + meta: optional + title: + type: optional + docs: Cloud storage title validation: - minLength: 1 maxLength: 256 - email: + description: type: optional + docs: Cloud storage description + created_at: + type: datetime + docs: Creation time + presign_ttl: + type: optional + docs: Presigned URLs TTL (in minutes) validation: - format: email - maxLength: 254 - last_activity: optional - avatar: optional - initials: optional - phone: + min: 0 + max: 32767 + glob_pattern: type: optional - validation: - maxLength: 256 - active_organization: optional - allow_newsletters: + docs: Glob pattern for syncing from bucket + synced: type: optional - docs: Allow sending newsletters to user - date_joined: optional - created_projects: optional - contributed_to_projects: optional - source: - openapi: openapi/openapi.yaml - OrganizationMemberUser: - properties: - id: optional - organization: + docs: Flag if dataset has been previously synced or not + job_id: + type: optional + dataset: type: integer - docs: Organization ID - user: UserSerializerWithProjects + docs: A unique integer value identifying this dataset. source: openapi: openapi/openapi.yaml - Prediction: + AzureDatasetStorageRequest: properties: - id: optional - result: - docs: List of prediction results for the task - type: list> - model_version: + synchronizable: + type: optional + default: true + presign: + type: optional + default: true + container: type: optional - docs: >- - Model version - tag for predictions that can be used to filter tasks - in Data Manager, as well as select specific model version for showing - preannotations in the labeling interface - created_ago: + docs: Azure blob container + prefix: type: optional - docs: Delta time from creation time - default: '' - validation: - minLength: 1 - score: - type: optional - docs: Prediction score - cluster: - type: optional - docs: Cluster for the current prediction - neighbors: - type: optional> - docs: Array of task IDs of the closest neighbors - mislabeling: - type: optional - docs: Related task mislabeling score - created_at: optional - updated_at: optional - model: - type: optional - docs: An ML Backend instance that created the prediction. - model_run: + docs: Azure blob prefix name + regex_filter: + type: optional + docs: Cloud storage regex for filtering objects + use_blob_urls: + type: optional + docs: Interpret objects as BLOBs and generate URLs + account_name: + type: optional + docs: Azure Blob account name + account_key: + type: optional + docs: Azure Blob account key + last_sync: + type: optional + docs: Last sync finished time + last_sync_count: type: optional - docs: A run of a ModelVersion that created the prediction. - task: integer - project: optional - source: - openapi: openapi/openapi.yaml - UserSimple: - docs: Project owner - properties: - id: optional - first_name: + docs: Count of tasks synced last time + validation: + min: 0 + max: 2147483647 + last_sync_job: type: optional + docs: Last sync job ID validation: maxLength: 256 - last_name: + status: optional + traceback: + type: optional + docs: Traceback report for the last failed sync + meta: optional + title: type: optional + docs: Cloud storage title validation: maxLength: 256 - email: + description: type: optional + docs: Cloud storage description + presign_ttl: + type: optional + docs: Presigned URLs TTL (in minutes) validation: - format: email - maxLength: 254 - avatar: optional + min: 0 + max: 32767 + glob_pattern: + type: optional + docs: Glob pattern for syncing from bucket + synced: + type: optional + docs: Flag if dataset has been previously synced or not + dataset: + type: integer + docs: A unique integer value identifying this dataset. source: openapi: openapi/openapi.yaml - ProjectSampling: - enum: - - value: Sequential sampling - name: SequentialSampling - - value: Uniform sampling - name: UniformSampling - - value: Uncertainty sampling - name: UncertaintySampling - inline: true + BatchFailedPredictions: + properties: + job_id: + type: string + validation: + maxLength: 255 + failed_predictions: list source: openapi: openapi/openapi.yaml - ProjectSkipQueue: - enum: - - REQUEUE_FOR_ME - - REQUEUE_FOR_OTHERS - - IGNORE_SKIPPED - inline: true + BatchPredictions: + properties: + job_id: + type: string + validation: + maxLength: 255 + results: list source: openapi: openapi/openapi.yaml - Project: + BlankEnum: literal<""> + Blueprint: properties: - id: optional + id: integer + share_id: string + short_url: string + project: integer + created_by: optional title: type: optional - docs: Project name. Must be between 3 and 50 characters long. + docs: Blueprint name. Must be between 3 and 50 characters long. validation: - minLength: 3 maxLength: 50 description: type: optional docs: Project description label_config: type: optional - docs: Label config in XML format. See more about it in documentation - expert_instruction: - type: optional - docs: Labeling instructions in HTML format - show_instruction: - type: optional - docs: Show instructions to the annotator before they start - show_skip_button: - type: optional - docs: Show a skip button in interface and allow annotators to skip the task - enable_empty_annotation: - type: optional - docs: Allow annotators to submit empty annotations - show_annotation_history: - type: optional - docs: Show annotation history to annotator - organization: optional - prompts: optional> - color: + docs: Labeling configuration in XML format + created_at: datetime + updated_at: datetime + source: + openapi: openapi/openapi.yaml + BlueprintList: + properties: + id: integer + share_id: string + short_url: string + title: type: optional + docs: Blueprint name. Must be between 3 and 50 characters long. validation: - maxLength: 16 - maximum_annotations: - type: optional - docs: >- - Maximum number of annotations for one task. If the number of - annotations per task is equal or greater to this value, the task is - completed (is_labeled=True) - annotation_limit_count: - type: optional - docs: >- - Maximum number of tasks that can be annotated by a single annotator in - this project pause - annotation_limit_percent: - type: optional - docs: >- - Maximum percentage of tasks in this project that can be annotated by a - single annotator - is_published: - type: optional - docs: Whether or not the project is published to annotators - model_version: - type: optional - docs: Machine learning model version - is_draft: - type: optional - docs: Whether or not the project is in the middle of being created - created_by: optional - created_at: optional - min_annotations_to_start_training: - type: optional - docs: >- - Minimum number of completed tasks after which model training is - started - start_training_on_annotation_update: - type: optional - docs: Start model training after any annotations are submitted or updated - show_collab_predictions: - type: optional - docs: If set, the annotator can view model predictions - num_tasks_with_annotations: - type: optional - docs: Tasks with annotations count - task_number: - type: optional - docs: Total task number in project - useful_annotation_number: - type: optional - docs: >- - Useful annotation number in project not including - skipped_annotations_number and ground_truth_number. Total annotations - = annotation_number + skipped_annotations_number + ground_truth_number - ground_truth_number: - type: optional - docs: Honeypot annotation number in project - skipped_annotations_number: - type: optional - docs: Skipped by collaborators annotation number in project - total_annotations_number: - type: optional - docs: >- - Total annotations number in project including - skipped_annotations_number and ground_truth_number. - total_predictions_number: - type: optional - docs: >- - Total predictions number in project including - skipped_annotations_number, ground_truth_number, and - useful_annotation_number. - sampling: optional - show_ground_truth_first: optional - show_overlap_first: optional - overlap_cohort_percentage: optional - task_data_login: + maxLength: 50 + description: type: optional - docs: 'Task data credentials: login' - validation: - maxLength: 256 - task_data_password: + docs: Project description + created_at: datetime + source: + openapi: openapi/openapi.yaml + BudgetResetPeriodEnum: + enum: + - Monthly + - Yearly + docs: |- + * `Monthly` - Monthly + * `Yearly` - Yearly + source: + openapi: openapi/openapi.yaml + Comment: + properties: + id: integer + region_ref: optional + classifications: optional + text: type: optional - docs: 'Task data credentials: password' - validation: - maxLength: 256 - control_weights: - type: optional> - docs: > - Dict of weights for each control tag in metric calculation. Each - control tag (e.g. label or choice) will have its own key in control - weight dict with weight for each label and overall weight. For - example, if a bounding box annotation with a control tag named my_bbox - should be included with 0.33 weight in agreement calculation, and the - first label Car should be twice as important as Airplane, then you - need to specify: {'my_bbox': {'type': 'RectangleLabels', 'labels': - {'Car': 1.0, 'Airplane': 0.5}, 'overall': 0.33}} - parsed_label_config: - type: optional> - docs: JSON-formatted labeling configuration - evaluate_predictions_automatically: + docs: Reviewer or annotator comment + created_at: + type: datetime + docs: Creation time + updated_at: + type: datetime + docs: Last updated time + is_resolved: type: optional - docs: Retrieve and display predictions when loading a task - config_has_control_tags: + docs: True if the comment is resolved + resolved_at: + type: optional + docs: Resolving time + project: optional + task: optional + draft: optional + annotation: optional + created_by: + type: integer + docs: User who made this comment + source: + openapi: openapi/openapi.yaml + CommentRequest: + properties: + region_ref: optional + classifications: optional + text: + type: optional + docs: Reviewer or annotator comment + is_resolved: type: optional - docs: Flag to detect is project ready for labeling - skip_queue: optional - reveal_preannotations_interactively: + docs: True if the comment is resolved + draft: optional + annotation: optional + source: + openapi: openapi/openapi.yaml + CommentSerializerWithExpandedUser: + properties: + id: integer + created_by: LseUser + region_ref: optional + classifications: optional + text: + type: optional + docs: Reviewer or annotator comment + created_at: + type: datetime + docs: Creation time + updated_at: + type: datetime + docs: Last updated time + is_resolved: type: optional - docs: Reveal pre-annotations interactively - pinned_at: + docs: True if the comment is resolved + resolved_at: type: optional - docs: Pinned date and time - finished_task_number: - type: optional - docs: Finished tasks - queue_total: optional - queue_done: optional + docs: Resolving time + project: optional + task: optional + draft: optional + annotation: optional source: openapi: openapi/openapi.yaml - ProjectLabelConfig: + ConvertedFormat: properties: - label_config: + id: integer + status: optional + export_type: type: string - docs: Label config in XML format. See more about it in documentation validation: - minLength: 1 - source: - openapi: openapi/openapi.yaml - ConvertedFormatStatus: - enum: - - created - - in_progress - - failed - - completed - inline: true + maxLength: 64 + traceback: + type: optional + docs: Traceback report in case of errors source: openapi: openapi/openapi.yaml - ConvertedFormat: + ConvertedFormatRequest: properties: - id: optional - status: optional + status: optional export_type: type: string validation: @@ -730,167 +1213,393 @@ types: docs: Traceback report in case of errors source: openapi: openapi/openapi.yaml - ExportStatus: + CustomScriptsEditableByEnum: enum: - - created - - in_progress - - failed - - completed - inline: true + - AD + - MA + docs: |- + * `AD` - Administrator + * `MA` - Manager source: openapi: openapi/openapi.yaml - Export: + Dataset: properties: + id: integer + created_by: + type: optional + docs: User who created Dataset + created_at: + type: datetime + docs: Creation time + updated_at: + type: datetime + docs: Last updated time title: + type: string + docs: Dataset title + validation: + maxLength: 1000 + description: type: optional + docs: Dataset description + columns: optional + total_entities: + type: optional validation: - maxLength: 2048 - id: optional - created_by: optional - created_at: - type: optional - docs: Creation time - finished_at: - type: optional - docs: Complete or fail time - status: optional - md5: + min: -2147483648 + max: 2147483647 + vector_db_dataset_name: type: optional + docs: Dataset name for weaviate schema validation: - minLength: 1 - maxLength: 128 - counters: optional> - converted_formats: optional> + maxLength: 37 + organization: optional source: openapi: openapi/openapi.yaml - ProjectImportStatus: - enum: - - created - - in_progress - - failed - - completed - inline: true + DatasetMember: + properties: + user: integer source: openapi: openapi/openapi.yaml - ProjectImport: + DatasetRequest: properties: - id: optional - preannotated_from_fields: optional> - commit_to_project: optional - return_task_ids: optional - status: optional - url: + created_by: + type: optional + docs: User who created Dataset + title: + type: string + docs: Dataset title + validation: + minLength: 1 + maxLength: 1000 + description: type: optional + docs: Dataset description + columns: optional + total_entities: + type: optional validation: - maxLength: 2048 - traceback: optional - error: optional - created_at: - type: optional - docs: Creation time - updated_at: - type: optional - docs: Updated time - finished_at: - type: optional - docs: Complete or fail time - task_count: optional - annotation_count: optional - prediction_count: optional - duration: optional - file_upload_ids: optional> - could_be_tasks_list: optional - found_formats: optional> - data_columns: optional> - tasks: optional> - task_ids: optional> - project: optional - source: - openapi: openapi/openapi.yaml - ProjectReimportStatus: - enum: - - created - - in_progress - - failed - - completed - inline: true + min: -2147483648 + max: 2147483647 + vector_db_dataset_name: + type: optional + docs: Dataset name for weaviate schema + validation: + minLength: 1 + maxLength: 37 + organization: optional source: openapi: openapi/openapi.yaml - ProjectReimport: + DatasetView: properties: - id: optional - status: optional - error: optional - task_count: optional - annotation_count: optional - prediction_count: optional - duration: optional - file_upload_ids: optional> - files_as_tasks_list: optional - found_formats: optional> - data_columns: optional> - traceback: optional - project: optional + id: integer + filter_group: optional + data: optional + ordering: optional + order: + type: optional + docs: >- + Position of the tab, starting at the left in data manager and + increasing as the tabs go left to right + validation: + min: -2147483648 + max: 2147483647 + selected_items: optional + user: + type: optional + docs: User who made this view + dataset: + type: integer + docs: Dataset ID + source: + openapi: openapi/openapi.yaml + DatasetViewRequest: + properties: + filter_group: optional + data: optional + ordering: optional + order: + type: optional + docs: >- + Position of the tab, starting at the left in data manager and + increasing as the tabs go left to right + validation: + min: -2147483648 + max: 2147483647 + selected_items: optional + user: + type: optional + docs: User who made this view + dataset: + type: integer + docs: Dataset ID + source: + openapi: openapi/openapi.yaml + DefaultRoleCustomScriptsEditableBy: + discriminated: false + docs: |- + Set the minimum user role that can edit custom scripts in the UI. + + * `AD` - Administrator + * `MA` - Manager + union: + - CustomScriptsEditableByEnum + - NullEnum source: openapi: openapi/openapi.yaml - AzureBlobImportStorageStatus: - enum: - - initialized - - queued - - in_progress - - failed - - completed inline: true + DefaultRole: + properties: + organization: + type: integer + docs: A unique integer value identifying this organization. + default_role: + type: optional + docs: |- + Default membership role for invited users + + * `OW` - Owner + * `AD` - Administrator + * `MA` - Manager + * `RE` - Reviewer + * `AN` - Annotator + * `DI` - Deactivated + * `NO` - Not Activated + external_id: + type: optional + docs: External ID to uniquely identify this organization + embed_domains: optional + embed_settings: optional + extra_data_on_activity_logs: optional + custom_scripts_enabled_at: + type: optional + docs: >- + Set to current time to enabled custom scripts for this organization. + Can only be enabled if no organization members are active members of + any other organizations; otherwise an error will be raised. If this + occurs, contact the LEAP team for assistance with enabling custom + scripts. + custom_scripts_editable_by: + type: optional + docs: |- + Set the minimum user role that can edit custom scripts in the UI. + + * `AD` - Administrator + * `MA` - Manager + annotator_reviewer_firewall_enabled_at: + type: optional + docs: >- + Set to current time to restrict data sharing between annotators and + reviewers in the label stream, review stream, and notifications (which + will be disabled). In these settings, information about annotator and + reviewer identity is suppressed in the UI. + read_only_quick_view_enabled_at: + type: optional + docs: >- + Set to current time to prevent creating or editing annotations in + quick view. + label_stream_navigation_disabled_at: + type: optional + docs: >- + Set to current time to disable the label stream navigation for this + organization. This will prevent users from going back in the label + stream to view previous labels. source: openapi: openapi/openapi.yaml - AzureBlobImportStorage: + DefaultRoleEnum: + enum: + - OW + - AD + - MA + - RE + - AN + - DI + - 'NO' + docs: |- + * `OW` - Owner + * `AD` - Administrator + * `MA` - Manager + * `RE` - Reviewer + * `AN` - Annotator + * `DI` - Deactivated + * `NO` - Not Activated + source: + openapi: openapi/openapi.yaml + EditionEnum: + enum: + - Community + - Enterprise + docs: |- + * `Community` - Community + * `Enterprise` - Enterprise + source: + openapi: openapi/openapi.yaml + Export: properties: - id: optional - type: + title: type: optional - default: azure + validation: + maxLength: 2048 + id: integer + created_by: optional + created_at: + type: datetime + docs: Creation time + finished_at: + type: optional + docs: Complete or fail time + status: optional + md5: + type: optional + validation: + maxLength: 128 + counters: optional + converted_formats: optional> + source: + openapi: openapi/openapi.yaml + FileUpload: + properties: + id: integer + file: string + source: + openapi: openapi/openapi.yaml + Filter: + properties: + id: integer + index: + type: optional + docs: To keep filter order + validation: + min: -2147483648 + max: 2147483647 + column: + type: string + docs: Field name + validation: + maxLength: 1024 + type: + type: string + docs: Field type + validation: + maxLength: 1024 + operator: + type: string + docs: Filter operator + validation: + maxLength: 1024 + value: optional + source: + openapi: openapi/openapi.yaml + FilterGroup: + properties: + id: integer + filters: list + conjunction: + type: string + docs: Type of conjunction + validation: + maxLength: 1024 + source: + openapi: openapi/openapi.yaml + FilterGroupRequest: + properties: + filters: list + conjunction: + type: string + docs: Type of conjunction + validation: + minLength: 1 + maxLength: 1024 + source: + openapi: openapi/openapi.yaml + FilterRequest: + properties: + index: + type: optional + docs: To keep filter order + validation: + min: -2147483648 + max: 2147483647 + column: + type: string + docs: Field name + validation: + minLength: 1 + maxLength: 1024 + type: + type: string + docs: Field type + validation: + minLength: 1 + maxLength: 1024 + operator: + type: string + docs: Filter operator + validation: + minLength: 1 + maxLength: 1024 + value: optional + source: + openapi: openapi/openapi.yaml + FinishedEnum: + enum: + - only + - exclude + docs: |- + * `only` - only + * `exclude` - exclude + * `None` - None + source: + openapi: openapi/openapi.yaml + GcsDatasetStorage: + properties: + id: integer + type: + type: string + default: gcs synchronizable: type: optional default: true presign: type: optional default: true - container: + bucket: type: optional - docs: Azure blob container + docs: GCS bucket name prefix: type: optional - docs: Azure blob prefix name + docs: GCS bucket prefix regex_filter: type: optional docs: Cloud storage regex for filtering objects use_blob_urls: type: optional docs: Interpret objects as BLOBs and generate URLs - account_name: + google_application_credentials: type: optional - docs: Azure Blob account name - account_key: + docs: The content of GOOGLE_APPLICATION_CREDENTIALS json file + google_project_id: type: optional - docs: Azure Blob account key + docs: Google project ID last_sync: type: optional docs: Last sync finished time last_sync_count: type: optional docs: Count of tasks synced last time + validation: + min: 0 + max: 2147483647 last_sync_job: type: optional docs: Last sync job ID validation: maxLength: 256 - status: optional + status: optional traceback: type: optional docs: Traceback report for the last failed sync - meta: - type: optional> - docs: Meta and debug information about storage processes + meta: optional title: type: optional docs: Cloud storage title @@ -900,71 +1609,72 @@ types: type: optional docs: Cloud storage description created_at: - type: optional + type: datetime docs: Creation time presign_ttl: type: optional docs: Presigned URLs TTL (in minutes) - project: + validation: + min: 0 + max: 32767 + glob_pattern: + type: optional + docs: Glob pattern for syncing from bucket + synced: + type: optional + docs: Flag if dataset has been previously synced or not + job_id: + type: optional + dataset: type: integer - docs: A unique integer value identifying this project. - source: - openapi: openapi/openapi.yaml - AzureBlobExportStorageStatus: - enum: - - initialized - - queued - - in_progress - - failed - - completed - inline: true + docs: A unique integer value identifying this dataset. source: openapi: openapi/openapi.yaml - AzureBlobExportStorage: + GcsDatasetStorageRequest: properties: - id: optional - type: - type: optional - default: azure synchronizable: type: optional default: true - container: + presign: + type: optional + default: true + bucket: type: optional - docs: Azure blob container + docs: GCS bucket name prefix: type: optional - docs: Azure blob prefix name + docs: GCS bucket prefix regex_filter: type: optional docs: Cloud storage regex for filtering objects use_blob_urls: type: optional docs: Interpret objects as BLOBs and generate URLs - account_name: + google_application_credentials: type: optional - docs: Azure Blob account name - account_key: + docs: The content of GOOGLE_APPLICATION_CREDENTIALS json file + google_project_id: type: optional - docs: Azure Blob account key + docs: Google project ID last_sync: type: optional docs: Last sync finished time last_sync_count: type: optional docs: Count of tasks synced last time + validation: + min: 0 + max: 2147483647 last_sync_job: type: optional docs: Last sync job ID validation: maxLength: 256 - status: optional + status: optional traceback: type: optional docs: Traceback report for the last failed sync - meta: - type: optional> - docs: Meta and debug information about storage processes + meta: optional title: type: optional docs: Cloud storage title @@ -973,32 +1683,28 @@ types: description: type: optional docs: Cloud storage description - created_at: - type: optional - docs: Creation time - can_delete_objects: + presign_ttl: + type: optional + docs: Presigned URLs TTL (in minutes) + validation: + min: 0 + max: 32767 + glob_pattern: + type: optional + docs: Glob pattern for syncing from bucket + synced: type: optional - docs: Deletion from storage enabled - project: + docs: Flag if dataset has been previously synced or not + dataset: type: integer - docs: A unique integer value identifying this project. - source: - openapi: openapi/openapi.yaml - GcsExportStorageStatus: - enum: - - initialized - - queued - - in_progress - - failed - - completed - inline: true + docs: A unique integer value identifying this dataset. source: openapi: openapi/openapi.yaml GcsExportStorage: properties: - id: optional + id: integer type: - type: optional + type: string default: gcs synchronizable: type: optional @@ -1027,18 +1733,19 @@ types: last_sync_count: type: optional docs: Count of tasks synced last time + validation: + min: 0 + max: 2147483647 last_sync_job: type: optional docs: Last sync job ID validation: maxLength: 256 - status: optional + status: optional traceback: type: optional docs: Traceback report for the last failed sync - meta: - type: optional> - docs: Meta and debug information about storage processes + meta: optional title: type: optional docs: Cloud storage title @@ -1048,7 +1755,7 @@ types: type: optional docs: Cloud storage description created_at: - type: optional + type: datetime docs: Creation time can_delete_objects: type: optional @@ -1058,52 +1765,55 @@ types: docs: A unique integer value identifying this project. source: openapi: openapi/openapi.yaml - LocalFilesExportStorageStatus: - enum: - - initialized - - queued - - in_progress - - failed - - completed - inline: true - source: - openapi: openapi/openapi.yaml - LocalFilesExportStorage: + GcsImportStorage: properties: - id: optional + id: integer type: - type: optional - default: localfiles - synchronizable: + type: string + default: gcs + synchronizable: type: optional default: true - path: + presign: + type: optional + default: true + bucket: type: optional - docs: Local path + docs: GCS bucket name + prefix: + type: optional + docs: GCS bucket prefix regex_filter: type: optional - docs: Regex for filtering objects + docs: Cloud storage regex for filtering objects use_blob_urls: type: optional docs: Interpret objects as BLOBs and generate URLs + google_application_credentials: + type: optional + docs: The content of GOOGLE_APPLICATION_CREDENTIALS json file + google_project_id: + type: optional + docs: Google project ID last_sync: type: optional docs: Last sync finished time last_sync_count: type: optional docs: Count of tasks synced last time + validation: + min: 0 + max: 2147483647 last_sync_job: type: optional docs: Last sync job ID validation: maxLength: 256 - status: optional + status: optional traceback: type: optional docs: Traceback report for the last failed sync - meta: - type: optional> - docs: Meta and debug information about storage processes + meta: optional title: type: optional docs: Cloud storage title @@ -1113,71 +1823,77 @@ types: type: optional docs: Cloud storage description created_at: - type: optional + type: datetime docs: Creation time - can_delete_objects: - type: optional - docs: Deletion from storage enabled + presign_ttl: + type: optional + docs: Presigned URLs TTL (in minutes) + validation: + min: 0 + max: 32767 project: type: integer docs: A unique integer value identifying this project. source: openapi: openapi/openapi.yaml - RedisExportStorageStatus: - enum: - - initialized - - queued - - in_progress - - failed - - completed - inline: true - source: - openapi: openapi/openapi.yaml - RedisExportStorage: + GcswifExportStorage: properties: - id: optional + id: integer type: - type: optional - default: redis + type: string + default: gcswif synchronizable: type: optional default: true - path: - type: optional - docs: Storage prefix (optional) - host: - type: optional - docs: Server Host IP (optional) - port: + bucket: type: optional - docs: Server Port (optional) - password: + docs: GCS bucket name + prefix: type: optional - docs: Server Password (optional) + docs: GCS bucket prefix regex_filter: type: optional docs: Cloud storage regex for filtering objects use_blob_urls: type: optional docs: Interpret objects as BLOBs and generate URLs + google_application_credentials: + type: optional + docs: The content of GOOGLE_APPLICATION_CREDENTIALS json file + google_project_id: + type: optional + docs: Google project ID + google_project_number: + type: optional + docs: Google project number + google_wif_pool_id: + type: optional + docs: Google WIF pool ID + google_wif_provider_id: + type: optional + docs: Google WIF provider ID + google_service_account_email: + type: optional + docs: Google service account email last_sync: type: optional docs: Last sync finished time last_sync_count: type: optional docs: Count of tasks synced last time + validation: + min: 0 + max: 2147483647 last_sync_job: type: optional docs: Last sync job ID validation: maxLength: 256 - status: optional + status: optional traceback: type: optional docs: Traceback report for the last failed sync - meta: - type: optional> - docs: Meta and debug information about storage processes + meta: optional title: type: optional docs: Cloud storage title @@ -1187,56 +1903,70 @@ types: type: optional docs: Cloud storage description created_at: - type: optional + type: datetime docs: Creation time can_delete_objects: type: optional docs: Deletion from storage enabled - db: - type: optional - docs: Server Database project: type: integer docs: A unique integer value identifying this project. source: openapi: openapi/openapi.yaml - S3ExportStorageStatus: - enum: - - initialized - - queued - - in_progress - - failed - - completed - inline: true - source: - openapi: openapi/openapi.yaml - S3ExportStorage: + GcswifExportStorageRequest: properties: - id: optional - type: - type: optional - default: s3 synchronizable: type: optional default: true + bucket: + type: optional + docs: GCS bucket name + prefix: + type: optional + docs: GCS bucket prefix + regex_filter: + type: optional + docs: Cloud storage regex for filtering objects + use_blob_urls: + type: optional + docs: Interpret objects as BLOBs and generate URLs + google_application_credentials: + type: optional + docs: The content of GOOGLE_APPLICATION_CREDENTIALS json file + google_project_id: + type: optional + docs: Google project ID + google_project_number: + type: optional + docs: Google project number + google_wif_pool_id: + type: optional + docs: Google WIF pool ID + google_wif_provider_id: + type: optional + docs: Google WIF provider ID + google_service_account_email: + type: optional + docs: Google service account email last_sync: type: optional docs: Last sync finished time last_sync_count: type: optional docs: Count of tasks synced last time + validation: + min: 0 + max: 2147483647 last_sync_job: type: optional docs: Last sync job ID validation: maxLength: 256 - status: optional + status: optional traceback: type: optional docs: Traceback report for the last failed sync - meta: - type: optional> - docs: Meta and debug information about storage processes + meta: optional title: type: optional docs: Cloud storage title @@ -1245,63 +1975,20 @@ types: description: type: optional docs: Cloud storage description - created_at: - type: optional - docs: Creation time can_delete_objects: type: optional docs: Deletion from storage enabled - bucket: - type: optional - docs: S3 bucket name - prefix: - type: optional - docs: S3 bucket prefix - regex_filter: - type: optional - docs: Cloud storage regex for filtering objects - use_blob_urls: - type: optional - docs: Interpret objects as BLOBs and generate URLs - aws_access_key_id: - type: optional - docs: AWS_ACCESS_KEY_ID - aws_secret_access_key: - type: optional - docs: AWS_SECRET_ACCESS_KEY - aws_session_token: - type: optional - docs: AWS_SESSION_TOKEN - aws_sse_kms_key_id: - type: optional - docs: AWS SSE KMS Key ID - region_name: - type: optional - docs: AWS Region - s3_endpoint: - type: optional - docs: S3 Endpoint project: type: integer docs: A unique integer value identifying this project. source: openapi: openapi/openapi.yaml - GcsImportStorageStatus: - enum: - - initialized - - queued - - in_progress - - failed - - completed - inline: true - source: - openapi: openapi/openapi.yaml - GcsImportStorage: + GcswifImportStorage: properties: - id: optional + id: integer type: - type: optional - default: gcs + type: string + default: gcswif synchronizable: type: optional default: true @@ -1326,24 +2013,37 @@ types: google_project_id: type: optional docs: Google project ID + google_project_number: + type: optional + docs: Google project number + google_wif_pool_id: + type: optional + docs: Google WIF pool ID + google_wif_provider_id: + type: optional + docs: Google WIF provider ID + google_service_account_email: + type: optional + docs: Google service account email last_sync: type: optional docs: Last sync finished time last_sync_count: type: optional docs: Count of tasks synced last time + validation: + min: 0 + max: 2147483647 last_sync_job: type: optional docs: Last sync job ID validation: maxLength: 256 - status: optional + status: optional traceback: type: optional docs: Traceback report for the last failed sync - meta: - type: optional> - docs: Meta and debug information about storage processes + meta: optional title: type: optional docs: Cloud storage title @@ -1353,62 +2053,76 @@ types: type: optional docs: Cloud storage description created_at: - type: optional + type: datetime docs: Creation time presign_ttl: type: optional docs: Presigned URLs TTL (in minutes) + validation: + min: 0 + max: 32767 project: type: integer docs: A unique integer value identifying this project. source: openapi: openapi/openapi.yaml - LocalFilesImportStorageStatus: - enum: - - initialized - - queued - - in_progress - - failed - - completed - inline: true - source: - openapi: openapi/openapi.yaml - LocalFilesImportStorage: + GcswifImportStorageRequest: properties: - id: optional - type: - type: optional - default: localfiles synchronizable: type: optional default: true - path: + presign: + type: optional + default: true + bucket: type: optional - docs: Local path + docs: GCS bucket name + prefix: + type: optional + docs: GCS bucket prefix regex_filter: type: optional - docs: Regex for filtering objects + docs: Cloud storage regex for filtering objects use_blob_urls: type: optional docs: Interpret objects as BLOBs and generate URLs + google_application_credentials: + type: optional + docs: The content of GOOGLE_APPLICATION_CREDENTIALS json file + google_project_id: + type: optional + docs: Google project ID + google_project_number: + type: optional + docs: Google project number + google_wif_pool_id: + type: optional + docs: Google WIF pool ID + google_wif_provider_id: + type: optional + docs: Google WIF provider ID + google_service_account_email: + type: optional + docs: Google service account email last_sync: type: optional docs: Last sync finished time last_sync_count: type: optional docs: Count of tasks synced last time + validation: + min: 0 + max: 2147483647 last_sync_job: type: optional docs: Last sync job ID validation: maxLength: 256 - status: optional + status: optional traceback: type: optional docs: Traceback report for the last failed sync - meta: - type: optional> - docs: Meta and debug information about storage processes + meta: optional title: type: optional docs: Cloud storage title @@ -1417,29 +2131,3402 @@ types: description: type: optional docs: Cloud storage description - created_at: - type: optional - docs: Creation time + presign_ttl: + type: optional + docs: Presigned URLs TTL (in minutes) + validation: + min: 0 + max: 32767 project: type: integer docs: A unique integer value identifying this project. source: openapi: openapi/openapi.yaml - RedisImportStorageStatus: - enum: - - initialized - - queued - - in_progress - - failed - - completed - inline: true + Hotkeys: + properties: + custom_hotkeys: map + source: + openapi: openapi/openapi.yaml + ImportApiRequest: + docs: Tasks serializer for Import API (TaskBulkCreateAPI) + properties: + annotations: optional> + predictions: optional> + data: unknown + meta: optional + overlap: + type: optional + docs: Number of distinct annotators that processed the current task + validation: + min: -2147483648 + max: 2147483647 + inner_id: + type: optional + docs: Internal task ID in the project, starts with 1 + total_annotations: + type: optional + docs: >- + Number of total annotations for the current task except cancelled + annotations + validation: + min: -2147483648 + max: 2147483647 + cancelled_annotations: + type: optional + docs: Number of total cancelled annotations for the current task + validation: + min: -2147483648 + max: 2147483647 + total_predictions: + type: optional + docs: Number of total predictions for the current task + validation: + min: -2147483648 + max: 2147483647 + comment_count: + type: optional + docs: Number of comments in the task including all annotations + validation: + min: -2147483648 + max: 2147483647 + unresolved_comment_count: + type: optional + docs: Number of unresolved comments in the task including all annotations + validation: + min: -2147483648 + max: 2147483647 + last_comment_updated_at: + type: optional + docs: When the last comment was updated + updated_by: + type: optional + docs: Last annotator or reviewer who updated this task + file_upload: + type: optional + docs: Uploaded file used as data source for this task + comment_authors: + type: optional> + docs: Users who wrote comments + source: + openapi: openapi/openapi.yaml + InferenceRunCostEstimate: + properties: + prompt_cost_usd: + type: optional + docs: Cost of the prompt (in USD) + completion_cost_usd: + type: optional + docs: Cost of the completion (in USD) + total_cost_usd: + type: optional + docs: Total cost of the inference (in USD) + is_error: + type: optional + docs: Whether an error occurred or not + error_type: + type: optional + docs: Type of error (e.g. "Timeout", "Rate Limit", etc) + error_message: + type: optional + docs: Error message details + source: + openapi: openapi/openapi.yaml + LseapiTokenCreate: + properties: + token: string + created_at: string + expires_at: string + source: + openapi: openapi/openapi.yaml + LseapiTokenList: + properties: + token: string + created_at: string + expires_at: string + source: + openapi: openapi/openapi.yaml + LsejwtSettings: + properties: + api_tokens_enabled: + type: optional + docs: Enable JWT API token authentication for this organization + legacy_api_tokens_enabled: + type: optional + docs: Enable legacy API token authentication for this organization + api_token_ttl_days: + type: optional + docs: Number of days before JWT API tokens expire + validation: + min: -2147483648 + max: 2147483647 + source: + openapi: openapi/openapi.yaml + LseKeyIndicatorValue: + docs: |- + Key indicator value for Label Studio Enterprise. + + Attributes: + title: The title for this metric, to be displayed to the user + values: Dictionary of key-value pairs for the indicator values + properties: + title: + type: string + docs: The title for this metric, to be displayed to the user + values: + type: map + docs: Dictionary of key-value pairs for the indicator values + source: + openapi: openapi/openapi.yaml + Label: + docs: |- + A ModelSerializer that takes additional arguments for + "fields", "omit" and "expand" in order to + control which fields are displayed, and whether to replace simple + values with complex, nested serializations + properties: + id: integer + links: list + created_at: + type: datetime + docs: Time of label creation + updated_at: + type: datetime + docs: Time of label modification + value: unknown + title: + type: string + docs: Label title + validation: + maxLength: 2048 + description: + type: optional + docs: Label description + approved: + type: optional + docs: Status of label + created_by: + type: integer + docs: User who made this label + approved_by: + type: optional + docs: User who approved this label + organization: integer + projects: list + source: + openapi: openapi/openapi.yaml + LabelCreate: + properties: + id: integer + created_by: integer + organization: integer + project: integer + from_name: string + created_at: + type: datetime + docs: Time of label creation + updated_at: + type: datetime + docs: Time of label modification + value: unknown + title: + type: string + docs: Label title + validation: + maxLength: 2048 + description: + type: optional + docs: Label description + approved: + type: optional + docs: Status of label + approved_by: + type: optional + docs: User who approved this label + projects: list + source: + openapi: openapi/openapi.yaml + LabelCreateRequest: + properties: + project: integer + from_name: + type: string + validation: + minLength: 1 + value: unknown + title: + type: string + docs: Label title + validation: + minLength: 1 + maxLength: 2048 + description: + type: optional + docs: Label description + approved: + type: optional + docs: Status of label + approved_by: + type: optional + docs: User who approved this label + source: + openapi: openapi/openapi.yaml + LabelLink: + docs: |- + A ModelSerializer that takes additional arguments for + "fields", "omit" and "expand" in order to + control which fields are displayed, and whether to replace simple + values with complex, nested serializations + properties: + id: integer + annotations_count: integer + from_name: + type: string + docs: Tag name + validation: + maxLength: 2048 + project: integer + label: integer + source: + openapi: openapi/openapi.yaml + LabelStreamTaskDistributionEnum: + enum: + - auto_distribution + - assigned_only + docs: >- + * `auto_distribution` - Label Stream distributes tasks automatically to + annotators + + * `assigned_only` - Label Stream shows tasks only to assigned users + source: + openapi: openapi/openapi.yaml + LastActionEnum: + enum: + - prediction + - propagated_annotation + - imported + - submitted + - updated + - skipped + - accepted + - rejected + - fixed_and_accepted + - deleted_review + docs: |- + * `prediction` - Created from prediction + * `propagated_annotation` - Created from another annotation + * `imported` - Imported + * `submitted` - Submitted + * `updated` - Updated + * `skipped` - Skipped + * `accepted` - Accepted + * `rejected` - Rejected + * `fixed_and_accepted` - Fixed and accepted + * `deleted_review` - Deleted review + source: + openapi: openapi/openapi.yaml + LocalFilesExportStorage: + properties: + id: integer + type: + type: string + default: localfiles + synchronizable: + type: optional + default: true + path: + type: optional + docs: Local path + regex_filter: + type: optional + docs: Regex for filtering objects + use_blob_urls: + type: optional + docs: Interpret objects as BLOBs and generate URLs + last_sync: + type: optional + docs: Last sync finished time + last_sync_count: + type: optional + docs: Count of tasks synced last time + validation: + min: 0 + max: 2147483647 + last_sync_job: + type: optional + docs: Last sync job ID + validation: + maxLength: 256 + status: optional + traceback: + type: optional + docs: Traceback report for the last failed sync + meta: optional + title: + type: optional + docs: Cloud storage title + validation: + maxLength: 256 + description: + type: optional + docs: Cloud storage description + created_at: + type: datetime + docs: Creation time + can_delete_objects: + type: optional + docs: Deletion from storage enabled + project: + type: integer + docs: A unique integer value identifying this project. + source: + openapi: openapi/openapi.yaml + LocalFilesImportStorage: + properties: + id: integer + type: + type: string + default: localfiles + synchronizable: + type: optional + default: true + path: + type: optional + docs: Local path + regex_filter: + type: optional + docs: Regex for filtering objects + use_blob_urls: + type: optional + docs: Interpret objects as BLOBs and generate URLs + last_sync: + type: optional + docs: Last sync finished time + last_sync_count: + type: optional + docs: Count of tasks synced last time + validation: + min: 0 + max: 2147483647 + last_sync_job: + type: optional + docs: Last sync job ID + validation: + maxLength: 256 + status: optional + traceback: + type: optional + docs: Traceback report for the last failed sync + meta: optional + title: + type: optional + docs: Cloud storage title + validation: + maxLength: 256 + description: + type: optional + docs: Cloud storage description + created_at: + type: datetime + docs: Creation time + project: + type: integer + docs: A unique integer value identifying this project. + source: + openapi: openapi/openapi.yaml + LseAnnotationFilterOptionsReviewed: + discriminated: false + docs: >- + `only` - include all tasks with at least one not reviewed + annotation
`exclude` - exclude with at least one not reviewed + annotation + + + * `only` - only + + * `exclude` - exclude + + * `None` - None + union: + - ReviewedEnum + - NullEnum + source: + openapi: openapi/openapi.yaml + inline: true + LseAnnotationFilterOptions: + properties: + usual: + type: optional + docs: Include not skipped and not ground truth annotations + default: true + ground_truth: + type: optional + docs: Include ground truth annotations + skipped: + type: optional + docs: Include skipped annotations + reviewed: + type: optional + docs: >- + `only` - include all tasks with at least one not reviewed + annotation
`exclude` - exclude with at least one not reviewed + annotation + + + * `only` - only + + * `exclude` - exclude + + * `None` - None + source: + openapi: openapi/openapi.yaml + LseAnnotationFilterOptionsRequestReviewed: + discriminated: false + docs: >- + `only` - include all tasks with at least one not reviewed + annotation
`exclude` - exclude with at least one not reviewed + annotation + + + * `only` - only + + * `exclude` - exclude + + * `None` - None + union: + - ReviewedEnum + - NullEnum + source: + openapi: openapi/openapi.yaml + inline: true + LseAnnotationFilterOptionsRequest: + properties: + usual: + type: optional + docs: Include not skipped and not ground truth annotations + default: true + ground_truth: + type: optional + docs: Include ground truth annotations + skipped: + type: optional + docs: Include skipped annotations + reviewed: + type: optional + docs: >- + `only` - include all tasks with at least one not reviewed + annotation
`exclude` - exclude with at least one not reviewed + annotation + + + * `only` - only + + * `exclude` - exclude + + * `None` - None + source: + openapi: openapi/openapi.yaml + LseExportCreate: + properties: + title: + type: optional + validation: + maxLength: 2048 + id: integer + created_by: optional + created_at: + type: datetime + docs: Creation time + finished_at: + type: optional + docs: Complete or fail time + status: optional + md5: + type: optional + validation: + maxLength: 128 + counters: optional + converted_formats: optional> + task_filter_options: optional + annotation_filter_options: optional + serialization_options: optional + source: + openapi: openapi/openapi.yaml + LseFieldsTrialRole: + discriminated: false + union: + - TrialRoleEnum + - BlankEnum + - NullEnum + source: + openapi: openapi/openapi.yaml + inline: true + LseFieldsOnboardingState: + discriminated: false + docs: |- + The current stage of user onboarding + + * `not_started` - Not Started + * `signup` - Signup + * `trial_signup` - Trial Signup + * `first_tutorial` - First Tutorial + * `in_app_guidance` - In App Guidance + * `complete` - Complete + union: + - OnboardingStateEnum + - BlankEnum + - NullEnum + source: + openapi: openapi/openapi.yaml + inline: true + LseFields: + properties: + invite_expired: string + invite_expired_at: string + invited_at: optional + invite_activated: optional + trial_company: + type: optional + validation: + maxLength: 1000 + trial_role: optional + trial_models_in_production: + type: optional + validation: + maxLength: 1000 + trial_experience_labeling: + type: optional + validation: + maxLength: 1000 + trial_license_enterprise: optional + social_auth_finished: + type: optional + docs: Is user finished social authentication + invited_by: optional + onboarding_state: + type: optional + docs: |- + The current stage of user onboarding + + * `not_started` - Not Started + * `signup` - Signup + * `trial_signup` - Trial Signup + * `first_tutorial` - First Tutorial + * `in_app_guidance` - In App Guidance + * `complete` - Complete + email_notification_settings: string + source: + openapi: openapi/openapi.yaml + LseFieldsRequestTrialRole: + discriminated: false + union: + - TrialRoleEnum + - BlankEnum + - NullEnum + source: + openapi: openapi/openapi.yaml + inline: true + LseFieldsRequestOnboardingState: + discriminated: false + docs: |- + The current stage of user onboarding + + * `not_started` - Not Started + * `signup` - Signup + * `trial_signup` - Trial Signup + * `first_tutorial` - First Tutorial + * `in_app_guidance` - In App Guidance + * `complete` - Complete + union: + - OnboardingStateEnum + - BlankEnum + - NullEnum + source: + openapi: openapi/openapi.yaml + inline: true + LseFieldsRequest: + properties: + invited_at: optional + invite_activated: optional + trial_company: + type: optional + validation: + maxLength: 1000 + trial_role: optional + trial_models_in_production: + type: optional + validation: + maxLength: 1000 + trial_experience_labeling: + type: optional + validation: + maxLength: 1000 + trial_license_enterprise: optional + social_auth_finished: + type: optional + docs: Is user finished social authentication + invited_by: optional + onboarding_state: + type: optional + docs: |- + The current stage of user onboarding + + * `not_started` - Not Started + * `signup` - Signup + * `trial_signup` - Trial Signup + * `first_tutorial` - First Tutorial + * `in_app_guidance` - In App Guidance + * `complete` - Complete + source: + openapi: openapi/openapi.yaml + LseOrganizationCustomScriptsEditableBy: + discriminated: false + docs: |- + Set the minimum user role that can edit custom scripts in the UI. + + * `AD` - Administrator + * `MA` - Manager + union: + - CustomScriptsEditableByEnum + - NullEnum + source: + openapi: openapi/openapi.yaml + inline: true + LseOrganization: + properties: + id: integer + external_id: + type: optional + docs: External ID to uniquely identify this organization + title: string + token: string + default_role: + type: optional + docs: |- + Default membership role for invited users + + * `OW` - Owner + * `AD` - Administrator + * `MA` - Manager + * `RE` - Reviewer + * `AN` - Annotator + * `DI` - Deactivated + * `NO` - Not Activated + created_at: datetime + billing: OrganizationBilling + embed_domains: optional + embed_settings: optional + custom_scripts_enabled: string + custom_scripts_editable_by: + type: optional + docs: |- + Set the minimum user role that can edit custom scripts in the UI. + + * `AD` - Administrator + * `MA` - Manager + source: + openapi: openapi/openapi.yaml + LseOrganizationMemberList: + docs: >- + A serializer mixin that takes an additional `fields` argument that + controls + + which fields should be displayed. + properties: + id: integer + organization: + type: integer + docs: Organization ID + user: LseUserOrganizationMemberList + role: string + source: + openapi: openapi/openapi.yaml + LseProjectSampling: + discriminated: false + union: + - SamplingEnum + - NullEnum + source: + openapi: openapi/openapi.yaml + inline: true + LseProjectSkipQueue: + discriminated: false + union: + - SkipQueueEnum + - NullEnum + source: + openapi: openapi/openapi.yaml + inline: true + LseProject: + docs: |- + Serializer get numbers from project queryset annotation, + make sure, that you use correct one(Project.objects.with_counts()) + properties: + id: integer + title: + type: optional + docs: Project name. Must be between 3 and 50 characters long. + validation: + minLength: 3 + maxLength: 50 + description: + type: optional + docs: Project description + label_config: + type: optional + docs: Label config in XML format. See more about it in documentation + expert_instruction: + type: optional + docs: Labeling instructions in HTML format + show_instruction: + type: optional + docs: Show instructions to the annotator before they start + show_skip_button: + type: optional + docs: Show a skip button in interface and allow annotators to skip the task + enable_empty_annotation: + type: optional + docs: Allow annotators to submit empty annotations + show_annotation_history: + type: optional + docs: Show annotation history to annotator + organization: optional + color: + type: optional + validation: + maxLength: 16 + maximum_annotations: + type: optional + docs: >- + Maximum number of annotations for one task. If the number of + annotations per task is equal or greater to this value, the task is + completed (is_labeled=True) + validation: + min: -2147483648 + max: 2147483647 + is_published: + type: optional + docs: Whether or not the project is published to annotators + model_version: + type: optional + docs: Machine learning model version + is_draft: + type: optional + docs: Whether or not the project is in the middle of being created + created_by: + type: optional + docs: Project owner + created_at: datetime + min_annotations_to_start_training: + type: optional + docs: >- + Minimum number of completed tasks after which model training is + started + validation: + min: -2147483648 + max: 2147483647 + start_training_on_annotation_update: + type: boolean + docs: Start model training after any annotations are submitted or updated + show_collab_predictions: + type: optional + docs: If set, the annotator can view model predictions + num_tasks_with_annotations: + type: integer + docs: Tasks with annotations count + task_number: + type: integer + docs: Total task number in project + useful_annotation_number: + type: integer + docs: >- + Useful annotation number in project not including + skipped_annotations_number and ground_truth_number. Total annotations + = annotation_number + skipped_annotations_number + ground_truth_number + ground_truth_number: + type: integer + docs: Honeypot annotation number in project + skipped_annotations_number: + type: integer + docs: Skipped by collaborators annotation number in project + total_annotations_number: + type: integer + docs: >- + Total annotations number in project including + skipped_annotations_number and ground_truth_number. + total_predictions_number: + type: integer + docs: >- + Total predictions number in project including + skipped_annotations_number, ground_truth_number, and + useful_annotation_number. + sampling: optional + show_ground_truth_first: optional + show_overlap_first: optional + overlap_cohort_percentage: + type: optional + validation: + min: -2147483648 + max: 2147483647 + task_data_login: + type: optional + docs: 'Task data credentials: login' + validation: + maxLength: 256 + task_data_password: + type: optional + docs: 'Task data credentials: password' + validation: + maxLength: 256 + control_weights: optional + parsed_label_config: unknown + evaluate_predictions_automatically: + type: optional + docs: Retrieve and display predictions when loading a task + config_has_control_tags: + type: boolean + docs: Flag to detect is project ready for labeling + skip_queue: optional + reveal_preannotations_interactively: + type: optional + docs: Reveal pre-annotations interactively + pinned_at: + type: optional + docs: Pinned date and time + finished_task_number: + type: integer + docs: Finished tasks + queue_total: string + queue_done: string + config_suitable_for_bulk_annotation: + type: boolean + docs: Flag to detect is project ready for bulk annotation + workspace: string + review_settings: ReviewSettings + assignment_settings: AssignmentSettings + members: string + custom_script: optional + comment_classification_config: optional + duplication_done: + type: optional + default: false + duplication_status: optional + require_comment_on_skip: + type: optional + default: false + data_types: unknown + reviewer_queue_total: string + queue_left: string + members_count: string + custom_task_lock_ttl: + type: optional + docs: TTL in seconds for task reservations, on new and existing tasks + validation: + min: 1 + max: 86400 + prompts: string + annotation_limit_count: + type: optional + validation: + min: 1 + annotation_limit_percent: + type: optional + validation: + pattern: ^-?\d{0,3}(?:\.\d{0,2})?$ + pause_on_failed_annotator_evaluation: + type: optional + default: false + annotator_evaluation_minimum_score: + type: optional + default: '95.00' + validation: + pattern: ^-?\d{0,3}(?:\.\d{0,2})?$ + annotator_evaluation_minimum_tasks: + type: optional + default: 10 + validation: + min: 0 + workspace_title: string + source: + openapi: openapi/openapi.yaml + LseProjectCounts: + docs: |- + Serializer get numbers from project queryset annotation, + make sure, that you use correct one(Project.objects.with_counts()) + properties: + id: integer + task_number: + type: integer + docs: Total task number in project + finished_task_number: integer + total_predictions_number: integer + total_annotations_number: string + num_tasks_with_annotations: string + useful_annotation_number: string + ground_truth_number: + type: integer + docs: Honeypot annotation number in project + skipped_annotations_number: string + rejected: string + queue_total: string + queue_done: string + queue_left: string + reviewed_number: string + review_total_tasks: string + source: + openapi: openapi/openapi.yaml + LseProjectCreateSampling: + discriminated: false + union: + - SamplingEnum + - NullEnum + source: + openapi: openapi/openapi.yaml + inline: true + LseProjectCreateSkipQueue: + discriminated: false + union: + - SkipQueueEnum + - NullEnum + source: + openapi: openapi/openapi.yaml + inline: true + LseProjectCreate: + docs: |- + Serializer get numbers from project queryset annotation, + make sure, that you use correct one(Project.objects.with_counts()) + properties: + id: integer + title: + type: optional + docs: Project name. Must be between 3 and 50 characters long. + validation: + minLength: 3 + maxLength: 50 + description: + type: optional + docs: Project description + label_config: + type: optional + docs: Label config in XML format. See more about it in documentation + expert_instruction: + type: optional + docs: Labeling instructions in HTML format + show_instruction: + type: optional + docs: Show instructions to the annotator before they start + show_skip_button: + type: optional + docs: Show a skip button in interface and allow annotators to skip the task + enable_empty_annotation: + type: optional + docs: Allow annotators to submit empty annotations + show_annotation_history: + type: optional + docs: Show annotation history to annotator + organization: optional + color: + type: optional + validation: + maxLength: 16 + maximum_annotations: + type: optional + docs: >- + Maximum number of annotations for one task. If the number of + annotations per task is equal or greater to this value, the task is + completed (is_labeled=True) + validation: + min: -2147483648 + max: 2147483647 + is_published: + type: optional + docs: Whether or not the project is published to annotators + model_version: + type: optional + docs: Machine learning model version + is_draft: + type: optional + docs: Whether or not the project is in the middle of being created + created_by: + type: optional + docs: Project owner + created_at: datetime + min_annotations_to_start_training: + type: optional + docs: >- + Minimum number of completed tasks after which model training is + started + validation: + min: -2147483648 + max: 2147483647 + start_training_on_annotation_update: + type: boolean + docs: Start model training after any annotations are submitted or updated + show_collab_predictions: + type: optional + docs: If set, the annotator can view model predictions + num_tasks_with_annotations: + type: integer + docs: Tasks with annotations count + task_number: + type: integer + docs: Total task number in project + useful_annotation_number: + type: integer + docs: >- + Useful annotation number in project not including + skipped_annotations_number and ground_truth_number. Total annotations + = annotation_number + skipped_annotations_number + ground_truth_number + ground_truth_number: + type: integer + docs: Honeypot annotation number in project + skipped_annotations_number: + type: integer + docs: Skipped by collaborators annotation number in project + total_annotations_number: + type: integer + docs: >- + Total annotations number in project including + skipped_annotations_number and ground_truth_number. + total_predictions_number: + type: integer + docs: >- + Total predictions number in project including + skipped_annotations_number, ground_truth_number, and + useful_annotation_number. + sampling: optional + show_ground_truth_first: optional + show_overlap_first: optional + overlap_cohort_percentage: + type: optional + validation: + min: -2147483648 + max: 2147483647 + task_data_login: + type: optional + docs: 'Task data credentials: login' + validation: + maxLength: 256 + task_data_password: + type: optional + docs: 'Task data credentials: password' + validation: + maxLength: 256 + control_weights: optional + parsed_label_config: unknown + evaluate_predictions_automatically: + type: optional + docs: Retrieve and display predictions when loading a task + config_has_control_tags: + type: boolean + docs: Flag to detect is project ready for labeling + skip_queue: optional + reveal_preannotations_interactively: + type: optional + docs: Reveal pre-annotations interactively + pinned_at: + type: optional + docs: Pinned date and time + finished_task_number: + type: integer + docs: Finished tasks + queue_total: integer + queue_done: integer + config_suitable_for_bulk_annotation: + type: boolean + docs: Flag to detect is project ready for bulk annotation + workspace: optional + source: + openapi: openapi/openapi.yaml + LseProjectUpdateSampling: + discriminated: false + union: + - SamplingEnum + - NullEnum + source: + openapi: openapi/openapi.yaml + inline: true + LseProjectUpdateSkipQueue: + discriminated: false + union: + - SkipQueueEnum + - NullEnum + source: + openapi: openapi/openapi.yaml + inline: true + LseProjectUpdate: + docs: |- + Serializer get numbers from project queryset annotation, + make sure, that you use correct one(Project.objects.with_counts()) + properties: + id: integer + title: + type: optional + docs: Project name. Must be between 3 and 50 characters long. + validation: + minLength: 3 + maxLength: 50 + description: + type: optional + docs: Project description + label_config: + type: optional + docs: Label config in XML format. See more about it in documentation + expert_instruction: + type: optional + docs: Labeling instructions in HTML format + show_instruction: + type: optional + docs: Show instructions to the annotator before they start + show_skip_button: + type: optional + docs: Show a skip button in interface and allow annotators to skip the task + enable_empty_annotation: + type: optional + docs: Allow annotators to submit empty annotations + show_annotation_history: + type: optional + docs: Show annotation history to annotator + organization: optional + color: + type: optional + validation: + maxLength: 16 + maximum_annotations: + type: optional + docs: >- + Maximum number of annotations for one task. If the number of + annotations per task is equal or greater to this value, the task is + completed (is_labeled=True) + validation: + min: -2147483648 + max: 2147483647 + is_published: + type: optional + docs: Whether or not the project is published to annotators + model_version: + type: optional + docs: Machine learning model version + is_draft: + type: optional + docs: Whether or not the project is in the middle of being created + created_by: + type: optional + docs: Project owner + created_at: datetime + min_annotations_to_start_training: + type: optional + docs: >- + Minimum number of completed tasks after which model training is + started + validation: + min: -2147483648 + max: 2147483647 + start_training_on_annotation_update: + type: boolean + docs: Start model training after any annotations are submitted or updated + show_collab_predictions: + type: optional + docs: If set, the annotator can view model predictions + num_tasks_with_annotations: + type: integer + docs: Tasks with annotations count + task_number: + type: integer + docs: Total task number in project + useful_annotation_number: + type: integer + docs: >- + Useful annotation number in project not including + skipped_annotations_number and ground_truth_number. Total annotations + = annotation_number + skipped_annotations_number + ground_truth_number + ground_truth_number: + type: integer + docs: Honeypot annotation number in project + skipped_annotations_number: + type: integer + docs: Skipped by collaborators annotation number in project + total_annotations_number: + type: integer + docs: >- + Total annotations number in project including + skipped_annotations_number and ground_truth_number. + total_predictions_number: + type: integer + docs: >- + Total predictions number in project including + skipped_annotations_number, ground_truth_number, and + useful_annotation_number. + sampling: optional + show_ground_truth_first: optional + show_overlap_first: optional + overlap_cohort_percentage: + type: optional + validation: + min: -2147483648 + max: 2147483647 + task_data_login: + type: optional + docs: 'Task data credentials: login' + validation: + maxLength: 256 + task_data_password: + type: optional + docs: 'Task data credentials: password' + validation: + maxLength: 256 + control_weights: optional + parsed_label_config: unknown + evaluate_predictions_automatically: + type: optional + docs: Retrieve and display predictions when loading a task + config_has_control_tags: + type: boolean + docs: Flag to detect is project ready for labeling + skip_queue: optional + reveal_preannotations_interactively: + type: optional + docs: Reveal pre-annotations interactively + pinned_at: + type: optional + docs: Pinned date and time + finished_task_number: + type: integer + docs: Finished tasks + queue_total: integer + queue_done: integer + config_suitable_for_bulk_annotation: + type: boolean + docs: Flag to detect is project ready for bulk annotation + workspace: integer + review_settings: ReviewSettings + assignment_settings: AssignmentSettings + custom_script: optional + comment_classification_config: optional + require_comment_on_skip: + type: optional + default: false + custom_task_lock_ttl: + type: optional + docs: TTL in seconds for task reservations, on new and existing tasks + validation: + min: 1 + max: 86400 + prompts: string + annotation_limit_count: + type: optional + validation: + min: 1 + annotation_limit_percent: + type: optional + validation: + pattern: ^-?\d{0,3}(?:\.\d{0,2})?$ + pause_on_failed_annotator_evaluation: + type: optional + default: false + annotator_evaluation_minimum_score: + type: optional + default: '95.00' + validation: + pattern: ^-?\d{0,3}(?:\.\d{0,2})?$ + annotator_evaluation_minimum_tasks: + type: optional + default: 10 + validation: + min: 0 + workspace_title: string + source: + openapi: openapi/openapi.yaml + LseS3ExportStorage: + properties: + id: integer + type: + type: string + default: s3s + synchronizable: + type: optional + default: true + last_sync: + type: optional + docs: Last sync finished time + last_sync_count: + type: optional + docs: Count of tasks synced last time + validation: + min: 0 + max: 2147483647 + last_sync_job: + type: optional + docs: Last sync job ID + validation: + maxLength: 256 + status: optional + traceback: + type: optional + docs: Traceback report for the last failed sync + meta: optional + title: + type: optional + docs: Cloud storage title + validation: + maxLength: 256 + description: + type: optional + docs: Cloud storage description + created_at: + type: datetime + docs: Creation time + can_delete_objects: + type: optional + docs: Deletion from storage enabled + bucket: + type: optional + docs: S3 bucket name + prefix: + type: optional + docs: S3 bucket prefix + regex_filter: + type: optional + docs: Cloud storage regex for filtering objects + use_blob_urls: + type: optional + docs: Interpret objects as BLOBs and generate URLs + aws_access_key_id: + type: optional + docs: AWS_ACCESS_KEY_ID + aws_secret_access_key: + type: optional + docs: AWS_SECRET_ACCESS_KEY + aws_session_token: + type: optional + docs: AWS_SESSION_TOKEN + aws_sse_kms_key_id: + type: optional + docs: AWS SSE KMS Key ID + region_name: + type: optional + docs: AWS Region + s3_endpoint: + type: optional + docs: S3 Endpoint + external_id: + type: optional + docs: AWS ExternalId + role_arn: + type: string + docs: AWS RoleArn + legacy_auth: optional + project: + type: integer + docs: A unique integer value identifying this project. + source: + openapi: openapi/openapi.yaml + LseS3ExportStorageRequest: + properties: + synchronizable: + type: optional + default: true + last_sync: + type: optional + docs: Last sync finished time + last_sync_count: + type: optional + docs: Count of tasks synced last time + validation: + min: 0 + max: 2147483647 + last_sync_job: + type: optional + docs: Last sync job ID + validation: + maxLength: 256 + status: optional + traceback: + type: optional + docs: Traceback report for the last failed sync + meta: optional + title: + type: optional + docs: Cloud storage title + validation: + maxLength: 256 + description: + type: optional + docs: Cloud storage description + can_delete_objects: + type: optional + docs: Deletion from storage enabled + bucket: + type: optional + docs: S3 bucket name + prefix: + type: optional + docs: S3 bucket prefix + regex_filter: + type: optional + docs: Cloud storage regex for filtering objects + use_blob_urls: + type: optional + docs: Interpret objects as BLOBs and generate URLs + aws_access_key_id: + type: optional + docs: AWS_ACCESS_KEY_ID + aws_secret_access_key: + type: optional + docs: AWS_SECRET_ACCESS_KEY + aws_session_token: + type: optional + docs: AWS_SESSION_TOKEN + aws_sse_kms_key_id: + type: optional + docs: AWS SSE KMS Key ID + region_name: + type: optional + docs: AWS Region + s3_endpoint: + type: optional + docs: S3 Endpoint + external_id: + type: optional + docs: AWS ExternalId + role_arn: + type: string + docs: AWS RoleArn + validation: + minLength: 1 + legacy_auth: optional + project: + type: integer + docs: A unique integer value identifying this project. + source: + openapi: openapi/openapi.yaml + LseS3ImportStorage: + properties: + id: integer + type: + type: string + default: s3s + synchronizable: + type: optional + default: true + presign: + type: optional + default: true + last_sync: + type: optional + docs: Last sync finished time + last_sync_count: + type: optional + docs: Count of tasks synced last time + validation: + min: 0 + max: 2147483647 + last_sync_job: + type: optional + docs: Last sync job ID + validation: + maxLength: 256 + status: optional + traceback: + type: optional + docs: Traceback report for the last failed sync + meta: optional + title: + type: optional + docs: Cloud storage title + validation: + maxLength: 256 + description: + type: optional + docs: Cloud storage description + created_at: + type: datetime + docs: Creation time + bucket: + type: optional + docs: S3 bucket name + prefix: + type: optional + docs: S3 bucket prefix + regex_filter: + type: optional + docs: Cloud storage regex for filtering objects + use_blob_urls: + type: optional + docs: Interpret objects as BLOBs and generate URLs + aws_access_key_id: + type: optional + docs: AWS_ACCESS_KEY_ID + aws_secret_access_key: + type: optional + docs: AWS_SECRET_ACCESS_KEY + aws_session_token: + type: optional + docs: AWS_SESSION_TOKEN + aws_sse_kms_key_id: + type: optional + docs: AWS SSE KMS Key ID + region_name: + type: optional + docs: AWS Region + s3_endpoint: + type: optional + docs: S3 Endpoint + external_id: + type: optional + docs: AWS ExternalId + role_arn: + type: string + docs: AWS RoleArn + legacy_auth: optional + presign_ttl: + type: optional + docs: Presigned URLs TTL (in minutes) + validation: + min: 0 + max: 32767 + recursive_scan: + type: optional + docs: Perform recursive scan over the bucket content + project: + type: integer + docs: A unique integer value identifying this project. + source: + openapi: openapi/openapi.yaml + LseS3ImportStorageRequest: + properties: + synchronizable: + type: optional + default: true + presign: + type: optional + default: true + last_sync: + type: optional + docs: Last sync finished time + last_sync_count: + type: optional + docs: Count of tasks synced last time + validation: + min: 0 + max: 2147483647 + last_sync_job: + type: optional + docs: Last sync job ID + validation: + maxLength: 256 + status: optional + traceback: + type: optional + docs: Traceback report for the last failed sync + meta: optional + title: + type: optional + docs: Cloud storage title + validation: + maxLength: 256 + description: + type: optional + docs: Cloud storage description + bucket: + type: optional + docs: S3 bucket name + prefix: + type: optional + docs: S3 bucket prefix + regex_filter: + type: optional + docs: Cloud storage regex for filtering objects + use_blob_urls: + type: optional + docs: Interpret objects as BLOBs and generate URLs + aws_access_key_id: + type: optional + docs: AWS_ACCESS_KEY_ID + aws_secret_access_key: + type: optional + docs: AWS_SECRET_ACCESS_KEY + aws_session_token: + type: optional + docs: AWS_SESSION_TOKEN + aws_sse_kms_key_id: + type: optional + docs: AWS SSE KMS Key ID + region_name: + type: optional + docs: AWS Region + s3_endpoint: + type: optional + docs: S3 Endpoint + external_id: + type: optional + docs: AWS ExternalId + role_arn: + type: string + docs: AWS RoleArn + validation: + minLength: 1 + legacy_auth: optional + presign_ttl: + type: optional + docs: Presigned URLs TTL (in minutes) + validation: + min: 0 + max: 32767 + recursive_scan: + type: optional + docs: Perform recursive scan over the bucket content + project: + type: integer + docs: A unique integer value identifying this project. + source: + openapi: openapi/openapi.yaml + LseTaskPredictionsItem: + properties: + result: + type: optional>> + score: + type: optional + model_version: + type: optional + model: + type: optional> + model_run: + type: optional> + task: + type: optional + project: + type: optional + created_at: + type: optional + updated_at: + type: optional + source: + openapi: openapi/openapi.yaml + inline: true + LseTaskDraftsItem: + properties: + result: + type: optional>> + created_at: + type: optional + updated_at: + type: optional + source: + openapi: openapi/openapi.yaml + inline: true + LseTask: + docs: Task Serializer with project scheme configs validation + properties: + id: integer + agreement: string + predictions: + docs: Predictions for this task + type: list + annotations: string + drafts: + docs: Drafts for this task + type: list + annotators: + docs: Annotators IDs who annotated this task + type: list + inner_id: optional + cancelled_annotations: optional + total_annotations: optional + total_predictions: optional + completed_at: optional + annotations_results: string + predictions_results: string + predictions_score: optional + file_upload: string + storage_filename: string + annotations_ids: string + predictions_model_versions: string + avg_lead_time: optional + draft_exists: optional + updated_by: + docs: User IDs who updated this task + type: list> + reviewers: string + comments: string + comment_authors: string + reviewed: optional + reviews_accepted: optional + reviews_rejected: optional + ground_truth: optional + data: unknown + meta: optional + created_at: + type: datetime + docs: Time a task was created + updated_at: + type: datetime + docs: Last time a task was updated + is_labeled: + type: optional + docs: >- + True if the number of annotations for this task is greater than or + equal to the number of maximum_completions for the project + overlap: + type: optional + docs: Number of distinct annotators that processed the current task + validation: + min: -2147483648 + max: 2147483647 + comment_count: + type: optional + docs: Number of comments in the task including all annotations + validation: + min: -2147483648 + max: 2147483647 + unresolved_comment_count: + type: optional + docs: Number of unresolved comments in the task including all annotations + validation: + min: -2147483648 + max: 2147483647 + last_comment_updated_at: + type: optional + docs: When the last comment was updated + project: + type: optional + docs: Project ID for this task + source: + openapi: openapi/openapi.yaml + LseTaskFilterOptionsSkipped: + discriminated: false + docs: >- + `only` - include all tasks with skipped annotations
`exclude` - exclude + all tasks with skipped annotations + + + * `only` - only + + * `exclude` - exclude + + * `None` - None + union: + - SkippedEnum + - NullEnum + source: + openapi: openapi/openapi.yaml + inline: true + LseTaskFilterOptionsFinished: + discriminated: false + docs: >- + `only` - include all finished tasks (is_labeled = true)
`exclude` - + exclude all finished tasks + + + * `only` - only + + * `exclude` - exclude + + * `None` - None + union: + - FinishedEnum + - NullEnum + source: + openapi: openapi/openapi.yaml + inline: true + LseTaskFilterOptionsAnnotated: + discriminated: false + docs: >- + `only` - include all tasks with at least one not skipped + annotation
`exclude` - exclude all tasks with at least one not skipped + annotation + + + * `only` - only + + * `exclude` - exclude + + * `None` - None + union: + - AnnotatedEnum + - NullEnum + source: + openapi: openapi/openapi.yaml + inline: true + LseTaskFilterOptionsReviewed: + discriminated: false + docs: >- + `only` - include all reviewed tasks
`exclude` - exclude all reviewed + tasks + + + * `only` - only + + * `exclude` - exclude + + * `None` - None + union: + - ReviewedEnum + - NullEnum + source: + openapi: openapi/openapi.yaml + inline: true + LseTaskFilterOptions: + properties: + view: + type: optional + docs: Apply filters from the view ID (a tab from the Data Manager) + skipped: + type: optional + docs: >- + `only` - include all tasks with skipped annotations
`exclude` - + exclude all tasks with skipped annotations + + + * `only` - only + + * `exclude` - exclude + + * `None` - None + finished: + type: optional + docs: >- + `only` - include all finished tasks (is_labeled = true)
`exclude` - + exclude all finished tasks + + + * `only` - only + + * `exclude` - exclude + + * `None` - None + annotated: + type: optional + docs: >- + `only` - include all tasks with at least one not skipped + annotation
`exclude` - exclude all tasks with at least one not + skipped annotation + + + * `only` - only + + * `exclude` - exclude + + * `None` - None + only_with_annotations: + type: optional + default: false + reviewed: + type: optional + docs: >- + `only` - include all reviewed tasks
`exclude` - exclude all + reviewed tasks + + + * `only` - only + + * `exclude` - exclude + + * `None` - None + source: + openapi: openapi/openapi.yaml + LseTaskFilterOptionsRequestSkipped: + discriminated: false + docs: >- + `only` - include all tasks with skipped annotations
`exclude` - exclude + all tasks with skipped annotations + + + * `only` - only + + * `exclude` - exclude + + * `None` - None + union: + - SkippedEnum + - NullEnum + source: + openapi: openapi/openapi.yaml + inline: true + LseTaskFilterOptionsRequestFinished: + discriminated: false + docs: >- + `only` - include all finished tasks (is_labeled = true)
`exclude` - + exclude all finished tasks + + + * `only` - only + + * `exclude` - exclude + + * `None` - None + union: + - FinishedEnum + - NullEnum + source: + openapi: openapi/openapi.yaml + inline: true + LseTaskFilterOptionsRequestAnnotated: + discriminated: false + docs: >- + `only` - include all tasks with at least one not skipped + annotation
`exclude` - exclude all tasks with at least one not skipped + annotation + + + * `only` - only + + * `exclude` - exclude + + * `None` - None + union: + - AnnotatedEnum + - NullEnum + source: + openapi: openapi/openapi.yaml + inline: true + LseTaskFilterOptionsRequestReviewed: + discriminated: false + docs: >- + `only` - include all reviewed tasks
`exclude` - exclude all reviewed + tasks + + + * `only` - only + + * `exclude` - exclude + + * `None` - None + union: + - ReviewedEnum + - NullEnum + source: + openapi: openapi/openapi.yaml + inline: true + LseTaskFilterOptionsRequest: + properties: + view: + type: optional + docs: Apply filters from the view ID (a tab from the Data Manager) + skipped: + type: optional + docs: >- + `only` - include all tasks with skipped annotations
`exclude` - + exclude all tasks with skipped annotations + + + * `only` - only + + * `exclude` - exclude + + * `None` - None + finished: + type: optional + docs: >- + `only` - include all finished tasks (is_labeled = true)
`exclude` - + exclude all finished tasks + + + * `only` - only + + * `exclude` - exclude + + * `None` - None + annotated: + type: optional + docs: >- + `only` - include all tasks with at least one not skipped + annotation
`exclude` - exclude all tasks with at least one not + skipped annotation + + + * `only` - only + + * `exclude` - exclude + + * `None` - None + only_with_annotations: + type: optional + default: false + reviewed: + type: optional + docs: >- + `only` - include all reviewed tasks
`exclude` - exclude all + reviewed tasks + + + * `only` - only + + * `exclude` - exclude + + * `None` - None + source: + openapi: openapi/openapi.yaml + LseTaskSerializerForAnnotatorsDraftsItem: + properties: + result: + type: optional>> + created_at: + type: optional + updated_at: + type: optional + source: + openapi: openapi/openapi.yaml + inline: true + LseTaskSerializerForAnnotatorsPredictionsItem: + properties: + result: + type: optional>> + score: + type: optional + model_version: + type: optional + model: + type: optional> + model_run: + type: optional> + task: + type: optional + project: + type: optional + created_at: + type: optional + updated_at: + type: optional + source: + openapi: openapi/openapi.yaml + inline: true + LseTaskSerializerForAnnotators: + docs: Task Serializer with project scheme configs validation + properties: + id: integer + data: unknown + created_at: + type: datetime + docs: Time a task was created + annotations: string + drafts: + docs: Drafts for this task + type: list + total_annotations: optional + cancelled_annotations: optional + annotations_results: string + predictions: + docs: Predictions for this task + type: list + total_predictions: optional + predictions_score: optional + predictions_results: string + comments: string + comment_count: string + unresolved_comment_count: string + reviews_rejected: optional + draft_exists: optional + source: + openapi: openapi/openapi.yaml + LseTaskSerializerForReviewersPredictionsItem: + properties: + result: + type: optional>> + score: + type: optional + model_version: + type: optional + model: + type: optional> + model_run: + type: optional> + task: + type: optional + project: + type: optional + created_at: + type: optional + updated_at: + type: optional + source: + openapi: openapi/openapi.yaml + inline: true + LseTaskSerializerForReviewersDraftsItem: + properties: + result: + type: optional>> + created_at: + type: optional + updated_at: + type: optional + source: + openapi: openapi/openapi.yaml + inline: true + LseTaskSerializerForReviewers: + docs: Task Serializer with project scheme configs validation + properties: + id: integer + agreement: string + predictions: + docs: Predictions for this task + type: list + annotations: string + drafts: + docs: Drafts for this task + type: list + annotators: + docs: Annotators IDs who annotated this task + type: list + inner_id: optional + cancelled_annotations: optional + total_annotations: optional + total_predictions: optional + completed_at: optional + annotations_results: string + predictions_results: string + predictions_score: optional + file_upload: string + storage_filename: string + annotations_ids: string + predictions_model_versions: string + avg_lead_time: optional + draft_exists: optional + updated_by: + docs: User IDs who updated this task + type: list> + reviewers: string + comments: string + comment_authors: string + reviewed: optional + reviews_accepted: optional + reviews_rejected: optional + ground_truth: optional + data: unknown + meta: optional + created_at: + type: datetime + docs: Time a task was created + updated_at: + type: datetime + docs: Last time a task was updated + is_labeled: + type: optional + docs: >- + True if the number of annotations for this task is greater than or + equal to the number of maximum_completions for the project + overlap: + type: optional + docs: Number of distinct annotators that processed the current task + validation: + min: -2147483648 + max: 2147483647 + comment_count: + type: optional + docs: Number of comments in the task including all annotations + validation: + min: -2147483648 + max: 2147483647 + unresolved_comment_count: + type: optional + docs: Number of unresolved comments in the task including all annotations + validation: + min: -2147483648 + max: 2147483647 + last_comment_updated_at: + type: optional + docs: When the last comment was updated + project: + type: optional + docs: Project ID for this task + source: + openapi: openapi/openapi.yaml + LseUser: + docs: |- + A ModelSerializer that takes additional arguments for + "fields", "omit" and "expand" in order to + control which fields are displayed, and whether to replace simple + values with complex, nested serializations + properties: + id: integer + first_name: + type: optional + validation: + maxLength: 256 + last_name: + type: optional + validation: + maxLength: 256 + username: + type: string + validation: + maxLength: 256 + email: + type: optional + validation: + format: email + maxLength: 254 + last_activity: datetime + custom_hotkeys: optional + avatar: string + initials: + type: string + default: '?' + phone: + type: optional + validation: + maxLength: 256 + active_organization: optional + active_organization_meta: string + allow_newsletters: + type: optional + docs: Allow sending newsletters to user + date_joined: optional + org_membership: list + lse_fields: LseFields + pause: string + source: + openapi: openapi/openapi.yaml + LseUserApi: + docs: |- + A ModelSerializer that takes additional arguments for + "fields", "omit" and "expand" in order to + control which fields are displayed, and whether to replace simple + values with complex, nested serializations + properties: + id: integer + first_name: + type: optional + validation: + maxLength: 256 + last_name: + type: optional + validation: + maxLength: 256 + username: + type: string + validation: + maxLength: 256 + email: + type: optional + validation: + format: email + maxLength: 254 + last_activity: datetime + custom_hotkeys: optional + avatar: string + initials: + type: string + default: '?' + phone: + type: optional + validation: + maxLength: 256 + active_organization: optional + active_organization_meta: string + allow_newsletters: + type: optional + docs: Allow sending newsletters to user + date_joined: optional + org_membership: list + source: + openapi: openapi/openapi.yaml + LseUserOrganizationMemberList: + docs: |- + A ModelSerializer that takes additional arguments for + "fields", "omit" and "expand" in order to + control which fields are displayed, and whether to replace simple + values with complex, nested serializations + properties: + id: integer + first_name: + type: optional + validation: + maxLength: 256 + last_name: + type: optional + validation: + maxLength: 256 + username: + type: string + validation: + maxLength: 256 + email: + type: optional + validation: + format: email + maxLength: 254 + last_activity: datetime + custom_hotkeys: optional + avatar: string + initials: + type: string + default: '?' + phone: + type: optional + validation: + maxLength: 256 + active_organization: optional + allow_newsletters: + type: optional + docs: Allow sending newsletters to user + date_joined: optional + lse_fields: LseFields + pause: string + created_projects: string + contributed_to_projects: string + source: + openapi: openapi/openapi.yaml + MlBackend: + docs: Serializer for MLBackend model. + properties: + id: integer + state: optional + readable_state: string + is_interactive: + type: optional + docs: >- + Used to interactively annotate tasks. If true, model returns one list + with results + url: + type: string + docs: URL for the machine learning model server + error_message: + type: optional + docs: Error message in error state + title: + type: optional + docs: Name of the machine learning backend + auth_method: optional + basic_auth_user: + type: optional + docs: HTTP Basic Auth user + basic_auth_pass_is_set: string + description: + type: optional + docs: Description for the machine learning backend + extra_params: optional + model_version: + type: optional + docs: Current model version associated with this machine learning backend + timeout: + type: optional + docs: Response model timeout + created_at: datetime + updated_at: datetime + auto_update: + type: optional + docs: >- + If false, model version is set by the user, if true - getting latest + version from backend. + project: integer + source: + openapi: openapi/openapi.yaml + MaybeExpandedComment: + discriminated: false + union: + - Comment + - CommentSerializerWithExpandedUser + source: + openapi: openapi/openapi.yaml + ModeEnum: + enum: + - settings + - value: settings,data + name: SettingsData + docs: |- + * `settings` - Only settings + * `settings,data` - Settings and tasks + source: + openapi: openapi/openapi.yaml + ModelInterface: + properties: + id: integer + created_by: + type: optional + docs: User who created Dataset + skill_name: optional + title: + type: string + docs: Model name + validation: + maxLength: 500 + description: + type: optional + docs: Model description + created_at: datetime + updated_at: datetime + input_fields: optional + output_classes: optional + organization: optional + associated_projects: optional> + source: + openapi: openapi/openapi.yaml + ModelInterfaceRequest: + properties: + created_by: + type: optional + docs: User who created Dataset + skill_name: optional + title: + type: string + docs: Model name + validation: + minLength: 1 + maxLength: 500 + description: + type: optional + docs: Model description + input_fields: optional + output_classes: optional + organization: optional + associated_projects: optional> + source: + openapi: openapi/openapi.yaml + ModelInterfaceSerializerGet: + properties: + id: integer + created_by: + type: optional + docs: User who created Dataset + skill_name: optional + associated_projects: optional> + title: + type: string + docs: Model name + validation: + maxLength: 500 + description: + type: optional + docs: Model description + created_at: datetime + updated_at: datetime + input_fields: optional + output_classes: optional + organization: optional + source: + openapi: openapi/openapi.yaml + ModelProviderConnectionBudgetResetPeriod: + discriminated: false + docs: |- + Budget reset period for the model provider connection (null if not reset) + + * `Monthly` - Monthly + * `Yearly` - Yearly + union: + - BudgetResetPeriodEnum + - NullEnum + source: + openapi: openapi/openapi.yaml + inline: true + ModelProviderConnection: + properties: + id: integer + created_by: UserSimple + model_params: + type: string + docs: JSON schema for the model parameters available for the provider + provider: optional + deployment_name: + type: optional + docs: Azure OpenAI deployment name + validation: + maxLength: 512 + endpoint: + type: optional + docs: Azure OpenAI endpoint + validation: + maxLength: 512 + google_project_id: + type: optional + docs: Google project ID + validation: + maxLength: 255 + google_location: + type: optional + docs: Google project location + validation: + maxLength: 255 + cached_available_models: + type: optional + docs: List of available models from the provider + validation: + maxLength: 4096 + scope: optional + created_at: datetime + updated_at: datetime + is_internal: + type: optional + docs: >- + Whether the model provider connection is internal, not visible to the + user + budget_limit: + type: optional + docs: Budget limit for the model provider connection (null if unlimited) + budget_last_reset_date: + type: optional + docs: Date and time the budget was last reset + budget_reset_period: + type: optional + docs: >- + Budget reset period for the model provider connection (null if not + reset) + + + * `Monthly` - Monthly + + * `Yearly` - Yearly + budget_total_spent: + type: optional + docs: >- + Tracked total budget spent for the given provider connection within + the current budget period + budget_alert_threshold: + type: optional + docs: Budget alert threshold for the given provider connection + organization: optional + source: + openapi: openapi/openapi.yaml + ModelProviderConnectionRequest: + properties: + provider: optional + api_key: + type: optional + docs: Model provider API key + auth_token: + type: optional + docs: Model provider Auth token + deployment_name: + type: optional + docs: Azure OpenAI deployment name + validation: + maxLength: 512 + endpoint: + type: optional + docs: Azure OpenAI endpoint + validation: + maxLength: 512 + google_application_credentials: + type: optional + docs: The content of GOOGLE_APPLICATION_CREDENTIALS json file + google_project_id: + type: optional + docs: Google project ID + validation: + maxLength: 255 + google_location: + type: optional + docs: Google project location + validation: + maxLength: 255 + cached_available_models: + type: optional + docs: List of available models from the provider + validation: + maxLength: 4096 + scope: optional + is_internal: + type: optional + docs: >- + Whether the model provider connection is internal, not visible to the + user + budget_alert_threshold: + type: optional + docs: Budget alert threshold for the given provider connection + source: + openapi: openapi/openapi.yaml + ModelRun: + properties: + id: integer + parent_model: integer + project_subset: optional + status: ModelRunStatusEnum + job_id: + type: optional + docs: Job ID for inference job for a ModelRun e.g. Adala job ID + validation: + maxLength: 255 + total_predictions: + type: optional + validation: + min: -2147483648 + max: 2147483647 + total_correct_predictions: + type: optional + validation: + min: -2147483648 + max: 2147483647 + total_tasks: + type: optional + validation: + min: -2147483648 + max: 2147483647 + created_at: datetime + triggered_at: optional + predictions_updated_at: optional + completed_at: optional + organization: optional + project: integer + created_by: optional + source: + openapi: openapi/openapi.yaml + ModelRunStatusEnum: + enum: + - Pending + - InProgress + - Completed + - Failed + - Canceled + docs: |- + * `Pending` - Pending + * `InProgress` - InProgress + * `Completed` - Completed + * `Failed` - Failed + * `Canceled` - Canceled + source: + openapi: openapi/openapi.yaml + NullEnum: string + OnboardingStateEnum: + enum: + - not_started + - signup + - trial_signup + - first_tutorial + - in_app_guidance + - complete + docs: |- + * `not_started` - Not Started + * `signup` - Signup + * `trial_signup` - Trial Signup + * `first_tutorial` - First Tutorial + * `in_app_guidance` - In App Guidance + * `complete` - Complete + source: + openapi: openapi/openapi.yaml + OrganizationBilling: + properties: + manual_workspace_management: string + manual_role_management: string + source: + openapi: openapi/openapi.yaml + OrganizationId: + docs: >- + A serializer mixin that takes an additional `fields` argument that + controls + + which fields should be displayed. + properties: + id: integer + title: + type: string + validation: + maxLength: 1000 + contact_info: + type: optional + validation: + format: email + maxLength: 254 + created_at: datetime + source: + openapi: openapi/openapi.yaml + OrganizationInvite: + properties: + token: optional + invite_url: optional + source: + openapi: openapi/openapi.yaml + OrganizationMember: + docs: >- + A serializer mixin that takes an additional `fields` argument that + controls + + which fields should be displayed. + properties: + user: + type: integer + docs: User ID + organization: + type: integer + docs: Organization ID + contributed_projects_count: string + annotations_count: string + created_at: datetime + source: + openapi: openapi/openapi.yaml + OrganizationMembership: + properties: + role: string + active: string + organization_id: + type: integer + docs: Organization ID + source: + openapi: openapi/openapi.yaml + OrganizationMembershipRequest: + properties: + role: + type: string + validation: + minLength: 1 + source: + openapi: openapi/openapi.yaml + PaginatedAllRolesProjectListList: + properties: + count: integer + next: + type: optional + validation: + format: uri + previous: + type: optional + validation: + format: uri + results: list + source: + openapi: openapi/openapi.yaml + PaginatedAnnotationHistoryList: + properties: + count: integer + next: + type: optional + validation: + format: uri + previous: + type: optional + validation: + format: uri + results: list + source: + openapi: openapi/openapi.yaml + PaginatedLabelCreateList: + properties: + count: integer + next: + type: optional + validation: + format: uri + previous: + type: optional + validation: + format: uri + results: list + source: + openapi: openapi/openapi.yaml + PaginatedLabelLinkList: + properties: + count: integer + next: + type: optional + validation: + format: uri + previous: + type: optional + validation: + format: uri + results: list + source: + openapi: openapi/openapi.yaml + PaginatedLabelList: + properties: + count: integer + next: + type: optional + validation: + format: uri + previous: + type: optional + validation: + format: uri + results: list