diff --git a/fern/openapi/openapi.yaml b/fern/openapi/openapi.yaml index 6a582b6..735377d 100644 --- a/fern/openapi/openapi.yaml +++ b/fern/openapi/openapi.yaml @@ -15777,110 +15777,83 @@ components: Serializer get numbers from project queryset annotation, make sure, that you use correct one(Project.objects.with_counts()) properties: - control_weights: + model_version: + type: string 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}' - start_training_on_annotation_update: + description: Machine learning model version + reveal_preannotations_interactively: type: boolean - readOnly: true - description: Start model training after any annotations are submitted or - updated - id: - type: integer - readOnly: true - ground_truth_number: - type: integer - readOnly: true - description: Honeypot annotation number in project - config_has_control_tags: + description: Reveal pre-annotations interactively + config_suitable_for_bulk_annotation: type: boolean readOnly: true - description: Flag to detect is project ready for labeling - annotation_limit_percent: + description: Flag to detect is project ready for bulk annotation + custom_script: type: string - format: decimal - pattern: ^-?\d{0,3}(?:\.\d{0,2})?$ - nullable: true - duplication_done: - type: boolean - default: false - finished_task_number: - type: integer - readOnly: true - members: + reviewed_number: type: string readOnly: true - total_annotations_number: + show_skip_button: + type: boolean + description: Show a skip button in interface and allow annotators to skip + the task + workspace: type: string readOnly: true - members_count: - type: integer + rejected: + type: string readOnly: true - enable_empty_annotation: - type: boolean - description: Allow annotators to submit empty annotations - config_suitable_for_bulk_annotation: + created_by: + allOf: + - $ref: '#/components/schemas/UserSimple' + description: Project owner + is_draft: type: boolean + description: Whether or not the project is in the middle of being created + parsed_label_config: readOnly: true - description: Flag to detect is project ready for bulk annotation - task_number: - type: integer + description: JSON-formatted labeling configuration + blueprints: + type: array + items: + $ref: '#/components/schemas/BlueprintList' readOnly: true - description: Total task number in project - workspace_title: + allow_stream: type: string readOnly: true - total_predictions_number: + members_count: type: integer readOnly: true - is_published: - type: boolean - title: Published - description: Whether or not the project is published to annotators - is_draft: - type: boolean - description: Whether or not the project is in the middle of being created - description: + label_config: type: string nullable: true - description: Project description - rejected: - type: string - readOnly: true - custom_script: - type: string - workspace: - type: string - readOnly: true - show_ground_truth_first: + 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) + show_instruction: type: boolean - expert_instruction: - type: string - nullable: true - description: Labeling instructions in HTML format - allow_stream: + description: Show instructions to the annotator before they start + total_annotations_number: type: string readOnly: true reviewer_queue_total: type: string readOnly: true + show_overlap_first: + type: boolean + comment_classification_config: + type: string created_at: type: string format: date-time readOnly: true - annotator_evaluation_minimum_tasks: - type: integer - minimum: 0 - nullable: true - default: 10 - review_total_tasks: + useful_annotation_number: type: string readOnly: true min_annotations_to_start_training: @@ -15889,155 +15862,182 @@ components: minimum: -2147483648 description: Minimum number of completed tasks after which model training is started - label_config: - type: string + organization: + type: integer nullable: true - description: Label config in XML format. See more about it in documentation - created_by: - allOf: - - $ref: '#/components/schemas/UserSimple' - description: Project owner - maximum_annotations: + overlap_cohort_percentage: 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) - evaluate_predictions_automatically: + show_annotation_history: + type: boolean + description: Show annotation history to annotator + config_has_control_tags: type: boolean - description: Retrieve and display predictions when loading a task - annotator_evaluation_minimum_score: - type: string - format: decimal - pattern: ^-?\d{0,3}(?:\.\d{0,2})?$ - nullable: true - default: '95.00' - model_version: - type: string - nullable: true - description: Machine learning model version - useful_annotation_number: - type: string readOnly: true - has_blueprints: - type: string + description: Flag to detect is project ready for labeling + id: + type: integer readOnly: true - pause_on_failed_annotator_evaluation: - type: boolean - nullable: true - default: false - show_instruction: - type: boolean - description: Show instructions to the annotator before they start - queue_left: + pinned_at: type: string + format: date-time + nullable: true + description: Pinned date and time + review_settings: + $ref: '#/components/schemas/ReviewSettings' + data_types: readOnly: true + nullable: 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 - pinned_at: + annotator_evaluation_minimum_tasks: + type: integer + minimum: 0 + nullable: true + default: 10 + annotation_limit_percent: type: string - format: date-time + format: decimal + pattern: ^-?\d{0,3}(?:\.\d{0,2})?$ + nullable: true + annotation_limit_count: + type: integer + minimum: 1 nullable: true - description: Pinned date and time ready: type: string readOnly: true - description_short: + evaluate_predictions_automatically: + type: boolean + description: Retrieve and display predictions when loading a task + duplication_status: + type: string + prompts: type: string readOnly: true - show_overlap_first: - type: boolean - reveal_preannotations_interactively: - type: boolean - description: Reveal pre-annotations interactively - comment_classification_config: + skipped_annotations_number: type: string - show_skip_button: - type: boolean - description: Show a skip button in interface and allow annotators to skip - the task - data_types: readOnly: true - nullable: true - organization: - type: integer - nullable: true - show_collab_predictions: + enable_empty_annotation: type: boolean - title: Show predictions to annotator - description: If set, the annotator can view model predictions - reviewed_number: + description: Allow annotators to submit empty annotations + color: type: string + nullable: true + maxLength: 16 + start_training_on_annotation_update: + type: boolean readOnly: true - prompts: + description: Start model training after any annotations are submitted or + updated + queue_left: type: string readOnly: true - overlap_cohort_percentage: - type: integer - maximum: 2147483647 - minimum: -2147483648 - duplication_status: - type: string - skipped_annotations_number: + description_short: type: string readOnly: true - blueprints: - type: array - items: - $ref: '#/components/schemas/BlueprintList' + duplication_done: + type: boolean + default: false + members: + type: string readOnly: true - sampling: + pause_on_failed_annotator_evaluation: + type: boolean nullable: true - oneOf: - - $ref: '#/components/schemas/SamplingEnum' - - $ref: '#/components/schemas/NullEnum' - color: + default: false + has_blueprints: type: string - nullable: true - maxLength: 16 + readOnly: true + show_collab_predictions: + type: boolean + title: Show predictions to annotator + description: If set, the annotator can view model predictions title: type: string nullable: true description: Project name. Must be between 3 and 50 characters long. maxLength: 50 minLength: 3 - skip_queue: + total_predictions_number: + type: integer + readOnly: true + review_total_tasks: + type: string + readOnly: true + expert_instruction: + type: string nullable: true - oneOf: - - $ref: '#/components/schemas/SkipQueueEnum' - - $ref: '#/components/schemas/NullEnum' - review_settings: - $ref: '#/components/schemas/ReviewSettings' + description: Labeling instructions in HTML format num_tasks_with_annotations: type: string readOnly: true + annotator_evaluation_minimum_score: + type: string + format: decimal + pattern: ^-?\d{0,3}(?:\.\d{0,2})?$ + nullable: true + default: '95.00' + finished_task_number: + type: integer + readOnly: true + task_number: + type: integer + readOnly: true + description: Total task number in project + 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}' + queue_done: + type: string + readOnly: true + show_ground_truth_first: + type: boolean assignment_settings: $ref: '#/components/schemas/AssignmentSettings' require_comment_on_skip: type: boolean default: false - annotation_limit_count: + ground_truth_number: type: integer - minimum: 1 + readOnly: true + description: Honeypot annotation number in project + skip_queue: nullable: true - queue_done: + oneOf: + - $ref: '#/components/schemas/SkipQueueEnum' + - $ref: '#/components/schemas/NullEnum' + workspace_title: type: string readOnly: true - show_annotation_history: - type: boolean - description: Show annotation history to annotator + sampling: + nullable: true + oneOf: + - $ref: '#/components/schemas/SamplingEnum' + - $ref: '#/components/schemas/NullEnum' queue_total: type: string readOnly: true - parsed_label_config: - readOnly: true - description: JSON-formatted labeling configuration + is_published: + type: boolean + title: Published + description: Whether or not the project is published to annotators + description: + type: string + nullable: true + description: Project description required: - allow_stream - assignment_settings