diff --git a/fern/openapi/openapi.yaml b/fern/openapi/openapi.yaml index bfc111c..6d7d28d 100644 --- a/fern/openapi/openapi.yaml +++ b/fern/openapi/openapi.yaml @@ -15576,110 +15576,144 @@ components: Serializer get numbers from project queryset annotation, make sure, that you use correct one(Project.objects.with_counts()) properties: - workspace_title: - type: string + control_weights: + nullable: true + description: 'Dict of weights for each control tag in metric calculation. + Each control tag (e.g. label or choice) will have it''s own key in control + weight dict with weight for each label and overall weight.For example, + if bounding box annotation with control tag named my_bbox should be included + with 0.33 weight in agreement calculation, and the first label Car should + be twice more important than Airplaine, then you have to need the specify: + {''my_bbox'': {''type'': ''RectangleLabels'', ''labels'': {''Car'': 1.0, + ''Airplaine'': 0.5}, ''overall'': 0.33}' + duplication_done: + type: boolean + default: false + require_comment_on_skip: + type: boolean + default: false + config_suitable_for_bulk_annotation: + type: boolean readOnly: true - ready: - type: string + description: Flag to detect is project ready for bulk annotation + task_number: + type: integer readOnly: true - overlap_cohort_percentage: + description: Total task number in project + finished_task_number: type: integer - maximum: 2147483647 - minimum: -2147483648 - queue_left: + readOnly: true + rejected: type: string readOnly: true - config_suitable_for_bulk_annotation: - type: boolean + description_short: + type: string readOnly: true - description: Flag to detect is project ready for bulk annotation - has_blueprints: + ready: type: string readOnly: true - show_overlap_first: - type: boolean - queue_total: + duplication_status: + type: string + annotation_limit_percent: type: string + format: decimal + pattern: ^-?\d{0,3}(?:\.\d{0,2})?$ + nullable: true + start_training_on_annotation_update: + type: boolean readOnly: true - enable_empty_annotation: + description: Start model training after any annotations are submitted or + updated + show_collab_predictions: type: boolean - description: Allow annotators to submit empty annotations + title: Show predictions to annotator + description: If set, the annotator can view model predictions + show_annotation_history: + type: boolean + description: Show annotation history to annotator + total_annotations_number: + type: string + readOnly: true + id: + type: integer + readOnly: true custom_task_lock_ttl: type: integer maximum: 86400 minimum: 1 nullable: true description: TTL in seconds for task reservations, on new and existing tasks - prompts: + color: + type: string + nullable: true + maxLength: 16 + num_tasks_with_annotations: type: string readOnly: true - start_training_on_annotation_update: + label_config: + type: string + nullable: true + description: Label config in XML format. See more about it in documentation + show_ground_truth_first: type: boolean + queue_done: + type: string readOnly: true - description: Start model training after any annotations are submitted or - updated - evaluate_predictions_automatically: - type: boolean - description: Retrieve and display predictions when loading a task - show_instruction: - type: boolean - description: Show instructions to the annotator before they start - color: + workspace: type: string - nullable: true - maxLength: 16 + readOnly: true sampling: nullable: true oneOf: - $ref: '#/components/schemas/SamplingEnum' - $ref: '#/components/schemas/NullEnum' - created_by: - allOf: - - $ref: '#/components/schemas/UserSimple' - description: Project owner - reveal_preannotations_interactively: + is_draft: type: boolean - description: Reveal pre-annotations interactively - pinned_at: + description: Whether or not the project is in the middle of being created + reviewed_number: type: string - format: date-time - nullable: true - description: Pinned date and time - finished_task_number: - type: integer readOnly: true - parsed_label_config: - readOnly: true - description: JSON-formatted labeling configuration - duplication_done: - type: boolean - default: false - reviewer_queue_total: + custom_script: type: string - readOnly: true - show_ground_truth_first: - type: boolean - task_number: - type: integer - readOnly: true - description: Total task number in project - num_tasks_with_annotations: + annotator_evaluation_minimum_score: + type: string + format: decimal + pattern: ^-?\d{0,3}(?:\.\d{0,2})?$ + nullable: true + default: '95.00' + expert_instruction: + type: string + nullable: true + description: Labeling instructions in HTML format + workspace_title: type: string readOnly: true - description_short: + comment_classification_config: + type: string + review_total_tasks: type: string readOnly: true - id: + total_predictions_number: type: integer readOnly: true - allow_stream: + reveal_preannotations_interactively: + type: boolean + description: Reveal pre-annotations interactively + members: type: string readOnly: true - annotation_limit_percent: - type: string - format: decimal - pattern: ^-?\d{0,3}(?:\.\d{0,2})?$ + show_overlap_first: + type: boolean + annotator_evaluation_minimum_tasks: + type: integer + minimum: 0 nullable: true + default: 10 + parsed_label_config: + readOnly: true + description: JSON-formatted labeling configuration + assignment_settings: + $ref: '#/components/schemas/AssignmentSettings' created_at: type: string format: date-time @@ -15688,153 +15722,119 @@ components: type: integer minimum: 1 nullable: true - queue_done: - type: string - readOnly: true - control_weights: - nullable: true - description: 'Dict of weights for each control tag in metric calculation. - Each control tag (e.g. label or choice) will have it''s own key in control - weight dict with weight for each label and overall weight.For example, - if bounding box annotation with control tag named my_bbox should be included - with 0.33 weight in agreement calculation, and the first label Car should - be twice more important than Airplaine, then you have to need the specify: - {''my_bbox'': {''type'': ''RectangleLabels'', ''labels'': {''Car'': 1.0, - ''Airplaine'': 0.5}, ''overall'': 0.33}' - data_types: - readOnly: true + overlap_cohort_percentage: + type: integer + maximum: 2147483647 + minimum: -2147483648 + skip_queue: nullable: true - reviewed_number: + oneOf: + - $ref: '#/components/schemas/SkipQueueEnum' + - $ref: '#/components/schemas/NullEnum' + has_blueprints: type: string readOnly: true - total_annotations_number: + members_count: type: string readOnly: true - total_predictions_number: + show_instruction: + type: boolean + description: Show instructions to the annotator before they start + ground_truth_number: type: integer readOnly: true - config_has_control_tags: + description: Honeypot annotation number in project + description: + type: string + nullable: true + description: Project description + enable_empty_annotation: type: boolean + description: Allow annotators to submit empty annotations + useful_annotation_number: + type: string readOnly: true - description: Flag to detect is project ready for labeling - blueprints: - type: array - items: - $ref: '#/components/schemas/BlueprintList' + evaluate_predictions_automatically: + type: boolean + description: Retrieve and display predictions when loading a task + review_settings: + $ref: '#/components/schemas/ReviewSettings' + data_types: readOnly: true - is_published: + nullable: true + config_has_control_tags: type: boolean - title: Published - description: Whether or not the project is published to annotators - duplication_status: - type: string - review_total_tasks: + readOnly: true + description: Flag to detect is project ready for labeling + reviewer_queue_total: type: string readOnly: true + pause_on_failed_annotator_evaluation: + type: boolean + nullable: true + default: false + created_by: + allOf: + - $ref: '#/components/schemas/UserSimple' + description: Project owner show_skip_button: type: boolean description: Show a skip button in interface and allow annotators to skip the task - is_draft: - type: boolean - description: Whether or not the project is in the middle of being created + queue_left: + type: string + readOnly: true title: type: string nullable: true description: Project name. Must be between 3 and 50 characters long. maxLength: 50 minLength: 3 - show_collab_predictions: - type: boolean - title: Show predictions to annotator - description: If set, the annotator can view model predictions - members: - type: string - readOnly: true min_annotations_to_start_training: type: integer maximum: 2147483647 minimum: -2147483648 description: Minimum number of completed tasks after which model training is started - workspace: + pinned_at: type: string - readOnly: true - organization: - type: integer + format: date-time nullable: true - assignment_settings: - $ref: '#/components/schemas/AssignmentSettings' - annotator_evaluation_minimum_tasks: + description: Pinned date and time + blueprints: + type: array + items: + $ref: '#/components/schemas/BlueprintList' + readOnly: true + maximum_annotations: type: integer - minimum: 0 - nullable: true - default: 10 + maximum: 2147483647 + minimum: -2147483648 + title: Maximum annotation number + description: 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) skipped_annotations_number: type: string readOnly: true - annotator_evaluation_minimum_score: - type: string - format: decimal - pattern: ^-?\d{0,3}(?:\.\d{0,2})?$ - nullable: true - default: '95.00' - comment_classification_config: - type: string - description: - type: string - nullable: true - description: Project description - expert_instruction: - type: string - nullable: true - description: Labeling instructions in HTML format - show_annotation_history: + is_published: type: boolean - description: Show annotation history to annotator - skip_queue: - nullable: true - oneOf: - - $ref: '#/components/schemas/SkipQueueEnum' - - $ref: '#/components/schemas/NullEnum' - review_settings: - $ref: '#/components/schemas/ReviewSettings' - members_count: + title: Published + description: Whether or not the project is published to annotators + prompts: type: string readOnly: true model_version: type: string nullable: true description: Machine learning model version - useful_annotation_number: + allow_stream: type: string readOnly: true - custom_script: - type: string - require_comment_on_skip: - type: boolean - default: false - ground_truth_number: + organization: type: integer - readOnly: true - description: Honeypot annotation number in project - pause_on_failed_annotator_evaluation: - type: boolean nullable: true - default: false - label_config: - type: string - nullable: true - description: Label config in XML format. See more about it in documentation - maximum_annotations: - type: integer - maximum: 2147483647 - minimum: -2147483648 - title: Maximum annotation number - description: 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) - rejected: + queue_total: type: string readOnly: true required: