diff --git a/fern/openapi/openapi.yaml b/fern/openapi/openapi.yaml index bfc111c..28c6d4e 100644 --- a/fern/openapi/openapi.yaml +++ b/fern/openapi/openapi.yaml @@ -1,181 +1,171 @@ openapi: 3.0.3 info: - title: Label Studio API - version: '' - description: Label Studio API for data annotation and labeling contact: url: https://labelstud.io + description: Label Studio API for data annotation and labeling + title: Label Studio API + version: '' paths: /api/activity-logs/: get: + description: Retrieve activity logs filtered by workspace, project, user, HTTP method, date range or search query. operationId: api_activity_logs_list - description: Retrieve activity logs filtered by workspace, project, user, HTTP - method, date range or search query. - summary: Get activity logs parameters: - - in: query - name: end_date - schema: - type: string - description: End date/time (ISO-8601) for log filtering. - - in: query - name: method - schema: - type: string - enum: - - DELETE - - GET - - PATCH - - POST - - PUT - - all - default: all - description: HTTP request method used in the log. - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - - in: query - name: page - schema: - type: integer - description: '[or "start"] Current page index.' - - in: query - name: page_size - schema: - type: integer - description: '[or "length"] Logs per page, use -1 to obtain all logs (might - be slow).' - - in: query - name: project - schema: - type: integer - description: Project ID to filter logs. - - in: query - name: search - schema: - type: string - description: Search expression using "AND"/"OR" to filter by request URL. - - in: query - name: start_date - schema: - type: string - description: Start date/time (ISO-8601) for log filtering. - - in: query - name: user - schema: - type: integer - description: User ID to filter logs. - - in: query - name: workspace - schema: - type: integer - description: Workspace owner ID to filter logs. - tags: - - Activity Log - security: - - Token: [] + - description: End date/time (ISO-8601) for log filtering. + in: query + name: end_date + schema: + type: string + - description: HTTP request method used in the log. + in: query + name: method + schema: + default: all + enum: + - DELETE + - GET + - PATCH + - POST + - PUT + - all + type: string + - description: Which field to use when ordering the results. + in: query + name: ordering + required: false + schema: + type: string + - description: '[or "start"] Current page index.' + in: query + name: page + schema: + type: integer + - description: '[or "length"] Logs per page, use -1 to obtain all logs (might be slow).' + in: query + name: page_size + schema: + type: integer + - description: Project ID to filter logs. + in: query + name: project + schema: + type: integer + - description: Search expression using "AND"/"OR" to filter by request URL. + in: query + name: search + schema: + type: string + - description: Start date/time (ISO-8601) for log filtering. + in: query + name: start_date + schema: + type: string + - description: User ID to filter logs. + in: query + name: user + schema: + type: integer + - description: Workspace owner ID to filter logs. + in: query + name: workspace + schema: + type: integer responses: '200': content: application/json: schema: - type: array items: $ref: '#/components/schemas/ActivityLogResponse' + type: array description: Activity logs '404': description: No more logs found - /api/annotation-history/: - get: - operationId: api_annotation_history_list - description: 'List annotation history items for an annotation. Annotation history - logs all actions performed with annotations, such as: imports, submits, updates, - reviews, and more. Users can view annotation history items in the Annotation - History panel during labeling.' - summary: List all annotation history items for annotation - parameters: - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - tags: - - Annotation History security: - - Token: [] + - Token: [] + summary: Get activity logs + tags: + - Activity Log + /api/annotation-history/: + delete: + description: Delete all annotation history items for a specific annotation, task or project. This method is available only for users with administrator roles. + operationId: api_annotation_history_destroy responses: '200': content: application/json: schema: - type: array - items: - $ref: '#/components/schemas/AnnotationHistory' - description: '' - delete: - operationId: api_annotation_history_destroy - description: Delete all annotation history items for a specific annotation, - task or project. This method is available only for users with administrator - roles. + properties: + removed: + description: Number of removed items + type: integer + type: object + description: Returns a dict containing the count of removed items. + security: + - Token: [] summary: Delete annotation history items tags: - - Annotation History - security: - - Token: [] + - Annotation History + get: + description: 'List annotation history items for an annotation. Annotation history logs all actions performed with annotations, such as: imports, submits, updates, reviews, and more. Users can view annotation history items in the Annotation History panel during labeling.' + operationId: api_annotation_history_list + parameters: + - description: Which field to use when ordering the results. + in: query + name: ordering + required: false + schema: + type: string responses: '200': content: application/json: schema: - type: object - properties: - removed: - type: integer - description: Number of removed items - description: Returns a dict containing the count of removed items. + items: + $ref: '#/components/schemas/AnnotationHistory' + type: array + description: '' + security: + - Token: [] + summary: List all annotation history items for annotation + tags: + - Annotation History /api/annotation-reviews/: get: - operationId: api_annotation_reviews_list description: List all reviews for a specific annotation ID. - summary: List reviews + operationId: api_annotation_reviews_list parameters: - - in: query - name: annotation - schema: - type: integer - - in: query - name: annotation__task__project - schema: - type: integer - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - tags: - - Annotation Reviews - security: - - Token: [] + - in: query + name: annotation + schema: + type: integer + - in: query + name: annotation__task__project + schema: + type: integer + - description: Which field to use when ordering the results. + in: query + name: ordering + required: false + schema: + type: string responses: '200': content: application/json: schema: - type: array items: $ref: '#/components/schemas/AnnotationReview' + type: array description: '' + security: + - Token: [] + summary: List reviews + tags: + - Annotation Reviews post: - operationId: api_annotation_reviews_create description: Create a review for a specific annotation ID. - summary: Create review - tags: - - Annotation Reviews + operationId: api_annotation_reviews_create requestBody: content: application/json: @@ -188,8 +178,6 @@ paths: schema: $ref: '#/components/schemas/AnnotationReviewRequest' required: true - security: - - Token: [] responses: '201': content: @@ -197,22 +185,73 @@ paths: schema: $ref: '#/components/schemas/AnnotationReview' description: '' + security: + - Token: [] + summary: Create review + tags: + - Annotation Reviews /api/annotation-reviews/{id}/: + delete: + description: Delete a review by ID + operationId: api_annotation_reviews_destroy + parameters: + - description: A unique integer value identifying this annotation review. + in: path + name: id + required: true + schema: + type: integer + responses: + '204': + description: No response body + security: + - Token: [] + summary: Delete review + tags: + - Annotation Reviews get: - operationId: api_annotation_reviews_retrieve description: Retrieve a specific review by ID for an annotation. - summary: Get review + operationId: api_annotation_reviews_retrieve parameters: - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this annotation review. - required: true - tags: - - Annotation Reviews + - description: A unique integer value identifying this annotation review. + in: path + name: id + required: true + schema: + type: integer + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/AnnotationReview' + description: '' security: - - Token: [] + - Token: [] + summary: Get review + tags: + - Annotation Reviews + patch: + description: Update a specific review by ID. + operationId: api_annotation_reviews_partial_update + parameters: + - description: A unique integer value identifying this annotation review. + in: path + name: id + required: true + schema: + type: integer + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedAnnotationReviewRequest' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/PatchedAnnotationReviewRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedAnnotationReviewRequest' responses: '200': content: @@ -220,19 +259,21 @@ paths: schema: $ref: '#/components/schemas/AnnotationReview' description: '' + security: + - Token: [] + summary: Update review + tags: + - Annotation Reviews put: - operationId: api_annotation_reviews_update description: Overwrite a specific review by ID. - summary: Put review + operationId: api_annotation_reviews_update parameters: - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this annotation review. - required: true - tags: - - Annotation Reviews + - description: A unique integer value identifying this annotation review. + in: path + name: id + required: true + schema: + type: integer requestBody: content: application/json: @@ -245,8 +286,6 @@ paths: schema: $ref: '#/components/schemas/AnnotationReviewRequest' required: true - security: - - Token: [] responses: '200': content: @@ -254,322 +293,503 @@ paths: schema: $ref: '#/components/schemas/AnnotationReview' description: '' - patch: - operationId: api_annotation_reviews_partial_update - description: Update a specific review by ID. - summary: Update review - parameters: - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this annotation review. - required: true + security: + - Token: [] + summary: Put review tags: - - Annotation Reviews + - Annotation Reviews + /api/annotations/bulk/: + post: + description: Create multiple annotations at once + operationId: api_annotations_bulk_create requestBody: content: application/json: schema: - $ref: '#/components/schemas/PatchedAnnotationReviewRequest' + $ref: '#/components/schemas/AnnotationBulkSerializerWithSelectedItemsRequest' application/x-www-form-urlencoded: schema: - $ref: '#/components/schemas/PatchedAnnotationReviewRequest' + $ref: '#/components/schemas/AnnotationBulkSerializerWithSelectedItemsRequest' multipart/form-data: schema: - $ref: '#/components/schemas/PatchedAnnotationReviewRequest' - security: - - Token: [] + $ref: '#/components/schemas/AnnotationBulkSerializerWithSelectedItemsRequest' responses: - '200': + '201': content: application/json: schema: - $ref: '#/components/schemas/AnnotationReview' - description: '' + items: + properties: + id: + description: Annotation ID + type: integer + required: + - id + type: object + type: array + description: Bulk annotations created successfully + security: + - Token: [] + summary: Bulk create annotations + tags: + - Annotations + x-fern-audiences: + - public + x-fern-sdk-group-name: annotations + x-fern-sdk-method-name: create_bulk + /api/annotations/{id}/: delete: - operationId: api_annotation_reviews_destroy - description: Delete a review by ID - summary: Delete review + description: Delete an annotation. This action can't be undone! + operationId: api_annotations_destroy parameters: - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this annotation review. - required: true - tags: - - Annotation Reviews - security: - - Token: [] + - in: path + name: id + required: true + schema: + type: integer responses: '204': description: No response body - /api/annotations/{id}/: + security: + - Token: [] + summary: Delete annotation + tags: + - Annotations + x-fern-audiences: + - public + x-fern-sdk-group-name: annotations + x-fern-sdk-method-name: delete get: + description: Retrieve a specific annotation for a task using the annotation result ID. operationId: api_annotations_retrieve - description: Retrieve a specific annotation for a task using the annotation - result ID. - summary: Get annotation by its ID parameters: - - in: path - name: id - schema: - type: integer - required: true - tags: - - Annotations - security: - - Token: [] + - in: path + name: id + required: true + schema: + type: integer responses: '200': content: application/json: - schema: - $ref: '#/components/schemas/Annotation' examples: Response: + summary: response value: + completed_by: 1 + ground_truth: false id: 1 + lead_time: 10 + project: 1 result: - - original_width: 1920 - original_height: 1080 - image_rotation: 0 - from_name: bboxes - to_name: image - type: rectanglelabels - value: - x: 20 - y: 30 - width: 50 - height: 60 - rotation: 0 - values: - rectanglelabels: - - Person + - from_name: bboxes + image_rotation: 0 + original_height: 1080 + original_width: 1920 + to_name: image + type: rectanglelabels + value: + height: 60 + rotation: 0 + values: + rectanglelabels: + - Person + width: 50 + x: 20 + y: 30 task: 1 - project: 1 - completed_by: 1 updated_by: 1 was_cancelled: false - ground_truth: false - lead_time: 10 - summary: response + schema: + $ref: '#/components/schemas/Annotation' description: Retrieved annotation - x-fern-sdk-group-name: annotations - x-fern-sdk-method-name: get + security: + - Token: [] + summary: Get annotation by its ID + tags: + - Annotations x-fern-audiences: - - public + - public + x-fern-sdk-group-name: annotations + x-fern-sdk-method-name: get patch: - operationId: api_annotations_partial_update description: Update existing attributes on an annotation. - summary: Update annotation + operationId: api_annotations_partial_update parameters: - - in: path - name: id - schema: - type: integer - required: true - tags: - - Annotations + - in: path + name: id + required: true + schema: + type: integer requestBody: content: application/json: schema: - type: object - properties: + example: + ground_truth: true result: - type: array - items: - type: object - description: Labeling result in JSON format. Read more about the - format in [the Label Studio documentation.](https://labelstud.io/guide/task_format) - example: - - original_width: 1920 - original_height: 1080 + - from_name: bboxes image_rotation: 0 - from_name: bboxes + original_height: 1080 + original_width: 1920 to_name: image type: rectanglelabels value: - x: 20 - y: 30 - width: 50 height: 60 rotation: 0 values: rectanglelabels: - - Person - task: + - Person + width: 50 + x: 20 + y: 30 + was_cancelled: false + properties: + completed_by: + description: User ID of the person who created this annotation type: integer - description: Corresponding task for this annotation + ground_truth: + description: This annotation is a Ground Truth + type: boolean + lead_time: + description: How much time it took to annotate the task (in seconds) + example: 100.5 + type: number project: - type: integer description: Project ID for this annotation - completed_by: type: integer - description: User ID of the person who created this annotation - updated_by: + result: + description: Labeling result in JSON format. Read more about the format in [the Label Studio documentation.](https://labelstud.io/guide/task_format) + example: + - from_name: bboxes + image_rotation: 0 + original_height: 1080 + original_width: 1920 + to_name: image + type: rectanglelabels + value: + height: 60 + rotation: 0 + values: + rectanglelabels: + - Person + width: 50 + x: 20 + y: 30 + items: + type: object + type: array + task: + description: Corresponding task for this annotation type: integer + updated_by: description: Last user who updated this annotation + type: integer was_cancelled: - type: boolean description: User skipped the task - ground_truth: type: boolean - description: This annotation is a Ground Truth - lead_time: - type: number - description: How much time it took to annotate the task (in seconds) - example: 100.5 required: [] - example: - result: - - original_width: 1920 - original_height: 1080 - image_rotation: 0 - from_name: bboxes - to_name: image - type: rectanglelabels - value: - x: 20 - y: 30 - width: 50 - height: 60 - rotation: 0 - values: - rectanglelabels: - - Person - was_cancelled: false - ground_truth: true - security: - - Token: [] + type: object responses: '200': content: application/json: - schema: - $ref: '#/components/schemas/Annotation' examples: Response: + summary: response value: + completed_by: 1 + ground_truth: false id: 1 + lead_time: 10 + project: 1 result: - - original_width: 1920 - original_height: 1080 - image_rotation: 0 - from_name: bboxes - to_name: image - type: rectanglelabels - value: - x: 20 - y: 30 - width: 50 - height: 60 - rotation: 0 - values: - rectanglelabels: - - Person + - from_name: bboxes + image_rotation: 0 + original_height: 1080 + original_width: 1920 + to_name: image + type: rectanglelabels + value: + height: 60 + rotation: 0 + values: + rectanglelabels: + - Person + width: 50 + x: 20 + y: 30 task: 1 - project: 1 - completed_by: 1 updated_by: 1 was_cancelled: false - ground_truth: false - lead_time: 10 - summary: response + schema: + $ref: '#/components/schemas/Annotation' description: Updated annotation - x-fern-sdk-group-name: annotations - x-fern-sdk-method-name: update - x-fern-audiences: - - public - delete: - operationId: api_annotations_destroy - description: Delete an annotation. This action can't be undone! - summary: Delete annotation - parameters: - - in: path - name: id - schema: - type: integer - required: true - tags: - - Annotations security: - - Token: [] - responses: - '204': - description: No response body - x-fern-sdk-group-name: annotations - x-fern-sdk-method-name: delete + - Token: [] + summary: Update annotation + tags: + - Annotations x-fern-audiences: - - public + - public + x-fern-sdk-group-name: annotations + x-fern-sdk-method-name: update /api/annotations/{id}/convert-to-draft: post: - operationId: api_annotations_convert_to_draft_create description: Convert annotation to draft - summary: Convert annotation to draft + operationId: api_annotations_convert_to_draft_create parameters: - - in: path - name: id - schema: - type: integer - required: true - tags: - - Annotations - security: - - Token: [] + - in: path + name: id + required: true + schema: + type: integer responses: '200': description: No response body - x-fern-audiences: - - internal - /api/annotations/bulk/: - post: - operationId: api_annotations_bulk_create - description: Create multiple annotations at once - summary: Bulk create annotations - tags: - - Annotations - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/AnnotationBulkSerializerWithSelectedItemsRequest' - application/x-www-form-urlencoded: - schema: - $ref: '#/components/schemas/AnnotationBulkSerializerWithSelectedItemsRequest' - multipart/form-data: - schema: - $ref: '#/components/schemas/AnnotationBulkSerializerWithSelectedItemsRequest' security: - - Token: [] + - Token: [] + summary: Convert annotation to draft + tags: + - Annotations + x-fern-audiences: + - internal + /api/billing/info: + get: + description: Retrieve billing checks and feature flags for the active organization. + operationId: api_billing_info_retrieve responses: - '201': + '200': content: application/json: - schema: - type: array - items: - type: object - properties: - id: - type: integer - description: Annotation ID - required: - - id - description: Bulk annotations created successfully - x-fern-sdk-group-name: annotations - x-fern-sdk-method-name: create_bulk + examples: + Cloud: + summary: cloud + value: + billing_checks: + export_storages: + count: 0 + limit: 0 + reached: false + import_storages: + count: 0 + limit: 0 + reached: false + is_license_expired: false + is_license_warning: false + is_prompts_expire: false + is_prompts_warning: false + license_expires: '2025-01-01' + license_issued: '2023-01-01' + license_warning: '2024-12-01' + organization_is_active: true + projects: + count: 3 + limit: 50 + reached: false + prompts_api_keys_enabled: true + prompts_enabled: true + prompts_expire: '2024-12-31' + prompts_status: Enabled + prompts_warning: null + results: + count: 100 + limit: 1000 + reached: false + trial_days: 14 + users: + count: 5 + limit: 10 + reached: false + total: 6 + billing_flags: + activated_at: '2023-01-01T00:00:00Z' + allow_activity_log: true + allow_ai: true + allow_ask_ai: true + allow_data_credentials: true + allow_invite_people: true + allow_invite_project_experts: true + allow_organization_webhooks: true + allow_sso: false + allow_storage_proxy: true + automax_enabled: true + automax_token_exists: false + cloud_instance: true + disable_members_page: false + disable_project_imports: false + early_adopter: false + embed_domains: + - domain: http://localhost:3000 + - domain: https://example.com + embed_enabled: false + embed_settings: + public_verify_alg: + - RS256 + public_verify_key: '....' + hide_storage_settings_for_manager: false + manual_role_management: false + manual_workspace_management: false + secure_mode: false + storage_persistence: true + white_label_id: null + Enterprise: + summary: enterprise + value: + billing_checks: + export_storages: + count: 0 + limit: 0 + reached: false + import_storages: + count: 0 + limit: 0 + reached: false + is_license_expired: false + is_license_warning: false + is_prompts_expire: false + is_prompts_warning: false + license_expires: '2025-01-01' + license_issued: '2023-01-01' + license_warning: '2024-12-01' + organization_is_active: true + projects: + count: 15 + limit: 200 + reached: false + prompts_api_keys_enabled: true + prompts_enabled: true + prompts_expire: null + prompts_status: Enabled + prompts_warning: null + results: + count: 25000 + limit: 100000 + reached: false + trial_days: 0 + users: + count: 20 + limit: 100 + reached: false + total: 22 + billing_flags: + activated_at: null + allow_activity_log: true + allow_ai: false + allow_ask_ai: true + allow_data_credentials: true + allow_invite_people: true + allow_invite_project_experts: true + allow_organization_webhooks: true + allow_sso: true + allow_storage_proxy: true + automax_enabled: true + automax_token_exists: true + cloud_instance: false + disable_members_page: false + disable_project_imports: false + early_adopter: true + embed_domains: + - domain: http://localhost:3000 + - domain: https://example.com + embed_enabled: false + embed_settings: + public_verify_alg: + - RS256 + public_verify_key: '....' + hide_storage_settings_for_manager: false + manual_role_management: false + manual_workspace_management: false + secure_mode: false + storage_persistence: true + white_label_id: wl-1 + Real-sample: + summary: real-sample + value: + billing_checks: + export_storages: + count: 0 + limit: 0 + reached: false + import_storages: + count: 0 + limit: 0 + reached: false + is_license_expired: false + is_license_warning: false + is_prompts_expire: false + is_prompts_warning: false + license_expires: '2030-01-02' + license_issued: '2000-01-01' + license_warning: '2030-01-01' + organization_is_active: true + projects: + count: 2044 + limit: 1000000 + reached: false + prompts_api_keys_enabled: true + prompts_enabled: true + prompts_expire: null + prompts_status: Enabled + prompts_warning: null + results: + count: 42949 + limit: 1000000000 + reached: false + trial_days: 0 + users: + count: 110 + limit: 1000 + reached: false + total: 221 + billing_flags: + activated_at: null + allow_activity_log: true + allow_ai: true + allow_ask_ai: true + allow_data_credentials: false + allow_invite_people: true + allow_invite_project_experts: true + allow_organization_webhooks: false + allow_sso: true + allow_storage_proxy: true + automax_enabled: true + automax_token_exists: true + cloud_instance: true + disable_members_page: false + disable_project_imports: false + early_adopter: true + embed_domains: + - domain: http://localhost:3000 + - domain: https://purple-zoos-flash.loca.lt + embed_enabled: true + embed_settings: + public_verify_alg: + - RS256 + public_verify_key: '....' + hide_storage_settings_for_manager: false + manual_role_management: true + manual_workspace_management: true + secure_mode: false + storage_persistence: true + white_label_id: null + schema: + $ref: '#/components/schemas/BillingInfoResponse' + description: Billing information for the active organization + security: + - Token: [] + summary: Get billing info + tags: + - Billing x-fern-audiences: - - public + - public + x-fern-sdk-group-name: + - billing + x-fern-sdk-method-name: info /api/blueprints/: post: - operationId: api_blueprints_create description: Create a new blueprint - summary: Create blueprint - tags: - - Blueprints + operationId: api_blueprints_create requestBody: content: application/json: @@ -581,8 +801,6 @@ paths: multipart/form-data: schema: $ref: '#/components/schemas/BlueprintRequest' - security: - - Token: [] responses: '201': content: @@ -590,115 +808,117 @@ paths: schema: $ref: '#/components/schemas/Blueprint' description: '' + security: + - Token: [] + summary: Create blueprint + tags: + - Blueprints /api/blueprints/{id}/: delete: - operationId: api_blueprints_destroy description: Delete a blueprint by ID - summary: Delete blueprint + operationId: api_blueprints_destroy parameters: - - in: path - name: id - schema: - type: string - required: true - tags: - - Blueprints - security: - - Token: [] + - in: path + name: id + required: true + schema: + type: string responses: '204': description: No response body + security: + - Token: [] + summary: Delete blueprint + tags: + - Blueprints /api/blueprints/{share_id}/create-project: get: - operationId: api_blueprints_create_project_retrieve description: Create a new project from an existing blueprint - summary: Create project from blueprint + operationId: api_blueprints_create_project_retrieve parameters: - - in: path - name: share_id - schema: - type: string - description: Blueprint share ID - required: true - tags: - - Blueprints - security: - - {} + - description: Blueprint share ID + in: path + name: share_id + required: true + schema: + type: string responses: '302': content: application/json: schema: - type: object properties: redirect_url: - type: string description: URL to redirect to the new project + type: string + type: object description: Redirect to new project '404': description: Blueprint not found + security: + - {} + summary: Create project from blueprint + tags: + - Blueprints /api/comments/: get: - operationId: api_comments_list description: List all comments for a specific annotation ID. - summary: List comments + operationId: api_comments_list parameters: - - in: query - name: annotation - schema: - type: integer - - in: query - name: annotators - schema: - type: string - - in: query - name: draft - schema: - type: integer - - in: query - name: expand_created_by - schema: - type: boolean - default: false - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - - in: query - name: projects - schema: - type: string - tags: - - Comments - security: - - Token: [] + - in: query + name: annotation + schema: + type: integer + - in: query + name: annotators + schema: + type: string + - in: query + name: draft + schema: + type: integer + - in: query + name: expand_created_by + schema: + default: false + type: boolean + - description: Which field to use when ordering the results. + in: query + name: ordering + required: false + schema: + type: string + - in: query + name: projects + schema: + type: string responses: '200': content: application/json: schema: - type: array items: $ref: '#/components/schemas/MaybeExpandedComment' + type: array description: List of comments + security: + - Token: [] + summary: List comments + tags: + - Comments + x-fern-audiences: + - public x-fern-sdk-group-name: comments x-fern-sdk-method-name: list - x-fern-audiences: - - public post: - operationId: api_comments_create description: Create a comment for a specific annotation ID. - summary: Create comment + operationId: api_comments_create parameters: - - in: query - name: expand_created_by - schema: - type: boolean - description: Expand the created_by field - tags: - - Comments + - description: Expand the created_by field + in: query + name: expand_created_by + schema: + type: boolean requestBody: content: application/json: @@ -710,8 +930,6 @@ paths: multipart/form-data: schema: $ref: '#/components/schemas/CommentRequest' - security: - - Token: [] responses: '201': content: @@ -719,30 +937,104 @@ paths: schema: $ref: '#/components/schemas/MaybeExpandedComment' description: '' + security: + - Token: [] + summary: Create comment + tags: + - Comments + x-fern-audiences: + - public x-fern-sdk-group-name: comments x-fern-sdk-method-name: create + /api/comments/export/: + get: + description: Export comments to CSV file + operationId: api_comments_export_retrieve + parameters: + - in: query + name: annotation + schema: + type: integer + - in: query + name: annotators + schema: + type: string + - in: query + name: draft + schema: + type: integer + - in: query + name: expand_created_by + schema: + default: false + type: boolean + - in: query + name: projects + schema: + type: string + - description: Timezone in which to export the data. Format IANA timezone name, e.g. "America/New_York" + in: query + name: tz + schema: + type: string + responses: + '200': + content: + application/json: + schema: + format: binary + type: string + description: CSV file with comments + security: + - Token: [] + summary: Export comments to CSV + tags: + - Comments x-fern-audiences: - - public + - public + x-fern-sdk-group-name: comments + x-fern-sdk-method-name: export /api/comments/{id}/: + delete: + description: Delete a comment by ID + operationId: api_comments_destroy + parameters: + - description: Expand the created_by field + in: query + name: expand_created_by + schema: + type: boolean + - in: path + name: id + required: true + schema: + type: string + responses: + '204': + description: No response body + security: + - Token: [] + summary: Delete comment + tags: + - Comments + x-fern-audiences: + - public + x-fern-sdk-group-name: comments + x-fern-sdk-method-name: delete get: - operationId: api_comments_retrieve description: Retrieve a specific comment by ID for an annotation. - summary: Get comment + operationId: api_comments_retrieve parameters: - - in: query - name: expand_created_by - schema: - type: boolean - description: Expand the created_by field - - in: path - name: id - schema: - type: string - required: true - tags: - - Comments - security: - - Token: [] + - description: Expand the created_by field + in: query + name: expand_created_by + schema: + type: boolean + - in: path + name: id + required: true + schema: + type: string responses: '200': content: @@ -750,174 +1042,99 @@ paths: schema: $ref: '#/components/schemas/MaybeExpandedComment' description: '' + security: + - Token: [] + summary: Get comment + tags: + - Comments + x-fern-audiences: + - public x-fern-sdk-group-name: comments x-fern-sdk-method-name: get - x-fern-audiences: - - public - put: - operationId: api_comments_update - description: Overwrite a specific comment by ID. - summary: Put comment + patch: + description: Update a specific comment by ID. + operationId: api_comments_partial_update parameters: - - in: query - name: expand_created_by - schema: - type: boolean - description: Expand the created_by field - - in: path - name: id - schema: - type: string - required: true - tags: - - Comments + - description: Expand the created_by field + in: query + name: expand_created_by + schema: + type: boolean + - in: path + name: id + required: true + schema: + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/CommentRequest' + $ref: '#/components/schemas/PatchedCommentRequest' application/x-www-form-urlencoded: schema: - $ref: '#/components/schemas/CommentRequest' + $ref: '#/components/schemas/PatchedCommentRequest' multipart/form-data: schema: - $ref: '#/components/schemas/CommentRequest' - security: - - Token: [] + $ref: '#/components/schemas/PatchedCommentRequest' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/Comment' + $ref: '#/components/schemas/MaybeExpandedComment' description: '' - x-fern-audiences: - - internal - patch: - operationId: api_comments_partial_update - description: Update a specific comment by ID. + security: + - Token: [] summary: Update comment - parameters: - - in: query - name: expand_created_by - schema: - type: boolean - description: Expand the created_by field - - in: path - name: id - schema: - type: string - required: true tags: - - Comments + - Comments + x-fern-audiences: + - public + x-fern-sdk-group-name: comments + x-fern-sdk-method-name: update + put: + description: Overwrite a specific comment by ID. + operationId: api_comments_update + parameters: + - description: Expand the created_by field + in: query + name: expand_created_by + schema: + type: boolean + - in: path + name: id + required: true + schema: + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/PatchedCommentRequest' + $ref: '#/components/schemas/CommentRequest' application/x-www-form-urlencoded: schema: - $ref: '#/components/schemas/PatchedCommentRequest' + $ref: '#/components/schemas/CommentRequest' multipart/form-data: schema: - $ref: '#/components/schemas/PatchedCommentRequest' - security: - - Token: [] + $ref: '#/components/schemas/CommentRequest' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/MaybeExpandedComment' + $ref: '#/components/schemas/Comment' description: '' - x-fern-sdk-group-name: comments - x-fern-sdk-method-name: update - x-fern-audiences: - - public - delete: - operationId: api_comments_destroy - description: Delete a comment by ID - summary: Delete comment - parameters: - - in: query - name: expand_created_by - schema: - type: boolean - description: Expand the created_by field - - in: path - name: id - schema: - type: string - required: true - tags: - - Comments security: - - Token: [] - responses: - '204': - description: No response body - x-fern-sdk-group-name: comments - x-fern-sdk-method-name: delete - x-fern-audiences: - - public - /api/comments/export/: - get: - operationId: api_comments_export_retrieve - description: Export comments to CSV file - summary: Export comments to CSV - parameters: - - in: query - name: annotation - schema: - type: integer - - in: query - name: annotators - schema: - type: string - - in: query - name: draft - schema: - type: integer - - in: query - name: expand_created_by - schema: - type: boolean - default: false - - in: query - name: projects - schema: - type: string - - in: query - name: tz - schema: - type: string - description: Timezone in which to export the data. Format IANA timezone name, - e.g. "America/New_York" + - Token: [] + summary: Put comment tags: - - Comments - security: - - Token: [] - responses: - '200': - content: - application/json: - schema: - type: string - format: binary - description: CSV file with comments - x-fern-sdk-group-name: comments - x-fern-sdk-method-name: export + - Comments x-fern-audiences: - - public + - internal /api/current-user: get: - operationId: api_current_user_retrieve description: Get info about the currently authenticated user. - summary: Get current user info - tags: - - Users - security: - - Token: [] + operationId: api_current_user_retrieve responses: '200': content: @@ -925,16 +1142,18 @@ paths: schema: $ref: '#/components/schemas/LseUserAPI' description: '' + security: + - Token: [] + summary: Get current user info + tags: + - Users + x-fern-audiences: + - public x-fern-sdk-group-name: users x-fern-sdk-method-name: get_current_user - x-fern-audiences: - - public patch: - operationId: api_current_user_partial_update description: Update details for the currently authenticated user. - summary: Update current user - tags: - - Users + operationId: api_current_user_partial_update requestBody: content: application/json: @@ -946,8 +1165,6 @@ paths: multipart/form-data: schema: $ref: '#/components/schemas/PatchedLseUserSerializerUpdateRequest' - security: - - Token: [] responses: '200': content: @@ -955,19 +1172,19 @@ paths: schema: $ref: '#/components/schemas/LseUserAPI' description: '' + security: + - Token: [] + summary: Update current user + tags: + - Users + x-fern-audiences: + - public x-fern-sdk-group-name: users x-fern-sdk-method-name: update_current_user - x-fern-audiences: - - public /api/current-user/hotkeys/: get: - operationId: api_current_user_hotkeys_retrieve description: Retrieve the custom hotkeys configuration for the current user. - summary: Get user hotkeys - tags: - - Users - security: - - Token: [] + operationId: api_current_user_hotkeys_retrieve responses: '200': content: @@ -975,16 +1192,18 @@ paths: schema: $ref: '#/components/schemas/Hotkeys' description: '' + security: + - Token: [] + summary: Get user hotkeys + tags: + - Users + x-fern-audiences: + - public x-fern-sdk-group-name: users x-fern-sdk-method-name: get_hotkeys - x-fern-audiences: - - public patch: - operationId: api_current_user_hotkeys_partial_update description: Update the custom hotkeys configuration for the current user. - summary: Update user hotkeys - tags: - - Users + operationId: api_current_user_hotkeys_partial_update requestBody: content: application/json: @@ -996,8 +1215,6 @@ paths: multipart/form-data: schema: $ref: '#/components/schemas/PatchedHotkeysRequest' - security: - - Token: [] responses: '200': content: @@ -1005,66 +1222,65 @@ paths: schema: $ref: '#/components/schemas/Hotkeys' description: '' + security: + - Token: [] + summary: Update user hotkeys + tags: + - Users + x-fern-audiences: + - public x-fern-sdk-group-name: users x-fern-sdk-method-name: update_hotkeys - x-fern-audiences: - - public /api/current-user/reset-token/: post: - operationId: api_current_user_reset_token_create description: Reset the user token for the current user. - summary: Reset user token - tags: - - Users - security: - - Token: [] + operationId: api_current_user_reset_token_create responses: '201': content: application/json: schema: - type: object properties: token: type: string + type: object description: User token response + security: + - Token: [] + summary: Reset user token + tags: + - Users + x-fern-audiences: + - public x-fern-sdk-group-name: users x-fern-sdk-method-name: reset_token - x-fern-audiences: - - public /api/current-user/token: get: - operationId: api_current_user_token_retrieve description: Get a user token to authenticate to the API as the current user. - summary: Get user token - tags: - - Users - security: - - Token: [] + operationId: api_current_user_token_retrieve responses: '200': content: application/json: schema: - type: object properties: detail: type: string + type: object description: User token response + security: + - Token: [] + summary: Get user token + tags: + - Users + x-fern-audiences: + - public x-fern-sdk-group-name: users x-fern-sdk-method-name: get_token - x-fern-audiences: - - public /api/current-user/whoami: get: + description: Retrieve details of the account that you are using to access the API. operationId: api_current_user_whoami_retrieve - description: Retrieve details of the account that you are using to access the - API. - summary: Retrieve my user - tags: - - Users - security: - - Token: [] responses: '200': content: @@ -1072,117 +1288,144 @@ paths: schema: $ref: '#/components/schemas/LseUser' description: '' + security: + - Token: [] + summary: Retrieve my user + tags: + - Users + x-fern-audiences: + - public x-fern-sdk-group-name: users x-fern-sdk-method-name: whoami - x-fern-audiences: - - public /api/dashboards/{id}/kpis/{kpi_key}: get: + description: 'Get Key Performance Indicator (KPI) data for a dashboard. Supports various KPIs including: skipped_annotations, accepted_annotations, rejected_annotations, average_time_per_task_min, total_annotations, regions_created, and more.' operationId: api_dashboards_kpis_retrieve - description: 'Get Key Performance Indicator (KPI) data for a dashboard. Supports - various KPIs including: skipped_annotations, accepted_annotations, rejected_annotations, - average_time_per_task_min, total_annotations, regions_created, and more.' - summary: Get KPI data parameters: - - in: query - name: end - schema: - type: string - description: End date for filtering (ISO format) - - in: path - name: id - schema: - type: integer - required: true - - in: path - name: kpi_key - schema: - type: string - required: true - - in: query - name: members - schema: - type: array - items: + - description: End date for filtering (ISO format) + in: query + name: end + schema: + type: string + - in: path + name: id + required: true + schema: type: integer - description: Array of user IDs to filter by - - in: query - name: start - schema: - type: string - description: Start date for filtering (ISO format) - tags: - - Dashboard - security: - - Token: [] + - in: path + name: kpi_key + required: true + schema: + type: string + - description: Array of user IDs to filter by + in: query + name: members + schema: + items: + type: integer + type: array + - description: Start date for filtering (ISO format) + in: query + name: start + schema: + type: string responses: '200': content: application/json: schema: - type: object description: KPI data with the requested key and its value + type: object description: KPI data '404': description: KPI not found '501': description: KPI depends on other KPIs - not implemented + security: + - Token: [] + summary: Get KPI data + tags: + - Dashboard /api/dataset-storages/: get: + description: Retrieve a list of the dataset storages of all types with their IDs. operationId: api_dataset_storages_list - description: Retrieve a list of the dataset storages of all types with their - IDs. - summary: List all dataset storages from the project parameters: - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - tags: - - Storage - security: - - Token: [] + - description: Which field to use when ordering the results. + in: query + name: ordering + required: false + schema: + type: string responses: '200': description: List of DatasetStorageSerializer + security: + - Token: [] + summary: List all dataset storages from the project + tags: + - Storage /api/dataset-storages/azure/: get: - operationId: api_dataset_storages_azure_list description: Get a list of all Azure import storage connections. - summary: Get all import storage + operationId: api_dataset_storages_azure_list parameters: - - in: query - name: dataset - schema: - type: integer - description: Dataset ID - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - tags: - - 'Dataset Storage: Azure' - security: - - Token: [] + - description: Dataset ID + in: query + name: dataset + schema: + type: integer + - description: Which field to use when ordering the results. + in: query + name: ordering + required: false + schema: + type: string responses: '200': content: application/json: schema: - type: array items: $ref: '#/components/schemas/AzureDatasetStorage' + type: array description: '' + security: + - Token: [] + summary: Get all import storage + tags: + - 'Dataset Storage: Azure' post: - operationId: api_dataset_storages_azure_create description: Create a new Azure import storage connection. + operationId: api_dataset_storages_azure_create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AzureDatasetStorageRequest' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/AzureDatasetStorageRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/AzureDatasetStorageRequest' + required: true + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/AzureDatasetStorage' + description: '' + security: + - Token: [] summary: Create import storage tags: - - 'Dataset Storage: Azure' + - 'Dataset Storage: Azure' + /api/dataset-storages/azure/check-for-records/: + post: + description: Checks for existence of records matching the file pattern in the bucket/prefix + operationId: api_dataset_storages_azure_check_for_records_create requestBody: content: application/json: @@ -1195,8 +1438,34 @@ paths: schema: $ref: '#/components/schemas/AzureDatasetStorageRequest' required: true + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/AzureDatasetStorage' + description: '' security: - - Token: [] + - Token: [] + summary: Check for records given the file pattern + tags: + - 'Dataset Storage: Azure' + /api/dataset-storages/azure/validate/: + post: + description: Validate a specific Azure import storage connection. + operationId: api_dataset_storages_azure_validate_create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AzureDatasetStorageRequest' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/AzureDatasetStorageRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/AzureDatasetStorageRequest' + required: true responses: '201': content: @@ -1204,21 +1473,38 @@ paths: schema: $ref: '#/components/schemas/AzureDatasetStorage' description: '' + security: + - Token: [] + summary: Validate import storage + tags: + - 'Dataset Storage: Azure' /api/dataset-storages/azure/{id}/: + delete: + description: Delete a specific Azure import storage connection. + operationId: api_dataset_storages_azure_destroy + parameters: + - in: path + name: id + required: true + schema: + type: integer + responses: + '204': + description: No response body + security: + - Token: [] + summary: Delete import storage + tags: + - 'Dataset Storage: Azure' get: - operationId: api_dataset_storages_azure_retrieve description: Get a specific Azure import storage connection. - summary: Get import storage + operationId: api_dataset_storages_azure_retrieve parameters: - - in: path - name: id - schema: - type: integer - required: true - tags: - - 'Dataset Storage: Azure' - security: - - Token: [] + - in: path + name: id + required: true + schema: + type: integer responses: '200': content: @@ -1226,18 +1512,20 @@ paths: schema: $ref: '#/components/schemas/AzureDatasetStorage' description: '' + security: + - Token: [] + summary: Get import storage + tags: + - 'Dataset Storage: Azure' patch: - operationId: api_dataset_storages_azure_partial_update description: Update a specific Azure import storage connection. - summary: Update import storage + operationId: api_dataset_storages_azure_partial_update parameters: - - in: path - name: id - schema: - type: integer - required: true - tags: - - 'Dataset Storage: Azure' + - in: path + name: id + required: true + schema: + type: integer requestBody: content: application/json: @@ -1249,8 +1537,6 @@ paths: multipart/form-data: schema: $ref: '#/components/schemas/PatchedAzureDatasetStorageRequest' - security: - - Token: [] responses: '200': content: @@ -1258,54 +1544,39 @@ paths: schema: $ref: '#/components/schemas/AzureDatasetStorage' description: '' - delete: - operationId: api_dataset_storages_azure_destroy - description: Delete a specific Azure import storage connection. - summary: Delete import storage - parameters: - - in: path - name: id - schema: - type: integer - required: true - tags: - - 'Dataset Storage: Azure' security: - - Token: [] - responses: - '204': - description: No response body + - Token: [] + summary: Update import storage + tags: + - 'Dataset Storage: Azure' /api/dataset-storages/azure/{id}/columns/: get: - operationId: api_dataset_storages_azure_columns_retrieve description: Retrieves column names from users JSON/blob data in bucket - summary: Get data column names from storage + operationId: api_dataset_storages_azure_columns_retrieve parameters: - - in: path - name: id - schema: - type: integer - required: true - tags: - - 'Dataset Storage: Azure' - security: - - Token: [] + - in: path + name: id + required: true + schema: + type: integer responses: '200': description: No response body + security: + - Token: [] + summary: Get data column names from storage + tags: + - 'Dataset Storage: Azure' /api/dataset-storages/azure/{id}/sync/: post: - operationId: api_dataset_storages_azure_sync_create description: Sync tasks from an Azure import storage connection. - summary: Sync import storage + operationId: api_dataset_storages_azure_sync_create parameters: - - in: path - name: id - schema: - type: integer - required: true - tags: - - 'Dataset Storage: Azure' + - in: path + name: id + required: true + schema: + type: integer requestBody: content: application/json: @@ -1318,8 +1589,6 @@ paths: schema: $ref: '#/components/schemas/AzureDatasetStorageRequest' required: true - security: - - Token: [] responses: '200': content: @@ -1327,99 +1596,100 @@ paths: schema: $ref: '#/components/schemas/AzureDatasetStorage' description: '' - /api/dataset-storages/azure/check-for-records/: - post: - operationId: api_dataset_storages_azure_check_for_records_create - description: Checks for existence of records matching the file pattern in the - bucket/prefix - summary: Check for records given the file pattern + security: + - Token: [] + summary: Sync import storage + tags: + - 'Dataset Storage: Azure' + /api/dataset-storages/gcs/: + get: + description: Get a list of all GCS import storage connections. + operationId: api_dataset_storages_gcs_list + parameters: + - description: Dataset ID + in: query + name: dataset + schema: + type: integer + - description: Which field to use when ordering the results. + in: query + name: ordering + required: false + schema: + type: string + responses: + '200': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/GCSDatasetStorage' + type: array + description: '' + security: + - Token: [] + summary: Get all import storage tags: - - 'Dataset Storage: Azure' + - 'Dataset Storage: GCS' + post: + description: Create a new GCS import storage connection. + operationId: api_dataset_storages_gcs_create requestBody: content: application/json: schema: - $ref: '#/components/schemas/AzureDatasetStorageRequest' + $ref: '#/components/schemas/GCSDatasetStorageRequest' application/x-www-form-urlencoded: schema: - $ref: '#/components/schemas/AzureDatasetStorageRequest' + $ref: '#/components/schemas/GCSDatasetStorageRequest' multipart/form-data: schema: - $ref: '#/components/schemas/AzureDatasetStorageRequest' + $ref: '#/components/schemas/GCSDatasetStorageRequest' required: true - security: - - Token: [] responses: '201': content: application/json: schema: - $ref: '#/components/schemas/AzureDatasetStorage' + $ref: '#/components/schemas/GCSDatasetStorage' description: '' - /api/dataset-storages/azure/validate/: - post: - operationId: api_dataset_storages_azure_validate_create - description: Validate a specific Azure import storage connection. - summary: Validate import storage + security: + - Token: [] + summary: Create import storage tags: - - 'Dataset Storage: Azure' + - 'Dataset Storage: GCS' + /api/dataset-storages/gcs/check-for-records/: + post: + description: Checks for existence of records matching the file pattern in the bucket/prefix + operationId: api_dataset_storages_gcs_check_for_records_create requestBody: content: application/json: schema: - $ref: '#/components/schemas/AzureDatasetStorageRequest' + $ref: '#/components/schemas/GCSDatasetStorageRequest' application/x-www-form-urlencoded: schema: - $ref: '#/components/schemas/AzureDatasetStorageRequest' + $ref: '#/components/schemas/GCSDatasetStorageRequest' multipart/form-data: schema: - $ref: '#/components/schemas/AzureDatasetStorageRequest' + $ref: '#/components/schemas/GCSDatasetStorageRequest' required: true - security: - - Token: [] responses: '201': content: application/json: schema: - $ref: '#/components/schemas/AzureDatasetStorage' + $ref: '#/components/schemas/GCSDatasetStorage' description: '' - /api/dataset-storages/gcs/: - get: - operationId: api_dataset_storages_gcs_list - description: Get a list of all GCS import storage connections. - summary: Get all import storage - parameters: - - in: query - name: dataset - schema: - type: integer - description: Dataset ID - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - tags: - - 'Dataset Storage: GCS' security: - - Token: [] - responses: - '200': - content: - application/json: - schema: - type: array - items: - $ref: '#/components/schemas/GCSDatasetStorage' - description: '' - post: - operationId: api_dataset_storages_gcs_create - description: Create a new GCS import storage connection. - summary: Create import storage + - Token: [] + summary: Check for records given the file pattern tags: - - 'Dataset Storage: GCS' + - 'Dataset Storage: GCS' + /api/dataset-storages/gcs/validate/: + post: + description: Validate a specific GCS import storage connection. + operationId: api_dataset_storages_gcs_validate_create requestBody: content: application/json: @@ -1432,8 +1702,6 @@ paths: schema: $ref: '#/components/schemas/GCSDatasetStorageRequest' required: true - security: - - Token: [] responses: '201': content: @@ -1441,21 +1709,38 @@ paths: schema: $ref: '#/components/schemas/GCSDatasetStorage' description: '' + security: + - Token: [] + summary: Validate import storage + tags: + - 'Dataset Storage: GCS' /api/dataset-storages/gcs/{id}/: + delete: + description: Delete a specific GCS import storage connection. + operationId: api_dataset_storages_gcs_destroy + parameters: + - in: path + name: id + required: true + schema: + type: integer + responses: + '204': + description: No response body + security: + - Token: [] + summary: Delete import storage + tags: + - 'Dataset Storage: GCS' get: - operationId: api_dataset_storages_gcs_retrieve description: Get a specific GCS import storage connection. - summary: Get import storage + operationId: api_dataset_storages_gcs_retrieve parameters: - - in: path - name: id - schema: - type: integer - required: true - tags: - - 'Dataset Storage: GCS' - security: - - Token: [] + - in: path + name: id + required: true + schema: + type: integer responses: '200': content: @@ -1463,18 +1748,20 @@ paths: schema: $ref: '#/components/schemas/GCSDatasetStorage' description: '' + security: + - Token: [] + summary: Get import storage + tags: + - 'Dataset Storage: GCS' patch: - operationId: api_dataset_storages_gcs_partial_update description: Update a specific GCS import storage connection. - summary: Update import storage + operationId: api_dataset_storages_gcs_partial_update parameters: - - in: path - name: id - schema: - type: integer - required: true - tags: - - 'Dataset Storage: GCS' + - in: path + name: id + required: true + schema: + type: integer requestBody: content: application/json: @@ -1486,8 +1773,6 @@ paths: multipart/form-data: schema: $ref: '#/components/schemas/PatchedGCSDatasetStorageRequest' - security: - - Token: [] responses: '200': content: @@ -1495,54 +1780,39 @@ paths: schema: $ref: '#/components/schemas/GCSDatasetStorage' description: '' - delete: - operationId: api_dataset_storages_gcs_destroy - description: Delete a specific GCS import storage connection. - summary: Delete import storage - parameters: - - in: path - name: id - schema: - type: integer - required: true - tags: - - 'Dataset Storage: GCS' security: - - Token: [] - responses: - '204': - description: No response body + - Token: [] + summary: Update import storage + tags: + - 'Dataset Storage: GCS' /api/dataset-storages/gcs/{id}/columns/: get: - operationId: api_dataset_storages_gcs_columns_retrieve description: Retrieves column names from users JSON/blob data in bucket - summary: Get data column names from storage + operationId: api_dataset_storages_gcs_columns_retrieve parameters: - - in: path - name: id - schema: - type: integer - required: true - tags: - - 'Dataset Storage: GCS' - security: - - Token: [] + - in: path + name: id + required: true + schema: + type: integer responses: '200': description: No response body + security: + - Token: [] + summary: Get data column names from storage + tags: + - 'Dataset Storage: GCS' /api/dataset-storages/gcs/{id}/sync/: post: - operationId: api_dataset_storages_gcs_sync_create description: Sync tasks from an GCS import storage connection. - summary: Sync import storage + operationId: api_dataset_storages_gcs_sync_create parameters: - - in: path - name: id - schema: - type: integer - required: true - tags: - - 'Dataset Storage: GCS' + - in: path + name: id + required: true + schema: + type: integer requestBody: content: application/json: @@ -1555,8 +1825,6 @@ paths: schema: $ref: '#/components/schemas/GCSDatasetStorageRequest' required: true - security: - - Token: [] responses: '200': content: @@ -1564,99 +1832,100 @@ paths: schema: $ref: '#/components/schemas/GCSDatasetStorage' description: '' - /api/dataset-storages/gcs/check-for-records/: - post: - operationId: api_dataset_storages_gcs_check_for_records_create - description: Checks for existence of records matching the file pattern in the - bucket/prefix - summary: Check for records given the file pattern + security: + - Token: [] + summary: Sync import storage + tags: + - 'Dataset Storage: GCS' + /api/dataset-storages/s3/: + get: + description: Get a list of all S3 import storage connections. + operationId: api_dataset_storages_s3_list + parameters: + - description: Dataset ID + in: query + name: dataset + schema: + type: integer + - description: Which field to use when ordering the results. + in: query + name: ordering + required: false + schema: + type: string + responses: + '200': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/S3DatasetStorage' + type: array + description: '' + security: + - Token: [] + summary: Get all import storage tags: - - 'Dataset Storage: GCS' + - 'Dataset Storage: S3' + post: + description: Create a new S3 import storage connection. + operationId: api_dataset_storages_s3_create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GCSDatasetStorageRequest' + $ref: '#/components/schemas/S3DatasetStorageRequest' application/x-www-form-urlencoded: schema: - $ref: '#/components/schemas/GCSDatasetStorageRequest' + $ref: '#/components/schemas/S3DatasetStorageRequest' multipart/form-data: schema: - $ref: '#/components/schemas/GCSDatasetStorageRequest' + $ref: '#/components/schemas/S3DatasetStorageRequest' required: true - security: - - Token: [] responses: '201': content: application/json: schema: - $ref: '#/components/schemas/GCSDatasetStorage' + $ref: '#/components/schemas/S3DatasetStorage' description: '' - /api/dataset-storages/gcs/validate/: - post: - operationId: api_dataset_storages_gcs_validate_create - description: Validate a specific GCS import storage connection. - summary: Validate import storage + security: + - Token: [] + summary: Create import storage tags: - - 'Dataset Storage: GCS' + - 'Dataset Storage: S3' + /api/dataset-storages/s3/check-for-records/: + post: + description: Checks for existence of records matching the file pattern in the bucket/prefix + operationId: api_dataset_storages_s3_check_for_records_create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GCSDatasetStorageRequest' + $ref: '#/components/schemas/S3DatasetStorageRequest' application/x-www-form-urlencoded: schema: - $ref: '#/components/schemas/GCSDatasetStorageRequest' + $ref: '#/components/schemas/S3DatasetStorageRequest' multipart/form-data: schema: - $ref: '#/components/schemas/GCSDatasetStorageRequest' + $ref: '#/components/schemas/S3DatasetStorageRequest' required: true - security: - - Token: [] responses: '201': content: application/json: schema: - $ref: '#/components/schemas/GCSDatasetStorage' + $ref: '#/components/schemas/S3DatasetStorage' description: '' - /api/dataset-storages/s3/: - get: - operationId: api_dataset_storages_s3_list - description: Get a list of all S3 import storage connections. - summary: Get all import storage - parameters: - - in: query - name: dataset - schema: - type: integer - description: Dataset ID - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - tags: - - 'Dataset Storage: S3' security: - - Token: [] - responses: - '200': - content: - application/json: - schema: - type: array - items: - $ref: '#/components/schemas/S3DatasetStorage' - description: '' - post: - operationId: api_dataset_storages_s3_create - description: Create a new S3 import storage connection. - summary: Create import storage + - Token: [] + summary: Check for records given the file pattern tags: - - 'Dataset Storage: S3' + - 'Dataset Storage: S3' + /api/dataset-storages/s3/validate/: + post: + description: Validate a specific S3 import storage connection. + operationId: api_dataset_storages_s3_validate_create requestBody: content: application/json: @@ -1669,8 +1938,6 @@ paths: schema: $ref: '#/components/schemas/S3DatasetStorageRequest' required: true - security: - - Token: [] responses: '201': content: @@ -1678,21 +1945,38 @@ paths: schema: $ref: '#/components/schemas/S3DatasetStorage' description: '' + security: + - Token: [] + summary: Validate import storage + tags: + - 'Dataset Storage: S3' /api/dataset-storages/s3/{id}/: + delete: + description: Delete a specific S3 import storage connection. + operationId: api_dataset_storages_s3_destroy + parameters: + - in: path + name: id + required: true + schema: + type: integer + responses: + '204': + description: No response body + security: + - Token: [] + summary: Delete import storage + tags: + - 'Dataset Storage: S3' get: - operationId: api_dataset_storages_s3_retrieve description: Get a specific S3 import storage connection. - summary: Get import storage + operationId: api_dataset_storages_s3_retrieve parameters: - - in: path - name: id - schema: - type: integer - required: true - tags: - - 'Dataset Storage: S3' - security: - - Token: [] + - in: path + name: id + required: true + schema: + type: integer responses: '200': content: @@ -1700,18 +1984,20 @@ paths: schema: $ref: '#/components/schemas/S3DatasetStorage' description: '' + security: + - Token: [] + summary: Get import storage + tags: + - 'Dataset Storage: S3' patch: - operationId: api_dataset_storages_s3_partial_update description: Update a specific S3 import storage connection. - summary: Update import storage + operationId: api_dataset_storages_s3_partial_update parameters: - - in: path - name: id - schema: - type: integer - required: true - tags: - - 'Dataset Storage: S3' + - in: path + name: id + required: true + schema: + type: integer requestBody: content: application/json: @@ -1723,8 +2009,6 @@ paths: multipart/form-data: schema: $ref: '#/components/schemas/PatchedS3DatasetStorageRequest' - security: - - Token: [] responses: '200': content: @@ -1732,54 +2016,39 @@ paths: schema: $ref: '#/components/schemas/S3DatasetStorage' description: '' - delete: - operationId: api_dataset_storages_s3_destroy - description: Delete a specific S3 import storage connection. - summary: Delete import storage - parameters: - - in: path - name: id - schema: - type: integer - required: true - tags: - - 'Dataset Storage: S3' security: - - Token: [] - responses: - '204': - description: No response body + - Token: [] + summary: Update import storage + tags: + - 'Dataset Storage: S3' /api/dataset-storages/s3/{id}/columns/: get: - operationId: api_dataset_storages_s3_columns_retrieve description: Retrieves column names from users JSON/blob data in bucket - summary: Get data column names from storage + operationId: api_dataset_storages_s3_columns_retrieve parameters: - - in: path - name: id - schema: - type: integer - required: true - tags: - - 'Dataset Storage: S3' - security: - - Token: [] + - in: path + name: id + required: true + schema: + type: integer responses: '200': description: No response body + security: + - Token: [] + summary: Get data column names from storage + tags: + - 'Dataset Storage: S3' /api/dataset-storages/s3/{id}/sync/: post: - operationId: api_dataset_storages_s3_sync_create description: Sync tasks from an S3 import storage connection. - summary: Sync import storage + operationId: api_dataset_storages_s3_sync_create parameters: - - in: path - name: id - schema: - type: integer - required: true - tags: - - 'Dataset Storage: S3' + - in: path + name: id + required: true + schema: + type: integer requestBody: content: application/json: @@ -1792,8 +2061,6 @@ paths: schema: $ref: '#/components/schemas/S3DatasetStorageRequest' required: true - security: - - Token: [] responses: '200': content: @@ -1801,107 +2068,51 @@ paths: schema: $ref: '#/components/schemas/S3DatasetStorage' description: '' - /api/dataset-storages/s3/check-for-records/: - post: - operationId: api_dataset_storages_s3_check_for_records_create - description: Checks for existence of records matching the file pattern in the - bucket/prefix - summary: Check for records given the file pattern - tags: - - 'Dataset Storage: S3' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/S3DatasetStorageRequest' - application/x-www-form-urlencoded: - schema: - $ref: '#/components/schemas/S3DatasetStorageRequest' - multipart/form-data: - schema: - $ref: '#/components/schemas/S3DatasetStorageRequest' - required: true security: - - Token: [] - responses: - '201': - content: - application/json: - schema: - $ref: '#/components/schemas/S3DatasetStorage' - description: '' - /api/dataset-storages/s3/validate/: - post: - operationId: api_dataset_storages_s3_validate_create - description: Validate a specific S3 import storage connection. - summary: Validate import storage + - Token: [] + summary: Sync import storage tags: - - 'Dataset Storage: S3' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/S3DatasetStorageRequest' - application/x-www-form-urlencoded: - schema: - $ref: '#/components/schemas/S3DatasetStorageRequest' - multipart/form-data: - schema: - $ref: '#/components/schemas/S3DatasetStorageRequest' - required: true - security: - - Token: [] - responses: - '201': - content: - application/json: - schema: - $ref: '#/components/schemas/S3DatasetStorage' - description: '' + - 'Dataset Storage: S3' /api/dataset-storages/types/: get: - operationId: api_dataset_storages_types_retrieve description: Retrieve a list of the dataset storages types. - summary: List all dataset storages types - tags: - - Storage - security: - - Token: [] + operationId: api_dataset_storages_types_retrieve responses: '200': - description: 'A list of dataset storages types {''name'': name, ''title'': - title}.' + description: 'A list of dataset storages types {''name'': name, ''title'': title}.' + security: + - Token: [] + summary: List all dataset storages types + tags: + - Storage /api/datasets/: get: - operationId: api_datasets_list description: List all datasets. - summary: List datasets + operationId: api_datasets_list parameters: - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - tags: - - Datasets - security: - - Token: [] + - description: Which field to use when ordering the results. + in: query + name: ordering + required: false + schema: + type: string responses: '200': content: application/json: schema: - type: array items: $ref: '#/components/schemas/Dataset' + type: array description: '' + security: + - Token: [] + summary: List datasets + tags: + - Datasets post: - operationId: api_datasets_create description: Create a new dataset. - summary: Create dataset - tags: - - Datasets + operationId: api_datasets_create requestBody: content: application/json: @@ -1914,8 +2125,6 @@ paths: schema: $ref: '#/components/schemas/DatasetRequest' required: true - security: - - Token: [] responses: '201': content: @@ -1923,323 +2132,132 @@ paths: schema: $ref: '#/components/schemas/Dataset' description: '' - /api/datasets/{id}/: + security: + - Token: [] + summary: Create dataset + tags: + - Datasets + /api/datasets/columns: get: - operationId: api_datasets_retrieve - description: Retrieve a specific dataset. - summary: Get dataset + description: Retrieve the data explorer columns available for a specific Dataset. + operationId: api_datasets_columns_retrieve parameters: - - in: path - name: id - schema: - type: string - required: true - tags: - - Datasets - security: - - Token: [] + - description: Dataset ID + in: query + name: dataset + schema: + type: integer responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Dataset' - description: '' - put: - operationId: api_datasets_update - description: Overwrite a specific dataset by ID. - summary: Put dataset - parameters: - - in: path - name: id - schema: - type: string - required: true - tags: - - Datasets - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/DatasetRequest' - application/x-www-form-urlencoded: - schema: - $ref: '#/components/schemas/DatasetRequest' - multipart/form-data: - schema: - $ref: '#/components/schemas/DatasetRequest' - required: true + description: No response body security: - - Token: [] - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Dataset' - description: '' + - Token: [] + summary: Get data explorer columns + tags: + - Data Explorer + /api/datasets/import: patch: - operationId: api_datasets_partial_update - description: Update a specific dataset by ID. - summary: Update dataset + description: Export Candidate task for a specific dataset to project. + operationId: api_datasets_import_partial_update parameters: - - in: path - name: id - schema: - type: string - required: true - tags: - - Datasets - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/PatchedDatasetRequest' - application/x-www-form-urlencoded: - schema: - $ref: '#/components/schemas/PatchedDatasetRequest' - multipart/form-data: - schema: - $ref: '#/components/schemas/PatchedDatasetRequest' - security: - - Token: [] + - description: Job ID to start or cancel + in: query + name: job_id + schema: + type: integer + - description: 'Signal type: start or cancel' + in: query + name: signal + schema: + type: string responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Dataset' - description: '' - delete: - operationId: api_datasets_destroy - description: Delete a dataset by ID - summary: Delete dataset - parameters: - - in: path - name: id - schema: - type: string - required: true - tags: - - Datasets - security: - - Token: [] - responses: - '204': description: No response body - /api/datasets/{id}/members: - get: - operationId: api_datasets_members_list - description: Retrieve the members for a specific dataset. - summary: Get datasets members - parameters: - - in: path - name: id - schema: - type: integer - required: true - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - tags: - - Datasets - security: - - Token: [] - responses: - '200': - content: - application/json: - schema: - type: array - items: - $ref: '#/components/schemas/DatasetMember' - description: '' - post: - operationId: api_datasets_members_create - description: Add a member to a specific dataset. - summary: Add dataset member - parameters: - - in: path - name: id - schema: - type: integer - required: true - tags: - - Datasets - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/DatasetMemberRequest' - application/x-www-form-urlencoded: - schema: - $ref: '#/components/schemas/DatasetMemberRequest' - multipart/form-data: - schema: - $ref: '#/components/schemas/DatasetMemberRequest' - required: true - security: - - Token: [] - responses: - '201': - content: - application/json: - schema: - $ref: '#/components/schemas/DatasetMember' - description: '' - delete: - operationId: api_datasets_members_destroy - description: Remove a member from a specific dataset. - summary: Remove member from dataset - parameters: - - in: path - name: id - schema: - type: integer - required: true - - in: query - name: project_member - schema: - type: integer - description: A unique integer value identifying this dataset member. - tags: - - Datasets security: - - Token: [] - responses: - '204': - description: No response body - /api/datasets/columns: - get: - operationId: api_datasets_columns_retrieve - description: Retrieve the data explorer columns available for a specific Dataset. - summary: Get data explorer columns - parameters: - - in: query - name: dataset - schema: - type: integer - description: Dataset ID + - Token: [] + summary: Export candidate tasks to project tags: - - Data Explorer - security: - - Token: [] - responses: - '200': - description: No response body - /api/datasets/import: + - Datasets post: + description: "\n Export Candidate task for a specific dataset to project.\n " operationId: api_datasets_import_create - description: "\n Export Candidate task for a specific dataset to project.\n\ - \ " - summary: Export candidate tasks to project parameters: - - in: query - name: additional_filters - schema: - type: object - additionalProperties: {} - description: Additional filters like page and page_size to limit export - - in: query - name: dataset - schema: - type: integer - description: Dataset ID - - in: query - name: excluded - schema: - type: object - additionalProperties: {} - description: Candidate tasks IDs to exclude from export - - in: query - name: included - schema: - type: object - additionalProperties: {} - description: Candidate tasks IDs from vectordb database - - in: query - name: project - schema: - type: integer - description: Project ID - - in: query - name: view - schema: - type: integer - description: View ID - tags: - - Data Explorer - security: - - Token: [] + - description: Additional filters like page and page_size to limit export + in: query + name: additional_filters + schema: + additionalProperties: {} + type: object + - description: Dataset ID + in: query + name: dataset + schema: + type: integer + - description: Candidate tasks IDs to exclude from export + in: query + name: excluded + schema: + additionalProperties: {} + type: object + - description: Candidate tasks IDs from vectordb database + in: query + name: included + schema: + additionalProperties: {} + type: object + - description: Project ID + in: query + name: project + schema: + type: integer + - description: View ID + in: query + name: view + schema: + type: integer responses: '200': description: No response body - patch: - operationId: api_datasets_import_partial_update - description: Export Candidate task for a specific dataset to project. + security: + - Token: [] summary: Export candidate tasks to project - parameters: - - in: query - name: job_id - schema: - type: integer - description: Job ID to start or cancel - - in: query - name: signal - schema: - type: string - description: 'Signal type: start or cancel' tags: - - Datasets - security: - - Token: [] - responses: - '200': - description: No response body + - Data Explorer /api/datasets/tasks: get: + description: "\n Retrieve a list of Data Explorer tasks with pagination for a specific view or dataset, by using filters and ordering.\n " operationId: api_datasets_tasks_retrieve - description: "\n Retrieve a list of Data Explorer tasks with pagination for\ - \ a specific view or dataset, by using filters and ordering.\n " - summary: Get Data Explorer tasks list parameters: - - in: query - name: dataset - schema: - type: integer - description: Dataset ID - - in: query - name: max_threshold - schema: - type: number - description: Maximum threshold for candidate score - - in: query - name: min_threshold - schema: - type: number - description: Minimum threshold for candidate score - - in: query - name: page - schema: - type: integer - description: Page number in request - - in: query - name: page_size - schema: - type: integer - description: Number of tasks to return in response - - in: query - name: view - schema: - type: integer - description: View ID - tags: - - Data Explorer - security: - - Token: [] + - description: Dataset ID + in: query + name: dataset + schema: + type: integer + - description: Maximum threshold for candidate score + in: query + name: max_threshold + schema: + type: number + - description: Minimum threshold for candidate score + in: query + name: min_threshold + schema: + type: number + - description: Page number in request + in: query + name: page + schema: + type: integer + - description: Number of tasks to return in response + in: query + name: page_size + schema: + type: integer + - description: View ID + in: query + name: view + schema: + type: integer responses: '200': content: @@ -2247,65 +2265,66 @@ paths: schema: $ref: '#/components/schemas/DatasetView' description: '' + security: + - Token: [] + summary: Get Data Explorer tasks list + tags: + - Data Explorer /api/datasets/tasks/metadata: get: + description: "\n Retrieve Candidate task metadata for a specific dataset, by using candidate_task_id or weaviate_id.\n " operationId: api_datasets_tasks_metadata_retrieve - description: "\n Retrieve Candidate task metadata for a specific dataset,\ - \ by using candidate_task_id or weaviate_id.\n " - summary: Get Candidate task metadata parameters: - - in: query - name: candidate_task_id - schema: - type: string - description: Candidate task path in the bucket - - in: query - name: dataset - schema: - type: integer - description: Dataset ID - - in: query - name: vectordb_id - schema: - type: string - description: Task ID from vectordb database - tags: - - Data Explorer - security: - - Token: [] + - description: Candidate task path in the bucket + in: query + name: candidate_task_id + schema: + type: string + - description: Dataset ID + in: query + name: dataset + schema: + type: integer + - description: Task ID from vectordb database + in: query + name: vectordb_id + schema: + type: string responses: '200': description: No response body + security: + - Token: [] + summary: Get Candidate task metadata + tags: + - Data Explorer /api/datasets/views/: get: - operationId: api_datasets_views_list description: List all views for a specific dataset. - summary: List dataset views + operationId: api_datasets_views_list parameters: - - in: query - name: dataset - schema: - type: integer - description: Dataset ID - tags: - - Datasets - security: - - Token: [] + - description: Dataset ID + in: query + name: dataset + schema: + type: integer responses: '200': content: application/json: schema: - type: array items: $ref: '#/components/schemas/DatasetView' + type: array description: '' + security: + - Token: [] + summary: List dataset views + tags: + - Datasets post: - operationId: api_datasets_views_create description: Create a view for a specific dataset. - summary: Create dataset view - tags: - - Datasets + operationId: api_datasets_views_create requestBody: content: application/json: @@ -2318,8 +2337,6 @@ paths: schema: $ref: '#/components/schemas/DatasetViewRequest' required: true - security: - - Token: [] responses: '201': content: @@ -2327,22 +2344,52 @@ paths: schema: $ref: '#/components/schemas/DatasetView' description: '' + security: + - Token: [] + summary: Create dataset view + tags: + - Datasets + /api/datasets/views/reset/: + delete: + description: Reset all views for a specific dataset. + operationId: api_datasets_views_reset_destroy + responses: + '204': + description: No response body + security: + - Token: [] + summary: Reset dataset views + tags: + - Datasets /api/datasets/views/{id}/: + delete: + description: Delete a specific view by ID. + operationId: api_datasets_views_destroy + parameters: + - description: View ID + in: path + name: id + required: true + schema: + type: string + responses: + '204': + description: No response body + security: + - Token: [] + summary: Delete dataset view + tags: + - Datasets get: - operationId: api_datasets_views_retrieve description: Get the details about a specific view in the data manager - summary: Get dataset view details + operationId: api_datasets_views_retrieve parameters: - - in: path - name: id - schema: - type: string - description: View ID - required: true - tags: - - Datasets - security: - - Token: [] + - description: View ID + in: path + name: id + required: true + schema: + type: string responses: '200': content: @@ -2350,20 +2397,54 @@ paths: schema: $ref: '#/components/schemas/DatasetView' description: '' - put: - operationId: api_datasets_views_update - description: Overwrite view data with updated filters and other information - for a specific dataset. - summary: Put dataset view - parameters: - - in: path - name: id - schema: - type: string - description: View ID - required: true + security: + - Token: [] + summary: Get dataset view details + tags: + - Datasets + patch: + description: Update view data with additional filters and other information for a specific dataset. + operationId: api_datasets_views_partial_update + parameters: + - description: View ID + in: path + name: id + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedDatasetViewRequest' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/PatchedDatasetViewRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedDatasetViewRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/DatasetView' + description: '' + security: + - Token: [] + summary: Update dataset view tags: - - Datasets + - Datasets + put: + description: Overwrite view data with updated filters and other information for a specific dataset. + operationId: api_datasets_views_update + parameters: + - description: View ID + in: path + name: id + required: true + schema: + type: string requestBody: content: application/json: @@ -2376,8 +2457,6 @@ paths: schema: $ref: '#/components/schemas/DatasetViewRequest' required: true - security: - - Token: [] responses: '200': content: @@ -2385,751 +2464,728 @@ paths: schema: $ref: '#/components/schemas/DatasetView' description: '' - patch: - operationId: api_datasets_views_partial_update - description: Update view data with additional filters and other information - for a specific dataset. - summary: Update dataset view + security: + - Token: [] + summary: Put dataset view + tags: + - Datasets + /api/datasets/{id}/: + delete: + description: Delete a dataset by ID + operationId: api_datasets_destroy parameters: - - in: path - name: id - schema: - type: string - description: View ID - required: true + - in: path + name: id + required: true + schema: + type: string + responses: + '204': + description: No response body + security: + - Token: [] + summary: Delete dataset + tags: + - Datasets + get: + description: Retrieve a specific dataset. + operationId: api_datasets_retrieve + parameters: + - in: path + name: id + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Dataset' + description: '' + security: + - Token: [] + summary: Get dataset tags: - - Datasets + - Datasets + patch: + description: Update a specific dataset by ID. + operationId: api_datasets_partial_update + parameters: + - in: path + name: id + required: true + schema: + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/PatchedDatasetViewRequest' + $ref: '#/components/schemas/PatchedDatasetRequest' application/x-www-form-urlencoded: schema: - $ref: '#/components/schemas/PatchedDatasetViewRequest' + $ref: '#/components/schemas/PatchedDatasetRequest' multipart/form-data: schema: - $ref: '#/components/schemas/PatchedDatasetViewRequest' - security: - - Token: [] + $ref: '#/components/schemas/PatchedDatasetRequest' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/DatasetView' + $ref: '#/components/schemas/Dataset' description: '' - delete: - operationId: api_datasets_views_destroy - description: Delete a specific view by ID. - summary: Delete dataset view + security: + - Token: [] + summary: Update dataset + tags: + - Datasets + put: + description: Overwrite a specific dataset by ID. + operationId: api_datasets_update parameters: - - in: path - name: id - schema: - type: string - description: View ID + - in: path + name: id + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DatasetRequest' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/DatasetRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/DatasetRequest' required: true - tags: - - Datasets + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Dataset' + description: '' security: - - Token: [] + - Token: [] + summary: Put dataset + tags: + - Datasets + /api/datasets/{id}/members: + delete: + description: Remove a member from a specific dataset. + operationId: api_datasets_members_destroy + parameters: + - in: path + name: id + required: true + schema: + type: integer + - description: A unique integer value identifying this dataset member. + in: query + name: project_member + schema: + type: integer responses: '204': description: No response body - /api/datasets/views/reset/: - delete: - operationId: api_datasets_views_reset_destroy - description: Reset all views for a specific dataset. - summary: Reset dataset views + security: + - Token: [] + summary: Remove member from dataset tags: - - Datasets + - Datasets + get: + description: Retrieve the members for a specific dataset. + operationId: api_datasets_members_list + parameters: + - in: path + name: id + required: true + schema: + type: integer + - description: Which field to use when ordering the results. + in: query + name: ordering + required: false + schema: + type: string + responses: + '200': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/DatasetMember' + type: array + description: '' security: - - Token: [] + - Token: [] + summary: Get datasets members + tags: + - Datasets + post: + description: Add a member to a specific dataset. + operationId: api_datasets_members_create + parameters: + - in: path + name: id + required: true + schema: + type: integer + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DatasetMemberRequest' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/DatasetMemberRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/DatasetMemberRequest' + required: true responses: - '204': - description: No response body + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/DatasetMember' + description: '' + security: + - Token: [] + summary: Add dataset member + tags: + - Datasets /api/dm/actions/: get: + description: Retrieve all the registered actions with descriptions that data manager can use. operationId: api_dm_actions_retrieve - description: Retrieve all the registered actions with descriptions that data - manager can use. - summary: Get actions parameters: - - in: query - name: project - schema: - type: integer - description: Project ID - required: true - tags: - - Data Manager - security: - - Token: [] + - description: Project ID + in: query + name: project + required: true + schema: + type: integer responses: '200': content: application/json: + examples: + Response: + summary: response + value: + - dialog: + form: null + text: Create annotations from predictions using selected predictions set for each selected task. Your account will be assigned as an owner to those annotations. + title: Create Annotations From Predictions + type: confirm + experimental: false + id: predictions_to_annotations + order: 91 + permission: tasks.change + title: Create Annotations From Predictions schema: - type: array - title: Action list description: List of available actions items: - type: object - title: Action properties: - id: - type: string - title: Action ID - title: - type: string - title: Title - order: - type: integer - title: Order - permission: - type: string - title: Permission - experimental: - type: boolean - title: Experimental dialog: - type: object - title: Dialog properties: - title: - type: string - title: Title + form: + items: + type: object nullable: true + title: Form + type: array text: - type: string - title: Text nullable: true - type: + title: Text type: string - title: Type + title: nullable: true - form: - type: array - title: Form - items: - type: object + title: Title + type: string + type: nullable: true - examples: - Response: - value: - - id: predictions_to_annotations - title: Create Annotations From Predictions - order: 91 - permission: tasks.change - experimental: false - dialog: - title: Create Annotations From Predictions - text: Create annotations from predictions using selected predictions - set for each selected task. Your account will be assigned - as an owner to those annotations. - type: confirm - form: null - summary: response + title: Type + type: string + title: Dialog + type: object + experimental: + title: Experimental + type: boolean + id: + title: Action ID + type: string + order: + title: Order + type: integer + permission: + title: Permission + type: string + title: + title: Title + type: string + title: Action + type: object + title: Action list + type: array description: Actions retrieved successfully - x-fern-sdk-group-name: actions - x-fern-sdk-method-name: list + security: + - Token: [] + summary: Get actions + tags: + - Data Manager x-fern-audiences: - - public + - public + x-fern-sdk-group-name: actions + x-fern-sdk-method-name: list post: + description: 'Perform a Data Manager action with the selected tasks and filters. Note: More complex actions require additional parameters in the request body. Call `GET api/actions?project=` to explore them.
Example: `GET api/actions?id=delete_tasks&project=1`' operationId: api_dm_actions_create - description: 'Perform a Data Manager action with the selected tasks and filters. - Note: More complex actions require additional parameters in the request body. - Call `GET api/actions?project=` to explore them.
Example: `GET api/actions?id=delete_tasks&project=1`' - summary: Post actions parameters: - - in: query - name: id - schema: - type: string - enum: - - delete_annotators - - delete_ground_truths - - delete_reviewers - - delete_tasks - - delete_tasks_annotations - - delete_tasks_predictions - - delete_tasks_reviews - - predictions_to_annotations - - remove_duplicates - - retrieve_tasks_predictions - description: Action name ID, see the full list of actions in the `GET api/actions` - request - required: true - - in: query - name: project - schema: - type: integer - description: Project ID - required: true - - in: query - name: view - schema: - type: integer - description: View ID (optional, it has higher priority than filters, selectedItems - and ordering from the request body payload) - tags: - - Data Manager + - description: Action name ID, see the full list of actions in the `GET api/actions` request + in: query + name: id + required: true + schema: + enum: + - delete_annotators + - delete_ground_truths + - delete_reviewers + - delete_tasks + - delete_tasks_annotations + - delete_tasks_predictions + - delete_tasks_reviews + - predictions_to_annotations + - remove_duplicates + - retrieve_tasks_predictions + type: string + - description: Project ID + in: query + name: project + required: true + schema: + type: integer + - description: View ID (optional, it has higher priority than filters, selectedItems and ordering from the request body payload) + in: query + name: view + schema: + type: integer requestBody: content: application/json: schema: - type: object + description: Data payload containing task filters, selected task items, and ordering + example: + filters: + conjunction: or + items: + - filter: filter:tasks:id + operator: greater + type: Number + value: 123 + ordering: + - tasks:total_annotations + selectedItems: + all: true + excluded: + - 124 + - 125 + - 126 properties: filters: - type: object + description: 'Filters to apply on tasks. You can use [the helper class `Filters` from this page](https://labelstud.io/sdk/data_manager.html) to create Data Manager Filters.
Example: `{"conjunction": "or", "items": [{"filter": "filter:tasks:completed_at", "operator": "greater", "type": "Datetime", "value": "2021-01-01T00:00:00.000Z"}]}`' properties: conjunction: - type: string + description: Logical conjunction for the filters. This conjunction (either "or" or "and") will be applied to all items in the filters list. It is not possible to combine "or" and "and" within one list of filters. All filters will be either combined with "or" or with "and", but not a mix of both. enum: - - or - - and - description: Logical conjunction for the filters. This conjunction - (either "or" or "and") will be applied to all items in the - filters list. It is not possible to combine "or" and "and" - within one list of filters. All filters will be either combined - with "or" or with "and", but not a mix of both. + - or + - and + type: string items: - type: array + description: List of filter items items: - type: object + example: + filter: filter:tasks:id + operator: greater + type: Number + value: 123 properties: filter: - type: string + description: 'Filter identifier, it should start with `filter:tasks:` prefix, e.g. `filter:tasks:agreement`. For `task.data` fields it may look like `filter:tasks:data.field_name`. If you need more info about columns, check the [Get data manager columns](#tag/Data-Manager/operation/api_dm_columns_list) API endpoint. Possible values:
  • `filter:tasks:agreement`
    (Number) Agreement for annotation results for a specific task (Enterprise only)

  • `filter:tasks:annotations_results`
    (String) Annotation results for the tasks

  • `filter:tasks:annotators`
    (List) Annotators that completed the task (Community). Can include assigned annotators (Enterprise only). Important note: the filter `type` should be List, but the filter `value` is integer

  • `filter:tasks:cancelled_annotations`
    (Number) Number of cancelled or skipped annotations for the task

  • `filter:tasks:comments`
    (Number) Number of comments in a task

  • `filter:tasks:completed_at`
    (Datetime) Time when a task was fully annotated

  • `filter:tasks:created_at`
    (Datetime) Time the task was created at

  • `filter:tasks:file_upload`
    (String) Name of the file uploaded to create the tasks

  • `filter:tasks:ground_truth`
    (Boolean) Ground truth status of the tasks

  • `filter:tasks:id`
    (Number) Task ID

  • `filter:tasks:inner_id`
    (Number) Task Inner ID, it starts from 1 for all projects

  • `filter:tasks:predictions_model_versions`
    (String) Model version used for the predictions

  • `filter:tasks:predictions_results`
    (String) Prediction results for the tasks

  • `filter:tasks:predictions_score`
    (Number) Prediction score for the task

  • `filter:tasks:reviewed`
    (Boolean) Whether the tasks have been reviewed (Enterprise only)

  • `filter:tasks:reviewers`
    (String) Reviewers that reviewed the task, or assigned reviewers (Enterprise only). Important note: the filter `type` should be List, but the filter `value` is integer

  • `filter:tasks:reviews_accepted`
    (Number) Number of annotations accepted for a task in review (Enterprise only)

  • `filter:tasks:reviews_rejected`
    (Number) Number of annotations rejected for a task in review (Enterprise only)

  • `filter:tasks:total_annotations`
    (Number) Total number of annotations on a task

  • `filter:tasks:total_predictions`
    (Number) Total number of predictions for the task

  • `filter:tasks:unresolved_comment_count`
    (Number) Number of unresolved comments in a task

  • `filter:tasks:updated_at`
    (Datetime) Time the task was updated at (e.g. new annotation was created, review added, etc)
    • ' enum: - - filter:tasks:agreement - - filter:tasks:annotations_results - - filter:tasks:annotators - - filter:tasks:cancelled_annotations - - filter:tasks:comments - - filter:tasks:completed_at - - filter:tasks:created_at - - filter:tasks:file_upload - - filter:tasks:ground_truth - - filter:tasks:id - - filter:tasks:inner_id - - filter:tasks:predictions_model_versions - - filter:tasks:predictions_results - - filter:tasks:predictions_score - - filter:tasks:reviewed - - filter:tasks:reviewers - - filter:tasks:reviews_accepted - - filter:tasks:reviews_rejected - - filter:tasks:total_annotations - - filter:tasks:total_predictions - - filter:tasks:unresolved_comment_count - - filter:tasks:updated_at - description: 'Filter identifier, it should start with - `filter:tasks:` prefix, e.g. `filter:tasks:agreement`. - For `task.data` fields it may look like `filter:tasks:data.field_name`. - If you need more info about columns, check the [Get - data manager columns](#tag/Data-Manager/operation/api_dm_columns_list) - API endpoint. Possible values:
  • `filter:tasks:agreement`
    - (Number) Agreement for annotation results for a specific - task (Enterprise only)

  • `filter:tasks:annotations_results`
    - (String) Annotation results for the tasks

  • `filter:tasks:annotators`
    - (List) Annotators that completed the task (Community). - Can include assigned annotators (Enterprise only). Important - note: the filter `type` should be List, but the filter - `value` is integer

  • `filter:tasks:cancelled_annotations`
    - (Number) Number of cancelled or skipped annotations - for the task

  • `filter:tasks:comments`
    - (Number) Number of comments in a task

  • `filter:tasks:completed_at`
    - (Datetime) Time when a task was fully annotated

  • `filter:tasks:created_at`
    - (Datetime) Time the task was created at

  • `filter:tasks:file_upload`
    - (String) Name of the file uploaded to create the tasks

  • `filter:tasks:ground_truth`
    - (Boolean) Ground truth status of the tasks

  • `filter:tasks:id`
    - (Number) Task ID

  • `filter:tasks:inner_id`
    - (Number) Task Inner ID, it starts from 1 for all projects

  • `filter:tasks:predictions_model_versions`
    - (String) Model version used for the predictions

  • `filter:tasks:predictions_results`
    - (String) Prediction results for the tasks

  • `filter:tasks:predictions_score`
    - (Number) Prediction score for the task

  • `filter:tasks:reviewed`
    - (Boolean) Whether the tasks have been reviewed (Enterprise - only)

  • `filter:tasks:reviewers`
    (String) - Reviewers that reviewed the task, or assigned reviewers - (Enterprise only). Important note: the filter `type` - should be List, but the filter `value` is integer

  • `filter:tasks:reviews_accepted`
    - (Number) Number of annotations accepted for a task in - review (Enterprise only)

  • `filter:tasks:reviews_rejected`
    - (Number) Number of annotations rejected for a task in - review (Enterprise only)

  • `filter:tasks:total_annotations`
    - (Number) Total number of annotations on a task

  • `filter:tasks:total_predictions`
    - (Number) Total number of predictions for the task

  • `filter:tasks:unresolved_comment_count`
    - (Number) Number of unresolved comments in a task

  • `filter:tasks:updated_at`
    - (Datetime) Time the task was updated at (e.g. new annotation - was created, review added, etc)
    • ' - operator: + - filter:tasks:agreement + - filter:tasks:annotations_results + - filter:tasks:annotators + - filter:tasks:cancelled_annotations + - filter:tasks:comments + - filter:tasks:completed_at + - filter:tasks:created_at + - filter:tasks:file_upload + - filter:tasks:ground_truth + - filter:tasks:id + - filter:tasks:inner_id + - filter:tasks:predictions_model_versions + - filter:tasks:predictions_results + - filter:tasks:predictions_score + - filter:tasks:reviewed + - filter:tasks:reviewers + - filter:tasks:reviews_accepted + - filter:tasks:reviews_rejected + - filter:tasks:total_annotations + - filter:tasks:total_predictions + - filter:tasks:unresolved_comment_count + - filter:tasks:updated_at type: string + operator: + description: 'Filter operator. Possible values:
  • `contains`
    Contains

  • `ends_with`
    Ends with

  • `equal`
    Equal to

  • `exists`
    Exists

  • `greater`
    Greater than

  • `greater_or_equal`
    Greater than or equal to

  • `in`
    Is between min and max values, so the filter `value` should be e.g. `{"min": 1, "max": 7}`

  • `less`
    Less than

  • `less_or_equal`
    Less than or equal to

  • `not_contains`
    Does not contain

  • `not_equal`
    Not equal to

  • `not_exists`
    Does not exist

  • `not_in`
    Is not between min and max values, so the filter `value` should be e.g. `{"min": 1, "max": 7}`

  • `starts_with`
    Starts with
    • ' enum: - - contains - - ends_with - - equal - - exists - - greater - - greater_or_equal - - in - - less - - less_or_equal - - not_contains - - not_equal - - not_exists - - not_in - - starts_with - description: 'Filter operator. Possible values:
  • `contains`
    - Contains

  • `ends_with`
    Ends with

  • `equal`
    - Equal to

  • `exists`
    Exists

  • `greater`
    - Greater than

  • `greater_or_equal`
    Greater - than or equal to

  • `in`
    Is between min - and max values, so the filter `value` should be e.g. - `{"min": 1, "max": 7}`

  • `less`
    Less than

  • `less_or_equal`
    - Less than or equal to

  • `not_contains`
    - Does not contain

  • `not_equal`
    Not equal - to

  • `not_exists`
    Does not exist

  • `not_in`
    - Is not between min and max values, so the filter `value` - should be e.g. `{"min": 1, "max": 7}`

  • `starts_with`
    - Starts with
    • ' + - contains + - ends_with + - equal + - exists + - greater + - greater_or_equal + - in + - less + - less_or_equal + - not_contains + - not_equal + - not_exists + - not_in + - starts_with + type: string type: + description: Type of the filter value. Possible values:
  • `Boolean`
    Boolean

  • `Datetime`
    Datetime string in `strftime('%Y-%m-%dT%H:%M:%S.%fZ')` format

  • `List`
    List of items

  • `Number`
    Float or Integer

  • `String`
    String

  • `Unknown`
    Unknown is explicitly converted to string format
    • type: string - description: Type of the filter value. Possible values:
  • `Boolean`
    - Boolean

  • `Datetime`
    Datetime string in - `strftime('%Y-%m-%dT%H:%M:%S.%fZ')` format

  • `List`
    - List of items

  • `Number`
    Float or Integer

  • `String`
    - String

  • `Unknown`
    Unknown is explicitly - converted to string format
    • value: - type: object - oneOf: - - type: string - title: String - description: String - - type: integer - title: Integer - description: Integer - - type: number - title: Float - format: float - description: Float - - type: boolean - title: Boolean - description: Boolean - - type: object - title: Dictionary - description: Dictionary is used for some operator types, - e.g. `in` and `not_in` - - type: object - title: List - description: List of strings or integers description: Value to filter by + oneOf: + - description: String + title: String + type: string + - description: Integer + title: Integer + type: integer + - description: Float + format: float + title: Float + type: number + - description: Boolean + title: Boolean + type: boolean + - description: Dictionary is used for some operator types, e.g. `in` and `not_in` + title: Dictionary + type: object + - description: List of strings or integers + title: List + type: object + type: object required: - - filter - - operator - - type - - value - example: - filter: filter:tasks:id - operator: greater - type: Number - value: 123 - description: List of filter items + - filter + - operator + - type + - value + type: object + type: array required: - - conjunction - - items - description: 'Filters to apply on tasks. You can use [the helper - class `Filters` from this page](https://labelstud.io/sdk/data_manager.html) - to create Data Manager Filters.
    Example: `{"conjunction": "or", - "items": [{"filter": "filter:tasks:completed_at", "operator": - "greater", "type": "Datetime", "value": "2021-01-01T00:00:00.000Z"}]}`' - selectedItems: + - conjunction + - items type: object - required: - - all - description: 'Task selection by IDs. If filters are applied, the - selection will be applied to the filtered tasks.If "all" is `false`, - `"included"` must be used. If "all" is `true`, `"excluded"` must - be used.
    Examples: `{"all": false, "included": [1, 2, 3]}` - or `{"all": true, "excluded": [4, 5]}`' - oneOf: - - title: 'all: false' - type: object - properties: - all: - type: boolean - enum: - - false - description: No tasks are selected - included: - type: array - items: - type: integer - description: List of included task IDs - required: - - all - - title: 'all: true' - type: object - properties: - all: - type: boolean - enum: - - true - description: All tasks are selected - excluded: - type: array - items: - type: integer - description: List of excluded task IDs - required: - - all ordering: - type: array + description: List of fields to order by. Fields are similar to filters but without the `filter:` prefix. To reverse the order, add a minus sign before the field name, e.g. `-tasks:created_at`. items: - type: string enum: - - tasks:agreement - - tasks:annotations_results - - tasks:annotators - - tasks:cancelled_annotations - - tasks:comments - - tasks:completed_at - - tasks:created_at - - tasks:file_upload - - tasks:ground_truth - - tasks:id - - tasks:inner_id - - tasks:predictions_model_versions - - tasks:predictions_results - - tasks:predictions_score - - tasks:reviewed - - tasks:reviewers - - tasks:reviews_accepted - - tasks:reviews_rejected - - tasks:total_annotations - - tasks:total_predictions - - tasks:unresolved_comment_count - - tasks:updated_at - description: List of fields to order by. Fields are similar to filters - but without the `filter:` prefix. To reverse the order, add a - minus sign before the field name, e.g. `-tasks:created_at`. - description: Data payload containing task filters, selected task items, - and ordering - example: - filters: - conjunction: or - items: - - filter: filter:tasks:id - operator: greater - type: Number - value: 123 + - tasks:agreement + - tasks:annotations_results + - tasks:annotators + - tasks:cancelled_annotations + - tasks:comments + - tasks:completed_at + - tasks:created_at + - tasks:file_upload + - tasks:ground_truth + - tasks:id + - tasks:inner_id + - tasks:predictions_model_versions + - tasks:predictions_results + - tasks:predictions_score + - tasks:reviewed + - tasks:reviewers + - tasks:reviews_accepted + - tasks:reviews_rejected + - tasks:total_annotations + - tasks:total_predictions + - tasks:unresolved_comment_count + - tasks:updated_at + type: string + type: array selectedItems: - all: true - excluded: - - 124 - - 125 - - 126 - ordering: - - tasks:total_annotations - security: - - Token: [] + description: 'Task selection by IDs. If filters are applied, the selection will be applied to the filtered tasks.If "all" is `false`, `"included"` must be used. If "all" is `true`, `"excluded"` must be used.
    Examples: `{"all": false, "included": [1, 2, 3]}` or `{"all": true, "excluded": [4, 5]}`' + oneOf: + - properties: + all: + description: No tasks are selected + enum: + - false + type: boolean + included: + description: List of included task IDs + items: + type: integer + type: array + required: + - all + title: 'all: false' + type: object + - properties: + all: + description: All tasks are selected + enum: + - true + type: boolean + excluded: + description: List of excluded task IDs + items: + type: integer + type: array + required: + - all + title: 'all: true' + type: object + required: + - all + type: object + type: object responses: '200': description: Action performed successfully + security: + - Token: [] + summary: Post actions + tags: + - Data Manager + x-fern-audiences: + - public x-fern-sdk-group-name: actions x-fern-sdk-method-name: create - x-fern-audiences: - - public /api/dm/actions/{action_id}/form/: get: - operationId: api_dm_actions_form_retrieve description: Get the form configuration for a specific action. - summary: Get action form + operationId: api_dm_actions_form_retrieve parameters: - - in: path - name: action_id - schema: - type: string - required: true - - in: query - name: project - schema: - type: integer - description: Project ID - required: true - tags: - - Data Manager - security: - - Token: [] + - in: path + name: action_id + required: true + schema: + type: string + - description: Project ID + in: query + name: project + required: true + schema: + type: integer responses: '200': content: application/json: schema: - type: object description: Form configuration object + type: object description: Action form configuration returned successfully + security: + - Token: [] + summary: Get action form + tags: + - Data Manager /api/dm/project/: get: - operationId: api_dm_project_retrieve description: Retrieve the project state for the data manager. - summary: Get project state - tags: - - Data Manager - security: - - Token: [] + operationId: api_dm_project_retrieve responses: '200': description: No response body + security: + - Token: [] + summary: Get project state + tags: + - Data Manager x-fern-audiences: - - internal + - internal /api/dm/views/: get: - operationId: api_dm_views_list description: List all views for a specific project. - summary: List views + operationId: api_dm_views_list parameters: - - in: query - name: project - schema: - type: integer - description: Project ID - tags: - - Data Manager - security: - - Token: [] + - description: Project ID + in: query + name: project + schema: + type: integer responses: '200': content: application/json: schema: - type: array items: $ref: '#/components/schemas/View' + type: array description: '' + security: + - Token: [] + summary: List views + tags: + - Data Manager + x-fern-audiences: + - public x-fern-sdk-group-name: views x-fern-sdk-method-name: list - x-fern-audiences: - - public post: - operationId: api_dm_views_create description: Create a view for a specific project. - summary: Create view - tags: - - Data Manager + operationId: api_dm_views_create requestBody: content: application/json: schema: - type: object properties: data: - type: object description: Custom view data properties: filters: - type: object + description: 'Filters to apply on tasks. You can use [the helper class `Filters` from this page](https://labelstud.io/sdk/data_manager.html) to create Data Manager Filters.
    Example: `{"conjunction": "or", "items": [{"filter": "filter:tasks:completed_at", "operator": "greater", "type": "Datetime", "value": "2021-01-01T00:00:00.000Z"}]}`' properties: conjunction: - type: string + description: Logical conjunction for the filters. This conjunction (either "or" or "and") will be applied to all items in the filters list. It is not possible to combine "or" and "and" within one list of filters. All filters will be either combined with "or" or with "and", but not a mix of both. enum: - - or - - and - description: Logical conjunction for the filters. This conjunction - (either "or" or "and") will be applied to all items in - the filters list. It is not possible to combine "or" and - "and" within one list of filters. All filters will be - either combined with "or" or with "and", but not a mix - of both. + - or + - and + type: string items: - type: array + description: List of filter items items: - type: object + example: + filter: filter:tasks:id + operator: greater + type: Number + value: 123 properties: filter: - type: string + description: 'Filter identifier, it should start with `filter:tasks:` prefix, e.g. `filter:tasks:agreement`. For `task.data` fields it may look like `filter:tasks:data.field_name`. If you need more info about columns, check the [Get data manager columns](#tag/Data-Manager/operation/api_dm_columns_list) API endpoint. Possible values:
  • `filter:tasks:agreement`
    (Number) Agreement for annotation results for a specific task (Enterprise only)

  • `filter:tasks:annotations_results`
    (String) Annotation results for the tasks

  • `filter:tasks:annotators`
    (List) Annotators that completed the task (Community). Can include assigned annotators (Enterprise only). Important note: the filter `type` should be List, but the filter `value` is integer

  • `filter:tasks:cancelled_annotations`
    (Number) Number of cancelled or skipped annotations for the task

  • `filter:tasks:comments`
    (Number) Number of comments in a task

  • `filter:tasks:completed_at`
    (Datetime) Time when a task was fully annotated

  • `filter:tasks:created_at`
    (Datetime) Time the task was created at

  • `filter:tasks:file_upload`
    (String) Name of the file uploaded to create the tasks

  • `filter:tasks:ground_truth`
    (Boolean) Ground truth status of the tasks

  • `filter:tasks:id`
    (Number) Task ID

  • `filter:tasks:inner_id`
    (Number) Task Inner ID, it starts from 1 for all projects

  • `filter:tasks:predictions_model_versions`
    (String) Model version used for the predictions

  • `filter:tasks:predictions_results`
    (String) Prediction results for the tasks

  • `filter:tasks:predictions_score`
    (Number) Prediction score for the task

  • `filter:tasks:reviewed`
    (Boolean) Whether the tasks have been reviewed (Enterprise only)

  • `filter:tasks:reviewers`
    (String) Reviewers that reviewed the task, or assigned reviewers (Enterprise only). Important note: the filter `type` should be List, but the filter `value` is integer

  • `filter:tasks:reviews_accepted`
    (Number) Number of annotations accepted for a task in review (Enterprise only)

  • `filter:tasks:reviews_rejected`
    (Number) Number of annotations rejected for a task in review (Enterprise only)

  • `filter:tasks:total_annotations`
    (Number) Total number of annotations on a task

  • `filter:tasks:total_predictions`
    (Number) Total number of predictions for the task

  • `filter:tasks:unresolved_comment_count`
    (Number) Number of unresolved comments in a task

  • `filter:tasks:updated_at`
    (Datetime) Time the task was updated at (e.g. new annotation was created, review added, etc)
    • ' enum: - - filter:tasks:agreement - - filter:tasks:annotations_results - - filter:tasks:annotators - - filter:tasks:cancelled_annotations - - filter:tasks:comments - - filter:tasks:completed_at - - filter:tasks:created_at - - filter:tasks:file_upload - - filter:tasks:ground_truth - - filter:tasks:id - - filter:tasks:inner_id - - filter:tasks:predictions_model_versions - - filter:tasks:predictions_results - - filter:tasks:predictions_score - - filter:tasks:reviewed - - filter:tasks:reviewers - - filter:tasks:reviews_accepted - - filter:tasks:reviews_rejected - - filter:tasks:total_annotations - - filter:tasks:total_predictions - - filter:tasks:unresolved_comment_count - - filter:tasks:updated_at - description: 'Filter identifier, it should start with - `filter:tasks:` prefix, e.g. `filter:tasks:agreement`. - For `task.data` fields it may look like `filter:tasks:data.field_name`. - If you need more info about columns, check the [Get - data manager columns](#tag/Data-Manager/operation/api_dm_columns_list) - API endpoint. Possible values:
  • `filter:tasks:agreement`
    - (Number) Agreement for annotation results for a - specific task (Enterprise only)

  • `filter:tasks:annotations_results`
    - (String) Annotation results for the tasks

  • `filter:tasks:annotators`
    - (List) Annotators that completed the task (Community). - Can include assigned annotators (Enterprise only). - Important note: the filter `type` should be List, - but the filter `value` is integer

  • `filter:tasks:cancelled_annotations`
    - (Number) Number of cancelled or skipped annotations - for the task

  • `filter:tasks:comments`
    - (Number) Number of comments in a task

  • `filter:tasks:completed_at`
    - (Datetime) Time when a task was fully annotated

  • `filter:tasks:created_at`
    - (Datetime) Time the task was created at

  • `filter:tasks:file_upload`
    - (String) Name of the file uploaded to create the - tasks

  • `filter:tasks:ground_truth`
    - (Boolean) Ground truth status of the tasks

  • `filter:tasks:id`
    - (Number) Task ID

  • `filter:tasks:inner_id`
    - (Number) Task Inner ID, it starts from 1 for all - projects

  • `filter:tasks:predictions_model_versions`
    - (String) Model version used for the predictions

  • `filter:tasks:predictions_results`
    - (String) Prediction results for the tasks

  • `filter:tasks:predictions_score`
    - (Number) Prediction score for the task

  • `filter:tasks:reviewed`
    - (Boolean) Whether the tasks have been reviewed (Enterprise - only)

  • `filter:tasks:reviewers`
    (String) - Reviewers that reviewed the task, or assigned reviewers - (Enterprise only). Important note: the filter `type` - should be List, but the filter `value` is integer

  • `filter:tasks:reviews_accepted`
    - (Number) Number of annotations accepted for a task - in review (Enterprise only)

  • `filter:tasks:reviews_rejected`
    - (Number) Number of annotations rejected for a task - in review (Enterprise only)

  • `filter:tasks:total_annotations`
    - (Number) Total number of annotations on a task

  • `filter:tasks:total_predictions`
    - (Number) Total number of predictions for the task

  • `filter:tasks:unresolved_comment_count`
    - (Number) Number of unresolved comments in a task

  • `filter:tasks:updated_at`
    - (Datetime) Time the task was updated at (e.g. new - annotation was created, review added, etc)
    • ' - operator: + - filter:tasks:agreement + - filter:tasks:annotations_results + - filter:tasks:annotators + - filter:tasks:cancelled_annotations + - filter:tasks:comments + - filter:tasks:completed_at + - filter:tasks:created_at + - filter:tasks:file_upload + - filter:tasks:ground_truth + - filter:tasks:id + - filter:tasks:inner_id + - filter:tasks:predictions_model_versions + - filter:tasks:predictions_results + - filter:tasks:predictions_score + - filter:tasks:reviewed + - filter:tasks:reviewers + - filter:tasks:reviews_accepted + - filter:tasks:reviews_rejected + - filter:tasks:total_annotations + - filter:tasks:total_predictions + - filter:tasks:unresolved_comment_count + - filter:tasks:updated_at type: string + operator: + description: 'Filter operator. Possible values:
  • `contains`
    Contains

  • `ends_with`
    Ends with

  • `equal`
    Equal to

  • `exists`
    Exists

  • `greater`
    Greater than

  • `greater_or_equal`
    Greater than or equal to

  • `in`
    Is between min and max values, so the filter `value` should be e.g. `{"min": 1, "max": 7}`

  • `less`
    Less than

  • `less_or_equal`
    Less than or equal to

  • `not_contains`
    Does not contain

  • `not_equal`
    Not equal to

  • `not_exists`
    Does not exist

  • `not_in`
    Is not between min and max values, so the filter `value` should be e.g. `{"min": 1, "max": 7}`

  • `starts_with`
    Starts with
    • ' enum: - - contains - - ends_with - - equal - - exists - - greater - - greater_or_equal - - in - - less - - less_or_equal - - not_contains - - not_equal - - not_exists - - not_in - - starts_with - description: 'Filter operator. Possible values:
  • `contains`
    - Contains

  • `ends_with`
    Ends with

  • `equal`
    - Equal to

  • `exists`
    Exists

  • `greater`
    - Greater than

  • `greater_or_equal`
    - Greater than or equal to

  • `in`
    Is - between min and max values, so the filter `value` - should be e.g. `{"min": 1, "max": 7}`

  • `less`
    - Less than

  • `less_or_equal`
    Less than - or equal to

  • `not_contains`
    Does - not contain

  • `not_equal`
    Not equal - to

  • `not_exists`
    Does not exist

  • `not_in`
    - Is not between min and max values, so the filter - `value` should be e.g. `{"min": 1, "max": 7}`

  • `starts_with`
    - Starts with
    • ' + - contains + - ends_with + - equal + - exists + - greater + - greater_or_equal + - in + - less + - less_or_equal + - not_contains + - not_equal + - not_exists + - not_in + - starts_with + type: string type: + description: Type of the filter value. Possible values:
  • `Boolean`
    Boolean

  • `Datetime`
    Datetime string in `strftime('%Y-%m-%dT%H:%M:%S.%fZ')` format

  • `List`
    List of items

  • `Number`
    Float or Integer

  • `String`
    String

  • `Unknown`
    Unknown is explicitly converted to string format
    • type: string - description: Type of the filter value. Possible values:
  • `Boolean`
    - Boolean

  • `Datetime`
    Datetime string - in `strftime('%Y-%m-%dT%H:%M:%S.%fZ')` format

  • `List`
    - List of items

  • `Number`
    Float or - Integer

  • `String`
    String

  • `Unknown`
    - Unknown is explicitly converted to string format
    • value: - type: object - oneOf: - - type: string - title: String - description: String - - type: integer - title: Integer - description: Integer - - type: number - title: Float - format: float - description: Float - - type: boolean - title: Boolean - description: Boolean - - type: object - title: Dictionary - description: Dictionary is used for some operator - types, e.g. `in` and `not_in` - - type: object - title: List - description: List of strings or integers description: Value to filter by + oneOf: + - description: String + title: String + type: string + - description: Integer + title: Integer + type: integer + - description: Float + format: float + title: Float + type: number + - description: Boolean + title: Boolean + type: boolean + - description: Dictionary is used for some operator types, e.g. `in` and `not_in` + title: Dictionary + type: object + - description: List of strings or integers + title: List + type: object + type: object required: - - filter - - operator - - type - - value - example: - filter: filter:tasks:id - operator: greater - type: Number - value: 123 - description: List of filter items + - filter + - operator + - type + - value + type: object + type: array required: - - conjunction - - items - description: 'Filters to apply on tasks. You can use [the helper - class `Filters` from this page](https://labelstud.io/sdk/data_manager.html) - to create Data Manager Filters.
    Example: `{"conjunction": - "or", "items": [{"filter": "filter:tasks:completed_at", "operator": - "greater", "type": "Datetime", "value": "2021-01-01T00:00:00.000Z"}]}`' + - conjunction + - items + type: object ordering: - type: array + description: List of fields to order by. Fields are similar to filters but without the `filter:` prefix. To reverse the order, add a minus sign before the field name, e.g. `-tasks:created_at`. items: - type: string enum: - - tasks:agreement - - tasks:annotations_results - - tasks:annotators - - tasks:cancelled_annotations - - tasks:comments - - tasks:completed_at - - tasks:created_at - - tasks:file_upload - - tasks:ground_truth - - tasks:id - - tasks:inner_id - - tasks:predictions_model_versions - - tasks:predictions_results - - tasks:predictions_score - - tasks:reviewed - - tasks:reviewers - - tasks:reviews_accepted - - tasks:reviews_rejected - - tasks:total_annotations - - tasks:total_predictions - - tasks:unresolved_comment_count - - tasks:updated_at - description: List of fields to order by. Fields are similar - to filters but without the `filter:` prefix. To reverse the - order, add a minus sign before the field name, e.g. `-tasks:created_at`. + - tasks:agreement + - tasks:annotations_results + - tasks:annotators + - tasks:cancelled_annotations + - tasks:comments + - tasks:completed_at + - tasks:created_at + - tasks:file_upload + - tasks:ground_truth + - tasks:id + - tasks:inner_id + - tasks:predictions_model_versions + - tasks:predictions_results + - tasks:predictions_score + - tasks:reviewed + - tasks:reviewers + - tasks:reviews_accepted + - tasks:reviews_rejected + - tasks:total_annotations + - tasks:total_predictions + - tasks:unresolved_comment_count + - tasks:updated_at + type: string + type: array + type: object project: - type: integer description: Project ID - security: - - Token: [] + type: integer + type: object responses: '201': content: @@ -3137,26 +3193,99 @@ paths: schema: $ref: '#/components/schemas/View' description: '' + security: + - Token: [] + summary: Create view + tags: + - Data Manager + x-fern-audiences: + - public x-fern-sdk-group-name: views x-fern-sdk-method-name: create + /api/dm/views/order/: + post: + description: Update the order field of views based on the provided list of view IDs + operationId: api_dm_views_order_create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ViewOrderRequest' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/ViewOrderRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/ViewOrderRequest' + required: true + responses: + '200': + description: View order updated successfully + security: + - Token: [] + summary: Update order of views + tags: + - Data Manager + x-fern-audiences: + - public + x-fern-sdk-group-name: views + x-fern-sdk-method-name: update_order + /api/dm/views/reset/: + delete: + description: Delete all views for a specific project. + operationId: api_dm_views_reset_destroy + parameters: + - description: Project ID + in: query + name: project + required: true + schema: + type: integer + responses: + '204': + description: No response body + security: + - Token: [] + summary: Delete all project views + tags: + - Data Manager x-fern-audiences: - - public + - public + x-fern-sdk-group-name: views + x-fern-sdk-method-name: delete_all /api/dm/views/{id}/: + delete: + description: Delete a specific view by ID. + operationId: api_dm_views_destroy + parameters: + - description: View ID + in: path + name: id + required: true + schema: + type: string + responses: + '204': + description: No response body + security: + - Token: [] + summary: Delete view + tags: + - Data Manager + x-fern-audiences: + - public + x-fern-sdk-group-name: views + x-fern-sdk-method-name: delete get: - operationId: api_dm_views_retrieve description: Get the details about a specific view in the data manager - summary: Get view details + operationId: api_dm_views_retrieve parameters: - - in: path - name: id - schema: - type: string - description: View ID - required: true - tags: - - Data Manager - security: - - Token: [] + - description: View ID + in: path + name: id + required: true + schema: + type: string responses: '200': content: @@ -3164,236 +3293,165 @@ paths: schema: $ref: '#/components/schemas/View' description: '' + security: + - Token: [] + summary: Get view details + tags: + - Data Manager + x-fern-audiences: + - public x-fern-sdk-group-name: views x-fern-sdk-method-name: get - x-fern-audiences: - - public - put: - operationId: api_dm_views_update - description: Overwrite view data with updated filters and other information - for a specific project. - summary: Put view + patch: + description: Update view data with additional filters and other information for a specific project. + operationId: api_dm_views_partial_update parameters: - - in: path - name: id - schema: - type: string - description: View ID - required: true - tags: - - Data Manager + - description: View ID + in: path + name: id + required: true + schema: + type: string requestBody: content: application/json: schema: - type: object properties: data: - type: object description: Custom view data properties: filters: - type: object + description: 'Filters to apply on tasks. You can use [the helper class `Filters` from this page](https://labelstud.io/sdk/data_manager.html) to create Data Manager Filters.
    Example: `{"conjunction": "or", "items": [{"filter": "filter:tasks:completed_at", "operator": "greater", "type": "Datetime", "value": "2021-01-01T00:00:00.000Z"}]}`' properties: conjunction: - type: string + description: Logical conjunction for the filters. This conjunction (either "or" or "and") will be applied to all items in the filters list. It is not possible to combine "or" and "and" within one list of filters. All filters will be either combined with "or" or with "and", but not a mix of both. enum: - - or - - and - description: Logical conjunction for the filters. This conjunction - (either "or" or "and") will be applied to all items in - the filters list. It is not possible to combine "or" and - "and" within one list of filters. All filters will be - either combined with "or" or with "and", but not a mix - of both. + - or + - and + type: string items: - type: array + description: List of filter items items: - type: object + example: + filter: filter:tasks:id + operator: greater + type: Number + value: 123 properties: filter: - type: string + description: 'Filter identifier, it should start with `filter:tasks:` prefix, e.g. `filter:tasks:agreement`. For `task.data` fields it may look like `filter:tasks:data.field_name`. If you need more info about columns, check the [Get data manager columns](#tag/Data-Manager/operation/api_dm_columns_list) API endpoint. Possible values:
  • `filter:tasks:agreement`
    (Number) Agreement for annotation results for a specific task (Enterprise only)

  • `filter:tasks:annotations_results`
    (String) Annotation results for the tasks

  • `filter:tasks:annotators`
    (List) Annotators that completed the task (Community). Can include assigned annotators (Enterprise only). Important note: the filter `type` should be List, but the filter `value` is integer

  • `filter:tasks:cancelled_annotations`
    (Number) Number of cancelled or skipped annotations for the task

  • `filter:tasks:comments`
    (Number) Number of comments in a task

  • `filter:tasks:completed_at`
    (Datetime) Time when a task was fully annotated

  • `filter:tasks:created_at`
    (Datetime) Time the task was created at

  • `filter:tasks:file_upload`
    (String) Name of the file uploaded to create the tasks

  • `filter:tasks:ground_truth`
    (Boolean) Ground truth status of the tasks

  • `filter:tasks:id`
    (Number) Task ID

  • `filter:tasks:inner_id`
    (Number) Task Inner ID, it starts from 1 for all projects

  • `filter:tasks:predictions_model_versions`
    (String) Model version used for the predictions

  • `filter:tasks:predictions_results`
    (String) Prediction results for the tasks

  • `filter:tasks:predictions_score`
    (Number) Prediction score for the task

  • `filter:tasks:reviewed`
    (Boolean) Whether the tasks have been reviewed (Enterprise only)

  • `filter:tasks:reviewers`
    (String) Reviewers that reviewed the task, or assigned reviewers (Enterprise only). Important note: the filter `type` should be List, but the filter `value` is integer

  • `filter:tasks:reviews_accepted`
    (Number) Number of annotations accepted for a task in review (Enterprise only)

  • `filter:tasks:reviews_rejected`
    (Number) Number of annotations rejected for a task in review (Enterprise only)

  • `filter:tasks:total_annotations`
    (Number) Total number of annotations on a task

  • `filter:tasks:total_predictions`
    (Number) Total number of predictions for the task

  • `filter:tasks:unresolved_comment_count`
    (Number) Number of unresolved comments in a task

  • `filter:tasks:updated_at`
    (Datetime) Time the task was updated at (e.g. new annotation was created, review added, etc)
    • ' enum: - - filter:tasks:agreement - - filter:tasks:annotations_results - - filter:tasks:annotators - - filter:tasks:cancelled_annotations - - filter:tasks:comments - - filter:tasks:completed_at - - filter:tasks:created_at - - filter:tasks:file_upload - - filter:tasks:ground_truth - - filter:tasks:id - - filter:tasks:inner_id - - filter:tasks:predictions_model_versions - - filter:tasks:predictions_results - - filter:tasks:predictions_score - - filter:tasks:reviewed - - filter:tasks:reviewers - - filter:tasks:reviews_accepted - - filter:tasks:reviews_rejected - - filter:tasks:total_annotations - - filter:tasks:total_predictions - - filter:tasks:unresolved_comment_count - - filter:tasks:updated_at - description: 'Filter identifier, it should start with - `filter:tasks:` prefix, e.g. `filter:tasks:agreement`. - For `task.data` fields it may look like `filter:tasks:data.field_name`. - If you need more info about columns, check the [Get - data manager columns](#tag/Data-Manager/operation/api_dm_columns_list) - API endpoint. Possible values:
  • `filter:tasks:agreement`
    - (Number) Agreement for annotation results for a - specific task (Enterprise only)

  • `filter:tasks:annotations_results`
    - (String) Annotation results for the tasks

  • `filter:tasks:annotators`
    - (List) Annotators that completed the task (Community). - Can include assigned annotators (Enterprise only). - Important note: the filter `type` should be List, - but the filter `value` is integer

  • `filter:tasks:cancelled_annotations`
    - (Number) Number of cancelled or skipped annotations - for the task

  • `filter:tasks:comments`
    - (Number) Number of comments in a task

  • `filter:tasks:completed_at`
    - (Datetime) Time when a task was fully annotated

  • `filter:tasks:created_at`
    - (Datetime) Time the task was created at

  • `filter:tasks:file_upload`
    - (String) Name of the file uploaded to create the - tasks

  • `filter:tasks:ground_truth`
    - (Boolean) Ground truth status of the tasks

  • `filter:tasks:id`
    - (Number) Task ID

  • `filter:tasks:inner_id`
    - (Number) Task Inner ID, it starts from 1 for all - projects

  • `filter:tasks:predictions_model_versions`
    - (String) Model version used for the predictions

  • `filter:tasks:predictions_results`
    - (String) Prediction results for the tasks

  • `filter:tasks:predictions_score`
    - (Number) Prediction score for the task

  • `filter:tasks:reviewed`
    - (Boolean) Whether the tasks have been reviewed (Enterprise - only)

  • `filter:tasks:reviewers`
    (String) - Reviewers that reviewed the task, or assigned reviewers - (Enterprise only). Important note: the filter `type` - should be List, but the filter `value` is integer

  • `filter:tasks:reviews_accepted`
    - (Number) Number of annotations accepted for a task - in review (Enterprise only)

  • `filter:tasks:reviews_rejected`
    - (Number) Number of annotations rejected for a task - in review (Enterprise only)

  • `filter:tasks:total_annotations`
    - (Number) Total number of annotations on a task

  • `filter:tasks:total_predictions`
    - (Number) Total number of predictions for the task

  • `filter:tasks:unresolved_comment_count`
    - (Number) Number of unresolved comments in a task

  • `filter:tasks:updated_at`
    - (Datetime) Time the task was updated at (e.g. new - annotation was created, review added, etc)
    • ' - operator: + - filter:tasks:agreement + - filter:tasks:annotations_results + - filter:tasks:annotators + - filter:tasks:cancelled_annotations + - filter:tasks:comments + - filter:tasks:completed_at + - filter:tasks:created_at + - filter:tasks:file_upload + - filter:tasks:ground_truth + - filter:tasks:id + - filter:tasks:inner_id + - filter:tasks:predictions_model_versions + - filter:tasks:predictions_results + - filter:tasks:predictions_score + - filter:tasks:reviewed + - filter:tasks:reviewers + - filter:tasks:reviews_accepted + - filter:tasks:reviews_rejected + - filter:tasks:total_annotations + - filter:tasks:total_predictions + - filter:tasks:unresolved_comment_count + - filter:tasks:updated_at type: string + operator: + description: 'Filter operator. Possible values:
  • `contains`
    Contains

  • `ends_with`
    Ends with

  • `equal`
    Equal to

  • `exists`
    Exists

  • `greater`
    Greater than

  • `greater_or_equal`
    Greater than or equal to

  • `in`
    Is between min and max values, so the filter `value` should be e.g. `{"min": 1, "max": 7}`

  • `less`
    Less than

  • `less_or_equal`
    Less than or equal to

  • `not_contains`
    Does not contain

  • `not_equal`
    Not equal to

  • `not_exists`
    Does not exist

  • `not_in`
    Is not between min and max values, so the filter `value` should be e.g. `{"min": 1, "max": 7}`

  • `starts_with`
    Starts with
    • ' enum: - - contains - - ends_with - - equal - - exists - - greater - - greater_or_equal - - in - - less - - less_or_equal - - not_contains - - not_equal - - not_exists - - not_in - - starts_with - description: 'Filter operator. Possible values:
  • `contains`
    - Contains

  • `ends_with`
    Ends with

  • `equal`
    - Equal to

  • `exists`
    Exists

  • `greater`
    - Greater than

  • `greater_or_equal`
    - Greater than or equal to

  • `in`
    Is - between min and max values, so the filter `value` - should be e.g. `{"min": 1, "max": 7}`

  • `less`
    - Less than

  • `less_or_equal`
    Less than - or equal to

  • `not_contains`
    Does - not contain

  • `not_equal`
    Not equal - to

  • `not_exists`
    Does not exist

  • `not_in`
    - Is not between min and max values, so the filter - `value` should be e.g. `{"min": 1, "max": 7}`

  • `starts_with`
    - Starts with
    • ' + - contains + - ends_with + - equal + - exists + - greater + - greater_or_equal + - in + - less + - less_or_equal + - not_contains + - not_equal + - not_exists + - not_in + - starts_with + type: string type: + description: Type of the filter value. Possible values:
  • `Boolean`
    Boolean

  • `Datetime`
    Datetime string in `strftime('%Y-%m-%dT%H:%M:%S.%fZ')` format

  • `List`
    List of items

  • `Number`
    Float or Integer

  • `String`
    String

  • `Unknown`
    Unknown is explicitly converted to string format
    • type: string - description: Type of the filter value. Possible values:
  • `Boolean`
    - Boolean

  • `Datetime`
    Datetime string - in `strftime('%Y-%m-%dT%H:%M:%S.%fZ')` format

  • `List`
    - List of items

  • `Number`
    Float or - Integer

  • `String`
    String

  • `Unknown`
    - Unknown is explicitly converted to string format
    • value: - type: object - oneOf: - - type: string - title: String - description: String - - type: integer - title: Integer - description: Integer - - type: number - title: Float - format: float - description: Float - - type: boolean - title: Boolean - description: Boolean - - type: object - title: Dictionary - description: Dictionary is used for some operator - types, e.g. `in` and `not_in` - - type: object - title: List - description: List of strings or integers description: Value to filter by + oneOf: + - description: String + title: String + type: string + - description: Integer + title: Integer + type: integer + - description: Float + format: float + title: Float + type: number + - description: Boolean + title: Boolean + type: boolean + - description: Dictionary is used for some operator types, e.g. `in` and `not_in` + title: Dictionary + type: object + - description: List of strings or integers + title: List + type: object + type: object required: - - filter - - operator - - type - - value - example: - filter: filter:tasks:id - operator: greater - type: Number - value: 123 - description: List of filter items + - filter + - operator + - type + - value + type: object + type: array required: - - conjunction - - items - description: 'Filters to apply on tasks. You can use [the helper - class `Filters` from this page](https://labelstud.io/sdk/data_manager.html) - to create Data Manager Filters.
    Example: `{"conjunction": - "or", "items": [{"filter": "filter:tasks:completed_at", "operator": - "greater", "type": "Datetime", "value": "2021-01-01T00:00:00.000Z"}]}`' + - conjunction + - items + type: object ordering: - type: array + description: List of fields to order by. Fields are similar to filters but without the `filter:` prefix. To reverse the order, add a minus sign before the field name, e.g. `-tasks:created_at`. items: - type: string enum: - - tasks:agreement - - tasks:annotations_results - - tasks:annotators - - tasks:cancelled_annotations - - tasks:comments - - tasks:completed_at - - tasks:created_at - - tasks:file_upload - - tasks:ground_truth - - tasks:id - - tasks:inner_id - - tasks:predictions_model_versions - - tasks:predictions_results - - tasks:predictions_score - - tasks:reviewed - - tasks:reviewers - - tasks:reviews_accepted - - tasks:reviews_rejected - - tasks:total_annotations - - tasks:total_predictions - - tasks:unresolved_comment_count - - tasks:updated_at - description: List of fields to order by. Fields are similar - to filters but without the `filter:` prefix. To reverse the - order, add a minus sign before the field name, e.g. `-tasks:created_at`. + - tasks:agreement + - tasks:annotations_results + - tasks:annotators + - tasks:cancelled_annotations + - tasks:comments + - tasks:completed_at + - tasks:created_at + - tasks:file_upload + - tasks:ground_truth + - tasks:id + - tasks:inner_id + - tasks:predictions_model_versions + - tasks:predictions_results + - tasks:predictions_score + - tasks:reviewed + - tasks:reviewers + - tasks:reviews_accepted + - tasks:reviews_rejected + - tasks:total_annotations + - tasks:total_predictions + - tasks:unresolved_comment_count + - tasks:updated_at + type: string + type: array + type: object project: - type: integer description: Project ID - security: - - Token: [] + type: integer + type: object responses: '200': content: @@ -3401,234 +3459,165 @@ paths: schema: $ref: '#/components/schemas/View' description: '' - x-fern-audiences: - - internal - patch: - operationId: api_dm_views_partial_update - description: Update view data with additional filters and other information - for a specific project. + security: + - Token: [] summary: Update view - parameters: - - in: path - name: id - schema: - type: string - description: View ID - required: true tags: - - Data Manager + - Data Manager + x-fern-audiences: + - public + x-fern-sdk-group-name: views + x-fern-sdk-method-name: update + put: + description: Overwrite view data with updated filters and other information for a specific project. + operationId: api_dm_views_update + parameters: + - description: View ID + in: path + name: id + required: true + schema: + type: string requestBody: content: application/json: schema: - type: object properties: data: - type: object description: Custom view data properties: filters: - type: object + description: 'Filters to apply on tasks. You can use [the helper class `Filters` from this page](https://labelstud.io/sdk/data_manager.html) to create Data Manager Filters.
    Example: `{"conjunction": "or", "items": [{"filter": "filter:tasks:completed_at", "operator": "greater", "type": "Datetime", "value": "2021-01-01T00:00:00.000Z"}]}`' properties: conjunction: - type: string + description: Logical conjunction for the filters. This conjunction (either "or" or "and") will be applied to all items in the filters list. It is not possible to combine "or" and "and" within one list of filters. All filters will be either combined with "or" or with "and", but not a mix of both. enum: - - or - - and - description: Logical conjunction for the filters. This conjunction - (either "or" or "and") will be applied to all items in - the filters list. It is not possible to combine "or" and - "and" within one list of filters. All filters will be - either combined with "or" or with "and", but not a mix - of both. + - or + - and + type: string items: - type: array + description: List of filter items items: - type: object + example: + filter: filter:tasks:id + operator: greater + type: Number + value: 123 properties: filter: - type: string + description: 'Filter identifier, it should start with `filter:tasks:` prefix, e.g. `filter:tasks:agreement`. For `task.data` fields it may look like `filter:tasks:data.field_name`. If you need more info about columns, check the [Get data manager columns](#tag/Data-Manager/operation/api_dm_columns_list) API endpoint. Possible values:
  • `filter:tasks:agreement`
    (Number) Agreement for annotation results for a specific task (Enterprise only)

  • `filter:tasks:annotations_results`
    (String) Annotation results for the tasks

  • `filter:tasks:annotators`
    (List) Annotators that completed the task (Community). Can include assigned annotators (Enterprise only). Important note: the filter `type` should be List, but the filter `value` is integer

  • `filter:tasks:cancelled_annotations`
    (Number) Number of cancelled or skipped annotations for the task

  • `filter:tasks:comments`
    (Number) Number of comments in a task

  • `filter:tasks:completed_at`
    (Datetime) Time when a task was fully annotated

  • `filter:tasks:created_at`
    (Datetime) Time the task was created at

  • `filter:tasks:file_upload`
    (String) Name of the file uploaded to create the tasks

  • `filter:tasks:ground_truth`
    (Boolean) Ground truth status of the tasks

  • `filter:tasks:id`
    (Number) Task ID

  • `filter:tasks:inner_id`
    (Number) Task Inner ID, it starts from 1 for all projects

  • `filter:tasks:predictions_model_versions`
    (String) Model version used for the predictions

  • `filter:tasks:predictions_results`
    (String) Prediction results for the tasks

  • `filter:tasks:predictions_score`
    (Number) Prediction score for the task

  • `filter:tasks:reviewed`
    (Boolean) Whether the tasks have been reviewed (Enterprise only)

  • `filter:tasks:reviewers`
    (String) Reviewers that reviewed the task, or assigned reviewers (Enterprise only). Important note: the filter `type` should be List, but the filter `value` is integer

  • `filter:tasks:reviews_accepted`
    (Number) Number of annotations accepted for a task in review (Enterprise only)

  • `filter:tasks:reviews_rejected`
    (Number) Number of annotations rejected for a task in review (Enterprise only)

  • `filter:tasks:total_annotations`
    (Number) Total number of annotations on a task

  • `filter:tasks:total_predictions`
    (Number) Total number of predictions for the task

  • `filter:tasks:unresolved_comment_count`
    (Number) Number of unresolved comments in a task

  • `filter:tasks:updated_at`
    (Datetime) Time the task was updated at (e.g. new annotation was created, review added, etc)
    • ' enum: - - filter:tasks:agreement - - filter:tasks:annotations_results - - filter:tasks:annotators - - filter:tasks:cancelled_annotations - - filter:tasks:comments - - filter:tasks:completed_at - - filter:tasks:created_at - - filter:tasks:file_upload - - filter:tasks:ground_truth - - filter:tasks:id - - filter:tasks:inner_id - - filter:tasks:predictions_model_versions - - filter:tasks:predictions_results - - filter:tasks:predictions_score - - filter:tasks:reviewed - - filter:tasks:reviewers - - filter:tasks:reviews_accepted - - filter:tasks:reviews_rejected - - filter:tasks:total_annotations - - filter:tasks:total_predictions - - filter:tasks:unresolved_comment_count - - filter:tasks:updated_at - description: 'Filter identifier, it should start with - `filter:tasks:` prefix, e.g. `filter:tasks:agreement`. - For `task.data` fields it may look like `filter:tasks:data.field_name`. - If you need more info about columns, check the [Get - data manager columns](#tag/Data-Manager/operation/api_dm_columns_list) - API endpoint. Possible values:
  • `filter:tasks:agreement`
    - (Number) Agreement for annotation results for a - specific task (Enterprise only)

  • `filter:tasks:annotations_results`
    - (String) Annotation results for the tasks

  • `filter:tasks:annotators`
    - (List) Annotators that completed the task (Community). - Can include assigned annotators (Enterprise only). - Important note: the filter `type` should be List, - but the filter `value` is integer

  • `filter:tasks:cancelled_annotations`
    - (Number) Number of cancelled or skipped annotations - for the task

  • `filter:tasks:comments`
    - (Number) Number of comments in a task

  • `filter:tasks:completed_at`
    - (Datetime) Time when a task was fully annotated

  • `filter:tasks:created_at`
    - (Datetime) Time the task was created at

  • `filter:tasks:file_upload`
    - (String) Name of the file uploaded to create the - tasks

  • `filter:tasks:ground_truth`
    - (Boolean) Ground truth status of the tasks

  • `filter:tasks:id`
    - (Number) Task ID

  • `filter:tasks:inner_id`
    - (Number) Task Inner ID, it starts from 1 for all - projects

  • `filter:tasks:predictions_model_versions`
    - (String) Model version used for the predictions

  • `filter:tasks:predictions_results`
    - (String) Prediction results for the tasks

  • `filter:tasks:predictions_score`
    - (Number) Prediction score for the task

  • `filter:tasks:reviewed`
    - (Boolean) Whether the tasks have been reviewed (Enterprise - only)

  • `filter:tasks:reviewers`
    (String) - Reviewers that reviewed the task, or assigned reviewers - (Enterprise only). Important note: the filter `type` - should be List, but the filter `value` is integer

  • `filter:tasks:reviews_accepted`
    - (Number) Number of annotations accepted for a task - in review (Enterprise only)

  • `filter:tasks:reviews_rejected`
    - (Number) Number of annotations rejected for a task - in review (Enterprise only)

  • `filter:tasks:total_annotations`
    - (Number) Total number of annotations on a task

  • `filter:tasks:total_predictions`
    - (Number) Total number of predictions for the task

  • `filter:tasks:unresolved_comment_count`
    - (Number) Number of unresolved comments in a task

  • `filter:tasks:updated_at`
    - (Datetime) Time the task was updated at (e.g. new - annotation was created, review added, etc)
    • ' - operator: + - filter:tasks:agreement + - filter:tasks:annotations_results + - filter:tasks:annotators + - filter:tasks:cancelled_annotations + - filter:tasks:comments + - filter:tasks:completed_at + - filter:tasks:created_at + - filter:tasks:file_upload + - filter:tasks:ground_truth + - filter:tasks:id + - filter:tasks:inner_id + - filter:tasks:predictions_model_versions + - filter:tasks:predictions_results + - filter:tasks:predictions_score + - filter:tasks:reviewed + - filter:tasks:reviewers + - filter:tasks:reviews_accepted + - filter:tasks:reviews_rejected + - filter:tasks:total_annotations + - filter:tasks:total_predictions + - filter:tasks:unresolved_comment_count + - filter:tasks:updated_at type: string + operator: + description: 'Filter operator. Possible values:
  • `contains`
    Contains

  • `ends_with`
    Ends with

  • `equal`
    Equal to

  • `exists`
    Exists

  • `greater`
    Greater than

  • `greater_or_equal`
    Greater than or equal to

  • `in`
    Is between min and max values, so the filter `value` should be e.g. `{"min": 1, "max": 7}`

  • `less`
    Less than

  • `less_or_equal`
    Less than or equal to

  • `not_contains`
    Does not contain

  • `not_equal`
    Not equal to

  • `not_exists`
    Does not exist

  • `not_in`
    Is not between min and max values, so the filter `value` should be e.g. `{"min": 1, "max": 7}`

  • `starts_with`
    Starts with
    • ' enum: - - contains - - ends_with - - equal - - exists - - greater - - greater_or_equal - - in - - less - - less_or_equal - - not_contains - - not_equal - - not_exists - - not_in - - starts_with - description: 'Filter operator. Possible values:
  • `contains`
    - Contains

  • `ends_with`
    Ends with

  • `equal`
    - Equal to

  • `exists`
    Exists

  • `greater`
    - Greater than

  • `greater_or_equal`
    - Greater than or equal to

  • `in`
    Is - between min and max values, so the filter `value` - should be e.g. `{"min": 1, "max": 7}`

  • `less`
    - Less than

  • `less_or_equal`
    Less than - or equal to

  • `not_contains`
    Does - not contain

  • `not_equal`
    Not equal - to

  • `not_exists`
    Does not exist

  • `not_in`
    - Is not between min and max values, so the filter - `value` should be e.g. `{"min": 1, "max": 7}`

  • `starts_with`
    - Starts with
    • ' + - contains + - ends_with + - equal + - exists + - greater + - greater_or_equal + - in + - less + - less_or_equal + - not_contains + - not_equal + - not_exists + - not_in + - starts_with + type: string type: + description: Type of the filter value. Possible values:
  • `Boolean`
    Boolean

  • `Datetime`
    Datetime string in `strftime('%Y-%m-%dT%H:%M:%S.%fZ')` format

  • `List`
    List of items

  • `Number`
    Float or Integer

  • `String`
    String

  • `Unknown`
    Unknown is explicitly converted to string format
    • type: string - description: Type of the filter value. Possible values:
  • `Boolean`
    - Boolean

  • `Datetime`
    Datetime string - in `strftime('%Y-%m-%dT%H:%M:%S.%fZ')` format

  • `List`
    - List of items

  • `Number`
    Float or - Integer

  • `String`
    String

  • `Unknown`
    - Unknown is explicitly converted to string format
    • value: - type: object - oneOf: - - type: string - title: String - description: String - - type: integer - title: Integer - description: Integer - - type: number - title: Float - format: float - description: Float - - type: boolean - title: Boolean - description: Boolean - - type: object - title: Dictionary - description: Dictionary is used for some operator - types, e.g. `in` and `not_in` - - type: object - title: List - description: List of strings or integers description: Value to filter by + oneOf: + - description: String + title: String + type: string + - description: Integer + title: Integer + type: integer + - description: Float + format: float + title: Float + type: number + - description: Boolean + title: Boolean + type: boolean + - description: Dictionary is used for some operator types, e.g. `in` and `not_in` + title: Dictionary + type: object + - description: List of strings or integers + title: List + type: object + type: object required: - - filter - - operator - - type - - value - example: - filter: filter:tasks:id - operator: greater - type: Number - value: 123 - description: List of filter items + - filter + - operator + - type + - value + type: object + type: array required: - - conjunction - - items - description: 'Filters to apply on tasks. You can use [the helper - class `Filters` from this page](https://labelstud.io/sdk/data_manager.html) - to create Data Manager Filters.
    Example: `{"conjunction": - "or", "items": [{"filter": "filter:tasks:completed_at", "operator": - "greater", "type": "Datetime", "value": "2021-01-01T00:00:00.000Z"}]}`' + - conjunction + - items + type: object ordering: - type: array + description: List of fields to order by. Fields are similar to filters but without the `filter:` prefix. To reverse the order, add a minus sign before the field name, e.g. `-tasks:created_at`. items: - type: string enum: - - tasks:agreement - - tasks:annotations_results - - tasks:annotators - - tasks:cancelled_annotations - - tasks:comments - - tasks:completed_at - - tasks:created_at - - tasks:file_upload - - tasks:ground_truth - - tasks:id - - tasks:inner_id - - tasks:predictions_model_versions - - tasks:predictions_results - - tasks:predictions_score - - tasks:reviewed - - tasks:reviewers - - tasks:reviews_accepted - - tasks:reviews_rejected - - tasks:total_annotations - - tasks:total_predictions - - tasks:unresolved_comment_count - - tasks:updated_at - description: List of fields to order by. Fields are similar - to filters but without the `filter:` prefix. To reverse the - order, add a minus sign before the field name, e.g. `-tasks:created_at`. + - tasks:agreement + - tasks:annotations_results + - tasks:annotators + - tasks:cancelled_annotations + - tasks:comments + - tasks:completed_at + - tasks:created_at + - tasks:file_upload + - tasks:ground_truth + - tasks:id + - tasks:inner_id + - tasks:predictions_model_versions + - tasks:predictions_results + - tasks:predictions_score + - tasks:reviewed + - tasks:reviewers + - tasks:reviews_accepted + - tasks:reviews_rejected + - tasks:total_annotations + - tasks:total_predictions + - tasks:unresolved_comment_count + - tasks:updated_at + type: string + type: array + type: object project: - type: integer description: Project ID - security: - - Token: [] + type: integer + type: object responses: '200': content: @@ -3636,99 +3625,45 @@ paths: schema: $ref: '#/components/schemas/View' description: '' - x-fern-sdk-group-name: views - x-fern-sdk-method-name: update - x-fern-audiences: - - public - delete: - operationId: api_dm_views_destroy - description: Delete a specific view by ID. - summary: Delete view - parameters: - - in: path - name: id - schema: - type: string - description: View ID - required: true - tags: - - Data Manager security: - - Token: [] - responses: - '204': - description: No response body - x-fern-sdk-group-name: views - x-fern-sdk-method-name: delete - x-fern-audiences: - - public - /api/dm/views/order/: - post: - operationId: api_dm_views_order_create - description: Update the order field of views based on the provided list of view - IDs - summary: Update order of views + - Token: [] + summary: Put view tags: - - Data Manager - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ViewOrderRequest' - application/x-www-form-urlencoded: - schema: - $ref: '#/components/schemas/ViewOrderRequest' - multipart/form-data: - schema: - $ref: '#/components/schemas/ViewOrderRequest' - required: true - security: - - Token: [] - responses: - '200': - description: View order updated successfully - x-fern-sdk-group-name: views - x-fern-sdk-method-name: update_order + - Data Manager x-fern-audiences: - - public - /api/dm/views/reset/: + - internal + /api/import/file-upload/{id}: delete: - operationId: api_dm_views_reset_destroy - description: Delete all views for a specific project. - summary: Delete all project views + description: Delete a specific uploaded file. + operationId: api_import_file_upload_destroy parameters: - - in: query - name: project - schema: - type: integer - description: Project ID - required: true - tags: - - Data Manager - security: - - Token: [] + - in: path + name: id + required: true + schema: + type: integer responses: '204': description: No response body - x-fern-sdk-group-name: views - x-fern-sdk-method-name: delete_all + security: + - Token: [] + summary: Delete file upload + tags: + - Import x-fern-audiences: - - public - /api/import/file-upload/{id}: + - public + x-fern-sdk-group-name: + - files + x-fern-sdk-method-name: delete get: - operationId: api_import_file_upload_retrieve description: Retrieve details about a specific uploaded file. - summary: Get file upload + operationId: api_import_file_upload_retrieve parameters: - - in: path - name: id - schema: - type: integer - required: true - tags: - - Import - security: - - Token: [] + - in: path + name: id + required: true + schema: + type: integer responses: '200': content: @@ -3736,36 +3671,36 @@ paths: schema: $ref: '#/components/schemas/FileUpload' description: '' + security: + - Token: [] + summary: Get file upload + tags: + - Import + x-fern-audiences: + - public x-fern-sdk-group-name: - - files + - files x-fern-sdk-method-name: get - x-fern-audiences: - - public patch: - operationId: api_import_file_upload_partial_update description: Update a specific uploaded file. - summary: Update file upload + operationId: api_import_file_upload_partial_update parameters: - - in: path - name: id - schema: - type: integer - required: true - tags: - - Import + - in: path + name: id + required: true + schema: + type: integer requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedFileUploadRequest' - multipart/form-data: + application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedFileUploadRequest' - application/x-www-form-urlencoded: + multipart/form-data: schema: $ref: '#/components/schemas/PatchedFileUploadRequest' - security: - - Token: [] responses: '200': content: @@ -3773,88 +3708,66 @@ paths: schema: $ref: '#/components/schemas/FileUpload' description: '' - x-fern-sdk-group-name: - - files - x-fern-sdk-method-name: update - x-fern-audiences: - - public - delete: - operationId: api_import_file_upload_destroy - description: Delete a specific uploaded file. - summary: Delete file upload - parameters: - - in: path - name: id - schema: - type: integer - required: true - tags: - - Import security: - - Token: [] - responses: - '204': - description: No response body - x-fern-sdk-group-name: - - files - x-fern-sdk-method-name: delete + - Token: [] + summary: Update file upload + tags: + - Import x-fern-audiences: - - public + - public + x-fern-sdk-group-name: + - files + x-fern-sdk-method-name: update /api/inference-runs/{id}/indicators/: get: - operationId: api_inference_runs_indicators_retrieve description: Get key indicators for the Prompt dashboard. - summary: Get key indicators + operationId: api_inference_runs_indicators_retrieve parameters: - - in: path - name: id - schema: - type: integer - required: true - tags: - - Prompts - security: - - Token: [] + - in: path + name: id + required: true + schema: + type: integer responses: '200': content: application/json: schema: - type: array items: - type: object properties: title: type: string values: type: object + type: object + type: array description: Key indicators + security: + - Token: [] + summary: Get key indicators + tags: + - Prompts + x-fern-audiences: + - public x-fern-sdk-group-name: - - prompts - - indicators + - prompts + - indicators x-fern-sdk-method-name: list - x-fern-audiences: - - public /api/inference-runs/{id}/indicators/{indicator_key}: get: - operationId: api_inference_runs_indicators_retrieve_2 description: Get a specific key indicator for the Prompt dashboard. - summary: Get key indicator + operationId: api_inference_runs_indicators_retrieve_2 parameters: - - in: path - name: id - schema: - type: integer - required: true - - in: path - name: indicator_key - schema: - type: string - required: true - tags: - - Prompts - security: - - Token: [] + - in: path + name: id + required: true + schema: + type: integer + - in: path + name: indicator_key + required: true + schema: + type: string responses: '200': content: @@ -3862,34 +3775,33 @@ paths: schema: $ref: '#/components/schemas/LSEKeyIndicatorValue' description: Key indicator + security: + - Token: [] + summary: Get key indicator + tags: + - Prompts + x-fern-audiences: + - public x-fern-sdk-group-name: - - prompts - - indicators + - prompts + - indicators x-fern-sdk-method-name: get - x-fern-audiences: - - public /api/invite: get: - operationId: api_invite_retrieve description: Get invite link for organization - summary: Invite people - tags: - - Invites - security: - - Token: [] + operationId: api_invite_retrieve responses: '200': description: No response body + security: + - Token: [] + summary: Invite people + tags: + - Invites /api/invite/reset-token: post: + description: Reset the token used in the invitation link to invite someone to an organization. operationId: api_invite_reset_token_create - description: Reset the token used in the invitation link to invite someone to - an organization. - summary: Reset organization token - tags: - - Invites - security: - - Token: [] responses: '200': content: @@ -3897,17 +3809,19 @@ paths: schema: $ref: '#/components/schemas/OrganizationInvite' description: '' + security: + - Token: [] + summary: Reset organization token + tags: + - Invites + x-fern-audiences: + - public x-fern-sdk-group-name: organizations x-fern-sdk-method-name: reset_token - x-fern-audiences: - - public /api/invite/revoke: post: - operationId: api_invite_revoke_create description: Revoke invite - summary: Revoke invite - tags: - - Invites + operationId: api_invite_revoke_create requestBody: content: application/json: @@ -3920,18 +3834,18 @@ paths: schema: $ref: '#/components/schemas/RevokeInviteRequest' required: true - security: - - Token: [] responses: '200': description: No response body + security: + - Token: [] + summary: Revoke invite + tags: + - Invites /api/invite/send-email: post: - operationId: api_invite_send_email_create description: Send email with invite to organization - summary: Send email with invite - tags: - - Invites + operationId: api_invite_send_email_create requestBody: content: application/json: @@ -3944,20 +3858,18 @@ paths: schema: $ref: '#/components/schemas/SendInviteRequest' required: true - security: - - Token: [] responses: '200': description: No response body + security: + - Token: [] + summary: Send email with invite + tags: + - Invites /api/jwt/settings: get: - operationId: api_jwt_settings_retrieve description: Retrieve JWT settings for the currently active organization. - summary: Retrieve JWT Settings - tags: - - JWT - security: - - Token: [] + operationId: api_jwt_settings_retrieve responses: '200': content: @@ -3965,16 +3877,18 @@ paths: schema: $ref: '#/components/schemas/LSEJWTSettings' description: '' + security: + - Token: [] + summary: Retrieve JWT Settings + tags: + - JWT + x-fern-audiences: + - public x-fern-sdk-group-name: jwt_settings x-fern-sdk-method-name: get - x-fern-audiences: - - public post: - operationId: api_jwt_settings_create description: Update JWT settings for the currently active organization. - summary: Update JWT Settings - tags: - - JWT + operationId: api_jwt_settings_create requestBody: content: application/json: @@ -3986,8 +3900,6 @@ paths: multipart/form-data: schema: $ref: '#/components/schemas/LSEJWTSettingsRequest' - security: - - Token: [] responses: '201': content: @@ -3995,26 +3907,26 @@ paths: schema: $ref: '#/components/schemas/LSEJWTSettings' description: '' + security: + - Token: [] + summary: Update JWT Settings + tags: + - JWT + x-fern-audiences: + - public x-fern-sdk-group-name: jwt_settings x-fern-sdk-method-name: update - x-fern-audiences: - - public /api/label_links/: get: - operationId: api_label_links_list description: List label links for a specific label and project. - summary: List label links + operationId: api_label_links_list parameters: - - name: page - required: false - in: query - description: A page number within the paginated result set. - schema: - type: integer - tags: - - Labels - security: - - Token: [] + - description: A page number within the paginated result set. + in: query + name: page + required: false + schema: + type: integer responses: '200': content: @@ -4022,19 +3934,20 @@ paths: schema: $ref: '#/components/schemas/PaginatedLabelLinkList' description: '' + security: + - Token: [] + summary: List label links + tags: + - Labels + x-fern-audiences: + - internal x-fern-sdk-group-name: - - projects - - labels + - projects + - labels x-fern-sdk-method-name: list - x-fern-audiences: - - internal post: + description: Create label links to link new custom labels to your project labeling configuration. operationId: api_label_links_create - description: Create label links to link new custom labels to your project labeling - configuration. - summary: Create label links - tags: - - Labels requestBody: content: application/json: @@ -4047,8 +3960,6 @@ paths: schema: $ref: '#/components/schemas/LabelLinkRequest' required: true - security: - - Token: [] responses: '201': content: @@ -4056,27 +3967,50 @@ paths: schema: $ref: '#/components/schemas/LabelLink' description: '' + security: + - Token: [] + summary: Create label links + tags: + - Labels + x-fern-audiences: + - internal x-fern-sdk-group-name: - - projects - - labels + - projects + - labels x-fern-sdk-method-name: create - x-fern-audiences: - - internal /api/label_links/{id}/: + delete: + description: "\n Remove a label link that links custom labels to your project labeling configuration. If you remove a label link,\n the label stops being available for the project it was linked to. You can add a new label link at any time. \n " + operationId: api_label_links_destroy + parameters: + - in: path + name: id + required: true + schema: + type: string + responses: + '204': + description: No response body + security: + - Token: [] + summary: Remove label link + tags: + - Labels + x-fern-audiences: + - internal + x-fern-sdk-group-name: + - projects + - labels + x-fern-sdk-method-name: delete get: - operationId: api_label_links_retrieve description: 'Get label links for a specific project configuration. ' - summary: Get label link + operationId: api_label_links_retrieve parameters: - - in: path - name: id - schema: - type: string - required: true - tags: - - Labels - security: - - Token: [] + - in: path + name: id + required: true + schema: + type: string responses: '200': content: @@ -4084,27 +4018,26 @@ paths: schema: $ref: '#/components/schemas/LabelLink' description: '' + security: + - Token: [] + summary: Get label link + tags: + - Labels + x-fern-audiences: + - internal x-fern-sdk-group-name: - - projects - - labels + - projects + - labels x-fern-sdk-method-name: get - x-fern-audiences: - - internal patch: + description: "\n Update a label link that links custom labels to a project labeling configuration, for example if the fromName, \n toName, or name parameters for a tag in the labeling configuration change. \n " operationId: api_label_links_partial_update - description: "\n Update a label link that links custom labels to a project\ - \ labeling configuration, for example if the fromName, \n toName,\ - \ or name parameters for a tag in the labeling configuration change. \n \ - \ " - summary: Update label link parameters: - - in: path - name: id - schema: - type: string - required: true - tags: - - Labels + - in: path + name: id + required: true + schema: + type: string requestBody: content: application/json: @@ -4116,8 +4049,6 @@ paths: multipart/form-data: schema: $ref: '#/components/schemas/PatchedLabelLinkRequest' - security: - - Token: [] responses: '200': content: @@ -4125,61 +4056,34 @@ paths: schema: $ref: '#/components/schemas/LabelLink' description: '' - x-fern-sdk-group-name: - - projects - - labels - x-fern-sdk-method-name: update - x-fern-audiences: - - internal - delete: - operationId: api_label_links_destroy - description: "\n Remove a label link that links custom labels to your\ - \ project labeling configuration. If you remove a label link,\n the\ - \ label stops being available for the project it was linked to. You can add\ - \ a new label link at any time. \n " - summary: Remove label link - parameters: - - in: path - name: id - schema: - type: string - required: true - tags: - - Labels security: - - Token: [] - responses: - '204': - description: No response body - x-fern-sdk-group-name: - - projects - - labels - x-fern-sdk-method-name: delete + - Token: [] + summary: Update label link + tags: + - Labels x-fern-audiences: - - internal + - internal + x-fern-sdk-group-name: + - projects + - labels + x-fern-sdk-method-name: update /api/labels/: get: + description: List all custom labels added to your project separately from the labeling configuration. operationId: api_labels_list - description: List all custom labels added to your project separately from the - labeling configuration. - summary: List labels parameters: - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - - name: page - required: false - in: query - description: A page number within the paginated result set. - schema: - type: integer - tags: - - Labels - security: - - Token: [] + - description: Which field to use when ordering the results. + in: query + name: ordering + required: false + schema: + type: string + - description: A page number within the paginated result set. + in: query + name: page + required: false + schema: + type: integer responses: '200': content: @@ -4187,49 +4091,49 @@ paths: schema: $ref: '#/components/schemas/PaginatedLabelList' description: '' + security: + - Token: [] + summary: List labels + tags: + - Labels + x-fern-audiences: + - internal x-fern-sdk-group-name: labels x-fern-sdk-method-name: list - x-fern-audiences: - - internal post: - operationId: api_labels_create description: Add labels to your project without updating the labeling configuration. - summary: Create labels + operationId: api_labels_create parameters: - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - - name: page - required: false - in: query - description: A page number within the paginated result set. - schema: - type: integer - tags: - - Labels + - description: Which field to use when ordering the results. + in: query + name: ordering + required: false + schema: + type: string + - description: A page number within the paginated result set. + in: query + name: page + required: false + schema: + type: integer requestBody: content: application/json: schema: - type: array items: $ref: '#/components/schemas/LabelCreateRequest' + type: array application/x-www-form-urlencoded: schema: - type: array items: $ref: '#/components/schemas/LabelCreateRequest' + type: array multipart/form-data: schema: - type: array items: $ref: '#/components/schemas/LabelCreateRequest' + type: array required: true - security: - - Token: [] responses: '201': content: @@ -4237,26 +4141,64 @@ paths: schema: $ref: '#/components/schemas/PaginatedLabelCreateList' description: '' + security: + - Token: [] + summary: Create labels + tags: + - Labels + x-fern-audiences: + - internal x-fern-sdk-group-name: labels x-fern-sdk-method-name: create + /api/labels/bulk: + post: + description: "\n If you want to update the labels in saved annotations, use this endpoint.\n " + operationId: api_labels_bulk_create + responses: + '200': + description: No response body + security: + - Token: [] + summary: Bulk update labels + tags: + - Labels x-fern-audiences: - - internal + - internal + x-fern-sdk-group-name: + - projects + - labels + x-fern-sdk-method-name: update_many /api/labels/{id}/: + delete: + description: Remove labels from your project without updating the labeling configuration. + operationId: api_labels_destroy + parameters: + - in: path + name: id + required: true + schema: + type: string + responses: + '204': + description: No response body + security: + - Token: [] + summary: Remove labels + tags: + - Labels + x-fern-audiences: + - internal + x-fern-sdk-group-name: labels + x-fern-sdk-method-name: delete get: + description: "\n Retrieve a specific custom label used for your project by its ID.\n " operationId: api_labels_retrieve - description: "\n Retrieve a specific custom label used for your project\ - \ by its ID.\n " - summary: Get label parameters: - - in: path - name: id - schema: - type: string - required: true - tags: - - Labels - security: - - Token: [] + - in: path + name: id + required: true + schema: + type: string responses: '200': content: @@ -4264,23 +4206,24 @@ paths: schema: $ref: '#/components/schemas/Label' description: '' + security: + - Token: [] + summary: Get label + tags: + - Labels + x-fern-audiences: + - internal x-fern-sdk-group-name: labels x-fern-sdk-method-name: get - x-fern-audiences: - - internal patch: + description: Update labels used for your project without updating the labeling configuration. operationId: api_labels_partial_update - description: Update labels used for your project without updating the labeling - configuration. - summary: Update labels parameters: - - in: path - name: id - schema: - type: string - required: true - tags: - - Labels + - in: path + name: id + required: true + schema: + type: string requestBody: content: application/json: @@ -4292,8 +4235,6 @@ paths: multipart/form-data: schema: $ref: '#/components/schemas/PatchedLabelRequest' - security: - - Token: [] responses: '200': content: @@ -4301,132 +4242,119 @@ paths: schema: $ref: '#/components/schemas/Label' description: '' - x-fern-sdk-group-name: labels - x-fern-sdk-method-name: update - x-fern-audiences: - - internal - delete: - operationId: api_labels_destroy - description: Remove labels from your project without updating the labeling configuration. - summary: Remove labels - parameters: - - in: path - name: id - schema: - type: string - required: true - tags: - - Labels security: - - Token: [] - responses: - '204': - description: No response body - x-fern-sdk-group-name: labels - x-fern-sdk-method-name: delete + - Token: [] + summary: Update labels + tags: + - Labels x-fern-audiences: - - internal - /api/labels/bulk: + - internal + x-fern-sdk-group-name: labels + x-fern-sdk-method-name: update + /api/llm/openai/chat/completions: post: - operationId: api_labels_bulk_create - description: "\n If you want to update the labels in saved annotations,\ - \ use this endpoint.\n " - summary: Bulk update labels - tags: - - Labels - security: - - Token: [] + description: Proxy requests to OpenAI /chat/completions and return the full response payload. + operationId: api_llm_openai_chat_completions_create + requestBody: + content: + application/json: + schema: + additionalProperties: {} + type: object + application/x-www-form-urlencoded: + schema: + additionalProperties: {} + type: object + multipart/form-data: + schema: + additionalProperties: {} + type: object responses: '200': - description: No response body - x-fern-sdk-group-name: - - projects - - labels - x-fern-sdk-method-name: update_many + content: + application/json: + schema: + additionalProperties: {} + type: object + description: '' + security: + - Token: [] + summary: Proxy to OpenAI Chat Completions + tags: + - LLM x-fern-audiences: - - internal + - internal /api/ml/: get: + description: "\n List all configured ML backends for a specific project by ID.\n Use the following cURL command:\n ```bash\n curl http://localhost:8000/api/ml?project={project_id} -H 'Authorization: Token abc123'\n " operationId: api_ml_list - description: "\n List all configured ML backends for a specific project by\ - \ ID.\n Use the following cURL command:\n ```bash\n curl http://localhost:8000/api/ml?project={project_id}\ - \ -H 'Authorization: Token abc123'\n " - summary: List ML backends parameters: - - in: query - name: project - schema: - type: integer - description: Project ID - tags: - - Machine Learning - security: - - Token: [] + - description: Project ID + in: query + name: project + schema: + type: integer responses: '200': content: application/json: schema: - type: array items: $ref: '#/components/schemas/MLBackend' + type: array description: '' + security: + - Token: [] + summary: List ML backends + tags: + - Machine Learning + x-fern-audiences: + - public x-fern-sdk-group-name: ml x-fern-sdk-method-name: list - x-fern-audiences: - - public post: + description: "\n Add an ML backend to a project using the Label Studio UI or by sending a POST request using the following cURL \n command:\n ```bash\n curl -X POST -H 'Content-type: application/json' http://localhost:8000/api/ml -H 'Authorization: Token abc123'\\\n --data '{\"url\": \"http://localhost:9090\", \"project\": {project_id}}' \n " operationId: api_ml_create - description: "\n Add an ML backend to a project using the Label Studio UI\ - \ or by sending a POST request using the following cURL \n command:\n \ - \ ```bash\n curl -X POST -H 'Content-type: application/json' http://localhost:8000/api/ml\ - \ -H 'Authorization: Token abc123'\\\n --data '{\"url\": \"http://localhost:9090\"\ - , \"project\": {project_id}}' \n " - summary: Add ML Backend - tags: - - Machine Learning requestBody: content: application/json: schema: - type: object properties: - url: + auth_method: + description: Auth method + enum: + - NONE + - BASIC_AUTH type: string - description: ML backend URL - project: - type: integer - description: Project ID - is_interactive: - type: boolean - description: Is interactive - title: + basic_auth_pass: + description: Basic auth password type: string - description: Title - description: - type: string - description: Description - auth_method: - type: string - description: Auth method - enum: - - NONE - - BASIC_AUTH basic_auth_user: - type: string description: Basic auth user - basic_auth_pass: type: string - description: Basic auth password + description: + description: Description + type: string extra_params: - type: object description: Extra parameters - timeout: + type: object + is_interactive: + description: Is interactive + type: boolean + project: + description: Project ID type: integer + timeout: description: Response model timeout + type: integer + title: + description: Title + type: string + url: + description: ML backend URL + type: string required: [] - security: - - Token: [] + type: object responses: '201': content: @@ -4434,28 +4362,46 @@ paths: schema: $ref: '#/components/schemas/MLBackend' description: '' + security: + - Token: [] + summary: Add ML Backend + tags: + - Machine Learning + x-fern-audiences: + - public x-fern-sdk-group-name: ml x-fern-sdk-method-name: create - x-fern-audiences: - - public /api/ml/{id}: + delete: + description: "\n Remove an existing ML backend connection by ID. For example, use the\n following cURL command:\n ```bash\n curl -X DELETE http://localhost:8000/api/ml/{ml_backend_ID} -H 'Authorization: Token abc123'\n " + operationId: api_ml_destroy + parameters: + - in: path + name: id + required: true + schema: + type: integer + responses: + '204': + description: No response body + security: + - Token: [] + summary: Remove ML Backend + tags: + - Machine Learning + x-fern-audiences: + - public + x-fern-sdk-group-name: ml + x-fern-sdk-method-name: delete get: + description: "\n Get details about a specific ML backend connection by ID. For example, make a GET request using the\n following cURL command:\n ```bash\n curl http://localhost:8000/api/ml/{ml_backend_ID} -H 'Authorization: Token abc123'\n " operationId: api_ml_retrieve - description: "\n Get details about a specific ML backend connection by ID.\ - \ For example, make a GET request using the\n following cURL command:\n\ - \ ```bash\n curl http://localhost:8000/api/ml/{ml_backend_ID} -H 'Authorization:\ - \ Token abc123'\n " - summary: Get ML Backend parameters: - - in: path - name: id - schema: - type: integer - required: true - tags: - - Machine Learning - security: - - Token: [] + - in: path + name: id + required: true + schema: + type: integer responses: '200': content: @@ -4463,68 +4409,64 @@ paths: schema: $ref: '#/components/schemas/MLBackend' description: '' + security: + - Token: [] + summary: Get ML Backend + tags: + - Machine Learning + x-fern-audiences: + - public x-fern-sdk-group-name: ml x-fern-sdk-method-name: get - x-fern-audiences: - - public patch: + description: "\n Update ML backend parameters using the Label Studio UI or by sending a PATCH request using the following cURL command:\n ```bash\n curl -X PATCH -H 'Content-type: application/json' http://localhost:8000/api/ml/{ml_backend_ID} -H 'Authorization: Token abc123'\\\n --data '{\"url\": \"http://localhost:9091\"}' \n " operationId: api_ml_partial_update - description: "\n Update ML backend parameters using the Label Studio UI or\ - \ by sending a PATCH request using the following cURL command:\n ```bash\n\ - \ curl -X PATCH -H 'Content-type: application/json' http://localhost:8000/api/ml/{ml_backend_ID}\ - \ -H 'Authorization: Token abc123'\\\n --data '{\"url\": \"http://localhost:9091\"\ - }' \n " - summary: Update ML Backend parameters: - - in: path - name: id - schema: - type: integer - required: true - tags: - - Machine Learning + - in: path + name: id + required: true + schema: + type: integer requestBody: content: application/json: schema: - type: object properties: - url: - type: string - description: ML backend URL - project: - type: integer - description: Project ID - is_interactive: - type: boolean - description: Is interactive - title: - type: string - description: Title - description: - type: string - description: Description auth_method: - type: string description: Auth method enum: - - NONE - - BASIC_AUTH - basic_auth_user: + - NONE + - BASIC_AUTH type: string - description: Basic auth user basic_auth_pass: - type: string description: Basic auth password + type: string + basic_auth_user: + description: Basic auth user + type: string + description: + description: Description + type: string extra_params: - type: object description: Extra parameters - timeout: + type: object + is_interactive: + description: Is interactive + type: boolean + project: + description: Project ID type: integer + timeout: description: Response model timeout + type: integer + title: + description: Title + type: string + url: + description: ML backend URL + type: string required: [] - security: - - Token: [] + type: object responses: '200': content: @@ -4532,50 +4474,26 @@ paths: schema: $ref: '#/components/schemas/MLBackend' description: '' - x-fern-sdk-group-name: ml - x-fern-sdk-method-name: update - x-fern-audiences: - - public - delete: - operationId: api_ml_destroy - description: "\n Remove an existing ML backend connection by ID. For example,\ - \ use the\n following cURL command:\n ```bash\n curl -X DELETE http://localhost:8000/api/ml/{ml_backend_ID}\ - \ -H 'Authorization: Token abc123'\n " - summary: Remove ML Backend - parameters: - - in: path - name: id - schema: - type: integer - required: true - tags: - - Machine Learning security: - - Token: [] - responses: - '204': - description: No response body - x-fern-sdk-group-name: ml - x-fern-sdk-method-name: delete + - Token: [] + summary: Update ML Backend + tags: + - Machine Learning x-fern-audiences: - - public + - public + x-fern-sdk-group-name: ml + x-fern-sdk-method-name: update /api/ml/{id}/interactive-annotating: post: + description: "\n Send a request to the machine learning backend set up to be used for interactive preannotations to retrieve a\n predicted region based on annotator input. \n See [set up machine learning](https://labelstud.io/guide/ml.html#Get-interactive-preannotations) for more.\n " operationId: api_ml_interactive_annotating_create - description: "\n Send a request to the machine learning backend set up\ - \ to be used for interactive preannotations to retrieve a\n predicted\ - \ region based on annotator input. \n See [set up machine learning](https://labelstud.io/guide/ml.html#Get-interactive-preannotations)\ - \ for more.\n " - summary: Request Interactive Annotation parameters: - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this ML backend. - required: true - tags: - - Machine Learning + - description: A unique integer value identifying this ML backend. + in: path + name: id + required: true + schema: + type: integer requestBody: content: application/json: @@ -4588,64 +4506,53 @@ paths: schema: $ref: '#/components/schemas/MLInteractiveAnnotatingRequestRequest' required: true - security: - - Token: [] responses: '200': description: Interactive annotation has succeeded. + security: + - Token: [] + summary: Request Interactive Annotation + tags: + - Machine Learning + x-fern-audiences: + - public x-fern-sdk-group-name: ml x-fern-sdk-method-name: predict_interactive - x-fern-audiences: - - public /api/ml/{id}/predict: post: + description: "\n Create predictions for all tasks using a specific ML backend so that you can set up an active learning strategy\n based on the confidence or uncertainty scores associated with the predictions. Creating predictions requires \n a Label Studio ML backend set up and configured for your project. \n\n See [Set up machine learning](https://labelstud.io/guide/ml.html) for more details \n about a Label Studio ML backend.\n\n Reference the ML backend ID in the path of this API call. Get the ML backend ID by \n [listing the ML backends for a project](https://labelstud.io/api/#operation/api_ml_list).\n " operationId: api_ml_predict_create - description: "\n Create predictions for all tasks using a specific ML\ - \ backend so that you can set up an active learning strategy\n based\ - \ on the confidence or uncertainty scores associated with the predictions.\ - \ Creating predictions requires \n a Label Studio ML backend set up\ - \ and configured for your project. \n\n See [Set up machine learning](https://labelstud.io/guide/ml.html)\ - \ for more details \n about a Label Studio ML backend.\n\n Reference\ - \ the ML backend ID in the path of this API call. Get the ML backend ID by\ - \ \n [listing the ML backends for a project](https://labelstud.io/api/#operation/api_ml_list).\n\ - \ " - summary: Create predictions parameters: - - in: query - name: batch_size - schema: - type: integer - description: Computed number of tasks without predictions that the ML backend - needs to predict. - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this ML backend. - required: true - tags: - - Machine Learning - security: - - Token: [] + - description: Computed number of tasks without predictions that the ML backend needs to predict. + in: query + name: batch_size + schema: + type: integer + - description: A unique integer value identifying this ML backend. + in: path + name: id + required: true + schema: + type: integer responses: '200': description: Predictions have successfully started. + security: + - Token: [] + summary: Create predictions + tags: + - Machine Learning /api/ml/{id}/predict/test: post: + description: "\n After you add an ML backend, call this API with the ML backend ID to run a test prediction on specific task data \n " operationId: api_ml_predict_test_create - description: "\n After you add an ML backend, call this API with the\ - \ ML backend ID to run a test prediction on specific task data \ - \ \n " - summary: Test prediction parameters: - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this ML backend. - required: true - tags: - - Machine Learning + - description: A unique integer value identifying this ML backend. + in: path + name: id + required: true + schema: + type: integer requestBody: content: application/json: @@ -4658,8 +4565,6 @@ paths: schema: $ref: '#/components/schemas/MLBackendRequest' required: true - security: - - Token: [] responses: '200': description: Predicting has successfully started. @@ -4668,41 +4573,38 @@ paths: application/json: schema: description: Error message - type: string example: Server responded with an error. + type: string description: Predicting error + security: + - Token: [] + summary: Test prediction + tags: + - Machine Learning + x-fern-audiences: + - internal x-fern-sdk-group-name: ml x-fern-sdk-method-name: test_predict - x-fern-audiences: - - internal /api/ml/{id}/train: post: + description: "\n After you add an ML backend, call this API with the ML backend ID to start training with \n already-labeled tasks. \n \n Get the ML backend ID by [listing the ML backends for a project](https://labelstud.io/api/#operation/api_ml_list).\n " operationId: api_ml_train_create - description: "\n After you add an ML backend, call this API with the\ - \ ML backend ID to start training with \n already-labeled tasks. \n\ - \ \n Get the ML backend ID by [listing the ML backends for a\ - \ project](https://labelstud.io/api/#operation/api_ml_list).\n " - summary: Train parameters: - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this ML backend. - required: true - tags: - - Machine Learning + - description: A unique integer value identifying this ML backend. + in: path + name: id + required: true + schema: + type: integer requestBody: content: application/json: schema: - type: object properties: use_ground_truth: - type: boolean description: Whether to include ground truth annotations in training - security: - - Token: [] + type: boolean + type: object responses: '200': description: Training has successfully started. @@ -4711,81 +4613,83 @@ paths: application/json: schema: description: Error message - type: string example: Server responded with an error. + type: string description: Training error + security: + - Token: [] + summary: Train + tags: + - Machine Learning + x-fern-audiences: + - public x-fern-sdk-group-name: ml x-fern-sdk-method-name: train - x-fern-audiences: - - public /api/ml/{id}/versions: get: - operationId: api_ml_versions_retrieve description: Get available versions of the model. - summary: Get model versions + operationId: api_ml_versions_retrieve parameters: - - in: path - name: id - schema: - type: integer - required: true - tags: - - Machine Learning - security: - - Token: [] + - in: path + name: id + required: true + schema: + type: integer responses: '200': content: application/json: schema: - type: object properties: + message: + type: string versions: - type: array items: type: string - message: - type: string + type: array + type: object description: List of available versions. + security: + - Token: [] + summary: Get model versions + tags: + - Machine Learning + x-fern-audiences: + - public x-fern-sdk-group-name: ml x-fern-sdk-method-name: list_model_versions - x-fern-audiences: - - public /api/model-provider-connections/: get: - operationId: api_model_provider_connections_list description: List all model provider connections. - summary: List model provider connections + operationId: api_model_provider_connections_list parameters: - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - tags: - - Model Provider Connection - security: - - Token: [] + - description: Which field to use when ordering the results. + in: query + name: ordering + required: false + schema: + type: string responses: '200': content: application/json: schema: - type: array items: $ref: '#/components/schemas/ModelProviderConnection' + type: array description: '' + security: + - Token: [] + summary: List model provider connections + tags: + - Model Provider Connection + x-fern-audiences: + - public x-fern-sdk-group-name: model_providers x-fern-sdk-method-name: list - x-fern-audiences: - - public post: - operationId: api_model_provider_connections_create description: Create a new model provider connection. - summary: Create model provider connection - tags: - - Model Provider Connection + operationId: api_model_provider_connections_create requestBody: content: application/json: @@ -4797,8 +4701,6 @@ paths: multipart/form-data: schema: $ref: '#/components/schemas/ModelProviderConnectionRequest' - security: - - Token: [] responses: '201': content: @@ -4806,61 +4708,71 @@ paths: schema: $ref: '#/components/schemas/ModelProviderConnection' description: '' + security: + - Token: [] + summary: Create model provider connection + tags: + - Model Provider Connection + x-fern-audiences: + - public x-fern-sdk-group-name: model_providers x-fern-sdk-method-name: create - x-fern-audiences: - - public - /api/model-provider-connections/{id}/: + /api/model-provider-connections/provider-choices: get: - operationId: api_model_provider_connections_retrieve - description: Retrieve a specific model provider connection. - summary: Get model provider connection - parameters: - - in: path - name: id - schema: - type: string - required: true - tags: - - Model Provider Connection - security: - - Token: [] + description: List all possible model provider choices + operationId: api_model_provider_connections_provider_choices_retrieve responses: '200': content: application/json: schema: - $ref: '#/components/schemas/ModelProviderConnection' - description: '' - x-fern-sdk-group-name: model_providers - x-fern-sdk-method-name: get + properties: + provider_choices: + items: + type: string + type: array + type: object + description: List of model provider choices + security: + - Token: [] + summary: List model provider choices + tags: + - Model Provider Connection x-fern-audiences: - - public - put: - operationId: api_model_provider_connections_update - description: Overwrite a specific model provider connection by ID. - summary: Put model provider connection + - public + x-fern-sdk-group-name: model_providers + x-fern-sdk-method-name: list_model_provider_choices + /api/model-provider-connections/{id}/: + delete: + description: Delete a model provider connection by ID + operationId: api_model_provider_connections_destroy parameters: - - in: path - name: id - schema: - type: string - required: true - tags: - - Model Provider Connection - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ModelProviderConnectionRequest' - application/x-www-form-urlencoded: - schema: - $ref: '#/components/schemas/ModelProviderConnectionRequest' - multipart/form-data: - schema: - $ref: '#/components/schemas/ModelProviderConnectionRequest' + - in: path + name: id + required: true + schema: + type: string + responses: + '204': + description: No response body security: - - Token: [] + - Token: [] + summary: Delete model provider connection + tags: + - Model Provider Connection + x-fern-audiences: + - public + x-fern-sdk-group-name: model_providers + x-fern-sdk-method-name: delete + get: + description: Retrieve a specific model provider connection. + operationId: api_model_provider_connections_retrieve + parameters: + - in: path + name: id + required: true + schema: + type: string responses: '200': content: @@ -4868,20 +4780,24 @@ paths: schema: $ref: '#/components/schemas/ModelProviderConnection' description: '' + security: + - Token: [] + summary: Get model provider connection + tags: + - Model Provider Connection x-fern-audiences: - - internal + - public + x-fern-sdk-group-name: model_providers + x-fern-sdk-method-name: get patch: - operationId: api_model_provider_connections_partial_update description: Update a specific model provider connection by ID. - summary: Update model provider connection + operationId: api_model_provider_connections_partial_update parameters: - - in: path - name: id - schema: - type: string - required: true - tags: - - Model Provider Connection + - in: path + name: id + required: true + schema: + type: string requestBody: content: application/json: @@ -4893,8 +4809,6 @@ paths: multipart/form-data: schema: $ref: '#/components/schemas/PatchedModelProviderConnectionRequest' - security: - - Token: [] responses: '200': content: @@ -4902,70 +4816,59 @@ paths: schema: $ref: '#/components/schemas/ModelProviderConnection' description: '' + security: + - Token: [] + summary: Update model provider connection + tags: + - Model Provider Connection + x-fern-audiences: + - public x-fern-sdk-group-name: model_providers x-fern-sdk-method-name: update - x-fern-audiences: - - public - delete: - operationId: api_model_provider_connections_destroy - description: Delete a model provider connection by ID - summary: Delete model provider connection + put: + description: Overwrite a specific model provider connection by ID. + operationId: api_model_provider_connections_update parameters: - - in: path - name: id - schema: - type: string - required: true - tags: - - Model Provider Connection - security: - - Token: [] - responses: - '204': - description: No response body - x-fern-sdk-group-name: model_providers - x-fern-sdk-method-name: delete - x-fern-audiences: - - public - /api/model-provider-connections/provider-choices: - get: - operationId: api_model_provider_connections_provider_choices_retrieve - description: List all possible model provider choices - summary: List model provider choices - tags: - - Model Provider Connection - security: - - Token: [] + - in: path + name: id + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ModelProviderConnectionRequest' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/ModelProviderConnectionRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/ModelProviderConnectionRequest' responses: '200': content: application/json: schema: - type: object - properties: - provider_choices: - type: array - items: - type: string - description: List of model provider choices - x-fern-sdk-group-name: model_providers - x-fern-sdk-method-name: list_model_provider_choices + $ref: '#/components/schemas/ModelProviderConnection' + description: '' + security: + - Token: [] + summary: Put model provider connection + tags: + - Model Provider Connection x-fern-audiences: - - public + - internal /api/model-run/batch-failed-predictions: post: - operationId: api_model_run_batch_failed_predictions_create description: Create a new batch of failed predictions. - summary: Create batch of failed predictions + operationId: api_model_run_batch_failed_predictions_create parameters: - - in: query - name: num_failed_predictions - schema: - type: integer - description: Number of failed predictions being sent (for telemetry only, - has no effect) - tags: - - Prompts + - description: Number of failed predictions being sent (for telemetry only, has no effect) + in: query + name: num_failed_predictions + schema: + type: integer requestBody: content: application/json: @@ -4978,8 +4881,6 @@ paths: schema: $ref: '#/components/schemas/BatchFailedPredictionsRequestRequest' required: true - security: - - Token: [] responses: '201': content: @@ -4987,24 +4888,25 @@ paths: schema: $ref: '#/components/schemas/BatchFailedPredictions' description: '' + security: + - Token: [] + summary: Create batch of failed predictions + tags: + - Prompts + x-fern-audiences: + - public x-fern-sdk-group-name: prompts x-fern-sdk-method-name: batch_failed_predictions - x-fern-audiences: - - public /api/model-run/batch-predictions: post: - operationId: api_model_run_batch_predictions_create description: Create a new batch prediction. - summary: Create batch predictions + operationId: api_model_run_batch_predictions_create parameters: - - in: query - name: num_predictions - schema: - type: integer - description: Number of predictions being sent (for telemetry only, has no - effect) - tags: - - Prompts + - description: Number of predictions being sent (for telemetry only, has no effect) + in: query + name: num_predictions + schema: + type: integer requestBody: content: application/json: @@ -5017,8 +4919,6 @@ paths: schema: $ref: '#/components/schemas/BatchPredictionsRequestRequest' required: true - security: - - Token: [] responses: '201': content: @@ -5026,55 +4926,54 @@ paths: schema: $ref: '#/components/schemas/BatchPredictions' description: '' + security: + - Token: [] + summary: Create batch predictions + tags: + - Prompts + x-fern-audiences: + - public x-fern-sdk-group-name: prompts x-fern-sdk-method-name: batch_predictions - x-fern-audiences: - - public /api/organizations/: get: + description: "\n Return a list of the organizations you've created or that you have access to.\n " operationId: api_organizations_list - description: "\n Return a list of the organizations you've created or\ - \ that you have access to.\n " - summary: List your organizations parameters: - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - tags: - - Organizations - security: - - Token: [] + - description: Which field to use when ordering the results. + in: query + name: ordering + required: false + schema: + type: string responses: '200': content: application/json: schema: - type: array items: $ref: '#/components/schemas/OrganizationId' + type: array description: '' + security: + - Token: [] + summary: List your organizations + tags: + - Organizations + x-fern-audiences: + - public x-fern-sdk-group-name: organizations x-fern-sdk-method-name: list - x-fern-audiences: - - public /api/organizations/{id}: get: - operationId: api_organizations_retrieve description: Retrieve the settings for a specific organization by ID. - summary: Get organization settings + operationId: api_organizations_retrieve parameters: - - in: path - name: id - schema: - type: integer - required: true - tags: - - Organizations - security: - - Token: [] + - in: path + name: id + required: true + schema: + type: integer responses: '200': content: @@ -5082,23 +4981,24 @@ paths: schema: $ref: '#/components/schemas/LseOrganization' description: '' + security: + - Token: [] + summary: Get organization settings + tags: + - Organizations + x-fern-audiences: + - public x-fern-sdk-group-name: organizations x-fern-sdk-method-name: get - x-fern-audiences: - - public patch: + description: Update organization details including title, embed domains, and custom scripts settings. operationId: api_organizations_partial_update - description: Update organization details including title, embed domains, and - custom scripts settings. - summary: Update organization parameters: - - in: path - name: id - schema: - type: integer - required: true - tags: - - Organizations + - in: path + name: id + required: true + schema: + type: integer requestBody: content: application/json: @@ -5110,8 +5010,6 @@ paths: multipart/form-data: schema: $ref: '#/components/schemas/PatchedLseOrganizationSerializerUpdateRequest' - security: - - Token: [] responses: '200': content: @@ -5125,58 +5023,56 @@ paths: description: Permission Denied '404': description: Not Found + security: + - Token: [] + summary: Update organization + tags: + - Organizations /api/organizations/{id}/memberships: get: - operationId: api_organizations_memberships_list description: Retrieve a list of all users and roles in a specific organization. - summary: Get organization members/roles + operationId: api_organizations_memberships_list parameters: - - in: query - name: exclude_project_id - schema: - type: integer - description: Project ID to exclude users who are already associated with this - project (direct members, workspace members, or implicit admin/owner access). - - in: query - name: exclude_workspace_id - schema: - type: integer - description: Workspace ID to exclude users who are already associated with - this workspace (direct workspace members or implicit admin/owner access). - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this organization. - required: true - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - - name: page - required: false - in: query - description: A page number within the paginated result set. - schema: - type: integer - - name: page_size - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - name: search - required: false - in: query - description: A search term. - schema: - type: string - tags: - - Organizations - security: - - Token: [] + - description: Project ID to exclude users who are already associated with this project (direct members, workspace members, or implicit admin/owner access). + in: query + name: exclude_project_id + schema: + type: integer + - description: Workspace ID to exclude users who are already associated with this workspace (direct workspace members or implicit admin/owner access). + in: query + name: exclude_workspace_id + schema: + type: integer + - description: A unique integer value identifying this organization. + in: path + name: id + required: true + schema: + type: integer + - description: Which field to use when ordering the results. + in: query + name: ordering + required: false + schema: + type: string + - description: A page number within the paginated result set. + in: query + name: page + required: false + schema: + type: integer + - description: Number of results to return per page. + in: query + name: page_size + required: false + schema: + type: integer + - description: A search term. + in: query + name: search + required: false + schema: + type: string responses: '200': content: @@ -5184,82 +5080,41 @@ paths: schema: $ref: '#/components/schemas/PaginatedLseOrganizationMemberListList' description: '' - post: - operationId: api_organizations_memberships_create - description: "\n Assign a role to a user in an organization. To do so, make\ - \ the following cURL request:\n\n ```bash\n curl -H 'Content-Type: application/json'\ - \ -H 'Authorization: Token abc123' \\\n -X POST 'https://label-studio-host/api/organizations/{{id}}/memberships'\ - \ --data '[{{\"user_id\": Int, \"role\": \"NO|DI|OW|AD|MA|AN|RE\" }}]'\n \ - \ ```\n \n Enumerate a role with one of the following abbreviations:\n\ - \n | Role | Full Role Name |\n | --- | --- |\n | NO | Not Activated\ - \ |\n | DI | Deactivated |\n | OW | Owner |\n | AD | Administrator\ - \ |\n | MA | Manager |\n | AN | Annotator |\n | RE | Reviewer |\n\ - \n For example, to set a user with an ID of 9 as an annotator, make the\ - \ following cURL request:\n ```bash\n curl -H 'Content-Type: application/json'\ - \ -H 'Authorization: Token abc123' \\\n -X POST 'https://label-studio-host/api/organizations/{{id}}/memberships'\ - \ --data '[{{\"user_id\": 9, \"role\": \"AN\" }}]'\n ```\n " - summary: Create organization member/role - parameters: - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this organization. - required: true - tags: - - Organizations - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/OrganizationMemberCreateUpdateRequest' - application/x-www-form-urlencoded: - schema: - $ref: '#/components/schemas/OrganizationMemberCreateUpdateRequest' - multipart/form-data: - schema: - $ref: '#/components/schemas/OrganizationMemberCreateUpdateRequest' - required: true security: - - Token: [] - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/LseOrganizationMemberList' - description: '' + - Token: [] + summary: Get organization members/roles + tags: + - Organizations + x-fern-audiences: + - public + x-fern-sdk-group-name: + - organizations + - members + x-fern-sdk-method-name: list patch: + description: |+ + Update organization membership or role for a specific user ID. + + **User Rotation Best Practices for API Usage** + + To maintain compliance with our licensing terms and ensure optimal performance of HumanSignal's APIs, please consider the following guidelines when managing user assignments: + + * **Maintain a 7-Day Minimum Assignment**: Once a licensed seat is assigned to a user, maintain that assignment for at least seven consecutive days before rotating it to another user. + + * **Automate, Monitor, and Log Rotations**: Implement automated scheduling and logging mechanisms to track the timing of user rotations. This helps ensure that rotations adhere to the seven-day minimum period. + + * **Adhere to API Update Frequency and Wait Periods**: When updating user assignments via our APIs, follow the recommended frequency and wait period guidelines provided in the HumanSignal API documentation. Avoid sending rapid, successive requests that might overload the endpoint. Instead, incorporate appropriate delays between calls as specified in the documentation. + + * **Avoid Overloading the API Endpoint**: Design your integration to batch or schedule updates where possible, and implement backoff strategies if the API indicates rate limiting. This helps prevent service disruptions and ensures a smooth operation. + operationId: api_organizations_memberships_partial_update - description: "\n Update organization membership or role for a specific user\ - \ ID.\n\n **User Rotation Best Practices for API Usage**\n \n To\ - \ maintain compliance with our licensing terms and ensure optimal performance\ - \ of HumanSignal's APIs, please consider the following guidelines when managing\ - \ user assignments:\n \n * **Maintain a 7-Day Minimum Assignment**:\ - \ Once a licensed seat is assigned to a user, maintain that assignment for\ - \ at least seven consecutive days before rotating it to another user.\n\n\ - \ * **Automate, Monitor, and Log Rotations**: Implement automated scheduling\ - \ and logging mechanisms to track the timing of user rotations. This helps\ - \ ensure that rotations adhere to the seven-day minimum period.\n\n * **Adhere\ - \ to API Update Frequency and Wait Periods**: When updating user assignments\ - \ via our APIs, follow the recommended frequency and wait period guidelines\ - \ provided in the HumanSignal API documentation. Avoid sending rapid, successive\ - \ requests that might overload the endpoint. Instead, incorporate appropriate\ - \ delays between calls as specified in the documentation.\n \n * **Avoid\ - \ Overloading the API Endpoint**: Design your integration to batch or schedule\ - \ updates where possible, and implement backoff strategies if the API indicates\ - \ rate limiting. This helps prevent service disruptions and ensures a smooth\ - \ operation.\n " - summary: Update organization member/role parameters: - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this organization. - required: true - tags: - - Organizations + - description: A unique integer value identifying this organization. + in: path + name: id + required: true + schema: + type: integer requestBody: content: application/json: @@ -5271,8 +5126,6 @@ paths: multipart/form-data: schema: $ref: '#/components/schemas/PatchedOrganizationMemberCreateUpdateRequest' - security: - - Token: [] responses: '200': content: @@ -5280,28 +5133,68 @@ paths: schema: $ref: '#/components/schemas/LseOrganizationMemberList' description: '' + security: + - Token: [] + summary: Update organization member/role + tags: + - Organizations + x-fern-audiences: + - public + x-fern-sdk-group-name: + - organizations + - members + x-fern-sdk-method-name: update /api/organizations/{id}/memberships/{user_pk}/: + delete: + description: Soft delete a member from the organization. + operationId: api_organizations_memberships_destroy + parameters: + - in: path + name: id + required: true + schema: + type: integer + - description: A unique integer value identifying the user to be deleted from the organization. + in: path + name: user_pk + required: true + schema: + type: integer + responses: + '204': + description: Member deleted successfully. + '403': + description: You can delete members only for your current active organization + '404': + description: Member not found + '405': + description: User cannot soft delete self. + security: + - Token: [] + summary: Soft delete an organization member + tags: + - Organizations + x-fern-audiences: + - public + x-fern-sdk-group-name: + - organizations + - members + x-fern-sdk-method-name: delete get: - operationId: api_organizations_memberships_retrieve description: Get organization member details by user ID. - summary: Get organization member details + operationId: api_organizations_memberships_retrieve parameters: - - in: path - name: id - schema: - type: integer - required: true - - in: path - name: user_pk - schema: - type: integer - description: A unique integer value identifying the user to get organization - details for. - required: true - tags: - - Organizations - security: - - Token: [] + - in: path + name: id + required: true + schema: + type: integer + - description: A unique integer value identifying the user to get organization details for. + in: path + name: user_pk + required: true + schema: + type: integer responses: '200': content: @@ -5309,61 +5202,27 @@ paths: schema: $ref: '#/components/schemas/OrganizationMember' description: '' - x-fern-sdk-group-name: - - organizations - - members - x-fern-sdk-method-name: get - x-fern-audiences: - - public - delete: - operationId: api_organizations_memberships_destroy - description: Soft delete a member from the organization. - summary: Soft delete an organization member - parameters: - - in: path - name: id - schema: - type: integer - required: true - - in: path - name: user_pk - schema: - type: integer - description: A unique integer value identifying the user to be deleted from - the organization. - required: true - tags: - - Organizations security: - - Token: [] - responses: - '204': - description: Member deleted successfully. - '405': - description: User cannot soft delete self. - '404': - description: Member not found - '403': - description: You can delete members only for your current active organization - x-fern-sdk-group-name: - - organizations - - members - x-fern-sdk-method-name: delete + - Token: [] + summary: Get organization member details + tags: + - Organizations x-fern-audiences: - - public + - public + x-fern-sdk-group-name: + - organizations + - members + x-fern-sdk-method-name: get /api/organizations/{id}/set-default-role: patch: - operationId: api_organizations_set_default_role_partial_update description: Update the default role for members of a specific organization. - summary: Update default role + operationId: api_organizations_set_default_role_partial_update parameters: - - in: path - name: id - schema: - type: integer - required: true - tags: - - Organizations + - in: path + name: id + required: true + schema: + type: integer requestBody: content: application/json: @@ -5375,8 +5234,6 @@ paths: multipart/form-data: schema: $ref: '#/components/schemas/PatchedDefaultRoleRequest' - security: - - Token: [] responses: '200': content: @@ -5384,494 +5241,481 @@ paths: schema: $ref: '#/components/schemas/DefaultRole' description: '' + security: + - Token: [] + summary: Update default role + tags: + - Organizations /api/predictions/: get: - operationId: api_predictions_list description: List all predictions and their IDs. - summary: List predictions + operationId: api_predictions_list parameters: - - in: query - name: project - schema: - type: integer - description: Filter predictions by project ID - - in: query - name: task - schema: - type: integer - description: Filter predictions by task ID - tags: - - Predictions - security: - - Token: [] + - description: Filter predictions by project ID + in: query + name: project + schema: + type: integer + - description: Filter predictions by task ID + in: query + name: task + schema: + type: integer responses: '200': content: application/json: - schema: - type: array - items: - $ref: '#/components/schemas/Prediction' examples: Response: - value: - - - id: 1 - task: 1 - result: - - original_width: 1920 - original_height: 1080 - image_rotation: 0 - from_name: bboxes - to_name: image - type: rectanglelabels - value: - x: 20 - y: 30 - width: 50 - height: 60 - rotation: 0 - values: - rectanglelabels: - - Person - score: 0.95 - model_version: yolo-v8 summary: response + value: + - - id: 1 + model_version: yolo-v8 + result: + - from_name: bboxes + image_rotation: 0 + original_height: 1080 + original_width: 1920 + to_name: image + type: rectanglelabels + value: + height: 60 + rotation: 0 + values: + rectanglelabels: + - Person + width: 50 + x: 20 + y: 30 + score: 0.95 + task: 1 + schema: + items: + $ref: '#/components/schemas/Prediction' + type: array description: Predictions list + security: + - Token: [] + summary: List predictions + tags: + - Predictions + x-fern-audiences: + - public x-fern-sdk-group-name: predictions x-fern-sdk-method-name: list - x-fern-audiences: - - public post: - operationId: api_predictions_create description: Create a prediction for a specific task. - summary: Create prediction - tags: - - Predictions + operationId: api_predictions_create requestBody: content: application/json: schema: - type: object - properties: - task: - type: integer - description: Task ID for which the prediction is created + example: + model_version: yolo-v8 result: - type: array - items: - type: object - description: Prediction result in JSON format. Read more about the - format in [the Label Studio documentation.](https://labelstud.io/guide/predictions) - example: - - original_width: 1920 - original_height: 1080 + - from_name: bboxes image_rotation: 0 - from_name: bboxes + original_height: 1080 + original_width: 1920 to_name: image type: rectanglelabels value: - x: 20 - y: 30 - width: 50 height: 60 rotation: 0 values: rectanglelabels: - - Person - score: - type: number - description: Prediction score. Can be used in Data Manager to sort - task by model confidence. Task with the lowest score will be shown - first. - example: 0.95 + - Person + width: 50 + x: 20 + y: 30 + score: 0.95 + properties: model_version: - type: string - description: 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 + description: 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 example: yolo-v8 - example: + type: string result: - - original_width: 1920 - original_height: 1080 - image_rotation: 0 - from_name: bboxes - to_name: image - type: rectanglelabels - value: - x: 20 - y: 30 - width: 50 - height: 60 - rotation: 0 - values: - rectanglelabels: - - Person - score: 0.95 - model_version: yolo-v8 - security: - - Token: [] + description: Prediction result in JSON format. Read more about the format in [the Label Studio documentation.](https://labelstud.io/guide/predictions) + example: + - from_name: bboxes + image_rotation: 0 + original_height: 1080 + original_width: 1920 + to_name: image + type: rectanglelabels + value: + height: 60 + rotation: 0 + values: + rectanglelabels: + - Person + width: 50 + x: 20 + y: 30 + items: + type: object + type: array + score: + description: Prediction score. Can be used in Data Manager to sort task by model confidence. Task with the lowest score will be shown first. + example: 0.95 + type: number + task: + description: Task ID for which the prediction is created + type: integer + type: object responses: '201': content: application/json: - schema: - $ref: '#/components/schemas/Prediction' examples: Response: + summary: response value: id: 1 - task: 1 + model_version: yolo-v8 result: - - original_width: 1920 - original_height: 1080 - image_rotation: 0 - from_name: bboxes - to_name: image - type: rectanglelabels - value: - x: 20 - y: 30 - width: 50 - height: 60 - rotation: 0 - values: - rectanglelabels: - - Person + - from_name: bboxes + image_rotation: 0 + original_height: 1080 + original_width: 1920 + to_name: image + type: rectanglelabels + value: + height: 60 + rotation: 0 + values: + rectanglelabels: + - Person + width: 50 + x: 20 + y: 30 score: 0.95 - model_version: yolo-v8 - summary: response + task: 1 + schema: + $ref: '#/components/schemas/Prediction' description: Created prediction + security: + - Token: [] + summary: Create prediction + tags: + - Predictions + x-fern-audiences: + - public x-fern-sdk-group-name: predictions x-fern-sdk-method-name: create - x-fern-audiences: - - public /api/predictions/{id}/: + delete: + description: Delete a prediction by prediction ID. + operationId: api_predictions_destroy + parameters: + - description: Prediction ID + in: path + name: id + required: true + schema: + type: integer + responses: + '204': + description: No response body + security: + - Token: [] + summary: Delete prediction + tags: + - Predictions + x-fern-audiences: + - public + x-fern-sdk-group-name: predictions + x-fern-sdk-method-name: delete get: - operationId: api_predictions_retrieve description: Get details about a specific prediction by its ID. - summary: Get prediction details + operationId: api_predictions_retrieve parameters: - - in: path - name: id - schema: - type: integer - description: Prediction ID - required: true - tags: - - Predictions - security: - - Token: [] + - description: Prediction ID + in: path + name: id + required: true + schema: + type: integer responses: '200': content: application/json: - schema: - $ref: '#/components/schemas/Prediction' examples: Response: + summary: response value: id: 1 - task: 1 + model_version: yolo-v8 result: - - original_width: 1920 - original_height: 1080 - image_rotation: 0 - from_name: bboxes - to_name: image - type: rectanglelabels - value: - x: 20 - y: 30 - width: 50 - height: 60 - rotation: 0 - values: - rectanglelabels: - - Person + - from_name: bboxes + image_rotation: 0 + original_height: 1080 + original_width: 1920 + to_name: image + type: rectanglelabels + value: + height: 60 + rotation: 0 + values: + rectanglelabels: + - Person + width: 50 + x: 20 + y: 30 score: 0.95 - model_version: yolo-v8 - summary: response + task: 1 + schema: + $ref: '#/components/schemas/Prediction' description: Prediction details + security: + - Token: [] + summary: Get prediction details + tags: + - Predictions + x-fern-audiences: + - public x-fern-sdk-group-name: predictions x-fern-sdk-method-name: get - x-fern-audiences: - - public - put: - operationId: api_predictions_update - description: Overwrite prediction data by prediction ID. - summary: Put prediction + patch: + description: Update prediction data by prediction ID. + operationId: api_predictions_partial_update parameters: - - in: path - name: id - schema: - type: integer - description: Prediction ID - required: true - tags: - - Predictions + - description: Prediction ID + in: path + name: id + required: true + schema: + type: integer requestBody: content: application/json: schema: - type: object - properties: - task: - type: integer - description: Task ID for which the prediction is created - result: - type: array - items: - type: object - description: Prediction result in JSON format. Read more about the - format in [the Label Studio documentation.](https://labelstud.io/guide/predictions) - example: - - original_width: 1920 - original_height: 1080 + example: + model_version: yolo-v8 + result: + - from_name: bboxes image_rotation: 0 - from_name: bboxes + original_height: 1080 + original_width: 1920 to_name: image type: rectanglelabels value: - x: 20 - y: 30 - width: 50 height: 60 rotation: 0 values: rectanglelabels: - - Person - score: - type: number - description: Prediction score. Can be used in Data Manager to sort - task by model confidence. Task with the lowest score will be shown - first. - example: 0.95 + - Person + width: 50 + x: 20 + y: 30 + score: 0.95 + properties: model_version: - type: string - description: 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 + description: 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 example: yolo-v8 - example: + type: string result: - - original_width: 1920 - original_height: 1080 - image_rotation: 0 - from_name: bboxes - to_name: image - type: rectanglelabels - value: - x: 20 - y: 30 - width: 50 - height: 60 - rotation: 0 - values: - rectanglelabels: - - Person - score: 0.95 - model_version: yolo-v8 - security: - - Token: [] + description: Prediction result in JSON format. Read more about the format in [the Label Studio documentation.](https://labelstud.io/guide/predictions) + example: + - from_name: bboxes + image_rotation: 0 + original_height: 1080 + original_width: 1920 + to_name: image + type: rectanglelabels + value: + height: 60 + rotation: 0 + values: + rectanglelabels: + - Person + width: 50 + x: 20 + y: 30 + items: + type: object + type: array + score: + description: Prediction score. Can be used in Data Manager to sort task by model confidence. Task with the lowest score will be shown first. + example: 0.95 + type: number + task: + description: Task ID for which the prediction is created + type: integer + type: object responses: '200': content: application/json: - schema: - $ref: '#/components/schemas/Prediction' examples: Response: + summary: response value: id: 1 - task: 1 + model_version: yolo-v8 result: - - original_width: 1920 - original_height: 1080 - image_rotation: 0 - from_name: bboxes - to_name: image - type: rectanglelabels - value: - x: 20 - y: 30 - width: 50 - height: 60 - rotation: 0 - values: - rectanglelabels: - - Person + - from_name: bboxes + image_rotation: 0 + original_height: 1080 + original_width: 1920 + to_name: image + type: rectanglelabels + value: + height: 60 + rotation: 0 + values: + rectanglelabels: + - Person + width: 50 + x: 20 + y: 30 score: 0.95 - model_version: yolo-v8 - summary: response + task: 1 + schema: + $ref: '#/components/schemas/Prediction' description: Updated prediction - x-fern-audiences: - - internal - patch: - operationId: api_predictions_partial_update - description: Update prediction data by prediction ID. + security: + - Token: [] summary: Update prediction - parameters: - - in: path - name: id - schema: - type: integer - description: Prediction ID - required: true tags: - - Predictions + - Predictions + x-fern-audiences: + - public + x-fern-sdk-group-name: predictions + x-fern-sdk-method-name: update + put: + description: Overwrite prediction data by prediction ID. + operationId: api_predictions_update + parameters: + - description: Prediction ID + in: path + name: id + required: true + schema: + type: integer requestBody: content: application/json: schema: - type: object - properties: - task: - type: integer - description: Task ID for which the prediction is created + example: + model_version: yolo-v8 result: - type: array - items: - type: object - description: Prediction result in JSON format. Read more about the - format in [the Label Studio documentation.](https://labelstud.io/guide/predictions) - example: - - original_width: 1920 - original_height: 1080 + - from_name: bboxes image_rotation: 0 - from_name: bboxes + original_height: 1080 + original_width: 1920 to_name: image type: rectanglelabels value: - x: 20 - y: 30 - width: 50 height: 60 rotation: 0 values: rectanglelabels: - - Person - score: - type: number - description: Prediction score. Can be used in Data Manager to sort - task by model confidence. Task with the lowest score will be shown - first. - example: 0.95 + - Person + width: 50 + x: 20 + y: 30 + score: 0.95 + properties: model_version: - type: string - description: 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 + description: 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 example: yolo-v8 - example: + type: string result: - - original_width: 1920 - original_height: 1080 - image_rotation: 0 - from_name: bboxes - to_name: image - type: rectanglelabels - value: - x: 20 - y: 30 - width: 50 - height: 60 - rotation: 0 - values: - rectanglelabels: - - Person - score: 0.95 - model_version: yolo-v8 - security: - - Token: [] + description: Prediction result in JSON format. Read more about the format in [the Label Studio documentation.](https://labelstud.io/guide/predictions) + example: + - from_name: bboxes + image_rotation: 0 + original_height: 1080 + original_width: 1920 + to_name: image + type: rectanglelabels + value: + height: 60 + rotation: 0 + values: + rectanglelabels: + - Person + width: 50 + x: 20 + y: 30 + items: + type: object + type: array + score: + description: Prediction score. Can be used in Data Manager to sort task by model confidence. Task with the lowest score will be shown first. + example: 0.95 + type: number + task: + description: Task ID for which the prediction is created + type: integer + type: object responses: '200': content: application/json: - schema: - $ref: '#/components/schemas/Prediction' examples: Response: + summary: response value: id: 1 - task: 1 + model_version: yolo-v8 result: - - original_width: 1920 - original_height: 1080 - image_rotation: 0 - from_name: bboxes - to_name: image - type: rectanglelabels - value: - x: 20 - y: 30 - width: 50 - height: 60 - rotation: 0 - values: - rectanglelabels: - - Person + - from_name: bboxes + image_rotation: 0 + original_height: 1080 + original_width: 1920 + to_name: image + type: rectanglelabels + value: + height: 60 + rotation: 0 + values: + rectanglelabels: + - Person + width: 50 + x: 20 + y: 30 score: 0.95 - model_version: yolo-v8 - summary: response + task: 1 + schema: + $ref: '#/components/schemas/Prediction' description: Updated prediction - x-fern-sdk-group-name: predictions - x-fern-sdk-method-name: update - x-fern-audiences: - - public - delete: - operationId: api_predictions_destroy - description: Delete a prediction by prediction ID. - summary: Delete prediction - parameters: - - in: path - name: id - schema: - type: integer - description: Prediction ID - required: true - tags: - - Predictions security: - - Token: [] - responses: - '204': - description: No response body - x-fern-sdk-group-name: predictions - x-fern-sdk-method-name: delete + - Token: [] + summary: Put prediction + tags: + - Predictions x-fern-audiences: - - public + - internal /api/project-templates/: get: - operationId: api_project_templates_list description: Get a list of all project templates for an organization. - summary: Get project templates + operationId: api_project_templates_list parameters: - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - tags: - - Project Templates - security: - - Token: [] + - description: Which field to use when ordering the results. + in: query + name: ordering + required: false + schema: + type: string responses: '200': content: application/json: schema: - type: array items: $ref: '#/components/schemas/ProjectTemplate' + type: array description: '' + security: + - Token: [] + summary: Get project templates + tags: + - Project Templates post: - operationId: api_project_templates_create description: Create a project template for an organization. - summary: Create project template - tags: - - Project Templates + operationId: api_project_templates_create requestBody: content: application/json: @@ -5884,8 +5728,6 @@ paths: schema: $ref: '#/components/schemas/ProjectTemplateRequest' required: true - security: - - Token: [] responses: '201': content: @@ -5893,21 +5735,38 @@ paths: schema: $ref: '#/components/schemas/ProjectTemplate' description: '' + security: + - Token: [] + summary: Create project template + tags: + - Project Templates /api/project-templates/{id}: + delete: + description: Delete a specific project template by ID for an organization. + operationId: api_project_templates_destroy + parameters: + - in: path + name: id + required: true + schema: + type: integer + responses: + '204': + description: No response body + security: + - Token: [] + summary: Delete a project template + tags: + - Project Templates get: - operationId: api_project_templates_retrieve description: Get a specific project template by ID for an organization. - summary: Get a project template + operationId: api_project_templates_retrieve parameters: - - in: path - name: id - schema: - type: integer - required: true - tags: - - Project Templates - security: - - Token: [] + - in: path + name: id + required: true + schema: + type: integer responses: '200': content: @@ -5915,32 +5774,31 @@ paths: schema: $ref: '#/components/schemas/ProjectTemplate' description: '' - put: - operationId: api_project_templates_update - description: Overwrite a specific project template by ID for an organization. - summary: Overwrite a project template - parameters: - - in: path - name: id - schema: - type: integer - required: true + security: + - Token: [] + summary: Get a project template tags: - - Project Templates + - Project Templates + patch: + description: Update the details of a specific project template by ID for an organization. + operationId: api_project_templates_partial_update + parameters: + - in: path + name: id + required: true + schema: + type: integer requestBody: content: application/json: schema: - $ref: '#/components/schemas/ProjectTemplateRequest' + $ref: '#/components/schemas/PatchedProjectTemplateRequest' application/x-www-form-urlencoded: schema: - $ref: '#/components/schemas/ProjectTemplateRequest' + $ref: '#/components/schemas/PatchedProjectTemplateRequest' multipart/form-data: schema: - $ref: '#/components/schemas/ProjectTemplateRequest' - required: true - security: - - Token: [] + $ref: '#/components/schemas/PatchedProjectTemplateRequest' responses: '200': content: @@ -5948,32 +5806,32 @@ paths: schema: $ref: '#/components/schemas/ProjectTemplate' description: '' - patch: - operationId: api_project_templates_partial_update - description: Update the details of a specific project template by ID for an - organization. + security: + - Token: [] summary: Update a project template - parameters: - - in: path - name: id - schema: - type: integer - required: true tags: - - Project Templates + - Project Templates + put: + description: Overwrite a specific project template by ID for an organization. + operationId: api_project_templates_update + parameters: + - in: path + name: id + required: true + schema: + type: integer requestBody: content: application/json: schema: - $ref: '#/components/schemas/PatchedProjectTemplateRequest' + $ref: '#/components/schemas/ProjectTemplateRequest' application/x-www-form-urlencoded: schema: - $ref: '#/components/schemas/PatchedProjectTemplateRequest' + $ref: '#/components/schemas/ProjectTemplateRequest' multipart/form-data: schema: - $ref: '#/components/schemas/PatchedProjectTemplateRequest' - security: - - Token: [] + $ref: '#/components/schemas/ProjectTemplateRequest' + required: true responses: '200': content: @@ -5981,58 +5839,39 @@ paths: schema: $ref: '#/components/schemas/ProjectTemplate' description: '' - delete: - operationId: api_project_templates_destroy - description: Delete a specific project template by ID for an organization. - summary: Delete a project template - parameters: - - in: path - name: id - schema: - type: integer - required: true - tags: - - Project Templates security: - - Token: [] - responses: - '204': - description: No response body + - Token: [] + summary: Overwrite a project template + tags: + - Project Templates /api/project-templates/{id}/create-project: post: + description: Create a project from a specific project template by ID for an organization. operationId: api_project_templates_create_project_create - description: Create a project from a specific project template by ID for an - organization. - summary: Create project from template parameters: - - in: path - name: id - schema: - type: integer - required: true - tags: - - Project Templates + - in: path + name: id + required: true + schema: + type: integer requestBody: content: application/json: schema: - type: object properties: - title: + description: + description: A description for the project. type: string + title: description: The title of the project to be created from the template. - description: type: string - description: A description for the project. workspace_id: + description: A unique integer value identifying the workspace in which to create the project. type: integer - description: A unique integer value identifying the workspace in - which to create the project. required: - - title - - workspace_id - security: - - Token: [] + - title + - workspace_id + type: object responses: '201': content: @@ -6040,68 +5879,68 @@ paths: schema: $ref: '#/components/schemas/LseProject' description: Project created successfully + security: + - Token: [] + summary: Create project from template + tags: + - Project Templates /api/projects/: get: - operationId: api_projects_list description: Retrieve a list of projects. - summary: List projects + operationId: api_projects_list parameters: - - in: query - name: filter - schema: - type: string - enum: - - all - - exclude_pinned - - pinned_only - description: Filter projects by pinned status. Use 'pinned_only' to return - only pinned projects, 'exclude_pinned' to return only non-pinned projects, - or 'all' to return all projects. - - in: query - name: ids - schema: - type: string - description: ids - - in: query - name: include - schema: - type: string - description: 'Comma-separated list of count fields to include in the response - to optimize performance. Available fields: task_number, finished_task_number, - total_predictions_number, total_annotations_number, num_tasks_with_annotations, - useful_annotation_number, ground_truth_number, skipped_annotations_number. - If not specified, all count fields are included.' - - in: query - name: ordering - schema: - type: string - description: Which field to use when ordering the results. - - name: page - required: false - in: query - description: A page number within the paginated result set. - schema: - type: integer - - name: page_size - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - in: query - name: title - schema: - type: string - description: title - - in: query - name: workspaces - schema: - type: integer - description: workspaces - tags: - - Projects - security: - - Token: [] + - description: Filter projects by pinned status. Use 'pinned_only' to return only pinned projects, 'exclude_pinned' to return only non-pinned projects, or 'all' to return all projects. + in: query + name: filter + schema: + enum: + - all + - exclude_pinned + - pinned_only + type: string + - description: ids + in: query + name: ids + schema: + type: string + - description: 'Comma-separated list of count fields to include in the response to optimize performance. Available fields: task_number, finished_task_number, total_predictions_number, total_annotations_number, num_tasks_with_annotations, useful_annotation_number, ground_truth_number, skipped_annotations_number. If not specified, all count fields are included.' + in: query + name: include + schema: + type: string + - description: Maximum number of members to return. + in: query + name: members_limit + schema: + default: 10 + type: integer + - description: Which field to use when ordering the results. + in: query + name: ordering + schema: + type: string + - description: A page number within the paginated result set. + in: query + name: page + required: false + schema: + type: integer + - description: Number of results to return per page. + in: query + name: page_size + required: false + schema: + type: integer + - description: title + in: query + name: title + schema: + type: string + - description: workspaces + in: query + name: workspaces + schema: + type: integer responses: '200': content: @@ -6109,19 +5948,21 @@ paths: schema: $ref: '#/components/schemas/PaginatedAllRolesProjectListList' description: '' - x-fern-sdk-group-name: projects - x-fern-sdk-method-name: list + security: + - Token: [] + summary: List projects + tags: + - Projects x-fern-audiences: - - public + - public x-fern-pagination: offset: $request.page results: $response.results + x-fern-sdk-group-name: projects + x-fern-sdk-method-name: list post: - operationId: api_projects_create description: Create a project for a specific organization. - summary: Create a project - tags: - - Projects + operationId: api_projects_create requestBody: content: application/json: @@ -6133,8 +5974,6 @@ paths: multipart/form-data: schema: $ref: '#/components/schemas/LseProjectCreateRequest' - security: - - Token: [] responses: '201': content: @@ -6142,406 +5981,534 @@ paths: schema: $ref: '#/components/schemas/LseProjectCreate' description: '' + security: + - Token: [] + summary: Create a project + tags: + - Projects + x-fern-audiences: + - public x-fern-sdk-group-name: projects x-fern-sdk-method-name: create - x-fern-audiences: - - public - /api/projects/{id}/: + /api/projects/counts/: get: - operationId: api_projects_retrieve - description: Retrieve information about a project by project ID. - summary: Get project by ID + description: Returns a list of projects with their counts. For example, task_number which is the total task number in project + operationId: api_projects_counts_list parameters: - - in: path - name: id - schema: - type: integer - required: true - tags: - - Projects - security: - - Token: [] + - description: Which field to use when ordering the results. + in: query + name: ordering + required: false + schema: + type: string + - description: A page number within the paginated result set. + in: query + name: page + required: false + schema: + type: integer + - description: Number of results to return per page. + in: query + name: page_size + required: false + schema: + type: integer responses: '200': content: application/json: schema: - $ref: '#/components/schemas/Project' - examples: - Response: - value: - id: 1 - title: My project - description: My first project - label_config: [...] - expert_instruction: Label all cats - show_instruction: true - show_skip_button: true - enable_empty_annotation: true - show_annotation_history: true - organization: 1 - color: '#FF0000' - maximum_annotations: 1 - is_published: true - model_version: 1.0.0 - is_draft: false - created_by: - id: 1 - first_name: Jo - last_name: Doe - email: manager@humansignal.com - created_at: '2023-08-24T14:15:22Z' - min_annotations_to_start_training: 0 - start_training_on_annotation_update: true - show_collab_predictions: true - num_tasks_with_annotations: 10 - task_number: 100 - useful_annotation_number: 10 - ground_truth_number: 5 - skipped_annotations_number: 0 - total_annotations_number: 10 - total_predictions_number: 0 - sampling: Sequential sampling - show_ground_truth_first: true - show_overlap_first: true - overlap_cohort_percentage: 100 - task_data_login: user - task_data_password: secret - control_weights: {} - parsed_label_config: '{"tag": {...}}' - evaluate_predictions_automatically: false - config_has_control_tags: true - skip_queue: REQUEUE_FOR_ME - reveal_preannotations_interactively: true - pinned_at: '2023-08-24T14:15:22Z' - finished_task_number: 10 - queue_total: 10 - queue_done: 100 - summary: response - description: Project information - x-fern-sdk-group-name: projects - x-fern-sdk-method-name: get - x-fern-audiences: - - public - patch: - operationId: api_projects_partial_update - description: Update the details of a specific project. - summary: Update project details + $ref: '#/components/schemas/PaginatedLseProjectCountsList' + description: '' + security: + - Token: [] + summary: List project's counts + tags: + - Projects + /api/projects/roles/: + get: + description: "\n List project roles for requested IDs for the current user\n " + operationId: api_projects_roles_list parameters: - - in: path - name: id - schema: - type: integer - required: true + - in: query + name: ids + schema: + type: integer + - description: Which field to use when ordering the results. + in: query + name: ordering + required: false + schema: + type: string + responses: + '200': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/ProjectRole' + type: array + description: '' + security: + - Token: [] + summary: List project roles for current user tags: - - Projects + - Project Roles + post: + description: "\n Create project role for user allowing the user the same access level provided by organization role.\n " + operationId: api_projects_roles_create requestBody: content: application/json: schema: - $ref: '#/components/schemas/PatchedLseProjectUpdateRequest' + $ref: '#/components/schemas/ProjectRoleRequest' application/x-www-form-urlencoded: schema: - $ref: '#/components/schemas/PatchedLseProjectUpdateRequest' + $ref: '#/components/schemas/ProjectRoleRequest' multipart/form-data: schema: - $ref: '#/components/schemas/PatchedLseProjectUpdateRequest' - security: - - Token: [] + $ref: '#/components/schemas/ProjectRoleRequest' + required: true responses: - '200': + '201': content: application/json: schema: - $ref: '#/components/schemas/LseProjectUpdate' + $ref: '#/components/schemas/ProjectRole' description: '' - x-fern-sdk-group-name: projects - x-fern-sdk-method-name: update - x-fern-audiences: - - public + security: + - Token: [] + summary: Create project role for user + tags: + - Project Roles + /api/projects/roles/{id}/: delete: - operationId: api_projects_destroy - description: Delete a project by specified project ID. - summary: Delete project + description: "\n Remove project role for user allowing the user the same access level provided by organization role.\n " + operationId: api_projects_roles_destroy parameters: - - in: path - name: id - schema: - type: integer - required: true - tags: - - Projects - security: - - Token: [] + - description: A unique integer value identifying this project role. + in: path + name: id + required: true + schema: + type: integer responses: '204': description: No response body - x-fern-sdk-group-name: projects - x-fern-sdk-method-name: delete - x-fern-audiences: - - public - /api/projects/{id}/annotation-history/: - get: - operationId: api_projects_annotation_history_list - description: List all annotation history items for the project with pagination. - summary: List annotation history items for project - parameters: - - in: path - name: id - schema: - type: integer - required: true - - name: page - required: false - in: query - description: A page number within the paginated result set. - schema: - type: integer - - name: page_size - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - tags: - - Annotation History security: - - Token: [] - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/PaginatedAnnotationHistoryList' - description: '' - /api/projects/{id}/aws-custom-function-logs: - get: - operationId: api_projects_aws_custom_function_logs_retrieve - description: Get AWS lambda logs for project, including filtering by start and - end dates - summary: Get AWS lambda logs for project - parameters: - - in: query - name: end_date - schema: - type: string - description: End date for AWS logs filtering - - in: path - name: id - schema: - type: integer + - Token: [] + summary: Remove project role for user + tags: + - Project Roles + /api/projects/validate/: + post: + description: Validate an arbitrary labeling configuration. + operationId: api_projects_validate_create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ProjectLabelConfigRequest' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/ProjectLabelConfigRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/ProjectLabelConfigRequest' required: true - - in: query - name: limit - schema: - type: integer - default: 100 - description: Limit the number of logs to return - - in: query - name: start_date - schema: - type: string - description: Start date for AWS logs filtering + responses: + '204': + description: Validation success + '400': + description: Validation failed + security: + - Token: [] + - {} + summary: Validate label config tags: - - AWS + - Projects + x-fern-audiences: + - internal + /api/projects/{id}/: + delete: + description: Delete a project by specified project ID. + operationId: api_projects_destroy + parameters: + - in: path + name: id + required: true + schema: + type: integer + responses: + '204': + description: No response body security: - - Token: [] + - Token: [] + summary: Delete project + tags: + - Projects + x-fern-audiences: + - public + x-fern-sdk-group-name: projects + x-fern-sdk-method-name: delete + get: + description: Retrieve information about a project by project ID. + operationId: api_projects_retrieve + parameters: + - in: path + name: id + required: true + schema: + type: integer + responses: + '200': + content: + application/json: + examples: + Response: + summary: response + value: + color: '#FF0000' + config_has_control_tags: true + control_weights: {} + created_at: '2023-08-24T14:15:22Z' + created_by: + email: manager@humansignal.com + first_name: Jo + id: 1 + last_name: Doe + description: My first project + enable_empty_annotation: true + evaluate_predictions_automatically: false + expert_instruction: Label all cats + finished_task_number: 10 + ground_truth_number: 5 + id: 1 + is_draft: false + is_published: true + label_config: [...] + maximum_annotations: 1 + min_annotations_to_start_training: 0 + model_version: 1.0.0 + num_tasks_with_annotations: 10 + organization: 1 + overlap_cohort_percentage: 100 + parsed_label_config: '{"tag": {...}}' + pinned_at: '2023-08-24T14:15:22Z' + queue_done: 100 + queue_total: 10 + reveal_preannotations_interactively: true + sampling: Sequential sampling + show_annotation_history: true + show_collab_predictions: true + show_ground_truth_first: true + show_instruction: true + show_overlap_first: true + show_skip_button: true + skip_queue: REQUEUE_FOR_ME + skipped_annotations_number: 0 + start_training_on_annotation_update: true + task_data_login: user + task_data_password: secret + task_number: 100 + title: My project + total_annotations_number: 10 + total_predictions_number: 0 + useful_annotation_number: 10 + schema: + $ref: '#/components/schemas/Project' + description: Project information + security: + - Token: [] + summary: Get project by ID + tags: + - Projects + x-fern-audiences: + - public + x-fern-sdk-group-name: projects + x-fern-sdk-method-name: get + patch: + description: Update the details of a specific project. + operationId: api_projects_partial_update + parameters: + - in: path + name: id + required: true + schema: + type: integer + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedLseProjectUpdateRequest' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/PatchedLseProjectUpdateRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedLseProjectUpdateRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/LseProjectUpdate' + description: '' + security: + - Token: [] + summary: Update project details + tags: + - Projects + x-fern-audiences: + - public + x-fern-sdk-group-name: projects + x-fern-sdk-method-name: update + /api/projects/{id}/annotation-history/: + get: + description: List all annotation history items for the project with pagination. + operationId: api_projects_annotation_history_list + parameters: + - in: path + name: id + required: true + schema: + type: integer + - description: A page number within the paginated result set. + in: query + name: page + required: false + schema: + type: integer + - description: Number of results to return per page. + in: query + name: page_size + required: false + schema: + type: integer + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedAnnotationHistoryList' + description: '' + security: + - Token: [] + summary: List annotation history items for project + tags: + - Annotation History + /api/projects/{id}/aws-custom-function-logs: + get: + description: Get AWS lambda logs for project, including filtering by start and end dates + operationId: api_projects_aws_custom_function_logs_retrieve + parameters: + - description: End date for AWS logs filtering + in: query + name: end_date + schema: + type: string + - in: path + name: id + required: true + schema: + type: integer + - description: Limit the number of logs to return + in: query + name: limit + schema: + default: 100 + type: integer + - description: Start date for AWS logs filtering + in: query + name: start_date + schema: + type: string responses: '200': content: application/json: schema: - title: List of AWS lambda logs description: List of AWS lambda logs + title: List of AWS lambda logs type: object description: Successful response returns list of AWS lambda logs + security: + - Token: [] + summary: Get AWS lambda logs for project + tags: + - AWS /api/projects/{id}/dashboard: get: + deprecated: true + description: Get dashboard data for project, including annotations and tasks stats. operationId: api_projects_dashboard_retrieve - description: Get dashboard data for project, including annotations and tasks - stats. - summary: Get dashboard data for project parameters: - - in: path - name: id - schema: - type: integer - required: true - tags: - - Dashboard - security: - - Token: [] - deprecated: true + - in: path + name: id + required: true + schema: + type: integer responses: '200': content: application/json: schema: - type: object properties: - tasks: - title: tasks + annotated_tasks: + description: Number of annotated (completed) tasks + title: annotated_tasks type: integer - description: Total number of tasks annotations: - title: annotations - type: integer description: Total number of annotations - annotated_tasks: - title: annotated_tasks + title: annotations type: integer - description: Number of annotated (completed) tasks - skipped_tasks: - title: skipped_tasks + remaining_tasks: + description: Total number of uncompleted tasks + title: remaining_tasks type: integer - description: Number of tasks that have been skipped by at least - one annotator reviewed_tasks: + description: Number of tasks that have been reviewed by at least one reviewer title: reviewed_tasks type: integer - description: Number of tasks that have been reviewed by at least - one reviewer - remaining_tasks: - title: remaining_tasks + skipped_tasks: + description: Number of tasks that have been skipped by at least one annotator + title: skipped_tasks type: integer - description: Total number of uncompleted tasks + tasks: + description: Total number of tasks + title: tasks + type: integer + type: object description: Successful response returns project-related annotation statistics + security: + - Token: [] + summary: Get dashboard data for project + tags: + - Dashboard /api/projects/{id}/dashboard-members: get: + deprecated: true + description: Get dashboard for members, including similarity matrix, user statistics and users list. operationId: api_projects_dashboard_members_retrieve - description: Get dashboard for members, including similarity matrix, user statistics - and users list. - summary: Get dashboard data for members parameters: - - in: query - name: action - schema: - type: string - description: All data objects will be filtered by updated_at or created_at - field - - in: query - name: end_date - schema: - type: string - description: End date for dashboard stats calculation. UTC timezone by default. - Use iso format (yyyy-mm-dd-hh-mm) to specify timezone. - - in: path - name: id - schema: - type: integer - required: true - - in: query - name: per_label - schema: - type: boolean - description: Per label calculation - - in: query - name: start_date - schema: - type: string - description: Start date for dashboard stats calculation. UTC timezone by default. - Use iso format (yyyy-mm-dd-hh-mm) to specify timezone. - - in: query - name: updated_by - schema: - type: string - description: All task objects will be filtered by updated_by field. Only tasks - that were updated by concrete user will be taken in account. - - in: query - name: use_kappa - schema: - type: boolean - description: Use kappa statistics for calculation - tags: - - Dashboard - security: - - Token: [] - deprecated: true + - description: All data objects will be filtered by updated_at or created_at field + in: query + name: action + schema: + type: string + - description: End date for dashboard stats calculation. UTC timezone by default. Use iso format (yyyy-mm-dd-hh-mm) to specify timezone. + in: query + name: end_date + schema: + type: string + - in: path + name: id + required: true + schema: + type: integer + - description: Per label calculation + in: query + name: per_label + schema: + type: boolean + - description: Start date for dashboard stats calculation. UTC timezone by default. Use iso format (yyyy-mm-dd-hh-mm) to specify timezone. + in: query + name: start_date + schema: + type: string + - description: All task objects will be filtered by updated_by field. Only tasks that were updated by concrete user will be taken in account. + in: query + name: updated_by + schema: + type: string + - description: Use kappa statistics for calculation + in: query + name: use_kappa + schema: + type: boolean responses: '200': content: application/json: schema: - title: Task creation response description: Task creation response - type: object properties: - users: - type: array - description: List of users - items: - title: User data - type: object similarity: - type: array description: Consensus statistics between different users items: title: Similarities, common tasks type: object - stats: type: array + stats: description: Number of annotated (completed) tasks items: - title: User statistics description: User statistics - type: object properties: - finished: - title: Finished tasks - type: integer - skipped: - title: Skipped tasks - type: integer accepted: + description: Number of annotations marked as "Accepted" by reviewer title: Accepted tasks type: integer - description: Number of annotations marked as "Accepted" - by reviewer - rejected: - title: Rejected tasks + finished: + title: Finished tasks type: integer - description: Number of annotations marked as "Rejected" - by reviewer - progress: - title: Annotation progress - type: integer - description: Fraction of annotation work done so far + gt: + description: Average agreement with Ground Truth annotations + title: Ground Truth score + type: number mean_time: + description: Average mean time spent on annotation title: Mean time type: number - description: Average mean time spent on annotation median_time: - title: Median time - type: number description: Average median time spent on annotation - gt: - title: Ground Truth score + title: Median time type: number - description: Average agreement with Ground Truth annotations predictions: + description: Average agreement with predictions title: Predictions score type: number - description: Average agreement with predictions + progress: + description: Fraction of annotation work done so far + title: Annotation progress + type: integer + rejected: + description: Number of annotations marked as "Rejected" by reviewer + title: Rejected tasks + type: integer review_score: + description: Average reviewing score, when calling with "per_label=true", returns dictionary with labels to score breakdown title: Review score type: number - description: Average reviewing score, when calling with - "per_label=true", returns dictionary with labels to score - breakdown + skipped: + title: Skipped tasks + type: integer + title: User statistics + type: object + type: array + users: + description: List of users + items: + title: User data + type: object + type: array + title: Task creation response + type: object description: Successful response returns project-related annotation statistics + security: + - Token: [] + summary: Get dashboard data for members + tags: + - Dashboard /api/projects/{id}/duplicate/: post: - operationId: api_projects_duplicate_create description: Make a copy of project. - summary: Duplicate project + operationId: api_projects_duplicate_create parameters: - - in: path - name: id - schema: - type: integer - required: true - tags: - - Projects + - in: path + name: id + required: true + schema: + type: integer requestBody: content: application/json: @@ -6554,182 +6521,163 @@ paths: schema: $ref: '#/components/schemas/ProjectDuplicateRequest' required: true - security: - - Token: [] responses: '201': content: application/json: schema: - type: object properties: id: - type: integer description: The ID of the duplicated project. + type: integer required: - - id + - id + type: object description: Project duplicated + security: + - Token: [] + summary: Duplicate project + tags: + - Projects + x-fern-audiences: + - public x-fern-sdk-group-name: projects x-fern-sdk-method-name: duplicate - x-fern-audiences: - - public /api/projects/{id}/export: get: + description: "\n Note: if you have a large project it's recommended to use\n export snapshots, this easy export endpoint might have timeouts.

    \n Export annotated tasks as a file in a specific format.\n For example, to export JSON annotations for a project to a file called `annotations.json`,\n run the following from the command line:\n ```bash\n curl -X GET http://localhost:8000/api/projects/{id}/export?exportType=JSON -H 'Authorization: Token abc123' --output 'annotations.json'\n ```\n To export all tasks, including skipped tasks and others without annotations, run the following from the command line:\n ```bash\n curl -X GET http://localhost:8000/api/projects/{id}/export?exportType=JSON&download_all_tasks=true -H 'Authorization: Token abc123' --output 'annotations.json'\n ```\n To export specific tasks with IDs of 123 and 345, run the following from the command line:\n ```bash\n curl -X GET 'http://localhost:8000/api/projects/{id}/export?ids[]=123&ids[]=345' -H 'Authorization: Token abc123' --output 'annotations.json'\n ```\n " operationId: api_projects_export_retrieve - description: "\n Note: if you have a large project it's recommended\ - \ to use\n export snapshots, this easy export endpoint might have timeouts.

    \n\ - \ Export annotated tasks as a file in a specific format.\n For\ - \ example, to export JSON annotations for a project to a file called `annotations.json`,\n\ - \ run the following from the command line:\n ```bash\n \ - \ curl -X GET http://localhost:8000/api/projects/{id}/export?exportType=JSON\ - \ -H 'Authorization: Token abc123' --output 'annotations.json'\n ```\n\ - \ To export all tasks, including skipped tasks and others without annotations,\ - \ run the following from the command line:\n ```bash\n curl\ - \ -X GET http://localhost:8000/api/projects/{id}/export?exportType=JSON&download_all_tasks=true\ - \ -H 'Authorization: Token abc123' --output 'annotations.json'\n ```\n\ - \ To export specific tasks with IDs of 123 and 345, run the following\ - \ from the command line:\n ```bash\n curl -X GET 'http://localhost:8000/api/projects/{id}/export?ids[]=123&ids[]=345'\ - \ -H 'Authorization: Token abc123' --output 'annotations.json'\n ```\n\ - \ " - summary: Easy export of tasks and annotations parameters: - - in: query - name: download_all_tasks - schema: - type: boolean - description: If true, download all tasks regardless of status. If false, download - only annotated tasks. - - in: query - name: download_resources - schema: - type: boolean - description: If true, download all resource files such as images, audio, and - others relevant to the tasks. - - in: query - name: export_type - schema: - type: string - description: Selected export format (JSON by default) - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this project. - required: true - - in: query - name: ids - schema: - type: array - items: + - description: If true, download all tasks regardless of status. If false, download only annotated tasks. + in: query + name: download_all_tasks + schema: + type: boolean + - description: If true, download all resource files such as images, audio, and others relevant to the tasks. + in: query + name: download_resources + schema: + type: boolean + - description: Selected export format (JSON by default) + in: query + name: export_type + schema: type: string - description: Specify a list of task IDs to retrieve only the details for those - tasks. - tags: - - Export - security: - - Token: [] + - description: A unique integer value identifying this project. + in: path + name: id + required: true + schema: + type: integer + - description: Specify a list of task IDs to retrieve only the details for those tasks. + in: query + name: ids + schema: + items: + type: string + type: array responses: '200': content: application/json: schema: - title: Export file description: Export file with results - type: string format: binary + title: Export file + type: string description: Exported data + security: + - Token: [] + summary: Easy export of tasks and annotations + tags: + - Export + x-fern-audiences: + - public x-fern-sdk-group-name: - - projects - - exports + - projects + - exports x-fern-sdk-method-name: download_sync - x-fern-audiences: - - public /api/projects/{id}/export/formats: get: + description: Retrieve the available export formats for the current project by ID. operationId: api_projects_export_formats_retrieve - description: Retrieve the available export formats for the current project by - ID. - summary: Get export formats parameters: - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this project. - required: true - tags: - - Export - security: - - Token: [] + - description: A unique integer value identifying this project. + in: path + name: id + required: true + schema: + type: integer responses: '200': content: application/json: schema: - type: array + description: List of available formats items: - type: string title: Export format - description: List of available formats + type: string title: Format list + type: array description: Export formats + security: + - Token: [] + summary: Get export formats + tags: + - Export + x-fern-audiences: + - public x-fern-sdk-group-name: - - projects - - exports + - projects + - exports x-fern-sdk-method-name: list_formats - x-fern-audiences: - - public /api/projects/{id}/exports/: get: - operationId: api_projects_exports_list description: Returns a list of exported files for a specific project by ID. - summary: List all export snapshots + operationId: api_projects_exports_list parameters: - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this project. - required: true - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - tags: - - Export - security: - - Token: [] + - description: A unique integer value identifying this project. + in: path + name: id + required: true + schema: + type: integer + - description: Which field to use when ordering the results. + in: query + name: ordering + required: false + schema: + type: string responses: '200': content: application/json: schema: - type: array items: $ref: '#/components/schemas/Export' + type: array description: '' + security: + - Token: [] + summary: List all export snapshots + tags: + - Export + x-fern-audiences: + - public x-fern-sdk-group-name: - - projects - - exports + - projects + - exports x-fern-sdk-method-name: list - x-fern-audiences: - - public post: + description: Create a new export request to start a background task and generate an export file for a specific project by ID. operationId: api_projects_exports_create - description: Create a new export request to start a background task and generate - an export file for a specific project by ID. - summary: Create new export snapshot parameters: - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this project. - required: true - tags: - - Export + - description: A unique integer value identifying this project. + in: path + name: id + required: true + schema: + type: integer requestBody: content: application/json: @@ -6741,8 +6689,6 @@ paths: multipart/form-data: schema: $ref: '#/components/schemas/LseExportCreateRequest' - security: - - Token: [] responses: '201': content: @@ -6750,35 +6696,64 @@ paths: schema: $ref: '#/components/schemas/LseExportCreate' description: '' + security: + - Token: [] + summary: Create new export snapshot + tags: + - Export + x-fern-audiences: + - public x-fern-sdk-group-name: - - projects - - exports + - projects + - exports x-fern-sdk-method-name: create - x-fern-audiences: - - public /api/projects/{id}/exports/{export_pk}: + delete: + description: Delete an export file by specified export ID. + operationId: api_projects_exports_destroy + parameters: + - description: Primary key identifying the export file. + in: path + name: export_pk + required: true + schema: + type: integer + - description: A unique integer value identifying this project. + in: path + name: id + required: true + schema: + type: integer + responses: + '204': + description: No response body + security: + - Token: [] + summary: Delete export snapshot + tags: + - Export + x-fern-audiences: + - public + x-fern-sdk-group-name: + - projects + - exports + x-fern-sdk-method-name: delete get: + description: Retrieve information about an export file by export ID for a specific project. operationId: api_projects_exports_retrieve - description: Retrieve information about an export file by export ID for a specific - project. - summary: Get export snapshot by ID parameters: - - in: path - name: export_pk - schema: - type: integer - description: Primary key identifying the export file. - required: true - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this project. - required: true - tags: - - Export - security: - - Token: [] + - description: Primary key identifying the export file. + in: path + name: export_pk + required: true + schema: + type: integer + - description: A unique integer value identifying this project. + in: path + name: id + required: true + schema: + type: integer responses: '200': content: @@ -6786,62 +6761,34 @@ paths: schema: $ref: '#/components/schemas/Export' description: '' - x-fern-sdk-group-name: - - projects - - exports - x-fern-sdk-method-name: get - x-fern-audiences: - - public - delete: - operationId: api_projects_exports_destroy - description: Delete an export file by specified export ID. - summary: Delete export snapshot - parameters: - - in: path - name: export_pk - schema: - type: integer - description: Primary key identifying the export file. - required: true - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this project. - required: true - tags: - - Export security: - - Token: [] - responses: - '204': - description: No response body - x-fern-sdk-group-name: - - projects - - exports - x-fern-sdk-method-name: delete + - Token: [] + summary: Get export snapshot by ID + tags: + - Export x-fern-audiences: - - public + - public + x-fern-sdk-group-name: + - projects + - exports + x-fern-sdk-method-name: get /api/projects/{id}/exports/{export_pk}/convert: post: - operationId: api_projects_exports_convert_create description: Convert export snapshot to selected format - summary: Export conversion + operationId: api_projects_exports_convert_create parameters: - - in: path - name: export_pk - schema: - type: integer - description: Primary key identifying the export file. - required: true - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this project. - required: true - tags: - - Export + - description: Primary key identifying the export file. + in: path + name: export_pk + required: true + schema: + type: integer + - description: A unique integer value identifying this project. + in: path + name: id + required: true + schema: + type: integer requestBody: content: application/json: @@ -6854,320 +6801,271 @@ paths: schema: $ref: '#/components/schemas/ExportConvertRequest' required: true - security: - - Token: [] responses: '200': content: application/json: schema: - type: object properties: - export_type: - type: string converted_format: type: integer + export_type: + type: string + type: object description: '' + security: + - Token: [] + summary: Export conversion + tags: + - Export + x-fern-audiences: + - public x-fern-sdk-group-name: - - projects - - exports + - projects + - exports x-fern-sdk-method-name: convert - x-fern-audiences: - - public /api/projects/{id}/exports/{export_pk}/download: get: + description: "\n Download an export file in the specified format for a specific project. Specify the project ID with the `id`\n parameter in the path and the ID of the export file you want to download using the `export_pk` parameter\n in the path.\n\n Get the `export_pk` from the response of the request to [Create new export](/api#operation/api_projects_exports_create)\n or after [listing export files](/api#operation/api_projects_exports_list).\n " operationId: api_projects_exports_download_retrieve - description: "\n Download an export file in the specified format for\ - \ a specific project. Specify the project ID with the `id`\n parameter\ - \ in the path and the ID of the export file you want to download using the\ - \ `export_pk` parameter\n in the path.\n\n Get the `export_pk`\ - \ from the response of the request to [Create new export](/api#operation/api_projects_exports_create)\n\ - \ or after [listing export files](/api#operation/api_projects_exports_list).\n\ - \ " - summary: Download export snapshot as file in specified format parameters: - - in: query - name: exportType - schema: - type: string - description: Selected export format - - in: path - name: export_pk - schema: - type: integer - description: Primary key identifying the export file. - required: true - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this project. - required: true - tags: - - Export - security: - - Token: [] + - description: Selected export format + in: query + name: exportType + schema: + type: string + - description: Primary key identifying the export file. + in: path + name: export_pk + required: true + schema: + type: integer + - description: A unique integer value identifying this project. + in: path + name: id + required: true + schema: + type: integer responses: '200': content: application/*: schema: - type: string format: binary + type: string description: Export file + security: + - Token: [] + summary: Download export snapshot as file in specified format + tags: + - Export + x-fern-audiences: + - public x-fern-sdk-group-name: - - projects - - exports + - projects + - exports x-fern-sdk-method-name: download - x-fern-audiences: - - public /api/projects/{id}/file-uploads: + delete: + description: "\n Delete uploaded files for a specific project.\n " + operationId: api_projects_file_uploads_destroy + parameters: + - in: path + name: id + required: true + schema: + type: integer + responses: + '204': + description: No response body + security: + - Token: [] + summary: Delete files + tags: + - Import + x-fern-audiences: + - public + x-fern-sdk-group-name: + - files + x-fern-sdk-method-name: delete_many get: + description: "\n Retrieve the list of uploaded files used to create labeling tasks for a specific project.\n " operationId: api_projects_file_uploads_list - description: "\n Retrieve the list of uploaded files used to create labeling\ - \ tasks for a specific project.\n " - summary: Get files list parameters: - - in: query - name: all - schema: - type: boolean - description: Set to "true" if you want to retrieve all file uploads - - in: path - name: id - schema: - type: integer - required: true - - in: query - name: ids - schema: - type: array - items: + - description: Set to "true" if you want to retrieve all file uploads + in: query + name: all + schema: + type: boolean + - in: path + name: id + required: true + schema: + type: integer + - description: Specify the list of file upload IDs to retrieve, e.g. ids=[1,2,3] + in: query + name: ids + schema: + items: + type: string + type: array + - description: Which field to use when ordering the results. + in: query + name: ordering + required: false + schema: type: string - description: Specify the list of file upload IDs to retrieve, e.g. ids=[1,2,3] - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - tags: - - Import - security: - - Token: [] responses: '200': content: application/json: schema: - type: array items: $ref: '#/components/schemas/FileUpload' + type: array description: '' + security: + - Token: [] + summary: Get files list + tags: + - Import + x-fern-audiences: + - public x-fern-sdk-group-name: - - files + - files x-fern-sdk-method-name: list - x-fern-audiences: - - public - delete: - operationId: api_projects_file_uploads_destroy - description: "\n Delete uploaded files for a specific project.\n \ - \ " - summary: Delete files + /api/projects/{id}/import: + post: + description: "\n Import data as labeling tasks in bulk using this API endpoint. You can use this API endpoint to import multiple tasks.\n One POST request is limited at 250K tasks and 200 MB.\n\n **Note:** Imported data is verified against a project *label_config* and must\n include all variables that were used in the *label_config*. For example,\n if the label configuration has a *$text* variable, then each item in a data object\n must include a \"text\" field.\n
    \n\n ## POST requests\n
    \n\n There are three possible ways to import tasks with this endpoint:\n\n ### 1. **POST with data**\n Send JSON tasks as POST data. Only JSON is supported for POSTing files directly.\n Update this example to specify your authorization token and Label Studio instance host, then run the following from\n the command line.\n\n ```bash\n curl -H 'Content-Type: application/json' -H 'Authorization: Token abc123' \\\n -X POST 'http://localhost:8000/api/projects/1/import' --data '[{\"text\": \"Some text 1\"}, {\"text\": \"Some text 2\"}]'\n ```\n\n ### 2. **POST with files**\n Send tasks as files. You can attach multiple files with different names.\n\n - **JSON**: text files in JavaScript object notation format\n - **CSV**: text files with tables in Comma Separated Values format\n - **TSV**: text files with tables in Tab Separated Value format\n - **TXT**: simple text files are similar to CSV with one column and no header, supported for projects with one source only\n\n Update this example to specify your authorization token, Label Studio instance host, and file name and path,\n then run the following from the command line:\n\n ```bash\n curl -H 'Authorization: Token abc123' \\\n -X POST 'http://localhost:8000/api/projects/1/import' -F 'file=@path/to/my_file.csv'\n ```\n\n ### 3. **POST with URL**\n You can also provide a URL to a file with labeling tasks. Supported file formats are the same as in option 2.\n\n ```bash\n curl -H 'Content-Type: application/json' -H 'Authorization: Token abc123' \\\n -X POST 'http://localhost:8000/api/projects/1/import' \\\n --data '[{\"url\": \"http://example.com/test1.csv\"}, {\"url\": \"http://example.com/test2.csv\"}]'\n ```\n\n
    \n " + operationId: api_projects_import_create parameters: - - in: path - name: id - schema: - type: integer - required: true - tags: - - Import - security: - - Token: [] - responses: - '204': - description: No response body - x-fern-sdk-group-name: - - files - x-fern-sdk-method-name: delete_many - x-fern-audiences: - - public - /api/projects/{id}/import: - post: - operationId: api_projects_import_create - description: "\n Import data as labeling tasks in bulk using this\ - \ API endpoint. You can use this API endpoint to import multiple tasks.\n\ - \ One POST request is limited at 250K tasks and 200 MB.\n\n \ - \ **Note:** Imported data is verified against a project *label_config*\ - \ and must\n include all variables that were used in the *label_config*.\ - \ For example,\n if the label configuration has a *$text* variable,\ - \ then each item in a data object\n must include a \"text\" field.\n\ - \
    \n\n ## POST requests\n
    \n\n There are three possible ways to import tasks\ - \ with this endpoint:\n\n ### 1. **POST with data**\n \ - \ Send JSON tasks as POST data. Only JSON is supported for POSTing files\ - \ directly.\n Update this example to specify your authorization\ - \ token and Label Studio instance host, then run the following from\n \ - \ the command line.\n\n ```bash\n curl -H 'Content-Type:\ - \ application/json' -H 'Authorization: Token abc123' \\\n -X POST\ - \ 'http://localhost:8000/api/projects/1/import' --data '[{\"text\": \"Some\ - \ text 1\"}, {\"text\": \"Some text 2\"}]'\n ```\n\n \ - \ ### 2. **POST with files**\n Send tasks as files. You can attach\ - \ multiple files with different names.\n\n - **JSON**: text files\ - \ in JavaScript object notation format\n - **CSV**: text files\ - \ with tables in Comma Separated Values format\n - **TSV**: text\ - \ files with tables in Tab Separated Value format\n - **TXT**:\ - \ simple text files are similar to CSV with one column and no header, supported\ - \ for projects with one source only\n\n Update this example to\ - \ specify your authorization token, Label Studio instance host, and file name\ - \ and path,\n then run the following from the command line:\n\n\ - \ ```bash\n curl -H 'Authorization: Token abc123' \\\ - \n -X POST 'http://localhost:8000/api/projects/1/import' -F 'file=@path/to/my_file.csv'\n\ - \ ```\n\n ### 3. **POST with URL**\n You\ - \ can also provide a URL to a file with labeling tasks. Supported file formats\ - \ are the same as in option 2.\n\n ```bash\n curl -H\ - \ 'Content-Type: application/json' -H 'Authorization: Token abc123' \\\n \ - \ -X POST 'http://localhost:8000/api/projects/1/import' \\\n \ - \ --data '[{\"url\": \"http://example.com/test1.csv\"}, {\"url\":\ - \ \"http://example.com/test2.csv\"}]'\n ```\n\n
    \n\ - \ " - summary: Import tasks - parameters: - - in: query - name: commit_to_project - schema: - type: boolean - default: true - description: Set to "true" to immediately commit tasks to the project. - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this project. - required: true - - in: query - name: preannotated_from_fields - schema: - type: array - items: - type: string - description: 'List of fields to preannotate from the task data. For example, - if you provide a list of `{"text": "text", "prediction": "label"}` items - in the request, the system will create a task with the `text` field and - a prediction with the `label` field when `preannoted_from_fields=["prediction"]`.' - - in: query - name: return_task_ids - schema: - type: boolean - default: false - description: Set to "true" to return task IDs in the response. - tags: - - Import + - description: Set to "true" to immediately commit tasks to the project. + in: query + name: commit_to_project + schema: + default: true + type: boolean + - description: A unique integer value identifying this project. + in: path + name: id + required: true + schema: + type: integer + - description: 'List of fields to preannotate from the task data. For example, if you provide a list of `{"text": "text", "prediction": "label"}` items in the request, the system will create a task with the `text` field and a prediction with the `label` field when `preannoted_from_fields=["prediction"]`.' + in: query + name: preannotated_from_fields + schema: + items: + type: string + type: array + - description: Set to "true" to return task IDs in the response. + in: query + name: return_task_ids + schema: + default: false + type: boolean requestBody: content: application/json: schema: - type: array items: $ref: '#/components/schemas/ImportApiRequest' - multipart/form-data: - schema: type: array - items: - $ref: '#/components/schemas/ImportApiRequest' application/x-www-form-urlencoded: schema: + items: + $ref: '#/components/schemas/ImportApiRequest' type: array + multipart/form-data: + schema: items: $ref: '#/components/schemas/ImportApiRequest' + type: array required: true - security: - - Token: [] responses: '201': content: application/json: schema: - title: Task creation response description: Task creation response - type: object properties: - task_count: - title: task_count - description: Number of tasks added - type: integer annotation_count: - title: annotation_count description: Number of annotations added + title: annotation_count type: integer - predictions_count: - title: predictions_count - description: Number of predictions added - type: integer + could_be_tasks_list: + description: Whether uploaded files can contain lists of tasks, like CSV/TSV files + title: could_be_tasks_list + type: boolean + data_columns: + description: The list of found data columns + items: + title: Data column name + type: string + title: data_columns + type: array duration: - title: duration description: Time in seconds to create + title: duration type: number file_upload_ids: - title: file_upload_ids description: Database IDs of uploaded files - type: array items: title: File Upload IDs type: integer - could_be_tasks_list: - title: could_be_tasks_list - description: Whether uploaded files can contain lists of tasks, - like CSV/TSV files - type: boolean + title: file_upload_ids + type: array found_formats: - title: found_formats description: The list of found file formats - type: array items: title: File format type: string - data_columns: - title: data_columns - description: The list of found data columns + title: found_formats type: array - items: - title: Data column name - type: string + predictions_count: + description: Number of predictions added + title: predictions_count + type: integer + task_count: + description: Number of tasks added + title: task_count + type: integer + title: Task creation response + type: object description: Tasks successfully imported '400': content: application/json: schema: - title: Incorrect task data description: String with error description + title: Incorrect task data type: string description: Bad Request + security: + - Token: [] + summary: Import tasks + tags: + - Import + x-fern-audiences: + - public x-fern-sdk-group-name: projects x-fern-sdk-method-name: import_tasks - x-fern-audiences: - - public /api/projects/{id}/imports/{import_pk}/: get: - operationId: api_projects_imports_retrieve description: Return data related to async project import operation - summary: Get project import info + operationId: api_projects_imports_retrieve parameters: - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this project import. - required: true - - in: path - name: import_pk - schema: - type: integer - required: true - tags: - - Projects - security: - - Token: [] + - description: A unique integer value identifying this project import. + in: path + name: id + required: true + schema: + type: integer + - in: path + name: import_pk + required: true + schema: + type: integer responses: '200': content: @@ -7175,25 +7073,67 @@ paths: schema: $ref: '#/components/schemas/ProjectImport' description: '' + security: + - Token: [] + summary: Get project import info + tags: + - Projects + x-fern-audiences: + - public x-fern-sdk-group-name: tasks x-fern-sdk-method-name: create_many_status - x-fern-audiences: - - public /api/projects/{id}/members/: + delete: + description: Remove a member from a specific project. + operationId: api_projects_members_destroy + parameters: + - in: path + name: id + required: true + schema: + type: integer + - description: A unique integer value identifying this project member. + in: query + name: project_member + schema: + type: integer + responses: + '204': + description: No response body + security: + - Token: [] + summary: Remove member from project + tags: + - Projects get: + description: Retrieve the members for a specific project. Pagination is available when the fflag_feat_fit_449_datamanager_filter_members_short feature flag is enabled. operationId: api_projects_members_retrieve - description: Retrieve the members for a specific project. - summary: Get project members parameters: - - in: path - name: id - schema: - type: integer - required: true - tags: - - Projects - security: - - Token: [] + - in: path + name: id + required: true + schema: + type: integer + - description: Exclude annotators from the results. + in: query + name: no_annotators + schema: + type: boolean + - description: Page number for pagination. + in: query + name: page + schema: + type: integer + - description: 'Number of items per page (default: 50).' + in: query + name: page_size + schema: + type: integer + - description: Include deleted members in the results. + in: query + name: with_deleted + schema: + type: boolean responses: '200': content: @@ -7201,18 +7141,20 @@ paths: schema: $ref: '#/components/schemas/ProjectMember' description: '' + security: + - Token: [] + summary: Get project members + tags: + - Projects post: - operationId: api_projects_members_create description: Add a member to a specific project. - summary: Add project member + operationId: api_projects_members_create parameters: - - in: path - name: id - schema: - type: integer - required: true - tags: - - Projects + - in: path + name: id + required: true + schema: + type: integer requestBody: content: application/json: @@ -7225,8 +7167,6 @@ paths: schema: $ref: '#/components/schemas/ProjectMemberRequest' required: true - security: - - Token: [] responses: '201': content: @@ -7234,82 +7174,59 @@ paths: schema: $ref: '#/components/schemas/ProjectMember' description: '' - delete: - operationId: api_projects_members_destroy - description: Remove a member from a specific project. - summary: Remove member from project - parameters: - - in: path - name: id - schema: - type: integer - required: true - - in: query - name: project_member - schema: - type: integer - description: A unique integer value identifying this project member. - tags: - - Projects security: - - Token: [] - responses: - '204': - description: No response body + - Token: [] + summary: Add project member + tags: + - Projects /api/projects/{id}/project-extra-params/: get: + description: Retrieve the annotator weights for statistics and Cohen's Kappa for a specific project. operationId: api_projects_project_extra_params_retrieve - description: Retrieve the annotator weights for statistics and Cohen's Kappa - for a specific project. - summary: Get annotator weights parameters: - - in: path - name: id - schema: - type: integer - required: true - tags: - - Projects - security: - - Token: [] + - in: path + name: id + required: true + schema: + type: integer responses: '200': content: application/json: schema: - title: Change annotator weights for statistics description: Create or change annotator weights for statistics - type: object properties: annotator_params: - title: annotator_params description: Dict of users with weights - type: array items: - title: User_id and weight description: '{user_id: weight}' + title: User_id and weight type: object + title: annotator_params + type: array use_kappa: - title: use_kappa description: If project uses Cohen's Kappa in calculation + title: use_kappa type: boolean + title: Change annotator weights for statistics + type: object description: Annotator weights retrieved '204': description: No annotator weights found + security: + - Token: [] + summary: Get annotator weights + tags: + - Projects post: + description: Create annotator weights to be used in the annotation statistics for a project, such as when calculating kappa metrics for inter-annotator agreement. operationId: api_projects_project_extra_params_create - description: Create annotator weights to be used in the annotation statistics - for a project, such as when calculating kappa metrics for inter-annotator - agreement. - summary: Create annotator weights for statistics parameters: - - in: path - name: id - schema: - type: integer - required: true - tags: - - Projects + - in: path + name: id + required: true + schema: + type: integer requestBody: content: application/json: @@ -7321,51 +7238,49 @@ paths: multipart/form-data: schema: $ref: '#/components/schemas/LseProjectParamsRequest' - security: - - Token: [] responses: '200': content: application/json: schema: - title: Change annotator weights for statistics description: Create or change annotator weights for statistics - type: object properties: annotator_params: - title: annotator_params description: Dict of users with weights - type: array items: - title: User_id and weight description: '{user_id: weight}' + title: User_id and weight type: object + title: annotator_params + type: array use_kappa: - title: use_kappa description: If project uses Cohen's Kappa in calculation + title: use_kappa type: boolean + title: Change annotator weights for statistics + type: object description: Annotator weights created/updated + security: + - Token: [] + summary: Create annotator weights for statistics + tags: + - Projects /api/projects/{id}/reimports/{reimport_pk}/: get: - operationId: api_projects_reimports_retrieve description: Return data related to async project reimport operation - summary: Get project reimport info + operationId: api_projects_reimports_retrieve parameters: - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this project reimport. - required: true - - in: path - name: reimport_pk - schema: - type: integer - required: true - tags: - - Projects - security: - - Token: [] + - description: A unique integer value identifying this project reimport. + in: path + name: id + required: true + schema: + type: integer + - in: path + name: reimport_pk + required: true + schema: + type: integer responses: '200': content: @@ -7373,25 +7288,23 @@ paths: schema: $ref: '#/components/schemas/ProjectReimport' description: '' + security: + - Token: [] + summary: Get project reimport info + tags: + - Projects x-fern-audiences: - - internal + - internal /api/projects/{id}/roles: get: + description: "\n List users and their project level roles for a given project.\n If user is not listed here and is a member of the project then they would behave as assigned role in organization.\n " operationId: api_projects_roles_retrieve - description: "\n List users and their project level roles for a given\ - \ project.\n If user is not listed here and is a member of the project\ - \ then they would behave as assigned role in organization.\n " - summary: List project roles parameters: - - in: path - name: id - schema: - type: integer - required: true - tags: - - Project Roles - security: - - Token: [] + - in: path + name: id + required: true + schema: + type: integer responses: '200': content: @@ -7399,409 +7312,376 @@ paths: schema: $ref: '#/components/schemas/ProjectRole' description: '' + security: + - Token: [] + summary: List project roles + tags: + - Project Roles /api/projects/{id}/stats/IAA: get: + description: Get Inter-Annotator Agreement (IAA) matrix for a project, showing agreement between all annotators. operationId: api_projects_stats_IAA_retrieve - description: Get Inter-Annotator Agreement (IAA) matrix for a project, showing - agreement between all annotators. - summary: Get Inter-Annotator Agreement matrix parameters: - - in: query - name: expand - schema: - type: string - description: Comma-separated list of fields to expand - - in: path - name: id - schema: - type: integer - required: true - - in: query - name: per_label - schema: - type: boolean - default: false - description: Calculate IAA per label - - in: query - name: std - schema: - type: boolean - default: false - description: Include standard deviation in results - - in: query - name: task - schema: - type: string - description: Comma-separated list of task IDs to filter by - tags: - - Stats - security: - - Token: [] + - description: Comma-separated list of fields to expand + in: query + name: expand + schema: + type: string + - in: path + name: id + required: true + schema: + type: integer + - description: Calculate IAA per label + in: query + name: per_label + schema: + default: false + type: boolean + - description: Include standard deviation in results + in: query + name: std + schema: + default: false + type: boolean + - description: Comma-separated list of task IDs to filter by + in: query + name: task + schema: + type: string responses: '200': content: application/json: - schema: - type: object - properties: - IAA: - oneOf: - - type: array - items: - type: array - items: - type: number - description: Inter-Annotator Agreement matrix (2D array) when - per_label=false - - type: object - additionalProperties: - type: array - items: - type: array - items: - type: number - description: Inter-Annotator Agreement matrix per label when - per_label=true - description: Inter-Annotator Agreement matrix - 2D array when - per_label=false, object with label keys when per_label=true - users: - type: array - items: - type: object - description: List of users in the matrix - std: - oneOf: - - type: number - - type: object - additionalProperties: - type: number - description: Standard deviation per label when per_label=true - description: Standard deviation - number when per_label=false, - object with label keys when per_label=true - common_tasks: - oneOf: - - type: array - items: - type: array - items: - type: number - description: Number of common tasks between annotators (2D array) - when per_label=false - - type: object - additionalProperties: - type: array - items: - type: array - items: - type: number - description: Number of common tasks per label when per_label=true - description: Common tasks matrix - 2D array when per_label=false, - object with label keys when per_label=true examples: Inter-AnnotatorAgreementMatrix(perLabel=false): + description: Example of Inter-Annotator Agreement matrix when per_label=false + summary: Inter-Annotator Agreement Matrix (per_label=false) value: IAA: - - - 1.0 - - 0.5 - - - 0.5 - - 1.0 - users: - - id: 1 - email: user1@example.com - - id: 2 - email: user2@example.com + - - 1.0 + - 0.5 + - - 0.5 + - 1.0 common_tasks: - - - 0.0 - - 1.0 - - - 1.0 - - 0.0 - summary: Inter-Annotator Agreement Matrix (per_label=false) - description: Example of Inter-Annotator Agreement matrix when per_label=false + - - 0.0 + - 1.0 + - - 1.0 + - 0.0 + users: + - email: user1@example.com + id: 1 + - email: user2@example.com + id: 2 Inter-AnnotatorAgreementMatrix(perLabel=true): + description: Example of Inter-Annotator Agreement matrix when per_label=true + summary: Inter-Annotator Agreement Matrix (per_label=true) value: IAA: neg: - - - null - - 0.0 - - - 0.0 - - null + - - null + - 0.0 + - - 0.0 + - null pos: - - - null - - 0.5 - - - 0.5 - - null - users: - - id: 1 - email: user1@example.com - - id: 2 - email: user2@example.com + - - null + - 0.5 + - - 0.5 + - null common_tasks: neg: - - - 0.0 - - 2.0 - - - 2.0 - - 0.0 + - - 0.0 + - 2.0 + - - 2.0 + - 0.0 pos: - - - 0.0 - - 4.0 - - - 4.0 - - 0.0 + - - 0.0 + - 4.0 + - - 4.0 + - 0.0 std: neg: 0.1 pos: 0.2 - summary: Inter-Annotator Agreement Matrix (per_label=true) - description: Example of Inter-Annotator Agreement matrix when per_label=true + users: + - email: user1@example.com + id: 1 + - email: user2@example.com + id: 2 + schema: + properties: + IAA: + description: Inter-Annotator Agreement matrix - 2D array when per_label=false, object with label keys when per_label=true + oneOf: + - description: Inter-Annotator Agreement matrix (2D array) when per_label=false + items: + items: + type: number + type: array + type: array + - additionalProperties: + items: + items: + type: number + type: array + type: array + description: Inter-Annotator Agreement matrix per label when per_label=true + type: object + common_tasks: + description: Common tasks matrix - 2D array when per_label=false, object with label keys when per_label=true + oneOf: + - description: Number of common tasks between annotators (2D array) when per_label=false + items: + items: + type: number + type: array + type: array + - additionalProperties: + items: + items: + type: number + type: array + type: array + description: Number of common tasks per label when per_label=true + type: object + std: + description: Standard deviation - number when per_label=false, object with label keys when per_label=true + oneOf: + - type: number + - additionalProperties: + type: number + description: Standard deviation per label when per_label=true + type: object + users: + description: List of users in the matrix + items: + type: object + type: array + type: object description: Inter-Annotator Agreement matrix + security: + - Token: [] + summary: Get Inter-Annotator Agreement matrix + tags: + - Stats + x-fern-audiences: + - public x-fern-sdk-group-name: - - projects - - stats + - projects + - stats x-fern-sdk-method-name: iaa - x-fern-audiences: - - public /api/projects/{id}/stats/agreement_annotator/{user_id}: get: - operationId: api_projects_stats_agreement_annotator_retrieve description: Get agreement statistics for a specific annotator within a project. - summary: Get individual annotator agreement stats + operationId: api_projects_stats_agreement_annotator_retrieve parameters: - - in: path - name: id - schema: - type: integer - required: true - - in: query - name: per_label - schema: - type: boolean - default: false - description: Calculate agreement per label - - in: path - name: user_id - schema: - type: integer - required: true - tags: - - Stats - security: - - Token: [] + - in: path + name: id + required: true + schema: + type: integer + - description: Calculate agreement per label + in: query + name: per_label + schema: + default: false + type: boolean + - in: path + name: user_id + required: true + schema: + type: integer responses: '200': content: application/json: schema: - type: object properties: Agreement_per_annotator: - type: number description: Agreement score for the annotator (0-1) + type: number + type: object description: Individual annotator agreement statistics + security: + - Token: [] + summary: Get individual annotator agreement stats + tags: + - Stats /api/projects/{id}/stats/data_filter: get: + description: Get statistics about user data filters and their usage within a project. operationId: api_projects_stats_data_filter_retrieve - description: Get statistics about user data filters and their usage within a - project. - summary: Get user data filter statistics parameters: - - in: path - name: id - schema: - type: integer - required: true - tags: - - Stats - security: - - Token: [] + - in: path + name: id + required: true + schema: + type: integer responses: '200': content: application/json: schema: - type: object properties: filters: - type: object description: Data filter statistics by user + type: object + type: object description: User data filter statistics + security: + - Token: [] + summary: Get user data filter statistics + tags: + - Stats /api/projects/{id}/stats/finished: get: - operationId: api_projects_stats_finished_retrieve description: Get statistics about finished tasks for a project. - summary: Get finished tasks statistics + operationId: api_projects_stats_finished_retrieve parameters: - - in: path - name: id - schema: - type: integer - required: true - - in: query - name: user_pk - schema: - type: integer - description: User ID to filter statistics by (optional) - tags: - - Stats - security: - - Token: [] + - in: path + name: id + required: true + schema: + type: integer + - description: User ID to filter statistics by (optional) + in: query + name: user_pk + schema: + type: integer responses: '200': content: application/json: schema: - type: object properties: finished_tasks: - type: integer description: Number of finished tasks + type: integer progress: - type: number description: Progress percentage (0-100) + type: number + type: object description: Finished tasks statistics + security: + - Token: [] + summary: Get finished tasks statistics + tags: + - Stats /api/projects/{id}/stats/lead_time: get: + description: Get lead time statistics across the project, including average annotation time. operationId: api_projects_stats_lead_time_retrieve - description: Get lead time statistics across the project, including average - annotation time. - summary: Get lead time statistics parameters: - - in: path - name: id - schema: - type: integer - required: true - tags: - - Stats - security: - - Token: [] + - in: path + name: id + required: true + schema: + type: integer responses: '200': content: application/json: schema: - type: object properties: lead_time: + description: Lead time statistics including mean, median, and distribution type: object - description: Lead time statistics including mean, median, and - distribution + type: object description: Lead time statistics - /api/projects/{id}/tasks/: - get: - operationId: api_projects_tasks_list - description: "\n Retrieve a paginated list of tasks for a specific\ - \ project. For example, use the following cURL command:\n ```bash\n\ - \ curl -X GET http://localhost:8000/api/projects/{id}/tasks/?page=1&page_size=10\ - \ -H 'Authorization: Token abc123'\n ```\n " - summary: List project tasks - parameters: - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this project. - required: true - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - - in: query - name: page - schema: - type: integer - description: '[or "start"] current page' - - in: query - name: page_size - schema: - type: integer - description: '[or "length"] tasks per page, use -1 to obtain all tasks (in - this case "page" has no effect and this operation might be slow)' - tags: - - Projects security: - - Token: [] - responses: - '200': - content: - application/json: - schema: - type: array - items: - $ref: '#/components/schemas/TaskSimple' - description: '' - x-fern-audiences: - - internal + - Token: [] + summary: Get lead time statistics + tags: + - Stats + /api/projects/{id}/tasks/: delete: - operationId: api_projects_tasks_destroy description: Delete all tasks from a specific project. - summary: Delete all tasks + operationId: api_projects_tasks_destroy parameters: - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this project. - required: true - tags: - - Projects - security: - - Token: [] + - description: A unique integer value identifying this project. + in: path + name: id + required: true + schema: + type: integer responses: '204': description: No response body + security: + - Token: [] + summary: Delete all tasks + tags: + - Projects + x-fern-audiences: + - public x-fern-sdk-group-name: tasks x-fern-sdk-method-name: delete_all_tasks - x-fern-audiences: - - public - /api/projects/{id}/tasks/{task_pk}/assignees: get: - operationId: api_projects_tasks_assignees_retrieve - description: Retrieve a list of tasks and assignees for those tasks for a specific - project. - summary: Get assigned tasks and assignees + description: "\n Retrieve a paginated list of tasks for a specific project. For example, use the following cURL command:\n ```bash\n curl -X GET http://localhost:8000/api/projects/{id}/tasks/?page=1&page_size=10 -H 'Authorization: Token abc123'\n ```\n " + operationId: api_projects_tasks_list parameters: - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this project. - required: true - - in: path - name: task_pk - schema: - type: integer - description: A unique integer value identifying this task. - required: true - tags: - - Tasks - security: - - Token: [] + - description: A unique integer value identifying this project. + in: path + name: id + required: true + schema: + type: integer + - description: Which field to use when ordering the results. + in: query + name: ordering + required: false + schema: + type: string + - description: '[or "start"] current page' + in: query + name: page + schema: + type: integer + - description: '[or "length"] tasks per page, use -1 to obtain all tasks (in this case "page" has no effect and this operation might be slow)' + in: query + name: page_size + schema: + type: integer responses: '200': content: application/json: schema: - $ref: '#/components/schemas/TaskAssignment' + items: + $ref: '#/components/schemas/TaskSimple' + type: array description: '' + security: + - Token: [] + summary: List project tasks + tags: + - Projects + x-fern-audiences: + - internal + /api/projects/{id}/tasks/assignees: post: - operationId: api_projects_tasks_assignees_create_2 - description: Assign a user to a task in a specific project. - summary: Create task assignee + description: Assign multiple tasks to a specific user for a specific project. + operationId: api_projects_tasks_assignees_create parameters: - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this project. - required: true - - in: path - name: task_pk - schema: - type: integer - description: A unique integer value identifying this task. - required: true - tags: - - Tasks + - in: path + name: id + required: true + schema: + type: integer + - description: Selected items + in: query + name: selected_items + schema: + type: boolean + - description: Assignment type + in: query + name: type + schema: + type: string + - description: Assignees + in: query + name: users + schema: + type: string requestBody: content: application/json: @@ -7814,8 +7694,66 @@ paths: schema: $ref: '#/components/schemas/TaskAssignmentRequest' required: true + responses: + '201': + content: + application/json: + schema: + properties: + assignments: + type: integer + async: + type: boolean + type: object + description: Success + '400': + description: Can't assign tasks + security: + - Token: [] + summary: Bulk assign tasks + tags: + - Tasks + /api/projects/{id}/tasks/{task_pk}/assignees: + delete: + description: Remove the assignee for a task for a specific project. + operationId: api_projects_tasks_assignees_destroy + parameters: + - description: A unique integer value identifying this project. + in: path + name: id + required: true + schema: + type: integer + - description: A unique integer value identifying this task. + in: path + name: task_pk + required: true + schema: + type: integer + responses: + '204': + description: No response body security: - - Token: [] + - Token: [] + summary: Delete task assignee + tags: + - Tasks + get: + description: Retrieve a list of tasks and assignees for those tasks for a specific project. + operationId: api_projects_tasks_assignees_retrieve + parameters: + - description: A unique integer value identifying this project. + in: path + name: id + required: true + schema: + type: integer + - description: A unique integer value identifying this task. + in: path + name: task_pk + required: true + schema: + type: integer responses: '200': content: @@ -7823,25 +7761,27 @@ paths: schema: $ref: '#/components/schemas/TaskAssignment' description: '' + security: + - Token: [] + summary: Get assigned tasks and assignees + tags: + - Tasks patch: - operationId: api_projects_tasks_assignees_partial_update description: Update the assignee for a task in a specific project. - summary: Update task assignee + operationId: api_projects_tasks_assignees_partial_update parameters: - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this project. - required: true - - in: path - name: task_pk - schema: - type: integer - description: A unique integer value identifying this task. - required: true - tags: - - Tasks + - description: A unique integer value identifying this project. + in: path + name: id + required: true + schema: + type: integer + - description: A unique integer value identifying this task. + in: path + name: task_pk + required: true + schema: + type: integer requestBody: content: application/json: @@ -7853,8 +7793,6 @@ paths: multipart/form-data: schema: $ref: '#/components/schemas/PatchedTaskAssignmentRequest' - security: - - Token: [] responses: '200': content: @@ -7862,58 +7800,27 @@ paths: schema: $ref: '#/components/schemas/TaskAssignment' description: '' - delete: - operationId: api_projects_tasks_assignees_destroy - description: Remove the assignee for a task for a specific project. - summary: Delete task assignee - parameters: - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this project. - required: true - - in: path - name: task_pk - schema: - type: integer - description: A unique integer value identifying this task. - required: true - tags: - - Tasks security: - - Token: [] - responses: - '204': - description: No response body - /api/projects/{id}/tasks/assignees: + - Token: [] + summary: Update task assignee + tags: + - Tasks post: - operationId: api_projects_tasks_assignees_create - description: Assign multiple tasks to a specific user for a specific project. - summary: Bulk assign tasks + description: Assign a user to a task in a specific project. + operationId: api_projects_tasks_assignees_create_2 parameters: - - in: path - name: id - schema: - type: integer - required: true - - in: query - name: selected_items - schema: - type: boolean - description: Selected items - - in: query - name: type - schema: - type: string - description: Assignment type - - in: query - name: users - schema: - type: string - description: Assignees - tags: - - Tasks + - description: A unique integer value identifying this project. + in: path + name: id + required: true + schema: + type: integer + - description: A unique integer value identifying this task. + in: path + name: task_pk + required: true + schema: + type: integer requestBody: content: application/json: @@ -7926,161 +7833,151 @@ paths: schema: $ref: '#/components/schemas/TaskAssignmentRequest' required: true - security: - - Token: [] responses: - '201': + '200': content: application/json: schema: - type: object - properties: - assignments: - type: array - items: - type: object - description: Success - '400': - description: Can't assign tasks + $ref: '#/components/schemas/TaskAssignment' + description: '' + security: + - Token: [] + summary: Create task assignee + tags: + - Tasks /api/projects/{id}/update-stats: get: - operationId: api_projects_update_stats_retrieve description: Start stats recalculation for given project - summary: Start stats recalculation + operationId: api_projects_update_stats_retrieve parameters: - - in: path - name: id - schema: - type: integer - required: true - - in: query - name: stat_type - schema: - type: string - description: 'Stat type to recalculate. Possible values: label, stats' - tags: - - Stats - security: - - Token: [] + - in: path + name: id + required: true + schema: + type: integer + - description: 'Stat type to recalculate. Possible values: label, stats' + in: query + name: stat_type + schema: + type: string responses: '200': content: application/json: schema: - title: Stat recalculation job description: Stat recalculation job + title: Stat recalculation job type: object description: Successful response returns job id + security: + - Token: [] + summary: Start stats recalculation + tags: + - Stats /api/projects/{id}/user-stats/{user_pk}/prediction: get: + description: Get prediction agreement statistics for a specific user within a project. operationId: api_projects_user_stats_prediction_retrieve - description: Get prediction agreement statistics for a specific user within - a project. - summary: Get individual user prediction agreement parameters: - - in: path - name: id - schema: - type: integer - required: true - - in: path - name: user_pk - schema: - type: integer - required: true - tags: - - Stats - security: - - Token: [] + - in: path + name: id + required: true + schema: + type: integer + - in: path + name: user_pk + required: true + schema: + type: integer responses: '200': content: application/json: schema: - type: object properties: average_prediction_agreement_per_user: - type: number description: Average prediction agreement score for the user (0-1) + type: number + type: object description: Individual user prediction agreement statistics + security: + - Token: [] + summary: Get individual user prediction agreement + tags: + - Stats /api/projects/{id}/user-stats/{user_pk}/review_score: get: - operationId: api_projects_user_stats_review_score_retrieve description: Get review score statistics for a specific user within a project. - summary: Get individual user review scores + operationId: api_projects_user_stats_review_score_retrieve parameters: - - in: path - name: id - schema: - type: integer - required: true - - in: path - name: user_pk - schema: - type: integer - required: true - tags: - - Stats - security: - - Token: [] + - in: path + name: id + required: true + schema: + type: integer + - in: path + name: user_pk + required: true + schema: + type: integer responses: '200': content: application/json: schema: - type: object properties: review_score: - type: number description: Average review score for the user + type: number + type: object description: Individual user review score statistics + security: + - Token: [] + summary: Get individual user review scores + tags: + - Stats /api/projects/{id}/users/{user_pk}/stats/agreement-groundtruth: get: + description: Get ground truth agreement statistics for a specific user within a project. operationId: api_projects_users_stats_agreement_groundtruth_retrieve - description: Get ground truth agreement statistics for a specific user within - a project. - summary: Get individual user ground truth agreement parameters: - - in: path - name: id - schema: - type: integer - required: true - - in: path - name: user_pk - schema: - type: integer - required: true - tags: - - Stats - security: - - Token: [] + - in: path + name: id + required: true + schema: + type: integer + - in: path + name: user_pk + required: true + schema: + type: integer responses: '200': content: application/json: schema: - type: object properties: agreement: - type: number description: Ground truth agreement score for the user (0-1) + type: number + type: object description: Individual user ground truth agreement statistics + security: + - Token: [] + summary: Get individual user ground truth agreement + tags: + - Stats /api/projects/{id}/validate/: post: + description: Determine whether the label configuration for a specific project is valid. operationId: api_projects_validate_label_config - description: Determine whether the label configuration for a specific project - is valid. - summary: Validate project label config parameters: - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this project. - required: true - tags: - - Projects + - description: A unique integer value identifying this project. + in: path + name: id + required: true + schema: + type: integer requestBody: content: application/json: @@ -8093,8 +7990,6 @@ paths: schema: $ref: '#/components/schemas/ProjectLabelConfigRequest' required: true - security: - - Token: [] responses: '200': content: @@ -8102,73 +7997,75 @@ paths: schema: $ref: '#/components/schemas/ProjectLabelConfig' description: '' + security: + - Token: [] + summary: Validate project label config + tags: + - Projects + x-fern-audiences: + - public x-fern-sdk-group-name: projects x-fern-sdk-method-name: validate_label_config - x-fern-audiences: - - public /api/projects/{project_pk}/members/{user_pk}/pauses/: get: - operationId: api_projects_members_pauses_list description: Retrieve a list of all pauses. - summary: List pauses + operationId: api_projects_members_pauses_list parameters: - - in: query - name: include_deleted - schema: - type: boolean - description: Include deleted pauses. - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - - in: path - name: project_pk - schema: - type: integer - required: true - - in: path - name: user_pk - schema: - type: integer - required: true - tags: - - Pauses - security: - - Token: [] + - description: Include deleted pauses. + in: query + name: include_deleted + schema: + type: boolean + - description: Which field to use when ordering the results. + in: query + name: ordering + required: false + schema: + type: string + - in: path + name: project_pk + required: true + schema: + type: integer + - in: path + name: user_pk + required: true + schema: + type: integer responses: '200': content: application/json: schema: - type: array items: $ref: '#/components/schemas/Pause' + type: array description: '' + security: + - Token: [] + summary: List pauses + tags: + - Pauses + x-fern-audiences: + - public x-fern-sdk-group-name: - - projects - - pauses + - projects + - pauses x-fern-sdk-method-name: list - x-fern-audiences: - - public post: - operationId: api_projects_members_pauses_create description: Create a new pause entry. - summary: Create pause + operationId: api_projects_members_pauses_create parameters: - - in: path - name: project_pk - schema: - type: integer - required: true - - in: path - name: user_pk - schema: - type: integer - required: true - tags: - - Pauses + - in: path + name: project_pk + required: true + schema: + type: integer + - in: path + name: user_pk + required: true + schema: + type: integer requestBody: content: application/json: @@ -8181,8 +8078,6 @@ paths: schema: $ref: '#/components/schemas/PauseRequest' required: true - security: - - Token: [] responses: '201': content: @@ -8190,37 +8085,70 @@ paths: schema: $ref: '#/components/schemas/Pause' description: '' + security: + - Token: [] + summary: Create pause + tags: + - Pauses + x-fern-audiences: + - public x-fern-sdk-group-name: - - projects - - pauses + - projects + - pauses x-fern-sdk-method-name: create - x-fern-audiences: - - public /api/projects/{project_pk}/members/{user_pk}/pauses/{id}/: + delete: + description: Delete a specific pause by ID. + operationId: api_projects_members_pauses_destroy + parameters: + - in: path + name: id + required: true + schema: + type: string + - in: path + name: project_pk + required: true + schema: + type: integer + - in: path + name: user_pk + required: true + schema: + type: integer + responses: + '204': + description: No response body + security: + - Token: [] + summary: Delete pause + tags: + - Pauses + x-fern-audiences: + - public + x-fern-sdk-group-name: + - projects + - pauses + x-fern-sdk-method-name: delete get: - operationId: api_projects_members_pauses_retrieve description: Retrieve a specific pause by ID. - summary: Get pause + operationId: api_projects_members_pauses_retrieve parameters: - - in: path - name: id - schema: - type: string - required: true - - in: path - name: project_pk - schema: - type: integer - required: true - - in: path - name: user_pk - schema: - type: integer - required: true - tags: - - Pauses - security: - - Token: [] + - in: path + name: id + required: true + schema: + type: string + - in: path + name: project_pk + required: true + schema: + type: integer + - in: path + name: user_pk + required: true + schema: + type: integer responses: '200': content: @@ -8228,48 +8156,47 @@ paths: schema: $ref: '#/components/schemas/Pause' description: '' + security: + - Token: [] + summary: Get pause + tags: + - Pauses + x-fern-audiences: + - public x-fern-sdk-group-name: - - projects - - pauses + - projects + - pauses x-fern-sdk-method-name: get - x-fern-audiences: - - public - put: - operationId: api_projects_members_pauses_update - description: Overwrite a pause entry by ID. - summary: Put pause + patch: + description: Partially update a pause entry by ID. + operationId: api_projects_members_pauses_partial_update parameters: - - in: path - name: id - schema: - type: string - required: true - - in: path - name: project_pk - schema: - type: integer - required: true - - in: path - name: user_pk - schema: - type: integer - required: true - tags: - - Pauses + - in: path + name: id + required: true + schema: + type: string + - in: path + name: project_pk + required: true + schema: + type: integer + - in: path + name: user_pk + required: true + schema: + type: integer requestBody: content: application/json: schema: - $ref: '#/components/schemas/PauseRequest' + $ref: '#/components/schemas/PatchedPauseRequest' application/x-www-form-urlencoded: schema: - $ref: '#/components/schemas/PauseRequest' + $ref: '#/components/schemas/PatchedPauseRequest' multipart/form-data: schema: - $ref: '#/components/schemas/PauseRequest' - required: true - security: - - Token: [] + $ref: '#/components/schemas/PatchedPauseRequest' responses: '200': content: @@ -8277,43 +8204,48 @@ paths: schema: $ref: '#/components/schemas/Pause' description: '' - x-fern-audiences: - - internal - patch: - operationId: api_projects_members_pauses_partial_update - description: Partially update a pause entry by ID. + security: + - Token: [] summary: Update pause - parameters: - - in: path - name: id - schema: - type: string - required: true - - in: path - name: project_pk - schema: - type: integer - required: true - - in: path - name: user_pk - schema: - type: integer - required: true tags: - - Pauses + - Pauses + x-fern-audiences: + - public + x-fern-sdk-group-name: + - projects + - pauses + x-fern-sdk-method-name: update + put: + description: Overwrite a pause entry by ID. + operationId: api_projects_members_pauses_update + parameters: + - in: path + name: id + required: true + schema: + type: string + - in: path + name: project_pk + required: true + schema: + type: integer + - in: path + name: user_pk + required: true + schema: + type: integer requestBody: content: application/json: schema: - $ref: '#/components/schemas/PatchedPauseRequest' + $ref: '#/components/schemas/PauseRequest' application/x-www-form-urlencoded: schema: - $ref: '#/components/schemas/PatchedPauseRequest' + $ref: '#/components/schemas/PauseRequest' multipart/form-data: schema: - $ref: '#/components/schemas/PatchedPauseRequest' - security: - - Token: [] + $ref: '#/components/schemas/PauseRequest' + required: true responses: '200': content: @@ -8321,292 +8253,111 @@ paths: schema: $ref: '#/components/schemas/Pause' description: '' - x-fern-sdk-group-name: - - projects - - pauses - x-fern-sdk-method-name: update + security: + - Token: [] + summary: Put pause + tags: + - Pauses x-fern-audiences: - - public - delete: - operationId: api_projects_members_pauses_destroy - description: Delete a specific pause by ID. - summary: Delete pause + - internal + /api/projects/{project_pk}/subset-tasks: + get: + description: "\n Provides list of tasks, based on project subset. Includes predictions for tasks. For the 'HasGT' subset, accuracy metrics will also be provided.\n " + operationId: api_projects_subset_tasks_list parameters: - - in: path - name: id - schema: - type: string - required: true - - in: path - name: project_pk - schema: - type: integer - required: true - - in: path - name: user_pk - schema: - type: integer - required: true - tags: - - Pauses - security: - - Token: [] - responses: - '204': - description: No response body - x-fern-sdk-group-name: - - projects - - pauses - x-fern-sdk-method-name: delete - x-fern-audiences: - - public - /api/projects/{project_pk}/subset-tasks: - get: - operationId: api_projects_subset_tasks_list - description: "\n Provides list of tasks, based on project subset. Includes\ - \ predictions for tasks. For the 'HasGT' subset, accuracy metrics will also\ - \ be provided.\n " - summary: Get Project Subset Task List with Predictions and Accuracy details - parameters: - - in: query - name: model_run - schema: - type: integer - description: A unique ID of a ModelRun - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - - name: page - required: false - in: query - description: A page number within the paginated result set. - schema: - type: integer - - name: page_size - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - in: path - name: project_pk - schema: - type: integer - required: true - - in: query - name: project_subset - schema: - type: string - description: The project subset to retrieve tasks for - tags: - - Projects - security: - - Token: [] + - description: A unique ID of a ModelRun + in: query + name: model_run + schema: + type: integer + - description: Which field to use when ordering the results. + in: query + name: ordering + required: false + schema: + type: string + - description: A page number within the paginated result set. + in: query + name: page + required: false + schema: + type: integer + - description: Number of results to return per page. + in: query + name: page_size + required: false + schema: + type: integer + - in: path + name: project_pk + required: true + schema: + type: integer + - description: The project subset to retrieve tasks for + in: query + name: project_subset + schema: + type: string responses: '200': description: Project subset task list '400': description: Bad request - missing parent_model + security: + - Token: [] + summary: Get Project Subset Task List with Predictions and Accuracy details + tags: + - Projects /api/projects/{project_pk}/subsets: get: + description: "\n Provides list of available subsets for a project along with count of tasks in each subset\n " operationId: api_projects_subsets_retrieve - description: "\n Provides list of available subsets for a project along\ - \ with count of tasks in each subset\n " - summary: Get available subsets of a project (for prompts usage) parameters: - - in: path - name: project_pk - schema: - type: integer - required: true - tags: - - Projects - security: - - Token: [] + - in: path + name: project_pk + required: true + schema: + type: integer responses: '200': description: No response body - /api/projects/counts/: - get: - operationId: api_projects_counts_list - description: Returns a list of projects with their counts. For example, task_number - which is the total task number in project - summary: List project's counts - parameters: - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - - name: page - required: false - in: query - description: A page number within the paginated result set. - schema: - type: integer - - name: page_size - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - tags: - - Projects - security: - - Token: [] - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/PaginatedLseProjectCountsList' - description: '' - /api/projects/roles/: - get: - operationId: api_projects_roles_list - description: "\n List project roles for requested IDs for the current\ - \ user\n " - summary: List project roles for current user - parameters: - - in: query - name: ids - schema: - type: integer - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - tags: - - Project Roles - security: - - Token: [] - responses: - '200': - content: - application/json: - schema: - type: array - items: - $ref: '#/components/schemas/ProjectRole' - description: '' - post: - operationId: api_projects_roles_create - description: "\n Create project role for user allowing the user the same\ - \ access level provided by organization role.\n " - summary: Create project role for user - tags: - - Project Roles - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ProjectRoleRequest' - application/x-www-form-urlencoded: - schema: - $ref: '#/components/schemas/ProjectRoleRequest' - multipart/form-data: - schema: - $ref: '#/components/schemas/ProjectRoleRequest' - required: true - security: - - Token: [] - responses: - '201': - content: - application/json: - schema: - $ref: '#/components/schemas/ProjectRole' - description: '' - /api/projects/roles/{id}/: - delete: - operationId: api_projects_roles_destroy - description: "\n Remove project role for user allowing the user the same\ - \ access level provided by organization role.\n " - summary: Remove project role for user - parameters: - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this project role. - required: true - tags: - - Project Roles security: - - Token: [] - responses: - '204': - description: No response body - /api/projects/validate/: - post: - operationId: api_projects_validate_create - description: Validate an arbitrary labeling configuration. - summary: Validate label config + - Token: [] + summary: Get available subsets of a project (for prompts usage) tags: - - Projects - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ProjectLabelConfigRequest' - application/x-www-form-urlencoded: - schema: - $ref: '#/components/schemas/ProjectLabelConfigRequest' - multipart/form-data: - schema: - $ref: '#/components/schemas/ProjectLabelConfigRequest' - required: true - security: - - Token: [] - - {} - responses: - '204': - description: Validation success - '400': - description: Validation failed - x-fern-audiences: - - internal + - Projects /api/prompts/: get: - operationId: api_prompts_list description: List all prompts. - summary: List prompts + operationId: api_prompts_list parameters: - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - tags: - - Prompts - security: - - Token: [] + - description: Which field to use when ordering the results. + in: query + name: ordering + required: false + schema: + type: string responses: '200': content: application/json: schema: - type: array items: $ref: '#/components/schemas/ModelInterfaceSerializerGET' + type: array description: '' + security: + - Token: [] + summary: List prompts + tags: + - Prompts + x-fern-audiences: + - public x-fern-sdk-group-name: prompts x-fern-sdk-method-name: list - x-fern-audiences: - - public post: - operationId: api_prompts_create description: Create a new prompt. - summary: Create prompt - tags: - - Prompts + operationId: api_prompts_create requestBody: content: application/json: @@ -8619,8 +8370,6 @@ paths: schema: $ref: '#/components/schemas/ModelInterfaceRequest' required: true - security: - - Token: [] responses: '201': content: @@ -8628,25 +8377,94 @@ paths: schema: $ref: '#/components/schemas/ModelInterface' description: '' + security: + - Token: [] + summary: Create prompt + tags: + - Prompts + x-fern-audiences: + - public x-fern-sdk-group-name: prompts x-fern-sdk-method-name: create + /api/prompts/compatible-projects: + get: + description: Retrieve a list of compatible project for prompt. + operationId: api_prompts_compatible_projects_list + parameters: + - description: Which field to use when ordering the results. + in: query + name: ordering + required: false + schema: + type: string + - description: A page number within the paginated result set. + in: query + name: page + required: false + schema: + type: integer + - description: Number of results to return per page. + in: query + name: page_size + required: false + schema: + type: integer + - description: Skill to filter by + in: query + name: project_type + schema: + default: TextClassification + enum: + - NamedEntityRecognition + - TextClassification + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedAllRolesProjectListList' + description: '' + security: + - Token: [] + summary: List projects compatible with prompt + tags: + - Prompts x-fern-audiences: - - public + - public + x-fern-sdk-group-name: prompts + x-fern-sdk-method-name: compatible_projects /api/prompts/{id}/: + delete: + description: Delete a prompt by ID + operationId: api_prompts_destroy + parameters: + - in: path + name: id + required: true + schema: + type: string + responses: + '204': + description: No response body + security: + - Token: [] + summary: Delete prompt + tags: + - Prompts + x-fern-audiences: + - public + x-fern-sdk-group-name: prompts + x-fern-sdk-method-name: delete get: - operationId: api_prompts_retrieve description: Retrieve a specific prompt. - summary: Get prompt + operationId: api_prompts_retrieve parameters: - - in: path - name: id - schema: - type: string - required: true - tags: - - Prompts - security: - - Token: [] + - in: path + name: id + required: true + schema: + type: string responses: '200': content: @@ -8654,36 +8472,35 @@ paths: schema: $ref: '#/components/schemas/ModelInterfaceSerializerGET' description: '' + security: + - Token: [] + summary: Get prompt + tags: + - Prompts + x-fern-audiences: + - public x-fern-sdk-group-name: prompts x-fern-sdk-method-name: get - x-fern-audiences: - - public - put: - operationId: api_prompts_update - description: Overwrite a specific prompt by ID. - summary: Put prompt + patch: + description: Update a specific prompt by ID. + operationId: api_prompts_partial_update parameters: - - in: path - name: id - schema: - type: string - required: true - tags: - - Prompts + - in: path + name: id + required: true + schema: + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/ModelInterfaceRequest' + $ref: '#/components/schemas/PatchedModelInterfaceRequest' application/x-www-form-urlencoded: schema: - $ref: '#/components/schemas/ModelInterfaceRequest' + $ref: '#/components/schemas/PatchedModelInterfaceRequest' multipart/form-data: schema: - $ref: '#/components/schemas/ModelInterfaceRequest' - required: true - security: - - Token: [] + $ref: '#/components/schemas/PatchedModelInterfaceRequest' responses: '200': content: @@ -8691,33 +8508,36 @@ paths: schema: $ref: '#/components/schemas/ModelInterface' description: '' - x-fern-audiences: - - internal - patch: - operationId: api_prompts_partial_update - description: Update a specific prompt by ID. + security: + - Token: [] summary: Update prompt - parameters: - - in: path - name: id - schema: - type: string - required: true tags: - - Prompts + - Prompts + x-fern-audiences: + - public + x-fern-sdk-group-name: prompts + x-fern-sdk-method-name: update + put: + description: Overwrite a specific prompt by ID. + operationId: api_prompts_update + parameters: + - in: path + name: id + required: true + schema: + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/PatchedModelInterfaceRequest' + $ref: '#/components/schemas/ModelInterfaceRequest' application/x-www-form-urlencoded: schema: - $ref: '#/components/schemas/PatchedModelInterfaceRequest' + $ref: '#/components/schemas/ModelInterfaceRequest' multipart/form-data: schema: - $ref: '#/components/schemas/PatchedModelInterfaceRequest' - security: - - Token: [] + $ref: '#/components/schemas/ModelInterfaceRequest' + required: true responses: '200': content: @@ -8725,110 +8545,88 @@ paths: schema: $ref: '#/components/schemas/ModelInterface' description: '' - x-fern-sdk-group-name: prompts - x-fern-sdk-method-name: update + security: + - Token: [] + summary: Put prompt + tags: + - Prompts x-fern-audiences: - - public - delete: - operationId: api_prompts_destroy - description: Delete a prompt by ID - summary: Delete prompt - parameters: - - in: path - name: id - schema: - type: string - required: true - tags: - - Prompts - security: - - Token: [] - responses: - '204': - description: No response body - x-fern-sdk-group-name: prompts - x-fern-sdk-method-name: delete - x-fern-audiences: - - public + - internal /api/prompts/{id}/get-default-version-name: get: - operationId: api_prompts_get_default_version_name_retrieve description: Get default prompt version name - summary: Get default prompt version name + operationId: api_prompts_get_default_version_name_retrieve parameters: - - in: path - name: id - schema: - type: integer - required: true - tags: - - Prompts - security: - - Token: [] + - in: path + name: id + required: true + schema: + type: integer responses: '200': description: No response body + security: + - Token: [] + summary: Get default prompt version name + tags: + - Prompts + x-fern-audiences: + - public x-fern-sdk-group-name: - - prompts - - versions + - prompts + - versions x-fern-sdk-method-name: get_default_version_name - x-fern-audiences: - - public /api/prompts/{prompt_id}/versions: get: - operationId: api_prompts_versions_list description: List all versions of a prompt. - summary: List prompt versions + operationId: api_prompts_versions_list parameters: - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - - in: path - name: prompt_id - schema: - type: integer - required: true - - in: query - name: prompt_id - schema: - type: integer - description: A unique integer value identifying the model ID to list versions - for. - required: true - tags: - - Prompts - security: - - Token: [] + - description: Which field to use when ordering the results. + in: query + name: ordering + required: false + schema: + type: string + - in: path + name: prompt_id + required: true + schema: + type: integer + - description: A unique integer value identifying the model ID to list versions for. + in: query + name: prompt_id + required: true + schema: + type: integer responses: '200': content: application/json: schema: - type: array items: $ref: '#/components/schemas/ThirdPartyModelVersion' + type: array description: '' + security: + - Token: [] + summary: List prompt versions + tags: + - Prompts + x-fern-audiences: + - public x-fern-sdk-group-name: - - prompts - - versions + - prompts + - versions x-fern-sdk-method-name: list - x-fern-audiences: - - public post: - operationId: api_prompts_versions_create description: Create a new version of a prompt. - summary: Create prompt version + operationId: api_prompts_versions_create parameters: - - in: path - name: prompt_id - schema: - type: integer - required: true - tags: - - Prompts + - in: path + name: prompt_id + required: true + schema: + type: integer requestBody: content: application/json: @@ -8841,8 +8639,6 @@ paths: schema: $ref: '#/components/schemas/ThirdPartyModelVersionRequest' required: true - security: - - Token: [] responses: '201': content: @@ -8850,32 +8646,60 @@ paths: schema: $ref: '#/components/schemas/ThirdPartyModelVersion' description: '' + security: + - Token: [] + summary: Create prompt version + tags: + - Prompts + x-fern-audiences: + - public x-fern-sdk-group-name: - - prompts - - versions + - prompts + - versions x-fern-sdk-method-name: create - x-fern-audiences: - - public /api/prompts/{prompt_id}/versions/{version_id}: + delete: + description: Delete a prompt version by ID + operationId: api_prompts_versions_destroy + parameters: + - in: path + name: prompt_id + required: true + schema: + type: integer + - in: path + name: version_id + required: true + schema: + type: integer + responses: + '204': + description: No response body + security: + - Token: [] + summary: Delete prompt version + tags: + - Prompts + x-fern-audiences: + - public + x-fern-sdk-group-name: + - prompts + - versions + x-fern-sdk-method-name: delete get: - operationId: api_prompts_versions_retrieve description: Retrieve a specific prompt of a model. - summary: Get prompt version + operationId: api_prompts_versions_retrieve parameters: - - in: path - name: prompt_id - schema: - type: integer - required: true - - in: path - name: version_id - schema: - type: integer - required: true - tags: - - Prompts - security: - - Token: [] + - in: path + name: prompt_id + required: true + schema: + type: integer + - in: path + name: version_id + required: true + schema: + type: integer responses: '200': content: @@ -8883,43 +8707,42 @@ paths: schema: $ref: '#/components/schemas/ThirdPartyModelVersion' description: '' + security: + - Token: [] + summary: Get prompt version + tags: + - Prompts + x-fern-audiences: + - public x-fern-sdk-group-name: - - prompts - - versions + - prompts + - versions x-fern-sdk-method-name: get - x-fern-audiences: - - public - put: - operationId: api_prompts_versions_update - description: Overwrite a specific prompt version by ID. - summary: Put prompt version + patch: + description: Update a specific prompt version by ID. + operationId: api_prompts_versions_partial_update parameters: - - in: path - name: prompt_id - schema: - type: integer - required: true - - in: path - name: version_id - schema: - type: integer - required: true - tags: - - Prompts + - in: path + name: prompt_id + required: true + schema: + type: integer + - in: path + name: version_id + required: true + schema: + type: integer requestBody: content: application/json: schema: - $ref: '#/components/schemas/ThirdPartyModelVersionRequest' + $ref: '#/components/schemas/PatchedThirdPartyModelVersionRequest' application/x-www-form-urlencoded: schema: - $ref: '#/components/schemas/ThirdPartyModelVersionRequest' + $ref: '#/components/schemas/PatchedThirdPartyModelVersionRequest' multipart/form-data: schema: - $ref: '#/components/schemas/ThirdPartyModelVersionRequest' - required: true - security: - - Token: [] + $ref: '#/components/schemas/PatchedThirdPartyModelVersionRequest' responses: '200': content: @@ -8927,38 +8750,43 @@ paths: schema: $ref: '#/components/schemas/ThirdPartyModelVersion' description: '' - x-fern-audiences: - - internal - patch: - operationId: api_prompts_versions_partial_update - description: Update a specific prompt version by ID. + security: + - Token: [] summary: Update prompt version - parameters: - - in: path - name: prompt_id - schema: - type: integer - required: true - - in: path - name: version_id - schema: - type: integer - required: true tags: - - Prompts + - Prompts + x-fern-audiences: + - public + x-fern-sdk-group-name: + - prompts + - versions + x-fern-sdk-method-name: update + put: + description: Overwrite a specific prompt version by ID. + operationId: api_prompts_versions_update + parameters: + - in: path + name: prompt_id + required: true + schema: + type: integer + - in: path + name: version_id + required: true + schema: + type: integer requestBody: content: application/json: schema: - $ref: '#/components/schemas/PatchedThirdPartyModelVersionRequest' + $ref: '#/components/schemas/ThirdPartyModelVersionRequest' application/x-www-form-urlencoded: schema: - $ref: '#/components/schemas/PatchedThirdPartyModelVersionRequest' + $ref: '#/components/schemas/ThirdPartyModelVersionRequest' multipart/form-data: schema: - $ref: '#/components/schemas/PatchedThirdPartyModelVersionRequest' - security: - - Token: [] + $ref: '#/components/schemas/ThirdPartyModelVersionRequest' + required: true responses: '200': content: @@ -8966,61 +8794,28 @@ paths: schema: $ref: '#/components/schemas/ThirdPartyModelVersion' description: '' - x-fern-sdk-group-name: - - prompts - - versions - x-fern-sdk-method-name: update - x-fern-audiences: - - public - delete: - operationId: api_prompts_versions_destroy - description: Delete a prompt version by ID - summary: Delete prompt version - parameters: - - in: path - name: prompt_id - schema: - type: integer - required: true - - in: path - name: version_id - schema: - type: integer - required: true - tags: - - Prompts security: - - Token: [] - responses: - '204': - description: No response body - x-fern-sdk-group-name: - - prompts - - versions - x-fern-sdk-method-name: delete + - Token: [] + summary: Put prompt version + tags: + - Prompts x-fern-audiences: - - public + - internal /api/prompts/{prompt_id}/versions/{version_id}/cost-estimate: get: + description: Get an estimate of the cost for making an inference run on the selected Prompt Version and Project/ProjectSubset operationId: api_prompts_versions_cost_estimate_retrieve - description: Get an estimate of the cost for making an inference run on the - selected Prompt Version and Project/ProjectSubset - summary: Get cost estimate for running a prompt version on a particular project/subset parameters: - - in: path - name: prompt_id - schema: - type: integer - required: true - - in: path - name: version_id - schema: - type: integer - required: true - tags: - - Prompts - security: - - Token: [] + - in: path + name: prompt_id + required: true + schema: + type: integer + - in: path + name: version_id + required: true + schema: + type: integer responses: '200': content: @@ -9028,91 +8823,91 @@ paths: schema: $ref: '#/components/schemas/InferenceRunCostEstimate' description: Cost estimate response + security: + - Token: [] + summary: Get cost estimate for running a prompt version on a particular project/subset + tags: + - Prompts + x-fern-audiences: + - public x-fern-sdk-group-name: - - prompts - - versions + - prompts + - versions x-fern-sdk-method-name: cost_estimate - x-fern-audiences: - - public /api/prompts/{prompt_id}/versions/{version_id}/inference-runs: get: + description: Get information (status, metadata, etc) about an existing inference run operationId: api_prompts_versions_inference_runs_list - description: Get information (status, metadata, etc) about an existing inference - run - summary: Get inference run info parameters: - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - - in: query - name: parent_model - schema: - type: integer - description: The ID of the parent model for this Inference Run - - in: query - name: project - schema: - type: integer - description: The ID of the project this Inference Run makes predictions on - - in: query - name: project_subset - schema: - type: string - enum: - - All - - HasGT - - Sample - description: Defines which tasks are operated on (e.g. HasGT will only operate - on tasks with a ground truth annotation, but All will operate on all records) - - in: path - name: prompt_id - schema: - type: integer - required: true - - in: path - name: version_id - schema: - type: integer - required: true - tags: - - Prompts - security: - - Token: [] + - description: Which field to use when ordering the results. + in: query + name: ordering + required: false + schema: + type: string + - description: The ID of the parent model for this Inference Run + in: query + name: parent_model + schema: + type: integer + - description: The ID of the project this Inference Run makes predictions on + in: query + name: project + schema: + type: integer + - description: Defines which tasks are operated on (e.g. HasGT will only operate on tasks with a ground truth annotation, but All will operate on all records) + in: query + name: project_subset + schema: + enum: + - All + - HasGT + - Sample + type: string + - in: path + name: prompt_id + required: true + schema: + type: integer + - in: path + name: version_id + required: true + schema: + type: integer responses: '200': content: application/json: schema: - type: array items: $ref: '#/components/schemas/ModelRun' + type: array description: '' + security: + - Token: [] + summary: Get inference run info + tags: + - Prompts + x-fern-audiences: + - public x-fern-sdk-group-name: - - prompts - - runs + - prompts + - runs x-fern-sdk-method-name: list - x-fern-audiences: - - public post: - operationId: api_prompts_versions_inference_runs_create description: Run a prompt inference. - summary: Run prompt inference + operationId: api_prompts_versions_inference_runs_create parameters: - - in: path - name: prompt_id - schema: - type: integer - required: true - - in: path - name: version_id - schema: - type: integer - required: true - tags: - - Prompts + - in: path + name: prompt_id + required: true + schema: + type: integer + - in: path + name: version_id + required: true + schema: + type: integer requestBody: content: application/json: @@ -9125,8 +8920,6 @@ paths: schema: $ref: '#/components/schemas/ModelRunRequest' required: true - security: - - Token: [] responses: '201': content: @@ -9134,66 +8927,65 @@ paths: schema: $ref: '#/components/schemas/ModelRun' description: '' + security: + - Token: [] + summary: Run prompt inference + tags: + - Prompts + x-fern-audiences: + - public x-fern-sdk-group-name: - - prompts - - runs + - prompts + - runs x-fern-sdk-method-name: create - x-fern-audiences: - - public /api/prompts/{prompt_id}/versions/{version_id}/inference-runs/{inference_run_id}/cancel: post: - operationId: api_prompts_versions_inference_runs_cancel_create description: Cancel the inference run for the given api - summary: Cancel Inference Run API + operationId: api_prompts_versions_inference_runs_cancel_create parameters: - - in: path - name: inference_run_id - schema: - type: integer - required: true - - in: path - name: prompt_id - schema: - type: integer - required: true - - in: path - name: version_id - schema: - type: integer - required: true - tags: - - Prompts - security: - - Token: [] + - in: path + name: inference_run_id + required: true + schema: + type: integer + - in: path + name: prompt_id + required: true + schema: + type: integer + - in: path + name: version_id + required: true + schema: + type: integer responses: '201': description: No response body + security: + - Token: [] + summary: Cancel Inference Run API + tags: + - Prompts /api/prompts/{prompt_id}/versions/{version_id}/refine: get: - operationId: api_prompts_versions_refine_retrieve description: Get the refined prompt based on the `refinement_job_id`. - summary: Get refined prompt + operationId: api_prompts_versions_refine_retrieve parameters: - - in: path - name: prompt_id - schema: - type: integer - required: true - - in: query - name: refinement_job_id - schema: - type: string - description: Refinement Job ID acquired from the `POST /api/prompts/{prompt_id}/versions/{version_id}/refine` - endpoint - - in: path - name: version_id - schema: - type: integer - required: true - tags: - - Prompts - security: - - Token: [] + - in: path + name: prompt_id + required: true + schema: + type: integer + - description: Refinement Job ID acquired from the `POST /api/prompts/{prompt_id}/versions/{version_id}/refine` endpoint + in: query + name: refinement_job_id + schema: + type: string + - in: path + name: version_id + required: true + schema: + type: integer responses: '200': content: @@ -9207,35 +8999,36 @@ paths: schema: $ref: '#/components/schemas/RefinedPromptResponse' description: Refinement job status + security: + - Token: [] + summary: Get refined prompt + tags: + - Prompts + x-fern-audiences: + - public x-fern-sdk-group-name: - - prompts - - versions + - prompts + - versions x-fern-sdk-method-name: get_refined_prompt - x-fern-audiences: - - public post: + description: Refine a prompt version using a teacher model and save the refined prompt as a new version. operationId: api_prompts_versions_refine_create - description: Refine a prompt version using a teacher model and save the refined - prompt as a new version. - summary: Refine a prompt version parameters: - - in: query - name: async - schema: - type: boolean - description: Whether to run the refinement asynchronously - - in: path - name: prompt_id - schema: - type: integer - required: true - - in: path - name: version_id - schema: - type: integer - required: true - tags: - - Prompts + - description: Whether to run the refinement asynchronously + in: query + name: async + schema: + type: boolean + - in: path + name: prompt_id + required: true + schema: + type: integer + - in: path + name: version_id + required: true + schema: + type: integer requestBody: content: application/json: @@ -9248,8 +9041,6 @@ paths: schema: $ref: '#/components/schemas/RefinePromptRequestRequest' required: true - security: - - Token: [] responses: '201': content: @@ -9257,69 +9048,21 @@ paths: schema: $ref: '#/components/schemas/RefinedPromptResponse' description: Refined prompt response + security: + - Token: [] + summary: Refine a prompt version + tags: + - Prompts + x-fern-audiences: + - public x-fern-sdk-group-name: - - prompts - - versions + - prompts + - versions x-fern-sdk-method-name: refine_prompt - x-fern-audiences: - - public - /api/prompts/compatible-projects: - get: - operationId: api_prompts_compatible_projects_list - description: Retrieve a list of compatible project for prompt. - summary: List projects compatible with prompt - parameters: - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - - name: page - required: false - in: query - description: A page number within the paginated result set. - schema: - type: integer - - name: page_size - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - in: query - name: project_type - schema: - type: string - enum: - - NamedEntityRecognition - - TextClassification - default: TextClassification - description: Skill to filter by - tags: - - Prompts - security: - - Token: [] - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/PaginatedAllRolesProjectListList' - description: '' - x-fern-sdk-group-name: prompts - x-fern-sdk-method-name: compatible_projects - x-fern-audiences: - - public /api/saml/settings: get: - operationId: api_saml_settings_retrieve description: Retrieve SAML2 settings for the currently active organization. - summary: Retrieve SAML2 Settings - tags: - - SSO - security: - - Token: [] + operationId: api_saml_settings_retrieve responses: '200': content: @@ -9327,12 +9070,14 @@ paths: schema: $ref: '#/components/schemas/SamlSettings' description: '' + security: + - Token: [] + summary: Retrieve SAML2 Settings + tags: + - SSO post: - operationId: api_saml_settings_create description: Update SAML2 settings for the currently active organization. - summary: Update SAML2 Settings - tags: - - SSO + operationId: api_saml_settings_create requestBody: content: application/json: @@ -9344,8 +9089,6 @@ paths: multipart/form-data: schema: $ref: '#/components/schemas/SamlSettingsUpdateRequest' - security: - - Token: [] responses: '201': content: @@ -9353,15 +9096,15 @@ paths: schema: $ref: '#/components/schemas/SamlSettingsUpdate' description: '' + security: + - Token: [] + summary: Update SAML2 Settings + tags: + - SSO /api/scim/settings: get: - operationId: api_scim_settings_retrieve description: Retrieve SCIM settings for the currently active organization. - summary: Retrieve SCIM Settings - tags: - - SSO - security: - - Token: [] + operationId: api_scim_settings_retrieve responses: '200': content: @@ -9369,12 +9112,14 @@ paths: schema: $ref: '#/components/schemas/ScimSettings' description: '' + security: + - Token: [] + summary: Retrieve SCIM Settings + tags: + - SSO post: - operationId: api_scim_settings_create description: Update SCIM settings for the currently active organization. - summary: Update SCIM Settings - tags: - - SSO + operationId: api_scim_settings_create requestBody: content: application/json: @@ -9386,8 +9131,6 @@ paths: multipart/form-data: schema: $ref: '#/components/schemas/ScimSettingsUpdateRequest' - security: - - Token: [] responses: '201': content: @@ -9395,15 +9138,15 @@ paths: schema: $ref: '#/components/schemas/ScimSettingsUpdate' description: '' + security: + - Token: [] + summary: Update SCIM Settings + tags: + - SSO /api/session-policy/: get: - operationId: api_session_policy_retrieve description: Retrieve session timeout policy for the currently active organization. - summary: Retrieve Session Policy - tags: - - Session Policy - security: - - Token: [] + operationId: api_session_policy_retrieve responses: '200': content: @@ -9411,12 +9154,14 @@ paths: schema: $ref: '#/components/schemas/SessionTimeoutPolicy' description: '' + security: + - Token: [] + summary: Retrieve Session Policy + tags: + - Session Policy patch: - operationId: api_session_policy_partial_update description: Update session timeout policy for the currently active organization. - summary: Update Session Policy - tags: - - Session Policy + operationId: api_session_policy_partial_update requestBody: content: application/json: @@ -9428,8 +9173,6 @@ paths: multipart/form-data: schema: $ref: '#/components/schemas/PatchedSessionTimeoutPolicyRequest' - security: - - Token: [] responses: '200': content: @@ -9437,131 +9180,126 @@ paths: schema: $ref: '#/components/schemas/SessionTimeoutPolicy' description: '' + security: + - Token: [] + summary: Update Session Policy + tags: + - Session Policy /api/storages/: get: + description: Retrieve a list of the import storages of all types with their IDs. operationId: api_storages_list - description: Retrieve a list of the import storages of all types with their - IDs. - summary: List all import storages from the project parameters: - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - tags: - - Storage - security: - - Token: [] + - description: Which field to use when ordering the results. + in: query + name: ordering + required: false + schema: + type: string responses: '200': content: application/json: schema: - type: array items: - type: object additionalProperties: {} description: Unspecified response body + type: object + type: array description: '' + security: + - Token: [] + summary: List all import storages from the project + tags: + - Storage + x-fern-audiences: + - internal x-fern-sdk-group-name: - - import_storage + - import_storage x-fern-sdk-method-name: list - x-fern-audiences: - - internal /api/storages/azure/: get: - operationId: api_storages_azure_list description: Get list of all Azure import storage connections. - summary: Get all import storage + operationId: api_storages_azure_list parameters: - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - - in: query - name: project - schema: - type: integer - description: Project ID - tags: - - 'Storage: Azure' - security: - - Token: [] + - description: Which field to use when ordering the results. + in: query + name: ordering + required: false + schema: + type: string + - description: Project ID + in: query + name: project + schema: + type: integer responses: '200': content: application/json: schema: - type: array items: $ref: '#/components/schemas/AzureBlobImportStorage' + type: array description: '' + security: + - Token: [] + summary: Get all import storage + tags: + - 'Storage: Azure' + x-fern-audiences: + - public x-fern-sdk-group-name: - - import_storage - - azure + - import_storage + - azure x-fern-sdk-method-name: list - x-fern-audiences: - - public post: - operationId: api_storages_azure_create description: Create new Azure import storage - summary: Create new storage - tags: - - 'Storage: Azure' + operationId: api_storages_azure_create requestBody: content: application/json: schema: - type: object properties: - regex_filter: + account_key: + description: Azure Blob account key type: string - description: Cloud storage regex for filtering objects. You must - specify it otherwise no objects will be imported. - use_blob_urls: - type: boolean - description: Interpret objects as BLOBs and generate URLs. For example, - if your bucket contains images, you can use this option to generate - URLs for these images. If set to False, it will read the content - of the file and load it into Label Studio. - default: false - presign: - type: boolean - description: Presign URLs for direct download - default: true - presign_ttl: - type: integer - description: Presign TTL in minutes - default: 1 - title: + account_name: + description: Azure Blob account name type: string - description: Storage title - maxLength: 2048 - description: + container: + description: Azure blob container type: string + description: description: Storage description - project: - type: integer - description: Project ID - container: type: string - description: Azure blob container prefix: - type: string description: Azure blob prefix name - account_name: type: string - description: Azure Blob account name - account_key: + presign: + default: true + description: Presign URLs for direct download + type: boolean + presign_ttl: + default: 1 + description: Presign TTL in minutes + type: integer + project: + description: Project ID + type: integer + regex_filter: + description: Cloud storage regex for filtering objects. You must specify it otherwise no objects will be imported. type: string - description: Azure Blob account key + title: + description: Storage title + maxLength: 2048 + type: string + use_blob_urls: + default: false + description: Interpret objects as BLOBs and generate URLs. For example, if your bucket contains images, you can use this option to generate URLs for these images. If set to False, it will read the content of the file and load it into Label Studio. + type: boolean required: [] - security: - - Token: [] + type: object responses: '201': content: @@ -9569,27 +9307,115 @@ paths: schema: $ref: '#/components/schemas/AzureBlobImportStorage' description: '' + security: + - Token: [] + summary: Create new storage + tags: + - 'Storage: Azure' + x-fern-audiences: + - public x-fern-sdk-group-name: - - import_storage - - azure + - import_storage + - azure x-fern-sdk-method-name: create + /api/storages/azure/validate: + post: + description: Validate a specific Azure import storage connection. + operationId: api_storages_azure_validate_create + requestBody: + content: + application/json: + schema: + properties: + account_key: + description: Azure Blob account key + type: string + account_name: + description: Azure Blob account name + type: string + container: + description: Azure blob container + type: string + description: + description: Storage description + type: string + id: + description: Storage ID. If set, storage with specified ID will be updated + type: integer + prefix: + description: Azure blob prefix name + type: string + presign: + default: true + description: Presign URLs for direct download + type: boolean + presign_ttl: + default: 1 + description: Presign TTL in minutes + type: integer + project: + description: Project ID + type: integer + regex_filter: + description: Cloud storage regex for filtering objects. You must specify it otherwise no objects will be imported. + type: string + title: + description: Storage title + maxLength: 2048 + type: string + use_blob_urls: + default: false + description: Interpret objects as BLOBs and generate URLs. For example, if your bucket contains images, you can use this option to generate URLs for these images. If set to False, it will read the content of the file and load it into Label Studio. + type: boolean + required: [] + type: object + responses: + '200': + description: Validation successful + security: + - Token: [] + summary: Validate import storage + tags: + - 'Storage: Azure' x-fern-audiences: - - public + - public + x-fern-sdk-group-name: + - import_storage + - azure + x-fern-sdk-method-name: validate /api/storages/azure/{id}: + delete: + description: Delete a specific Azure import storage connection. + operationId: api_storages_azure_destroy + parameters: + - in: path + name: id + required: true + schema: + type: integer + responses: + '204': + description: No response body + security: + - Token: [] + summary: Delete import storage + tags: + - 'Storage: Azure' + x-fern-audiences: + - public + x-fern-sdk-group-name: + - import_storage + - azure + x-fern-sdk-method-name: delete get: - operationId: api_storages_azure_retrieve description: Get a specific Azure import storage connection. - summary: Get import storage + operationId: api_storages_azure_retrieve parameters: - - in: path - name: id - schema: - type: integer - required: true - tags: - - 'Storage: Azure' - security: - - Token: [] + - in: path + name: id + required: true + schema: + type: integer responses: '200': content: @@ -9597,74 +9423,70 @@ paths: schema: $ref: '#/components/schemas/AzureBlobImportStorage' description: '' + security: + - Token: [] + summary: Get import storage + tags: + - 'Storage: Azure' + x-fern-audiences: + - public x-fern-sdk-group-name: - - import_storage - - azure + - import_storage + - azure x-fern-sdk-method-name: get - x-fern-audiences: - - public patch: - operationId: api_storages_azure_partial_update description: Update a specific Azure import storage connection. - summary: Update import storage + operationId: api_storages_azure_partial_update parameters: - - in: path - name: id - schema: - type: integer - required: true - tags: - - 'Storage: Azure' + - in: path + name: id + required: true + schema: + type: integer requestBody: content: application/json: schema: - type: object properties: - regex_filter: + account_key: + description: Azure Blob account key type: string - description: Cloud storage regex for filtering objects. You must - specify it otherwise no objects will be imported. - use_blob_urls: - type: boolean - description: Interpret objects as BLOBs and generate URLs. For example, - if your bucket contains images, you can use this option to generate - URLs for these images. If set to False, it will read the content - of the file and load it into Label Studio. - default: false - presign: - type: boolean - description: Presign URLs for direct download - default: true - presign_ttl: - type: integer - description: Presign TTL in minutes - default: 1 - title: + account_name: + description: Azure Blob account name type: string - description: Storage title - maxLength: 2048 - description: + container: + description: Azure blob container type: string + description: description: Storage description - project: - type: integer - description: Project ID - container: type: string - description: Azure blob container prefix: - type: string description: Azure blob prefix name - account_name: type: string - description: Azure Blob account name - account_key: + presign: + default: true + description: Presign URLs for direct download + type: boolean + presign_ttl: + default: 1 + description: Presign TTL in minutes + type: integer + project: + description: Project ID + type: integer + regex_filter: + description: Cloud storage regex for filtering objects. You must specify it otherwise no objects will be imported. type: string - description: Azure Blob account key + title: + description: Storage title + maxLength: 2048 + type: string + use_blob_urls: + default: false + description: Interpret objects as BLOBs and generate URLs. For example, if your bucket contains images, you can use this option to generate URLs for these images. If set to False, it will read the content of the file and load it into Label Studio. + type: boolean required: [] - security: - - Token: [] + type: object responses: '200': content: @@ -9672,51 +9494,28 @@ paths: schema: $ref: '#/components/schemas/AzureBlobImportStorage' description: '' - x-fern-sdk-group-name: - - import_storage - - azure - x-fern-sdk-method-name: update - x-fern-audiences: - - public - delete: - operationId: api_storages_azure_destroy - description: Delete a specific Azure import storage connection. - summary: Delete import storage - parameters: - - in: path - name: id - schema: - type: integer - required: true - tags: - - 'Storage: Azure' security: - - Token: [] - responses: - '204': - description: No response body - x-fern-sdk-group-name: - - import_storage - - azure - x-fern-sdk-method-name: delete + - Token: [] + summary: Update import storage + tags: + - 'Storage: Azure' x-fern-audiences: - - public + - public + x-fern-sdk-group-name: + - import_storage + - azure + x-fern-sdk-method-name: update /api/storages/azure/{id}/sync: post: - operationId: api_storages_azure_sync_create description: Sync tasks from an Azure import storage connection. - summary: Sync import storage + operationId: api_storages_azure_sync_create parameters: - - in: path - name: id - schema: - type: integer - description: Storage ID - required: true - tags: - - 'Storage: Azure' - security: - - Token: [] + - description: Storage ID + in: path + name: id + required: true + schema: + type: integer responses: '200': content: @@ -9724,114 +9523,73 @@ paths: schema: $ref: '#/components/schemas/AzureBlobImportStorage' description: '' - x-fern-sdk-group-name: - - import_storage - - azure - x-fern-sdk-method-name: sync - x-fern-audiences: - - public - /api/storages/azure/validate: - post: - operationId: api_storages_azure_validate_create - description: Validate a specific Azure import storage connection. - summary: Validate import storage - tags: - - 'Storage: Azure' - requestBody: - content: - application/json: - schema: - type: object - properties: - id: - type: integer - description: Storage ID. If set, storage with specified ID will - be updated - regex_filter: - type: string - description: Cloud storage regex for filtering objects. You must - specify it otherwise no objects will be imported. - use_blob_urls: - type: boolean - description: Interpret objects as BLOBs and generate URLs. For example, - if your bucket contains images, you can use this option to generate - URLs for these images. If set to False, it will read the content - of the file and load it into Label Studio. - default: false - presign: - type: boolean - description: Presign URLs for direct download - default: true - presign_ttl: - type: integer - description: Presign TTL in minutes - default: 1 - title: - type: string - description: Storage title - maxLength: 2048 - description: - type: string - description: Storage description - project: - type: integer - description: Project ID - container: - type: string - description: Azure blob container - prefix: - type: string - description: Azure blob prefix name - account_name: - type: string - description: Azure Blob account name - account_key: - type: string - description: Azure Blob account key - required: [] security: - - Token: [] - responses: - '200': - description: Validation successful - x-fern-sdk-group-name: - - import_storage - - azure - x-fern-sdk-method-name: validate + - Token: [] + summary: Sync import storage + tags: + - 'Storage: Azure' x-fern-audiences: - - public + - public + x-fern-sdk-group-name: + - import_storage + - azure + x-fern-sdk-method-name: sync /api/storages/azure_spi/: get: + description: Get list of all Azure import storage connections set up with Service Principal authentication. operationId: api_storages_azure_spi_list - description: Get list of all Azure import storage connections set up with Service - Principal authentication. - summary: Get Azure SPI import storage parameters: - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - tags: - - 'Storage: Azure SPI' - security: - - Token: [] + - description: Which field to use when ordering the results. + in: query + name: ordering + required: false + schema: + type: string responses: '200': content: application/json: schema: - type: array items: $ref: '#/components/schemas/AzureServicePrincipalImportStorage' + type: array description: '' + security: + - Token: [] + summary: Get Azure SPI import storage + tags: + - 'Storage: Azure SPI' post: - operationId: api_storages_azure_spi_create description: Create Azure import storage with Service Principal authentication. + operationId: api_storages_azure_spi_create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AzureServicePrincipalImportStorageRequest' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/AzureServicePrincipalImportStorageRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/AzureServicePrincipalImportStorageRequest' + required: true + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/AzureServicePrincipalImportStorage' + description: '' + security: + - Token: [] summary: Create Azure import storage with SPI tags: - - 'Storage: Azure SPI' + - 'Storage: Azure SPI' + /api/storages/azure_spi/validate: + post: + description: Validate a specific Azure import storage connection that was set up with Service Principal authentication. + operationId: api_storages_azure_spi_validate_create requestBody: content: application/json: @@ -9844,8 +9602,6 @@ paths: schema: $ref: '#/components/schemas/AzureServicePrincipalImportStorageRequest' required: true - security: - - Token: [] responses: '201': content: @@ -9853,22 +9609,38 @@ paths: schema: $ref: '#/components/schemas/AzureServicePrincipalImportStorage' description: '' + security: + - Token: [] + summary: Validate Azure SPI import storage + tags: + - 'Storage: Azure SPI' /api/storages/azure_spi/{id}: + delete: + description: Delete a specific Azure import storage connection that was set up with Service Principal authentication. + operationId: api_storages_azure_spi_destroy + parameters: + - in: path + name: id + required: true + schema: + type: integer + responses: + '204': + description: No response body + security: + - Token: [] + summary: Delete Azure SPI import storage + tags: + - 'Storage: Azure SPI' get: + description: Get a specific Azure import storage connection that was set up with Service Principal authentication. operationId: api_storages_azure_spi_retrieve - description: Get a specific Azure import storage connection that was set up - with Service Principal authentication. - summary: Get Azure SPI import storage parameters: - - in: path - name: id - schema: - type: integer - required: true - tags: - - 'Storage: Azure SPI' - security: - - Token: [] + - in: path + name: id + required: true + schema: + type: integer responses: '200': content: @@ -9876,19 +9648,20 @@ paths: schema: $ref: '#/components/schemas/AzureServicePrincipalImportStorage' description: '' + security: + - Token: [] + summary: Get Azure SPI import storage + tags: + - 'Storage: Azure SPI' patch: + description: Update a specific Azure import storage connection that was set up with Service Principal authentication. operationId: api_storages_azure_spi_partial_update - description: Update a specific Azure import storage connection that was set - up with Service Principal authentication. - summary: Update Azure SPI import storage parameters: - - in: path - name: id - schema: - type: integer - required: true - tags: - - 'Storage: Azure SPI' + - in: path + name: id + required: true + schema: + type: integer requestBody: content: application/json: @@ -9900,8 +9673,6 @@ paths: multipart/form-data: schema: $ref: '#/components/schemas/PatchedAzureServicePrincipalImportStorageRequest' - security: - - Token: [] responses: '200': content: @@ -9909,38 +9680,21 @@ paths: schema: $ref: '#/components/schemas/AzureServicePrincipalImportStorage' description: '' - delete: - operationId: api_storages_azure_spi_destroy - description: Delete a specific Azure import storage connection that was set - up with Service Principal authentication. - summary: Delete Azure SPI import storage - parameters: - - in: path - name: id - schema: - type: integer - required: true - tags: - - 'Storage: Azure SPI' security: - - Token: [] - responses: - '204': - description: No response body + - Token: [] + summary: Update Azure SPI import storage + tags: + - 'Storage: Azure SPI' /api/storages/azure_spi/{id}/sync: post: + description: Sync tasks from an Azure import storage connection that was set up with Service Principal authentication. operationId: api_storages_azure_spi_sync_create - description: Sync tasks from an Azure import storage connection that was set - up with Service Principal authentication. - summary: Sync Azure SPI import storage parameters: - - in: path - name: id - schema: - type: integer - required: true - tags: - - 'Storage: Azure SPI' + - in: path + name: id + required: true + schema: + type: integer requestBody: content: application/json: @@ -9953,8 +9707,6 @@ paths: schema: $ref: '#/components/schemas/AzureServicePrincipalImportStorageRequest' required: true - security: - - Token: [] responses: '200': content: @@ -9962,145 +9714,115 @@ paths: schema: $ref: '#/components/schemas/AzureServicePrincipalImportStorage' description: '' - /api/storages/azure_spi/validate: - post: - operationId: api_storages_azure_spi_validate_create - description: Validate a specific Azure import storage connection that was set - up with Service Principal authentication. - summary: Validate Azure SPI import storage - tags: - - 'Storage: Azure SPI' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/AzureServicePrincipalImportStorageRequest' - application/x-www-form-urlencoded: - schema: - $ref: '#/components/schemas/AzureServicePrincipalImportStorageRequest' - multipart/form-data: - schema: - $ref: '#/components/schemas/AzureServicePrincipalImportStorageRequest' - required: true security: - - Token: [] - responses: - '201': - content: - application/json: - schema: - $ref: '#/components/schemas/AzureServicePrincipalImportStorage' - description: '' + - Token: [] + summary: Sync Azure SPI import storage + tags: + - 'Storage: Azure SPI' /api/storages/export: get: + description: Retrieve a list of the export storages of all types with their IDs. operationId: api_storages_export_list - description: Retrieve a list of the export storages of all types with their - IDs. - summary: List all export storages from the project parameters: - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - tags: - - Storage - security: - - Token: [] + - description: Which field to use when ordering the results. + in: query + name: ordering + required: false + schema: + type: string responses: '200': content: application/json: schema: - type: array items: - type: object additionalProperties: {} description: Unspecified response body + type: object + type: array description: '' + security: + - Token: [] + summary: List all export storages from the project + tags: + - Storage + x-fern-audiences: + - internal x-fern-sdk-group-name: - - export_storage + - export_storage x-fern-sdk-method-name: list - x-fern-audiences: - - internal /api/storages/export/azure: get: - operationId: api_storages_export_azure_list description: Get a list of all Azure export storage connections. - summary: Get all export storage + operationId: api_storages_export_azure_list parameters: - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - - in: query - name: project - schema: - type: integer - description: Project ID - tags: - - 'Storage: Azure' - security: - - Token: [] + - description: Which field to use when ordering the results. + in: query + name: ordering + required: false + schema: + type: string + - description: Project ID + in: query + name: project + schema: + type: integer responses: '200': content: application/json: schema: - type: array items: $ref: '#/components/schemas/AzureBlobExportStorage' + type: array description: '' + security: + - Token: [] + summary: Get all export storage + tags: + - 'Storage: Azure' + x-fern-audiences: + - public x-fern-sdk-group-name: - - export_storage - - azure + - export_storage + - azure x-fern-sdk-method-name: list - x-fern-audiences: - - public post: - operationId: api_storages_export_azure_create description: Create a new Azure export storage connection to store annotations. - summary: Create export storage - tags: - - 'Storage: Azure' + operationId: api_storages_export_azure_create requestBody: content: application/json: schema: - type: object properties: + account_key: + description: Azure Blob account key + type: string + account_name: + description: Azure Blob account name + type: string can_delete_objects: - type: boolean - description: Deletion from storage enabled default: false - title: + description: Deletion from storage enabled + type: boolean + container: + description: Azure blob container type: string - description: Storage title - maxLength: 2048 description: - type: string description: Storage description - project: - type: integer - description: Project ID - container: type: string - description: Azure blob container prefix: - type: string description: Azure blob prefix name - account_name: type: string - description: Azure Blob account name - account_key: + project: + description: Project ID + type: integer + title: + description: Storage title + maxLength: 2048 type: string - description: Azure Blob account key required: [] - security: - - Token: [] + type: object responses: '201': content: @@ -10108,138 +9830,104 @@ paths: schema: $ref: '#/components/schemas/AzureBlobExportStorage' description: '' - x-fern-sdk-group-name: - - export_storage - - azure - x-fern-sdk-method-name: create - x-fern-audiences: - - public - /api/storages/export/azure/{id}: - get: - operationId: api_storages_export_azure_retrieve - description: Get a specific Azure export storage connection. - summary: Get export storage - parameters: - - in: path - name: id - schema: - type: integer - required: true - tags: - - 'Storage: Azure' security: - - Token: [] - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/AzureBlobExportStorage' - description: '' - x-fern-sdk-group-name: - - export_storage - - azure - x-fern-sdk-method-name: get - x-fern-audiences: - - public - patch: - operationId: api_storages_export_azure_partial_update - description: Update a specific Azure export storage connection. - summary: Update export storage - parameters: - - in: path - name: id - schema: - type: integer - required: true + - Token: [] + summary: Create export storage tags: - - 'Storage: Azure' + - 'Storage: Azure' + x-fern-audiences: + - public + x-fern-sdk-group-name: + - export_storage + - azure + x-fern-sdk-method-name: create + /api/storages/export/azure/validate: + post: + description: Validate a specific Azure export storage connection. + operationId: api_storages_export_azure_validate_create requestBody: content: application/json: schema: - type: object properties: + account_key: + description: Azure Blob account key + type: string + account_name: + description: Azure Blob account name + type: string can_delete_objects: - type: boolean - description: Deletion from storage enabled default: false - title: + description: Deletion from storage enabled + type: boolean + container: + description: Azure blob container type: string - description: Storage title - maxLength: 2048 description: - type: string description: Storage description - project: - type: integer - description: Project ID - container: type: string - description: Azure blob container + id: + description: Storage ID. If set, storage with specified ID will be updated + type: integer prefix: - type: string description: Azure blob prefix name - account_name: type: string - description: Azure Blob account name - account_key: + project: + description: Project ID + type: integer + title: + description: Storage title + maxLength: 2048 type: string - description: Azure Blob account key required: [] - security: - - Token: [] + type: object responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/AzureBlobExportStorage' - description: '' - x-fern-sdk-group-name: - - export_storage - - azure - x-fern-sdk-method-name: update + description: Validation successful + security: + - Token: [] + summary: Validate export storage + tags: + - 'Storage: Azure' x-fern-audiences: - - public + - public + x-fern-sdk-group-name: + - export_storage + - azure + x-fern-sdk-method-name: validate + /api/storages/export/azure/{id}: delete: - operationId: api_storages_export_azure_destroy description: Delete a specific Azure export storage connection. - summary: Delete export storage + operationId: api_storages_export_azure_destroy parameters: - - in: path - name: id - schema: - type: integer - required: true - tags: - - 'Storage: Azure' - security: - - Token: [] + - in: path + name: id + required: true + schema: + type: integer responses: '204': description: No response body + security: + - Token: [] + summary: Delete export storage + tags: + - 'Storage: Azure' + x-fern-audiences: + - public x-fern-sdk-group-name: - - export_storage - - azure + - export_storage + - azure x-fern-sdk-method-name: delete - x-fern-audiences: - - public - /api/storages/export/azure/{id}/sync: - post: - operationId: api_storages_export_azure_sync_create - description: Sync tasks from an Azure export storage connection. - summary: Sync export storage + get: + description: Get a specific Azure export storage connection. + operationId: api_storages_export_azure_retrieve parameters: - - in: path - name: id - schema: - type: integer - required: true - tags: - - 'Storage: Azure' - security: - - Token: [] + - in: path + name: id + required: true + schema: + type: integer responses: '200': content: @@ -10247,100 +9935,161 @@ paths: schema: $ref: '#/components/schemas/AzureBlobExportStorage' description: '' - x-fern-sdk-group-name: - - export_storage - - azure - x-fern-sdk-method-name: sync - x-fern-audiences: - - public - /api/storages/export/azure/validate: - post: - operationId: api_storages_export_azure_validate_create - description: Validate a specific Azure export storage connection. - summary: Validate export storage + security: + - Token: [] + summary: Get export storage tags: - - 'Storage: Azure' + - 'Storage: Azure' + x-fern-audiences: + - public + x-fern-sdk-group-name: + - export_storage + - azure + x-fern-sdk-method-name: get + patch: + description: Update a specific Azure export storage connection. + operationId: api_storages_export_azure_partial_update + parameters: + - in: path + name: id + required: true + schema: + type: integer requestBody: content: application/json: schema: - type: object properties: - id: - type: integer - description: Storage ID. If set, storage with specified ID will - be updated + account_key: + description: Azure Blob account key + type: string + account_name: + description: Azure Blob account name + type: string can_delete_objects: - type: boolean - description: Deletion from storage enabled default: false - title: + description: Deletion from storage enabled + type: boolean + container: + description: Azure blob container type: string - description: Storage title - maxLength: 2048 description: - type: string description: Storage description - project: - type: integer - description: Project ID - container: type: string - description: Azure blob container prefix: - type: string description: Azure blob prefix name - account_name: type: string - description: Azure Blob account name - account_key: + project: + description: Project ID + type: integer + title: + description: Storage title + maxLength: 2048 type: string - description: Azure Blob account key required: [] - security: - - Token: [] + type: object responses: '200': - description: Validation successful - x-fern-sdk-group-name: - - export_storage - - azure - x-fern-sdk-method-name: validate + content: + application/json: + schema: + $ref: '#/components/schemas/AzureBlobExportStorage' + description: '' + security: + - Token: [] + summary: Update export storage + tags: + - 'Storage: Azure' x-fern-audiences: - - public - /api/storages/export/azure_spi: - get: - operationId: api_storages_export_azure_spi_list - description: Get a list of all Azure export storage connections that were set - up with Service Principal authentication. - summary: Get all Azure SPI export storage + - public + x-fern-sdk-group-name: + - export_storage + - azure + x-fern-sdk-method-name: update + /api/storages/export/azure/{id}/sync: + post: + description: Sync tasks from an Azure export storage connection. + operationId: api_storages_export_azure_sync_create parameters: - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - tags: - - 'Storage: Azure SPI' - security: - - Token: [] + - in: path + name: id + required: true + schema: + type: integer responses: '200': content: application/json: schema: - type: array - items: + $ref: '#/components/schemas/AzureBlobExportStorage' + description: '' + security: + - Token: [] + summary: Sync export storage + tags: + - 'Storage: Azure' + x-fern-audiences: + - public + x-fern-sdk-group-name: + - export_storage + - azure + x-fern-sdk-method-name: sync + /api/storages/export/azure_spi: + get: + description: Get a list of all Azure export storage connections that were set up with Service Principal authentication. + operationId: api_storages_export_azure_spi_list + parameters: + - description: Which field to use when ordering the results. + in: query + name: ordering + required: false + schema: + type: string + responses: + '200': + content: + application/json: + schema: + items: $ref: '#/components/schemas/AzureServicePrincipalExportStorage' + type: array description: '' + security: + - Token: [] + summary: Get all Azure SPI export storage + tags: + - 'Storage: Azure SPI' post: + description: Create an Azure export storage connection with Service Principal authentication to store annotations. operationId: api_storages_export_azure_spi_create - description: Create an Azure export storage connection with Service Principal - authentication to store annotations. + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AzureServicePrincipalExportStorageRequest' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/AzureServicePrincipalExportStorageRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/AzureServicePrincipalExportStorageRequest' + required: true + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/AzureServicePrincipalExportStorage' + description: '' + security: + - Token: [] summary: Create Azure export storage with SPI authentication tags: - - 'Storage: Azure SPI' + - 'Storage: Azure SPI' + /api/storages/export/azure_spi/validate: + post: + description: Validate a specific Azure export storage connection that was set up with Service Principal authentication. + operationId: api_storages_export_azure_spi_validate_create requestBody: content: application/json: @@ -10353,8 +10102,6 @@ paths: schema: $ref: '#/components/schemas/AzureServicePrincipalExportStorageRequest' required: true - security: - - Token: [] responses: '201': content: @@ -10362,22 +10109,38 @@ paths: schema: $ref: '#/components/schemas/AzureServicePrincipalExportStorage' description: '' + security: + - Token: [] + summary: Validate Azure SPI export storage + tags: + - 'Storage: Azure SPI' /api/storages/export/azure_spi/{id}: + delete: + description: Delete a specific Azure export storage connection that was set up with Service Principal authentication. + operationId: api_storages_export_azure_spi_destroy + parameters: + - in: path + name: id + required: true + schema: + type: integer + responses: + '204': + description: No response body + security: + - Token: [] + summary: Delete Azure SPI export storage + tags: + - 'Storage: Azure SPI' get: + description: Get a specific Azure export storage connection that was set up with Service Principal authentication. operationId: api_storages_export_azure_spi_retrieve - description: Get a specific Azure export storage connection that was set up - with Service Principal authentication. - summary: Get Azure SPI export storage parameters: - - in: path - name: id - schema: - type: integer - required: true - tags: - - 'Storage: Azure SPI' - security: - - Token: [] + - in: path + name: id + required: true + schema: + type: integer responses: '200': content: @@ -10385,19 +10148,20 @@ paths: schema: $ref: '#/components/schemas/AzureServicePrincipalExportStorage' description: '' + security: + - Token: [] + summary: Get Azure SPI export storage + tags: + - 'Storage: Azure SPI' patch: + description: Update a specific Azure export storage connection that was set up with Service Principal authentication. operationId: api_storages_export_azure_spi_partial_update - description: Update a specific Azure export storage connection that was set - up with Service Principal authentication. - summary: Update Azure SPI export storage parameters: - - in: path - name: id - schema: - type: integer - required: true - tags: - - 'Storage: Azure SPI' + - in: path + name: id + required: true + schema: + type: integer requestBody: content: application/json: @@ -10409,8 +10173,6 @@ paths: multipart/form-data: schema: $ref: '#/components/schemas/PatchedAzureServicePrincipalExportStorageRequest' - security: - - Token: [] responses: '200': content: @@ -10418,37 +10180,21 @@ paths: schema: $ref: '#/components/schemas/AzureServicePrincipalExportStorage' description: '' - delete: - operationId: api_storages_export_azure_spi_destroy - description: Delete a specific Azure export storage connection that was set - up with Service Principal authentication. - summary: Delete Azure SPI export storage - parameters: - - in: path - name: id - schema: - type: integer - required: true - tags: - - 'Storage: Azure SPI' security: - - Token: [] - responses: - '204': - description: No response body + - Token: [] + summary: Update Azure SPI export storage + tags: + - 'Storage: Azure SPI' /api/storages/export/azure_spi/{id}/sync: post: - operationId: api_storages_export_azure_spi_sync_create description: Sync tasks from an Azure SPI export storage. - summary: Sync Azure SPI export storage + operationId: api_storages_export_azure_spi_sync_create parameters: - - in: path - name: id - schema: - type: integer - required: true - tags: - - 'Storage: Azure SPI' + - in: path + name: id + required: true + schema: + type: integer requestBody: content: application/json: @@ -10461,8 +10207,6 @@ paths: schema: $ref: '#/components/schemas/AzureServicePrincipalExportStorageRequest' required: true - security: - - Token: [] responses: '200': content: @@ -10470,114 +10214,83 @@ paths: schema: $ref: '#/components/schemas/AzureServicePrincipalExportStorage' description: '' - /api/storages/export/azure_spi/validate: - post: - operationId: api_storages_export_azure_spi_validate_create - description: Validate a specific Azure export storage connection that was set - up with Service Principal authentication. - summary: Validate Azure SPI export storage - tags: - - 'Storage: Azure SPI' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/AzureServicePrincipalExportStorageRequest' - application/x-www-form-urlencoded: - schema: - $ref: '#/components/schemas/AzureServicePrincipalExportStorageRequest' - multipart/form-data: - schema: - $ref: '#/components/schemas/AzureServicePrincipalExportStorageRequest' - required: true security: - - Token: [] - responses: - '201': - content: - application/json: - schema: - $ref: '#/components/schemas/AzureServicePrincipalExportStorage' - description: '' + - Token: [] + summary: Sync Azure SPI export storage + tags: + - 'Storage: Azure SPI' /api/storages/export/gcs: get: - operationId: api_storages_export_gcs_list description: Get a list of all GCS export storage connections. - summary: Get all export storage + operationId: api_storages_export_gcs_list parameters: - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - - in: query - name: project - schema: - type: integer - description: Project ID - tags: - - 'Storage: GCS' - security: - - Token: [] + - description: Which field to use when ordering the results. + in: query + name: ordering + required: false + schema: + type: string + - description: Project ID + in: query + name: project + schema: + type: integer responses: '200': content: application/json: schema: - type: array items: $ref: '#/components/schemas/GCSExportStorage' + type: array description: '' + security: + - Token: [] + summary: Get all export storage + tags: + - 'Storage: GCS' + x-fern-audiences: + - public x-fern-sdk-group-name: - - export_storage - - gcs + - export_storage + - gcs x-fern-sdk-method-name: list - x-fern-audiences: - - public post: - operationId: api_storages_export_gcs_create description: Create a new GCS export storage connection to store annotations. - summary: Create export storage - tags: - - 'Storage: GCS' + operationId: api_storages_export_gcs_create requestBody: content: application/json: schema: - type: object properties: + bucket: + description: GCS bucket name + type: string can_delete_objects: - type: boolean - description: Deletion from storage enabled. default: false - title: - type: string - description: Storage title - maxLength: 2048 + description: Deletion from storage enabled. + type: boolean description: - type: string description: Storage description - project: - type: integer - description: Project ID - bucket: - type: string - description: GCS bucket name - prefix: type: string - description: GCS bucket prefix google_application_credentials: + description: The content of GOOGLE_APPLICATION_CREDENTIALS json file. Check official Google Cloud Authentication documentation for more details. type: string - description: The content of GOOGLE_APPLICATION_CREDENTIALS json - file. Check official Google Cloud Authentication documentation - for more details. google_project_id: - type: string description: Google project ID + type: string + prefix: + description: GCS bucket prefix + type: string + project: + description: Project ID + type: integer + title: + description: Storage title + maxLength: 2048 + type: string required: [] - security: - - Token: [] + type: object responses: '201': content: @@ -10585,140 +10298,104 @@ paths: schema: $ref: '#/components/schemas/GCSExportStorage' description: '' - x-fern-sdk-group-name: - - export_storage - - gcs - x-fern-sdk-method-name: create - x-fern-audiences: - - public - /api/storages/export/gcs/{id}: - get: - operationId: api_storages_export_gcs_retrieve - description: Get a specific GCS export storage connection. - summary: Get export storage - parameters: - - in: path - name: id - schema: - type: integer - required: true - tags: - - 'Storage: GCS' security: - - Token: [] - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/GCSExportStorage' - description: '' - x-fern-sdk-group-name: - - export_storage - - gcs - x-fern-sdk-method-name: get - x-fern-audiences: - - public - patch: - operationId: api_storages_export_gcs_partial_update - description: Update a specific GCS export storage connection. - summary: Update export storage - parameters: - - in: path - name: id - schema: - type: integer - required: true + - Token: [] + summary: Create export storage tags: - - 'Storage: GCS' + - 'Storage: GCS' + x-fern-audiences: + - public + x-fern-sdk-group-name: + - export_storage + - gcs + x-fern-sdk-method-name: create + /api/storages/export/gcs/validate: + post: + description: Validate a specific GCS export storage connection. + operationId: api_storages_export_gcs_validate_create requestBody: content: application/json: schema: - type: object properties: + bucket: + description: GCS bucket name + type: string can_delete_objects: - type: boolean - description: Deletion from storage enabled. default: false - title: - type: string - description: Storage title - maxLength: 2048 + description: Deletion from storage enabled. + type: boolean description: - type: string description: Storage description - project: - type: integer - description: Project ID - bucket: - type: string - description: GCS bucket name - prefix: type: string - description: GCS bucket prefix google_application_credentials: + description: The content of GOOGLE_APPLICATION_CREDENTIALS json file. Check official Google Cloud Authentication documentation for more details. type: string - description: The content of GOOGLE_APPLICATION_CREDENTIALS json - file. Check official Google Cloud Authentication documentation - for more details. google_project_id: - type: string description: Google project ID + type: string + id: + description: Storage ID. If set, storage with specified ID will be updated + type: integer + prefix: + description: GCS bucket prefix + type: string + project: + description: Project ID + type: integer + title: + description: Storage title + maxLength: 2048 + type: string required: [] - security: - - Token: [] + type: object responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/GCSExportStorage' - description: '' - x-fern-sdk-group-name: - - export_storage - - gcs - x-fern-sdk-method-name: update + description: Validation successful + security: + - Token: [] + summary: Validate export storage + tags: + - 'Storage: GCS' x-fern-audiences: - - public + - public + x-fern-sdk-group-name: + - export_storage + - gcs + x-fern-sdk-method-name: validate + /api/storages/export/gcs/{id}: delete: - operationId: api_storages_export_gcs_destroy description: Delete a specific GCS export storage connection. - summary: Delete export storage + operationId: api_storages_export_gcs_destroy parameters: - - in: path - name: id - schema: - type: integer - required: true - tags: - - 'Storage: GCS' - security: - - Token: [] + - in: path + name: id + required: true + schema: + type: integer responses: '204': description: No response body + security: + - Token: [] + summary: Delete export storage + tags: + - 'Storage: GCS' + x-fern-audiences: + - public x-fern-sdk-group-name: - - export_storage - - gcs + - export_storage + - gcs x-fern-sdk-method-name: delete - x-fern-audiences: - - public - /api/storages/export/gcs/{id}/sync: - post: - operationId: api_storages_export_gcs_sync_create - description: Sync tasks from an GCS export storage connection. - summary: Sync export storage + get: + description: Get a specific GCS export storage connection. + operationId: api_storages_export_gcs_retrieve parameters: - - in: path - name: id - schema: - type: integer - required: true - tags: - - 'Storage: GCS' - security: - - Token: [] + - in: path + name: id + required: true + schema: + type: integer responses: '200': content: @@ -10726,102 +10403,161 @@ paths: schema: $ref: '#/components/schemas/GCSExportStorage' description: '' - x-fern-sdk-group-name: - - export_storage - - gcs - x-fern-sdk-method-name: sync - x-fern-audiences: - - public - /api/storages/export/gcs/validate: - post: - operationId: api_storages_export_gcs_validate_create - description: Validate a specific GCS export storage connection. - summary: Validate export storage + security: + - Token: [] + summary: Get export storage tags: - - 'Storage: GCS' + - 'Storage: GCS' + x-fern-audiences: + - public + x-fern-sdk-group-name: + - export_storage + - gcs + x-fern-sdk-method-name: get + patch: + description: Update a specific GCS export storage connection. + operationId: api_storages_export_gcs_partial_update + parameters: + - in: path + name: id + required: true + schema: + type: integer requestBody: content: application/json: schema: - type: object properties: - id: - type: integer - description: Storage ID. If set, storage with specified ID will - be updated + bucket: + description: GCS bucket name + type: string can_delete_objects: - type: boolean - description: Deletion from storage enabled. default: false - title: - type: string - description: Storage title - maxLength: 2048 + description: Deletion from storage enabled. + type: boolean description: - type: string description: Storage description - project: - type: integer - description: Project ID - bucket: - type: string - description: GCS bucket name - prefix: type: string - description: GCS bucket prefix google_application_credentials: + description: The content of GOOGLE_APPLICATION_CREDENTIALS json file. Check official Google Cloud Authentication documentation for more details. type: string - description: The content of GOOGLE_APPLICATION_CREDENTIALS json - file. Check official Google Cloud Authentication documentation - for more details. google_project_id: - type: string description: Google project ID + type: string + prefix: + description: GCS bucket prefix + type: string + project: + description: Project ID + type: integer + title: + description: Storage title + maxLength: 2048 + type: string required: [] - security: - - Token: [] + type: object responses: '200': - description: Validation successful + content: + application/json: + schema: + $ref: '#/components/schemas/GCSExportStorage' + description: '' + security: + - Token: [] + summary: Update export storage + tags: + - 'Storage: GCS' + x-fern-audiences: + - public x-fern-sdk-group-name: - - export_storage - - gcs - x-fern-sdk-method-name: validate + - export_storage + - gcs + x-fern-sdk-method-name: update + /api/storages/export/gcs/{id}/sync: + post: + description: Sync tasks from an GCS export storage connection. + operationId: api_storages_export_gcs_sync_create + parameters: + - in: path + name: id + required: true + schema: + type: integer + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/GCSExportStorage' + description: '' + security: + - Token: [] + summary: Sync export storage + tags: + - 'Storage: GCS' x-fern-audiences: - - public + - public + x-fern-sdk-group-name: + - export_storage + - gcs + x-fern-sdk-method-name: sync /api/storages/export/gcswif: get: + description: Get a list of all GCS export storage connections that were set up with WIF authentication. operationId: api_storages_export_gcswif_list - description: Get a list of all GCS export storage connections that were set - up with WIF authentication. - summary: Get all GCS WIF export storage parameters: - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - tags: - - 'Storage: GCS WIF' - security: - - Token: [] + - description: Which field to use when ordering the results. + in: query + name: ordering + required: false + schema: + type: string responses: '200': content: application/json: schema: - type: array items: $ref: '#/components/schemas/GCSWIFExportStorage' + type: array description: '' + security: + - Token: [] + summary: Get all GCS WIF export storage + tags: + - 'Storage: GCS WIF' post: + description: Create an GCS export storage connection with WIF authentication to store annotations. operationId: api_storages_export_gcswif_create - description: Create an GCS export storage connection with WIF authentication - to store annotations. + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GCSWIFExportStorageRequest' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/GCSWIFExportStorageRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/GCSWIFExportStorageRequest' + required: true + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/GCSWIFExportStorage' + description: '' + security: + - Token: [] summary: Create GCS export storage with WIF authentication tags: - - 'Storage: GCS WIF' + - 'Storage: GCS WIF' + /api/storages/export/gcswif/validate: + post: + description: Validate a specific GCS export storage connection that was set up with WIF authentication. + operationId: api_storages_export_gcswif_validate_create requestBody: content: application/json: @@ -10834,8 +10570,6 @@ paths: schema: $ref: '#/components/schemas/GCSWIFExportStorageRequest' required: true - security: - - Token: [] responses: '201': content: @@ -10843,22 +10577,38 @@ paths: schema: $ref: '#/components/schemas/GCSWIFExportStorage' description: '' + security: + - Token: [] + summary: Validate GCS WIF export storage + tags: + - 'Storage: GCS WIF' /api/storages/export/gcswif/{id}: + delete: + description: Delete a specific GCS export storage connection that was set up with WIF authentication. + operationId: api_storages_export_gcswif_destroy + parameters: + - in: path + name: id + required: true + schema: + type: integer + responses: + '204': + description: No response body + security: + - Token: [] + summary: Delete GCS WIF export storage + tags: + - 'Storage: GCS WIF' get: + description: Get a specific GCS export storage connection that was set up with WIF authentication. operationId: api_storages_export_gcswif_retrieve - description: Get a specific GCS export storage connection that was set up with - WIF authentication. - summary: Get GCS WIF export storage parameters: - - in: path - name: id - schema: - type: integer - required: true - tags: - - 'Storage: GCS WIF' - security: - - Token: [] + - in: path + name: id + required: true + schema: + type: integer responses: '200': content: @@ -10866,19 +10616,20 @@ paths: schema: $ref: '#/components/schemas/GCSWIFExportStorage' description: '' + security: + - Token: [] + summary: Get GCS WIF export storage + tags: + - 'Storage: GCS WIF' patch: + description: Update a specific GCS export storage connection that was set up with WIF authentication. operationId: api_storages_export_gcswif_partial_update - description: Update a specific GCS export storage connection that was set up - with WIF authentication. - summary: Update GCS WIF export storage parameters: - - in: path - name: id - schema: - type: integer - required: true - tags: - - 'Storage: GCS WIF' + - in: path + name: id + required: true + schema: + type: integer requestBody: content: application/json: @@ -10890,8 +10641,6 @@ paths: multipart/form-data: schema: $ref: '#/components/schemas/PatchedGCSWIFExportStorageRequest' - security: - - Token: [] responses: '200': content: @@ -10899,37 +10648,21 @@ paths: schema: $ref: '#/components/schemas/GCSWIFExportStorage' description: '' - delete: - operationId: api_storages_export_gcswif_destroy - description: Delete a specific GCS export storage connection that was set up - with WIF authentication. - summary: Delete GCS WIF export storage - parameters: - - in: path - name: id - schema: - type: integer - required: true - tags: - - 'Storage: GCS WIF' security: - - Token: [] - responses: - '204': - description: No response body + - Token: [] + summary: Update GCS WIF export storage + tags: + - 'Storage: GCS WIF' /api/storages/export/gcswif/{id}/sync: post: - operationId: api_storages_export_gcswif_sync_create description: Sync tasks from an GCS WIF export storage. - summary: Sync GCS WIF export storage + operationId: api_storages_export_gcswif_sync_create parameters: - - in: path - name: id - schema: - type: integer - required: true - tags: - - 'Storage: GCS WIF' + - in: path + name: id + required: true + schema: + type: integer requestBody: content: application/json: @@ -10942,8 +10675,6 @@ paths: schema: $ref: '#/components/schemas/GCSWIFExportStorageRequest' required: true - security: - - Token: [] responses: '200': content: @@ -10951,109 +10682,77 @@ paths: schema: $ref: '#/components/schemas/GCSWIFExportStorage' description: '' - /api/storages/export/gcswif/validate: - post: - operationId: api_storages_export_gcswif_validate_create - description: Validate a specific GCS export storage connection that was set - up with WIF authentication. - summary: Validate GCS WIF export storage - tags: - - 'Storage: GCS WIF' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GCSWIFExportStorageRequest' - application/x-www-form-urlencoded: - schema: - $ref: '#/components/schemas/GCSWIFExportStorageRequest' - multipart/form-data: - schema: - $ref: '#/components/schemas/GCSWIFExportStorageRequest' - required: true security: - - Token: [] - responses: - '201': - content: - application/json: - schema: - $ref: '#/components/schemas/GCSWIFExportStorage' - description: '' + - Token: [] + summary: Sync GCS WIF export storage + tags: + - 'Storage: GCS WIF' /api/storages/export/localfiles: get: - operationId: api_storages_export_localfiles_list description: Get a list of all local file export storage connections. - summary: Get all export storage + operationId: api_storages_export_localfiles_list parameters: - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - - in: query - name: project - schema: - type: integer - description: Project ID - tags: - - 'Storage: Local' - security: - - Token: [] + - description: Which field to use when ordering the results. + in: query + name: ordering + required: false + schema: + type: string + - description: Project ID + in: query + name: project + schema: + type: integer responses: '200': content: application/json: schema: - type: array items: $ref: '#/components/schemas/LocalFilesExportStorage' + type: array description: '' + security: + - Token: [] + summary: Get all export storage + tags: + - 'Storage: Local' + x-fern-audiences: + - public x-fern-sdk-group-name: - - export_storage - - local + - export_storage + - local x-fern-sdk-method-name: list - x-fern-audiences: - - public post: - operationId: api_storages_export_localfiles_create description: Create a new local file export storage connection to store annotations. - summary: Create export storage - tags: - - 'Storage: Local' + operationId: api_storages_export_localfiles_create requestBody: content: application/json: schema: - type: object properties: - title: - type: string - description: Storage title - maxLength: 2048 description: - type: string description: Storage description - project: - type: integer - description: Project ID - path: type: string + path: description: Path to local directory - regex_filter: type: string + project: + description: Project ID + type: integer + regex_filter: description: Regex for filtering objects + type: string + title: + description: Storage title + maxLength: 2048 + type: string use_blob_urls: - type: boolean - description: Interpret objects as BLOBs and generate URLs. For example, - if your directory contains images, you can use this option to - generate URLs for these images. If set to False, it will read - the content of the file and load it into Label Studio. default: false + description: Interpret objects as BLOBs and generate URLs. For example, if your directory contains images, you can use this option to generate URLs for these images. If set to False, it will read the content of the file and load it into Label Studio. + type: boolean required: [] - security: - - Token: [] + type: object responses: '201': content: @@ -11061,135 +10760,98 @@ paths: schema: $ref: '#/components/schemas/LocalFilesExportStorage' description: '' - x-fern-sdk-group-name: - - export_storage - - local - x-fern-sdk-method-name: create - x-fern-audiences: - - public - /api/storages/export/localfiles/{id}: - get: - operationId: api_storages_export_localfiles_retrieve - description: Get a specific local file export storage connection. - summary: Get export storage - parameters: - - in: path - name: id - schema: - type: integer - required: true - tags: - - 'Storage: Local' security: - - Token: [] - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/LocalFilesExportStorage' - description: '' - x-fern-sdk-group-name: - - export_storage - - local - x-fern-sdk-method-name: get - x-fern-audiences: - - public - patch: - operationId: api_storages_export_localfiles_partial_update - description: Update a specific local file export storage connection. - summary: Update export storage - parameters: - - in: path - name: id - schema: - type: integer - required: true + - Token: [] + summary: Create export storage tags: - - 'Storage: Local' + - 'Storage: Local' + x-fern-audiences: + - public + x-fern-sdk-group-name: + - export_storage + - local + x-fern-sdk-method-name: create + /api/storages/export/localfiles/validate: + post: + description: Validate a specific local file export storage connection. + operationId: api_storages_export_localfiles_validate_create requestBody: content: application/json: schema: - type: object properties: - title: - type: string - description: Storage title - maxLength: 2048 description: - type: string description: Storage description - project: + type: string + id: + description: Storage ID. If set, storage with specified ID will be updated type: integer - description: Project ID path: - type: string description: Path to local directory - regex_filter: type: string + project: + description: Project ID + type: integer + regex_filter: description: Regex for filtering objects + type: string + title: + description: Storage title + maxLength: 2048 + type: string use_blob_urls: - type: boolean - description: Interpret objects as BLOBs and generate URLs. For example, - if your directory contains images, you can use this option to - generate URLs for these images. If set to False, it will read - the content of the file and load it into Label Studio. default: false + description: Interpret objects as BLOBs and generate URLs. For example, if your directory contains images, you can use this option to generate URLs for these images. If set to False, it will read the content of the file and load it into Label Studio. + type: boolean required: [] - security: - - Token: [] + type: object responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/LocalFilesExportStorage' - description: '' - x-fern-sdk-group-name: - - export_storage - - local - x-fern-sdk-method-name: update + description: Validation successful + security: + - Token: [] + summary: Validate export storage + tags: + - 'Storage: Local' x-fern-audiences: - - public + - public + x-fern-sdk-group-name: + - export_storage + - local + x-fern-sdk-method-name: validate + /api/storages/export/localfiles/{id}: delete: - operationId: api_storages_export_localfiles_destroy description: Delete a specific local file export storage connection. - summary: Delete export storage + operationId: api_storages_export_localfiles_destroy parameters: - - in: path - name: id - schema: - type: integer - required: true - tags: - - 'Storage: Local' - security: - - Token: [] + - in: path + name: id + required: true + schema: + type: integer responses: '204': description: No response body + security: + - Token: [] + summary: Delete export storage + tags: + - 'Storage: Local' + x-fern-audiences: + - public x-fern-sdk-group-name: - - export_storage - - local + - export_storage + - local x-fern-sdk-method-name: delete - x-fern-audiences: - - public - /api/storages/export/localfiles/{id}/sync: - post: - operationId: api_storages_export_localfiles_sync_create - description: Sync tasks from a local file export storage connection. - summary: Sync export storage + get: + description: Get a specific local file export storage connection. + operationId: api_storages_export_localfiles_retrieve parameters: - - in: path - name: id - schema: - type: integer - required: true - tags: - - 'Storage: Local' - security: - - Token: [] + - in: path + name: id + required: true + schema: + type: integer responses: '200': content: @@ -11197,144 +10859,174 @@ paths: schema: $ref: '#/components/schemas/LocalFilesExportStorage' description: '' - x-fern-sdk-group-name: - - export_storage - - local - x-fern-sdk-method-name: sync - x-fern-audiences: - - public - /api/storages/export/localfiles/validate: - post: - operationId: api_storages_export_localfiles_validate_create - description: Validate a specific local file export storage connection. - summary: Validate export storage + security: + - Token: [] + summary: Get export storage tags: - - 'Storage: Local' + - 'Storage: Local' + x-fern-audiences: + - public + x-fern-sdk-group-name: + - export_storage + - local + x-fern-sdk-method-name: get + patch: + description: Update a specific local file export storage connection. + operationId: api_storages_export_localfiles_partial_update + parameters: + - in: path + name: id + required: true + schema: + type: integer requestBody: content: application/json: schema: - type: object properties: - id: - type: integer - description: Storage ID. If set, storage with specified ID will - be updated - title: - type: string - description: Storage title - maxLength: 2048 description: - type: string description: Storage description - project: - type: integer - description: Project ID - path: type: string + path: description: Path to local directory - regex_filter: type: string + project: + description: Project ID + type: integer + regex_filter: description: Regex for filtering objects + type: string + title: + description: Storage title + maxLength: 2048 + type: string use_blob_urls: - type: boolean - description: Interpret objects as BLOBs and generate URLs. For example, - if your directory contains images, you can use this option to - generate URLs for these images. If set to False, it will read - the content of the file and load it into Label Studio. default: false + description: Interpret objects as BLOBs and generate URLs. For example, if your directory contains images, you can use this option to generate URLs for these images. If set to False, it will read the content of the file and load it into Label Studio. + type: boolean required: [] - security: - - Token: [] + type: object responses: '200': - description: Validation successful + content: + application/json: + schema: + $ref: '#/components/schemas/LocalFilesExportStorage' + description: '' + security: + - Token: [] + summary: Update export storage + tags: + - 'Storage: Local' + x-fern-audiences: + - public x-fern-sdk-group-name: - - export_storage - - local - x-fern-sdk-method-name: validate + - export_storage + - local + x-fern-sdk-method-name: update + /api/storages/export/localfiles/{id}/sync: + post: + description: Sync tasks from a local file export storage connection. + operationId: api_storages_export_localfiles_sync_create + parameters: + - in: path + name: id + required: true + schema: + type: integer + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/LocalFilesExportStorage' + description: '' + security: + - Token: [] + summary: Sync export storage + tags: + - 'Storage: Local' x-fern-audiences: - - public + - public + x-fern-sdk-group-name: + - export_storage + - local + x-fern-sdk-method-name: sync /api/storages/export/redis: get: - operationId: api_storages_export_redis_list description: Get a list of all Redis export storage connections. - summary: Get all export storage + operationId: api_storages_export_redis_list parameters: - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - - in: query - name: project - schema: - type: integer - description: Project ID - tags: - - 'Storage: Redis' - security: - - Token: [] + - description: Which field to use when ordering the results. + in: query + name: ordering + required: false + schema: + type: string + - description: Project ID + in: query + name: project + schema: + type: integer responses: '200': content: application/json: schema: - type: array items: $ref: '#/components/schemas/RedisExportStorage' + type: array description: '' + security: + - Token: [] + summary: Get all export storage + tags: + - 'Storage: Redis' + x-fern-audiences: + - public x-fern-sdk-group-name: - - export_storage - - redis + - export_storage + - redis x-fern-sdk-method-name: list - x-fern-audiences: - - public post: - operationId: api_storages_export_redis_create description: Create a new Redis export storage connection to store annotations. - summary: Create export storage - tags: - - 'Storage: Redis' + operationId: api_storages_export_redis_create requestBody: content: application/json: schema: - type: object properties: - db: - type: integer - description: Database ID of database to use can_delete_objects: - type: boolean - description: Deletion from storage enabled. default: false - title: - type: string - description: Storage title - maxLength: 2048 + description: Deletion from storage enabled. + type: boolean + db: + description: Database ID of database to use + type: integer description: - type: string description: Storage description - project: - type: integer - description: Project ID - path: type: string - description: Storage prefix (optional) host: - type: string description: Server Host IP (optional) - port: type: string - description: Server Port (optional) password: - type: string description: Server Password (optional) + type: string + path: + description: Storage prefix (optional) + type: string + port: + description: Server Port (optional) + type: string + project: + description: Project ID + type: integer + title: + description: Storage title + maxLength: 2048 + type: string required: [] - security: - - Token: [] + type: object responses: '201': content: @@ -11342,141 +11034,107 @@ paths: schema: $ref: '#/components/schemas/RedisExportStorage' description: '' - x-fern-sdk-group-name: - - export_storage - - redis - x-fern-sdk-method-name: create - x-fern-audiences: - - public - /api/storages/export/redis/{id}: - get: - operationId: api_storages_export_redis_retrieve - description: Get a specific Redis export storage connection. - summary: Get export storage - parameters: - - in: path - name: id - schema: - type: integer - required: true - tags: - - 'Storage: Redis' security: - - Token: [] - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/RedisExportStorage' - description: '' - x-fern-sdk-group-name: - - export_storage - - redis - x-fern-sdk-method-name: get - x-fern-audiences: - - public - patch: - operationId: api_storages_export_redis_partial_update - description: Update a specific Redis export storage connection. - summary: Update export storage - parameters: - - in: path - name: id - schema: - type: integer - required: true + - Token: [] + summary: Create export storage tags: - - 'Storage: Redis' + - 'Storage: Redis' + x-fern-audiences: + - public + x-fern-sdk-group-name: + - export_storage + - redis + x-fern-sdk-method-name: create + /api/storages/export/redis/validate: + post: + description: Validate a specific Redis export storage connection. + operationId: api_storages_export_redis_validate_create requestBody: content: application/json: schema: - type: object properties: - db: - type: integer - description: Database ID of database to use can_delete_objects: - type: boolean - description: Deletion from storage enabled. default: false - title: - type: string - description: Storage title - maxLength: 2048 + description: Deletion from storage enabled. + type: boolean + db: + description: Database ID of database to use + type: integer description: - type: string description: Storage description - project: + type: string + host: + description: Server Host IP (optional) + type: string + id: + description: Storage ID. If set, storage with specified ID will be updated type: integer - description: Project ID - path: + password: + description: Server Password (optional) type: string + path: description: Storage prefix (optional) - host: type: string - description: Server Host IP (optional) port: - type: string description: Server Port (optional) - password: type: string - description: Server Password (optional) + project: + description: Project ID + type: integer + title: + description: Storage title + maxLength: 2048 + type: string required: [] - security: - - Token: [] + type: object responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/RedisExportStorage' - description: '' - x-fern-sdk-group-name: - - export_storage - - redis - x-fern-sdk-method-name: update + description: Validation successful + security: + - Token: [] + summary: Validate export storage + tags: + - 'Storage: Redis' x-fern-audiences: - - public + - public + x-fern-sdk-group-name: + - export_storage + - redis + x-fern-sdk-method-name: validate + /api/storages/export/redis/{id}: delete: - operationId: api_storages_export_redis_destroy description: Delete a specific Redis export storage connection. - summary: Delete export storage + operationId: api_storages_export_redis_destroy parameters: - - in: path - name: id - schema: - type: integer - required: true - tags: - - 'Storage: Redis' - security: - - Token: [] + - in: path + name: id + required: true + schema: + type: integer responses: '204': description: No response body + security: + - Token: [] + summary: Delete export storage + tags: + - 'Storage: Redis' + x-fern-audiences: + - public x-fern-sdk-group-name: - - export_storage - - redis + - export_storage + - redis x-fern-sdk-method-name: delete - x-fern-audiences: - - public - /api/storages/export/redis/{id}/sync: - post: - operationId: api_storages_export_redis_sync_create - description: Sync tasks from a Redis export storage connection. - summary: Sync export storage + get: + description: Get a specific Redis export storage connection. + operationId: api_storages_export_redis_retrieve parameters: - - in: path - name: id - schema: - type: integer - required: true - tags: - - 'Storage: Redis' - security: - - Token: [] + - in: path + name: id + required: true + schema: + type: integer responses: '200': content: @@ -11484,159 +11142,192 @@ paths: schema: $ref: '#/components/schemas/RedisExportStorage' description: '' - x-fern-sdk-group-name: - - export_storage - - redis - x-fern-sdk-method-name: sync - x-fern-audiences: - - public - /api/storages/export/redis/validate: - post: - operationId: api_storages_export_redis_validate_create - description: Validate a specific Redis export storage connection. - summary: Validate export storage + security: + - Token: [] + summary: Get export storage tags: - - 'Storage: Redis' + - 'Storage: Redis' + x-fern-audiences: + - public + x-fern-sdk-group-name: + - export_storage + - redis + x-fern-sdk-method-name: get + patch: + description: Update a specific Redis export storage connection. + operationId: api_storages_export_redis_partial_update + parameters: + - in: path + name: id + required: true + schema: + type: integer requestBody: content: application/json: schema: - type: object properties: - id: - type: integer - description: Storage ID. If set, storage with specified ID will - be updated - db: - type: integer - description: Database ID of database to use can_delete_objects: - type: boolean - description: Deletion from storage enabled. default: false - title: - type: string - description: Storage title - maxLength: 2048 + description: Deletion from storage enabled. + type: boolean + db: + description: Database ID of database to use + type: integer description: - type: string description: Storage description - project: - type: integer - description: Project ID - path: type: string - description: Storage prefix (optional) host: - type: string description: Server Host IP (optional) - port: type: string - description: Server Port (optional) password: - type: string description: Server Password (optional) + type: string + path: + description: Storage prefix (optional) + type: string + port: + description: Server Port (optional) + type: string + project: + description: Project ID + type: integer + title: + description: Storage title + maxLength: 2048 + type: string required: [] - security: - - Token: [] + type: object responses: '200': - description: Validation successful + content: + application/json: + schema: + $ref: '#/components/schemas/RedisExportStorage' + description: '' + security: + - Token: [] + summary: Update export storage + tags: + - 'Storage: Redis' + x-fern-audiences: + - public x-fern-sdk-group-name: - - export_storage - - redis - x-fern-sdk-method-name: validate + - export_storage + - redis + x-fern-sdk-method-name: update + /api/storages/export/redis/{id}/sync: + post: + description: Sync tasks from a Redis export storage connection. + operationId: api_storages_export_redis_sync_create + parameters: + - in: path + name: id + required: true + schema: + type: integer + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/RedisExportStorage' + description: '' + security: + - Token: [] + summary: Sync export storage + tags: + - 'Storage: Redis' x-fern-audiences: - - public + - public + x-fern-sdk-group-name: + - export_storage + - redis + x-fern-sdk-method-name: sync /api/storages/export/s3: get: - operationId: api_storages_export_s3_list description: Get a list of all S3 export storage connections. - summary: Get all export storage + operationId: api_storages_export_s3_list parameters: - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - - in: query - name: project - schema: - type: integer - description: Project ID - tags: - - 'Storage: S3' - security: - - Token: [] + - description: Which field to use when ordering the results. + in: query + name: ordering + required: false + schema: + type: string + - description: Project ID + in: query + name: project + schema: + type: integer responses: '200': content: application/json: schema: - type: array items: $ref: '#/components/schemas/S3ExportStorage' + type: array description: '' + security: + - Token: [] + summary: Get all export storage + tags: + - 'Storage: S3' + x-fern-audiences: + - public x-fern-sdk-group-name: - - export_storage - - s3 + - export_storage + - s3 x-fern-sdk-method-name: list - x-fern-audiences: - - public post: - operationId: api_storages_export_s3_create description: Create a new S3 export storage connection to store annotations. - summary: Create export storage - tags: - - 'Storage: S3' + operationId: api_storages_export_s3_create requestBody: content: application/json: schema: - type: object properties: - can_delete_objects: - type: boolean - description: Deletion from storage enabled. - default: false - title: - type: string - description: Storage title - maxLength: 2048 - description: - type: string - description: Storage description - project: - type: integer - description: Project ID - bucket: - type: string - description: S3 bucket name - prefix: - type: string - description: S3 bucket prefix aws_access_key_id: - type: string description: AWS_ACCESS_KEY_ID - aws_secret_access_key: type: string + aws_secret_access_key: description: AWS_SECRET_ACCESS_KEY - aws_session_token: type: string + aws_session_token: description: AWS_SESSION_TOKEN - aws_sse_kms_key_id: type: string + aws_sse_kms_key_id: description: AWS SSE KMS Key ID - region_name: type: string + bucket: + description: S3 bucket name + type: string + can_delete_objects: + default: false + description: Deletion from storage enabled. + type: boolean + description: + description: Storage description + type: string + prefix: + description: S3 bucket prefix + type: string + project: + description: Project ID + type: integer + region_name: description: AWS Region - s3_endpoint: type: string + s3_endpoint: description: S3 Endpoint + type: string + title: + description: Storage title + maxLength: 2048 + type: string required: [] - security: - - Token: [] + type: object responses: '201': content: @@ -11644,27 +11335,116 @@ paths: schema: $ref: '#/components/schemas/S3ExportStorage' description: '' + security: + - Token: [] + summary: Create export storage + tags: + - 'Storage: S3' + x-fern-audiences: + - public x-fern-sdk-group-name: - - export_storage - - s3 + - export_storage + - s3 x-fern-sdk-method-name: create + /api/storages/export/s3/validate: + post: + description: Validate a specific S3 export storage connection. + operationId: api_storages_export_s3_validate_create + requestBody: + content: + application/json: + schema: + properties: + aws_access_key_id: + description: AWS_ACCESS_KEY_ID + type: string + aws_secret_access_key: + description: AWS_SECRET_ACCESS_KEY + type: string + aws_session_token: + description: AWS_SESSION_TOKEN + type: string + aws_sse_kms_key_id: + description: AWS SSE KMS Key ID + type: string + bucket: + description: S3 bucket name + type: string + can_delete_objects: + default: false + description: Deletion from storage enabled. + type: boolean + description: + description: Storage description + type: string + id: + description: Storage ID. If set, storage with specified ID will be updated + type: integer + prefix: + description: S3 bucket prefix + type: string + project: + description: Project ID + type: integer + region_name: + description: AWS Region + type: string + s3_endpoint: + description: S3 Endpoint + type: string + title: + description: Storage title + maxLength: 2048 + type: string + required: [] + type: object + responses: + '200': + description: Validation successful + security: + - Token: [] + summary: Validate export storage + tags: + - 'Storage: S3' x-fern-audiences: - - public + - public + x-fern-sdk-group-name: + - export_storage + - s3 + x-fern-sdk-method-name: validate /api/storages/export/s3/{id}: + delete: + description: Delete a specific S3 export storage connection. + operationId: api_storages_export_s3_destroy + parameters: + - in: path + name: id + required: true + schema: + type: integer + responses: + '204': + description: No response body + security: + - Token: [] + summary: Delete export storage + tags: + - 'Storage: S3' + x-fern-audiences: + - public + x-fern-sdk-group-name: + - export_storage + - s3 + x-fern-sdk-method-name: delete get: - operationId: api_storages_export_s3_retrieve description: Get a specific S3 export storage connection. - summary: Get export storage + operationId: api_storages_export_s3_retrieve parameters: - - in: path - name: id - schema: - type: integer - required: true - tags: - - 'Storage: S3' - security: - - Token: [] + - in: path + name: id + required: true + schema: + type: integer responses: '200': content: @@ -11672,71 +11452,71 @@ paths: schema: $ref: '#/components/schemas/S3ExportStorage' description: '' + security: + - Token: [] + summary: Get export storage + tags: + - 'Storage: S3' + x-fern-audiences: + - public x-fern-sdk-group-name: - - export_storage - - s3 + - export_storage + - s3 x-fern-sdk-method-name: get - x-fern-audiences: - - public patch: - operationId: api_storages_export_s3_partial_update description: Update a specific S3 export storage connection. - summary: Update export storage + operationId: api_storages_export_s3_partial_update parameters: - - in: path - name: id - schema: - type: integer - required: true - tags: - - 'Storage: S3' + - in: path + name: id + required: true + schema: + type: integer requestBody: content: application/json: schema: - type: object properties: - can_delete_objects: - type: boolean - description: Deletion from storage enabled. - default: false - title: - type: string - description: Storage title - maxLength: 2048 - description: - type: string - description: Storage description - project: - type: integer - description: Project ID - bucket: - type: string - description: S3 bucket name - prefix: - type: string - description: S3 bucket prefix aws_access_key_id: - type: string description: AWS_ACCESS_KEY_ID - aws_secret_access_key: type: string + aws_secret_access_key: description: AWS_SECRET_ACCESS_KEY - aws_session_token: type: string + aws_session_token: description: AWS_SESSION_TOKEN - aws_sse_kms_key_id: type: string + aws_sse_kms_key_id: description: AWS SSE KMS Key ID - region_name: type: string + bucket: + description: S3 bucket name + type: string + can_delete_objects: + default: false + description: Deletion from storage enabled. + type: boolean + description: + description: Storage description + type: string + prefix: + description: S3 bucket prefix + type: string + project: + description: Project ID + type: integer + region_name: description: AWS Region - s3_endpoint: type: string + s3_endpoint: description: S3 Endpoint + type: string + title: + description: Storage title + maxLength: 2048 + type: string required: [] - security: - - Token: [] + type: object responses: '200': content: @@ -11744,50 +11524,27 @@ paths: schema: $ref: '#/components/schemas/S3ExportStorage' description: '' - x-fern-sdk-group-name: - - export_storage - - s3 - x-fern-sdk-method-name: update - x-fern-audiences: - - public - delete: - operationId: api_storages_export_s3_destroy - description: Delete a specific S3 export storage connection. - summary: Delete export storage - parameters: - - in: path - name: id - schema: - type: integer - required: true - tags: - - 'Storage: S3' security: - - Token: [] - responses: - '204': - description: No response body - x-fern-sdk-group-name: - - export_storage - - s3 - x-fern-sdk-method-name: delete + - Token: [] + summary: Update export storage + tags: + - 'Storage: S3' x-fern-audiences: - - public + - public + x-fern-sdk-group-name: + - export_storage + - s3 + x-fern-sdk-method-name: update /api/storages/export/s3/{id}/sync: post: - operationId: api_storages_export_s3_sync_create description: Sync tasks from an S3 export storage connection. - summary: Sync export storage + operationId: api_storages_export_s3_sync_create parameters: - - in: path - name: id - schema: - type: integer - required: true - tags: - - 'Storage: S3' - security: - - Token: [] + - in: path + name: id + required: true + schema: + type: integer responses: '200': content: @@ -11795,122 +11552,89 @@ paths: schema: $ref: '#/components/schemas/S3ExportStorage' description: '' + security: + - Token: [] + summary: Sync export storage + tags: + - 'Storage: S3' + x-fern-audiences: + - public x-fern-sdk-group-name: - - export_storage - - s3 + - export_storage + - s3 x-fern-sdk-method-name: sync + /api/storages/export/s3s: + get: + description: Get a list of all S3 export storage connections that were set up with IAM role access. + operationId: api_storages_export_s3s_list + parameters: + - description: Which field to use when ordering the results. + in: query + name: ordering + schema: + type: string + - description: Project ID + in: query + name: project + schema: + type: integer + responses: + '200': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/LseS3ExportStorage' + type: array + description: '' + security: + - Token: [] + summary: List S3s export storage + tags: + - 'Storage: S3 Roles' x-fern-audiences: - - public - /api/storages/export/s3/validate: + - public + x-fern-sdk-group-name: + - export_storage + - s3s + x-fern-sdk-method-name: list post: - operationId: api_storages_export_s3_validate_create - description: Validate a specific S3 export storage connection. - summary: Validate export storage - tags: - - 'Storage: S3' + description: Create an S3 export storage connection with IAM role access to store annotations. + operationId: api_storages_export_s3s_create requestBody: content: application/json: schema: - type: object - properties: - id: - type: integer - description: Storage ID. If set, storage with specified ID will - be updated - can_delete_objects: - type: boolean - description: Deletion from storage enabled. - default: false - title: - type: string - description: Storage title - maxLength: 2048 - description: - type: string - description: Storage description - project: - type: integer - description: Project ID - bucket: - type: string - description: S3 bucket name - prefix: - type: string - description: S3 bucket prefix - aws_access_key_id: - type: string - description: AWS_ACCESS_KEY_ID - aws_secret_access_key: - type: string - description: AWS_SECRET_ACCESS_KEY - aws_session_token: - type: string - description: AWS_SESSION_TOKEN - aws_sse_kms_key_id: - type: string - description: AWS SSE KMS Key ID - region_name: - type: string - description: AWS Region - s3_endpoint: - type: string - description: S3 Endpoint - required: [] - security: - - Token: [] - responses: - '200': - description: Validation successful - x-fern-sdk-group-name: - - export_storage - - s3 - x-fern-sdk-method-name: validate - x-fern-audiences: - - public - /api/storages/export/s3s: - get: - operationId: api_storages_export_s3s_list - description: Get a list of all S3 export storage connections that were set up - with IAM role access. - summary: List S3s export storage - parameters: - - in: query - name: ordering - schema: - type: string - description: Which field to use when ordering the results. - - in: query - name: project - schema: - type: integer - description: Project ID - tags: - - 'Storage: S3 Roles' - security: - - Token: [] + $ref: '#/components/schemas/LseS3ExportStorageRequest' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/LseS3ExportStorageRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/LseS3ExportStorageRequest' + required: true responses: - '200': + '201': content: application/json: schema: - type: array - items: - $ref: '#/components/schemas/LseS3ExportStorage' + $ref: '#/components/schemas/LseS3ExportStorage' description: '' - x-fern-sdk-group-name: - - export_storage - - s3s - x-fern-sdk-method-name: list - x-fern-audiences: - - public - post: - operationId: api_storages_export_s3s_create - description: Create an S3 export storage connection with IAM role access to - store annotations. + security: + - Token: [] summary: Create export storage tags: - - 'Storage: S3 Roles' + - 'Storage: S3 Roles' + x-fern-audiences: + - public + x-fern-sdk-group-name: + - export_storage + - s3s + x-fern-sdk-method-name: create + /api/storages/export/s3s/validate: + post: + description: Validate a specific S3 export storage connection that was set up with IAM role access. + operationId: api_storages_export_s3s_validate_create requestBody: content: application/json: @@ -11923,37 +11647,53 @@ paths: schema: $ref: '#/components/schemas/LseS3ExportStorageRequest' required: true - security: - - Token: [] responses: - '201': - content: - application/json: - schema: - $ref: '#/components/schemas/LseS3ExportStorage' - description: '' - x-fern-sdk-group-name: - - export_storage - - s3s - x-fern-sdk-method-name: create + '200': + description: Validation successful + security: + - Token: [] + summary: Validate export storage + tags: + - 'Storage: S3 Roles' x-fern-audiences: - - public + - public + x-fern-sdk-group-name: + - export_storage + - s3s + x-fern-sdk-method-name: validate /api/storages/export/s3s/{id}: + delete: + description: Delete a specific S3 export storage connection that was set up with IAM role access. + operationId: api_storages_export_s3s_destroy + parameters: + - in: path + name: id + required: true + schema: + type: integer + responses: + '204': + description: No response body + security: + - Token: [] + summary: Delete export storage + tags: + - 'Storage: S3 Roles' + x-fern-audiences: + - public + x-fern-sdk-group-name: + - export_storage + - s3s + x-fern-sdk-method-name: delete get: + description: Get a specific S3 export storage connection that was set up with IAM role access. operationId: api_storages_export_s3s_retrieve - description: Get a specific S3 export storage connection that was set up with - IAM role access. - summary: Get export storage parameters: - - in: path - name: id - schema: - type: integer - required: true - tags: - - 'Storage: S3 Roles' - security: - - Token: [] + - in: path + name: id + required: true + schema: + type: integer responses: '200': content: @@ -11961,25 +11701,26 @@ paths: schema: $ref: '#/components/schemas/LseS3ExportStorage' description: '' + security: + - Token: [] + summary: Get export storage + tags: + - 'Storage: S3 Roles' + x-fern-audiences: + - public x-fern-sdk-group-name: - - export_storage - - s3s + - export_storage + - s3s x-fern-sdk-method-name: get - x-fern-audiences: - - public patch: + description: Update a specific S3 export storage connection that was set up with IAM role access. operationId: api_storages_export_s3s_partial_update - description: Update a specific S3 export storage connection that was set up - with IAM role access. - summary: Update export storage parameters: - - in: path - name: id - schema: - type: integer - required: true - tags: - - 'Storage: S3 Roles' + - in: path + name: id + required: true + schema: + type: integer requestBody: content: application/json: @@ -11991,8 +11732,6 @@ paths: multipart/form-data: schema: $ref: '#/components/schemas/PatchedLseS3ExportStorageRequest' - security: - - Token: [] responses: '200': content: @@ -12000,51 +11739,27 @@ paths: schema: $ref: '#/components/schemas/LseS3ExportStorage' description: '' - x-fern-sdk-group-name: - - export_storage - - s3s - x-fern-sdk-method-name: update - x-fern-audiences: - - public - delete: - operationId: api_storages_export_s3s_destroy - description: Delete a specific S3 export storage connection that was set up - with IAM role access. - summary: Delete export storage - parameters: - - in: path - name: id - schema: - type: integer - required: true - tags: - - 'Storage: S3 Roles' security: - - Token: [] - responses: - '204': - description: No response body - x-fern-sdk-group-name: - - export_storage - - s3s - x-fern-sdk-method-name: delete + - Token: [] + summary: Update export storage + tags: + - 'Storage: S3 Roles' x-fern-audiences: - - public + - public + x-fern-sdk-group-name: + - export_storage + - s3s + x-fern-sdk-method-name: update /api/storages/export/s3s/{id}/sync: post: - operationId: api_storages_export_s3s_sync_create description: Sync tasks from an S3 export storage. - summary: Sync export storage + operationId: api_storages_export_s3s_sync_create parameters: - - in: path - name: id - schema: - type: integer - required: true - tags: - - 'Storage: S3 Roles' - security: - - Token: [] + - in: path + name: id + required: true + schema: + type: integer responses: '200': content: @@ -12052,165 +11767,128 @@ paths: schema: $ref: '#/components/schemas/LseS3ExportStorage' description: '' - x-fern-sdk-group-name: - - export_storage - - s3s - x-fern-sdk-method-name: sync - x-fern-audiences: - - public - /api/storages/export/s3s/validate: - post: - operationId: api_storages_export_s3s_validate_create - description: Validate a specific S3 export storage connection that was set up - with IAM role access. - summary: Validate export storage - tags: - - 'Storage: S3 Roles' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/LseS3ExportStorageRequest' - application/x-www-form-urlencoded: - schema: - $ref: '#/components/schemas/LseS3ExportStorageRequest' - multipart/form-data: - schema: - $ref: '#/components/schemas/LseS3ExportStorageRequest' - required: true security: - - Token: [] - responses: - '200': - description: Validation successful - x-fern-sdk-group-name: - - export_storage - - s3s - x-fern-sdk-method-name: validate + - Token: [] + summary: Sync export storage + tags: + - 'Storage: S3 Roles' x-fern-audiences: - - public + - public + x-fern-sdk-group-name: + - export_storage + - s3s + x-fern-sdk-method-name: sync /api/storages/export/types: get: - operationId: api_storages_export_types_retrieve description: Retrieve a list of the export storages types. - summary: List all export storages types - tags: - - Storage - security: - - Token: [] + operationId: api_storages_export_types_retrieve responses: '200': content: application/json: schema: - type: array items: - type: object properties: name: type: string title: type: string + type: object + type: array description: List of export storage types + security: + - Token: [] + summary: List all export storages types + tags: + - Storage + x-fern-audiences: + - public x-fern-sdk-group-name: - - export_storage + - export_storage x-fern-sdk-method-name: list_types - x-fern-audiences: - - public /api/storages/gcs/: get: - operationId: api_storages_gcs_list description: Get a list of all GCS import storage connections. - summary: Get all import storage + operationId: api_storages_gcs_list parameters: - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - - in: query - name: project - schema: - type: integer - description: Project ID - tags: - - 'Storage: GCS' - security: - - Token: [] + - description: Which field to use when ordering the results. + in: query + name: ordering + required: false + schema: + type: string + - description: Project ID + in: query + name: project + schema: + type: integer responses: '200': content: application/json: schema: - type: array items: $ref: '#/components/schemas/GCSImportStorage' + type: array description: '' + security: + - Token: [] + summary: Get all import storage + tags: + - 'Storage: GCS' + x-fern-audiences: + - public x-fern-sdk-group-name: - - import_storage - - gcs + - import_storage + - gcs x-fern-sdk-method-name: list - x-fern-audiences: - - public post: - operationId: api_storages_gcs_create description: Create a new GCS import storage connection. - summary: Create import storage - tags: - - 'Storage: GCS' + operationId: api_storages_gcs_create requestBody: content: application/json: schema: - type: object properties: - regex_filter: + bucket: + description: GCS bucket name + type: string + description: + description: Storage description + type: string + google_application_credentials: + description: The content of GOOGLE_APPLICATION_CREDENTIALS json file. Check official Google Cloud Authentication documentation for more details. + type: string + google_project_id: + description: Google project ID + type: string + prefix: + description: GCS bucket prefix type: string - description: Cloud storage regex for filtering objects. You must - specify it otherwise no objects will be imported. - use_blob_urls: - type: boolean - description: Interpret objects as BLOBs and generate URLs. For example, - if your bucket contains images, you can use this option to generate - URLs for these images. If set to False, it will read the content - of the file and load it into Label Studio. - default: false presign: - type: boolean - description: Presign URLs for direct download default: true + description: Presign URLs for direct download + type: boolean presign_ttl: - type: integer - description: Presign TTL in minutes default: 1 - title: - type: string - description: Storage title - maxLength: 2048 - description: - type: string - description: Storage description - project: + description: Presign TTL in minutes type: integer + project: description: Project ID - bucket: - type: string - description: GCS bucket name - prefix: - type: string - description: GCS bucket prefix - google_application_credentials: + type: integer + regex_filter: + description: Cloud storage regex for filtering objects. You must specify it otherwise no objects will be imported. type: string - description: The content of GOOGLE_APPLICATION_CREDENTIALS json - file. Check official Google Cloud Authentication documentation - for more details. - google_project_id: + title: + description: Storage title + maxLength: 2048 type: string - description: Google project ID + use_blob_urls: + default: false + description: Interpret objects as BLOBs and generate URLs. For example, if your bucket contains images, you can use this option to generate URLs for these images. If set to False, it will read the content of the file and load it into Label Studio. + type: boolean required: [] - security: - - Token: [] + type: object responses: '201': content: @@ -12218,156 +11896,115 @@ paths: schema: $ref: '#/components/schemas/GCSImportStorage' description: '' - x-fern-sdk-group-name: - - import_storage - - gcs - x-fern-sdk-method-name: create - x-fern-audiences: - - public - /api/storages/gcs/{id}: - get: - operationId: api_storages_gcs_retrieve - description: Get a specific GCS import storage connection. - summary: Get import storage - parameters: - - in: path - name: id - schema: - type: integer - required: true - tags: - - 'Storage: GCS' security: - - Token: [] - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/GCSImportStorage' - description: '' - x-fern-sdk-group-name: - - import_storage - - gcs - x-fern-sdk-method-name: get - x-fern-audiences: - - public - patch: - operationId: api_storages_gcs_partial_update - description: Update a specific GCS import storage connection. - summary: Update import storage - parameters: - - in: path - name: id - schema: - type: integer - required: true + - Token: [] + summary: Create import storage tags: - - 'Storage: GCS' + - 'Storage: GCS' + x-fern-audiences: + - public + x-fern-sdk-group-name: + - import_storage + - gcs + x-fern-sdk-method-name: create + /api/storages/gcs/validate: + post: + description: Validate a specific GCS import storage connection. + operationId: api_storages_gcs_validate_create requestBody: content: application/json: schema: - type: object properties: - regex_filter: + bucket: + description: GCS bucket name + type: string + description: + description: Storage description + type: string + google_application_credentials: + description: The content of GOOGLE_APPLICATION_CREDENTIALS json file. Check official Google Cloud Authentication documentation for more details. + type: string + google_project_id: + description: Google project ID + type: string + id: + description: Storage ID. If set, storage with specified ID will be updated + type: integer + prefix: + description: GCS bucket prefix type: string - description: Cloud storage regex for filtering objects. You must - specify it otherwise no objects will be imported. - use_blob_urls: - type: boolean - description: Interpret objects as BLOBs and generate URLs. For example, - if your bucket contains images, you can use this option to generate - URLs for these images. If set to False, it will read the content - of the file and load it into Label Studio. - default: false presign: - type: boolean - description: Presign URLs for direct download default: true + description: Presign URLs for direct download + type: boolean presign_ttl: - type: integer - description: Presign TTL in minutes default: 1 - title: - type: string - description: Storage title - maxLength: 2048 - description: - type: string - description: Storage description - project: + description: Presign TTL in minutes type: integer + project: description: Project ID - bucket: - type: string - description: GCS bucket name - prefix: - type: string - description: GCS bucket prefix - google_application_credentials: + type: integer + regex_filter: + description: Cloud storage regex for filtering objects. You must specify it otherwise no objects will be imported. type: string - description: The content of GOOGLE_APPLICATION_CREDENTIALS json - file. Check official Google Cloud Authentication documentation - for more details. - google_project_id: + title: + description: Storage title + maxLength: 2048 type: string - description: Google project ID + use_blob_urls: + default: false + description: Interpret objects as BLOBs and generate URLs. For example, if your bucket contains images, you can use this option to generate URLs for these images. If set to False, it will read the content of the file and load it into Label Studio. + type: boolean required: [] - security: - - Token: [] + type: object responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/GCSImportStorage' - description: '' - x-fern-sdk-group-name: - - import_storage - - gcs - x-fern-sdk-method-name: update + description: Validation successful + security: + - Token: [] + summary: Validate import storage + tags: + - 'Storage: GCS' x-fern-audiences: - - public + - public + x-fern-sdk-group-name: + - import_storage + - gcs + x-fern-sdk-method-name: validate + /api/storages/gcs/{id}: delete: - operationId: api_storages_gcs_destroy description: Delete a specific GCS import storage connection. - summary: Delete import storage + operationId: api_storages_gcs_destroy parameters: - - in: path - name: id - schema: - type: integer - required: true - tags: - - 'Storage: GCS' - security: - - Token: [] + - in: path + name: id + required: true + schema: + type: integer responses: '204': description: No response body + security: + - Token: [] + summary: Delete import storage + tags: + - 'Storage: GCS' + x-fern-audiences: + - public x-fern-sdk-group-name: - - import_storage - - gcs + - import_storage + - gcs x-fern-sdk-method-name: delete - x-fern-audiences: - - public - /api/storages/gcs/{id}/sync: - post: - operationId: api_storages_gcs_sync_create - description: Sync tasks from a GCS import storage connection. - summary: Sync import storage + get: + description: Get a specific GCS import storage connection. + operationId: api_storages_gcs_retrieve parameters: - - in: path - name: id - schema: - type: integer - description: Storage ID - required: true - tags: - - 'Storage: GCS' - security: - - Token: [] + - in: path + name: id + required: true + schema: + type: integer responses: '200': content: @@ -12375,116 +12012,145 @@ paths: schema: $ref: '#/components/schemas/GCSImportStorage' description: '' - x-fern-sdk-group-name: - - import_storage - - gcs - x-fern-sdk-method-name: sync - x-fern-audiences: - - public - /api/storages/gcs/validate: - post: - operationId: api_storages_gcs_validate_create - description: Validate a specific GCS import storage connection. - summary: Validate import storage + security: + - Token: [] + summary: Get import storage tags: - - 'Storage: GCS' + - 'Storage: GCS' + x-fern-audiences: + - public + x-fern-sdk-group-name: + - import_storage + - gcs + x-fern-sdk-method-name: get + patch: + description: Update a specific GCS import storage connection. + operationId: api_storages_gcs_partial_update + parameters: + - in: path + name: id + required: true + schema: + type: integer requestBody: content: application/json: schema: - type: object properties: - id: - type: integer - description: Storage ID. If set, storage with specified ID will - be updated - regex_filter: + bucket: + description: GCS bucket name + type: string + description: + description: Storage description + type: string + google_application_credentials: + description: The content of GOOGLE_APPLICATION_CREDENTIALS json file. Check official Google Cloud Authentication documentation for more details. + type: string + google_project_id: + description: Google project ID + type: string + prefix: + description: GCS bucket prefix type: string - description: Cloud storage regex for filtering objects. You must - specify it otherwise no objects will be imported. - use_blob_urls: - type: boolean - description: Interpret objects as BLOBs and generate URLs. For example, - if your bucket contains images, you can use this option to generate - URLs for these images. If set to False, it will read the content - of the file and load it into Label Studio. - default: false presign: - type: boolean - description: Presign URLs for direct download default: true + description: Presign URLs for direct download + type: boolean presign_ttl: - type: integer - description: Presign TTL in minutes default: 1 - title: - type: string - description: Storage title - maxLength: 2048 - description: - type: string - description: Storage description - project: + description: Presign TTL in minutes type: integer + project: description: Project ID - bucket: - type: string - description: GCS bucket name - prefix: - type: string - description: GCS bucket prefix - google_application_credentials: + type: integer + regex_filter: + description: Cloud storage regex for filtering objects. You must specify it otherwise no objects will be imported. type: string - description: The content of GOOGLE_APPLICATION_CREDENTIALS json - file. Check official Google Cloud Authentication documentation - for more details. - google_project_id: + title: + description: Storage title + maxLength: 2048 type: string - description: Google project ID + use_blob_urls: + default: false + description: Interpret objects as BLOBs and generate URLs. For example, if your bucket contains images, you can use this option to generate URLs for these images. If set to False, it will read the content of the file and load it into Label Studio. + type: boolean required: [] - security: - - Token: [] + type: object responses: '200': - description: Validation successful + content: + application/json: + schema: + $ref: '#/components/schemas/GCSImportStorage' + description: '' + security: + - Token: [] + summary: Update import storage + tags: + - 'Storage: GCS' + x-fern-audiences: + - public x-fern-sdk-group-name: - - import_storage - - gcs - x-fern-sdk-method-name: validate + - import_storage + - gcs + x-fern-sdk-method-name: update + /api/storages/gcs/{id}/sync: + post: + description: Sync tasks from a GCS import storage connection. + operationId: api_storages_gcs_sync_create + parameters: + - description: Storage ID + in: path + name: id + required: true + schema: + type: integer + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/GCSImportStorage' + description: '' + security: + - Token: [] + summary: Sync import storage + tags: + - 'Storage: GCS' x-fern-audiences: - - public + - public + x-fern-sdk-group-name: + - import_storage + - gcs + x-fern-sdk-method-name: sync /api/storages/gcswif/: get: + description: Get list of all GCS import storage connections set up with WIF authentication. operationId: api_storages_gcswif_list - description: Get list of all GCS import storage connections set up with WIF - authentication. - summary: Get GCS WIF import storage parameters: - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - tags: - - 'Storage: GCS WIF' - security: - - Token: [] + - description: Which field to use when ordering the results. + in: query + name: ordering + required: false + schema: + type: string responses: '200': content: application/json: schema: - type: array items: $ref: '#/components/schemas/GCSWIFImportStorage' + type: array description: '' + security: + - Token: [] + summary: Get GCS WIF import storage + tags: + - 'Storage: GCS WIF' post: - operationId: api_storages_gcswif_create description: Create GCS import storage with WIF. - summary: Create GCS import storage with WIF - tags: - - 'Storage: GCS WIF' + operationId: api_storages_gcswif_create requestBody: content: application/json: @@ -12497,8 +12163,6 @@ paths: schema: $ref: '#/components/schemas/GCSWIFImportStorageRequest' required: true - security: - - Token: [] responses: '201': content: @@ -12506,108 +12170,98 @@ paths: schema: $ref: '#/components/schemas/GCSWIFImportStorage' description: '' - /api/storages/gcswif/{id}: - get: - operationId: api_storages_gcswif_retrieve - description: Get a specific GCS import storage connection that was set up with - WIF. - summary: Get GCS WIF import storage - parameters: - - in: path - name: id - schema: - type: integer - required: true - tags: - - 'Storage: GCS WIF' security: - - Token: [] - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/GCSWIFImportStorage' - description: '' - patch: - operationId: api_storages_gcswif_partial_update - description: Update a specific GCS import storage connection that was set up - with WIF authentication. - summary: Update GCS WIF import storage - parameters: - - in: path - name: id - schema: - type: integer - required: true + - Token: [] + summary: Create GCS import storage with WIF tags: - - 'Storage: GCS WIF' + - 'Storage: GCS WIF' + /api/storages/gcswif/validate: + post: + description: Validate a specific GCS import storage connection that was set up with WIF authentication. + operationId: api_storages_gcswif_validate_create requestBody: content: application/json: schema: - $ref: '#/components/schemas/PatchedGCSWIFImportStorageRequest' + $ref: '#/components/schemas/GCSWIFImportStorageRequest' application/x-www-form-urlencoded: schema: - $ref: '#/components/schemas/PatchedGCSWIFImportStorageRequest' + $ref: '#/components/schemas/GCSWIFImportStorageRequest' multipart/form-data: schema: - $ref: '#/components/schemas/PatchedGCSWIFImportStorageRequest' - security: - - Token: [] + $ref: '#/components/schemas/GCSWIFImportStorageRequest' + required: true responses: - '200': + '201': content: application/json: schema: $ref: '#/components/schemas/GCSWIFImportStorage' description: '' + security: + - Token: [] + summary: Validate GCS WIF import storage + tags: + - 'Storage: GCS WIF' + /api/storages/gcswif/{id}: delete: + description: Delete a specific GCS import storage connection that was set up with WIF authentication. operationId: api_storages_gcswif_destroy - description: Delete a specific GCS import storage connection that was set up - with WIF authentication. - summary: Delete GCS WIF import storage parameters: - - in: path - name: id - schema: - type: integer - required: true - tags: - - 'Storage: GCS WIF' - security: - - Token: [] + - in: path + name: id + required: true + schema: + type: integer responses: '204': description: No response body - /api/storages/gcswif/{id}/sync: - post: - operationId: api_storages_gcswif_sync_create - description: Sync tasks from an GCS import storage connection that was set up - with WIF authentication. - summary: Sync GCS WIF import storage + security: + - Token: [] + summary: Delete GCS WIF import storage + tags: + - 'Storage: GCS WIF' + get: + description: Get a specific GCS import storage connection that was set up with WIF. + operationId: api_storages_gcswif_retrieve parameters: - - in: path - name: id - schema: - type: integer - required: true + - in: path + name: id + required: true + schema: + type: integer + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/GCSWIFImportStorage' + description: '' + security: + - Token: [] + summary: Get GCS WIF import storage tags: - - 'Storage: GCS WIF' + - 'Storage: GCS WIF' + patch: + description: Update a specific GCS import storage connection that was set up with WIF authentication. + operationId: api_storages_gcswif_partial_update + parameters: + - in: path + name: id + required: true + schema: + type: integer requestBody: content: application/json: schema: - $ref: '#/components/schemas/GCSWIFImportStorageRequest' + $ref: '#/components/schemas/PatchedGCSWIFImportStorageRequest' application/x-www-form-urlencoded: schema: - $ref: '#/components/schemas/GCSWIFImportStorageRequest' + $ref: '#/components/schemas/PatchedGCSWIFImportStorageRequest' multipart/form-data: schema: - $ref: '#/components/schemas/GCSWIFImportStorageRequest' - required: true - security: - - Token: [] + $ref: '#/components/schemas/PatchedGCSWIFImportStorageRequest' responses: '200': content: @@ -12615,14 +12269,21 @@ paths: schema: $ref: '#/components/schemas/GCSWIFImportStorage' description: '' - /api/storages/gcswif/validate: - post: - operationId: api_storages_gcswif_validate_create - description: Validate a specific GCS import storage connection that was set - up with WIF authentication. - summary: Validate GCS WIF import storage + security: + - Token: [] + summary: Update GCS WIF import storage tags: - - 'Storage: GCS WIF' + - 'Storage: GCS WIF' + /api/storages/gcswif/{id}/sync: + post: + description: Sync tasks from an GCS import storage connection that was set up with WIF authentication. + operationId: api_storages_gcswif_sync_create + parameters: + - in: path + name: id + required: true + schema: + type: integer requestBody: content: application/json: @@ -12635,89 +12296,84 @@ paths: schema: $ref: '#/components/schemas/GCSWIFImportStorageRequest' required: true - security: - - Token: [] responses: - '201': + '200': content: application/json: schema: $ref: '#/components/schemas/GCSWIFImportStorage' description: '' + security: + - Token: [] + summary: Sync GCS WIF import storage + tags: + - 'Storage: GCS WIF' /api/storages/localfiles/: get: - operationId: api_storages_localfiles_list description: Get a list of all local file import storage connections. - summary: Get all import storage + operationId: api_storages_localfiles_list parameters: - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - - in: query - name: project - schema: - type: integer - description: Project ID - tags: - - 'Storage: Local' - security: - - Token: [] + - description: Which field to use when ordering the results. + in: query + name: ordering + required: false + schema: + type: string + - description: Project ID + in: query + name: project + schema: + type: integer responses: '200': content: application/json: schema: - type: array items: $ref: '#/components/schemas/LocalFilesImportStorage' + type: array description: '' + security: + - Token: [] + summary: Get all import storage + tags: + - 'Storage: Local' + x-fern-audiences: + - public x-fern-sdk-group-name: - - import_storage - - local + - import_storage + - local x-fern-sdk-method-name: list - x-fern-audiences: - - public post: - operationId: api_storages_localfiles_create description: Create a new local file import storage connection. - summary: Create import storage - tags: - - 'Storage: Local' + operationId: api_storages_localfiles_create requestBody: content: application/json: schema: - type: object properties: - title: - type: string - description: Storage title - maxLength: 2048 description: - type: string description: Storage description - project: - type: integer - description: Project ID - path: type: string + path: description: Path to local directory - regex_filter: type: string + project: + description: Project ID + type: integer + regex_filter: description: Regex for filtering objects + type: string + title: + description: Storage title + maxLength: 2048 + type: string use_blob_urls: - type: boolean - description: Interpret objects as BLOBs and generate URLs. For example, - if your directory contains images, you can use this option to - generate URLs for these images. If set to False, it will read - the content of the file and load it into Label Studio. default: false + description: Interpret objects as BLOBs and generate URLs. For example, if your directory contains images, you can use this option to generate URLs for these images. If set to False, it will read the content of the file and load it into Label Studio. + type: boolean required: [] - security: - - Token: [] + type: object responses: '201': content: @@ -12725,27 +12381,98 @@ paths: schema: $ref: '#/components/schemas/LocalFilesImportStorage' description: '' + security: + - Token: [] + summary: Create import storage + tags: + - 'Storage: Local' + x-fern-audiences: + - public x-fern-sdk-group-name: - - import_storage - - local + - import_storage + - local x-fern-sdk-method-name: create + /api/storages/localfiles/validate: + post: + description: Validate a specific local file import storage connection. + operationId: api_storages_localfiles_validate_create + requestBody: + content: + application/json: + schema: + properties: + description: + description: Storage description + type: string + id: + description: Storage ID. If set, storage with specified ID will be updated + type: integer + path: + description: Path to local directory + type: string + project: + description: Project ID + type: integer + regex_filter: + description: Regex for filtering objects + type: string + title: + description: Storage title + maxLength: 2048 + type: string + use_blob_urls: + default: false + description: Interpret objects as BLOBs and generate URLs. For example, if your directory contains images, you can use this option to generate URLs for these images. If set to False, it will read the content of the file and load it into Label Studio. + type: boolean + required: [] + type: object + responses: + '200': + description: Validation successful + security: + - Token: [] + summary: Validate import storage + tags: + - 'Storage: Local' x-fern-audiences: - - public + - public + x-fern-sdk-group-name: + - import_storage + - local + x-fern-sdk-method-name: validate /api/storages/localfiles/{id}: + delete: + description: Delete a specific local file import storage connection. + operationId: api_storages_localfiles_destroy + parameters: + - in: path + name: id + required: true + schema: + type: integer + responses: + '204': + description: No response body + security: + - Token: [] + summary: Delete import storage + tags: + - 'Storage: Local' + x-fern-audiences: + - public + x-fern-sdk-group-name: + - import_storage + - local + x-fern-sdk-method-name: delete get: - operationId: api_storages_localfiles_retrieve description: Get a specific local file import storage connection. - summary: Get import storage + operationId: api_storages_localfiles_retrieve parameters: - - in: path - name: id - schema: - type: integer - required: true - tags: - - 'Storage: Local' - security: - - Token: [] + - in: path + name: id + required: true + schema: + type: integer responses: '200': content: @@ -12753,56 +12480,53 @@ paths: schema: $ref: '#/components/schemas/LocalFilesImportStorage' description: '' + security: + - Token: [] + summary: Get import storage + tags: + - 'Storage: Local' + x-fern-audiences: + - public x-fern-sdk-group-name: - - import_storage - - local + - import_storage + - local x-fern-sdk-method-name: get - x-fern-audiences: - - public patch: - operationId: api_storages_localfiles_partial_update description: Update a specific local file import storage connection. - summary: Update import storage + operationId: api_storages_localfiles_partial_update parameters: - - in: path - name: id - schema: - type: integer - required: true - tags: - - 'Storage: Local' + - in: path + name: id + required: true + schema: + type: integer requestBody: content: application/json: schema: - type: object properties: - title: - type: string - description: Storage title - maxLength: 2048 description: - type: string description: Storage description - project: - type: integer - description: Project ID - path: type: string + path: description: Path to local directory - regex_filter: type: string + project: + description: Project ID + type: integer + regex_filter: description: Regex for filtering objects + type: string + title: + description: Storage title + maxLength: 2048 + type: string use_blob_urls: - type: boolean - description: Interpret objects as BLOBs and generate URLs. For example, - if your directory contains images, you can use this option to - generate URLs for these images. If set to False, it will read - the content of the file and load it into Label Studio. default: false + description: Interpret objects as BLOBs and generate URLs. For example, if your directory contains images, you can use this option to generate URLs for these images. If set to False, it will read the content of the file and load it into Label Studio. + type: boolean required: [] - security: - - Token: [] + type: object responses: '200': content: @@ -12810,51 +12534,28 @@ paths: schema: $ref: '#/components/schemas/LocalFilesImportStorage' description: '' - x-fern-sdk-group-name: - - import_storage - - local - x-fern-sdk-method-name: update - x-fern-audiences: - - public - delete: - operationId: api_storages_localfiles_destroy - description: Delete a specific local file import storage connection. - summary: Delete import storage - parameters: - - in: path - name: id - schema: - type: integer - required: true - tags: - - 'Storage: Local' security: - - Token: [] - responses: - '204': - description: No response body - x-fern-sdk-group-name: - - import_storage - - local - x-fern-sdk-method-name: delete + - Token: [] + summary: Update import storage + tags: + - 'Storage: Local' x-fern-audiences: - - public + - public + x-fern-sdk-group-name: + - import_storage + - local + x-fern-sdk-method-name: update /api/storages/localfiles/{id}/sync: post: - operationId: api_storages_localfiles_sync_create description: Sync tasks from a local file import storage connection. - summary: Sync import storage + operationId: api_storages_localfiles_sync_create parameters: - - in: path - name: id - schema: - type: integer - description: Storage ID - required: true - tags: - - 'Storage: Local' - security: - - Token: [] + - description: Storage ID + in: path + name: id + required: true + schema: + type: integer responses: '200': content: @@ -12862,148 +12563,92 @@ paths: schema: $ref: '#/components/schemas/LocalFilesImportStorage' description: '' - x-fern-sdk-group-name: - - import_storage - - local - x-fern-sdk-method-name: sync - x-fern-audiences: - - public - /api/storages/localfiles/validate: - post: - operationId: api_storages_localfiles_validate_create - description: Validate a specific local file import storage connection. - summary: Validate import storage - tags: - - 'Storage: Local' - requestBody: - content: - application/json: - schema: - type: object - properties: - id: - type: integer - description: Storage ID. If set, storage with specified ID will - be updated - title: - type: string - description: Storage title - maxLength: 2048 - description: - type: string - description: Storage description - project: - type: integer - description: Project ID - path: - type: string - description: Path to local directory - regex_filter: - type: string - description: Regex for filtering objects - use_blob_urls: - type: boolean - description: Interpret objects as BLOBs and generate URLs. For example, - if your directory contains images, you can use this option to - generate URLs for these images. If set to False, it will read - the content of the file and load it into Label Studio. - default: false - required: [] security: - - Token: [] - responses: - '200': - description: Validation successful - x-fern-sdk-group-name: - - import_storage - - local - x-fern-sdk-method-name: validate + - Token: [] + summary: Sync import storage + tags: + - 'Storage: Local' x-fern-audiences: - - public + - public + x-fern-sdk-group-name: + - import_storage + - local + x-fern-sdk-method-name: sync /api/storages/redis/: get: - operationId: api_storages_redis_list description: Get a list of all Redis import storage connections. - summary: Get all import storage + operationId: api_storages_redis_list parameters: - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - - in: query - name: project - schema: - type: integer - description: Project ID - tags: - - 'Storage: Redis' - security: - - Token: [] + - description: Which field to use when ordering the results. + in: query + name: ordering + required: false + schema: + type: string + - description: Project ID + in: query + name: project + schema: + type: integer responses: '200': content: application/json: schema: - type: array items: $ref: '#/components/schemas/RedisImportStorage' + type: array description: '' + security: + - Token: [] + summary: Get all import storage + tags: + - 'Storage: Redis' + x-fern-audiences: + - public x-fern-sdk-group-name: - - import_storage - - redis + - import_storage + - redis x-fern-sdk-method-name: list - x-fern-audiences: - - public post: - operationId: api_storages_redis_create description: Create a new Redis import storage connection. - summary: Create import storage - tags: - - 'Storage: Redis' + operationId: api_storages_redis_create requestBody: content: application/json: schema: - type: object properties: - regex_filter: + description: + description: Storage description type: string - description: Cloud storage regex for filtering objects. You must - specify it otherwise no objects will be imported. - use_blob_urls: - type: boolean - description: Interpret objects as BLOBs and generate URLs. For example, - if your bucket contains images, you can use this option to generate - URLs for these images. If set to False, it will read the content - of the file and load it into Label Studio. - default: false - title: + host: + description: Server Host IP (optional) type: string - description: Storage title - maxLength: 2048 - description: + password: + description: Server Password (optional) type: string - description: Storage description - project: - type: integer - description: Project ID path: - type: string description: Storage prefix (optional) - host: type: string - description: Server Host IP (optional) port: - type: string description: Server Port (optional) - password: type: string - description: Server Password (optional) + project: + description: Project ID + type: integer + regex_filter: + description: Cloud storage regex for filtering objects. You must specify it otherwise no objects will be imported. + type: string + title: + description: Storage title + maxLength: 2048 + type: string + use_blob_urls: + default: false + description: Interpret objects as BLOBs and generate URLs. For example, if your bucket contains images, you can use this option to generate URLs for these images. If set to False, it will read the content of the file and load it into Label Studio. + type: boolean required: [] - security: - - Token: [] + type: object responses: '201': content: @@ -13011,27 +12656,107 @@ paths: schema: $ref: '#/components/schemas/RedisImportStorage' description: '' + security: + - Token: [] + summary: Create import storage + tags: + - 'Storage: Redis' + x-fern-audiences: + - public x-fern-sdk-group-name: - - import_storage - - redis + - import_storage + - redis x-fern-sdk-method-name: create + /api/storages/redis/validate: + post: + description: Validate a specific Redis import storage connection. + operationId: api_storages_redis_validate_create + requestBody: + content: + application/json: + schema: + properties: + description: + description: Storage description + type: string + host: + description: Server Host IP (optional) + type: string + id: + description: Storage ID. If set, storage with specified ID will be updated + type: integer + password: + description: Server Password (optional) + type: string + path: + description: Storage prefix (optional) + type: string + port: + description: Server Port (optional) + type: string + project: + description: Project ID + type: integer + regex_filter: + description: Cloud storage regex for filtering objects. You must specify it otherwise no objects will be imported. + type: string + title: + description: Storage title + maxLength: 2048 + type: string + use_blob_urls: + default: false + description: Interpret objects as BLOBs and generate URLs. For example, if your bucket contains images, you can use this option to generate URLs for these images. If set to False, it will read the content of the file and load it into Label Studio. + type: boolean + required: [] + type: object + responses: + '200': + description: Validation successful + security: + - Token: [] + summary: Validate import storage + tags: + - 'Storage: Redis' x-fern-audiences: - - public + - public + x-fern-sdk-group-name: + - import_storage + - redis + x-fern-sdk-method-name: validate /api/storages/redis/{id}: + delete: + description: Delete a specific Redis import storage connection. + operationId: api_storages_redis_destroy + parameters: + - in: path + name: id + required: true + schema: + type: integer + responses: + '204': + description: No response body + security: + - Token: [] + summary: Delete import storage + tags: + - 'Storage: Redis' + x-fern-audiences: + - public + x-fern-sdk-group-name: + - import_storage + - redis + x-fern-sdk-method-name: delete get: - operationId: api_storages_redis_retrieve description: Get a specific Redis import storage connection. - summary: Get import storage + operationId: api_storages_redis_retrieve parameters: - - in: path - name: id - schema: - type: integer - required: true - tags: - - 'Storage: Redis' - security: - - Token: [] + - in: path + name: id + required: true + schema: + type: integer responses: '200': content: @@ -13039,66 +12764,62 @@ paths: schema: $ref: '#/components/schemas/RedisImportStorage' description: '' + security: + - Token: [] + summary: Get import storage + tags: + - 'Storage: Redis' + x-fern-audiences: + - public x-fern-sdk-group-name: - - import_storage - - redis + - import_storage + - redis x-fern-sdk-method-name: get - x-fern-audiences: - - public patch: - operationId: api_storages_redis_partial_update description: Update a specific Redis import storage connection. - summary: Update import storage + operationId: api_storages_redis_partial_update parameters: - - in: path - name: id - schema: - type: integer - required: true - tags: - - 'Storage: Redis' + - in: path + name: id + required: true + schema: + type: integer requestBody: content: application/json: schema: - type: object properties: - regex_filter: + description: + description: Storage description type: string - description: Cloud storage regex for filtering objects. You must - specify it otherwise no objects will be imported. - use_blob_urls: - type: boolean - description: Interpret objects as BLOBs and generate URLs. For example, - if your bucket contains images, you can use this option to generate - URLs for these images. If set to False, it will read the content - of the file and load it into Label Studio. - default: false - title: + host: + description: Server Host IP (optional) type: string - description: Storage title - maxLength: 2048 - description: + password: + description: Server Password (optional) type: string - description: Storage description - project: - type: integer - description: Project ID path: - type: string description: Storage prefix (optional) - host: type: string - description: Server Host IP (optional) port: - type: string description: Server Port (optional) - password: type: string - description: Server Password (optional) + project: + description: Project ID + type: integer + regex_filter: + description: Cloud storage regex for filtering objects. You must specify it otherwise no objects will be imported. + type: string + title: + description: Storage title + maxLength: 2048 + type: string + use_blob_urls: + default: false + description: Interpret objects as BLOBs and generate URLs. For example, if your bucket contains images, you can use this option to generate URLs for these images. If set to False, it will read the content of the file and load it into Label Studio. + type: boolean required: [] - security: - - Token: [] + type: object responses: '200': content: @@ -13106,51 +12827,28 @@ paths: schema: $ref: '#/components/schemas/RedisImportStorage' description: '' + security: + - Token: [] + summary: Update import storage + tags: + - 'Storage: Redis' + x-fern-audiences: + - public x-fern-sdk-group-name: - - import_storage - - redis + - import_storage + - redis x-fern-sdk-method-name: update - x-fern-audiences: - - public - delete: - operationId: api_storages_redis_destroy - description: Delete a specific Redis import storage connection. - summary: Delete import storage + /api/storages/redis/{id}/sync: + post: + description: Sync tasks from a Redis import storage connection. + operationId: api_storages_redis_sync_create parameters: - - in: path - name: id - schema: - type: integer - required: true - tags: - - 'Storage: Redis' - security: - - Token: [] - responses: - '204': - description: No response body - x-fern-sdk-group-name: - - import_storage - - redis - x-fern-sdk-method-name: delete - x-fern-audiences: - - public - /api/storages/redis/{id}/sync: - post: - operationId: api_storages_redis_sync_create - description: Sync tasks from a Redis import storage connection. - summary: Sync import storage - parameters: - - in: path - name: id - schema: - type: integer - description: Storage ID - required: true - tags: - - 'Storage: Redis' - security: - - Token: [] + - description: Storage ID + in: path + name: id + required: true + schema: + type: integer responses: '200': content: @@ -13158,181 +12856,115 @@ paths: schema: $ref: '#/components/schemas/RedisImportStorage' description: '' - x-fern-sdk-group-name: - - import_storage - - redis - x-fern-sdk-method-name: sync - x-fern-audiences: - - public - /api/storages/redis/validate: - post: - operationId: api_storages_redis_validate_create - description: Validate a specific Redis import storage connection. - summary: Validate import storage - tags: - - 'Storage: Redis' - requestBody: - content: - application/json: - schema: - type: object - properties: - id: - type: integer - description: Storage ID. If set, storage with specified ID will - be updated - regex_filter: - type: string - description: Cloud storage regex for filtering objects. You must - specify it otherwise no objects will be imported. - use_blob_urls: - type: boolean - description: Interpret objects as BLOBs and generate URLs. For example, - if your bucket contains images, you can use this option to generate - URLs for these images. If set to False, it will read the content - of the file and load it into Label Studio. - default: false - title: - type: string - description: Storage title - maxLength: 2048 - description: - type: string - description: Storage description - project: - type: integer - description: Project ID - path: - type: string - description: Storage prefix (optional) - host: - type: string - description: Server Host IP (optional) - port: - type: string - description: Server Port (optional) - password: - type: string - description: Server Password (optional) - required: [] security: - - Token: [] - responses: - '200': - description: Validation successful - x-fern-sdk-group-name: - - import_storage - - redis - x-fern-sdk-method-name: validate + - Token: [] + summary: Sync import storage + tags: + - 'Storage: Redis' x-fern-audiences: - - public + - public + x-fern-sdk-group-name: + - import_storage + - redis + x-fern-sdk-method-name: sync /api/storages/s3/: get: - operationId: api_storages_s3_list description: Get a list of all S3 import storage connections. - summary: List S3 import storage + operationId: api_storages_s3_list parameters: - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - - in: query - name: project - schema: - type: integer - description: Project ID - tags: - - 'Storage: S3' - security: - - Token: [] + - description: Which field to use when ordering the results. + in: query + name: ordering + required: false + schema: + type: string + - description: Project ID + in: query + name: project + schema: + type: integer responses: '200': content: application/json: schema: - type: array items: $ref: '#/components/schemas/S3ImportStorage' + type: array description: '' + security: + - Token: [] + summary: List S3 import storage + tags: + - 'Storage: S3' + x-fern-audiences: + - public x-fern-sdk-group-name: - - import_storage - - s3 + - import_storage + - s3 x-fern-sdk-method-name: list - x-fern-audiences: - - public post: - operationId: api_storages_s3_create description: Create new S3 import storage - summary: Create new S3 storage - tags: - - 'Storage: S3' + operationId: api_storages_s3_create requestBody: content: application/json: schema: - type: object properties: - regex_filter: + aws_access_key_id: + description: AWS_ACCESS_KEY_ID type: string - description: Cloud storage regex for filtering objects. You must - specify it otherwise no objects will be imported. - use_blob_urls: - type: boolean - description: Interpret objects as BLOBs and generate URLs. For example, - if your bucket contains images, you can use this option to generate - URLs for these images. If set to False, it will read the content - of the file and load it into Label Studio. - default: false - presign: - type: boolean - description: Presign URLs for download - default: true - presign_ttl: - type: integer - description: Presign TTL in minutes - default: 1 - recursive_scan: - type: boolean - description: Scan recursively - title: + aws_secret_access_key: + description: AWS_SECRET_ACCESS_KEY type: string - description: Storage title - maxLength: 2048 - description: + aws_session_token: + description: AWS_SESSION_TOKEN type: string - description: Storage description - project: - type: integer - description: Project ID - bucket: + aws_sse_kms_key_id: + description: AWS SSE KMS Key ID type: string + bucket: description: S3 bucket name - prefix: type: string - description: S3 bucket prefix - aws_access_key_id: - type: string - description: AWS_ACCESS_KEY_ID - aws_secret_access_key: + description: + description: Storage description type: string - description: AWS_SECRET_ACCESS_KEY - aws_session_token: + prefix: + description: S3 bucket prefix type: string - description: AWS_SESSION_TOKEN - aws_sse_kms_key_id: + presign: + default: true + description: Presign URLs for download + type: boolean + presign_ttl: + default: 1 + description: Presign TTL in minutes + type: integer + project: + description: Project ID + type: integer + recursive_scan: + description: Scan recursively + type: boolean + regex_filter: + description: Cloud storage regex for filtering objects. You must specify it otherwise no objects will be imported. type: string - description: AWS SSE KMS Key ID region_name: - type: string description: AWS Region - s3_endpoint: type: string + s3_endpoint: description: S3 Endpoint + type: string + title: + description: Storage title + maxLength: 2048 + type: string + use_blob_urls: + default: false + description: Interpret objects as BLOBs and generate URLs. For example, if your bucket contains images, you can use this option to generate URLs for these images. If set to False, it will read the content of the file and load it into Label Studio. + type: boolean required: [] - security: - - Token: [] + type: object responses: '201': content: @@ -13340,169 +12972,130 @@ paths: schema: $ref: '#/components/schemas/S3ImportStorage' description: '' - x-fern-sdk-group-name: - - import_storage - - s3 - x-fern-sdk-method-name: create - x-fern-audiences: - - public - /api/storages/s3/{id}: - get: - operationId: api_storages_s3_retrieve - description: Get a specific S3 import storage connection. - summary: Get import storage - parameters: - - in: path - name: id - schema: - type: integer - required: true - tags: - - 'Storage: S3' security: - - Token: [] - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/S3ImportStorage' - description: '' - x-fern-sdk-group-name: - - import_storage - - s3 - x-fern-sdk-method-name: get - x-fern-audiences: - - public - patch: - operationId: api_storages_s3_partial_update - description: Update a specific S3 import storage connection. - summary: Update import storage - parameters: - - in: path - name: id - schema: - type: integer - required: true + - Token: [] + summary: Create new S3 storage tags: - - 'Storage: S3' + - 'Storage: S3' + x-fern-audiences: + - public + x-fern-sdk-group-name: + - import_storage + - s3 + x-fern-sdk-method-name: create + /api/storages/s3/validate: + post: + description: Validate a specific S3 import storage connection. + operationId: api_storages_s3_validate_create requestBody: content: application/json: schema: - type: object properties: - regex_filter: + aws_access_key_id: + description: AWS_ACCESS_KEY_ID + type: string + aws_secret_access_key: + description: AWS_SECRET_ACCESS_KEY + type: string + aws_session_token: + description: AWS_SESSION_TOKEN + type: string + aws_sse_kms_key_id: + description: AWS SSE KMS Key ID + type: string + bucket: + description: S3 bucket name + type: string + description: + description: Storage description + type: string + id: + description: Storage ID. If set, storage with specified ID will be updated + type: integer + prefix: + description: S3 bucket prefix type: string - description: Cloud storage regex for filtering objects. You must - specify it otherwise no objects will be imported. - use_blob_urls: - type: boolean - description: Interpret objects as BLOBs and generate URLs. For example, - if your bucket contains images, you can use this option to generate - URLs for these images. If set to False, it will read the content - of the file and load it into Label Studio. - default: false presign: - type: boolean - description: Presign URLs for download default: true + description: Presign URLs for download + type: boolean presign_ttl: - type: integer - description: Presign TTL in minutes default: 1 + description: Presign TTL in minutes + type: integer + project: + description: Project ID + type: integer recursive_scan: - type: boolean description: Scan recursively - title: + type: boolean + regex_filter: + description: Cloud storage regex for filtering objects. You must specify it otherwise no objects will be imported. + type: string + region_name: + description: AWS Region type: string + s3_endpoint: + description: S3 Endpoint + type: string + title: description: Storage title maxLength: 2048 - description: type: string - description: Storage description - project: - type: integer - description: Project ID - bucket: - type: string - description: S3 bucket name - prefix: - type: string - description: S3 bucket prefix - aws_access_key_id: - type: string - description: AWS_ACCESS_KEY_ID - aws_secret_access_key: - type: string - description: AWS_SECRET_ACCESS_KEY - aws_session_token: - type: string - description: AWS_SESSION_TOKEN - aws_sse_kms_key_id: - type: string - description: AWS SSE KMS Key ID - region_name: - type: string - description: AWS Region - s3_endpoint: - type: string - description: S3 Endpoint + use_blob_urls: + default: false + description: Interpret objects as BLOBs and generate URLs. For example, if your bucket contains images, you can use this option to generate URLs for these images. If set to False, it will read the content of the file and load it into Label Studio. + type: boolean required: [] - security: - - Token: [] + type: object responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/S3ImportStorage' - description: '' - x-fern-sdk-group-name: - - import_storage - - s3 - x-fern-sdk-method-name: update + description: Validation successful + security: + - Token: [] + summary: Validate import storage + tags: + - 'Storage: S3' x-fern-audiences: - - public + - public + x-fern-sdk-group-name: + - import_storage + - s3 + x-fern-sdk-method-name: validate + /api/storages/s3/{id}: delete: - operationId: api_storages_s3_destroy description: Delete a specific S3 import storage connection. - summary: Delete import storage + operationId: api_storages_s3_destroy parameters: - - in: path - name: id - schema: - type: integer - required: true - tags: - - 'Storage: S3' - security: - - Token: [] + - in: path + name: id + required: true + schema: + type: integer responses: '204': description: No response body + security: + - Token: [] + summary: Delete import storage + tags: + - 'Storage: S3' + x-fern-audiences: + - public x-fern-sdk-group-name: - - import_storage - - s3 + - import_storage + - s3 x-fern-sdk-method-name: delete - x-fern-audiences: - - public - /api/storages/s3/{id}/sync: - post: - operationId: api_storages_s3_sync_create - description: Sync tasks from an S3 import storage connection. - summary: Sync import storage + get: + description: Get a specific S3 import storage connection. + operationId: api_storages_s3_retrieve parameters: - - in: path - name: id - schema: - type: integer - description: Storage ID - required: true - tags: - - 'Storage: S3' - security: - - Token: [] + - in: path + name: id + required: true + schema: + type: integer responses: '200': content: @@ -13510,139 +13103,170 @@ paths: schema: $ref: '#/components/schemas/S3ImportStorage' description: '' - x-fern-sdk-group-name: - - import_storage - - s3 - x-fern-sdk-method-name: sync - x-fern-audiences: - - public - /api/storages/s3/validate: - post: - operationId: api_storages_s3_validate_create - description: Validate a specific S3 import storage connection. - summary: Validate import storage + security: + - Token: [] + summary: Get import storage tags: - - 'Storage: S3' + - 'Storage: S3' + x-fern-audiences: + - public + x-fern-sdk-group-name: + - import_storage + - s3 + x-fern-sdk-method-name: get + patch: + description: Update a specific S3 import storage connection. + operationId: api_storages_s3_partial_update + parameters: + - in: path + name: id + required: true + schema: + type: integer requestBody: content: application/json: schema: - type: object properties: - id: - type: integer - description: Storage ID. If set, storage with specified ID will - be updated - regex_filter: + aws_access_key_id: + description: AWS_ACCESS_KEY_ID type: string - description: Cloud storage regex for filtering objects. You must - specify it otherwise no objects will be imported. - use_blob_urls: - type: boolean - description: Interpret objects as BLOBs and generate URLs. For example, - if your bucket contains images, you can use this option to generate - URLs for these images. If set to False, it will read the content - of the file and load it into Label Studio. - default: false - presign: - type: boolean - description: Presign URLs for download - default: true - presign_ttl: - type: integer - description: Presign TTL in minutes - default: 1 - recursive_scan: - type: boolean - description: Scan recursively - title: + aws_secret_access_key: + description: AWS_SECRET_ACCESS_KEY type: string - description: Storage title - maxLength: 2048 - description: + aws_session_token: + description: AWS_SESSION_TOKEN type: string - description: Storage description - project: - type: integer - description: Project ID - bucket: + aws_sse_kms_key_id: + description: AWS SSE KMS Key ID type: string + bucket: description: S3 bucket name - prefix: - type: string - description: S3 bucket prefix - aws_access_key_id: type: string - description: AWS_ACCESS_KEY_ID - aws_secret_access_key: + description: + description: Storage description type: string - description: AWS_SECRET_ACCESS_KEY - aws_session_token: + prefix: + description: S3 bucket prefix type: string - description: AWS_SESSION_TOKEN - aws_sse_kms_key_id: + presign: + default: true + description: Presign URLs for download + type: boolean + presign_ttl: + default: 1 + description: Presign TTL in minutes + type: integer + project: + description: Project ID + type: integer + recursive_scan: + description: Scan recursively + type: boolean + regex_filter: + description: Cloud storage regex for filtering objects. You must specify it otherwise no objects will be imported. type: string - description: AWS SSE KMS Key ID region_name: - type: string description: AWS Region - s3_endpoint: type: string + s3_endpoint: description: S3 Endpoint + type: string + title: + description: Storage title + maxLength: 2048 + type: string + use_blob_urls: + default: false + description: Interpret objects as BLOBs and generate URLs. For example, if your bucket contains images, you can use this option to generate URLs for these images. If set to False, it will read the content of the file and load it into Label Studio. + type: boolean required: [] - security: - - Token: [] + type: object responses: '200': - description: Validation successful + content: + application/json: + schema: + $ref: '#/components/schemas/S3ImportStorage' + description: '' + security: + - Token: [] + summary: Update import storage + tags: + - 'Storage: S3' + x-fern-audiences: + - public x-fern-sdk-group-name: - - import_storage - - s3 - x-fern-sdk-method-name: validate + - import_storage + - s3 + x-fern-sdk-method-name: update + /api/storages/s3/{id}/sync: + post: + description: Sync tasks from an S3 import storage connection. + operationId: api_storages_s3_sync_create + parameters: + - description: Storage ID + in: path + name: id + required: true + schema: + type: integer + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/S3ImportStorage' + description: '' + security: + - Token: [] + summary: Sync import storage + tags: + - 'Storage: S3' x-fern-audiences: - - public + - public + x-fern-sdk-group-name: + - import_storage + - s3 + x-fern-sdk-method-name: sync /api/storages/s3s/: get: + description: Get list of all S3 import storage connections set up with IAM role access. operationId: api_storages_s3s_list - description: Get list of all S3 import storage connections set up with IAM role - access. - summary: List S3s import storage parameters: - - in: query - name: ordering - schema: - type: string - description: Which field to use when ordering the results. - - in: query - name: project - schema: - type: integer - description: Project ID - tags: - - 'Storage: S3 Roles' - security: - - Token: [] + - description: Which field to use when ordering the results. + in: query + name: ordering + schema: + type: string + - description: Project ID + in: query + name: project + schema: + type: integer responses: '200': content: application/json: schema: - type: array items: $ref: '#/components/schemas/LseS3ImportStorage' + type: array description: '' + security: + - Token: [] + summary: List S3s import storage + tags: + - 'Storage: S3 Roles' + x-fern-audiences: + - public x-fern-sdk-group-name: - - import_storage - - s3s + - import_storage + - s3s x-fern-sdk-method-name: list - x-fern-audiences: - - public post: - operationId: api_storages_s3s_create description: Create S3 import storage with IAM role access. - summary: Create import storage - tags: - - 'Storage: S3 Roles' + operationId: api_storages_s3s_create requestBody: content: application/json: @@ -13655,8 +13279,6 @@ paths: schema: $ref: '#/components/schemas/LseS3ImportStorageRequest' required: true - security: - - Token: [] responses: '201': content: @@ -13664,120 +13286,80 @@ paths: schema: $ref: '#/components/schemas/LseS3ImportStorage' description: '' - x-fern-sdk-group-name: - - import_storage - - s3s - x-fern-sdk-method-name: create - x-fern-audiences: - - public - /api/storages/s3s/{id}: - get: - operationId: api_storages_s3s_retrieve - description: Get a specific S3 import storage connection that was set up with - IAM role access. - summary: Get import storage - parameters: - - in: path - name: id - schema: - type: integer - required: true - tags: - - 'Storage: S3 Roles' security: - - Token: [] - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/LseS3ImportStorage' - description: '' - x-fern-sdk-group-name: - - import_storage - - s3s - x-fern-sdk-method-name: get - x-fern-audiences: - - public - patch: - operationId: api_storages_s3s_partial_update - description: Update a specific S3 import storage connection that was set up - with IAM role access. - summary: Update import storage - parameters: - - in: path - name: id - schema: - type: integer - required: true + - Token: [] + summary: Create import storage tags: - - 'Storage: S3 Roles' + - 'Storage: S3 Roles' + x-fern-audiences: + - public + x-fern-sdk-group-name: + - import_storage + - s3s + x-fern-sdk-method-name: create + /api/storages/s3s/validate: + post: + description: Validate a specific S3 import storage connection that was set up with IAM role access. + operationId: api_storages_s3s_validate_create requestBody: content: application/json: schema: - $ref: '#/components/schemas/PatchedLseS3ImportStorageRequest' + $ref: '#/components/schemas/LseS3ImportStorageRequest' application/x-www-form-urlencoded: schema: - $ref: '#/components/schemas/PatchedLseS3ImportStorageRequest' + $ref: '#/components/schemas/LseS3ImportStorageRequest' multipart/form-data: schema: - $ref: '#/components/schemas/PatchedLseS3ImportStorageRequest' - security: - - Token: [] + $ref: '#/components/schemas/LseS3ImportStorageRequest' + required: true responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/LseS3ImportStorage' - description: '' - x-fern-sdk-group-name: - - import_storage - - s3s - x-fern-sdk-method-name: update + description: Validation successful + security: + - Token: [] + summary: Validate import storage + tags: + - 'Storage: S3 Roles' x-fern-audiences: - - public + - public + x-fern-sdk-group-name: + - import_storage + - s3s + x-fern-sdk-method-name: validate + /api/storages/s3s/{id}: delete: + description: Delete a specific S3 import storage connection that was set up with IAM role access. operationId: api_storages_s3s_destroy - description: Delete a specific S3 import storage connection that was set up - with IAM role access. - summary: Delete import storage parameters: - - in: path - name: id - schema: - type: integer - required: true - tags: - - 'Storage: S3 Roles' - security: - - Token: [] + - in: path + name: id + required: true + schema: + type: integer responses: '204': description: No response body + security: + - Token: [] + summary: Delete import storage + tags: + - 'Storage: S3 Roles' + x-fern-audiences: + - public x-fern-sdk-group-name: - - import_storage - - s3s + - import_storage + - s3s x-fern-sdk-method-name: delete - x-fern-audiences: - - public - /api/storages/s3s/{id}/sync: - post: - operationId: api_storages_s3s_sync_create - description: Sync tasks from an S3 import storage connection that was set up - with IAM role access. - summary: Sync import storage + get: + description: Get a specific S3 import storage connection that was set up with IAM role access. + operationId: api_storages_s3s_retrieve parameters: - - in: path - name: id - schema: - type: integer - required: true - tags: - - 'Storage: S3 Roles' - security: - - Token: [] + - in: path + name: id + required: true + schema: + type: integer responses: '200': content: @@ -13785,154 +13367,188 @@ paths: schema: $ref: '#/components/schemas/LseS3ImportStorage' description: '' - x-fern-sdk-group-name: - - import_storage - - s3s - x-fern-sdk-method-name: sync - x-fern-audiences: - - public - /api/storages/s3s/validate: - post: - operationId: api_storages_s3s_validate_create - description: Validate a specific S3 import storage connection that was set up - with IAM role access. - summary: Validate import storage + security: + - Token: [] + summary: Get import storage tags: - - 'Storage: S3 Roles' + - 'Storage: S3 Roles' + x-fern-audiences: + - public + x-fern-sdk-group-name: + - import_storage + - s3s + x-fern-sdk-method-name: get + patch: + description: Update a specific S3 import storage connection that was set up with IAM role access. + operationId: api_storages_s3s_partial_update + parameters: + - in: path + name: id + required: true + schema: + type: integer requestBody: content: application/json: schema: - $ref: '#/components/schemas/LseS3ImportStorageRequest' + $ref: '#/components/schemas/PatchedLseS3ImportStorageRequest' application/x-www-form-urlencoded: schema: - $ref: '#/components/schemas/LseS3ImportStorageRequest' + $ref: '#/components/schemas/PatchedLseS3ImportStorageRequest' multipart/form-data: schema: - $ref: '#/components/schemas/LseS3ImportStorageRequest' - required: true - security: - - Token: [] + $ref: '#/components/schemas/PatchedLseS3ImportStorageRequest' responses: '200': - description: Validation successful + content: + application/json: + schema: + $ref: '#/components/schemas/LseS3ImportStorage' + description: '' + security: + - Token: [] + summary: Update import storage + tags: + - 'Storage: S3 Roles' + x-fern-audiences: + - public x-fern-sdk-group-name: - - import_storage - - s3s - x-fern-sdk-method-name: validate + - import_storage + - s3s + x-fern-sdk-method-name: update + /api/storages/s3s/{id}/sync: + post: + description: Sync tasks from an S3 import storage connection that was set up with IAM role access. + operationId: api_storages_s3s_sync_create + parameters: + - in: path + name: id + required: true + schema: + type: integer + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/LseS3ImportStorage' + description: '' + security: + - Token: [] + summary: Sync import storage + tags: + - 'Storage: S3 Roles' x-fern-audiences: - - public + - public + x-fern-sdk-group-name: + - import_storage + - s3s + x-fern-sdk-method-name: sync /api/storages/types: get: - operationId: api_storages_types_retrieve description: Retrieve a list of the import storages types. - summary: List all import storages types - tags: - - Storage - security: - - Token: [] + operationId: api_storages_types_retrieve responses: '200': content: application/json: schema: - type: array items: - type: object properties: name: type: string title: type: string + type: object + type: array description: List of import storage types + security: + - Token: [] + summary: List all import storages types + tags: + - Storage + x-fern-audiences: + - public x-fern-sdk-group-name: - - import_storage + - import_storage x-fern-sdk-method-name: list_types - x-fern-audiences: - - public /api/tasks/: get: - operationId: api_tasks_list description: |- Retrieve a paginated list of tasks. The response format varies based on the user's role in the organization: - **Admin/Owner**: Full task details with all annotations, reviews, and metadata - **Reviewer**: Task details optimized for review workflow - **Annotator**: Task details filtered to show only user's own annotations and assignments - summary: List tasks + operationId: api_tasks_list parameters: - - in: query - name: fields - schema: - type: string - enum: - - all - - task_only - description: Set to "all" if you want to include annotations and predictions - in the response. Defaults to task_only - - in: query - name: include - schema: - type: string - description: Specify which fields to include in the response - - in: query - name: only_annotated - schema: - type: boolean - description: Filter to show only tasks that have annotations - - name: page - required: false - in: query - description: A page number within the paginated result set. - schema: - type: integer - - name: page_size - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - in: query - name: project - schema: - type: integer - description: Project ID - - in: query - name: query - schema: - type: string - description: |- - Additional query to filter tasks. It must be JSON encoded string of dict containing one of the following parameters: {"filters": ..., "selectedItems": ..., "ordering": ...}. Check Data Manager > Create View > see data field for more details about filters, selectedItems and ordering. + - description: Set to "all" if you want to include annotations and predictions in the response. Defaults to task_only + in: query + name: fields + schema: + enum: + - all + - task_only + type: string + - description: Specify which fields to include in the response + in: query + name: include + schema: + type: string + - description: Filter to show only tasks that have annotations + in: query + name: only_annotated + schema: + type: boolean + - description: A page number within the paginated result set. + in: query + name: page + required: false + schema: + type: integer + - description: Number of results to return per page. + in: query + name: page_size + required: false + schema: + type: integer + - description: Project ID + in: query + name: project + schema: + type: integer + - description: |- + Additional query to filter tasks. It must be JSON encoded string of dict containing one of the following parameters: {"filters": ..., "selectedItems": ..., "ordering": ...}. Check Data Manager > Create View > see data field for more details about filters, selectedItems and ordering. - filters: dict with "conjunction" string ("or" or "and") and list of filters in "items" array. Each filter is a dictionary with keys: "filter", "operator", "type", "value". Read more about available filters - Example: {"conjunction": "or", "items": [{"filter": "filter:tasks:completed_at", "operator": "greater", "type": "Datetime", "value": "2021-01-01T00:00:00.000Z"}]} - selectedItems: dictionary with keys: "all", "included", "excluded". If "all" is false, "included" must be used. If "all" is true, "excluded" must be used. - Examples: {"all": false, "included": [1, 2, 3]} or {"all": true, "excluded": [4, 5]} - ordering: list of fields to order by. Currently, ordering is supported by only one parameter. - Example: ["completed_at"] - - in: query - name: resolve_uri - schema: - type: boolean - description: Resolve task data URIs using Cloud Storage - - in: query - name: review - schema: - type: boolean - description: Get tasks for review - - in: query - name: selectedItems - schema: - type: string - description: JSON string of selected task IDs for review workflow - - in: query - name: view - schema: - type: integer - description: View ID - tags: - - Tasks - security: - - Token: [] + filters: dict with "conjunction" string ("or" or "and") and list of filters in "items" array. Each filter is a dictionary with keys: "filter", "operator", "type", "value". Read more about available filters + Example: {"conjunction": "or", "items": [{"filter": "filter:tasks:completed_at", "operator": "greater", "type": "Datetime", "value": "2021-01-01T00:00:00.000Z"}]} + selectedItems: dictionary with keys: "all", "included", "excluded". If "all" is false, "included" must be used. If "all" is true, "excluded" must be used. + Examples: {"all": false, "included": [1, 2, 3]} or {"all": true, "excluded": [4, 5]} + ordering: list of fields to order by. Currently, ordering is supported by only one parameter. + Example: ["completed_at"] + in: query + name: query + schema: + type: string + - description: Resolve task data URIs using Cloud Storage + in: query + name: resolve_uri + schema: + type: boolean + - description: Get tasks for review + in: query + name: review + schema: + type: boolean + - description: JSON string of selected task IDs for review workflow + in: query + name: selectedItems + schema: + type: string + - description: View ID + in: query + name: view + schema: + type: integer responses: '200': content: @@ -13946,19 +13562,21 @@ paths: description: Unauthorized - authentication required '403': description: Forbidden - insufficient permissions - x-fern-sdk-group-name: tasks - x-fern-sdk-method-name: list + security: + - Token: [] + summary: List tasks + tags: + - Tasks x-fern-audiences: - - public + - public x-fern-pagination: offset: $request.page results: $response.tasks + x-fern-sdk-group-name: tasks + x-fern-sdk-method-name: list post: - operationId: api_tasks_create description: Create a new task - summary: Create a new task - tags: - - Tasks + operationId: api_tasks_create requestBody: content: application/json: @@ -13971,8 +13589,6 @@ paths: schema: $ref: '#/components/schemas/LseTaskRequest' required: true - security: - - Token: [] responses: '201': content: @@ -13980,27 +13596,48 @@ paths: schema: $ref: '#/components/schemas/LseTask' description: '' + security: + - Token: [] + summary: Create a new task + tags: + - Tasks + x-fern-audiences: + - public x-fern-sdk-group-name: tasks x-fern-sdk-method-name: create - x-fern-audiences: - - public /api/tasks/{id}/: + delete: + description: Delete a task in Label Studio. This action cannot be undone! + operationId: api_tasks_destroy + parameters: + - description: Task ID + in: path + name: id + required: true + schema: + type: string + responses: + '204': + description: Task deleted successfully + security: + - Token: [] + summary: Delete task + tags: + - Tasks + x-fern-audiences: + - public + x-fern-sdk-group-name: tasks + x-fern-sdk-method-name: delete get: + description: Get task data, metadata, annotations and other attributes for a specific labeling task by task ID. operationId: api_tasks_retrieve - description: Get task data, metadata, annotations and other attributes for a - specific labeling task by task ID. - summary: Get task parameters: - - in: path - name: id - schema: - type: string - description: Task ID - required: true - tags: - - Tasks - security: - - Token: [] + - description: Task ID + in: path + name: id + required: true + schema: + type: string responses: '200': content: @@ -14008,23 +13645,25 @@ paths: schema: $ref: '#/components/schemas/RoleBasedTask' description: '' + security: + - Token: [] + summary: Get task + tags: + - Tasks + x-fern-audiences: + - public x-fern-sdk-group-name: tasks x-fern-sdk-method-name: get - x-fern-audiences: - - public patch: - operationId: api_tasks_partial_update description: Update the attributes of an existing labeling task. - summary: Update task + operationId: api_tasks_partial_update parameters: - - in: path - name: id - schema: - type: string - description: Task ID - required: true - tags: - - Tasks + - description: Task ID + in: path + name: id + required: true + schema: + type: string requestBody: content: application/json: @@ -14036,8 +13675,6 @@ paths: multipart/form-data: schema: $ref: '#/components/schemas/PatchedLseTaskRequest' - security: - - Token: [] responses: '200': content: @@ -14045,263 +13682,233 @@ paths: schema: $ref: '#/components/schemas/RoleBasedTask' description: '' - x-fern-sdk-group-name: tasks - x-fern-sdk-method-name: update - x-fern-audiences: - - public - delete: - operationId: api_tasks_destroy - description: Delete a task in Label Studio. This action cannot be undone! - summary: Delete task - parameters: - - in: path - name: id - schema: - type: string - description: Task ID - required: true - tags: - - Tasks security: - - Token: [] - responses: - '204': - description: Task deleted successfully - x-fern-sdk-group-name: tasks - x-fern-sdk-method-name: delete + - Token: [] + summary: Update task + tags: + - Tasks x-fern-audiences: - - public + - public + x-fern-sdk-group-name: tasks + x-fern-sdk-method-name: update /api/tasks/{id}/annotations/: get: - operationId: api_tasks_annotations_list description: List all annotations for a task. - summary: Get all task annotations + operationId: api_tasks_annotations_list parameters: - - in: path - name: id - schema: - type: integer - description: Task ID - required: true - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - tags: - - Annotations - security: - - Token: [] + - description: Task ID + in: path + name: id + required: true + schema: + type: integer + - description: Which field to use when ordering the results. + in: query + name: ordering + required: false + schema: + type: string responses: '200': content: application/json: - schema: - type: array - items: - $ref: '#/components/schemas/Annotation' examples: Response: - value: - - - id: 1 - result: - - original_width: 1920 - original_height: 1080 - image_rotation: 0 - from_name: bboxes - to_name: image - type: rectanglelabels - value: - x: 20 - y: 30 - width: 50 - height: 60 - rotation: 0 - values: - rectanglelabels: - - Person - task: 1 - project: 1 - completed_by: 1 - updated_by: 1 - was_cancelled: false - ground_truth: false - lead_time: 10 summary: response + value: + - - completed_by: 1 + ground_truth: false + id: 1 + lead_time: 10 + project: 1 + result: + - from_name: bboxes + image_rotation: 0 + original_height: 1080 + original_width: 1920 + to_name: image + type: rectanglelabels + value: + height: 60 + rotation: 0 + values: + rectanglelabels: + - Person + width: 50 + x: 20 + y: 30 + task: 1 + updated_by: 1 + was_cancelled: false + schema: + items: + $ref: '#/components/schemas/Annotation' + type: array description: Annotation + security: + - Token: [] + summary: Get all task annotations + tags: + - Annotations + x-fern-audiences: + - public x-fern-sdk-group-name: annotations x-fern-sdk-method-name: list - x-fern-audiences: - - public post: + description: "\n Add annotations to a task like an annotator does. The content of the result field depends on your \n labeling configuration. For example, send the following data as part of your POST \n request to send an empty annotation with the ID of the user who completed the task:\n \n ```json\n {\n \"result\": {},\n \"was_cancelled\": true,\n \"ground_truth\": true,\n \"lead_time\": 0,\n \"task\": 0\n \"completed_by\": 123\n } \n ```\n " operationId: api_tasks_annotations_create - description: "\n Add annotations to a task like an annotator does. The\ - \ content of the result field depends on your \n labeling configuration.\ - \ For example, send the following data as part of your POST \n request\ - \ to send an empty annotation with the ID of the user who completed the task:\n\ - \ \n ```json\n {\n \"result\": {},\n \"\ - was_cancelled\": true,\n \"ground_truth\": true,\n \"lead_time\"\ - : 0,\n \"task\": 0\n \"completed_by\": 123\n } \n \ - \ ```\n " - summary: Create annotation parameters: - - in: path - name: id - schema: - type: integer - description: Task ID - required: true - tags: - - Annotations + - description: Task ID + in: path + name: id + required: true + schema: + type: integer requestBody: content: application/json: schema: - type: object - properties: + example: + ground_truth: true result: - type: array - items: - type: object - description: Labeling result in JSON format. Read more about the - format in [the Label Studio documentation.](https://labelstud.io/guide/task_format) - example: - - original_width: 1920 - original_height: 1080 + - from_name: bboxes image_rotation: 0 - from_name: bboxes + original_height: 1080 + original_width: 1920 to_name: image type: rectanglelabels value: - x: 20 - y: 30 - width: 50 height: 60 rotation: 0 values: rectanglelabels: - - Person - task: - type: integer - description: Corresponding task for this annotation - project: - type: integer - description: Project ID for this annotation - completed_by: - type: integer + - Person + width: 50 + x: 20 + y: 30 + was_cancelled: false + properties: + completed_by: description: User ID of the person who created this annotation - updated_by: type: integer - description: Last user who updated this annotation - was_cancelled: - type: boolean - description: User skipped the task ground_truth: - type: boolean description: This annotation is a Ground Truth + type: boolean lead_time: - type: number description: How much time it took to annotate the task (in seconds) example: 100.5 - required: [] - example: + type: number + project: + description: Project ID for this annotation + type: integer result: - - original_width: 1920 - original_height: 1080 - image_rotation: 0 - from_name: bboxes - to_name: image - type: rectanglelabels - value: - x: 20 - y: 30 - width: 50 - height: 60 - rotation: 0 - values: - rectanglelabels: - - Person - was_cancelled: false - ground_truth: true - security: - - Token: [] + description: Labeling result in JSON format. Read more about the format in [the Label Studio documentation.](https://labelstud.io/guide/task_format) + example: + - from_name: bboxes + image_rotation: 0 + original_height: 1080 + original_width: 1920 + to_name: image + type: rectanglelabels + value: + height: 60 + rotation: 0 + values: + rectanglelabels: + - Person + width: 50 + x: 20 + y: 30 + items: + type: object + type: array + task: + description: Corresponding task for this annotation + type: integer + updated_by: + description: Last user who updated this annotation + type: integer + was_cancelled: + description: User skipped the task + type: boolean + required: [] + type: object responses: '201': content: application/json: - schema: - $ref: '#/components/schemas/Annotation' examples: Response: + summary: response value: + completed_by: 1 + ground_truth: false id: 1 + lead_time: 10 + project: 1 result: - - original_width: 1920 - original_height: 1080 - image_rotation: 0 - from_name: bboxes - to_name: image - type: rectanglelabels - value: - x: 20 - y: 30 - width: 50 - height: 60 - rotation: 0 - values: - rectanglelabels: - - Person + - from_name: bboxes + image_rotation: 0 + original_height: 1080 + original_width: 1920 + to_name: image + type: rectanglelabels + value: + height: 60 + rotation: 0 + values: + rectanglelabels: + - Person + width: 50 + x: 20 + y: 30 task: 1 - project: 1 - completed_by: 1 updated_by: 1 was_cancelled: false - ground_truth: false - lead_time: 10 - summary: response + schema: + $ref: '#/components/schemas/Annotation' description: Created annotation + security: + - Token: [] + summary: Create annotation + tags: + - Annotations + x-fern-audiences: + - public x-fern-sdk-group-name: annotations x-fern-sdk-method-name: create - x-fern-audiences: - - public /api/token/: get: - operationId: api_token_list description: List all API tokens for the current user. - summary: List API tokens + operationId: api_token_list parameters: - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - tags: - - JWT - security: - - Token: [] + - description: Which field to use when ordering the results. + in: query + name: ordering + required: false + schema: + type: string responses: '200': content: application/json: schema: - type: array items: $ref: '#/components/schemas/LSEAPITokenList' + type: array description: '' + security: + - Token: [] + summary: List API tokens + tags: + - JWT + x-fern-audiences: + - public x-fern-sdk-group-name: tokens x-fern-sdk-method-name: list - x-fern-audiences: - - public post: - operationId: api_token_create description: Create a new API token for the current user. - summary: Create API token - tags: - - JWT - security: - - Token: [] + operationId: api_token_create responses: '201': content: @@ -14309,18 +13916,19 @@ paths: schema: $ref: '#/components/schemas/LSEAPITokenCreate' description: '' + security: + - Token: [] + summary: Create API token + tags: + - JWT + x-fern-audiences: + - public x-fern-sdk-group-name: tokens x-fern-sdk-method-name: create - x-fern-audiences: - - public /api/token/blacklist/: post: + description: Adds a JWT refresh token to the blacklist, preventing it from being used to obtain new access tokens. operationId: api_token_blacklist_create - description: Adds a JWT refresh token to the blacklist, preventing it from being - used to obtain new access tokens. - summary: Blacklist a JWT refresh token - tags: - - JWT requestBody: content: application/json: @@ -14338,29 +13946,29 @@ paths: content: application/json: schema: - type: object additionalProperties: {} description: Unspecified response body + type: object description: '' '404': content: application/json: schema: - type: object additionalProperties: {} description: Unspecified response body + type: object description: '' + summary: Blacklist a JWT refresh token + tags: + - JWT + x-fern-audiences: + - public x-fern-sdk-group-name: tokens x-fern-sdk-method-name: blacklist - x-fern-audiences: - - public /api/token/refresh/: post: - operationId: api_token_refresh_create description: Get a new access token, using a refresh token. - summary: Refresh JWT token - tags: - - JWT + operationId: api_token_refresh_create requestBody: content: application/json: @@ -14380,17 +13988,17 @@ paths: schema: $ref: '#/components/schemas/TokenRefreshResponse' description: '' + summary: Refresh JWT token + tags: + - JWT + x-fern-audiences: + - public x-fern-sdk-group-name: tokens x-fern-sdk-method-name: refresh - x-fern-audiences: - - public /api/token/rotate/: post: - operationId: api_token_rotate_create description: Creates a new JWT refresh token and blacklists the current one. - summary: Rotate JWT refresh token - tags: - - JWT + operationId: api_token_rotate_create requestBody: content: application/json: @@ -14403,8 +14011,6 @@ paths: schema: $ref: '#/components/schemas/LSAPITokenRotateRequest' required: true - security: - - Token: [] responses: '200': content: @@ -14416,84 +14022,84 @@ paths: content: application/json: schema: - type: object additionalProperties: {} description: Unspecified response body + type: object description: '' + security: + - Token: [] + summary: Rotate JWT refresh token + tags: + - JWT + x-fern-audiences: + - public x-fern-sdk-group-name: tokens x-fern-sdk-method-name: rotate - x-fern-audiences: - - public /api/users/: get: - operationId: api_users_list description: List the users that exist on the Label Studio server. - summary: List users + operationId: api_users_list parameters: - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - tags: - - Users - security: - - Token: [] + - description: Which field to use when ordering the results. + in: query + name: ordering + required: false + schema: + type: string responses: '200': content: application/json: schema: - type: array items: $ref: '#/components/schemas/LseUserAPI' + type: array description: '' + security: + - Token: [] + summary: List users + tags: + - Users + x-fern-audiences: + - public x-fern-sdk-group-name: users x-fern-sdk-method-name: list - x-fern-audiences: - - public post: - operationId: api_users_create description: Create a user in Label Studio. - summary: Create new user - tags: - - Users + operationId: api_users_create requestBody: content: application/json: schema: - type: object properties: - id: - type: integer - description: User ID - first_name: - type: string - description: First name of the user - last_name: - type: string - description: Last name of the user - username: + allow_newsletters: + description: Whether the user allows newsletters + type: boolean + avatar: + description: Avatar URL of the user type: string - description: Username of the user email: - type: string description: Email of the user - avatar: type: string - description: Avatar URL of the user - initials: + first_name: + description: First name of the user type: string + id: + description: User ID + type: integer + initials: description: Initials of the user - phone: type: string + last_name: + description: Last name of the user + type: string + phone: description: Phone number of the user - allow_newsletters: - type: boolean - description: Whether the user allows newsletters - security: - - Token: [] + type: string + username: + description: Username of the user + type: string + type: object responses: '201': content: @@ -14501,27 +14107,51 @@ paths: schema: $ref: '#/components/schemas/LseUser' description: '' + security: + - Token: [] + summary: Create new user + tags: + - Users + x-fern-audiences: + - public x-fern-sdk-group-name: users x-fern-sdk-method-name: create - x-fern-audiences: - - public /api/users/{id}/: + delete: + description: |- + Delete a specific Label Studio user. Only available in community edition. + + Use caution when deleting a user, as this can cause issues such as breaking the "Annotated by" filter or leaving orphaned records. + operationId: api_users_destroy + parameters: + - description: User ID + in: path + name: id + required: true + schema: + type: integer + responses: + '204': + description: No response body + security: + - Token: [] + summary: Delete user + tags: + - Users + x-fern-audiences: + - public + x-fern-sdk-group-name: users + x-fern-sdk-method-name: delete get: + description: Get info about a specific Label Studio user, based on the user ID. operationId: api_users_retrieve - description: Get info about a specific Label Studio user, based on the user - ID. - summary: Get user info parameters: - - in: path - name: id - schema: - type: integer - description: User ID - required: true - tags: - - Users - security: - - Token: [] + - description: User ID + in: path + name: id + required: true + schema: + type: integer responses: '200': content: @@ -14529,59 +14159,58 @@ paths: schema: $ref: '#/components/schemas/LseUser' description: '' + security: + - Token: [] + summary: Get user info + tags: + - Users + x-fern-audiences: + - public x-fern-sdk-group-name: users x-fern-sdk-method-name: get - x-fern-audiences: - - public patch: + description: "\n Update details for a specific user, such as their name or contact information, in Label Studio.\n " operationId: api_users_partial_update - description: "\n Update details for a specific user, such as their name\ - \ or contact information, in Label Studio.\n " - summary: Update user details parameters: - - in: path - name: id - schema: - type: integer - description: User ID - required: true - tags: - - Users + - description: User ID + in: path + name: id + required: true + schema: + type: integer requestBody: content: application/json: schema: - type: object properties: - id: - type: integer - description: User ID - first_name: - type: string - description: First name of the user - last_name: - type: string - description: Last name of the user - username: + allow_newsletters: + description: Whether the user allows newsletters + type: boolean + avatar: + description: Avatar URL of the user type: string - description: Username of the user email: - type: string description: Email of the user - avatar: type: string - description: Avatar URL of the user - initials: + first_name: + description: First name of the user type: string + id: + description: User ID + type: integer + initials: description: Initials of the user - phone: type: string + last_name: + description: Last name of the user + type: string + phone: description: Phone number of the user - allow_newsletters: - type: boolean - description: Whether the user allows newsletters - security: - - Token: [] + type: string + username: + description: Username of the user + type: string + type: object responses: '200': content: @@ -14589,45 +14218,19 @@ paths: schema: $ref: '#/components/schemas/LseUser' description: '' - x-fern-sdk-group-name: users - x-fern-sdk-method-name: update - x-fern-audiences: - - public - delete: - operationId: api_users_destroy - description: |- - Delete a specific Label Studio user. Only available in community edition. - - Use caution when deleting a user, as this can cause issues such as breaking the "Annotated by" filter or leaving orphaned records. - summary: Delete user - parameters: - - in: path - name: id - schema: - type: integer - description: User ID - required: true - tags: - - Users security: - - Token: [] - responses: - '204': - description: No response body - x-fern-sdk-group-name: users - x-fern-sdk-method-name: delete + - Token: [] + summary: Update user details + tags: + - Users x-fern-audiences: - - public + - public + x-fern-sdk-group-name: users + x-fern-sdk-method-name: update /api/version/: get: - operationId: api_version_retrieve description: Get version information about the Label Studio instance. - summary: Get version information - tags: - - Versions - security: - - Token: [] - - {} + operationId: api_version_retrieve responses: '200': content: @@ -14635,44 +14238,47 @@ paths: schema: $ref: '#/components/schemas/VersionResponse' description: '' + security: + - Token: [] + - {} + summary: Get version information + tags: + - Versions + x-fern-audiences: + - public x-fern-sdk-group-name: versions x-fern-sdk-method-name: get - x-fern-audiences: - - public /api/webhooks/: get: - operationId: api_webhooks_list description: List all webhooks set up for your organization. - summary: List all webhooks + operationId: api_webhooks_list parameters: - - in: query - name: project - schema: - type: string - description: Project ID - tags: - - Webhooks - security: - - Token: [] + - description: Project ID + in: query + name: project + schema: + type: string responses: '200': content: application/json: schema: - type: array items: $ref: '#/components/schemas/Webhook' + type: array description: '' + security: + - Token: [] + summary: List all webhooks + tags: + - Webhooks + x-fern-audiences: + - public x-fern-sdk-group-name: webhooks x-fern-sdk-method-name: list - x-fern-audiences: - - public post: - operationId: api_webhooks_create description: Create a webhook for your organization. - summary: Create a webhook - tags: - - Webhooks + operationId: api_webhooks_create requestBody: content: application/json: @@ -14685,8 +14291,6 @@ paths: schema: $ref: '#/components/schemas/WebhookRequest' required: true - security: - - Token: [] responses: '201': content: @@ -14694,438 +14298,434 @@ paths: schema: $ref: '#/components/schemas/Webhook' description: '' - x-fern-sdk-group-name: webhooks - x-fern-sdk-method-name: create - x-fern-audiences: - - public - /api/webhooks/{id}/: - get: - operationId: api_webhooks_retrieve - summary: Get webhook info - parameters: - - in: path - name: id - schema: - type: integer - required: true - tags: - - Webhooks - security: - - Token: [] - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Webhook' - description: '' - x-fern-sdk-group-name: webhooks - x-fern-sdk-method-name: get - x-fern-audiences: - - public - put: - operationId: api_webhooks_update - summary: Save webhook info - parameters: - - in: path - name: id - schema: - type: integer - required: true - tags: - - Webhooks - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/WebhookSerializerForUpdateRequest' - application/x-www-form-urlencoded: - schema: - $ref: '#/components/schemas/WebhookSerializerForUpdateRequest' - multipart/form-data: - schema: - $ref: '#/components/schemas/WebhookSerializerForUpdateRequest' - required: true security: - - Token: [] - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/WebhookSerializerForUpdate' - description: '' - x-fern-audiences: - - internal - patch: - operationId: api_webhooks_partial_update - summary: Update webhook info - parameters: - - in: path - name: id - schema: - type: integer - required: true + - Token: [] + summary: Create a webhook tags: - - Webhooks - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/PatchedWebhookSerializerForUpdateRequest' - application/x-www-form-urlencoded: - schema: - $ref: '#/components/schemas/PatchedWebhookSerializerForUpdateRequest' - multipart/form-data: - schema: - $ref: '#/components/schemas/PatchedWebhookSerializerForUpdateRequest' - security: - - Token: [] - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/WebhookSerializerForUpdate' - description: '' - x-fern-sdk-group-name: webhooks - x-fern-sdk-method-name: update + - Webhooks x-fern-audiences: - - public - delete: - operationId: api_webhooks_destroy - summary: Delete webhook info - parameters: - - in: path - name: id - schema: - type: integer - required: true - tags: - - Webhooks - security: - - Token: [] - responses: - '204': - description: No response body + - public x-fern-sdk-group-name: webhooks - x-fern-sdk-method-name: delete - x-fern-audiences: - - public + x-fern-sdk-method-name: create /api/webhooks/info/: get: - operationId: api_webhooks_info_retrieve description: Get descriptions of all available webhook actions to set up webhooks. - summary: Get all webhook actions + operationId: api_webhooks_info_retrieve parameters: - - in: query - name: organization-only - schema: - type: boolean - description: organization-only or not - tags: - - Webhooks - security: - - Token: [] - - {} + - description: organization-only or not + in: query + name: organization-only + schema: + type: boolean responses: '200': content: application/json: schema: - type: object properties: - PROJECT_CREATED: - type: object + ANNOTATIONS_CREATED: properties: - name: - type: string description: type: string key: type: string + name: + type: string organization-only: type: boolean required: - - name - - description - - key - - organization-only - PROJECT_UPDATED: + - name + - description + - key + - organization-only type: object + ANNOTATIONS_DELETED: properties: - name: - type: string description: type: string key: type: string + name: + type: string organization-only: type: boolean required: - - name - - description - - key - - organization-only - PROJECT_DELETED: + - name + - description + - key + - organization-only type: object + ANNOTATION_CREATED: properties: - name: - type: string description: type: string key: type: string + name: + type: string organization-only: type: boolean required: - - name - - description - - key - - organization-only - TASKS_CREATED: + - name + - description + - key + - organization-only type: object + ANNOTATION_UPDATED: properties: - name: - type: string description: type: string key: type: string + name: + type: string organization-only: type: boolean required: - - name - - description - - key - - organization-only - TASKS_DELETED: + - name + - description + - key + - organization-only type: object + LABEL_LINK_CREATED: properties: - name: - type: string description: type: string key: type: string + name: + type: string organization-only: type: boolean required: - - name - - description - - key - - organization-only - ANNOTATION_CREATED: + - name + - description + - key + - organization-only type: object + LABEL_LINK_DELETED: properties: - name: - type: string description: type: string key: type: string + name: + type: string organization-only: type: boolean required: - - name - - description - - key - - organization-only - ANNOTATIONS_CREATED: + - name + - description + - key + - organization-only type: object + LABEL_LINK_UPDATED: properties: - name: - type: string description: type: string key: type: string + name: + type: string organization-only: type: boolean required: - - name - - description - - key - - organization-only - ANNOTATION_UPDATED: + - name + - description + - key + - organization-only type: object + PROJECT_CREATED: properties: - name: - type: string description: type: string key: type: string + name: + type: string organization-only: type: boolean required: - - name - - description - - key - - organization-only - ANNOTATIONS_DELETED: + - name + - description + - key + - organization-only type: object + PROJECT_DELETED: properties: - name: - type: string description: type: string key: type: string + name: + type: string organization-only: type: boolean required: - - name - - description - - key - - organization-only - LABEL_LINK_CREATED: + - name + - description + - key + - organization-only type: object + PROJECT_UPDATED: properties: - name: - type: string description: type: string key: type: string + name: + type: string organization-only: type: boolean required: - - name - - description - - key - - organization-only - LABEL_LINK_UPDATED: + - name + - description + - key + - organization-only type: object + REVIEWS_DELETED: properties: - name: - type: string description: type: string key: type: string + name: + type: string organization-only: type: boolean required: - - name - - description - - key - - organization-only - LABEL_LINK_DELETED: + - name + - description + - key + - organization-only type: object + REVIEW_CREATED: properties: - name: - type: string description: type: string key: type: string - organization-only: + name: + type: string + organization-only: type: boolean required: - - name - - description - - key - - organization-only - REVIEW_CREATED: + - name + - description + - key + - organization-only type: object + REVIEW_UPDATED: properties: - name: - type: string description: type: string key: type: string + name: + type: string organization-only: type: boolean required: - - name - - description - - key - - organization-only - REVIEW_UPDATED: + - name + - description + - key + - organization-only type: object + TASKS_CREATED: properties: - name: - type: string description: type: string key: type: string + name: + type: string organization-only: type: boolean required: - - name - - description - - key - - organization-only - REVIEWS_DELETED: + - name + - description + - key + - organization-only type: object + TASKS_DELETED: properties: - name: - type: string description: type: string key: type: string + name: + type: string organization-only: type: boolean required: - - name - - description - - key - - organization-only + - name + - description + - key + - organization-only + type: object + type: object description: Object with webhook action descriptions. + security: + - Token: [] + - {} + summary: Get all webhook actions + tags: + - Webhooks + x-fern-audiences: + - public x-fern-sdk-group-name: webhooks x-fern-sdk-method-name: info + /api/webhooks/{id}/: + delete: + operationId: api_webhooks_destroy + parameters: + - in: path + name: id + required: true + schema: + type: integer + responses: + '204': + description: No response body + security: + - Token: [] + summary: Delete webhook info + tags: + - Webhooks x-fern-audiences: - - public - /api/workspaces/: + - public + x-fern-sdk-group-name: webhooks + x-fern-sdk-method-name: delete get: - operationId: api_workspaces_list - description: List all workspaces for your organization. Workspaces in Label - Studio let you organize your projects and users into separate spaces. This - is useful for managing different teams, departments, or projects within your - organization. For more information, see the [Workspaces documentation](https://docs.humansignal.com/workspaces). - summary: List workspaces + operationId: api_webhooks_retrieve parameters: - - in: query - name: is_personal - schema: - type: boolean - description: Workspace is a personal user workspace. - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string + - in: path + name: id + required: true + schema: + type: integer + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Webhook' + description: '' + security: + - Token: [] + summary: Get webhook info + tags: + - Webhooks + x-fern-audiences: + - public + x-fern-sdk-group-name: webhooks + x-fern-sdk-method-name: get + patch: + operationId: api_webhooks_partial_update + parameters: + - in: path + name: id + required: true + schema: + type: integer + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedWebhookSerializerForUpdateRequest' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/PatchedWebhookSerializerForUpdateRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedWebhookSerializerForUpdateRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/WebhookSerializerForUpdate' + description: '' + security: + - Token: [] + summary: Update webhook info tags: - - Workspaces + - Webhooks + x-fern-audiences: + - public + x-fern-sdk-group-name: webhooks + x-fern-sdk-method-name: update + put: + operationId: api_webhooks_update + parameters: + - in: path + name: id + required: true + schema: + type: integer + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WebhookSerializerForUpdateRequest' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/WebhookSerializerForUpdateRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/WebhookSerializerForUpdateRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/WebhookSerializerForUpdate' + description: '' security: - - Token: [] + - Token: [] + summary: Save webhook info + tags: + - Webhooks + x-fern-audiences: + - internal + /api/workspaces/: + get: + description: List all workspaces for your organization. Workspaces in Label Studio let you organize your projects and users into separate spaces. This is useful for managing different teams, departments, or projects within your organization. For more information, see the [Workspaces documentation](https://docs.humansignal.com/workspaces). + operationId: api_workspaces_list + parameters: + - description: Workspace is a personal user workspace. + in: query + name: is_personal + schema: + type: boolean + - description: Which field to use when ordering the results. + in: query + name: ordering + required: false + schema: + type: string responses: '200': content: application/json: schema: - type: array items: $ref: '#/components/schemas/Workspace' + type: array description: '' + security: + - Token: [] + summary: List workspaces + tags: + - Workspaces + x-fern-audiences: + - public x-fern-sdk-group-name: workspaces x-fern-sdk-method-name: list - x-fern-audiences: - - public post: + description: Create a new workspace. Workspaces in Label Studio let you organize your projects and users into separate spaces. This is useful for managing different teams, departments, or projects within your organization. For more information, see the [Workspaces documentation](https://docs.humansignal.com/workspaces). operationId: api_workspaces_create - description: Create a new workspace. Workspaces in Label Studio let you organize - your projects and users into separate spaces. This is useful for managing - different teams, departments, or projects within your organization. For more - information, see the [Workspaces documentation](https://docs.humansignal.com/workspaces). - summary: Create workspace - tags: - - Workspaces requestBody: content: application/json: @@ -15138,8 +14738,6 @@ paths: schema: $ref: '#/components/schemas/WorkspaceRequest' required: true - security: - - Token: [] responses: '201': content: @@ -15147,25 +14745,46 @@ paths: schema: $ref: '#/components/schemas/Workspace' description: '' + security: + - Token: [] + summary: Create workspace + tags: + - Workspaces + x-fern-audiences: + - public x-fern-sdk-group-name: workspaces x-fern-sdk-method-name: create - x-fern-audiences: - - public /api/workspaces/{id}/: + delete: + description: Delete a specific workspace by ID. + operationId: api_workspaces_destroy + parameters: + - in: path + name: id + required: true + schema: + type: integer + responses: + '204': + description: No response body + security: + - Token: [] + summary: Delete workspace + tags: + - Workspaces + x-fern-audiences: + - public + x-fern-sdk-group-name: workspaces + x-fern-sdk-method-name: delete get: - operationId: api_workspaces_retrieve description: Retrieve details for a specific workspace by ID. - summary: Get workspace + operationId: api_workspaces_retrieve parameters: - - in: path - name: id - schema: - type: integer - required: true - tags: - - Workspaces - security: - - Token: [] + - in: path + name: id + required: true + schema: + type: integer responses: '200': content: @@ -15173,22 +14792,24 @@ paths: schema: $ref: '#/components/schemas/Workspace' description: '' + security: + - Token: [] + summary: Get workspace + tags: + - Workspaces + x-fern-audiences: + - public x-fern-sdk-group-name: workspaces x-fern-sdk-method-name: get - x-fern-audiences: - - public patch: - operationId: api_workspaces_partial_update description: Update settings for a specific workspace by ID. - summary: Update workspace + operationId: api_workspaces_partial_update parameters: - - in: path - name: id - schema: - type: integer - required: true - tags: - - Workspaces + - in: path + name: id + required: true + schema: + type: integer requestBody: content: application/json: @@ -15200,8 +14821,6 @@ paths: multipart/form-data: schema: $ref: '#/components/schemas/PatchedWorkspaceRequest' - security: - - Token: [] responses: '200': content: @@ -15209,73 +14828,77 @@ paths: schema: $ref: '#/components/schemas/Workspace' description: '' + security: + - Token: [] + summary: Update workspace + tags: + - Workspaces + x-fern-audiences: + - public x-fern-sdk-group-name: workspaces x-fern-sdk-method-name: update - x-fern-audiences: - - public + /api/workspaces/{id}/memberships/: delete: - operationId: api_workspaces_destroy - description: Delete a specific workspace by ID. - summary: Delete workspace + description: 'Remove a specific member by ID from a workspace. This endpoint expects an object like `{"user_id": 123}`.' + operationId: api_workspaces_memberships_destroy parameters: - - in: path - name: id - schema: - type: integer - required: true - tags: - - Workspaces - security: - - Token: [] + - in: path + name: id + required: true + schema: + type: integer responses: '204': description: No response body - x-fern-sdk-group-name: workspaces - x-fern-sdk-method-name: delete + security: + - Token: [] + summary: Delete workspace membership + tags: + - Workspaces x-fern-audiences: - - public - /api/workspaces/{id}/memberships/: + - public + x-fern-sdk-group-name: + - workspaces + - members + x-fern-sdk-method-name: delete get: - operationId: api_workspaces_memberships_retrieve description: Get a list of all members in a specific workspace. - summary: List workspace memberships + operationId: api_workspaces_memberships_retrieve parameters: - - in: path - name: id - schema: - type: integer - required: true - tags: - - Workspaces - security: - - Token: [] + - in: path + name: id + required: true + schema: + type: integer responses: '200': content: application/json: schema: - type: array items: $ref: '#/components/schemas/WorkspaceMemberList' + type: array description: A list of workspace memberships + security: + - Token: [] + summary: List workspace memberships + tags: + - Workspaces + x-fern-audiences: + - public x-fern-sdk-group-name: - - workspaces - - members + - workspaces + - members x-fern-sdk-method-name: list - x-fern-audiences: - - public post: - operationId: api_workspaces_memberships_create description: Add a new workspace member by user ID. - summary: Create workspace membership + operationId: api_workspaces_memberships_create parameters: - - in: path - name: id - schema: - type: integer - required: true - tags: - - Workspaces + - in: path + name: id + required: true + schema: + type: integer requestBody: content: application/json: @@ -15288,8 +14911,6 @@ paths: schema: $ref: '#/components/schemas/WorkspaceMemberCreateRequest' required: true - security: - - Token: [] responses: '200': content: @@ -15297,51 +14918,44 @@ paths: schema: $ref: '#/components/schemas/WorkspaceMemberCreate' description: '' + security: + - Token: [] + summary: Create workspace membership + tags: + - Workspaces + x-fern-audiences: + - public x-fern-sdk-group-name: - - workspaces - - members + - workspaces + - members x-fern-sdk-method-name: create - x-fern-audiences: - - public + /api/workspaces/{id}/projects/: delete: - operationId: api_workspaces_memberships_destroy - description: 'Remove a specific member by ID from a workspace. This endpoint - expects an object like `{"user_id": 123}`.' - summary: Delete workspace membership + description: Delete projects from a specific workspace. + operationId: api_workspaces_projects_destroy parameters: - - in: path - name: id - schema: - type: integer - required: true - tags: - - Workspaces - security: - - Token: [] + - in: path + name: id + required: true + schema: + type: integer responses: '204': description: No response body - x-fern-sdk-group-name: - - workspaces - - members - x-fern-sdk-method-name: delete - x-fern-audiences: - - public - /api/workspaces/{id}/projects/: + security: + - Token: [] + summary: Remove workspace projects + tags: + - Workspaces get: - operationId: api_workspaces_projects_retrieve description: Retrieve a list of all projects in a specific workspace. - summary: List workspace projects + operationId: api_workspaces_projects_retrieve parameters: - - in: path - name: id - schema: - type: integer - required: true - tags: - - Workspaces - security: - - Token: [] + - in: path + name: id + required: true + schema: + type: integer responses: '200': content: @@ -15349,18 +14963,20 @@ paths: schema: $ref: '#/components/schemas/Project' description: '' + security: + - Token: [] + summary: List workspace projects + tags: + - Workspaces post: - operationId: api_workspaces_projects_create description: Create a project in a specific workspace. - summary: Create workspace project + operationId: api_workspaces_projects_create parameters: - - in: path - name: id - schema: - type: integer - required: true - tags: - - Workspaces + - in: path + name: id + required: true + schema: + type: integer requestBody: content: application/json: @@ -15372,8 +14988,6 @@ paths: multipart/form-data: schema: $ref: '#/components/schemas/ProjectRequest' - security: - - Token: [] responses: '200': content: @@ -15381,61 +14995,37 @@ paths: schema: $ref: '#/components/schemas/Project' description: '' - delete: - operationId: api_workspaces_projects_destroy - description: Delete projects from a specific workspace. - summary: Remove workspace projects - parameters: - - in: path - name: id - schema: - type: integer - required: true - tags: - - Workspaces security: - - Token: [] - responses: - '204': - description: No response body + - Token: [] + summary: Create workspace project + tags: + - Workspaces /data/upload/{filename}: get: - operationId: data_upload_retrieve description: Download a specific uploaded file. - summary: Download file + operationId: data_upload_retrieve parameters: - - in: path - name: filename - schema: - type: string - required: true - tags: - - Import - security: - - Token: [] + - in: path + name: filename + required: true + schema: + type: string responses: '200': description: File downloaded successfully + security: + - Token: [] + summary: Download file + tags: + - Import + x-fern-audiences: + - public x-fern-sdk-group-name: - - files + - files x-fern-sdk-method-name: download - x-fern-audiences: - - public components: schemas: ActionEnum: - enum: - - prediction - - propagated_annotation - - imported - - submitted - - updated - - skipped - - accepted - - rejected - - fixed_and_accepted - - deleted_review - type: string description: |- * `prediction` - Created from prediction * `propagated_annotation` - Created from another annotation @@ -15447,24 +15037,19 @@ components: * `rejected` - Rejected * `fixed_and_accepted` - Fixed and accepted * `deleted_review` - Deleted review - 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 + - prediction + - propagated_annotation + - imported + - submitted + - updated + - skipped + - accepted + - rejected + - fixed_and_accepted + - deleted_review type: string + ActionsEnum: description: |- * `PROJECT_CREATED` - PROJECT_CREATED * `PROJECT_UPDATED` - PROJECT_UPDATED @@ -15481,467 +15066,452 @@ components: * `REVIEW_CREATED` - REVIEW_CREATED * `REVIEW_UPDATED` - REVIEW_UPDATED * `REVIEWS_DELETED` - REVIEWS_DELETED + 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 + type: string ActivityLog: - type: object properties: - id: - type: integer + datetime: + format: date-time readOnly: true - user_id: - type: integer + type: string + duration: + description: Duration of response generation in ms maximum: 2147483647 minimum: -2147483648 + nullable: true + type: integer email: - type: string maxLength: 256 - user_agent: type: string - maxLength: 1024 + extra_data: + nullable: true http_referer: - type: string maxLength: 1024 - request_url: - type: string - title: Url - maxLength: 256 - request_method: - type: string - title: Http method - maxLength: 10 - response_code: - type: string - maxLength: 3 - datetime: type: string - format: date-time + id: readOnly: true + type: integer ip_address: - type: string nullable: true title: IP - extra_data: - nullable: true - duration: - type: integer + type: string + organization_id: + description: Organization id maximum: 2147483647 minimum: -2147483648 nullable: true - description: Duration of response generation in ms - project_id: + title: Active organization id type: integer + project_id: + description: Project id if request has it maximum: 2147483647 minimum: -2147483648 nullable: true - description: Project id if request has it - workspace_owner_id: type: integer + request_method: + maxLength: 10 + title: Http method + type: string + request_url: + maxLength: 256 + title: Url + type: string + response_code: + maxLength: 3 + type: string + user_agent: + maxLength: 1024 + type: string + user_id: maximum: 2147483647 minimum: -2147483648 - nullable: true - description: Owner id of workspace where action performed - organization_id: type: integer + workspace_owner_id: + description: Owner id of workspace where action performed maximum: 2147483647 minimum: -2147483648 nullable: true - title: Active organization id - description: Organization id + type: integer required: - - datetime - - email - - id - - request_method - - request_url - - response_code - - user_id - ActivityLogResponse: + - datetime + - email + - id + - request_method + - request_url + - response_code + - user_id type: object + ActivityLogResponse: description: Serializer for ActivityLogAPI response. properties: data: - type: array items: $ref: '#/components/schemas/ActivityLog' - recordsTotal: - type: integer + type: array recordsFiltered: type: integer + recordsTotal: + type: integer required: - - data - - recordsFiltered - - recordsTotal - AllRolesProjectList: + - data + - recordsFiltered + - recordsTotal type: object + AllRolesProjectList: description: |- Serializer get numbers from project queryset annotation, make sure, that you use correct one(Project.objects.with_counts()) properties: - workspace_title: - type: string + allow_stream: readOnly: true - ready: type: string - readOnly: true - overlap_cohort_percentage: + annotation_limit_count: + minimum: 1 + nullable: true type: integer - maximum: 2147483647 - minimum: -2147483648 - queue_left: - type: string - readOnly: true - config_suitable_for_bulk_annotation: - type: boolean - readOnly: true - description: Flag to detect is project ready for bulk annotation - has_blueprints: + annotation_limit_percent: + format: decimal + nullable: true + pattern: ^-?\d{0,3}(?:\.\d{0,2})?$ type: string - readOnly: true - show_overlap_first: - type: boolean - queue_total: + annotator_evaluation_minimum_score: + default: '95.00' + format: decimal + nullable: true + pattern: ^-?\d{0,3}(?:\.\d{0,2})?$ type: string - readOnly: true - enable_empty_annotation: - type: boolean - description: Allow annotators to submit empty annotations - custom_task_lock_ttl: + annotator_evaluation_minimum_tasks: + default: 10 + minimum: 0 + nullable: true type: integer - maximum: 86400 - minimum: 1 + assignment_settings: + $ref: '#/components/schemas/AssignmentSettings' + blueprints: + items: + $ref: '#/components/schemas/BlueprintList' + readOnly: true + type: array + color: + maxLength: 16 nullable: true - description: TTL in seconds for task reservations, on new and existing tasks - prompts: type: string + comment_classification_config: + type: string + config_has_control_tags: + description: Flag to detect is project ready for labeling readOnly: true - start_training_on_annotation_update: type: boolean + config_suitable_for_bulk_annotation: + description: Flag to detect is project ready for bulk annotation 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: - type: string - nullable: true - maxLength: 16 - sampling: + control_weights: + 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}' nullable: true - oneOf: - - $ref: '#/components/schemas/SamplingEnum' - - $ref: '#/components/schemas/NullEnum' + created_at: + format: date-time + readOnly: true + type: string created_by: allOf: - - $ref: '#/components/schemas/UserSimple' + - $ref: '#/components/schemas/UserSimple' description: Project owner - reveal_preannotations_interactively: - type: boolean - description: Reveal pre-annotations interactively - pinned_at: + custom_script: type: string - format: date-time + custom_task_lock_ttl: + description: TTL in seconds for task reservations, on new and existing tasks + maximum: 86400 + minimum: 1 nullable: true - description: Pinned date and time - finished_task_number: type: integer + data_types: + nullable: true readOnly: true - parsed_label_config: + description: + description: Project description + nullable: true + type: string + description_short: readOnly: true - description: JSON-formatted labeling configuration + type: string duplication_done: - type: boolean default: false - reviewer_queue_total: + type: boolean + duplication_status: type: string - readOnly: true - show_ground_truth_first: + enable_empty_annotation: + description: Allow annotators to submit empty annotations type: boolean - task_number: - type: integer - readOnly: true - description: Total task number in project - num_tasks_with_annotations: + evaluate_predictions_automatically: + description: Retrieve and display predictions when loading a task + type: boolean + expert_instruction: + description: Labeling instructions in HTML format + nullable: true type: string + finished_task_number: readOnly: true - description_short: - type: string + type: integer + ground_truth_number: + description: Honeypot annotation number in project readOnly: true - id: type: integer + has_blueprints: readOnly: true - allow_stream: type: string + id: readOnly: true - annotation_limit_percent: - type: string - format: decimal - pattern: ^-?\d{0,3}(?:\.\d{0,2})?$ + type: integer + is_draft: + description: Whether or not the project is in the middle of being created + type: boolean + is_published: + description: Whether or not the project is published to annotators + title: Published + type: boolean + label_config: + description: Label config in XML format. See more about it in documentation nullable: true - created_at: type: string - format: date-time + maximum_annotations: + 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) + maximum: 2147483647 + minimum: -2147483648 + title: Maximum annotation number + type: integer + members: + readOnly: true + type: string + members_count: readOnly: true - annotation_limit_count: type: integer - minimum: 1 + min_annotations_to_start_training: + description: Minimum number of completed tasks after which model training is started + maximum: 2147483647 + minimum: -2147483648 + type: integer + model_version: + description: Machine learning model version nullable: true - queue_done: type: string + num_tasks_with_annotations: readOnly: true - control_weights: + type: string + organization: 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: + type: integer + overlap_cohort_percentage: + maximum: 2147483647 + minimum: -2147483648 + type: integer + parsed_label_config: + description: JSON-formatted labeling configuration readOnly: true + pause_on_failed_annotator_evaluation: + default: false + nullable: true + type: boolean + pinned_at: + description: Pinned date and time + format: date-time nullable: true - reviewed_number: type: string + prompts: readOnly: true - total_annotations_number: type: string + queue_done: readOnly: true - total_predictions_number: - type: integer - readOnly: true - config_has_control_tags: - type: boolean + type: string + queue_left: readOnly: true - description: Flag to detect is project ready for labeling - blueprints: - type: array - items: - $ref: '#/components/schemas/BlueprintList' + type: string + queue_total: readOnly: true - is_published: - type: boolean - title: Published - description: Whether or not the project is published to annotators - duplication_status: type: string - review_total_tasks: + ready: + readOnly: true type: string + rejected: readOnly: true - 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 - title: type: string - nullable: true - description: Project name. Must be between 3 and 50 characters long. - maxLength: 50 - minLength: 3 - show_collab_predictions: + require_comment_on_skip: + default: false type: boolean - title: Show predictions to annotator - description: If set, the annotator can view model predictions - members: - type: string + reveal_preannotations_interactively: + description: Reveal pre-annotations interactively + type: boolean + review_settings: + $ref: '#/components/schemas/ReviewSettings' + review_total_tasks: 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: type: string + reviewed_number: readOnly: true - organization: - type: integer - nullable: true - assignment_settings: - $ref: '#/components/schemas/AssignmentSettings' - annotator_evaluation_minimum_tasks: - type: integer - minimum: 0 - nullable: true - default: 10 - skipped_annotations_number: type: string + reviewer_queue_total: 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 + sampling: nullable: true - description: Labeling instructions in HTML format + oneOf: + - $ref: '#/components/schemas/SamplingEnum' + - $ref: '#/components/schemas/NullEnum' show_annotation_history: - type: boolean description: Show annotation history to annotator + type: boolean + show_collab_predictions: + description: If set, the annotator can view model predictions + title: Show predictions to annotator + type: boolean + show_ground_truth_first: + type: boolean + show_instruction: + description: Show instructions to the annotator before they start + type: boolean + show_overlap_first: + type: boolean + show_skip_button: + description: Show a skip button in interface and allow annotators to skip the task + type: boolean skip_queue: nullable: true oneOf: - - $ref: '#/components/schemas/SkipQueueEnum' - - $ref: '#/components/schemas/NullEnum' - review_settings: - $ref: '#/components/schemas/ReviewSettings' - members_count: - type: string + - $ref: '#/components/schemas/SkipQueueEnum' + - $ref: '#/components/schemas/NullEnum' + skipped_annotations_number: readOnly: true - model_version: type: string + start_training_on_annotation_update: + description: Start model training after any annotations are submitted or updated + readOnly: true + type: boolean + task_number: + description: Total task number in project + readOnly: true + type: integer + title: + description: Project name. Must be between 3 and 50 characters long. + maxLength: 50 + minLength: 3 nullable: true - description: Machine learning model version - useful_annotation_number: type: string + total_annotations_number: readOnly: true - custom_script: type: string - require_comment_on_skip: - type: boolean - default: false - ground_truth_number: + total_predictions_number: + readOnly: true type: integer + useful_annotation_number: 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: + workspace: + readOnly: true type: string + workspace_title: readOnly: true + type: string required: - - allow_stream - - assignment_settings - - blueprints - - config_has_control_tags - - config_suitable_for_bulk_annotation - - created_at - - data_types - - description_short - - finished_task_number - - ground_truth_number - - has_blueprints - - id - - members - - members_count - - num_tasks_with_annotations - - parsed_label_config - - prompts - - queue_done - - queue_left - - queue_total - - ready - - rejected - - review_settings - - review_total_tasks - - reviewed_number - - reviewer_queue_total - - skipped_annotations_number - - start_training_on_annotation_update - - task_number - - total_annotations_number - - total_predictions_number - - useful_annotation_number - - workspace - - workspace_title + - allow_stream + - assignment_settings + - blueprints + - config_has_control_tags + - config_suitable_for_bulk_annotation + - created_at + - data_types + - description_short + - finished_task_number + - ground_truth_number + - has_blueprints + - id + - members + - members_count + - num_tasks_with_annotations + - parsed_label_config + - prompts + - queue_done + - queue_left + - queue_total + - ready + - rejected + - review_settings + - review_total_tasks + - reviewed_number + - reviewer_queue_total + - skipped_annotations_number + - start_training_on_annotation_update + - task_number + - total_annotations_number + - total_predictions_number + - useful_annotation_number + - workspace + - workspace_title + type: object AnnotatedEnum: - enum: - - only - - exclude description: |- * `only` - only * `exclude` - exclude * `None` - None + enum: + - only + - exclude Annotation: - type: object properties: - id: + bulk_created: + description: Annotation was created in bulk mode + nullable: true + type: boolean + completed_by: type: integer - readOnly: true - result: - type: array - title: Annotation result list - description: List of annotation results for the task - items: - type: object - title: Annotation result items (regions) - description: List of annotated regions for the task - created_username: - type: string - readOnly: true - default: '' - description: Username string created_ago: - type: string - readOnly: true default: '' description: Time delta from creation time - completed_by: - type: integer - was_cancelled: - type: boolean - description: User skipped the task - ground_truth: - type: boolean - description: This annotation is a Ground Truth (ground_truth) - created_at: + readOnly: true type: string + created_at: + description: Creation time format: date-time readOnly: true - description: Creation time - updated_at: type: string - format: date-time + created_username: + default: '' + description: Username string readOnly: true - description: Last updated time - draft_created_at: type: string - format: date-time - nullable: true + draft_created_at: description: Draft creation time - lead_time: - type: number - format: double + format: date-time nullable: true - description: How much time it took to annotate the task - import_id: + type: string + ground_truth: + description: This annotation is a Ground Truth (ground_truth) + type: boolean + id: + readOnly: true type: integer + import_id: + description: Original annotation ID that was at the import step or NULL if this annotation wasn't imported + format: int64 maximum: 9223372036854775807 minimum: -9223372036854775808 - format: int64 nullable: true - description: Original annotation ID that was at the import step or NULL - if this annotation wasn't imported + type: integer last_action: - nullable: true description: |- Action which was performed in the last annotation history item @@ -15955,95 +15525,86 @@ components: * `rejected` - Rejected * `fixed_and_accepted` - Fixed and accepted * `deleted_review` - Deleted review + nullable: true oneOf: - - $ref: '#/components/schemas/LastActionEnum' - - $ref: '#/components/schemas/NullEnum' - bulk_created: - type: boolean + - $ref: '#/components/schemas/LastActionEnum' + - $ref: '#/components/schemas/NullEnum' + last_created_by: + description: User who created the last annotation history item nullable: true - description: Annotation was created in bulk mode - task: - type: integer - nullable: true - description: Corresponding task for this annotation - project: type: integer + lead_time: + description: How much time it took to annotate the task + format: double nullable: true - description: Project ID for this annotation - updated_by: - type: integer + type: number + parent_annotation: + description: Points to the parent annotation from which this annotation was created nullable: true - description: Last user who updated this annotation - parent_prediction: type: integer - nullable: true + parent_prediction: description: Points to the prediction from which this annotation was created - parent_annotation: - type: integer nullable: true - description: Points to the parent annotation from which this annotation - was created - last_created_by: type: integer + project: + description: Project ID for this annotation nullable: true - description: User who created the last annotation history item - required: - - created_ago - - created_at - - created_username - - id - - updated_at - AnnotationBulkSerializerWithSelectedItemsRequest: - type: object - properties: + type: integer result: - type: array - title: Annotation result list description: List of annotation results for the task items: - type: object - title: Annotation result items (regions) description: List of annotated regions for the task - completed_by: + title: Annotation result items (regions) + type: object + title: Annotation result list + type: array + task: + description: Corresponding task for this annotation + nullable: true type: integer - unique_id: + updated_at: + description: Last updated time + format: date-time + readOnly: true type: string - writeOnly: true - minLength: 1 - tasks: - type: array - items: - type: integer - selected_items: - allOf: - - $ref: '#/components/schemas/SelectedItemsRequest' + updated_by: + description: Last user who updated this annotation nullable: true + type: integer was_cancelled: - type: boolean description: User skipped the task - ground_truth: type: boolean - description: This annotation is a Ground Truth (ground_truth) - draft_created_at: - type: string - format: date-time + required: + - created_ago + - created_at + - created_username + - id + - updated_at + type: object + AnnotationBulkSerializerWithSelectedItemsRequest: + properties: + bulk_created: + description: Annotation was created in bulk mode nullable: true + type: boolean + completed_by: + type: integer + draft_created_at: description: Draft creation time - lead_time: - type: number - format: double + format: date-time nullable: true - description: How much time it took to annotate the task + type: string + ground_truth: + description: This annotation is a Ground Truth (ground_truth) + type: boolean import_id: - type: integer + description: Original annotation ID that was at the import step or NULL if this annotation wasn't imported + format: int64 maximum: 9223372036854775807 minimum: -9223372036854775808 - format: int64 nullable: true - description: Original annotation ID that was at the import step or NULL - if this annotation wasn't imported + type: integer last_action: - nullable: true description: |- Action which was performed in the last annotation history item @@ -16057,171 +15618,176 @@ components: * `rejected` - Rejected * `fixed_and_accepted` - Fixed and accepted * `deleted_review` - Deleted review + nullable: true oneOf: - - $ref: '#/components/schemas/LastActionEnum' - - $ref: '#/components/schemas/NullEnum' - bulk_created: - type: boolean + - $ref: '#/components/schemas/LastActionEnum' + - $ref: '#/components/schemas/NullEnum' + last_created_by: + description: User who created the last annotation history item nullable: true - description: Annotation was created in bulk mode - task: type: integer + lead_time: + description: How much time it took to annotate the task + format: double nullable: true - description: Corresponding task for this annotation - project: - type: integer + type: number + parent_annotation: + description: Points to the parent annotation from which this annotation was created nullable: true - description: Project ID for this annotation - updated_by: type: integer - nullable: true - description: Last user who updated this annotation parent_prediction: + description: Points to the prediction from which this annotation was created + nullable: true type: integer + project: + description: Project ID for this annotation nullable: true - description: Points to the prediction from which this annotation was created - parent_annotation: type: integer + result: + description: List of annotation results for the task + items: + description: List of annotated regions for the task + title: Annotation result items (regions) + type: object + title: Annotation result list + type: array + selected_items: + allOf: + - $ref: '#/components/schemas/SelectedItemsRequest' + nullable: true + task: + description: Corresponding task for this annotation nullable: true - description: Points to the parent annotation from which this annotation - was created - last_created_by: type: integer + tasks: + items: + type: integer + type: array + unique_id: + minLength: 1 + type: string + writeOnly: true + updated_by: + description: Last user who updated this annotation nullable: true - description: User who created the last annotation history item - AnnotationHistory: + type: integer + was_cancelled: + description: User skipped the task + type: boolean type: object + AnnotationHistory: description: |- 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: - type: integer - readOnly: true - comment: - type: string - readOnly: true + action: nullable: true - organization_id: - type: integer + oneOf: + - $ref: '#/components/schemas/ActionEnum' + - $ref: '#/components/schemas/NullEnum' + annotation_id: + description: Corresponding annotation for this historical annotation maximum: 2147483647 minimum: -2147483648 nullable: true - description: Organization for this annotation history - project_id: type: integer + comment: + nullable: true + readOnly: true + type: string + comment_id: + description: Comment id sent with result maximum: 2147483647 minimum: -2147483648 nullable: true - description: Project for this annotation history - annotation_id: type: integer + created_at: + format: date-time + readOnly: true + type: string + created_by: + description: Created by user id maximum: 2147483647 minimum: -2147483648 nullable: true - description: Corresponding annotation for this historical annotation - draft_id: type: integer + draft_id: + description: Corresponding draft for this historical annotation maximum: 2147483647 minimum: -2147483648 nullable: true - description: Corresponding draft for this historical annotation - review_id: type: integer + id: + readOnly: true + type: integer + lead_time: + description: How much time it took to annotate the task + format: double + nullable: true + type: number + organization_id: + description: Organization for this annotation history maximum: 2147483647 minimum: -2147483648 nullable: true - description: AnnotationReview ID, using with review field - task_id: type: integer + project_id: + description: Project for this annotation history maximum: 2147483647 minimum: -2147483648 nullable: true - description: Task id + type: integer result: - nullable: true description: Labeling result - lead_time: - type: number - format: double nullable: true - description: How much time it took to annotate the task - action: + review_id: + description: AnnotationReview ID, using with review field + maximum: 2147483647 + minimum: -2147483648 nullable: true - oneOf: - - $ref: '#/components/schemas/ActionEnum' - - $ref: '#/components/schemas/NullEnum' + type: integer started_at: - type: string + description: The time that a user started working on this revision of the annotation format: date-time nullable: true - description: The time that a user started working on this revision of the - annotation - created_at: type: string - format: date-time - readOnly: true - created_by: - type: integer + task_id: + description: Task id maximum: 2147483647 minimum: -2147483648 nullable: true - description: Created by user id - comment_id: type: integer - maximum: 2147483647 - minimum: -2147483648 - nullable: true - description: Comment id sent with result required: - - comment - - created_at - - id - AnnotationRequest: + - comment + - created_at + - id type: object + AnnotationRequest: properties: - result: - type: array - title: Annotation result list - description: List of annotation results for the task - items: - type: object - title: Annotation result items (regions) - description: List of annotated regions for the task + bulk_created: + description: Annotation was created in bulk mode + nullable: true + type: boolean completed_by: type: integer - unique_id: - type: string - writeOnly: true - minLength: 1 - was_cancelled: - type: boolean - description: User skipped the task - ground_truth: - type: boolean - description: This annotation is a Ground Truth (ground_truth) draft_created_at: - type: string - format: date-time - nullable: true description: Draft creation time - lead_time: - type: number - format: double + format: date-time nullable: true - description: How much time it took to annotate the task + type: string + ground_truth: + description: This annotation is a Ground Truth (ground_truth) + type: boolean import_id: - type: integer + description: Original annotation ID that was at the import step or NULL if this annotation wasn't imported + format: int64 maximum: 9223372036854775807 minimum: -9223372036854775808 - format: int64 nullable: true - description: Original annotation ID that was at the import step or NULL - if this annotation wasn't imported + type: integer last_action: - nullable: true description: |- Action which was performed in the last annotation history item @@ -16235,95 +15801,111 @@ components: * `rejected` - Rejected * `fixed_and_accepted` - Fixed and accepted * `deleted_review` - Deleted review + nullable: true oneOf: - - $ref: '#/components/schemas/LastActionEnum' - - $ref: '#/components/schemas/NullEnum' - bulk_created: - type: boolean + - $ref: '#/components/schemas/LastActionEnum' + - $ref: '#/components/schemas/NullEnum' + last_created_by: + description: User who created the last annotation history item nullable: true - description: Annotation was created in bulk mode - task: type: integer + lead_time: + description: How much time it took to annotate the task + format: double nullable: true - description: Corresponding task for this annotation - project: - type: integer + type: number + parent_annotation: + description: Points to the parent annotation from which this annotation was created nullable: true - description: Project ID for this annotation - updated_by: type: integer - nullable: true - description: Last user who updated this annotation parent_prediction: + description: Points to the prediction from which this annotation was created + nullable: true type: integer + project: + description: Project ID for this annotation nullable: true - description: Points to the prediction from which this annotation was created - parent_annotation: type: integer + result: + description: List of annotation results for the task + items: + description: List of annotated regions for the task + title: Annotation result items (regions) + type: object + title: Annotation result list + type: array + task: + description: Corresponding task for this annotation nullable: true - description: Points to the parent annotation from which this annotation - was created - last_created_by: type: integer + unique_id: + minLength: 1 + type: string + writeOnly: true + updated_by: + description: Last user who updated this annotation nullable: true - description: User who created the last annotation history item - AnnotationReview: + type: integer + was_cancelled: + description: User skipped the task + type: boolean type: object + AnnotationReview: description: |- 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: + accepted: + description: Accepted or rejected (if false) flag + type: boolean + annotation: + description: Corresponding annotation type: integer + created_at: + description: Creation time + format: date-time readOnly: true + type: string created_by: - type: integer - readOnly: true description: User who made this review - created_at: - type: string - format: date-time readOnly: true - description: Creation time - accepted: - type: boolean - description: Accepted or rejected (if false) flag - result: - nullable: true - annotation: type: integer - description: Corresponding annotation fixed_annotation_history: - type: integer - readOnly: true - nullable: true description: Fixed annotation history item by the reviewer - previous_annotation_history: + nullable: true + readOnly: true type: integer + id: readOnly: true - nullable: true - description: Previous annotation history item by the annotator + type: integer last_annotation_history: + nullable: true type: integer + previous_annotation_history: + description: Previous annotation history item by the annotator nullable: true + readOnly: true + type: integer remove_from_queue: + nullable: true type: boolean + result: nullable: true started_at: - type: string format: date-time nullable: true + type: string required: - - annotation - - created_at - - created_by - - fixed_annotation_history - - id - - previous_annotation_history - AnnotationReviewRequest: + - annotation + - created_at + - created_by + - fixed_annotation_history + - id + - previous_annotation_history type: object + AnnotationReviewRequest: description: |- A ModelSerializer that takes additional arguments for "fields", "omit" and "expand" in order to @@ -16331,69 +15913,69 @@ components: values with complex, nested serializations properties: accepted: - type: boolean description: Accepted or rejected (if false) flag - result: - nullable: true + type: boolean annotation: - type: integer description: Corresponding annotation - last_annotation_history: type: integer - nullable: true comment: + minLength: 1 + nullable: true type: string writeOnly: true + last_annotation_history: nullable: true - minLength: 1 + type: integer remove_from_queue: + nullable: true type: boolean + result: nullable: true started_at: - type: string format: date-time nullable: true + type: string required: - - annotation - AssignmentSettings: + - annotation type: object + AssignmentSettings: properties: id: - type: integer readOnly: true + type: integer label_stream_task_distribution: - nullable: true description: |- 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 + nullable: true oneOf: - - $ref: '#/components/schemas/LabelStreamTaskDistributionEnum' - - $ref: '#/components/schemas/NullEnum' + - $ref: '#/components/schemas/LabelStreamTaskDistributionEnum' + - $ref: '#/components/schemas/NullEnum' project: - type: integer nullable: true + type: integer required: - - id - AssignmentSettingsRequest: + - id type: object + AssignmentSettingsRequest: properties: label_stream_task_distribution: - nullable: true description: |- 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 + nullable: true oneOf: - - $ref: '#/components/schemas/LabelStreamTaskDistributionEnum' - - $ref: '#/components/schemas/NullEnum' + - $ref: '#/components/schemas/LabelStreamTaskDistributionEnum' + - $ref: '#/components/schemas/NullEnum' project: - type: integer nullable: true - AssociatedProject: + type: integer type: object + AssociatedProject: description: |- A ModelSerializer that takes additional arguments for "fields", "omit" and "expand" in order to @@ -16401,1354 +15983,1541 @@ components: values with complex, nested serializations properties: id: - type: integer readOnly: true + type: integer title: - type: string - nullable: true description: Project name. Must be between 3 and 50 characters long. maxLength: 50 minLength: 3 + nullable: true + type: string required: - - id + - id + type: object AuthMethodEnum: - enum: - - NONE - - BASIC_AUTH - type: string description: |- * `NONE` - None * `BASIC_AUTH` - Basic Auth + enum: + - NONE + - BASIC_AUTH + type: string AzureBlobExportStorage: - type: object properties: - id: - type: integer - readOnly: true - type: - type: string - readOnly: true - default: azure - synchronizable: - type: boolean - default: true - container: - type: string + account_key: + description: Azure Blob account key nullable: true - description: Azure blob container - prefix: type: string + account_name: + description: Azure Blob account name nullable: true - description: Azure blob prefix name - regex_filter: type: string + can_delete_objects: + description: Deletion from storage enabled nullable: true - description: Cloud storage regex for filtering objects - use_blob_urls: type: boolean - description: Interpret objects as BLOBs and generate URLs - account_name: - type: string + container: + description: Azure blob container nullable: true - description: Azure Blob account name - account_key: type: string + created_at: + description: Creation time + format: date-time + readOnly: true + type: string + description: + description: Cloud storage description nullable: true - description: Azure Blob account key - last_sync: type: string + id: + readOnly: true + type: integer + last_sync: + description: Last sync finished time format: date-time nullable: true - description: Last sync finished time + type: string last_sync_count: - type: integer + description: Count of tasks synced last time maximum: 2147483647 minimum: 0 nullable: true - description: Count of tasks synced last time + type: integer last_sync_job: - type: string - nullable: true description: Last sync job ID maxLength: 256 - status: - $ref: '#/components/schemas/StatusC5aEnum' - traceback: - type: string nullable: true - description: Traceback report for the last failed sync + type: string meta: - nullable: true description: Meta and debug information about storage processes - title: - type: string nullable: true - description: Cloud storage title - maxLength: 256 - description: - type: string + prefix: + description: Azure blob prefix name nullable: true - description: Cloud storage description - created_at: type: string - format: date-time - readOnly: true - description: Creation time - can_delete_objects: - type: boolean - nullable: true - description: Deletion from storage enabled project: - type: integer description: A unique integer value identifying this project. - required: - - created_at - - id - - project - - type - AzureBlobImportStorage: - type: object - properties: - id: type: integer - readOnly: true - type: + regex_filter: + description: Cloud storage regex for filtering objects + nullable: true type: string - readOnly: true - default: azure + status: + $ref: '#/components/schemas/StatusC5aEnum' synchronizable: - type: boolean default: true - presign: type: boolean - default: true - container: - type: string + title: + description: Cloud storage title + maxLength: 256 nullable: true - description: Azure blob container - prefix: type: string + traceback: + description: Traceback report for the last failed sync nullable: true - description: Azure blob prefix name - regex_filter: type: string - nullable: true - description: Cloud storage regex for filtering objects + type: + default: azure + readOnly: true + type: string use_blob_urls: - type: boolean description: Interpret objects as BLOBs and generate URLs - account_name: - type: string - nullable: true - description: Azure Blob account name - account_key: + type: boolean + required: + - created_at + - id + - project + - type + type: object + AzureBlobImportStorage: + properties: + account_key: + description: Azure Blob account key + nullable: true type: string + account_name: + description: Azure Blob account name + nullable: true + type: string + container: + description: Azure blob container nullable: true - description: Azure Blob account key - last_sync: type: string + created_at: + description: Creation time format: date-time + readOnly: true + type: string + description: + description: Cloud storage description nullable: true + type: string + id: + readOnly: true + type: integer + last_sync: description: Last sync finished time + format: date-time + nullable: true + type: string last_sync_count: - type: integer + description: Count of tasks synced last time maximum: 2147483647 minimum: 0 nullable: true - description: Count of tasks synced last time + type: integer last_sync_job: - type: string - nullable: true description: Last sync job ID maxLength: 256 - status: - $ref: '#/components/schemas/StatusC5aEnum' - traceback: - type: string nullable: true - description: Traceback report for the last failed sync + type: string meta: - nullable: true description: Meta and debug information about storage processes - title: - type: string nullable: true - description: Cloud storage title - maxLength: 256 - description: - type: string + prefix: + description: Azure blob prefix name nullable: true - description: Cloud storage description - created_at: type: string - format: date-time - readOnly: true - description: Creation time + presign: + default: true + type: boolean presign_ttl: - type: integer + description: Presigned URLs TTL (in minutes) maximum: 32767 minimum: 0 - description: Presigned URLs TTL (in minutes) - project: type: integer + project: description: A unique integer value identifying this project. - required: - - created_at - - id - - project - - type - AzureDatasetStorage: - type: object - properties: - id: type: integer - readOnly: true - type: + regex_filter: + description: Cloud storage regex for filtering objects + nullable: true type: string - readOnly: true - default: azure + status: + $ref: '#/components/schemas/StatusC5aEnum' synchronizable: - type: boolean default: true - presign: type: boolean - default: true - container: - type: string + title: + description: Cloud storage title + maxLength: 256 nullable: true - description: Azure blob container - prefix: type: string + traceback: + description: Traceback report for the last failed sync nullable: true - description: Azure blob prefix name - regex_filter: type: string - nullable: true - description: Cloud storage regex for filtering objects + type: + default: azure + readOnly: true + type: string use_blob_urls: - type: boolean description: Interpret objects as BLOBs and generate URLs - account_name: - type: string + type: boolean + required: + - created_at + - id + - project + - type + type: object + AzureDatasetStorage: + properties: + account_key: + description: Azure Blob account key nullable: true + type: string + account_name: description: Azure Blob account name - account_key: + nullable: true type: string + container: + description: Azure blob container nullable: true - description: Azure Blob account key - last_sync: type: string + created_at: + description: Creation time format: date-time + readOnly: true + type: string + dataset: + description: A unique integer value identifying this dataset. + type: integer + description: + description: Cloud storage description + nullable: true + type: string + glob_pattern: + description: Glob pattern for syncing from bucket + nullable: true + type: string + id: + readOnly: true + type: integer + job_id: nullable: true + readOnly: true + title: The Job ID for the GCP Dataproc job that will import the records of this dataset into the vector db + type: string + last_sync: description: Last sync finished time + format: date-time + nullable: true + type: string last_sync_count: - type: integer + description: Count of tasks synced last time maximum: 2147483647 minimum: 0 nullable: true - description: Count of tasks synced last time + type: integer last_sync_job: - type: string - nullable: true description: Last sync job ID maxLength: 256 - status: - $ref: '#/components/schemas/StatusC5aEnum' - traceback: - type: string nullable: true - description: Traceback report for the last failed sync + type: string meta: - nullable: true description: Meta and debug information about storage processes - title: - type: string nullable: true - description: Cloud storage title - maxLength: 256 - description: - type: string + prefix: + description: Azure blob prefix name nullable: true - description: Cloud storage description - created_at: type: string - format: date-time - readOnly: true - description: Creation time + presign: + default: true + type: boolean presign_ttl: - type: integer + description: Presigned URLs TTL (in minutes) maximum: 32767 minimum: 0 - description: Presigned URLs TTL (in minutes) - glob_pattern: - type: string + type: integer + regex_filter: + description: Cloud storage regex for filtering objects nullable: true - description: Glob pattern for syncing from bucket + type: string + status: + $ref: '#/components/schemas/StatusC5aEnum' synced: - type: boolean description: Flag if dataset has been previously synced or not - job_id: - type: string - readOnly: true - nullable: true - title: The Job ID for the GCP Dataproc job that will import the records - of this dataset into the vector db - dataset: - type: integer - description: A unique integer value identifying this dataset. - required: - - created_at - - dataset - - id - - job_id - - type - AzureDatasetStorageRequest: - type: object - properties: - synchronizable: type: boolean + synchronizable: default: true - presign: type: boolean - default: true - container: - type: string + title: + description: Cloud storage title + maxLength: 256 nullable: true - description: Azure blob container - prefix: type: string + traceback: + description: Traceback report for the last failed sync nullable: true - description: Azure blob prefix name - regex_filter: type: string - nullable: true - description: Cloud storage regex for filtering objects + type: + default: azure + readOnly: true + type: string use_blob_urls: - type: boolean description: Interpret objects as BLOBs and generate URLs + type: boolean + required: + - created_at + - dataset + - id + - job_id + - type + type: object + AzureDatasetStorageRequest: + properties: + account_key: + description: Azure Blob account key + nullable: true + type: string account_name: + description: Azure Blob account name + nullable: true type: string + container: + description: Azure blob container nullable: true - description: Azure Blob account name - account_key: type: string + dataset: + description: A unique integer value identifying this dataset. + type: integer + description: + description: Cloud storage description nullable: true - description: Azure Blob account key - last_sync: type: string - format: date-time + glob_pattern: + description: Glob pattern for syncing from bucket nullable: true + type: string + last_sync: description: Last sync finished time + format: date-time + nullable: true + type: string last_sync_count: - type: integer + description: Count of tasks synced last time maximum: 2147483647 minimum: 0 nullable: true - description: Count of tasks synced last time + type: integer last_sync_job: - type: string - nullable: true description: Last sync job ID maxLength: 256 - status: - $ref: '#/components/schemas/StatusC5aEnum' - traceback: - type: string nullable: true - description: Traceback report for the last failed sync + type: string meta: - nullable: true description: Meta and debug information about storage processes - title: - type: string nullable: true - description: Cloud storage title - maxLength: 256 - description: - type: string + prefix: + description: Azure blob prefix name nullable: true - description: Cloud storage description + type: string + presign: + default: true + type: boolean presign_ttl: - type: integer + description: Presigned URLs TTL (in minutes) maximum: 32767 minimum: 0 - description: Presigned URLs TTL (in minutes) - glob_pattern: - type: string + type: integer + regex_filter: + description: Cloud storage regex for filtering objects nullable: true - description: Glob pattern for syncing from bucket + type: string + status: + $ref: '#/components/schemas/StatusC5aEnum' synced: - type: boolean description: Flag if dataset has been previously synced or not - dataset: - type: integer - description: A unique integer value identifying this dataset. - required: - - dataset - AzureServicePrincipalExportStorage: - type: object - properties: - id: - type: integer - readOnly: true - type: - type: string - readOnly: true - default: azure_spi - synchronizable: type: boolean + synchronizable: default: true - prefix: - type: string + type: boolean + title: + description: Cloud storage title + maxLength: 256 nullable: true - description: Azure blob prefix name - regex_filter: type: string + traceback: + description: Traceback report for the last failed sync nullable: true - description: Cloud storage regex for filtering objects + type: string use_blob_urls: - type: boolean description: Interpret objects as BLOBs and generate URLs + type: boolean + required: + - dataset + type: object + AzureServicePrincipalExportStorage: + properties: account_name: - type: string - nullable: true description: Azure Blob account name - container: - type: string nullable: true - description: Azure blob container - tenant_id: type: string + can_delete_objects: + description: Deletion from storage enabled nullable: true - description: Azure Tenant ID + type: boolean client_id: - type: string - nullable: true description: Azure Blob Service Principal Client ID - client_secret: - type: string nullable: true + type: string + client_secret: description: Azure Blob Service Principal Client Secret - user_delegation_key: + nullable: true type: string + container: + description: Azure blob container nullable: true - description: User Delegation Key (Backend) - last_sync: type: string + created_at: + description: Creation time format: date-time + readOnly: true + type: string + description: + description: Cloud storage description nullable: true + type: string + id: + readOnly: true + type: integer + last_sync: description: Last sync finished time + format: date-time + nullable: true + type: string last_sync_count: - type: integer + description: Count of tasks synced last time maximum: 2147483647 minimum: 0 nullable: true - description: Count of tasks synced last time + type: integer last_sync_job: - type: string - nullable: true description: Last sync job ID maxLength: 256 - status: - $ref: '#/components/schemas/StatusC5aEnum' - traceback: - type: string nullable: true - description: Traceback report for the last failed sync + type: string meta: - nullable: true description: Meta and debug information about storage processes - title: - type: string nullable: true - description: Cloud storage title - maxLength: 256 - description: - type: string + prefix: + description: Azure blob prefix name nullable: true - description: Cloud storage description - created_at: type: string - format: date-time - readOnly: true - description: Creation time - can_delete_objects: - type: boolean - nullable: true - description: Deletion from storage enabled project: - type: integer description: A unique integer value identifying this project. - required: - - created_at - - id - - project - - type - AzureServicePrincipalExportStorageRequest: - type: object - properties: + type: integer + regex_filter: + description: Cloud storage regex for filtering objects + nullable: true + type: string + status: + $ref: '#/components/schemas/StatusC5aEnum' synchronizable: - type: boolean default: true - prefix: + type: boolean + tenant_id: + description: Azure Tenant ID + nullable: true type: string + title: + description: Cloud storage title + maxLength: 256 nullable: true - description: Azure blob prefix name - regex_filter: type: string + traceback: + description: Traceback report for the last failed sync nullable: true - description: Cloud storage regex for filtering objects + type: string + type: + default: azure_spi + readOnly: true + type: string use_blob_urls: - type: boolean description: Interpret objects as BLOBs and generate URLs - account_name: - type: string + type: boolean + user_delegation_key: + description: User Delegation Key (Backend) nullable: true - description: Azure Blob account name - container: type: string + required: + - created_at + - id + - project + - type + type: object + AzureServicePrincipalExportStorageRequest: + properties: + account_name: + description: Azure Blob account name nullable: true - description: Azure blob container - tenant_id: type: string + can_delete_objects: + description: Deletion from storage enabled nullable: true - description: Azure Tenant ID + type: boolean client_id: - type: string - nullable: true description: Azure Blob Service Principal Client ID + nullable: true + type: string client_secret: + description: Azure Blob Service Principal Client Secret + nullable: true type: string + container: + description: Azure blob container nullable: true - description: Azure Blob Service Principal Client Secret - user_delegation_key: type: string + description: + description: Cloud storage description nullable: true - description: User Delegation Key (Backend) - last_sync: type: string + last_sync: + description: Last sync finished time format: date-time nullable: true - description: Last sync finished time + type: string last_sync_count: - type: integer + description: Count of tasks synced last time maximum: 2147483647 minimum: 0 nullable: true - description: Count of tasks synced last time + type: integer last_sync_job: - type: string - nullable: true description: Last sync job ID maxLength: 256 - status: - $ref: '#/components/schemas/StatusC5aEnum' - traceback: - type: string nullable: true - description: Traceback report for the last failed sync + type: string meta: - nullable: true description: Meta and debug information about storage processes - title: - type: string - nullable: true - description: Cloud storage title - maxLength: 256 - description: - type: string nullable: true - description: Cloud storage description - can_delete_objects: - type: boolean + prefix: + description: Azure blob prefix name nullable: true - description: Deletion from storage enabled + type: string project: - type: integer description: A unique integer value identifying this project. - required: - - project - AzureServicePrincipalImportStorage: - type: object - properties: - id: type: integer - readOnly: true - type: + regex_filter: + description: Cloud storage regex for filtering objects + nullable: true type: string - readOnly: true - default: azure_spi + status: + $ref: '#/components/schemas/StatusC5aEnum' synchronizable: - type: boolean default: true - presign: type: boolean - default: true - prefix: + tenant_id: + description: Azure Tenant ID + nullable: true type: string + title: + description: Cloud storage title + maxLength: 256 nullable: true - description: Azure blob prefix name - regex_filter: type: string + traceback: + description: Traceback report for the last failed sync nullable: true - description: Cloud storage regex for filtering objects + type: string use_blob_urls: - type: boolean description: Interpret objects as BLOBs and generate URLs - account_name: - type: string + type: boolean + user_delegation_key: + description: User Delegation Key (Backend) nullable: true - description: Azure Blob account name - container: type: string + required: + - project + type: object + AzureServicePrincipalImportStorage: + properties: + account_name: + description: Azure Blob account name nullable: true - description: Azure blob container - tenant_id: type: string - nullable: true - description: Azure Tenant ID client_id: - type: string - nullable: true description: Azure Blob Service Principal Client ID - client_secret: - type: string nullable: true + type: string + client_secret: description: Azure Blob Service Principal Client Secret - user_delegation_key: + nullable: true type: string + container: + description: Azure blob container nullable: true - description: User Delegation Key (Backend) - last_sync: type: string + created_at: + description: Creation time format: date-time + readOnly: true + type: string + description: + description: Cloud storage description nullable: true + type: string + id: + readOnly: true + type: integer + last_sync: description: Last sync finished time + format: date-time + nullable: true + type: string last_sync_count: - type: integer + description: Count of tasks synced last time maximum: 2147483647 minimum: 0 nullable: true - description: Count of tasks synced last time + type: integer last_sync_job: - type: string - nullable: true description: Last sync job ID maxLength: 256 - status: - $ref: '#/components/schemas/StatusC5aEnum' - traceback: - type: string nullable: true - description: Traceback report for the last failed sync + type: string meta: - nullable: true description: Meta and debug information about storage processes - title: - type: string nullable: true - description: Cloud storage title - maxLength: 256 - description: - type: string + prefix: + description: Azure blob prefix name nullable: true - description: Cloud storage description - created_at: type: string - format: date-time - readOnly: true - description: Creation time + presign: + default: true + type: boolean presign_ttl: - type: integer + description: Presigned URLs TTL (in minutes) maximum: 32767 minimum: 0 - description: Presigned URLs TTL (in minutes) - project: type: integer + project: description: A unique integer value identifying this project. - required: - - created_at - - id - - project - - type - AzureServicePrincipalImportStorageRequest: - type: object - properties: + type: integer + regex_filter: + description: Cloud storage regex for filtering objects + nullable: true + type: string + status: + $ref: '#/components/schemas/StatusC5aEnum' synchronizable: - type: boolean default: true - presign: type: boolean - default: true - prefix: + tenant_id: + description: Azure Tenant ID + nullable: true type: string + title: + description: Cloud storage title + maxLength: 256 nullable: true - description: Azure blob prefix name - regex_filter: type: string + traceback: + description: Traceback report for the last failed sync nullable: true - description: Cloud storage regex for filtering objects + type: string + type: + default: azure_spi + readOnly: true + type: string use_blob_urls: - type: boolean description: Interpret objects as BLOBs and generate URLs - account_name: - type: string + type: boolean + user_delegation_key: + description: User Delegation Key (Backend) nullable: true - description: Azure Blob account name - container: type: string + required: + - created_at + - id + - project + - type + type: object + AzureServicePrincipalImportStorageRequest: + properties: + account_name: + description: Azure Blob account name nullable: true - description: Azure blob container - tenant_id: type: string - nullable: true - description: Azure Tenant ID client_id: - type: string - nullable: true description: Azure Blob Service Principal Client ID + nullable: true + type: string client_secret: + description: Azure Blob Service Principal Client Secret + nullable: true type: string + container: + description: Azure blob container nullable: true - description: Azure Blob Service Principal Client Secret - user_delegation_key: type: string + description: + description: Cloud storage description nullable: true - description: User Delegation Key (Backend) - last_sync: type: string + last_sync: + description: Last sync finished time format: date-time nullable: true - description: Last sync finished time + type: string last_sync_count: - type: integer + description: Count of tasks synced last time maximum: 2147483647 minimum: 0 nullable: true - description: Count of tasks synced last time + type: integer last_sync_job: - type: string - nullable: true description: Last sync job ID maxLength: 256 - status: - $ref: '#/components/schemas/StatusC5aEnum' - traceback: - type: string nullable: true - description: Traceback report for the last failed sync + type: string meta: - nullable: true description: Meta and debug information about storage processes - title: - type: string nullable: true - description: Cloud storage title - maxLength: 256 - description: - type: string + prefix: + description: Azure blob prefix name nullable: true - description: Cloud storage description + type: string + presign: + default: true + type: boolean presign_ttl: - type: integer + description: Presigned URLs TTL (in minutes) maximum: 32767 minimum: 0 - description: Presigned URLs TTL (in minutes) - project: type: integer + project: description: A unique integer value identifying this project. + type: integer + regex_filter: + description: Cloud storage regex for filtering objects + nullable: true + type: string + status: + $ref: '#/components/schemas/StatusC5aEnum' + synchronizable: + default: true + type: boolean + tenant_id: + description: Azure Tenant ID + nullable: true + type: string + title: + description: Cloud storage title + maxLength: 256 + nullable: true + type: string + traceback: + description: Traceback report for the last failed sync + nullable: true + type: string + use_blob_urls: + description: Interpret objects as BLOBs and generate URLs + type: boolean + user_delegation_key: + description: User Delegation Key (Backend) + nullable: true + type: string required: - - project - BatchFailedPredictions: + - project type: object + BatchFailedPredictions: properties: - job_id: - type: string - maxLength: 255 failed_predictions: - type: array items: {} + type: array + job_id: + maxLength: 255 + type: string required: - - failed_predictions - - job_id - BatchFailedPredictionsRequestRequest: + - failed_predictions + - job_id type: object + BatchFailedPredictionsRequestRequest: properties: - job_id: - type: string - minLength: 1 - maxLength: 255 failed_predictions: - type: array items: {} + type: array + job_id: + maxLength: 255 + minLength: 1 + type: string modelrun_id: type: integer required: - - failed_predictions - - modelrun_id - BatchPredictions: + - failed_predictions + - modelrun_id type: object + BatchPredictions: properties: job_id: - type: string maxLength: 255 + type: string results: - type: array items: {} + type: array required: - - job_id - - results - BatchPredictionsRequestRequest: + - job_id + - results type: object + BatchPredictionsRequestRequest: properties: job_id: - type: string - minLength: 1 maxLength: 255 - results: - type: array - items: {} + minLength: 1 + type: string modelrun_id: type: integer + results: + items: {} + type: array required: - - modelrun_id - - results - BlankEnum: - enum: - - '' - Blueprint: + - modelrun_id + - results type: object + BillingChecks: properties: - id: - type: integer - readOnly: true - share_id: - type: string - readOnly: true - short_url: + export_storages: + $ref: '#/components/schemas/CountLimit' + import_storages: + $ref: '#/components/schemas/CountLimit' + is_license_expired: + type: boolean + is_license_warning: + type: boolean + is_prompts_expire: + type: boolean + is_prompts_warning: + type: boolean + license_expires: + format: date + nullable: true type: string - readOnly: true - project: - type: integer - readOnly: true - created_by: - type: integer + license_issued: + format: date nullable: true - title: type: string + license_warning: + format: date nullable: true - description: Blueprint name. Must be between 3 and 50 characters long. - maxLength: 50 - description: type: string + organization_is_active: + type: boolean + projects: + $ref: '#/components/schemas/CountLimit' + prompts_api_keys_enabled: + type: boolean + prompts_enabled: + type: boolean + prompts_expire: nullable: true - description: Project description - label_config: type: string + prompts_status: + $ref: '#/components/schemas/PromptsStatusEnum' + prompts_warning: nullable: true - description: Labeling configuration in XML format - created_at: type: string + results: + $ref: '#/components/schemas/CountLimit' + trial_days: + type: integer + users: + $ref: '#/components/schemas/CountLimit' + required: + - export_storages + - import_storages + - is_license_expired + - is_license_warning + - is_prompts_expire + - is_prompts_warning + - license_expires + - license_issued + - license_warning + - organization_is_active + - projects + - prompts_api_keys_enabled + - prompts_enabled + - prompts_expire + - prompts_status + - prompts_warning + - results + - trial_days + - users + type: object + BillingFlags: + properties: + activated_at: format: date-time - readOnly: true - updated_at: + nullable: true + type: string + allow_activity_log: + type: boolean + allow_ai: + type: boolean + allow_ask_ai: + type: boolean + allow_data_credentials: + type: boolean + allow_invite_people: + type: boolean + allow_invite_project_experts: + type: boolean + allow_organization_webhooks: + type: boolean + allow_sso: + type: boolean + allow_storage_proxy: + type: boolean + automax_enabled: + type: boolean + automax_token_exists: + type: boolean + cloud_instance: + type: boolean + disable_members_page: + type: boolean + disable_project_imports: + type: boolean + early_adopter: + type: boolean + embed_domains: + items: + additionalProperties: {} + type: object + type: array + embed_enabled: + type: boolean + embed_settings: + additionalProperties: {} + type: object + hide_storage_settings_for_manager: + type: boolean + manual_role_management: + type: boolean + manual_workspace_management: + type: boolean + secure_mode: + type: boolean + storage_persistence: + type: boolean + white_label_id: + nullable: true type: string - format: date-time - readOnly: true required: - - created_at - - id - - project - - share_id - - short_url - - updated_at - BlueprintList: + - activated_at + - allow_activity_log + - allow_ai + - allow_ask_ai + - allow_data_credentials + - allow_invite_people + - allow_invite_project_experts + - allow_organization_webhooks + - allow_sso + - allow_storage_proxy + - automax_enabled + - automax_token_exists + - cloud_instance + - disable_members_page + - disable_project_imports + - early_adopter + - embed_enabled + - hide_storage_settings_for_manager + - manual_role_management + - manual_workspace_management + - secure_mode + - storage_persistence + - white_label_id + type: object + BillingInfoResponse: + properties: + billing_checks: + $ref: '#/components/schemas/BillingChecks' + billing_flags: + $ref: '#/components/schemas/BillingFlags' + required: + - billing_checks + - billing_flags type: object + BlankEnum: + enum: + - '' + Blueprint: properties: + created_at: + format: date-time + readOnly: true + type: string + created_by: + nullable: true + type: integer + description: + description: Project description + nullable: true + type: string id: + readOnly: true type: integer + label_config: + description: Labeling configuration in XML format + nullable: true + type: string + project: readOnly: true + type: integer share_id: - type: string readOnly: true - short_url: type: string + short_url: readOnly: true - title: type: string - nullable: true + title: description: Blueprint name. Must be between 3 and 50 characters long. maxLength: 50 - description: - type: string nullable: true - description: Project description - created_at: type: string + updated_at: format: date-time readOnly: true + type: string required: - - created_at - - id - - share_id - - short_url - BlueprintRequest: + - created_at + - id + - project + - share_id + - short_url + - updated_at type: object + BlueprintList: properties: - created_by: - type: integer - nullable: true - title: + created_at: + format: date-time + readOnly: true type: string + description: + description: Project description nullable: true + type: string + id: + readOnly: true + type: integer + share_id: + readOnly: true + type: string + short_url: + readOnly: true + type: string + title: description: Blueprint name. Must be between 3 and 50 characters long. maxLength: 50 - description: + nullable: true type: string + required: + - created_at + - id + - share_id + - short_url + type: object + BlueprintRequest: + properties: + created_by: nullable: true + type: integer + description: description: Project description + nullable: true + type: string label_config: + description: Labeling configuration in XML format + nullable: true type: string + title: + description: Blueprint name. Must be between 3 and 50 characters long. + maxLength: 50 nullable: true - description: Labeling configuration in XML format + type: string + type: object BudgetResetPeriodEnum: - enum: - - Monthly - - Yearly - type: string description: |- * `Monthly` - Monthly * `Yearly` - Yearly + enum: + - Monthly + - Yearly + type: string ChildFilter: - type: object properties: + column: + description: Field name + maxLength: 1024 + type: string id: - type: integer readOnly: true - index: type: integer + index: + description: Display order among root filters only maximum: 2147483647 minimum: -2147483648 nullable: true - description: Display order among root filters only - column: - type: string - description: Field name + type: integer + operator: + description: Filter operator maxLength: 1024 - type: type: string + parent: + description: Optional parent filter to create one-level hierarchy (child filters are AND-merged with parent) + nullable: true + type: integer + type: description: Field type maxLength: 1024 - operator: type: string - description: Filter operator - maxLength: 1024 value: - nullable: true description: Filter value - parent: - type: integer nullable: true - description: Optional parent filter to create one-level hierarchy (child - filters are AND-merged with parent) required: - - column - - id - - operator - - type - ChildFilterRequest: + - column + - id + - operator + - type type: object + ChildFilterRequest: properties: + column: + description: Field name + maxLength: 1024 + minLength: 1 + type: string index: - type: integer + description: Display order among root filters only maximum: 2147483647 minimum: -2147483648 nullable: true - description: Display order among root filters only - column: - type: string - minLength: 1 - description: Field name + type: integer + operator: + description: Filter operator maxLength: 1024 - type: - type: string minLength: 1 + type: string + parent: + description: Optional parent filter to create one-level hierarchy (child filters are AND-merged with parent) + nullable: true + type: integer + type: description: Field type maxLength: 1024 - operator: - type: string minLength: 1 - description: Filter operator - maxLength: 1024 + type: string value: - nullable: true description: Filter value - parent: - type: integer nullable: true - description: Optional parent filter to create one-level hierarchy (child - filters are AND-merged with parent) required: - - column - - operator - - type - Comment: + - column + - operator + - type type: object + Comment: properties: - id: - type: integer - readOnly: true - region_ref: + annotation: nullable: true - description: Set if this comment is related to a specific part of the annotation. - Normally contains region ID and control name. + type: integer classifications: - nullable: true description: Classifications applied by a reviewer or annotator - text: - type: string nullable: true - description: Reviewer or annotator comment created_at: - type: string - format: date-time - readOnly: true description: Creation time - updated_at: - type: string format: date-time readOnly: true - description: Last updated time - is_resolved: - type: boolean - description: True if the comment is resolved - resolved_at: type: string - format: date-time + created_by: + description: User who made this comment readOnly: true - nullable: true - description: Resolving time - project: type: integer - readOnly: true + draft: nullable: true - task: type: integer + id: readOnly: true - nullable: true - draft: - type: integer - nullable: true - annotation: type: integer + is_resolved: + description: True if the comment is resolved + type: boolean + project: nullable: true - created_by: - type: integer readOnly: true - description: User who made this comment - required: - - created_at - - created_by - - id - - project - - resolved_at - - task - - updated_at - CommentRequest: - type: object - properties: + type: integer region_ref: + description: Set if this comment is related to a specific part of the annotation. Normally contains region ID and control name. nullable: true - description: Set if this comment is related to a specific part of the annotation. - Normally contains region ID and control name. - classifications: + resolved_at: + description: Resolving time + format: date-time nullable: true - description: Classifications applied by a reviewer or annotator - text: + readOnly: true type: string + task: nullable: true - description: Reviewer or annotator comment - is_resolved: - type: boolean - description: True if the comment is resolved - draft: + readOnly: true type: integer + text: + description: Reviewer or annotator comment nullable: true + type: string + updated_at: + description: Last updated time + format: date-time + readOnly: true + type: string + required: + - created_at + - created_by + - id + - project + - resolved_at + - task + - updated_at + type: object + CommentRequest: + properties: annotation: + nullable: true type: integer + classifications: + description: Classifications applied by a reviewer or annotator + nullable: true + draft: nullable: true - CommentSerializerWithExpandedUser: - type: object - properties: - id: type: integer - readOnly: true - created_by: - $ref: '#/components/schemas/LseUser' + is_resolved: + description: True if the comment is resolved + type: boolean region_ref: + description: Set if this comment is related to a specific part of the annotation. Normally contains region ID and control name. nullable: true - description: Set if this comment is related to a specific part of the annotation. - Normally contains region ID and control name. - classifications: - nullable: true - description: Classifications applied by a reviewer or annotator text: + description: Reviewer or annotator comment + nullable: true type: string + type: object + CommentSerializerWithExpandedUser: + properties: + annotation: + nullable: true + type: integer + classifications: + description: Classifications applied by a reviewer or annotator nullable: true - description: Reviewer or annotator comment created_at: - type: string + description: Creation time format: date-time readOnly: true - description: Creation time - updated_at: type: string - format: date-time + created_by: + $ref: '#/components/schemas/LseUser' + draft: + nullable: true + type: integer + id: readOnly: true - description: Last updated time + type: integer is_resolved: - type: boolean description: True if the comment is resolved - resolved_at: - type: string - format: date-time + type: boolean + project: + nullable: true readOnly: true + type: integer + region_ref: + description: Set if this comment is related to a specific part of the annotation. Normally contains region ID and control name. nullable: true + resolved_at: description: Resolving time - project: - type: integer - readOnly: true + format: date-time nullable: true - task: - type: integer readOnly: true + type: string + task: nullable: true - draft: - type: integer - nullable: true - annotation: + readOnly: true type: integer + text: + description: Reviewer or annotator comment nullable: true + type: string + updated_at: + description: Last updated time + format: date-time + readOnly: true + type: string required: - - created_at - - created_by - - id - - project - - resolved_at - - task - - updated_at - ConvertedFormat: + - created_at + - created_by + - id + - project + - resolved_at + - task + - updated_at type: object + ConvertedFormat: properties: + export_type: + maxLength: 64 + type: string id: - type: integer readOnly: true + type: integer status: $ref: '#/components/schemas/Status7bfEnum' - export_type: - type: string - maxLength: 64 traceback: - type: string - nullable: true description: Traceback report in case of errors + nullable: true + type: string required: - - export_type - - id - ConvertedFormatRequest: + - export_type + - id type: object + ConvertedFormatRequest: properties: - status: - $ref: '#/components/schemas/Status7bfEnum' export_type: - type: string - minLength: 1 maxLength: 64 - traceback: + minLength: 1 type: string - nullable: true + status: + $ref: '#/components/schemas/Status7bfEnum' + traceback: description: Traceback report in case of errors + nullable: true + type: string + required: + - export_type + type: object + CountLimit: + properties: + count: + type: integer + limit: + type: integer + reached: + type: boolean + total: + type: integer required: - - export_type + - count + - limit + - reached + type: object CustomScriptsEditableByEnum: - enum: - - AD - - MA - type: string description: |- * `AD` - Administrator * `MA` - Manager + enum: + - AD + - MA + type: string Dataset: - type: object properties: - id: - type: integer + columns: + description: All data columns found in Dataset tasks + nullable: true + created_at: + description: Creation time + format: date-time readOnly: true + type: string created_by: allOf: - - $ref: '#/components/schemas/UserSimple' + - $ref: '#/components/schemas/UserSimple' description: User who created Dataset - created_at: - type: string - format: date-time - readOnly: true - description: Creation time - updated_at: + description: + description: Dataset description + nullable: true type: string - format: date-time + id: readOnly: true - description: Last updated time + type: integer + organization: + nullable: true + type: integer title: - type: string description: Dataset title maxLength: 1000 - description: type: string - nullable: true - description: Dataset description - columns: - nullable: true - description: All data columns found in Dataset tasks total_entities: - type: integer maximum: 2147483647 minimum: -2147483648 nullable: true title: The number of entities in the dataset - vector_db_dataset_name: + type: integer + updated_at: + description: Last updated time + format: date-time + readOnly: true type: string + vector_db_dataset_name: description: Dataset name for weaviate schema maxLength: 37 - organization: - type: integer - nullable: true + type: string required: - - created_at - - id - - title - - updated_at - DatasetMember: + - created_at + - id + - title + - updated_at type: object + DatasetMember: properties: user: type: integer required: - - user - DatasetMemberRequest: + - user type: object + DatasetMemberRequest: properties: user: type: integer required: - - user - DatasetRequest: + - user type: object + DatasetRequest: properties: + columns: + description: All data columns found in Dataset tasks + nullable: true created_by: allOf: - - $ref: '#/components/schemas/UserSimpleRequest' + - $ref: '#/components/schemas/UserSimpleRequest' description: User who created Dataset - title: + description: + description: Dataset description + nullable: true type: string - minLength: 1 + organization: + nullable: true + type: integer + title: description: Dataset title maxLength: 1000 - description: + minLength: 1 type: string - nullable: true - description: Dataset description - columns: - nullable: true - description: All data columns found in Dataset tasks total_entities: - type: integer maximum: 2147483647 minimum: -2147483648 nullable: true title: The number of entities in the dataset + type: integer vector_db_dataset_name: - type: string - minLength: 1 description: Dataset name for weaviate schema maxLength: 37 - organization: - type: integer - nullable: true + minLength: 1 + type: string required: - - title - DatasetView: + - title type: object + DatasetView: properties: - id: - type: integer - readOnly: true - filter_group: - $ref: '#/components/schemas/FilterGroup' data: - nullable: true description: Custom view data - ordering: nullable: true - description: Ordering parameters - order: + dataset: + description: Dataset ID + type: integer + filter_group: + $ref: '#/components/schemas/FilterGroup' + id: + readOnly: true type: integer + order: + description: Position of the tab, starting at the left in data manager and increasing as the tabs go left to right maximum: 2147483647 minimum: -2147483648 nullable: true - description: Position of the tab, starting at the left in data manager and - increasing as the tabs go left to right - selected_items: + type: integer + ordering: + description: Ordering parameters nullable: true + selected_items: description: Selected items - user: - type: integer nullable: true + user: description: User who made this view - dataset: + nullable: true type: integer - description: Dataset ID required: - - dataset - - id - DatasetViewRequest: + - dataset + - id type: object + DatasetViewRequest: properties: - filter_group: - $ref: '#/components/schemas/FilterGroupRequest' data: - nullable: true description: Custom view data - ordering: nullable: true - description: Ordering parameters - order: + dataset: + description: Dataset ID type: integer + filter_group: + $ref: '#/components/schemas/FilterGroupRequest' + order: + description: Position of the tab, starting at the left in data manager and increasing as the tabs go left to right maximum: 2147483647 minimum: -2147483648 nullable: true - description: Position of the tab, starting at the left in data manager and - increasing as the tabs go left to right - selected_items: + type: integer + ordering: + description: Ordering parameters nullable: true + selected_items: description: Selected items - user: - type: integer nullable: true + user: description: User who made this view - dataset: + nullable: true type: integer - description: Dataset ID required: - - dataset - DefaultRole: + - dataset type: object + DefaultRole: properties: - organization: - type: integer - description: A unique integer value identifying this organization. + annotator_reviewer_firewall_enabled_at: + description: 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. + format: date-time + nullable: true + type: string + custom_scripts_editable_by: + description: |- + Set the minimum user role that can edit custom scripts in the UI. + + * `AD` - Administrator + * `MA` - Manager + nullable: true + oneOf: + - $ref: '#/components/schemas/CustomScriptsEditableByEnum' + - $ref: '#/components/schemas/NullEnum' + custom_scripts_enabled_at: + description: 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. + format: date-time + nullable: true + type: string default_role: allOf: - - $ref: '#/components/schemas/DefaultRoleEnum' + - $ref: '#/components/schemas/DefaultRoleEnum' description: |- Default membership role for invited users @@ -17759,75 +17528,38 @@ components: * `AN` - Annotator * `DI` - Deactivated * `NO` - Not Activated - external_id: - type: string + email_notification_settings: + description: 'Email notification settings for this organization. Controls which email notifications users can receive. Structure: {"notifications_allowed": {"notification_type": bool}}' nullable: true - description: External ID to uniquely identify this organization embed_domains: + description: 'List of objects: {"domain": "example.com"}. Used for CSP header on /embed routes.' nullable: true - description: 'List of objects: {"domain": "example.com"}. Used for CSP header - on /embed routes.' embed_settings: - nullable: true description: Embed settings for this organization - extra_data_on_activity_logs: - type: boolean - custom_scripts_enabled_at: - type: string - format: date-time nullable: true - description: 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: + external_id: + description: External ID to uniquely identify this organization nullable: true - description: |- - Set the minimum user role that can edit custom scripts in the UI. - - * `AD` - Administrator - * `MA` - Manager - oneOf: - - $ref: '#/components/schemas/CustomScriptsEditableByEnum' - - $ref: '#/components/schemas/NullEnum' - annotator_reviewer_firewall_enabled_at: type: string + extra_data_on_activity_logs: + type: boolean + label_stream_navigation_disabled_at: + description: 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. format: date-time nullable: true - description: 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: string + organization: + description: A unique integer value identifying this organization. + type: integer + read_only_quick_view_enabled_at: + description: Set to current time to prevent creating or editing annotations in quick view. format: date-time nullable: true - description: Set to current time to prevent creating or editing annotations - in quick view. - label_stream_navigation_disabled_at: type: string - format: date-time - nullable: true - description: 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. - email_notification_settings: - nullable: true - description: 'Email notification settings for this organization. Controls - which email notifications users can receive. Structure: {"notifications_allowed": - {"notification_type": bool}}' required: - - organization + - organization + type: object DefaultRoleEnum: - enum: - - OW - - AD - - MA - - RE - - AN - - DI - - 'NO' - type: string description: |- * `OW` - Owner * `AD` - Administrator @@ -17836,1150 +17568,1156 @@ components: * `AN` - Annotator * `DI` - Deactivated * `NO` - Not Activated - EditionEnum: enum: - - Community - - Enterprise + - OW + - AD + - MA + - RE + - AN + - DI + - 'NO' type: string + EditionEnum: description: |- * `Community` - Community * `Enterprise` - Enterprise + enum: + - Community + - Enterprise + type: string Export: - type: object properties: - title: - type: string - maxLength: 2048 - id: - type: integer - readOnly: true - created_by: - $ref: '#/components/schemas/UserSimple' + converted_formats: + items: + $ref: '#/components/schemas/ConvertedFormat' + type: array + counters: + title: Exporting meta data created_at: - type: string + description: Creation time format: date-time readOnly: true - description: Creation time - finished_at: type: string + created_by: + $ref: '#/components/schemas/UserSimple' + finished_at: + description: Complete or fail time format: date-time nullable: true - description: Complete or fail time + type: string + id: + readOnly: true + type: integer + md5: + maxLength: 128 + title: Md5 of file + type: string status: allOf: - - $ref: '#/components/schemas/Status7bfEnum' + - $ref: '#/components/schemas/Status7bfEnum' title: Export status - md5: + title: + maxLength: 2048 type: string - title: Md5 of file - maxLength: 128 - counters: - title: Exporting meta data - converted_formats: - type: array - items: - $ref: '#/components/schemas/ConvertedFormat' required: - - created_at - - id - ExportConvertRequest: + - created_at + - id type: object + ExportConvertRequest: properties: - export_type: - type: string - minLength: 1 - description: Export file format. download_resources: - type: boolean description: Download resources in converter. + type: boolean + export_type: + description: Export file format. + minLength: 1 + type: string required: - - export_type - FileUpload: + - export_type type: object + FileUpload: properties: + file: + type: string id: + readOnly: true type: integer + size: + nullable: true readOnly: true - file: - type: string + type: integer required: - - file - - id - Filter: + - file + - id + - size type: object + Filter: properties: - id: - type: integer - readOnly: true child_filter: $ref: '#/components/schemas/ChildFilter' - index: + column: + description: Field name + maxLength: 1024 + type: string + id: + readOnly: true type: integer + index: + description: Display order among root filters only maximum: 2147483647 minimum: -2147483648 nullable: true - description: Display order among root filters only - column: - type: string - description: Field name + type: integer + operator: + description: Filter operator maxLength: 1024 - type: type: string + parent: + description: Optional parent filter to create one-level hierarchy (child filters are AND-merged with parent) + nullable: true + type: integer + type: description: Field type maxLength: 1024 - operator: type: string - description: Filter operator - maxLength: 1024 value: - nullable: true description: Filter value - parent: - type: integer nullable: true - description: Optional parent filter to create one-level hierarchy (child - filters are AND-merged with parent) required: - - column - - id - - operator - - type - FilterGroup: + - column + - id + - operator + - type type: object + FilterGroup: properties: - id: - type: integer - readOnly: true - filters: - type: array - items: - $ref: '#/components/schemas/Filter' conjunction: - type: string description: Type of conjunction maxLength: 1024 + type: string + filters: + items: + $ref: '#/components/schemas/Filter' + type: array + id: + readOnly: true + type: integer required: - - conjunction - - filters - - id - FilterGroupRequest: + - conjunction + - filters + - id type: object + FilterGroupRequest: properties: - filters: - type: array - items: - $ref: '#/components/schemas/FilterRequest' conjunction: - type: string - minLength: 1 description: Type of conjunction maxLength: 1024 + minLength: 1 + type: string + filters: + items: + $ref: '#/components/schemas/FilterRequest' + type: array required: - - conjunction - - filters - FilterRequest: + - conjunction + - filters type: object + FilterRequest: properties: child_filter: $ref: '#/components/schemas/ChildFilterRequest' + column: + description: Field name + maxLength: 1024 + minLength: 1 + type: string index: - type: integer + description: Display order among root filters only maximum: 2147483647 minimum: -2147483648 nullable: true - description: Display order among root filters only - column: - type: string - minLength: 1 - description: Field name + type: integer + operator: + description: Filter operator maxLength: 1024 - type: - type: string minLength: 1 + type: string + parent: + description: Optional parent filter to create one-level hierarchy (child filters are AND-merged with parent) + nullable: true + type: integer + type: description: Field type maxLength: 1024 - operator: - type: string minLength: 1 - description: Filter operator - maxLength: 1024 + type: string value: - nullable: true description: Filter value - parent: - type: integer nullable: true - description: Optional parent filter to create one-level hierarchy (child - filters are AND-merged with parent) required: - - column - - operator - - type + - column + - operator + - type + type: object FinishedEnum: - enum: - - only - - exclude description: |- * `only` - only * `exclude` - exclude * `None` - None + enum: + - only + - exclude GCSDatasetStorage: - type: object properties: - id: - type: integer - readOnly: true - type: + bucket: + description: GCS bucket name + nullable: true type: string + created_at: + description: Creation time + format: date-time readOnly: true - default: gcs - synchronizable: - type: boolean - default: true - presign: - type: boolean - default: true - bucket: type: string + dataset: + description: A unique integer value identifying this dataset. + type: integer + description: + description: Cloud storage description nullable: true - description: GCS bucket name - prefix: type: string + glob_pattern: + description: Glob pattern for syncing from bucket nullable: true - description: GCS bucket prefix - regex_filter: type: string - nullable: true - description: Cloud storage regex for filtering objects - use_blob_urls: - type: boolean - description: Interpret objects as BLOBs and generate URLs google_application_credentials: - type: string - nullable: true description: The content of GOOGLE_APPLICATION_CREDENTIALS json file + nullable: true + type: string google_project_id: + description: Google project ID + nullable: true type: string + id: + readOnly: true + type: integer + job_id: nullable: true - description: Google project ID - last_sync: + readOnly: true + title: The Job ID for the GCP Dataproc job that will import the records of this dataset into the vector db type: string + last_sync: + description: Last sync finished time format: date-time nullable: true - description: Last sync finished time + type: string last_sync_count: - type: integer + description: Count of tasks synced last time maximum: 2147483647 minimum: 0 nullable: true - description: Count of tasks synced last time + type: integer last_sync_job: - type: string - nullable: true description: Last sync job ID maxLength: 256 - status: - $ref: '#/components/schemas/StatusC5aEnum' - traceback: - type: string nullable: true - description: Traceback report for the last failed sync + type: string meta: - nullable: true description: Meta and debug information about storage processes - title: - type: string nullable: true - description: Cloud storage title - maxLength: 256 - description: - type: string + prefix: + description: GCS bucket prefix nullable: true - description: Cloud storage description - created_at: type: string - format: date-time - readOnly: true - description: Creation time + presign: + default: true + type: boolean presign_ttl: - type: integer + description: Presigned URLs TTL (in minutes) maximum: 32767 minimum: 0 - description: Presigned URLs TTL (in minutes) - glob_pattern: - type: string + type: integer + regex_filter: + description: Cloud storage regex for filtering objects nullable: true - description: Glob pattern for syncing from bucket + type: string + status: + $ref: '#/components/schemas/StatusC5aEnum' synced: - type: boolean description: Flag if dataset has been previously synced or not - job_id: + type: boolean + synchronizable: + default: true + type: boolean + title: + description: Cloud storage title + maxLength: 256 + nullable: true type: string - readOnly: true + traceback: + description: Traceback report for the last failed sync nullable: true - title: The Job ID for the GCP Dataproc job that will import the records - of this dataset into the vector db - dataset: - type: integer - description: A unique integer value identifying this dataset. + type: string + type: + default: gcs + readOnly: true + type: string + use_blob_urls: + description: Interpret objects as BLOBs and generate URLs + type: boolean required: - - created_at - - dataset - - id - - job_id - - type - GCSDatasetStorageRequest: + - created_at + - dataset + - id + - job_id + - type type: object + GCSDatasetStorageRequest: properties: - synchronizable: - type: boolean - default: true - presign: - type: boolean - default: true bucket: - type: string - nullable: true description: GCS bucket name - prefix: - type: string nullable: true - description: GCS bucket prefix - regex_filter: type: string + dataset: + description: A unique integer value identifying this dataset. + type: integer + description: + description: Cloud storage description nullable: true - description: Cloud storage regex for filtering objects - use_blob_urls: - type: boolean - description: Interpret objects as BLOBs and generate URLs - google_application_credentials: type: string + glob_pattern: + description: Glob pattern for syncing from bucket nullable: true - description: The content of GOOGLE_APPLICATION_CREDENTIALS json file - google_project_id: type: string + google_application_credentials: + description: The content of GOOGLE_APPLICATION_CREDENTIALS json file nullable: true + type: string + google_project_id: description: Google project ID - last_sync: + nullable: true type: string + last_sync: + description: Last sync finished time format: date-time nullable: true - description: Last sync finished time + type: string last_sync_count: - type: integer + description: Count of tasks synced last time maximum: 2147483647 minimum: 0 nullable: true - description: Count of tasks synced last time + type: integer last_sync_job: - type: string - nullable: true description: Last sync job ID maxLength: 256 - status: - $ref: '#/components/schemas/StatusC5aEnum' - traceback: - type: string nullable: true - description: Traceback report for the last failed sync + type: string meta: - nullable: true description: Meta and debug information about storage processes - title: - type: string nullable: true - description: Cloud storage title - maxLength: 256 - description: - type: string + prefix: + description: GCS bucket prefix nullable: true - description: Cloud storage description + type: string + presign: + default: true + type: boolean presign_ttl: - type: integer + description: Presigned URLs TTL (in minutes) maximum: 32767 minimum: 0 - description: Presigned URLs TTL (in minutes) - glob_pattern: - type: string + type: integer + regex_filter: + description: Cloud storage regex for filtering objects nullable: true - description: Glob pattern for syncing from bucket + type: string + status: + $ref: '#/components/schemas/StatusC5aEnum' synced: - type: boolean description: Flag if dataset has been previously synced or not - dataset: - type: integer - description: A unique integer value identifying this dataset. - required: - - dataset - GCSExportStorage: - type: object - properties: - id: - type: integer - readOnly: true - type: - type: string - readOnly: true - default: gcs - synchronizable: type: boolean + synchronizable: default: true - bucket: + type: boolean + title: + description: Cloud storage title + maxLength: 256 + nullable: true type: string + traceback: + description: Traceback report for the last failed sync nullable: true - description: GCS bucket name - prefix: type: string + use_blob_urls: + description: Interpret objects as BLOBs and generate URLs + type: boolean + required: + - dataset + type: object + GCSExportStorage: + properties: + bucket: + description: GCS bucket name nullable: true - description: GCS bucket prefix - regex_filter: type: string + can_delete_objects: + description: Deletion from storage enabled nullable: true - description: Cloud storage regex for filtering objects - use_blob_urls: type: boolean - description: Interpret objects as BLOBs and generate URLs - google_application_credentials: + created_at: + description: Creation time + format: date-time + readOnly: true type: string + description: + description: Cloud storage description nullable: true - description: The content of GOOGLE_APPLICATION_CREDENTIALS json file - google_project_id: type: string + google_application_credentials: + description: The content of GOOGLE_APPLICATION_CREDENTIALS json file nullable: true + type: string + google_project_id: description: Google project ID - last_sync: + nullable: true type: string + id: + readOnly: true + type: integer + last_sync: + description: Last sync finished time format: date-time nullable: true - description: Last sync finished time + type: string last_sync_count: - type: integer + description: Count of tasks synced last time maximum: 2147483647 minimum: 0 nullable: true - description: Count of tasks synced last time + type: integer last_sync_job: - type: string - nullable: true description: Last sync job ID maxLength: 256 - status: - $ref: '#/components/schemas/StatusC5aEnum' - traceback: - type: string nullable: true - description: Traceback report for the last failed sync + type: string meta: - nullable: true description: Meta and debug information about storage processes - title: - type: string nullable: true - description: Cloud storage title - maxLength: 256 - description: - type: string + prefix: + description: GCS bucket prefix nullable: true - description: Cloud storage description - created_at: type: string - format: date-time - readOnly: true - description: Creation time - can_delete_objects: - type: boolean - nullable: true - description: Deletion from storage enabled project: - type: integer description: A unique integer value identifying this project. - required: - - created_at - - id - - project - - type - GCSImportStorage: - type: object - properties: - id: type: integer - readOnly: true - type: + regex_filter: + description: Cloud storage regex for filtering objects + nullable: true type: string - readOnly: true - default: gcs + status: + $ref: '#/components/schemas/StatusC5aEnum' synchronizable: - type: boolean default: true - presign: type: boolean - default: true - bucket: - type: string + title: + description: Cloud storage title + maxLength: 256 nullable: true - description: GCS bucket name - prefix: type: string + traceback: + description: Traceback report for the last failed sync nullable: true - description: GCS bucket prefix - regex_filter: type: string - nullable: true - description: Cloud storage regex for filtering objects + type: + default: gcs + readOnly: true + type: string use_blob_urls: - type: boolean description: Interpret objects as BLOBs and generate URLs - google_application_credentials: + type: boolean + required: + - created_at + - id + - project + - type + type: object + GCSImportStorage: + properties: + bucket: + description: GCS bucket name + nullable: true + type: string + created_at: + description: Creation time + format: date-time + readOnly: true type: string + description: + description: Cloud storage description nullable: true - description: The content of GOOGLE_APPLICATION_CREDENTIALS json file - google_project_id: type: string + google_application_credentials: + description: The content of GOOGLE_APPLICATION_CREDENTIALS json file nullable: true + type: string + google_project_id: description: Google project ID - last_sync: + nullable: true type: string + id: + readOnly: true + type: integer + last_sync: + description: Last sync finished time format: date-time nullable: true - description: Last sync finished time + type: string last_sync_count: - type: integer + description: Count of tasks synced last time maximum: 2147483647 minimum: 0 nullable: true - description: Count of tasks synced last time + type: integer last_sync_job: - type: string - nullable: true description: Last sync job ID maxLength: 256 - status: - $ref: '#/components/schemas/StatusC5aEnum' - traceback: - type: string nullable: true - description: Traceback report for the last failed sync + type: string meta: - nullable: true description: Meta and debug information about storage processes - title: - type: string nullable: true - description: Cloud storage title - maxLength: 256 - description: - type: string + prefix: + description: GCS bucket prefix nullable: true - description: Cloud storage description - created_at: type: string - format: date-time - readOnly: true - description: Creation time + presign: + default: true + type: boolean presign_ttl: - type: integer + description: Presigned URLs TTL (in minutes) maximum: 32767 minimum: 0 - description: Presigned URLs TTL (in minutes) - project: type: integer + project: description: A unique integer value identifying this project. - required: - - created_at - - id - - project - - type - GCSWIFExportStorage: - type: object - properties: - id: type: integer - readOnly: true - type: + regex_filter: + description: Cloud storage regex for filtering objects + nullable: true type: string - readOnly: true - default: gcswif + status: + $ref: '#/components/schemas/StatusC5aEnum' synchronizable: - type: boolean default: true - bucket: + type: boolean + title: + description: Cloud storage title + maxLength: 256 + nullable: true type: string + traceback: + description: Traceback report for the last failed sync nullable: true - description: GCS bucket name - prefix: type: string + type: + default: gcs + readOnly: true + type: string + use_blob_urls: + description: Interpret objects as BLOBs and generate URLs + type: boolean + required: + - created_at + - id + - project + - type + type: object + GCSWIFExportStorage: + properties: + bucket: + description: GCS bucket name nullable: true - description: GCS bucket prefix - regex_filter: type: string + can_delete_objects: + description: Deletion from storage enabled nullable: true - description: Cloud storage regex for filtering objects - use_blob_urls: type: boolean - description: Interpret objects as BLOBs and generate URLs - google_application_credentials: + created_at: + description: Creation time + format: date-time + readOnly: true type: string + description: + description: Cloud storage description nullable: true - description: The content of GOOGLE_APPLICATION_CREDENTIALS json file - google_project_id: type: string + google_application_credentials: + description: The content of GOOGLE_APPLICATION_CREDENTIALS json file nullable: true - description: Google project ID - google_project_number: type: string + google_project_id: + description: Google project ID nullable: true + type: string + google_project_number: description: Google project number - google_wif_pool_id: + nullable: true type: string + google_service_account_email: + description: Google service account email nullable: true + type: string + google_wif_pool_id: description: Google WIF pool ID - google_wif_provider_id: + nullable: true type: string + google_wif_provider_id: + description: Google WIF provider ID nullable: true title: Google wif provider - description: Google WIF provider ID - google_service_account_email: type: string - nullable: true - description: Google service account email + id: + readOnly: true + type: integer last_sync: - type: string + description: Last sync finished time format: date-time nullable: true - description: Last sync finished time + type: string last_sync_count: - type: integer + description: Count of tasks synced last time maximum: 2147483647 minimum: 0 nullable: true - description: Count of tasks synced last time + type: integer last_sync_job: - type: string - nullable: true description: Last sync job ID maxLength: 256 - status: - $ref: '#/components/schemas/StatusC5aEnum' - traceback: - type: string nullable: true - description: Traceback report for the last failed sync + type: string meta: - nullable: true description: Meta and debug information about storage processes - title: + nullable: true + prefix: + description: GCS bucket prefix + nullable: true type: string + project: + description: A unique integer value identifying this project. + type: integer + regex_filter: + description: Cloud storage regex for filtering objects nullable: true + type: string + status: + $ref: '#/components/schemas/StatusC5aEnum' + synchronizable: + default: true + type: boolean + title: description: Cloud storage title maxLength: 256 - description: + nullable: true type: string + traceback: + description: Traceback report for the last failed sync nullable: true - description: Cloud storage description - created_at: type: string - format: date-time + type: + default: gcswif readOnly: true - description: Creation time - can_delete_objects: + type: string + use_blob_urls: + description: Interpret objects as BLOBs and generate URLs type: boolean - nullable: true - description: Deletion from storage enabled - project: - type: integer - description: A unique integer value identifying this project. required: - - created_at - - id - - project - - type - GCSWIFExportStorageRequest: + - created_at + - id + - project + - type type: object + GCSWIFExportStorageRequest: properties: - synchronizable: - type: boolean - default: true bucket: - type: string - nullable: true description: GCS bucket name - prefix: - type: string nullable: true - description: GCS bucket prefix - regex_filter: type: string + can_delete_objects: + description: Deletion from storage enabled nullable: true - description: Cloud storage regex for filtering objects - use_blob_urls: type: boolean - description: Interpret objects as BLOBs and generate URLs - google_application_credentials: - type: string + description: + description: Cloud storage description nullable: true - description: The content of GOOGLE_APPLICATION_CREDENTIALS json file - google_project_id: type: string + google_application_credentials: + description: The content of GOOGLE_APPLICATION_CREDENTIALS json file nullable: true - description: Google project ID - google_project_number: type: string + google_project_id: + description: Google project ID nullable: true + type: string + google_project_number: description: Google project number - google_wif_pool_id: + nullable: true type: string + google_service_account_email: + description: Google service account email nullable: true + type: string + google_wif_pool_id: description: Google WIF pool ID - google_wif_provider_id: + nullable: true type: string + google_wif_provider_id: + description: Google WIF provider ID nullable: true title: Google wif provider - description: Google WIF provider ID - google_service_account_email: type: string - nullable: true - description: Google service account email last_sync: - type: string + description: Last sync finished time format: date-time nullable: true - description: Last sync finished time + type: string last_sync_count: - type: integer + description: Count of tasks synced last time maximum: 2147483647 minimum: 0 nullable: true - description: Count of tasks synced last time + type: integer last_sync_job: - type: string - nullable: true description: Last sync job ID maxLength: 256 - status: - $ref: '#/components/schemas/StatusC5aEnum' - traceback: - type: string nullable: true - description: Traceback report for the last failed sync + type: string meta: - nullable: true description: Meta and debug information about storage processes - title: - type: string - nullable: true - description: Cloud storage title - maxLength: 256 - description: - type: string nullable: true - description: Cloud storage description - can_delete_objects: - type: boolean + prefix: + description: GCS bucket prefix nullable: true - description: Deletion from storage enabled + type: string project: - type: integer description: A unique integer value identifying this project. - required: - - project - GCSWIFImportStorage: - type: object - properties: - id: type: integer - readOnly: true - type: + regex_filter: + description: Cloud storage regex for filtering objects + nullable: true type: string - readOnly: true - default: gcswif + status: + $ref: '#/components/schemas/StatusC5aEnum' synchronizable: - type: boolean default: true - presign: type: boolean - default: true - bucket: - type: string + title: + description: Cloud storage title + maxLength: 256 nullable: true - description: GCS bucket name - prefix: type: string + traceback: + description: Traceback report for the last failed sync nullable: true - description: GCS bucket prefix - regex_filter: type: string - nullable: true - description: Cloud storage regex for filtering objects use_blob_urls: - type: boolean description: Interpret objects as BLOBs and generate URLs - google_application_credentials: + type: boolean + required: + - project + type: object + GCSWIFImportStorage: + properties: + bucket: + description: GCS bucket name + nullable: true + type: string + created_at: + description: Creation time + format: date-time + readOnly: true type: string + description: + description: Cloud storage description nullable: true - description: The content of GOOGLE_APPLICATION_CREDENTIALS json file - google_project_id: type: string + google_application_credentials: + description: The content of GOOGLE_APPLICATION_CREDENTIALS json file nullable: true - description: Google project ID - google_project_number: type: string + google_project_id: + description: Google project ID nullable: true + type: string + google_project_number: description: Google project number - google_wif_pool_id: + nullable: true type: string + google_service_account_email: + description: Google service account email nullable: true + type: string + google_wif_pool_id: description: Google WIF pool ID - google_wif_provider_id: + nullable: true type: string + google_wif_provider_id: + description: Google WIF provider ID nullable: true title: Google wif provider - description: Google WIF provider ID - google_service_account_email: type: string - nullable: true - description: Google service account email + id: + readOnly: true + type: integer last_sync: - type: string + description: Last sync finished time format: date-time nullable: true - description: Last sync finished time + type: string last_sync_count: - type: integer + description: Count of tasks synced last time maximum: 2147483647 minimum: 0 nullable: true - description: Count of tasks synced last time + type: integer last_sync_job: - type: string - nullable: true description: Last sync job ID maxLength: 256 - status: - $ref: '#/components/schemas/StatusC5aEnum' - traceback: - type: string nullable: true - description: Traceback report for the last failed sync + type: string meta: - nullable: true description: Meta and debug information about storage processes - title: - type: string nullable: true - description: Cloud storage title - maxLength: 256 - description: - type: string + prefix: + description: GCS bucket prefix nullable: true - description: Cloud storage description - created_at: type: string - format: date-time - readOnly: true - description: Creation time + presign: + default: true + type: boolean presign_ttl: - type: integer + description: Presigned URLs TTL (in minutes) maximum: 32767 minimum: 0 - description: Presigned URLs TTL (in minutes) - project: type: integer + project: description: A unique integer value identifying this project. - required: - - created_at - - id - - project - - type - GCSWIFImportStorageRequest: - type: object - properties: + type: integer + regex_filter: + description: Cloud storage regex for filtering objects + nullable: true + type: string + status: + $ref: '#/components/schemas/StatusC5aEnum' synchronizable: - type: boolean default: true - presign: type: boolean - default: true - bucket: - type: string + title: + description: Cloud storage title + maxLength: 256 nullable: true - description: GCS bucket name - prefix: type: string + traceback: + description: Traceback report for the last failed sync nullable: true - description: GCS bucket prefix - regex_filter: type: string - nullable: true - description: Cloud storage regex for filtering objects + type: + default: gcswif + readOnly: true + type: string use_blob_urls: - type: boolean description: Interpret objects as BLOBs and generate URLs - google_application_credentials: + type: boolean + required: + - created_at + - id + - project + - type + type: object + GCSWIFImportStorageRequest: + properties: + bucket: + description: GCS bucket name + nullable: true type: string + description: + description: Cloud storage description nullable: true - description: The content of GOOGLE_APPLICATION_CREDENTIALS json file - google_project_id: type: string + google_application_credentials: + description: The content of GOOGLE_APPLICATION_CREDENTIALS json file nullable: true - description: Google project ID - google_project_number: type: string + google_project_id: + description: Google project ID nullable: true + type: string + google_project_number: description: Google project number - google_wif_pool_id: + nullable: true type: string + google_service_account_email: + description: Google service account email nullable: true + type: string + google_wif_pool_id: description: Google WIF pool ID - google_wif_provider_id: + nullable: true type: string + google_wif_provider_id: + description: Google WIF provider ID nullable: true title: Google wif provider - description: Google WIF provider ID - google_service_account_email: type: string - nullable: true - description: Google service account email last_sync: - type: string + description: Last sync finished time format: date-time nullable: true - description: Last sync finished time + type: string last_sync_count: - type: integer + description: Count of tasks synced last time maximum: 2147483647 minimum: 0 nullable: true - description: Count of tasks synced last time + type: integer last_sync_job: - type: string - nullable: true description: Last sync job ID maxLength: 256 - status: - $ref: '#/components/schemas/StatusC5aEnum' - traceback: - type: string nullable: true - description: Traceback report for the last failed sync + type: string meta: - nullable: true description: Meta and debug information about storage processes - title: - type: string nullable: true - description: Cloud storage title - maxLength: 256 - description: - type: string + prefix: + description: GCS bucket prefix nullable: true - description: Cloud storage description + type: string + presign: + default: true + type: boolean presign_ttl: - type: integer + description: Presigned URLs TTL (in minutes) maximum: 32767 minimum: 0 - description: Presigned URLs TTL (in minutes) - project: type: integer + project: description: A unique integer value identifying this project. + type: integer + regex_filter: + description: Cloud storage regex for filtering objects + nullable: true + type: string + status: + $ref: '#/components/schemas/StatusC5aEnum' + synchronizable: + default: true + type: boolean + title: + description: Cloud storage title + maxLength: 256 + nullable: true + type: string + traceback: + description: Traceback report for the last failed sync + nullable: true + type: string + use_blob_urls: + description: Interpret objects as BLOBs and generate URLs + type: boolean required: - - project - Hotkeys: + - project type: object + Hotkeys: properties: custom_hotkeys: - type: object additionalProperties: {} + type: object required: - - custom_hotkeys - ImportApiRequest: + - custom_hotkeys type: object + ImportApiRequest: description: Tasks serializer for Import API (TaskBulkCreateAPI) properties: annotations: - type: array + default: [] items: $ref: '#/components/schemas/AnnotationRequest' - default: [] - predictions: type: array + cancelled_annotations: + description: Number of total cancelled annotations for the current task + maximum: 2147483647 + minimum: -2147483648 + type: integer + comment_authors: + description: Users who wrote comments items: - $ref: '#/components/schemas/PredictionRequest' - default: [] + type: integer + type: array + comment_count: + description: Number of comments in the task including all annotations + maximum: 2147483647 + minimum: -2147483648 + type: integer data: - description: User imported or uploaded data for a task. Data is formatted - according to the project label config. You can find examples of data for - your project on the Import page in the Label Studio Data Manager UI. - meta: + description: User imported or uploaded data for a task. Data is formatted according to the project label config. You can find examples of data for your project on the Import page in the Label Studio Data Manager UI. + file_upload: + description: Uploaded file used as data source for this task nullable: true - description: Meta is user imported (uploaded) data and can be useful as - input for an ML Backend for embeddings, advanced vectors, and other info. - It is passed to ML during training/predicting steps. - overlap: type: integer - maximum: 2147483647 - minimum: -2147483648 - description: Number of distinct annotators that processed the current task inner_id: - type: integer + description: Internal task ID in the project, starts with 1 + format: int64 maximum: 9223372036854775807 minimum: -9223372036854775808 - format: int64 nullable: true - description: Internal task ID in the project, starts with 1 - total_annotations: type: integer + last_comment_updated_at: + description: When the last comment was updated + format: date-time + nullable: true + type: string + meta: + description: Meta is user imported (uploaded) data and can be useful as input for an ML Backend for embeddings, advanced vectors, and other info. It is passed to ML during training/predicting steps. + nullable: true + overlap: + description: Number of distinct annotators that processed the current task maximum: 2147483647 minimum: -2147483648 - description: Number of total annotations for the current task except cancelled - annotations - cancelled_annotations: type: integer + predictions: + default: [] + items: + $ref: '#/components/schemas/PredictionRequest' + type: array + total_annotations: + description: Number of total annotations for the current task except cancelled annotations maximum: 2147483647 minimum: -2147483648 - description: Number of total cancelled annotations for the current task - total_predictions: type: integer - maximum: 2147483647 - minimum: -2147483648 + total_predictions: description: Number of total predictions for the current task - comment_count: - type: integer maximum: 2147483647 minimum: -2147483648 - description: Number of comments in the task including all annotations - unresolved_comment_count: type: integer + unresolved_comment_count: + description: Number of unresolved comments in the task including all annotations maximum: 2147483647 minimum: -2147483648 - description: Number of unresolved comments in the task including all annotations - last_comment_updated_at: - type: string - format: date-time - nullable: true - description: When the last comment was updated - updated_by: type: integer - nullable: true + updated_by: description: Last annotator or reviewer who updated this task - file_upload: - type: integer nullable: true - description: Uploaded file used as data source for this task - comment_authors: - type: array - items: - type: integer - description: Users who wrote comments + type: integer required: - - data - InferenceRunCostEstimate: + - data type: object + InferenceRunCostEstimate: properties: - prompt_cost_usd: - type: string - nullable: true - description: Cost of the prompt (in USD) completion_cost_usd: + description: Cost of the completion (in USD) + nullable: true type: string + error_message: + description: Error message details nullable: true - description: Cost of the completion (in USD) - total_cost_usd: type: string + error_type: + description: Type of error (e.g. "Timeout", "Rate Limit", etc) nullable: true - description: Total cost of the inference (in USD) + type: string is_error: + description: Whether an error occurred or not + nullable: true type: boolean + prompt_cost_usd: + description: Cost of the prompt (in USD) nullable: true - description: Whether an error occurred or not - error_type: type: string + total_cost_usd: + description: Total cost of the inference (in USD) nullable: true - description: Type of error (e.g. "Timeout", "Rate Limit", etc) - error_message: type: string - nullable: true - description: Error message details - LSAPITokenBlacklistRequest: type: object + LSAPITokenBlacklistRequest: properties: refresh: + minLength: 1 type: string writeOnly: true - minLength: 1 required: - - refresh - LSAPITokenRotateRequest: + - refresh type: object + LSAPITokenRotateRequest: properties: refresh: - type: string minLength: 1 + type: string required: - - refresh - LSEAPITokenCreate: + - refresh type: object + LSEAPITokenCreate: properties: - token: - type: string - readOnly: true created_at: - type: string readOnly: true + type: string expires_at: + readOnly: true type: string + token: readOnly: true + type: string required: - - created_at - - expires_at - - token - LSEAPITokenList: + - created_at + - expires_at + - token type: object + LSEAPITokenList: properties: - token: - type: string - readOnly: true created_at: - type: string readOnly: true + type: string expires_at: + readOnly: true type: string + token: readOnly: true + type: string required: - - created_at - - expires_at - - token - LSEJWTSettings: + - created_at + - expires_at + - token type: object + LSEJWTSettings: properties: - api_tokens_enabled: - type: boolean - title: JWT API tokens enabled - description: Enable JWT API token authentication for this organization - legacy_api_tokens_enabled: - type: boolean - description: Enable legacy API token authentication for this organization api_token_ttl_days: - type: integer + description: Number of days before JWT API tokens expire maximum: 2147483647 minimum: -2147483648 title: JWT API token time to live (days) - description: Number of days before JWT API tokens expire - LSEJWTSettingsRequest: - type: object - properties: + type: integer api_tokens_enabled: - type: boolean - title: JWT API tokens enabled description: Enable JWT API token authentication for this organization - legacy_api_tokens_enabled: + title: JWT API tokens enabled type: boolean + legacy_api_tokens_enabled: description: Enable legacy API token authentication for this organization + type: boolean + type: object + LSEJWTSettingsRequest: + properties: api_token_ttl_days: - type: integer + description: Number of days before JWT API tokens expire maximum: 2147483647 minimum: -2147483648 title: JWT API token time to live (days) - description: Number of days before JWT API tokens expire + type: integer + api_tokens_enabled: + description: Enable JWT API token authentication for this organization + title: JWT API tokens enabled + type: boolean + legacy_api_tokens_enabled: + description: Enable legacy API token authentication for this organization + type: boolean + type: object LSEKeyIndicatorValue: description: |- Key indicator value for Label Studio Enterprise. @@ -18998,194 +18736,193 @@ components: title: Values type: object required: - - title - - values + - title + - values title: LSEKeyIndicatorValue type: object Label: - type: object description: |- 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: + approved: + description: Status of label + type: boolean + approved_by: + description: User who approved this label + nullable: true type: integer - readOnly: true - links: - type: array - items: - type: integer - readOnly: true created_at: - type: string - format: date-time - readOnly: true description: Time of label creation - updated_at: - type: string format: date-time readOnly: true - description: Time of label modification - value: - description: Label value - title: type: string - description: Label title - maxLength: 2048 + created_by: + description: User who made this label + type: integer description: - type: string - nullable: true description: Label description - approved: - type: boolean - description: Status of label - created_by: - type: integer - description: User who made this label - approved_by: - type: integer nullable: true - description: User who approved this label + type: string + id: + readOnly: true + type: integer + links: + items: + type: integer + readOnly: true + type: array organization: type: integer projects: - type: array items: type: integer readOnly: true + type: array + title: + description: Label title + maxLength: 2048 + type: string + updated_at: + description: Time of label modification + format: date-time + readOnly: true + type: string + value: + description: Label value required: - - created_at - - created_by - - id - - links - - organization - - projects - - title - - updated_at - - value - LabelCreate: + - created_at + - created_by + - id + - links + - organization + - projects + - title + - updated_at + - value type: object + LabelCreate: properties: - id: + approved: + description: Status of label + type: boolean + approved_by: + description: User who approved this label + nullable: true type: integer + created_at: + description: Time of label creation + format: date-time readOnly: true + type: string created_by: + readOnly: true type: integer + description: + description: Label description + nullable: true + type: string + from_name: + type: string + id: readOnly: true - organization: type: integer + organization: readOnly: true + type: integer project: type: integer - from_name: - type: string - created_at: - type: string - format: date-time + projects: + items: + type: integer readOnly: true - description: Time of label creation - updated_at: + type: array + title: + description: Label title + maxLength: 2048 type: string + updated_at: + description: Time of label modification format: date-time readOnly: true - description: Time of label modification + type: string value: description: Label value - title: - type: string - description: Label title - maxLength: 2048 - description: - type: string - nullable: true - description: Label description + required: + - created_at + - created_by + - from_name + - id + - organization + - project + - projects + - title + - updated_at + - value + type: object + LabelCreateRequest: + properties: approved: - type: boolean description: Status of label + type: boolean approved_by: - type: integer - nullable: true description: User who approved this label - projects: - type: array - items: - type: integer - readOnly: true - required: - - created_at - - created_by - - from_name - - id - - organization - - project - - projects - - title - - updated_at - - value - LabelCreateRequest: - type: object - properties: - project: + nullable: true type: integer - from_name: + description: + description: Label description + nullable: true type: string + from_name: minLength: 1 - value: - description: Label value - title: type: string - minLength: 1 + project: + type: integer + title: description: Label title maxLength: 2048 - description: + minLength: 1 type: string - nullable: true - description: Label description - approved: - type: boolean - description: Status of label - approved_by: - type: integer - nullable: true - description: User who approved this label + value: + description: Label value required: - - from_name - - project - - title - - value - LabelLink: + - from_name + - project + - title + - value type: object + LabelLink: description: |- 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: - type: integer - readOnly: true annotations_count: - type: integer readOnly: true + type: integer from_name: - type: string - title: Tag name description: Tag name maxLength: 2048 - project: + title: Tag name + type: string + id: + readOnly: true type: integer label: type: integer + project: + type: integer required: - - annotations_count - - from_name - - id - - label - - project - LabelLinkRequest: + - annotations_count + - from_name + - id + - label + - project type: object + LabelLinkRequest: description: |- A ModelSerializer that takes additional arguments for "fields", "omit" and "expand" in order to @@ -19193,40 +18930,29 @@ components: values with complex, nested serializations properties: from_name: - type: string - minLength: 1 - title: Tag name description: Tag name maxLength: 2048 - project: - type: integer + minLength: 1 + title: Tag name + type: string label: type: integer + project: + type: integer required: - - from_name - - label - - project + - from_name + - label + - project + type: object LabelStreamTaskDistributionEnum: - enum: - - auto_distribution - - assigned_only - type: string description: |- * `auto_distribution` - Label Stream distributes tasks automatically to annotators * `assigned_only` - Label Stream shows tasks only to assigned users - LastActionEnum: enum: - - prediction - - propagated_annotation - - imported - - submitted - - updated - - skipped - - accepted - - rejected - - fixed_and_accepted - - deleted_review + - auto_distribution + - assigned_only type: string + LastActionEnum: description: |- * `prediction` - Created from prediction * `propagated_annotation` - Created from another annotation @@ -19238,330 +18964,318 @@ components: * `rejected` - Rejected * `fixed_and_accepted` - Fixed and accepted * `deleted_review` - Deleted review + enum: + - prediction + - propagated_annotation + - imported + - submitted + - updated + - skipped + - accepted + - rejected + - fixed_and_accepted + - deleted_review + type: string LocalFilesExportStorage: - type: object properties: - id: - type: integer - readOnly: true - type: - type: string - readOnly: true - default: localfiles - synchronizable: + can_delete_objects: + description: Deletion from storage enabled + nullable: true type: boolean - default: true - path: + created_at: + description: Creation time + format: date-time + readOnly: true type: string + description: + description: Cloud storage description nullable: true - description: Local path - regex_filter: type: string - nullable: true - description: Regex for filtering objects - use_blob_urls: - type: boolean - description: Interpret objects as BLOBs and generate URLs + id: + readOnly: true + type: integer last_sync: - type: string + description: Last sync finished time format: date-time nullable: true - description: Last sync finished time + type: string last_sync_count: - type: integer + description: Count of tasks synced last time maximum: 2147483647 minimum: 0 nullable: true - description: Count of tasks synced last time + type: integer last_sync_job: - type: string - nullable: true description: Last sync job ID maxLength: 256 - status: - $ref: '#/components/schemas/StatusC5aEnum' - traceback: - type: string nullable: true - description: Traceback report for the last failed sync + type: string meta: - nullable: true description: Meta and debug information about storage processes - title: + nullable: true + path: + description: Local path + nullable: true type: string + project: + description: A unique integer value identifying this project. + type: integer + regex_filter: + description: Regex for filtering objects nullable: true + type: string + status: + $ref: '#/components/schemas/StatusC5aEnum' + synchronizable: + default: true + type: boolean + title: description: Cloud storage title maxLength: 256 - description: + nullable: true type: string + traceback: + description: Traceback report for the last failed sync nullable: true - description: Cloud storage description - created_at: type: string - format: date-time + type: + default: localfiles readOnly: true - description: Creation time - can_delete_objects: + type: string + use_blob_urls: + description: Interpret objects as BLOBs and generate URLs type: boolean - nullable: true - description: Deletion from storage enabled - project: - type: integer - description: A unique integer value identifying this project. required: - - created_at - - id - - project - - type - LocalFilesImportStorage: + - created_at + - id + - project + - type type: object + LocalFilesImportStorage: properties: - id: - type: integer + created_at: + description: Creation time + format: date-time readOnly: true - type: - type: string - readOnly: true - default: localfiles - synchronizable: - type: boolean - default: true - path: type: string + description: + description: Cloud storage description nullable: true - description: Local path - regex_filter: type: string - nullable: true - description: Regex for filtering objects - use_blob_urls: - type: boolean - description: Interpret objects as BLOBs and generate URLs + id: + readOnly: true + type: integer last_sync: - type: string + description: Last sync finished time format: date-time nullable: true - description: Last sync finished time + type: string last_sync_count: - type: integer + description: Count of tasks synced last time maximum: 2147483647 minimum: 0 nullable: true - description: Count of tasks synced last time + type: integer last_sync_job: - type: string - nullable: true description: Last sync job ID maxLength: 256 - status: - $ref: '#/components/schemas/StatusC5aEnum' - traceback: - type: string nullable: true - description: Traceback report for the last failed sync + type: string meta: - nullable: true description: Meta and debug information about storage processes - title: + nullable: true + path: + description: Local path + nullable: true type: string + project: + description: A unique integer value identifying this project. + type: integer + regex_filter: + description: Regex for filtering objects nullable: true + type: string + status: + $ref: '#/components/schemas/StatusC5aEnum' + synchronizable: + default: true + type: boolean + title: description: Cloud storage title maxLength: 256 - description: + nullable: true type: string + traceback: + description: Traceback report for the last failed sync nullable: true - description: Cloud storage description - created_at: type: string - format: date-time + type: + default: localfiles readOnly: true - description: Creation time - project: - type: integer - description: A unique integer value identifying this project. + type: string + use_blob_urls: + description: Interpret objects as BLOBs and generate URLs + type: boolean required: - - created_at - - id - - project - - type - LseAnnotationFilterOptions: + - created_at + - id + - project + - type type: object + LseAnnotationFilterOptions: properties: - usual: - type: boolean - nullable: true - default: true - description: Include not skipped and not ground truth annotations ground_truth: - type: boolean - nullable: true description: Include ground truth annotations - skipped: - type: boolean nullable: true - description: Include skipped annotations + type: boolean reviewed: - nullable: true description: |- `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 + nullable: true oneOf: - - $ref: '#/components/schemas/ReviewedEnum' - - $ref: '#/components/schemas/NullEnum' - LseAnnotationFilterOptionsRequest: - type: object - properties: - usual: - type: boolean + - $ref: '#/components/schemas/ReviewedEnum' + - $ref: '#/components/schemas/NullEnum' + skipped: + description: Include skipped annotations nullable: true + type: boolean + usual: default: true description: Include not skipped and not ground truth annotations - ground_truth: - type: boolean nullable: true - description: Include ground truth annotations - skipped: type: boolean + type: object + LseAnnotationFilterOptionsRequest: + properties: + ground_truth: + description: Include ground truth annotations nullable: true - description: Include skipped annotations + type: boolean reviewed: - nullable: true description: |- `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 + nullable: true oneOf: - - $ref: '#/components/schemas/ReviewedEnum' - - $ref: '#/components/schemas/NullEnum' - LseExportCreate: + - $ref: '#/components/schemas/ReviewedEnum' + - $ref: '#/components/schemas/NullEnum' + skipped: + description: Include skipped annotations + nullable: true + type: boolean + usual: + default: true + description: Include not skipped and not ground truth annotations + nullable: true + type: boolean type: object + LseExportCreate: properties: - title: - type: string - maxLength: 2048 - id: - type: integer - readOnly: true - created_by: - $ref: '#/components/schemas/UserSimple' + annotation_filter_options: + $ref: '#/components/schemas/LseAnnotationFilterOptions' + converted_formats: + items: + $ref: '#/components/schemas/ConvertedFormat' + type: array + counters: + title: Exporting meta data created_at: - type: string + description: Creation time format: date-time readOnly: true - description: Creation time - finished_at: type: string + created_by: + $ref: '#/components/schemas/UserSimple' + finished_at: + description: Complete or fail time format: date-time nullable: true - description: Complete or fail time + type: string + id: + readOnly: true + type: integer + md5: + maxLength: 128 + title: Md5 of file + type: string + serialization_options: + $ref: '#/components/schemas/SerializationOptions' status: allOf: - - $ref: '#/components/schemas/Status7bfEnum' + - $ref: '#/components/schemas/Status7bfEnum' title: Export status - md5: - type: string - title: Md5 of file - maxLength: 128 - counters: - title: Exporting meta data - converted_formats: - type: array - items: - $ref: '#/components/schemas/ConvertedFormat' task_filter_options: $ref: '#/components/schemas/LseTaskFilterOptions' - annotation_filter_options: - $ref: '#/components/schemas/LseAnnotationFilterOptions' - serialization_options: - $ref: '#/components/schemas/SerializationOptions' + title: + maxLength: 2048 + type: string required: - - created_at - - id - LseExportCreateRequest: + - created_at + - id type: object + LseExportCreateRequest: properties: - title: - type: string - maxLength: 2048 + annotation_filter_options: + $ref: '#/components/schemas/LseAnnotationFilterOptionsRequest' + converted_formats: + items: + $ref: '#/components/schemas/ConvertedFormatRequest' + type: array + counters: + title: Exporting meta data created_by: $ref: '#/components/schemas/UserSimpleRequest' finished_at: - type: string + description: Complete or fail time format: date-time nullable: true - description: Complete or fail time - status: - allOf: - - $ref: '#/components/schemas/Status7bfEnum' - title: Export status - md5: type: string + md5: + maxLength: 128 minLength: 1 title: Md5 of file - maxLength: 128 - counters: - title: Exporting meta data - converted_formats: - type: array - items: - $ref: '#/components/schemas/ConvertedFormatRequest' - task_filter_options: - $ref: '#/components/schemas/LseTaskFilterOptionsRequest' - annotation_filter_options: - $ref: '#/components/schemas/LseAnnotationFilterOptionsRequest' + type: string serialization_options: $ref: '#/components/schemas/SerializationOptionsRequest' - LseFields: + status: + allOf: + - $ref: '#/components/schemas/Status7bfEnum' + title: Export status + task_filter_options: + $ref: '#/components/schemas/LseTaskFilterOptionsRequest' + title: + maxLength: 2048 + type: string type: object + LseFields: properties: - invite_expired: - type: string - readOnly: true - invite_expired_at: - type: string + email_notification_settings: readOnly: true - invited_at: type: string - format: date-time - nullable: true invite_activated: - type: boolean nullable: true - trial_company: + type: boolean + invite_expired: + readOnly: true type: string - nullable: true - maxLength: 1000 - trial_role: - nullable: true - oneOf: - - $ref: '#/components/schemas/TrialRoleEnum' - - $ref: '#/components/schemas/BlankEnum' - - $ref: '#/components/schemas/NullEnum' - trial_models_in_production: + invite_expired_at: + readOnly: true type: string + invited_at: + format: date-time nullable: true - maxLength: 1000 - trial_experience_labeling: type: string - nullable: true - maxLength: 1000 - trial_license_enterprise: - type: boolean - nullable: true - social_auth_finished: - type: boolean - nullable: true - description: Is user finished social authentication invited_by: - type: integer nullable: true + type: integer onboarding_state: - nullable: true description: |- The current stage of user onboarding @@ -19571,57 +19285,54 @@ components: * `first_tutorial` - First Tutorial * `in_app_guidance` - In App Guidance * `complete` - Complete + nullable: true oneOf: - - $ref: '#/components/schemas/OnboardingStateEnum' - - $ref: '#/components/schemas/BlankEnum' - - $ref: '#/components/schemas/NullEnum' - email_notification_settings: - type: string - readOnly: true - required: - - email_notification_settings - - invite_expired - - invite_expired_at - LseFieldsRequest: - type: object - properties: - invited_at: - type: string - format: date-time + - $ref: '#/components/schemas/OnboardingStateEnum' + - $ref: '#/components/schemas/BlankEnum' + - $ref: '#/components/schemas/NullEnum' + social_auth_finished: + description: Is user finished social authentication nullable: true - invite_activated: type: boolean - nullable: true trial_company: - type: string + maxLength: 1000 nullable: true + type: string + trial_experience_labeling: maxLength: 1000 - trial_role: nullable: true - oneOf: - - $ref: '#/components/schemas/TrialRoleEnum' - - $ref: '#/components/schemas/BlankEnum' - - $ref: '#/components/schemas/NullEnum' - trial_models_in_production: type: string + trial_license_enterprise: nullable: true + type: boolean + trial_models_in_production: maxLength: 1000 - trial_experience_labeling: + nullable: true type: string + trial_role: nullable: true - maxLength: 1000 - trial_license_enterprise: - type: boolean + oneOf: + - $ref: '#/components/schemas/TrialRoleEnum' + - $ref: '#/components/schemas/BlankEnum' + - $ref: '#/components/schemas/NullEnum' + required: + - email_notification_settings + - invite_expired + - invite_expired_at + type: object + LseFieldsRequest: + properties: + invite_activated: nullable: true - social_auth_finished: type: boolean + invited_at: + format: date-time nullable: true - description: Is user finished social authentication + type: string invited_by: - type: integer nullable: true + type: integer onboarding_state: - nullable: true description: |- The current stage of user onboarding @@ -19631,29 +19342,61 @@ components: * `first_tutorial` - First Tutorial * `in_app_guidance` - In App Guidance * `complete` - Complete + nullable: true oneOf: - - $ref: '#/components/schemas/OnboardingStateEnum' - - $ref: '#/components/schemas/BlankEnum' - - $ref: '#/components/schemas/NullEnum' - LseOrganization: + - $ref: '#/components/schemas/OnboardingStateEnum' + - $ref: '#/components/schemas/BlankEnum' + - $ref: '#/components/schemas/NullEnum' + social_auth_finished: + description: Is user finished social authentication + nullable: true + type: boolean + trial_company: + maxLength: 1000 + nullable: true + type: string + trial_experience_labeling: + maxLength: 1000 + nullable: true + type: string + trial_license_enterprise: + nullable: true + type: boolean + trial_models_in_production: + maxLength: 1000 + nullable: true + type: string + trial_role: + nullable: true + oneOf: + - $ref: '#/components/schemas/TrialRoleEnum' + - $ref: '#/components/schemas/BlankEnum' + - $ref: '#/components/schemas/NullEnum' type: object + LseOrganization: properties: - id: - type: integer + billing: + $ref: '#/components/schemas/OrganizationBilling' + created_at: + format: date-time readOnly: true - external_id: type: string + custom_scripts_editable_by: + description: |- + Set the minimum user role that can edit custom scripts in the UI. + + * `AD` - Administrator + * `MA` - Manager nullable: true - description: External ID to uniquely identify this organization - title: - type: string + oneOf: + - $ref: '#/components/schemas/CustomScriptsEditableByEnum' + - $ref: '#/components/schemas/NullEnum' + custom_scripts_enabled: readOnly: true - token: type: string - readOnly: true default_role: allOf: - - $ref: '#/components/schemas/DefaultRoleEnum' + - $ref: '#/components/schemas/DefaultRoleEnum' description: |- Default membership role for invited users @@ -19664,3044 +19407,2937 @@ components: * `AN` - Annotator * `DI` - Deactivated * `NO` - Not Activated - created_at: - type: string - format: date-time + email_notification_settings: readOnly: true - billing: - $ref: '#/components/schemas/OrganizationBilling' + type: string embed_domains: + description: 'List of objects: {"domain": "example.com"}. Used for CSP header on /embed routes.' nullable: true - description: 'List of objects: {"domain": "example.com"}. Used for CSP header - on /embed routes.' embed_settings: - nullable: true description: Embed settings for this organization - custom_scripts_enabled: + nullable: true + external_id: + description: External ID to uniquely identify this organization + nullable: true type: string + id: + readOnly: true + type: integer + title: readOnly: true - custom_scripts_editable_by: - nullable: true - description: |- - Set the minimum user role that can edit custom scripts in the UI. - - * `AD` - Administrator - * `MA` - Manager - oneOf: - - $ref: '#/components/schemas/CustomScriptsEditableByEnum' - - $ref: '#/components/schemas/NullEnum' - email_notification_settings: type: string + token: readOnly: true + type: string required: - - billing - - created_at - - custom_scripts_enabled - - email_notification_settings - - id - - title - - token - LseOrganizationMemberList: + - billing + - created_at + - custom_scripts_enabled + - email_notification_settings + - id + - title + - token type: object + LseOrganizationMemberList: description: |- A serializer mixin that takes an additional `fields` argument that controls which fields should be displayed. properties: id: - type: integer readOnly: true - organization: type: integer + organization: description: Organization ID - user: - $ref: '#/components/schemas/LseUserOrganizationMemberList' + type: integer role: - type: string readOnly: true + type: string + user: + $ref: '#/components/schemas/LseUserOrganizationMemberList' required: - - id - - organization - - role - - user - LseProject: + - id + - organization + - role + - user type: object + LseProject: description: |- Serializer get numbers from project queryset annotation, make sure, that you use correct one(Project.objects.with_counts()) properties: - id: - type: integer - readOnly: true - title: - type: string + annotation_limit_count: + minimum: 1 nullable: true - description: Project name. Must be between 3 and 50 characters long. - maxLength: 50 - minLength: 3 - description: - type: string + type: integer + annotation_limit_percent: + format: decimal nullable: true - description: Project description - label_config: + pattern: ^-?\d{0,3}(?:\.\d{0,2})?$ type: string + annotator_evaluation_minimum_score: + default: '95.00' + format: decimal nullable: true - description: Label config in XML format. See more about it in documentation - expert_instruction: + pattern: ^-?\d{0,3}(?:\.\d{0,2})?$ type: string + annotator_evaluation_minimum_tasks: + default: 10 + minimum: 0 nullable: true - description: Labeling instructions in HTML format - show_instruction: - type: boolean - description: Show instructions to the annotator before they start - show_skip_button: - type: boolean - description: Show a skip button in interface and allow annotators to skip - the task - enable_empty_annotation: - type: boolean - description: Allow annotators to submit empty annotations - show_annotation_history: - type: boolean - description: Show annotation history to annotator - organization: type: integer - nullable: true + assignment_settings: + $ref: '#/components/schemas/AssignmentSettings' color: - type: string - nullable: true maxLength: 16 - 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) - is_published: - type: boolean - title: Published - description: Whether or not the project is published to annotators - model_version: - type: string nullable: true - description: Machine learning model version - is_draft: + type: string + comment_classification_config: + type: string + config_has_control_tags: + description: Flag to detect is project ready for labeling + readOnly: true type: boolean - description: Whether or not the project is in the middle of being created + config_suitable_for_bulk_annotation: + description: Flag to detect is project ready for bulk annotation + readOnly: true + type: boolean + control_weights: + 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}' + nullable: true + created_at: + format: date-time + readOnly: true + type: string created_by: allOf: - - $ref: '#/components/schemas/UserSimple' + - $ref: '#/components/schemas/UserSimple' description: Project owner - created_at: + custom_script: type: string - format: date-time - readOnly: true - min_annotations_to_start_training: + custom_task_lock_ttl: + description: TTL in seconds for task reservations, on new and existing tasks + maximum: 86400 + minimum: 1 + nullable: true type: integer - maximum: 2147483647 - minimum: -2147483648 - description: Minimum number of completed tasks after which model training - is started - start_training_on_annotation_update: - type: boolean + data_types: + nullable: true readOnly: true - description: Start model training after any annotations are submitted or - updated - show_collab_predictions: + description: + description: Project description + nullable: true + type: string + duplication_done: + default: false type: boolean - title: Show predictions to annotator - description: If set, the annotator can view model predictions - num_tasks_with_annotations: - type: integer - readOnly: true - description: Tasks with annotations count - task_number: - type: integer + duplication_status: + type: string + enable_empty_annotation: + description: Allow annotators to submit empty annotations + type: boolean + evaluate_predictions_automatically: + description: Retrieve and display predictions when loading a task + type: boolean + expert_instruction: + description: Labeling instructions in HTML format + nullable: true + type: string + finished_task_number: + description: Finished tasks readOnly: true - description: Total task number in project - useful_annotation_number: type: integer - readOnly: true - description: 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 - readOnly: true description: Honeypot annotation number in project - skipped_annotations_number: - type: integer readOnly: true - description: Skipped by collaborators annotation number in project - total_annotations_number: type: integer + id: readOnly: true - description: Total annotations number in project including skipped_annotations_number - and ground_truth_number. - total_predictions_number: type: integer - readOnly: true - description: Total predictions number in project including skipped_annotations_number, - ground_truth_number, and useful_annotation_number. - sampling: - nullable: true - oneOf: - - $ref: '#/components/schemas/SamplingEnum' - - $ref: '#/components/schemas/NullEnum' - show_ground_truth_first: + is_draft: + description: Whether or not the project is in the middle of being created type: boolean - show_overlap_first: + is_published: + description: Whether or not the project is published to annotators + title: Published type: boolean - overlap_cohort_percentage: - type: integer + label_config: + description: Label config in XML format. See more about it in documentation + nullable: true + type: string + maximum_annotations: + 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) maximum: 2147483647 minimum: -2147483648 - task_data_login: + title: Maximum annotation number + type: integer + members: + readOnly: true type: string + members_count: + readOnly: true + type: integer + min_annotations_to_start_training: + description: Minimum number of completed tasks after which model training is started + maximum: 2147483647 + minimum: -2147483648 + type: integer + model_version: + description: Machine learning model version nullable: true - description: 'Task data credentials: login' - maxLength: 256 - task_data_password: type: string + num_tasks_with_annotations: + description: Tasks with annotations count + readOnly: true + type: integer + organization: nullable: true - description: 'Task data credentials: password' - maxLength: 256 - 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}' + type: integer + overlap_cohort_percentage: + maximum: 2147483647 + minimum: -2147483648 + type: integer parsed_label_config: - readOnly: true description: JSON-formatted labeling configuration - evaluate_predictions_automatically: - type: boolean - description: Retrieve and display predictions when loading a task - config_has_control_tags: - type: boolean readOnly: true - description: Flag to detect is project ready for labeling - skip_queue: + pause_on_failed_annotator_evaluation: + default: false nullable: true - oneOf: - - $ref: '#/components/schemas/SkipQueueEnum' - - $ref: '#/components/schemas/NullEnum' - reveal_preannotations_interactively: type: boolean - description: Reveal pre-annotations interactively pinned_at: - type: string + description: Pinned date and time format: date-time nullable: true - description: Pinned date and time - finished_task_number: - type: integer - readOnly: true - description: Finished tasks - queue_total: type: string + prompts: readOnly: true - queue_done: type: string + queue_done: readOnly: true - config_suitable_for_bulk_annotation: - type: boolean + type: string + queue_left: readOnly: true - description: Flag to detect is project ready for bulk annotation - workspace: type: string + queue_total: readOnly: true + type: string + require_comment_on_skip: + default: false + type: boolean + reveal_preannotations_interactively: + description: Reveal pre-annotations interactively + type: boolean review_settings: $ref: '#/components/schemas/ReviewSettings' - assignment_settings: - $ref: '#/components/schemas/AssignmentSettings' - members: - type: string + reviewer_queue_total: readOnly: true - custom_script: - type: string - comment_classification_config: type: string - duplication_done: + sampling: + nullable: true + oneOf: + - $ref: '#/components/schemas/SamplingEnum' + - $ref: '#/components/schemas/NullEnum' + show_annotation_history: + description: Show annotation history to annotator type: boolean - default: false - duplication_status: - type: string - require_comment_on_skip: + show_collab_predictions: + description: If set, the annotator can view model predictions + title: Show predictions to annotator type: boolean - default: false - data_types: - readOnly: true + show_ground_truth_first: + type: boolean + show_instruction: + description: Show instructions to the annotator before they start + type: boolean + show_overlap_first: + type: boolean + show_skip_button: + description: Show a skip button in interface and allow annotators to skip the task + type: boolean + skip_queue: nullable: true - reviewer_queue_total: - type: string + oneOf: + - $ref: '#/components/schemas/SkipQueueEnum' + - $ref: '#/components/schemas/NullEnum' + skipped_annotations_number: + description: Skipped by collaborators annotation number in project readOnly: true - queue_left: - type: string + type: integer + start_training_on_annotation_update: + description: Start model training after any annotations are submitted or updated readOnly: true - members_count: + type: boolean + task_data_login: + description: 'Task data credentials: login' + maxLength: 256 + nullable: true type: string - readOnly: true - custom_task_lock_ttl: - type: integer - maximum: 86400 - minimum: 1 + task_data_password: + description: 'Task data credentials: password' + maxLength: 256 nullable: true - description: TTL in seconds for task reservations, on new and existing tasks - prompts: type: string + task_number: + description: Total task number in project readOnly: true - annotation_limit_count: type: integer - minimum: 1 - nullable: true - annotation_limit_percent: - type: string - format: decimal - pattern: ^-?\d{0,3}(?:\.\d{0,2})?$ - nullable: true - pause_on_failed_annotator_evaluation: - type: boolean + title: + description: Project name. Must be between 3 and 50 characters long. + maxLength: 50 + minLength: 3 nullable: true - default: false - annotator_evaluation_minimum_score: type: string - format: decimal - pattern: ^-?\d{0,3}(?:\.\d{0,2})?$ - nullable: true - default: '95.00' - annotator_evaluation_minimum_tasks: + total_annotations_number: + description: Total annotations number in project including skipped_annotations_number and ground_truth_number. + readOnly: true type: integer - minimum: 0 - nullable: true - default: 10 - workspace_title: + total_predictions_number: + description: Total predictions number in project including skipped_annotations_number, ground_truth_number, and useful_annotation_number. + readOnly: true + type: integer + useful_annotation_number: + description: Useful annotation number in project not including skipped_annotations_number and ground_truth_number. Total annotations = annotation_number + skipped_annotations_number + ground_truth_number + readOnly: true + type: integer + workspace: + readOnly: true type: string + workspace_title: readOnly: true + type: string required: - - assignment_settings - - config_has_control_tags - - config_suitable_for_bulk_annotation - - created_at - - data_types - - finished_task_number - - ground_truth_number - - id - - members - - members_count - - num_tasks_with_annotations - - parsed_label_config - - prompts - - queue_done - - queue_left - - queue_total - - review_settings - - reviewer_queue_total - - skipped_annotations_number - - start_training_on_annotation_update - - task_number - - total_annotations_number - - total_predictions_number - - useful_annotation_number - - workspace - - workspace_title - LseProjectCounts: + - assignment_settings + - config_has_control_tags + - config_suitable_for_bulk_annotation + - created_at + - data_types + - finished_task_number + - ground_truth_number + - id + - members + - members_count + - num_tasks_with_annotations + - parsed_label_config + - prompts + - queue_done + - queue_left + - queue_total + - review_settings + - reviewer_queue_total + - skipped_annotations_number + - start_training_on_annotation_update + - task_number + - total_annotations_number + - total_predictions_number + - useful_annotation_number + - workspace + - workspace_title type: object + LseProjectCounts: description: |- Serializer get numbers from project queryset annotation, make sure, that you use correct one(Project.objects.with_counts()) properties: - id: - type: integer + finished_task_number: readOnly: true - task_number: type: integer + ground_truth_number: + description: Honeypot annotation number in project readOnly: true - description: Total task number in project - finished_task_number: type: integer + id: readOnly: true - total_predictions_number: type: integer + num_tasks_with_annotations: readOnly: true - total_annotations_number: type: string + queue_done: readOnly: true - num_tasks_with_annotations: type: string + queue_left: readOnly: true - useful_annotation_number: type: string + queue_total: readOnly: true - ground_truth_number: - type: integer - readOnly: true - description: Honeypot annotation number in project - skipped_annotations_number: type: string - readOnly: true rejected: - type: string readOnly: true - queue_total: type: string + review_total_tasks: readOnly: true - queue_done: type: string + reviewed_number: readOnly: true - queue_left: type: string + skipped_annotations_number: readOnly: true - reviewed_number: type: string + task_number: + description: Total task number in project + readOnly: true + type: integer + total_annotations_number: readOnly: true - review_total_tasks: type: string + total_predictions_number: + readOnly: true + type: integer + useful_annotation_number: readOnly: true + type: string required: - - finished_task_number - - ground_truth_number - - id - - num_tasks_with_annotations - - queue_done - - queue_left - - queue_total - - rejected - - review_total_tasks - - reviewed_number - - skipped_annotations_number - - task_number - - total_annotations_number - - total_predictions_number - - useful_annotation_number - LseProjectCreate: + - finished_task_number + - ground_truth_number + - id + - num_tasks_with_annotations + - queue_done + - queue_left + - queue_total + - rejected + - review_total_tasks + - reviewed_number + - skipped_annotations_number + - task_number + - total_annotations_number + - total_predictions_number + - useful_annotation_number type: object + LseProjectCreate: description: |- Serializer get numbers from project queryset annotation, make sure, that you use correct one(Project.objects.with_counts()) properties: - id: - type: integer - readOnly: true - title: - type: string + color: + maxLength: 16 nullable: true - description: Project name. Must be between 3 and 50 characters long. - maxLength: 50 - minLength: 3 - description: type: string + config_has_control_tags: + description: Flag to detect is project ready for labeling + readOnly: true + type: boolean + config_suitable_for_bulk_annotation: + description: Flag to detect is project ready for bulk annotation + readOnly: true + type: boolean + control_weights: + 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}' nullable: true - description: Project description - label_config: + created_at: + format: date-time + readOnly: true type: string + created_by: + allOf: + - $ref: '#/components/schemas/UserSimple' + description: Project owner + description: + description: Project description nullable: true - description: Label config in XML format. See more about it in documentation - expert_instruction: type: string - nullable: true - description: Labeling instructions in HTML format - show_instruction: - type: boolean - description: Show instructions to the annotator before they start - show_skip_button: - type: boolean - description: Show a skip button in interface and allow annotators to skip - the task enable_empty_annotation: - type: boolean description: Allow annotators to submit empty annotations - show_annotation_history: type: boolean - description: Show annotation history to annotator - organization: - type: integer + evaluate_predictions_automatically: + description: Retrieve and display predictions when loading a task + type: boolean + expert_instruction: + description: Labeling instructions in HTML format nullable: true - color: type: string - nullable: true - maxLength: 16 - maximum_annotations: + finished_task_number: + description: Finished tasks + readOnly: true 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) - is_published: + ground_truth_number: + description: Honeypot annotation number in project + readOnly: true + type: integer + id: + readOnly: true + type: integer + is_draft: + description: Whether or not the project is in the middle of being created type: boolean - title: Published + is_published: description: Whether or not the project is published to annotators - model_version: - type: string - nullable: true - description: Machine learning model version - is_draft: + title: Published type: boolean - description: Whether or not the project is in the middle of being created - created_by: - allOf: - - $ref: '#/components/schemas/UserSimple' - description: Project owner - created_at: + label_config: + description: Label config in XML format. See more about it in documentation + nullable: true type: string - format: date-time - readOnly: true - min_annotations_to_start_training: + maximum_annotations: + 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) + maximum: 2147483647 + minimum: -2147483648 + title: Maximum annotation number type: integer + min_annotations_to_start_training: + description: Minimum number of completed tasks after which model training is started maximum: 2147483647 minimum: -2147483648 - description: Minimum number of completed tasks after which model training - is started - start_training_on_annotation_update: - type: boolean - readOnly: true - description: Start model training after any annotations are submitted or - updated - show_collab_predictions: - type: boolean - title: Show predictions to annotator - description: If set, the annotator can view model predictions - num_tasks_with_annotations: type: integer - readOnly: true + model_version: + description: Machine learning model version + nullable: true + type: string + num_tasks_with_annotations: description: Tasks with annotations count - task_number: - type: integer readOnly: true - description: Total task number in project - useful_annotation_number: type: integer - readOnly: true - description: 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: + organization: + nullable: true type: integer - readOnly: true - description: Honeypot annotation number in project - skipped_annotations_number: + overlap_cohort_percentage: + maximum: 2147483647 + minimum: -2147483648 type: integer + parsed_label_config: + description: JSON-formatted labeling configuration readOnly: true - description: Skipped by collaborators annotation number in project - total_annotations_number: - type: integer + pinned_at: + description: Pinned date and time + format: date-time + nullable: true + type: string + queue_done: readOnly: true - description: Total annotations number in project including skipped_annotations_number - and ground_truth_number. - total_predictions_number: type: integer + queue_total: readOnly: true - description: Total predictions number in project including skipped_annotations_number, - ground_truth_number, and useful_annotation_number. + type: integer + reveal_preannotations_interactively: + description: Reveal pre-annotations interactively + type: boolean sampling: nullable: true oneOf: - - $ref: '#/components/schemas/SamplingEnum' - - $ref: '#/components/schemas/NullEnum' + - $ref: '#/components/schemas/SamplingEnum' + - $ref: '#/components/schemas/NullEnum' + show_annotation_history: + description: Show annotation history to annotator + type: boolean + show_collab_predictions: + description: If set, the annotator can view model predictions + title: Show predictions to annotator + type: boolean show_ground_truth_first: type: boolean + show_instruction: + description: Show instructions to the annotator before they start + type: boolean show_overlap_first: type: boolean - overlap_cohort_percentage: + show_skip_button: + description: Show a skip button in interface and allow annotators to skip the task + type: boolean + skip_queue: + nullable: true + oneOf: + - $ref: '#/components/schemas/SkipQueueEnum' + - $ref: '#/components/schemas/NullEnum' + skipped_annotations_number: + description: Skipped by collaborators annotation number in project + readOnly: true type: integer - maximum: 2147483647 - minimum: -2147483648 + start_training_on_annotation_update: + description: Start model training after any annotations are submitted or updated + readOnly: true + type: boolean task_data_login: - type: string - nullable: true description: 'Task data credentials: login' maxLength: 256 - task_data_password: - type: string nullable: true + type: string + task_data_password: description: 'Task data credentials: password' maxLength: 256 - 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}' - parsed_label_config: - readOnly: true - description: JSON-formatted labeling configuration - evaluate_predictions_automatically: - type: boolean - description: Retrieve and display predictions when loading a task - config_has_control_tags: - type: boolean + type: string + task_number: + description: Total task number in project readOnly: true - description: Flag to detect is project ready for labeling - skip_queue: + type: integer + title: + description: Project name. Must be between 3 and 50 characters long. + maxLength: 50 + minLength: 3 nullable: true - oneOf: - - $ref: '#/components/schemas/SkipQueueEnum' - - $ref: '#/components/schemas/NullEnum' - reveal_preannotations_interactively: - type: boolean - description: Reveal pre-annotations interactively - pinned_at: type: string - format: date-time - nullable: true - description: Pinned date and time - finished_task_number: - type: integer + total_annotations_number: + description: Total annotations number in project including skipped_annotations_number and ground_truth_number. readOnly: true - description: Finished tasks - queue_total: type: integer + total_predictions_number: + description: Total predictions number in project including skipped_annotations_number, ground_truth_number, and useful_annotation_number. readOnly: true - queue_done: type: integer + useful_annotation_number: + description: Useful annotation number in project not including skipped_annotations_number and ground_truth_number. Total annotations = annotation_number + skipped_annotations_number + ground_truth_number readOnly: true - config_suitable_for_bulk_annotation: - type: boolean - readOnly: true - description: Flag to detect is project ready for bulk annotation + type: integer workspace: type: integer required: - - config_has_control_tags - - config_suitable_for_bulk_annotation - - created_at - - finished_task_number - - ground_truth_number - - id - - num_tasks_with_annotations - - parsed_label_config - - queue_done - - queue_total - - skipped_annotations_number - - start_training_on_annotation_update - - task_number - - total_annotations_number - - total_predictions_number - - useful_annotation_number - LseProjectCreateRequest: + - config_has_control_tags + - config_suitable_for_bulk_annotation + - created_at + - finished_task_number + - ground_truth_number + - id + - num_tasks_with_annotations + - parsed_label_config + - queue_done + - queue_total + - skipped_annotations_number + - start_training_on_annotation_update + - task_number + - total_annotations_number + - total_predictions_number + - useful_annotation_number type: object + LseProjectCreateRequest: description: |- Serializer get numbers from project queryset annotation, make sure, that you use correct one(Project.objects.with_counts()) properties: - title: - type: string + color: + maxLength: 16 nullable: true - description: Project name. Must be between 3 and 50 characters long. - maxLength: 50 - minLength: 3 - description: type: string + control_weights: + 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}' nullable: true + created_by: + allOf: + - $ref: '#/components/schemas/UserSimpleRequest' + description: Project owner + description: description: Project description - label_config: - type: string nullable: true - description: Label config in XML format. See more about it in documentation - expert_instruction: type: string - nullable: true - description: Labeling instructions in HTML format - show_instruction: - type: boolean - description: Show instructions to the annotator before they start - show_skip_button: - type: boolean - description: Show a skip button in interface and allow annotators to skip - the task enable_empty_annotation: - type: boolean description: Allow annotators to submit empty annotations - show_annotation_history: type: boolean - description: Show annotation history to annotator - organization: - type: integer + evaluate_predictions_automatically: + description: Retrieve and display predictions when loading a task + type: boolean + expert_instruction: + description: Labeling instructions in HTML format nullable: true - color: type: string + is_draft: + description: Whether or not the project is in the middle of being created + type: boolean + is_published: + description: Whether or not the project is published to annotators + title: Published + type: boolean + label_config: + description: Label config in XML format. See more about it in documentation nullable: true - maxLength: 16 + type: string maximum_annotations: - type: integer + 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) 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) - is_published: - type: boolean - title: Published - description: Whether or not the project is published to annotators + type: integer + min_annotations_to_start_training: + description: Minimum number of completed tasks after which model training is started + maximum: 2147483647 + minimum: -2147483648 + type: integer model_version: + description: Machine learning model version + nullable: true type: string + organization: nullable: true - description: Machine learning model version - is_draft: - type: boolean - description: Whether or not the project is in the middle of being created - created_by: - allOf: - - $ref: '#/components/schemas/UserSimpleRequest' - description: Project owner - min_annotations_to_start_training: type: integer + overlap_cohort_percentage: maximum: 2147483647 minimum: -2147483648 - description: Minimum number of completed tasks after which model training - is started - show_collab_predictions: - type: boolean - title: Show predictions to annotator - description: If set, the annotator can view model predictions + type: integer + pinned_at: + description: Pinned date and time + format: date-time + nullable: true + type: string + reveal_preannotations_interactively: + description: Reveal pre-annotations interactively + type: boolean sampling: nullable: true oneOf: - - $ref: '#/components/schemas/SamplingEnum' - - $ref: '#/components/schemas/NullEnum' + - $ref: '#/components/schemas/SamplingEnum' + - $ref: '#/components/schemas/NullEnum' + show_annotation_history: + description: Show annotation history to annotator + type: boolean + show_collab_predictions: + description: If set, the annotator can view model predictions + title: Show predictions to annotator + type: boolean show_ground_truth_first: type: boolean + show_instruction: + description: Show instructions to the annotator before they start + type: boolean show_overlap_first: type: boolean - overlap_cohort_percentage: - type: integer - maximum: 2147483647 - minimum: -2147483648 - task_data_login: - type: string + show_skip_button: + description: Show a skip button in interface and allow annotators to skip the task + type: boolean + skip_queue: nullable: true + oneOf: + - $ref: '#/components/schemas/SkipQueueEnum' + - $ref: '#/components/schemas/NullEnum' + task_data_login: description: 'Task data credentials: login' maxLength: 256 - task_data_password: - type: string nullable: true + type: string + task_data_password: description: 'Task data credentials: password' maxLength: 256 - 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}' - evaluate_predictions_automatically: - type: boolean - description: Retrieve and display predictions when loading a task - skip_queue: nullable: true - oneOf: - - $ref: '#/components/schemas/SkipQueueEnum' - - $ref: '#/components/schemas/NullEnum' - reveal_preannotations_interactively: - type: boolean - description: Reveal pre-annotations interactively - pinned_at: type: string - format: date-time + title: + description: Project name. Must be between 3 and 50 characters long. + maxLength: 50 + minLength: 3 nullable: true - description: Pinned date and time + type: string workspace: type: integer - LseProjectParamsRequest: type: object + LseProjectParamsRequest: properties: - use_kappa: - type: boolean - description: If categorical variables are used in labeling (e.g. choices), - Cohen's Kappa statistic is computed to measure inter-rater reliability - instead of basic agreement annotator_params: + description: 'user ID and user weight in score calculation. Format {user_id[int]: weight[Float[0..1]]}' nullable: true - description: 'user ID and user weight in score calculation. Format {user_id[int]: - weight[Float[0..1]]}' - LseProjectUpdate: + use_kappa: + description: If categorical variables are used in labeling (e.g. choices), Cohen's Kappa statistic is computed to measure inter-rater reliability instead of basic agreement + type: boolean type: object + LseProjectUpdate: description: |- Serializer get numbers from project queryset annotation, make sure, that you use correct one(Project.objects.with_counts()) properties: - id: - type: integer - readOnly: true - title: - type: string + annotation_limit_count: + minimum: 1 nullable: true - description: Project name. Must be between 3 and 50 characters long. - maxLength: 50 - minLength: 3 - description: - type: string + type: integer + annotation_limit_percent: + format: decimal nullable: true - description: Project description - label_config: + pattern: ^-?\d{0,3}(?:\.\d{0,2})?$ type: string + annotator_evaluation_minimum_score: + default: '95.00' + format: decimal nullable: true - description: Label config in XML format. See more about it in documentation - expert_instruction: + pattern: ^-?\d{0,3}(?:\.\d{0,2})?$ type: string + annotator_evaluation_minimum_tasks: + default: 10 + minimum: 0 nullable: true - description: Labeling instructions in HTML format - show_instruction: - type: boolean - description: Show instructions to the annotator before they start - show_skip_button: - type: boolean - description: Show a skip button in interface and allow annotators to skip - the task - enable_empty_annotation: - type: boolean - description: Allow annotators to submit empty annotations - show_annotation_history: - type: boolean - description: Show annotation history to annotator - organization: type: integer - nullable: true + assignment_settings: + $ref: '#/components/schemas/AssignmentSettings' color: - type: string - nullable: true maxLength: 16 - 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) - is_published: - type: boolean - title: Published - description: Whether or not the project is published to annotators - model_version: - type: string nullable: true - description: Machine learning model version - is_draft: + type: string + comment_classification_config: + type: string + config_has_control_tags: + description: Flag to detect is project ready for labeling + readOnly: true type: boolean - description: Whether or not the project is in the middle of being created + config_suitable_for_bulk_annotation: + description: Flag to detect is project ready for bulk annotation + readOnly: true + type: boolean + control_weights: + 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}' + nullable: true + created_at: + format: date-time + readOnly: true + type: string created_by: allOf: - - $ref: '#/components/schemas/UserSimple' + - $ref: '#/components/schemas/UserSimple' description: Project owner - created_at: + custom_script: type: string - format: date-time - readOnly: true - min_annotations_to_start_training: + custom_task_lock_ttl: + description: TTL in seconds for task reservations, on new and existing tasks + maximum: 86400 + minimum: 1 + nullable: true type: integer - maximum: 2147483647 - minimum: -2147483648 - description: Minimum number of completed tasks after which model training - is started - start_training_on_annotation_update: + description: + description: Project description + nullable: true + type: string + enable_empty_annotation: + description: Allow annotators to submit empty annotations type: boolean - readOnly: true - description: Start model training after any annotations are submitted or - updated - show_collab_predictions: + evaluate_predictions_automatically: + description: Retrieve and display predictions when loading a task type: boolean - title: Show predictions to annotator - description: If set, the annotator can view model predictions - num_tasks_with_annotations: - type: integer - readOnly: true - description: Tasks with annotations count - task_number: - type: integer + expert_instruction: + description: Labeling instructions in HTML format + nullable: true + type: string + finished_task_number: + description: Finished tasks readOnly: true - description: Total task number in project - useful_annotation_number: type: integer - readOnly: true - description: 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 - readOnly: true description: Honeypot annotation number in project - skipped_annotations_number: - type: integer readOnly: true - description: Skipped by collaborators annotation number in project - total_annotations_number: type: integer + id: readOnly: true - description: Total annotations number in project including skipped_annotations_number - and ground_truth_number. - total_predictions_number: type: integer - readOnly: true - description: Total predictions number in project including skipped_annotations_number, - ground_truth_number, and useful_annotation_number. - sampling: - nullable: true - oneOf: - - $ref: '#/components/schemas/SamplingEnum' - - $ref: '#/components/schemas/NullEnum' - show_ground_truth_first: + is_draft: + description: Whether or not the project is in the middle of being created type: boolean - show_overlap_first: + is_published: + description: Whether or not the project is published to annotators + title: Published type: boolean - overlap_cohort_percentage: + label_config: + description: Label config in XML format. See more about it in documentation + nullable: true + type: string + maximum_annotations: + 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) + maximum: 2147483647 + minimum: -2147483648 + title: Maximum annotation number type: integer + min_annotations_to_start_training: + description: Minimum number of completed tasks after which model training is started maximum: 2147483647 minimum: -2147483648 - task_data_login: - type: string + type: integer + model_version: + description: Machine learning model version nullable: true - description: 'Task data credentials: login' - maxLength: 256 - task_data_password: type: string + num_tasks_with_annotations: + description: Tasks with annotations count + readOnly: true + type: integer + organization: nullable: true - description: 'Task data credentials: password' - maxLength: 256 - 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}' + type: integer + overlap_cohort_percentage: + maximum: 2147483647 + minimum: -2147483648 + type: integer parsed_label_config: - readOnly: true description: JSON-formatted labeling configuration - evaluate_predictions_automatically: - type: boolean - description: Retrieve and display predictions when loading a task - config_has_control_tags: - type: boolean readOnly: true - description: Flag to detect is project ready for labeling - skip_queue: + pause_on_failed_annotator_evaluation: + default: false nullable: true - oneOf: - - $ref: '#/components/schemas/SkipQueueEnum' - - $ref: '#/components/schemas/NullEnum' - reveal_preannotations_interactively: type: boolean - description: Reveal pre-annotations interactively pinned_at: - type: string + description: Pinned date and time format: date-time nullable: true - description: Pinned date and time - finished_task_number: - type: integer - readOnly: true - description: Finished tasks - queue_total: - type: integer + type: string + prompts: readOnly: true + type: string queue_done: + readOnly: true type: integer + queue_total: readOnly: true - config_suitable_for_bulk_annotation: - type: boolean - readOnly: true - description: Flag to detect is project ready for bulk annotation - workspace: type: integer + require_comment_on_skip: + default: false + type: boolean + reveal_preannotations_interactively: + description: Reveal pre-annotations interactively + type: boolean review_settings: $ref: '#/components/schemas/ReviewSettings' - assignment_settings: - $ref: '#/components/schemas/AssignmentSettings' - custom_script: - type: string - comment_classification_config: - type: string - require_comment_on_skip: + sampling: + nullable: true + oneOf: + - $ref: '#/components/schemas/SamplingEnum' + - $ref: '#/components/schemas/NullEnum' + show_annotation_history: + description: Show annotation history to annotator type: boolean - default: false - custom_task_lock_ttl: - type: integer - maximum: 86400 - minimum: 1 + show_collab_predictions: + description: If set, the annotator can view model predictions + title: Show predictions to annotator + type: boolean + show_ground_truth_first: + type: boolean + show_instruction: + description: Show instructions to the annotator before they start + type: boolean + show_overlap_first: + type: boolean + show_skip_button: + description: Show a skip button in interface and allow annotators to skip the task + type: boolean + skip_queue: nullable: true - description: TTL in seconds for task reservations, on new and existing tasks - prompts: - type: string + oneOf: + - $ref: '#/components/schemas/SkipQueueEnum' + - $ref: '#/components/schemas/NullEnum' + skipped_annotations_number: + description: Skipped by collaborators annotation number in project readOnly: true - annotation_limit_count: type: integer - minimum: 1 - nullable: true - annotation_limit_percent: - type: string - format: decimal - pattern: ^-?\d{0,3}(?:\.\d{0,2})?$ - nullable: true - pause_on_failed_annotator_evaluation: + start_training_on_annotation_update: + description: Start model training after any annotations are submitted or updated + readOnly: true type: boolean + task_data_login: + description: 'Task data credentials: login' + maxLength: 256 nullable: true - default: false - annotator_evaluation_minimum_score: type: string - format: decimal - pattern: ^-?\d{0,3}(?:\.\d{0,2})?$ + task_data_password: + description: 'Task data credentials: password' + maxLength: 256 nullable: true - default: '95.00' - annotator_evaluation_minimum_tasks: + type: string + task_number: + description: Total task number in project + readOnly: true type: integer - minimum: 0 + title: + description: Project name. Must be between 3 and 50 characters long. + maxLength: 50 + minLength: 3 nullable: true - default: 10 - workspace_title: type: string + total_annotations_number: + description: Total annotations number in project including skipped_annotations_number and ground_truth_number. readOnly: true - required: - - assignment_settings - - config_has_control_tags - - config_suitable_for_bulk_annotation - - created_at - - finished_task_number - - ground_truth_number - - id - - num_tasks_with_annotations - - parsed_label_config - - prompts - - queue_done - - queue_total - - review_settings - - skipped_annotations_number - - start_training_on_annotation_update - - task_number - - total_annotations_number - - total_predictions_number - - useful_annotation_number - - workspace - - workspace_title - LseS3ExportStorage: - type: object - properties: - id: type: integer + total_predictions_number: + description: Total predictions number in project including skipped_annotations_number, ground_truth_number, and useful_annotation_number. readOnly: true - type: - type: string + type: integer + useful_annotation_number: + description: Useful annotation number in project not including skipped_annotations_number and ground_truth_number. Total annotations = annotation_number + skipped_annotations_number + ground_truth_number readOnly: true - default: s3s - synchronizable: - type: boolean - default: true - last_sync: - type: string - format: date-time - nullable: true - description: Last sync finished time - last_sync_count: type: integer - maximum: 2147483647 - minimum: 0 - nullable: true - description: Count of tasks synced last time - last_sync_job: + workspace: + type: integer + workspace_title: + readOnly: true type: string + required: + - assignment_settings + - config_has_control_tags + - config_suitable_for_bulk_annotation + - created_at + - finished_task_number + - ground_truth_number + - id + - num_tasks_with_annotations + - parsed_label_config + - prompts + - queue_done + - queue_total + - review_settings + - skipped_annotations_number + - start_training_on_annotation_update + - task_number + - total_annotations_number + - total_predictions_number + - useful_annotation_number + - workspace + - workspace_title + type: object + LseS3ExportStorage: + properties: + aws_access_key_id: + description: AWS_ACCESS_KEY_ID nullable: true - description: Last sync job ID - maxLength: 256 - status: - $ref: '#/components/schemas/StatusC5aEnum' - traceback: type: string + aws_secret_access_key: + description: AWS_SECRET_ACCESS_KEY nullable: true - description: Traceback report for the last failed sync - meta: - nullable: true - description: Meta and debug information about storage processes - title: type: string + aws_session_token: + description: AWS_SESSION_TOKEN nullable: true - description: Cloud storage title - maxLength: 256 - description: type: string + aws_sse_kms_key_id: + description: AWS SSE KMS Key ID nullable: true - description: Cloud storage description - created_at: type: string - format: date-time - readOnly: true - description: Creation time - can_delete_objects: - type: boolean - nullable: true - description: Deletion from storage enabled bucket: - type: string - nullable: true description: S3 bucket name - prefix: - type: string nullable: true - description: S3 bucket prefix - regex_filter: type: string + can_delete_objects: + description: Deletion from storage enabled nullable: true - description: Cloud storage regex for filtering objects - use_blob_urls: type: boolean - description: Interpret objects as BLOBs and generate URLs - aws_access_key_id: - type: string - nullable: true - description: AWS_ACCESS_KEY_ID - aws_secret_access_key: - type: string - nullable: true - description: AWS_SECRET_ACCESS_KEY - aws_session_token: - type: string - nullable: true - description: AWS_SESSION_TOKEN - aws_sse_kms_key_id: - type: string - nullable: true - description: AWS SSE KMS Key ID - region_name: + created_at: + description: Creation time + format: date-time + readOnly: true type: string + description: + description: Cloud storage description nullable: true - description: AWS Region - s3_endpoint: type: string - nullable: true - description: S3 Endpoint external_id: - type: string + description: AWS ExternalId nullable: true title: ExternalID - description: AWS ExternalId - role_arn: type: string - description: AWS RoleArn - legacy_auth: - type: boolean - nullable: true - project: + id: + readOnly: true type: integer - description: A unique integer value identifying this project. - required: - - created_at - - id - - project - - role_arn - - type - LseS3ExportStorageRequest: - type: object - properties: - synchronizable: - type: boolean - default: true last_sync: - type: string + description: Last sync finished time format: date-time nullable: true - description: Last sync finished time + type: string last_sync_count: - type: integer + description: Count of tasks synced last time maximum: 2147483647 minimum: 0 nullable: true - description: Count of tasks synced last time + type: integer last_sync_job: - type: string - nullable: true description: Last sync job ID maxLength: 256 - status: - $ref: '#/components/schemas/StatusC5aEnum' - traceback: + nullable: true type: string + legacy_auth: nullable: true - description: Traceback report for the last failed sync + type: boolean meta: - nullable: true description: Meta and debug information about storage processes - title: - type: string - nullable: true - description: Cloud storage title - maxLength: 256 - description: - type: string nullable: true - description: Cloud storage description - can_delete_objects: - type: boolean + prefix: + description: S3 bucket prefix nullable: true - description: Deletion from storage enabled - bucket: type: string + project: + description: A unique integer value identifying this project. + type: integer + regex_filter: + description: Cloud storage regex for filtering objects nullable: true - description: S3 bucket name - prefix: type: string + region_name: + description: AWS Region nullable: true - description: S3 bucket prefix - regex_filter: type: string - nullable: true - description: Cloud storage regex for filtering objects - use_blob_urls: - type: boolean - description: Interpret objects as BLOBs and generate URLs - aws_access_key_id: + role_arn: + description: AWS RoleArn type: string + s3_endpoint: + description: S3 Endpoint nullable: true - description: AWS_ACCESS_KEY_ID - aws_secret_access_key: type: string + status: + $ref: '#/components/schemas/StatusC5aEnum' + synchronizable: + default: true + type: boolean + title: + description: Cloud storage title + maxLength: 256 nullable: true - description: AWS_SECRET_ACCESS_KEY - aws_session_token: type: string + traceback: + description: Traceback report for the last failed sync nullable: true - description: AWS_SESSION_TOKEN - aws_sse_kms_key_id: type: string + type: + default: s3s + readOnly: true + type: string + use_blob_urls: + description: Interpret objects as BLOBs and generate URLs + type: boolean + required: + - created_at + - id + - project + - role_arn + - type + type: object + LseS3ExportStorageRequest: + properties: + aws_access_key_id: + description: AWS_ACCESS_KEY_ID nullable: true - description: AWS SSE KMS Key ID - region_name: type: string + aws_secret_access_key: + description: AWS_SECRET_ACCESS_KEY nullable: true - description: AWS Region - s3_endpoint: type: string + aws_session_token: + description: AWS_SESSION_TOKEN nullable: true - description: S3 Endpoint - external_id: type: string + aws_sse_kms_key_id: + description: AWS SSE KMS Key ID nullable: true - title: ExternalID - description: AWS ExternalId - role_arn: type: string - minLength: 1 - description: AWS RoleArn - legacy_auth: - type: boolean + bucket: + description: S3 bucket name nullable: true - project: - type: integer - description: A unique integer value identifying this project. - required: - - project - - role_arn - LseS3ImportStorage: - type: object - properties: - id: - type: integer - readOnly: true - type: type: string - readOnly: true - default: s3s - synchronizable: - type: boolean - default: true - presign: + can_delete_objects: + description: Deletion from storage enabled + nullable: true type: boolean - default: true - last_sync: + description: + description: Cloud storage description + nullable: true type: string - format: date-time + external_id: + description: AWS ExternalId nullable: true + title: ExternalID + type: string + last_sync: description: Last sync finished time + format: date-time + nullable: true + type: string last_sync_count: - type: integer + description: Count of tasks synced last time maximum: 2147483647 minimum: 0 nullable: true - description: Count of tasks synced last time + type: integer last_sync_job: - type: string - nullable: true description: Last sync job ID maxLength: 256 - status: - $ref: '#/components/schemas/StatusC5aEnum' - traceback: + nullable: true type: string + legacy_auth: nullable: true - description: Traceback report for the last failed sync + type: boolean meta: - nullable: true description: Meta and debug information about storage processes - title: + nullable: true + prefix: + description: S3 bucket prefix + nullable: true type: string + project: + description: A unique integer value identifying this project. + type: integer + regex_filter: + description: Cloud storage regex for filtering objects nullable: true - description: Cloud storage title - maxLength: 256 - description: type: string + region_name: + description: AWS Region nullable: true - description: Cloud storage description - created_at: type: string - format: date-time - readOnly: true - description: Creation time - bucket: + role_arn: + description: AWS RoleArn + minLength: 1 type: string + s3_endpoint: + description: S3 Endpoint nullable: true - description: S3 bucket name - prefix: type: string + status: + $ref: '#/components/schemas/StatusC5aEnum' + synchronizable: + default: true + type: boolean + title: + description: Cloud storage title + maxLength: 256 nullable: true - description: S3 bucket prefix - regex_filter: type: string + traceback: + description: Traceback report for the last failed sync nullable: true - description: Cloud storage regex for filtering objects + type: string use_blob_urls: - type: boolean description: Interpret objects as BLOBs and generate URLs + type: boolean + required: + - project + - role_arn + type: object + LseS3ImportStorage: + properties: aws_access_key_id: - type: string - nullable: true description: AWS_ACCESS_KEY_ID - aws_secret_access_key: - type: string nullable: true - description: AWS_SECRET_ACCESS_KEY - aws_session_token: type: string + aws_secret_access_key: + description: AWS_SECRET_ACCESS_KEY nullable: true - description: AWS_SESSION_TOKEN - aws_sse_kms_key_id: type: string + aws_session_token: + description: AWS_SESSION_TOKEN nullable: true + type: string + aws_sse_kms_key_id: description: AWS SSE KMS Key ID - region_name: + nullable: true type: string + bucket: + description: S3 bucket name nullable: true - description: AWS Region - s3_endpoint: type: string + created_at: + description: Creation time + format: date-time + readOnly: true + type: string + description: + description: Cloud storage description nullable: true - description: S3 Endpoint - external_id: type: string + external_id: + description: AWS ExternalId nullable: true title: ExternalID - description: AWS ExternalId - role_arn: type: string - description: AWS RoleArn - legacy_auth: - type: boolean - nullable: true - presign_ttl: - type: integer - maximum: 32767 - minimum: 0 - description: Presigned URLs TTL (in minutes) - recursive_scan: - type: boolean - description: Perform recursive scan over the bucket content - project: + id: + readOnly: true type: integer - description: A unique integer value identifying this project. - required: - - created_at - - id - - project - - role_arn - - type - LseS3ImportStorageRequest: - type: object - properties: - synchronizable: - type: boolean - default: true - presign: - type: boolean - default: true last_sync: - type: string + description: Last sync finished time format: date-time nullable: true - description: Last sync finished time + type: string last_sync_count: - type: integer + description: Count of tasks synced last time maximum: 2147483647 minimum: 0 nullable: true - description: Count of tasks synced last time + type: integer last_sync_job: - type: string - nullable: true description: Last sync job ID maxLength: 256 - status: - $ref: '#/components/schemas/StatusC5aEnum' - traceback: + nullable: true type: string + legacy_auth: nullable: true - description: Traceback report for the last failed sync + type: boolean meta: - nullable: true description: Meta and debug information about storage processes - title: - type: string nullable: true - description: Cloud storage title - maxLength: 256 - description: - type: string + prefix: + description: S3 bucket prefix nullable: true - description: Cloud storage description - bucket: type: string + presign: + default: true + type: boolean + presign_ttl: + description: Presigned URLs TTL (in minutes) + maximum: 32767 + minimum: 0 + type: integer + project: + description: A unique integer value identifying this project. + type: integer + recursive_scan: + description: Perform recursive scan over the bucket content + type: boolean + regex_filter: + description: Cloud storage regex for filtering objects nullable: true - description: S3 bucket name - prefix: type: string + region_name: + description: AWS Region nullable: true - description: S3 bucket prefix - regex_filter: type: string - nullable: true - description: Cloud storage regex for filtering objects - use_blob_urls: + role_arn: + description: AWS RoleArn + type: string + s3_endpoint: + description: S3 Endpoint + nullable: true + type: string + status: + $ref: '#/components/schemas/StatusC5aEnum' + synchronizable: + default: true type: boolean - description: Interpret objects as BLOBs and generate URLs - aws_access_key_id: + title: + description: Cloud storage title + maxLength: 256 + nullable: true type: string + traceback: + description: Traceback report for the last failed sync nullable: true - description: AWS_ACCESS_KEY_ID - aws_secret_access_key: type: string + type: + default: s3s + readOnly: true + type: string + use_blob_urls: + description: Interpret objects as BLOBs and generate URLs + type: boolean + required: + - created_at + - id + - project + - role_arn + - type + type: object + LseS3ImportStorageRequest: + properties: + aws_access_key_id: + description: AWS_ACCESS_KEY_ID nullable: true - description: AWS_SECRET_ACCESS_KEY - aws_session_token: type: string + aws_secret_access_key: + description: AWS_SECRET_ACCESS_KEY nullable: true - description: AWS_SESSION_TOKEN - aws_sse_kms_key_id: type: string + aws_session_token: + description: AWS_SESSION_TOKEN nullable: true + type: string + aws_sse_kms_key_id: description: AWS SSE KMS Key ID - region_name: + nullable: true type: string + bucket: + description: S3 bucket name nullable: true - description: AWS Region - s3_endpoint: type: string + description: + description: Cloud storage description nullable: true - description: S3 Endpoint - external_id: type: string + external_id: + description: AWS ExternalId nullable: true title: ExternalID - description: AWS ExternalId - role_arn: type: string - minLength: 1 - description: AWS RoleArn + last_sync: + description: Last sync finished time + format: date-time + nullable: true + type: string + last_sync_count: + description: Count of tasks synced last time + maximum: 2147483647 + minimum: 0 + nullable: true + type: integer + last_sync_job: + description: Last sync job ID + maxLength: 256 + nullable: true + type: string legacy_auth: + nullable: true type: boolean + meta: + description: Meta and debug information about storage processes nullable: true + prefix: + description: S3 bucket prefix + nullable: true + type: string + presign: + default: true + type: boolean presign_ttl: - type: integer + description: Presigned URLs TTL (in minutes) maximum: 32767 minimum: 0 - description: Presigned URLs TTL (in minutes) - recursive_scan: - type: boolean - description: Perform recursive scan over the bucket content - project: type: integer + project: description: A unique integer value identifying this project. + type: integer + recursive_scan: + description: Perform recursive scan over the bucket content + type: boolean + regex_filter: + description: Cloud storage regex for filtering objects + nullable: true + type: string + region_name: + description: AWS Region + nullable: true + type: string + role_arn: + description: AWS RoleArn + minLength: 1 + type: string + s3_endpoint: + description: S3 Endpoint + nullable: true + type: string + status: + $ref: '#/components/schemas/StatusC5aEnum' + synchronizable: + default: true + type: boolean + title: + description: Cloud storage title + maxLength: 256 + nullable: true + type: string + traceback: + description: Traceback report for the last failed sync + nullable: true + type: string + use_blob_urls: + description: Interpret objects as BLOBs and generate URLs + type: boolean required: - - project - - role_arn - LseTask: + - project + - role_arn type: object + LseTask: description: Task Serializer with project scheme configs validation properties: - id: - type: integer - readOnly: true agreement: + readOnly: true + type: string + annotations: + readOnly: true type: string + annotations_ids: readOnly: true - predictions: + type: string + annotations_results: + readOnly: true + type: string + annotators: + description: Annotators IDs who annotated this task + items: + title: User IDs + type: integer + readOnly: true + title: Annotators IDs type: array - title: Predictions - description: Predictions for this task + annotators_count: + description: The annotators_count is calculated as the number of users with annotations (can be repeated, so same as the number of annotations) + the number of assignees without annotations. + readOnly: true + type: integer + avg_lead_time: + format: double + type: number + cancelled_annotations: + type: integer + comment_authors: items: + additionalProperties: {} type: object - title: Prediction object + readOnly: true + type: array + comment_authors_count: + readOnly: true + type: integer + comment_count: + description: Number of comments in the task including all annotations + maximum: 2147483647 + minimum: -2147483648 + type: integer + comments: + readOnly: true + type: string + completed_at: + format: date-time + type: string + created_at: + description: Time a task was created + format: date-time + readOnly: true + type: string + data: + description: User imported or uploaded data for a task. Data is formatted according to the project label config. You can find examples of data for your project on the Import page in the Label Studio Data Manager UI. + draft_exists: + type: boolean + drafts: + description: Drafts for this task + items: properties: - result: - type: array - title: Prediction result - items: - type: object - title: Prediction result item - score: - type: number - title: Prediction score - model_version: - type: string - title: Model version - model: - type: object - title: ML Backend instance - model_run: - type: object - title: Model Run instance - task: - type: integer - title: Task ID related to the prediction - project: - type: integer - title: Project ID related to the prediction created_at: - type: string format: date-time title: Creation time - updated_at: type: string + result: + items: + title: Draft result item + type: object + title: Draft result + type: array + updated_at: format: date-time title: Last update time + type: string + title: Draft object + type: object + readOnly: true + title: Annotation drafts + type: array + file_upload: readOnly: true - annotations: type: string + ground_truth: + type: boolean + id: readOnly: true - drafts: - type: array - title: Annotation drafts - description: Drafts for this task + type: integer + inner_id: + type: integer + is_labeled: + description: True if the number of annotations for this task is greater than or equal to the number of maximum_completions for the project + type: boolean + last_comment_updated_at: + description: When the last comment was updated + format: date-time + nullable: true + type: string + meta: + description: Meta is user imported (uploaded) data and can be useful as input for an ML Backend for embeddings, advanced vectors, and other info. It is passed to ML during training/predicting steps. + nullable: true + overlap: + description: Number of distinct annotators that processed the current task + maximum: 2147483647 + minimum: -2147483648 + type: integer + predictions: + description: Predictions for this task items: - type: object - title: Draft object properties: - result: - type: array - title: Draft result - items: - type: object - title: Draft result item created_at: - type: string format: date-time title: Creation time + type: string + model: + title: ML Backend instance + type: object + model_run: + title: Model Run instance + type: object + model_version: + title: Model version + type: string + project: + title: Project ID related to the prediction + type: integer + result: + items: + title: Prediction result item + type: object + title: Prediction result + type: array + score: + title: Prediction score + type: number + task: + title: Task ID related to the prediction + type: integer updated_at: - type: string format: date-time title: Last update time + type: string + title: Prediction object + type: object readOnly: true - annotators: + title: Predictions type: array - title: Annotators IDs - description: Annotators IDs who annotated this task - items: - type: integer - title: User IDs + predictions_model_versions: readOnly: true - inner_id: - type: integer - cancelled_annotations: - type: integer - total_annotations: - type: integer - total_predictions: - type: integer - completed_at: - type: string - format: date-time - annotations_results: type: string - readOnly: true predictions_results: - type: string readOnly: true + type: string predictions_score: - type: number format: double - file_upload: - type: string - readOnly: true - storage_filename: - type: string - readOnly: true - annotations_ids: - type: string - readOnly: true - predictions_model_versions: - type: string - readOnly: true - avg_lead_time: type: number - format: double - draft_exists: + project: + description: Project ID for this task + nullable: true + type: integer + reviewed: type: boolean - updated_by: - type: array - title: User IDs - description: User IDs who updated this task - items: - type: object - title: User IDs - readOnly: true reviewers: - type: array items: - type: object additionalProperties: {} + type: object readOnly: true - comments: - type: string - readOnly: true - comment_authors: type: array - items: - type: object - additionalProperties: {} + reviewers_count: readOnly: true - reviewed: - type: boolean + type: integer reviews_accepted: type: integer reviews_rejected: type: integer - ground_truth: - type: boolean - annotators_count: - type: integer - description: The annotators_count is calculated as the number of users with - annotations (can be repeated, so same as the number of annotations) + - the number of assignees without annotations. - readOnly: true - reviewers_count: - type: integer - readOnly: true - comment_authors_count: - type: integer - readOnly: true - data: - description: User imported or uploaded data for a task. Data is formatted - according to the project label config. You can find examples of data for - your project on the Import page in the Label Studio Data Manager UI. - meta: - nullable: true - description: Meta is user imported (uploaded) data and can be useful as - input for an ML Backend for embeddings, advanced vectors, and other info. - It is passed to ML during training/predicting steps. - created_at: - type: string - format: date-time + storage_filename: readOnly: true - description: Time a task was created - updated_at: type: string - format: date-time - readOnly: true - description: Last time a task was updated - is_labeled: - type: boolean - description: True if the number of annotations for this task is greater - than or equal to the number of maximum_completions for the project - overlap: + total_annotations: type: integer - maximum: 2147483647 - minimum: -2147483648 - description: Number of distinct annotators that processed the current task - comment_count: + total_predictions: type: integer - maximum: 2147483647 - minimum: -2147483648 - description: Number of comments in the task including all annotations unresolved_comment_count: - type: integer + description: Number of unresolved comments in the task including all annotations maximum: 2147483647 minimum: -2147483648 - description: Number of unresolved comments in the task including all annotations - last_comment_updated_at: - type: string - format: date-time - nullable: true - description: When the last comment was updated - project: type: integer - nullable: true - description: Project ID for this task + updated_at: + description: Last time a task was updated + format: date-time + readOnly: true + type: string + updated_by: + description: User IDs who updated this task + items: + title: User IDs + type: object + readOnly: true + title: User IDs + type: array required: - - agreement - - annotations - - annotations_ids - - annotations_results - - annotators - - annotators_count - - comment_authors - - comment_authors_count - - comments - - created_at - - data - - drafts - - file_upload - - id - - predictions - - predictions_model_versions - - predictions_results - - reviewers - - reviewers_count - - storage_filename - - updated_at - - updated_by - LseTaskFilterOptions: + - agreement + - annotations + - annotations_ids + - annotations_results + - annotators + - annotators_count + - comment_authors + - comment_authors_count + - comments + - created_at + - data + - drafts + - file_upload + - id + - predictions + - predictions_model_versions + - predictions_results + - reviewers + - reviewers_count + - storage_filename + - updated_at + - updated_by type: object + LseTaskFilterOptions: properties: - view: - type: integer - description: Apply filters from the view ID (a tab from the Data Manager) - skipped: - nullable: true + annotated: description: |- - `only` - include all tasks with skipped annotations
    `exclude` - exclude all tasks with skipped annotations + `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 + nullable: true oneOf: - - $ref: '#/components/schemas/SkippedEnum' - - $ref: '#/components/schemas/NullEnum' + - $ref: '#/components/schemas/AnnotatedEnum' + - $ref: '#/components/schemas/NullEnum' finished: - nullable: true description: |- `only` - include all finished tasks (is_labeled = true)
    `exclude` - exclude all finished tasks * `only` - only * `exclude` - exclude * `None` - None - oneOf: - - $ref: '#/components/schemas/FinishedEnum' - - $ref: '#/components/schemas/NullEnum' - annotated: nullable: true - description: |- - `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 oneOf: - - $ref: '#/components/schemas/AnnotatedEnum' - - $ref: '#/components/schemas/NullEnum' + - $ref: '#/components/schemas/FinishedEnum' + - $ref: '#/components/schemas/NullEnum' only_with_annotations: - type: boolean default: false + type: boolean reviewed: - nullable: true description: |- `only` - include all reviewed tasks
    `exclude` - exclude all reviewed tasks * `only` - only * `exclude` - exclude * `None` - None + nullable: true oneOf: - - $ref: '#/components/schemas/ReviewedEnum' - - $ref: '#/components/schemas/NullEnum' - LseTaskFilterOptionsRequest: - type: object - properties: - view: - type: integer - description: Apply filters from the view ID (a tab from the Data Manager) + - $ref: '#/components/schemas/ReviewedEnum' + - $ref: '#/components/schemas/NullEnum' skipped: - nullable: true description: |- `only` - include all tasks with skipped annotations
    `exclude` - exclude all tasks with skipped annotations * `only` - only * `exclude` - exclude * `None` - None - oneOf: - - $ref: '#/components/schemas/SkippedEnum' - - $ref: '#/components/schemas/NullEnum' - finished: nullable: true + oneOf: + - $ref: '#/components/schemas/SkippedEnum' + - $ref: '#/components/schemas/NullEnum' + view: + description: Apply filters from the view ID (a tab from the Data Manager) + type: integer + type: object + LseTaskFilterOptionsRequest: + properties: + annotated: description: |- - `only` - include all finished tasks (is_labeled = true)
    `exclude` - exclude all finished tasks + `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 - oneOf: - - $ref: '#/components/schemas/FinishedEnum' - - $ref: '#/components/schemas/NullEnum' - annotated: nullable: true + oneOf: + - $ref: '#/components/schemas/AnnotatedEnum' + - $ref: '#/components/schemas/NullEnum' + finished: description: |- - `only` - include all tasks with at least one not skipped annotation
    `exclude` - exclude all tasks with at least one not skipped annotation + `only` - include all finished tasks (is_labeled = true)
    `exclude` - exclude all finished tasks * `only` - only * `exclude` - exclude * `None` - None + nullable: true oneOf: - - $ref: '#/components/schemas/AnnotatedEnum' - - $ref: '#/components/schemas/NullEnum' + - $ref: '#/components/schemas/FinishedEnum' + - $ref: '#/components/schemas/NullEnum' only_with_annotations: - type: boolean default: false + type: boolean reviewed: - nullable: true description: |- `only` - include all reviewed tasks
    `exclude` - exclude all reviewed tasks * `only` - only * `exclude` - exclude * `None` - None + nullable: true oneOf: - - $ref: '#/components/schemas/ReviewedEnum' - - $ref: '#/components/schemas/NullEnum' - LseTaskRequest: + - $ref: '#/components/schemas/ReviewedEnum' + - $ref: '#/components/schemas/NullEnum' + skipped: + description: |- + `only` - include all tasks with skipped annotations
    `exclude` - exclude all tasks with skipped annotations + + * `only` - only + * `exclude` - exclude + * `None` - None + nullable: true + oneOf: + - $ref: '#/components/schemas/SkippedEnum' + - $ref: '#/components/schemas/NullEnum' + view: + description: Apply filters from the view ID (a tab from the Data Manager) + type: integer type: object + LseTaskRequest: description: Task Serializer with project scheme configs validation properties: - data: - description: User imported or uploaded data for a task. Data is formatted - according to the project label config. You can find examples of data for - your project on the Import page in the Label Studio Data Manager UI. - meta: - nullable: true - description: Meta is user imported (uploaded) data and can be useful as - input for an ML Backend for embeddings, advanced vectors, and other info. - It is passed to ML during training/predicting steps. - is_labeled: - type: boolean - description: True if the number of annotations for this task is greater - than or equal to the number of maximum_completions for the project - overlap: + cancelled_annotations: + description: Number of total cancelled annotations for the current task + maximum: 2147483647 + minimum: -2147483648 type: integer + comment_authors: + description: Users who wrote comments + items: + type: integer + type: array + comment_count: + description: Number of comments in the task including all annotations maximum: 2147483647 minimum: -2147483648 - description: Number of distinct annotators that processed the current task - inner_id: type: integer + data: + description: User imported or uploaded data for a task. Data is formatted according to the project label config. You can find examples of data for your project on the Import page in the Label Studio Data Manager UI. + file_upload: + description: Uploaded file used as data source for this task + nullable: true + type: integer + inner_id: + description: Internal task ID in the project, starts with 1 + format: int64 maximum: 9223372036854775807 minimum: -9223372036854775808 - format: int64 nullable: true - description: Internal task ID in the project, starts with 1 - total_annotations: - type: integer - maximum: 2147483647 - minimum: -2147483648 - description: Number of total annotations for the current task except cancelled - annotations - cancelled_annotations: type: integer + is_labeled: + description: True if the number of annotations for this task is greater than or equal to the number of maximum_completions for the project + type: boolean + last_comment_updated_at: + description: When the last comment was updated + format: date-time + nullable: true + type: string + meta: + description: Meta is user imported (uploaded) data and can be useful as input for an ML Backend for embeddings, advanced vectors, and other info. It is passed to ML during training/predicting steps. + nullable: true + overlap: + description: Number of distinct annotators that processed the current task maximum: 2147483647 minimum: -2147483648 - description: Number of total cancelled annotations for the current task - total_predictions: type: integer - maximum: 2147483647 - minimum: -2147483648 - description: Number of total predictions for the current task - comment_count: + project: + description: Project ID for this task + nullable: true type: integer + total_annotations: + description: Number of total annotations for the current task except cancelled annotations maximum: 2147483647 minimum: -2147483648 - description: Number of comments in the task including all annotations - unresolved_comment_count: type: integer + total_predictions: + description: Number of total predictions for the current task maximum: 2147483647 minimum: -2147483648 + type: integer + unresolved_comment_count: description: Number of unresolved comments in the task including all annotations - last_comment_updated_at: - type: string - format: date-time - nullable: true - description: When the last comment was updated - project: + maximum: 2147483647 + minimum: -2147483648 type: integer - nullable: true - description: Project ID for this task updated_by: - type: integer - nullable: true description: Last annotator or reviewer who updated this task - file_upload: - type: integer nullable: true - description: Uploaded file used as data source for this task - comment_authors: - type: array - items: - type: integer - description: Users who wrote comments + type: integer required: - - data - LseTaskSerializerForAnnotators: + - data type: object + LseTaskSerializerForAnnotators: description: Task Serializer with project scheme configs validation properties: - id: + annotations: + default: [] + readOnly: true + type: string + annotations_results: + readOnly: true + type: string + cancelled_annotations: type: integer + comment_count: readOnly: true - data: - description: User imported or uploaded data for a task. Data is formatted - according to the project label config. You can find examples of data for - your project on the Import page in the Label Studio Data Manager UI. - created_at: type: string - format: date-time + comments: readOnly: true - description: Time a task was created - annotations: type: string + created_at: + description: Time a task was created + format: date-time readOnly: true - default: [] + type: string + data: + description: User imported or uploaded data for a task. Data is formatted according to the project label config. You can find examples of data for your project on the Import page in the Label Studio Data Manager UI. + draft_exists: + type: boolean drafts: - type: array - title: Annotation drafts description: Drafts for this task items: - type: object - title: Draft object properties: - result: - type: array - title: Draft result - items: - type: object - title: Draft result item created_at: - type: string format: date-time title: Creation time - updated_at: type: string + result: + items: + title: Draft result item + type: object + title: Draft result + type: array + updated_at: format: date-time title: Last update time + type: string + title: Draft object + type: object readOnly: true - total_annotations: - type: integer - cancelled_annotations: - type: integer - annotations_results: - type: string + title: Annotation drafts + type: array + id: readOnly: true + type: integer predictions: - type: array - title: Predictions description: Predictions for this task items: - type: object - title: Prediction object properties: - result: - type: array - title: Prediction result - items: - type: object - title: Prediction result item - score: - type: number - title: Prediction score - model_version: + created_at: + format: date-time + title: Creation time type: string - title: Model version model: - type: object title: ML Backend instance - model_run: type: object + model_run: title: Model Run instance - task: + type: object + model_version: + title: Model version + type: string + project: + title: Project ID related to the prediction type: integer + result: + items: + title: Prediction result item + type: object + title: Prediction result + type: array + score: + title: Prediction score + type: number + task: title: Task ID related to the prediction - project: type: integer - title: Project ID related to the prediction - created_at: - type: string - format: date-time - title: Creation time updated_at: - type: string format: date-time title: Last update time + type: string + title: Prediction object + type: object readOnly: true - total_predictions: - type: integer + title: Predictions + type: array + predictions_results: + readOnly: true + type: string predictions_score: - type: number format: double - predictions_results: + type: number + reviews_rejected: + type: integer + total_annotations: + type: integer + total_predictions: + type: integer + unresolved_comment_count: + readOnly: true type: string + required: + - annotations + - annotations_results + - comment_count + - comments + - created_at + - data + - drafts + - id + - predictions + - predictions_results + - unresolved_comment_count + type: object + LseTaskSerializerForReviewers: + description: Task Serializer with project scheme configs validation + properties: + agreement: readOnly: true - comments: type: string + annotations: readOnly: true - comment_count: type: string + annotations_ids: readOnly: true - unresolved_comment_count: type: string + annotations_results: readOnly: true - reviews_rejected: + type: string + annotators: + description: Annotators IDs who annotated this task + items: + title: User IDs + type: integer + readOnly: true + title: Annotators IDs + type: array + annotators_count: + description: The annotators_count is calculated as the number of users with annotations (can be repeated, so same as the number of annotations) + the number of assignees without annotations. + readOnly: true + type: integer + avg_lead_time: + format: double + type: number + cancelled_annotations: type: integer + comment_authors: + items: + additionalProperties: {} + type: object + readOnly: true + type: array + comment_authors_count: + readOnly: true + type: integer + comment_count: + description: Number of comments in the task including all annotations + maximum: 2147483647 + minimum: -2147483648 + type: integer + comments: + readOnly: true + type: string + completed_at: + format: date-time + type: string + created_at: + description: Time a task was created + format: date-time + readOnly: true + type: string + data: + description: User imported or uploaded data for a task. Data is formatted according to the project label config. You can find examples of data for your project on the Import page in the Label Studio Data Manager UI. draft_exists: type: boolean - required: - - annotations - - annotations_results - - comment_count - - comments - - created_at - - data - - drafts - - id - - predictions - - predictions_results - - unresolved_comment_count - LseTaskSerializerForReviewers: - type: object - description: Task Serializer with project scheme configs validation - properties: - id: - type: integer + drafts: + description: Drafts for this task + items: + properties: + created_at: + format: date-time + title: Creation time + type: string + result: + items: + title: Draft result item + type: object + title: Draft result + type: array + updated_at: + format: date-time + title: Last update time + type: string + title: Draft object + type: object + readOnly: true + title: Annotation drafts + type: array + file_upload: readOnly: true - agreement: type: string + ground_truth: + type: boolean + id: readOnly: true + type: integer + inner_id: + type: integer + is_labeled: + description: True if the number of annotations for this task is greater than or equal to the number of maximum_completions for the project + type: boolean + last_comment_updated_at: + description: When the last comment was updated + format: date-time + nullable: true + type: string + meta: + description: Meta is user imported (uploaded) data and can be useful as input for an ML Backend for embeddings, advanced vectors, and other info. It is passed to ML during training/predicting steps. + nullable: true + overlap: + description: Number of distinct annotators that processed the current task + maximum: 2147483647 + minimum: -2147483648 + type: integer predictions: - type: array - title: Predictions description: Predictions for this task items: - type: object - title: Prediction object properties: - result: - type: array - title: Prediction result - items: - type: object - title: Prediction result item - score: - type: number - title: Prediction score - model_version: + created_at: + format: date-time + title: Creation time type: string - title: Model version model: - type: object title: ML Backend instance - model_run: type: object + model_run: title: Model Run instance - task: - type: integer - title: Task ID related to the prediction + type: object + model_version: + title: Model version + type: string project: - type: integer title: Project ID related to the prediction - created_at: - type: string - format: date-time - title: Creation time - updated_at: - type: string - format: date-time - title: Last update time - readOnly: true - annotations: - type: string - readOnly: true - drafts: - type: array - title: Annotation drafts - description: Drafts for this task - items: - type: object - title: Draft object - properties: + type: integer result: - type: array - title: Draft result items: + title: Prediction result item type: object - title: Draft result item - created_at: - type: string - format: date-time - title: Creation time + title: Prediction result + type: array + score: + title: Prediction score + type: number + task: + title: Task ID related to the prediction + type: integer updated_at: - type: string format: date-time title: Last update time + type: string + title: Prediction object + type: object readOnly: true - annotators: + title: Predictions type: array - title: Annotators IDs - description: Annotators IDs who annotated this task - items: - type: integer - title: User IDs + predictions_model_versions: readOnly: true - inner_id: - type: integer - cancelled_annotations: - type: integer - total_annotations: - type: integer - total_predictions: - type: integer - completed_at: - type: string - format: date-time - annotations_results: type: string - readOnly: true predictions_results: - type: string readOnly: true + type: string predictions_score: - type: number format: double - file_upload: - type: string - readOnly: true - storage_filename: - type: string - readOnly: true - annotations_ids: - type: string - readOnly: true - predictions_model_versions: - type: string - readOnly: true - avg_lead_time: type: number - format: double - draft_exists: + project: + description: Project ID for this task + nullable: true + type: integer + reviewed: type: boolean - updated_by: - type: array - title: User IDs - description: User IDs who updated this task - items: - type: object - title: User IDs - readOnly: true reviewers: - type: array items: - type: object additionalProperties: {} + type: object readOnly: true - comments: - type: string - readOnly: true - comment_authors: type: array - items: - type: object - additionalProperties: {} + reviewers_count: readOnly: true - reviewed: - type: boolean + type: integer reviews_accepted: type: integer reviews_rejected: type: integer - ground_truth: - type: boolean - annotators_count: - type: integer - description: The annotators_count is calculated as the number of users with - annotations (can be repeated, so same as the number of annotations) + - the number of assignees without annotations. - readOnly: true - reviewers_count: - type: integer - readOnly: true - comment_authors_count: - type: integer - readOnly: true - data: - description: User imported or uploaded data for a task. Data is formatted - according to the project label config. You can find examples of data for - your project on the Import page in the Label Studio Data Manager UI. - meta: - nullable: true - description: Meta is user imported (uploaded) data and can be useful as - input for an ML Backend for embeddings, advanced vectors, and other info. - It is passed to ML during training/predicting steps. - created_at: - type: string - format: date-time + storage_filename: readOnly: true - description: Time a task was created - updated_at: type: string - format: date-time - readOnly: true - description: Last time a task was updated - is_labeled: - type: boolean - description: True if the number of annotations for this task is greater - than or equal to the number of maximum_completions for the project - overlap: + total_annotations: type: integer - maximum: 2147483647 - minimum: -2147483648 - description: Number of distinct annotators that processed the current task - comment_count: + total_predictions: type: integer - maximum: 2147483647 - minimum: -2147483648 - description: Number of comments in the task including all annotations unresolved_comment_count: - type: integer + description: Number of unresolved comments in the task including all annotations maximum: 2147483647 minimum: -2147483648 - description: Number of unresolved comments in the task including all annotations - last_comment_updated_at: - type: string - format: date-time - nullable: true - description: When the last comment was updated - project: type: integer - nullable: true - description: Project ID for this task + updated_at: + description: Last time a task was updated + format: date-time + readOnly: true + type: string + updated_by: + description: User IDs who updated this task + items: + title: User IDs + type: object + readOnly: true + title: User IDs + type: array required: - - agreement - - annotations - - annotations_ids - - annotations_results - - annotators - - annotators_count - - comment_authors - - comment_authors_count - - comments - - created_at - - data - - drafts - - file_upload - - id - - predictions - - predictions_model_versions - - predictions_results - - reviewers - - reviewers_count - - storage_filename - - updated_at - - updated_by - LseUser: + - agreement + - annotations + - annotations_ids + - annotations_results + - annotators + - annotators_count + - comment_authors + - comment_authors_count + - comments + - created_at + - data + - drafts + - file_upload + - id + - predictions + - predictions_model_versions + - predictions_results + - reviewers + - reviewers_count + - storage_filename + - updated_at + - updated_by type: object + LseUser: description: |- 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: + active_organization: + nullable: true type: integer + active_organization_meta: readOnly: true - first_name: type: string - maxLength: 256 - last_name: + allow_newsletters: + description: Allow sending newsletters to user + nullable: true + type: boolean + avatar: + readOnly: true type: string - maxLength: 256 - username: + custom_hotkeys: + description: Custom keyboard shortcuts configuration for the user interface + nullable: true + date_joined: + format: date-time type: string - maxLength: 256 email: - type: string format: email - title: Email address maxLength: 254 - last_activity: + title: Email address type: string - format: date-time - readOnly: true - custom_hotkeys: - nullable: true - description: Custom keyboard shortcuts configuration for the user interface - avatar: + first_name: + maxLength: 256 type: string + id: readOnly: true + type: integer initials: + default: '?' + readOnly: true type: string + last_activity: + format: date-time readOnly: true - default: '?' - phone: type: string + last_name: maxLength: 256 - active_organization: - type: integer - nullable: true - active_organization_meta: type: string + lse_fields: + allOf: + - $ref: '#/components/schemas/LseFields' readOnly: true - allow_newsletters: - type: boolean - nullable: true - description: Allow sending newsletters to user - date_joined: - type: string - format: date-time org_membership: - type: array items: $ref: '#/components/schemas/OrganizationMembership' readOnly: true - lse_fields: - allOf: - - $ref: '#/components/schemas/LseFields' - readOnly: true + type: array pause: - type: string readOnly: true + type: string + phone: + maxLength: 256 + type: string + username: + maxLength: 256 + type: string required: - - active_organization_meta - - avatar - - id - - initials - - last_activity - - lse_fields - - org_membership - - pause - - username - LseUserAPI: + - active_organization_meta + - avatar + - id + - initials + - last_activity + - lse_fields + - org_membership + - pause + - username type: object + LseUserAPI: description: |- 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: + active_organization: + nullable: true type: integer + active_organization_meta: readOnly: true - first_name: type: string - maxLength: 256 - last_name: + allow_newsletters: + description: Allow sending newsletters to user + nullable: true + type: boolean + avatar: + readOnly: true type: string - maxLength: 256 - username: + custom_hotkeys: + description: Custom keyboard shortcuts configuration for the user interface + nullable: true + date_joined: + format: date-time type: string - maxLength: 256 email: - type: string format: email - title: Email address maxLength: 254 - last_activity: + title: Email address type: string - format: date-time - readOnly: true - custom_hotkeys: - nullable: true - description: Custom keyboard shortcuts configuration for the user interface - avatar: + first_name: + maxLength: 256 type: string + id: readOnly: true + type: integer initials: + default: '?' + readOnly: true type: string + last_activity: + format: date-time readOnly: true - default: '?' - phone: type: string + last_name: maxLength: 256 - active_organization: - type: integer - nullable: true - active_organization_meta: - type: string - readOnly: true - allow_newsletters: - type: boolean - nullable: true - description: Allow sending newsletters to user - date_joined: type: string - format: date-time org_membership: - type: array items: $ref: '#/components/schemas/OrganizationMembership' readOnly: true + type: array + phone: + maxLength: 256 + type: string + username: + maxLength: 256 + type: string required: - - active_organization_meta - - avatar - - id - - initials - - last_activity - - org_membership - - username - LseUserOrganizationMemberList: + - active_organization_meta + - avatar + - id + - initials + - last_activity + - org_membership + - username type: object + LseUserOrganizationMemberList: description: |- 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: + active_organization: + nullable: true type: integer + allow_newsletters: + description: Allow sending newsletters to user + nullable: true + type: boolean + avatar: readOnly: true - first_name: type: string - maxLength: 256 - last_name: + contributed_to_projects: + readOnly: true type: string - maxLength: 256 - username: + created_projects: + readOnly: true type: string - maxLength: 256 - email: + custom_hotkeys: + description: Custom keyboard shortcuts configuration for the user interface + nullable: true + date_joined: + format: date-time type: string + email: format: email - title: Email address maxLength: 254 - last_activity: + title: Email address type: string - format: date-time - readOnly: true - custom_hotkeys: - nullable: true - description: Custom keyboard shortcuts configuration for the user interface - avatar: + first_name: + maxLength: 256 type: string + id: readOnly: true + type: integer initials: + default: '?' + readOnly: true type: string + last_activity: + format: date-time readOnly: true - default: '?' - phone: type: string + last_name: maxLength: 256 - active_organization: - type: integer - nullable: true - allow_newsletters: - type: boolean - nullable: true - description: Allow sending newsletters to user - date_joined: type: string - format: date-time lse_fields: allOf: - - $ref: '#/components/schemas/LseFields' + - $ref: '#/components/schemas/LseFields' readOnly: true pause: - type: string readOnly: true - created_projects: type: string - readOnly: true - contributed_to_projects: + phone: + maxLength: 256 + type: string + username: + maxLength: 256 type: string - readOnly: true required: - - avatar - - contributed_to_projects - - created_projects - - id - - initials - - last_activity - - lse_fields - - pause - - username - MLBackend: + - avatar + - contributed_to_projects + - created_projects + - id + - initials + - last_activity + - lse_fields + - pause + - username type: object + MLBackend: description: Serializer for MLBackend model. properties: - id: - type: integer - readOnly: true - state: - $ref: '#/components/schemas/StateEnum' - readable_state: - type: string - readOnly: true - is_interactive: - type: boolean - description: Used to interactively annotate tasks. If true, model returns - one list with results - url: - type: string - description: URL for the machine learning model server - error_message: - type: string - nullable: true - description: Error message in error state - title: - type: string - nullable: true - description: Name of the machine learning backend auth_method: $ref: '#/components/schemas/AuthMethodEnum' - basic_auth_user: + auto_update: + description: If false, model version is set by the user, if true - getting latest version from backend. + type: boolean + basic_auth_pass_is_set: + readOnly: true type: string - nullable: true + basic_auth_user: description: HTTP Basic Auth user - basic_auth_pass_is_set: + nullable: true type: string + created_at: + format: date-time readOnly: true + type: string description: + description: Description for the machine learning backend + nullable: true type: string + error_message: + description: Error message in error state nullable: true - description: Description for the machine learning backend + type: string extra_params: - nullable: true description: Any extra parameters passed to the ML Backend during the setup + nullable: true + id: + readOnly: true + type: integer + is_interactive: + description: Used to interactively annotate tasks. If true, model returns one list with results + type: boolean model_version: - type: string + description: Current model version associated with this machine learning backend nullable: true - description: Current model version associated with this machine learning - backend + type: string + project: + type: integer + readable_state: + readOnly: true + type: string + state: + $ref: '#/components/schemas/StateEnum' timeout: - type: number - format: double description: Response model timeout - created_at: + format: double + type: number + title: + description: Name of the machine learning backend + nullable: true type: string - format: date-time - readOnly: true updated_at: - type: string format: date-time readOnly: true - auto_update: - type: boolean - description: If false, model version is set by the user, if true - getting - latest version from backend. - project: - type: integer + type: string + url: + description: URL for the machine learning model server + type: string required: - - basic_auth_pass_is_set - - created_at - - id - - project - - readable_state - - updated_at - - url - MLBackendRequest: + - basic_auth_pass_is_set + - created_at + - id + - project + - readable_state + - updated_at + - url type: object + MLBackendRequest: description: Serializer for MLBackend model. properties: - state: - $ref: '#/components/schemas/StateEnum' - is_interactive: - type: boolean - description: Used to interactively annotate tasks. If true, model returns - one list with results - url: - type: string - minLength: 1 - description: URL for the machine learning model server - error_message: - type: string - nullable: true - description: Error message in error state - title: - type: string - nullable: true - description: Name of the machine learning backend auth_method: $ref: '#/components/schemas/AuthMethodEnum' - basic_auth_user: - type: string - nullable: true - description: HTTP Basic Auth user + auto_update: + description: If false, model version is set by the user, if true - getting latest version from backend. + type: boolean basic_auth_pass: + nullable: true type: string writeOnly: true + basic_auth_user: + description: HTTP Basic Auth user nullable: true - description: type: string - nullable: true + description: description: Description for the machine learning backend - extra_params: nullable: true - description: Any extra parameters passed to the ML Backend during the setup - model_version: type: string + error_message: + description: Error message in error state nullable: true - description: Current model version associated with this machine learning - backend - timeout: - type: number - format: double - description: Response model timeout - auto_update: + type: string + extra_params: + description: Any extra parameters passed to the ML Backend during the setup + nullable: true + is_interactive: + description: Used to interactively annotate tasks. If true, model returns one list with results type: boolean - description: If false, model version is set by the user, if true - getting - latest version from backend. + model_version: + description: Current model version associated with this machine learning backend + nullable: true + type: string project: type: integer + state: + $ref: '#/components/schemas/StateEnum' + timeout: + description: Response model timeout + format: double + type: number + title: + description: Name of the machine learning backend + nullable: true + type: string + url: + description: URL for the machine learning model server + minLength: 1 + type: string required: - - project - - url - MLInteractiveAnnotatingRequestRequest: + - project + - url type: object + MLInteractiveAnnotatingRequestRequest: description: Serializer for ML interactive annotating request. properties: - task: - type: integer - description: ID of task to annotate context: - nullable: true description: Context for ML model + nullable: true + task: + description: ID of task to annotate + type: integer required: - - task + - task + type: object MaybeExpandedComment: oneOf: - - $ref: '#/components/schemas/Comment' - - $ref: '#/components/schemas/CommentSerializerWithExpandedUser' + - $ref: '#/components/schemas/Comment' + - $ref: '#/components/schemas/CommentSerializerWithExpandedUser' ModeEnum: - enum: - - settings - - settings,data - type: string description: |- * `settings` - Only settings * `settings,data` - Settings and tasks + enum: + - settings + - settings,data + type: string ModelInterface: - type: object properties: - id: - type: integer + associated_projects: + items: + type: integer + type: array + created_at: + format: date-time readOnly: true + type: string created_by: allOf: - - $ref: '#/components/schemas/UserSimple' + - $ref: '#/components/schemas/UserSimple' description: User who created Dataset + description: + description: Model description + nullable: true + type: string + id: + readOnly: true + type: integer + input_fields: {} + organization: + nullable: true + type: integer + output_classes: {} skill_name: allOf: - - $ref: '#/components/schemas/SkillNameEnum' + - $ref: '#/components/schemas/SkillNameEnum' default: TextClassification title: - type: string description: Model name maxLength: 500 - description: - type: string - nullable: true - description: Model description - created_at: type: string - format: date-time - readOnly: true updated_at: - type: string format: date-time readOnly: true - input_fields: {} - output_classes: {} - organization: - type: integer - nullable: true - associated_projects: - type: array - items: - type: integer + type: string required: - - created_at - - id - - title - - updated_at - ModelInterfaceRequest: + - created_at + - id + - title + - updated_at type: object + ModelInterfaceRequest: properties: + associated_projects: + items: + type: integer + type: array created_by: allOf: - - $ref: '#/components/schemas/UserSimpleRequest' + - $ref: '#/components/schemas/UserSimpleRequest' description: User who created Dataset + description: + description: Model description + nullable: true + type: string + input_fields: {} + organization: + nullable: true + type: integer + output_classes: {} skill_name: allOf: - - $ref: '#/components/schemas/SkillNameEnum' + - $ref: '#/components/schemas/SkillNameEnum' default: TextClassification title: - type: string - minLength: 1 description: Model name maxLength: 500 - description: + minLength: 1 type: string - nullable: true - description: Model description - input_fields: {} - output_classes: {} - organization: - type: integer - nullable: true - associated_projects: - type: array - items: - type: integer required: - - title - ModelInterfaceSerializerGET: + - title type: object + ModelInterfaceSerializerGET: properties: - id: - type: integer + associated_projects: + default: [] + items: + $ref: '#/components/schemas/AssociatedProject' + type: array + created_at: + format: date-time readOnly: true + type: string created_by: allOf: - - $ref: '#/components/schemas/UserSimple' + - $ref: '#/components/schemas/UserSimple' description: User who created Dataset + description: + description: Model description + nullable: true + type: string + id: + readOnly: true + type: integer + input_fields: {} + organization: + nullable: true + type: integer + output_classes: {} skill_name: allOf: - - $ref: '#/components/schemas/SkillNameEnum' + - $ref: '#/components/schemas/SkillNameEnum' default: TextClassification - associated_projects: - type: array - items: - $ref: '#/components/schemas/AssociatedProject' - default: [] title: - type: string description: Model name maxLength: 500 - description: type: string - nullable: true - description: Model description - created_at: - type: string - format: date-time - readOnly: true updated_at: - type: string format: date-time readOnly: true - input_fields: {} - output_classes: {} - organization: - type: integer - nullable: true + type: string required: - - created_at - - id - - title - - updated_at - ModelProviderConnection: + - created_at + - id + - title + - updated_at type: object + ModelProviderConnection: properties: - id: - type: integer - readOnly: true - created_by: - allOf: - - $ref: '#/components/schemas/UserSimple' - readOnly: true - model_params: - type: string - readOnly: true - description: JSON schema for the model parameters available for the provider - provider: - $ref: '#/components/schemas/ProviderEnum' - deployment_name: - type: string - nullable: true - description: Azure OpenAI deployment name - maxLength: 512 - endpoint: - type: string - nullable: true - description: Azure OpenAI endpoint - maxLength: 512 - google_project_id: - type: string - nullable: true - description: Google project ID - maxLength: 255 - google_location: - type: string - nullable: true - description: Google project location - maxLength: 255 - cached_available_models: - type: string + budget_alert_threshold: + description: Budget alert threshold for the given provider connection + format: double nullable: true - description: List of available models from the provider - maxLength: 4096 - scope: - $ref: '#/components/schemas/ScopeEnum' - created_at: - type: string + type: number + budget_last_reset_date: + description: Date and time the budget was last reset format: date-time + nullable: true readOnly: true - updated_at: type: string - format: date-time - readOnly: true - is_internal: - type: boolean - nullable: true - description: Whether the model provider connection is internal, not visible - to the user budget_limit: - type: number + description: Budget limit for the model provider connection (null if unlimited) format: double - readOnly: true nullable: true - description: Budget limit for the model provider connection (null if unlimited) - budget_last_reset_date: - type: string - format: date-time readOnly: true - nullable: true - description: Date and time the budget was last reset + type: number budget_reset_period: - readOnly: true - nullable: true description: |- Budget reset period for the model provider connection (null if not reset) * `Monthly` - Monthly * `Yearly` - Yearly + nullable: true oneOf: - - $ref: '#/components/schemas/BudgetResetPeriodEnum' - - $ref: '#/components/schemas/NullEnum' + - $ref: '#/components/schemas/BudgetResetPeriodEnum' + - $ref: '#/components/schemas/NullEnum' + readOnly: true budget_total_spent: - type: number + description: Tracked total budget spent for the given provider connection within the current budget period format: double - readOnly: true nullable: true - description: Tracked total budget spent for the given provider connection - within the current budget period - budget_alert_threshold: + readOnly: true type: number - format: double + cached_available_models: + description: List of available models from the provider + maxLength: 4096 + nullable: true + type: string + created_at: + format: date-time + readOnly: true + type: string + created_by: + allOf: + - $ref: '#/components/schemas/UserSimple' + readOnly: true + deployment_name: + description: Azure OpenAI deployment name + maxLength: 512 + nullable: true + type: string + endpoint: + description: Azure OpenAI endpoint + maxLength: 512 + nullable: true + type: string + google_location: + description: Google project location + maxLength: 255 + nullable: true + type: string + google_project_id: + description: Google project ID + maxLength: 255 + nullable: true + type: string + id: + readOnly: true + type: integer + is_internal: + description: Whether the model provider connection is internal, not visible to the user nullable: true - description: Budget alert threshold for the given provider connection + type: boolean + model_params: + description: JSON schema for the model parameters available for the provider + readOnly: true + type: string organization: + nullable: true + readOnly: true type: integer + provider: + $ref: '#/components/schemas/ProviderEnum' + scope: + $ref: '#/components/schemas/ScopeEnum' + updated_at: + format: date-time readOnly: true - nullable: true + type: string required: - - budget_last_reset_date - - budget_limit - - budget_reset_period - - budget_total_spent - - created_at - - created_by - - id - - model_params - - organization - - updated_at - ModelProviderConnectionRequest: + - budget_last_reset_date + - budget_limit + - budget_reset_period + - budget_total_spent + - created_at + - created_by + - id + - model_params + - organization + - updated_at type: object + ModelProviderConnectionRequest: properties: - provider: - $ref: '#/components/schemas/ProviderEnum' api_key: + description: Model provider API key + nullable: true type: string writeOnly: true - nullable: true - description: Model provider API key auth_token: + description: Model provider Auth token + nullable: true type: string writeOnly: true + budget_alert_threshold: + description: Budget alert threshold for the given provider connection + format: double nullable: true - description: Model provider Auth token - deployment_name: - type: string + type: number + cached_available_models: + description: List of available models from the provider + maxLength: 4096 nullable: true + type: string + deployment_name: description: Azure OpenAI deployment name maxLength: 512 - endpoint: - type: string nullable: true + type: string + endpoint: description: Azure OpenAI endpoint maxLength: 512 + nullable: true + type: string google_application_credentials: + description: The content of GOOGLE_APPLICATION_CREDENTIALS json file + nullable: true type: string writeOnly: true + google_location: + description: Google project location + maxLength: 255 nullable: true - description: The content of GOOGLE_APPLICATION_CREDENTIALS json file - google_project_id: type: string - nullable: true + google_project_id: description: Google project ID maxLength: 255 - google_location: - type: string nullable: true - description: Google project location - maxLength: 255 - cached_available_models: type: string + is_internal: + description: Whether the model provider connection is internal, not visible to the user nullable: true - description: List of available models from the provider - maxLength: 4096 + type: boolean + provider: + $ref: '#/components/schemas/ProviderEnum' scope: $ref: '#/components/schemas/ScopeEnum' - is_internal: - type: boolean - nullable: true - description: Whether the model provider connection is internal, not visible - to the user - budget_alert_threshold: - type: number - format: double - nullable: true - description: Budget alert threshold for the given provider connection - ModelRun: type: object + ModelRun: properties: - id: + completed_at: + format: date-time + nullable: true + readOnly: true + type: string + created_at: + format: date-time + readOnly: true + type: string + created_by: + nullable: true + readOnly: true type: integer + id: readOnly: true - parent_model: type: integer + job_id: + description: Job ID for inference job for a ModelRun e.g. Adala job ID + maxLength: 255 + nullable: true + type: string + organization: + nullable: true + type: integer + parent_model: readOnly: true + type: integer + predictions_updated_at: + format: date-time + nullable: true + type: string + project: + type: integer project_subset: $ref: '#/components/schemas/ProjectSubsetEnum' status: allOf: - - $ref: '#/components/schemas/ModelRunStatusEnum' + - $ref: '#/components/schemas/ModelRunStatusEnum' readOnly: true - job_id: - type: string - nullable: true - description: Job ID for inference job for a ModelRun e.g. Adala job ID - maxLength: 255 - total_predictions: - type: integer + total_correct_predictions: maximum: 2147483647 minimum: -2147483648 - total_correct_predictions: type: integer + total_predictions: maximum: 2147483647 minimum: -2147483648 - total_tasks: type: integer + total_tasks: maximum: 2147483647 minimum: -2147483648 - created_at: - type: string - format: date-time - readOnly: true + type: integer triggered_at: - type: string format: date-time - readOnly: true nullable: true - predictions_updated_at: + readOnly: true type: string - format: date-time + required: + - completed_at + - created_at + - created_by + - id + - parent_model + - project + - status + - triggered_at + type: object + ModelRunRequest: + properties: + job_id: + description: Job ID for inference job for a ModelRun e.g. Adala job ID + maxLength: 255 nullable: true - completed_at: type: string - format: date-time - readOnly: true - nullable: true organization: + nullable: true type: integer + predictions_updated_at: + format: date-time nullable: true + type: string project: type: integer - created_by: - type: integer - readOnly: true - nullable: true - required: - - completed_at - - created_at - - created_by - - id - - parent_model - - project - - status - - triggered_at - ModelRunRequest: - type: object - properties: project_subset: $ref: '#/components/schemas/ProjectSubsetEnum' - job_id: - type: string - nullable: true - description: Job ID for inference job for a ModelRun e.g. Adala job ID - maxLength: 255 - total_predictions: - type: integer + total_correct_predictions: maximum: 2147483647 minimum: -2147483648 - total_correct_predictions: type: integer + total_predictions: maximum: 2147483647 minimum: -2147483648 - total_tasks: type: integer + total_tasks: maximum: 2147483647 minimum: -2147483648 - predictions_updated_at: - type: string - format: date-time - nullable: true - organization: - type: integer - nullable: true - project: type: integer required: - - project + - project + type: object ModelRunStatusEnum: - enum: - - Pending - - InProgress - - Completed - - Failed - - Canceled - type: string description: |- * `Pending` - Pending * `InProgress` - InProgress * `Completed` - Completed * `Failed` - Failed * `Canceled` - Canceled + enum: + - Pending + - InProgress + - Completed + - Failed + - Canceled + type: string NullEnum: enum: - - null + - null OnboardingStateEnum: - enum: - - not_started - - signup - - trial_signup - - first_tutorial - - in_app_guidance - - complete - type: string description: |- * `not_started` - Not Started * `signup` - Signup @@ -22709,300 +22345,297 @@ components: * `first_tutorial` - First Tutorial * `in_app_guidance` - In App Guidance * `complete` - Complete + enum: + - not_started + - signup + - trial_signup + - first_tutorial + - in_app_guidance + - complete + type: string OrganizationBilling: - type: object properties: - manual_workspace_management: - type: string - readOnly: true manual_role_management: + readOnly: true type: string + manual_workspace_management: readOnly: true + type: string required: - - manual_role_management - - manual_workspace_management - OrganizationId: + - manual_role_management + - manual_workspace_management type: object + OrganizationId: description: |- A serializer mixin that takes an additional `fields` argument that controls which fields should be displayed. properties: - id: - type: integer - readOnly: true - title: - type: string - title: Organization title - maxLength: 1000 contact_info: - type: string format: email - nullable: true maxLength: 254 - created_at: + nullable: true type: string + created_at: format: date-time readOnly: true + type: string + id: + readOnly: true + type: integer + title: + maxLength: 1000 + title: Organization title + type: string required: - - created_at - - id - - title - OrganizationInvite: + - created_at + - id + - title type: object + OrganizationInvite: properties: - token: - type: string invite_url: type: string - OrganizationMember: + token: + type: string type: object + OrganizationMember: description: |- A serializer mixin that takes an additional `fields` argument that controls which fields should be displayed. properties: - user: - type: integer - description: User ID - organization: - type: integer - description: Organization ID - contributed_projects_count: - type: string - readOnly: true annotations_count: + readOnly: true type: string + contributed_projects_count: readOnly: true - created_at: type: string + created_at: format: date-time readOnly: true - required: - - annotations_count - - contributed_projects_count - - created_at - - organization - - user - OrganizationMemberCreateUpdateRequest: - type: object - properties: - user_id: + type: string + organization: + description: Organization ID + type: integer + user: + description: User ID type: integer - role: - $ref: '#/components/schemas/Role9e7Enum' required: - - role - - user_id - OrganizationMembership: + - annotations_count + - contributed_projects_count + - created_at + - organization + - user type: object + OrganizationMembership: properties: - role: - type: string active: - type: string readOnly: true + type: string organization_id: - type: integer description: Organization ID readOnly: true + type: integer + role: + type: string required: - - active - - organization_id - - role - OrganizationMembershipRequest: + - active + - organization_id + - role type: object + OrganizationMembershipRequest: properties: role: - type: string minLength: 1 + type: string required: - - role - PaginatedAllRolesProjectListList: + - role type: object - required: - - count - - results + PaginatedAllRolesProjectListList: properties: count: - type: integer example: 123 + type: integer next: - type: string - nullable: true - format: uri example: http://api.example.org/accounts/?page=4 - previous: - type: string - nullable: true format: uri + nullable: true + type: string + previous: example: http://api.example.org/accounts/?page=2 + format: uri + nullable: true + type: string results: - type: array items: $ref: '#/components/schemas/AllRolesProjectList' - PaginatedAnnotationHistoryList: - type: object + type: array required: - - count - - results + - count + - results + type: object + PaginatedAnnotationHistoryList: properties: count: - type: integer example: 123 + type: integer next: - type: string - nullable: true - format: uri example: http://api.example.org/accounts/?page=4 - previous: - type: string - nullable: true format: uri + nullable: true + type: string + previous: example: http://api.example.org/accounts/?page=2 + format: uri + nullable: true + type: string results: - type: array items: $ref: '#/components/schemas/AnnotationHistory' - PaginatedLabelCreateList: - type: object + type: array required: - - count - - results + - count + - results + type: object + PaginatedLabelCreateList: properties: count: - type: integer example: 123 + type: integer next: - type: string - nullable: true - format: uri example: http://api.example.org/accounts/?page=4 - previous: - type: string - nullable: true format: uri + nullable: true + type: string + previous: example: http://api.example.org/accounts/?page=2 + format: uri + nullable: true + type: string results: - type: array items: $ref: '#/components/schemas/LabelCreate' - PaginatedLabelLinkList: - type: object + type: array required: - - count - - results + - count + - results + type: object + PaginatedLabelLinkList: properties: count: - type: integer example: 123 + type: integer next: - type: string - nullable: true - format: uri example: http://api.example.org/accounts/?page=4 - previous: - type: string - nullable: true format: uri + nullable: true + type: string + previous: example: http://api.example.org/accounts/?page=2 + format: uri + nullable: true + type: string results: - type: array items: $ref: '#/components/schemas/LabelLink' - PaginatedLabelList: - type: object + type: array required: - - count - - results + - count + - results + type: object + PaginatedLabelList: properties: count: - type: integer example: 123 + type: integer next: - type: string - nullable: true - format: uri example: http://api.example.org/accounts/?page=4 - previous: - type: string - nullable: true format: uri + nullable: true + type: string + previous: example: http://api.example.org/accounts/?page=2 + format: uri + nullable: true + type: string results: - type: array items: $ref: '#/components/schemas/Label' - PaginatedLseOrganizationMemberListList: - type: object + type: array required: - - count - - results + - count + - results + type: object + PaginatedLseOrganizationMemberListList: properties: count: - type: integer example: 123 + type: integer next: - type: string - nullable: true - format: uri example: http://api.example.org/accounts/?page=4 - previous: - type: string - nullable: true format: uri + nullable: true + type: string + previous: example: http://api.example.org/accounts/?page=2 + format: uri + nullable: true + type: string results: - type: array items: $ref: '#/components/schemas/LseOrganizationMemberList' - PaginatedLseProjectCountsList: - type: object + type: array required: - - count - - results + - count + - results + type: object + PaginatedLseProjectCountsList: properties: count: - type: integer example: 123 + type: integer next: - type: string - nullable: true - format: uri example: http://api.example.org/accounts/?page=4 - previous: - type: string - nullable: true format: uri + nullable: true + type: string + previous: example: http://api.example.org/accounts/?page=2 + format: uri + nullable: true + type: string results: - type: array items: $ref: '#/components/schemas/LseProjectCounts' - PaginatedRoleBasedTaskList: + type: array + required: + - count + - results type: object + PaginatedRoleBasedTaskList: properties: tasks: - type: array items: $ref: '#/components/schemas/RoleBasedTask' + type: array total: - type: integer description: Total number of tasks example: 123 - total_annotations: type: integer + total_annotations: description: Total number of annotations example: 456 - total_predictions: type: integer + total_predictions: description: Total number of predictions example: 78 + type: integer required: - - tasks - - total - - total_annotations - - total_predictions - PatchedAnnotationReviewRequest: + - tasks + - total + - total_annotations + - total_predictions type: object + PatchedAnnotationReviewRequest: description: |- A ModelSerializer that takes additional arguments for "fields", "omit" and "expand" in order to @@ -23010,370 +22643,385 @@ components: values with complex, nested serializations properties: accepted: - type: boolean description: Accepted or rejected (if false) flag - result: - nullable: true + type: boolean annotation: - type: integer description: Corresponding annotation - last_annotation_history: type: integer - nullable: true comment: + minLength: 1 + nullable: true type: string writeOnly: true + last_annotation_history: nullable: true - minLength: 1 + type: integer remove_from_queue: + nullable: true type: boolean + result: nullable: true started_at: - type: string format: date-time nullable: true - PatchedAzureDatasetStorageRequest: + type: string type: object + PatchedAzureDatasetStorageRequest: properties: - synchronizable: - type: boolean - default: true - presign: - type: boolean - default: true - container: - type: string + account_key: + description: Azure Blob account key nullable: true - description: Azure blob container - prefix: type: string + account_name: + description: Azure Blob account name nullable: true - description: Azure blob prefix name - regex_filter: type: string + container: + description: Azure blob container nullable: true - description: Cloud storage regex for filtering objects - use_blob_urls: - type: boolean - description: Interpret objects as BLOBs and generate URLs - account_name: type: string + dataset: + description: A unique integer value identifying this dataset. + type: integer + description: + description: Cloud storage description nullable: true - description: Azure Blob account name - account_key: type: string + glob_pattern: + description: Glob pattern for syncing from bucket nullable: true - description: Azure Blob account key - last_sync: type: string + last_sync: + description: Last sync finished time format: date-time nullable: true - description: Last sync finished time + type: string last_sync_count: - type: integer + description: Count of tasks synced last time maximum: 2147483647 minimum: 0 nullable: true - description: Count of tasks synced last time + type: integer last_sync_job: - type: string - nullable: true description: Last sync job ID maxLength: 256 - status: - $ref: '#/components/schemas/StatusC5aEnum' - traceback: - type: string nullable: true - description: Traceback report for the last failed sync + type: string meta: - nullable: true description: Meta and debug information about storage processes - title: - type: string nullable: true - description: Cloud storage title - maxLength: 256 - description: - type: string + prefix: + description: Azure blob prefix name nullable: true - description: Cloud storage description + type: string + presign: + default: true + type: boolean presign_ttl: - type: integer + description: Presigned URLs TTL (in minutes) maximum: 32767 minimum: 0 - description: Presigned URLs TTL (in minutes) - glob_pattern: - type: string + type: integer + regex_filter: + description: Cloud storage regex for filtering objects nullable: true - description: Glob pattern for syncing from bucket + type: string + status: + $ref: '#/components/schemas/StatusC5aEnum' synced: - type: boolean description: Flag if dataset has been previously synced or not - dataset: - type: integer - description: A unique integer value identifying this dataset. - PatchedAzureServicePrincipalExportStorageRequest: - type: object - properties: - synchronizable: type: boolean + synchronizable: default: true - prefix: - type: string + type: boolean + title: + description: Cloud storage title + maxLength: 256 nullable: true - description: Azure blob prefix name - regex_filter: type: string + traceback: + description: Traceback report for the last failed sync nullable: true - description: Cloud storage regex for filtering objects + type: string use_blob_urls: - type: boolean description: Interpret objects as BLOBs and generate URLs + type: boolean + type: object + PatchedAzureServicePrincipalExportStorageRequest: + properties: account_name: - type: string - nullable: true description: Azure Blob account name - container: - type: string nullable: true - description: Azure blob container - tenant_id: type: string + can_delete_objects: + description: Deletion from storage enabled nullable: true - description: Azure Tenant ID + type: boolean client_id: - type: string - nullable: true description: Azure Blob Service Principal Client ID + nullable: true + type: string client_secret: + description: Azure Blob Service Principal Client Secret + nullable: true type: string + container: + description: Azure blob container nullable: true - description: Azure Blob Service Principal Client Secret - user_delegation_key: type: string + description: + description: Cloud storage description nullable: true - description: User Delegation Key (Backend) - last_sync: type: string + last_sync: + description: Last sync finished time format: date-time nullable: true - description: Last sync finished time + type: string last_sync_count: - type: integer + description: Count of tasks synced last time maximum: 2147483647 minimum: 0 nullable: true - description: Count of tasks synced last time + type: integer last_sync_job: - type: string - nullable: true description: Last sync job ID maxLength: 256 - status: - $ref: '#/components/schemas/StatusC5aEnum' - traceback: - type: string nullable: true - description: Traceback report for the last failed sync + type: string meta: - nullable: true description: Meta and debug information about storage processes - title: - type: string - nullable: true - description: Cloud storage title - maxLength: 256 - description: - type: string nullable: true - description: Cloud storage description - can_delete_objects: - type: boolean + prefix: + description: Azure blob prefix name nullable: true - description: Deletion from storage enabled + type: string project: - type: integer description: A unique integer value identifying this project. - PatchedAzureServicePrincipalImportStorageRequest: - type: object - properties: + type: integer + regex_filter: + description: Cloud storage regex for filtering objects + nullable: true + type: string + status: + $ref: '#/components/schemas/StatusC5aEnum' synchronizable: - type: boolean default: true - presign: type: boolean - default: true - prefix: + tenant_id: + description: Azure Tenant ID + nullable: true type: string + title: + description: Cloud storage title + maxLength: 256 nullable: true - description: Azure blob prefix name - regex_filter: type: string + traceback: + description: Traceback report for the last failed sync nullable: true - description: Cloud storage regex for filtering objects + type: string use_blob_urls: - type: boolean description: Interpret objects as BLOBs and generate URLs - account_name: - type: string + type: boolean + user_delegation_key: + description: User Delegation Key (Backend) nullable: true - description: Azure Blob account name - container: type: string + type: object + PatchedAzureServicePrincipalImportStorageRequest: + properties: + account_name: + description: Azure Blob account name nullable: true - description: Azure blob container - tenant_id: type: string - nullable: true - description: Azure Tenant ID client_id: - type: string - nullable: true description: Azure Blob Service Principal Client ID + nullable: true + type: string client_secret: + description: Azure Blob Service Principal Client Secret + nullable: true type: string + container: + description: Azure blob container nullable: true - description: Azure Blob Service Principal Client Secret - user_delegation_key: type: string + description: + description: Cloud storage description nullable: true - description: User Delegation Key (Backend) - last_sync: type: string + last_sync: + description: Last sync finished time format: date-time nullable: true - description: Last sync finished time + type: string last_sync_count: - type: integer + description: Count of tasks synced last time maximum: 2147483647 minimum: 0 nullable: true - description: Count of tasks synced last time + type: integer last_sync_job: - type: string - nullable: true description: Last sync job ID maxLength: 256 - status: - $ref: '#/components/schemas/StatusC5aEnum' - traceback: - type: string nullable: true - description: Traceback report for the last failed sync + type: string meta: - nullable: true description: Meta and debug information about storage processes - title: - type: string nullable: true - description: Cloud storage title - maxLength: 256 - description: - type: string + prefix: + description: Azure blob prefix name nullable: true - description: Cloud storage description + type: string + presign: + default: true + type: boolean presign_ttl: - type: integer + description: Presigned URLs TTL (in minutes) maximum: 32767 minimum: 0 - description: Presigned URLs TTL (in minutes) - project: type: integer + project: description: A unique integer value identifying this project. - PatchedCommentRequest: + type: integer + regex_filter: + description: Cloud storage regex for filtering objects + nullable: true + type: string + status: + $ref: '#/components/schemas/StatusC5aEnum' + synchronizable: + default: true + type: boolean + tenant_id: + description: Azure Tenant ID + nullable: true + type: string + title: + description: Cloud storage title + maxLength: 256 + nullable: true + type: string + traceback: + description: Traceback report for the last failed sync + nullable: true + type: string + use_blob_urls: + description: Interpret objects as BLOBs and generate URLs + type: boolean + user_delegation_key: + description: User Delegation Key (Backend) + nullable: true + type: string type: object + PatchedCommentRequest: properties: - region_ref: + annotation: nullable: true - description: Set if this comment is related to a specific part of the annotation. - Normally contains region ID and control name. + type: integer classifications: - nullable: true description: Classifications applied by a reviewer or annotator - text: - type: string nullable: true - description: Reviewer or annotator comment - is_resolved: - type: boolean - description: True if the comment is resolved draft: - type: integer nullable: true - annotation: type: integer + is_resolved: + description: True if the comment is resolved + type: boolean + region_ref: + description: Set if this comment is related to a specific part of the annotation. Normally contains region ID and control name. nullable: true - PatchedDatasetRequest: + text: + description: Reviewer or annotator comment + nullable: true + type: string type: object + PatchedDatasetRequest: properties: + columns: + description: All data columns found in Dataset tasks + nullable: true created_by: allOf: - - $ref: '#/components/schemas/UserSimpleRequest' + - $ref: '#/components/schemas/UserSimpleRequest' description: User who created Dataset - title: + description: + description: Dataset description + nullable: true type: string - minLength: 1 + organization: + nullable: true + type: integer + title: description: Dataset title maxLength: 1000 - description: + minLength: 1 type: string - nullable: true - description: Dataset description - columns: - nullable: true - description: All data columns found in Dataset tasks total_entities: - type: integer maximum: 2147483647 minimum: -2147483648 nullable: true title: The number of entities in the dataset + type: integer vector_db_dataset_name: - type: string - minLength: 1 description: Dataset name for weaviate schema maxLength: 37 - organization: - type: integer - nullable: true - PatchedDatasetViewRequest: + minLength: 1 + type: string type: object + PatchedDatasetViewRequest: properties: + data: + description: Custom view data + nullable: true + dataset: + description: Dataset ID + type: integer filter_group: $ref: '#/components/schemas/FilterGroupRequest' - data: - nullable: true - description: Custom view data - ordering: - nullable: true - description: Ordering parameters order: - type: integer + description: Position of the tab, starting at the left in data manager and increasing as the tabs go left to right maximum: 2147483647 minimum: -2147483648 nullable: true - description: Position of the tab, starting at the left in data manager and - increasing as the tabs go left to right - selected_items: + type: integer + ordering: + description: Ordering parameters nullable: true + selected_items: description: Selected items - user: - type: integer nullable: true + user: description: User who made this view - dataset: + nullable: true type: integer - description: Dataset ID - PatchedDefaultRoleRequest: type: object + PatchedDefaultRoleRequest: properties: - organization: - type: integer - description: A unique integer value identifying this organization. + annotator_reviewer_firewall_enabled_at: + description: 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. + format: date-time + nullable: true + type: string + custom_scripts_editable_by: + description: |- + Set the minimum user role that can edit custom scripts in the UI. + + * `AD` - Administrator + * `MA` - Manager + nullable: true + oneOf: + - $ref: '#/components/schemas/CustomScriptsEditableByEnum' + - $ref: '#/components/schemas/NullEnum' + custom_scripts_enabled_at: + description: 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. + format: date-time + nullable: true + type: string default_role: allOf: - - $ref: '#/components/schemas/DefaultRoleEnum' + - $ref: '#/components/schemas/DefaultRoleEnum' description: |- Default membership role for invited users @@ -23384,336 +23032,307 @@ components: * `AN` - Annotator * `DI` - Deactivated * `NO` - Not Activated - external_id: - type: string + email_notification_settings: + description: 'Email notification settings for this organization. Controls which email notifications users can receive. Structure: {"notifications_allowed": {"notification_type": bool}}' nullable: true - description: External ID to uniquely identify this organization embed_domains: + description: 'List of objects: {"domain": "example.com"}. Used for CSP header on /embed routes.' nullable: true - description: 'List of objects: {"domain": "example.com"}. Used for CSP header - on /embed routes.' embed_settings: - nullable: true description: Embed settings for this organization - extra_data_on_activity_logs: - type: boolean - custom_scripts_enabled_at: - type: string - format: date-time nullable: true - description: 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: + external_id: + description: External ID to uniquely identify this organization nullable: true - description: |- - Set the minimum user role that can edit custom scripts in the UI. - - * `AD` - Administrator - * `MA` - Manager - oneOf: - - $ref: '#/components/schemas/CustomScriptsEditableByEnum' - - $ref: '#/components/schemas/NullEnum' - annotator_reviewer_firewall_enabled_at: type: string + extra_data_on_activity_logs: + type: boolean + label_stream_navigation_disabled_at: + description: 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. format: date-time nullable: true - description: 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: string + organization: + description: A unique integer value identifying this organization. + type: integer + read_only_quick_view_enabled_at: + description: Set to current time to prevent creating or editing annotations in quick view. format: date-time nullable: true - description: Set to current time to prevent creating or editing annotations - in quick view. - label_stream_navigation_disabled_at: type: string - format: date-time - nullable: true - description: 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. - email_notification_settings: - nullable: true - description: 'Email notification settings for this organization. Controls - which email notifications users can receive. Structure: {"notifications_allowed": - {"notification_type": bool}}' - PatchedFileUploadRequest: type: object + PatchedFileUploadRequest: properties: file: - type: string format: binary - PatchedGCSDatasetStorageRequest: + type: string type: object + PatchedGCSDatasetStorageRequest: properties: - synchronizable: - type: boolean - default: true - presign: - type: boolean - default: true bucket: - type: string - nullable: true description: GCS bucket name - prefix: - type: string nullable: true - description: GCS bucket prefix - regex_filter: type: string + dataset: + description: A unique integer value identifying this dataset. + type: integer + description: + description: Cloud storage description nullable: true - description: Cloud storage regex for filtering objects - use_blob_urls: - type: boolean - description: Interpret objects as BLOBs and generate URLs - google_application_credentials: type: string + glob_pattern: + description: Glob pattern for syncing from bucket nullable: true - description: The content of GOOGLE_APPLICATION_CREDENTIALS json file - google_project_id: type: string + google_application_credentials: + description: The content of GOOGLE_APPLICATION_CREDENTIALS json file nullable: true + type: string + google_project_id: description: Google project ID - last_sync: + nullable: true type: string + last_sync: + description: Last sync finished time format: date-time nullable: true - description: Last sync finished time + type: string last_sync_count: - type: integer + description: Count of tasks synced last time maximum: 2147483647 minimum: 0 nullable: true - description: Count of tasks synced last time + type: integer last_sync_job: - type: string - nullable: true description: Last sync job ID maxLength: 256 - status: - $ref: '#/components/schemas/StatusC5aEnum' - traceback: - type: string nullable: true - description: Traceback report for the last failed sync + type: string meta: - nullable: true description: Meta and debug information about storage processes - title: - type: string nullable: true - description: Cloud storage title - maxLength: 256 - description: - type: string + prefix: + description: GCS bucket prefix nullable: true - description: Cloud storage description + type: string + presign: + default: true + type: boolean presign_ttl: - type: integer + description: Presigned URLs TTL (in minutes) maximum: 32767 minimum: 0 - description: Presigned URLs TTL (in minutes) - glob_pattern: - type: string + type: integer + regex_filter: + description: Cloud storage regex for filtering objects nullable: true - description: Glob pattern for syncing from bucket + type: string + status: + $ref: '#/components/schemas/StatusC5aEnum' synced: - type: boolean description: Flag if dataset has been previously synced or not - dataset: - type: integer - description: A unique integer value identifying this dataset. - PatchedGCSWIFExportStorageRequest: - type: object - properties: - synchronizable: type: boolean + synchronizable: default: true - bucket: - type: string + type: boolean + title: + description: Cloud storage title + maxLength: 256 nullable: true - description: GCS bucket name - prefix: type: string + traceback: + description: Traceback report for the last failed sync nullable: true - description: GCS bucket prefix - regex_filter: type: string - nullable: true - description: Cloud storage regex for filtering objects use_blob_urls: - type: boolean description: Interpret objects as BLOBs and generate URLs - google_application_credentials: + type: boolean + type: object + PatchedGCSWIFExportStorageRequest: + properties: + bucket: + description: GCS bucket name + nullable: true type: string + can_delete_objects: + description: Deletion from storage enabled + nullable: true + type: boolean + description: + description: Cloud storage description nullable: true - description: The content of GOOGLE_APPLICATION_CREDENTIALS json file - google_project_id: type: string + google_application_credentials: + description: The content of GOOGLE_APPLICATION_CREDENTIALS json file nullable: true - description: Google project ID - google_project_number: type: string + google_project_id: + description: Google project ID nullable: true + type: string + google_project_number: description: Google project number - google_wif_pool_id: + nullable: true type: string + google_service_account_email: + description: Google service account email nullable: true + type: string + google_wif_pool_id: description: Google WIF pool ID - google_wif_provider_id: + nullable: true type: string + google_wif_provider_id: + description: Google WIF provider ID nullable: true title: Google wif provider - description: Google WIF provider ID - google_service_account_email: type: string - nullable: true - description: Google service account email last_sync: - type: string + description: Last sync finished time format: date-time nullable: true - description: Last sync finished time + type: string last_sync_count: - type: integer + description: Count of tasks synced last time maximum: 2147483647 minimum: 0 nullable: true - description: Count of tasks synced last time + type: integer last_sync_job: - type: string - nullable: true description: Last sync job ID maxLength: 256 - status: - $ref: '#/components/schemas/StatusC5aEnum' - traceback: - type: string nullable: true - description: Traceback report for the last failed sync + type: string meta: - nullable: true description: Meta and debug information about storage processes - title: - type: string - nullable: true - description: Cloud storage title - maxLength: 256 - description: - type: string nullable: true - description: Cloud storage description - can_delete_objects: - type: boolean + prefix: + description: GCS bucket prefix nullable: true - description: Deletion from storage enabled + type: string project: - type: integer description: A unique integer value identifying this project. - PatchedGCSWIFImportStorageRequest: - type: object - properties: + type: integer + regex_filter: + description: Cloud storage regex for filtering objects + nullable: true + type: string + status: + $ref: '#/components/schemas/StatusC5aEnum' synchronizable: - type: boolean default: true - presign: type: boolean - default: true - bucket: - type: string + title: + description: Cloud storage title + maxLength: 256 nullable: true - description: GCS bucket name - prefix: type: string + traceback: + description: Traceback report for the last failed sync nullable: true - description: GCS bucket prefix - regex_filter: type: string - nullable: true - description: Cloud storage regex for filtering objects use_blob_urls: - type: boolean description: Interpret objects as BLOBs and generate URLs - google_application_credentials: + type: boolean + type: object + PatchedGCSWIFImportStorageRequest: + properties: + bucket: + description: GCS bucket name + nullable: true type: string + description: + description: Cloud storage description nullable: true - description: The content of GOOGLE_APPLICATION_CREDENTIALS json file - google_project_id: type: string + google_application_credentials: + description: The content of GOOGLE_APPLICATION_CREDENTIALS json file nullable: true - description: Google project ID - google_project_number: type: string + google_project_id: + description: Google project ID nullable: true + type: string + google_project_number: description: Google project number - google_wif_pool_id: + nullable: true type: string + google_service_account_email: + description: Google service account email nullable: true + type: string + google_wif_pool_id: description: Google WIF pool ID - google_wif_provider_id: + nullable: true type: string + google_wif_provider_id: + description: Google WIF provider ID nullable: true title: Google wif provider - description: Google WIF provider ID - google_service_account_email: type: string - nullable: true - description: Google service account email last_sync: - type: string + description: Last sync finished time format: date-time nullable: true - description: Last sync finished time + type: string last_sync_count: - type: integer + description: Count of tasks synced last time maximum: 2147483647 minimum: 0 nullable: true - description: Count of tasks synced last time + type: integer last_sync_job: - type: string - nullable: true description: Last sync job ID maxLength: 256 - status: - $ref: '#/components/schemas/StatusC5aEnum' - traceback: - type: string nullable: true - description: Traceback report for the last failed sync + type: string meta: - nullable: true description: Meta and debug information about storage processes - title: - type: string nullable: true - description: Cloud storage title - maxLength: 256 - description: - type: string + prefix: + description: GCS bucket prefix nullable: true - description: Cloud storage description + type: string + presign: + default: true + type: boolean presign_ttl: - type: integer + description: Presigned URLs TTL (in minutes) maximum: 32767 minimum: 0 - description: Presigned URLs TTL (in minutes) - project: type: integer + project: description: A unique integer value identifying this project. - PatchedHotkeysRequest: + type: integer + regex_filter: + description: Cloud storage regex for filtering objects + nullable: true + type: string + status: + $ref: '#/components/schemas/StatusC5aEnum' + synchronizable: + default: true + type: boolean + title: + description: Cloud storage title + maxLength: 256 + nullable: true + type: string + traceback: + description: Traceback report for the last failed sync + nullable: true + type: string + use_blob_urls: + description: Interpret objects as BLOBs and generate URLs + type: boolean type: object + PatchedHotkeysRequest: properties: custom_hotkeys: - type: object additionalProperties: {} - PatchedLabelLinkRequest: + type: object type: object + PatchedLabelLinkRequest: description: |- A ModelSerializer that takes additional arguments for "fields", "omit" and "expand" in order to @@ -23721,677 +23340,660 @@ components: values with complex, nested serializations properties: from_name: - type: string - minLength: 1 - title: Tag name description: Tag name maxLength: 2048 - project: - type: integer + minLength: 1 + title: Tag name + type: string label: type: integer - PatchedLabelRequest: + project: + type: integer type: object + PatchedLabelRequest: description: |- 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: - value: - description: Label value - title: - type: string - minLength: 1 - description: Label title - maxLength: 2048 - description: - type: string - nullable: true - description: Label description approved: - type: boolean description: Status of label - created_by: + type: boolean + approved_by: + description: User who approved this label + nullable: true type: integer + created_by: description: User who made this label - approved_by: type: integer + description: + description: Label description nullable: true - description: User who approved this label + type: string organization: type: integer - PatchedLseOrganizationSerializerUpdateRequest: + title: + description: Label title + maxLength: 2048 + minLength: 1 + type: string + value: + description: Label value type: object + PatchedLseOrganizationSerializerUpdateRequest: description: |- A serializer mixin that takes an additional `fields` argument that controls which fields should be displayed. properties: - title: + contact_info: + format: email + maxLength: 254 + nullable: true type: string - writeOnly: true + created_by: nullable: true + type: integer + custom_scripts_editable_by: minLength: 1 - embed_domains: - type: array - items: - type: object - additionalProperties: - type: string - minLength: 1 - writeOnly: true nullable: true + type: string + writeOnly: true custom_scripts_enabled: + nullable: true type: boolean writeOnly: true + email_notification_settings: nullable: true - custom_scripts_editable_by: - type: string writeOnly: true + embed_domains: + items: + additionalProperties: + minLength: 1 + type: string + type: object nullable: true - minLength: 1 - embed_settings: + type: array writeOnly: true + embed_settings: nullable: true - email_notification_settings: writeOnly: true + title: + minLength: 1 nullable: true - token: type: string - nullable: true + writeOnly: true + token: maxLength: 256 - contact_info: - type: string - format: email - nullable: true - maxLength: 254 - created_by: - type: integer nullable: true - PatchedLseProjectUpdateRequest: + type: string type: object + PatchedLseProjectUpdateRequest: description: |- Serializer get numbers from project queryset annotation, make sure, that you use correct one(Project.objects.with_counts()) properties: - title: + annotation_limit_count: + minimum: 1 + nullable: true + type: integer + annotation_limit_percent: + format: decimal + nullable: true + pattern: ^-?\d{0,3}(?:\.\d{0,2})?$ type: string + annotator_evaluation_minimum_score: + default: '95.00' + format: decimal nullable: true - description: Project name. Must be between 3 and 50 characters long. - maxLength: 50 - minLength: 3 - description: + pattern: ^-?\d{0,3}(?:\.\d{0,2})?$ type: string + annotator_evaluation_minimum_tasks: + default: 10 + minimum: 0 + nullable: true + type: integer + assignment_settings: + $ref: '#/components/schemas/AssignmentSettingsRequest' + color: + maxLength: 16 nullable: true - description: Project description - label_config: type: string + comment_classification_config: + type: string + control_weights: + 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}' nullable: true - description: Label config in XML format. See more about it in documentation - expert_instruction: + created_by: + allOf: + - $ref: '#/components/schemas/UserSimpleRequest' + description: Project owner + custom_script: type: string + custom_task_lock_ttl: + description: TTL in seconds for task reservations, on new and existing tasks + maximum: 86400 + minimum: 1 nullable: true - description: Labeling instructions in HTML format - show_instruction: - type: boolean - description: Show instructions to the annotator before they start - show_skip_button: - type: boolean - description: Show a skip button in interface and allow annotators to skip - the task + type: integer + description: + description: Project description + nullable: true + type: string enable_empty_annotation: - type: boolean description: Allow annotators to submit empty annotations - show_annotation_history: type: boolean - description: Show annotation history to annotator - organization: - type: integer + evaluate_predictions_automatically: + description: Retrieve and display predictions when loading a task + type: boolean + expert_instruction: + description: Labeling instructions in HTML format nullable: true - color: type: string + is_draft: + description: Whether or not the project is in the middle of being created + type: boolean + is_published: + description: Whether or not the project is published to annotators + title: Published + type: boolean + label_config: + description: Label config in XML format. See more about it in documentation nullable: true - maxLength: 16 + type: string maximum_annotations: - type: integer + 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) 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) - is_published: - type: boolean - title: Published - description: Whether or not the project is published to annotators + type: integer + min_annotations_to_start_training: + description: Minimum number of completed tasks after which model training is started + maximum: 2147483647 + minimum: -2147483648 + type: integer model_version: + description: Machine learning model version + nullable: true type: string + organization: nullable: true - description: Machine learning model version - is_draft: - type: boolean - description: Whether or not the project is in the middle of being created - created_by: - allOf: - - $ref: '#/components/schemas/UserSimpleRequest' - description: Project owner - min_annotations_to_start_training: type: integer + overlap_cohort_percentage: maximum: 2147483647 minimum: -2147483648 - description: Minimum number of completed tasks after which model training - is started - show_collab_predictions: + type: integer + pause_on_failed_annotator_evaluation: + default: false + nullable: true type: boolean - title: Show predictions to annotator - description: If set, the annotator can view model predictions + pinned_at: + description: Pinned date and time + format: date-time + nullable: true + type: string + require_comment_on_skip: + default: false + type: boolean + reveal_preannotations_interactively: + description: Reveal pre-annotations interactively + type: boolean + review_settings: + $ref: '#/components/schemas/ReviewSettingsRequest' sampling: nullable: true oneOf: - - $ref: '#/components/schemas/SamplingEnum' - - $ref: '#/components/schemas/NullEnum' + - $ref: '#/components/schemas/SamplingEnum' + - $ref: '#/components/schemas/NullEnum' + show_annotation_history: + description: Show annotation history to annotator + type: boolean + show_collab_predictions: + description: If set, the annotator can view model predictions + title: Show predictions to annotator + type: boolean show_ground_truth_first: type: boolean + show_instruction: + description: Show instructions to the annotator before they start + type: boolean show_overlap_first: type: boolean - overlap_cohort_percentage: - type: integer - maximum: 2147483647 - minimum: -2147483648 - task_data_login: - type: string + show_skip_button: + description: Show a skip button in interface and allow annotators to skip the task + type: boolean + skip_queue: nullable: true + oneOf: + - $ref: '#/components/schemas/SkipQueueEnum' + - $ref: '#/components/schemas/NullEnum' + task_data_login: description: 'Task data credentials: login' maxLength: 256 - task_data_password: - type: string nullable: true + type: string + task_data_password: description: 'Task data credentials: password' maxLength: 256 - 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}' - evaluate_predictions_automatically: - type: boolean - description: Retrieve and display predictions when loading a task - skip_queue: nullable: true - oneOf: - - $ref: '#/components/schemas/SkipQueueEnum' - - $ref: '#/components/schemas/NullEnum' - reveal_preannotations_interactively: - type: boolean - description: Reveal pre-annotations interactively - pinned_at: type: string - format: date-time + title: + description: Project name. Must be between 3 and 50 characters long. + maxLength: 50 + minLength: 3 nullable: true - description: Pinned date and time + type: string workspace: type: integer - review_settings: - $ref: '#/components/schemas/ReviewSettingsRequest' - assignment_settings: - $ref: '#/components/schemas/AssignmentSettingsRequest' - custom_script: + type: object + PatchedLseS3ExportStorageRequest: + properties: + aws_access_key_id: + description: AWS_ACCESS_KEY_ID + nullable: true type: string - comment_classification_config: + aws_secret_access_key: + description: AWS_SECRET_ACCESS_KEY + nullable: true type: string - require_comment_on_skip: - type: boolean - default: false - custom_task_lock_ttl: - type: integer - maximum: 86400 - minimum: 1 + aws_session_token: + description: AWS_SESSION_TOKEN nullable: true - description: TTL in seconds for task reservations, on new and existing tasks - annotation_limit_count: - type: integer - minimum: 1 + type: string + aws_sse_kms_key_id: + description: AWS SSE KMS Key ID nullable: true - annotation_limit_percent: type: string - format: decimal - pattern: ^-?\d{0,3}(?:\.\d{0,2})?$ + bucket: + description: S3 bucket name + nullable: true + type: string + can_delete_objects: + description: Deletion from storage enabled nullable: true - pause_on_failed_annotator_evaluation: type: boolean + description: + description: Cloud storage description nullable: true - default: false - annotator_evaluation_minimum_score: type: string - format: decimal - pattern: ^-?\d{0,3}(?:\.\d{0,2})?$ - nullable: true - default: '95.00' - annotator_evaluation_minimum_tasks: - type: integer - minimum: 0 + external_id: + description: AWS ExternalId nullable: true - default: 10 - PatchedLseS3ExportStorageRequest: - type: object - properties: - synchronizable: - type: boolean - default: true - last_sync: + title: ExternalID type: string + last_sync: + description: Last sync finished time format: date-time nullable: true - description: Last sync finished time + type: string last_sync_count: - type: integer + description: Count of tasks synced last time maximum: 2147483647 minimum: 0 nullable: true - description: Count of tasks synced last time + type: integer last_sync_job: - type: string - nullable: true description: Last sync job ID maxLength: 256 - status: - $ref: '#/components/schemas/StatusC5aEnum' - traceback: + nullable: true type: string + legacy_auth: nullable: true - description: Traceback report for the last failed sync + type: boolean meta: - nullable: true description: Meta and debug information about storage processes - title: - type: string nullable: true - description: Cloud storage title - maxLength: 256 - description: + prefix: + description: S3 bucket prefix + nullable: true type: string + project: + description: A unique integer value identifying this project. + type: integer + regex_filter: + description: Cloud storage regex for filtering objects nullable: true - description: Cloud storage description - can_delete_objects: - type: boolean + type: string + region_name: + description: AWS Region nullable: true - description: Deletion from storage enabled - bucket: type: string + role_arn: + description: AWS RoleArn + minLength: 1 + type: string + s3_endpoint: + description: S3 Endpoint nullable: true - description: S3 bucket name - prefix: type: string + status: + $ref: '#/components/schemas/StatusC5aEnum' + synchronizable: + default: true + type: boolean + title: + description: Cloud storage title + maxLength: 256 nullable: true - description: S3 bucket prefix - regex_filter: type: string + traceback: + description: Traceback report for the last failed sync nullable: true - description: Cloud storage regex for filtering objects + type: string use_blob_urls: - type: boolean description: Interpret objects as BLOBs and generate URLs + type: boolean + type: object + PatchedLseS3ImportStorageRequest: + properties: aws_access_key_id: - type: string - nullable: true description: AWS_ACCESS_KEY_ID - aws_secret_access_key: - type: string nullable: true - description: AWS_SECRET_ACCESS_KEY - aws_session_token: type: string + aws_secret_access_key: + description: AWS_SECRET_ACCESS_KEY nullable: true - description: AWS_SESSION_TOKEN - aws_sse_kms_key_id: type: string + aws_session_token: + description: AWS_SESSION_TOKEN nullable: true + type: string + aws_sse_kms_key_id: description: AWS SSE KMS Key ID - region_name: + nullable: true type: string + bucket: + description: S3 bucket name nullable: true - description: AWS Region - s3_endpoint: type: string + description: + description: Cloud storage description nullable: true - description: S3 Endpoint - external_id: type: string + external_id: + description: AWS ExternalId nullable: true title: ExternalID - description: AWS ExternalId - role_arn: type: string - minLength: 1 - description: AWS RoleArn - legacy_auth: - type: boolean - nullable: true - project: - type: integer - description: A unique integer value identifying this project. - PatchedLseS3ImportStorageRequest: - type: object - properties: - synchronizable: - type: boolean - default: true - presign: - type: boolean - default: true last_sync: - type: string + description: Last sync finished time format: date-time nullable: true - description: Last sync finished time + type: string last_sync_count: - type: integer + description: Count of tasks synced last time maximum: 2147483647 minimum: 0 nullable: true - description: Count of tasks synced last time + type: integer last_sync_job: - type: string - nullable: true description: Last sync job ID maxLength: 256 - status: - $ref: '#/components/schemas/StatusC5aEnum' - traceback: + nullable: true type: string + legacy_auth: nullable: true - description: Traceback report for the last failed sync + type: boolean meta: - nullable: true description: Meta and debug information about storage processes - title: - type: string - nullable: true - description: Cloud storage title - maxLength: 256 - description: - type: string - nullable: true - description: Cloud storage description - bucket: - type: string nullable: true - description: S3 bucket name prefix: - type: string - nullable: true description: S3 bucket prefix - regex_filter: - type: string - nullable: true - description: Cloud storage regex for filtering objects - use_blob_urls: - type: boolean - description: Interpret objects as BLOBs and generate URLs - aws_access_key_id: - type: string nullable: true - description: AWS_ACCESS_KEY_ID - aws_secret_access_key: type: string + presign: + default: true + type: boolean + presign_ttl: + description: Presigned URLs TTL (in minutes) + maximum: 32767 + minimum: 0 + type: integer + project: + description: A unique integer value identifying this project. + type: integer + recursive_scan: + description: Perform recursive scan over the bucket content + type: boolean + regex_filter: + description: Cloud storage regex for filtering objects nullable: true - description: AWS_SECRET_ACCESS_KEY - aws_session_token: type: string + region_name: + description: AWS Region nullable: true - description: AWS_SESSION_TOKEN - aws_sse_kms_key_id: type: string - nullable: true - description: AWS SSE KMS Key ID - region_name: + role_arn: + description: AWS RoleArn + minLength: 1 type: string - nullable: true - description: AWS Region s3_endpoint: - type: string - nullable: true description: S3 Endpoint - external_id: - type: string nullable: true - title: ExternalID - description: AWS ExternalId - role_arn: type: string - minLength: 1 - description: AWS RoleArn - legacy_auth: + status: + $ref: '#/components/schemas/StatusC5aEnum' + synchronizable: + default: true type: boolean + title: + description: Cloud storage title + maxLength: 256 nullable: true - presign_ttl: - type: integer - maximum: 32767 - minimum: 0 - description: Presigned URLs TTL (in minutes) - recursive_scan: + type: string + traceback: + description: Traceback report for the last failed sync + nullable: true + type: string + use_blob_urls: + description: Interpret objects as BLOBs and generate URLs type: boolean - description: Perform recursive scan over the bucket content - project: - type: integer - description: A unique integer value identifying this project. - PatchedLseTaskRequest: type: object + PatchedLseTaskRequest: description: Task Serializer with project scheme configs validation properties: - inner_id: - type: integer + avg_lead_time: + format: double + type: number cancelled_annotations: type: integer - total_annotations: - type: integer - total_predictions: + comment_count: + description: Number of comments in the task including all annotations + maximum: 2147483647 + minimum: -2147483648 type: integer completed_at: + format: date-time type: string + data: + description: User imported or uploaded data for a task. Data is formatted according to the project label config. You can find examples of data for your project on the Import page in the Label Studio Data Manager UI. + draft_exists: + type: boolean + ground_truth: + type: boolean + inner_id: + type: integer + is_labeled: + description: True if the number of annotations for this task is greater than or equal to the number of maximum_completions for the project + type: boolean + last_comment_updated_at: + description: When the last comment was updated format: date-time + nullable: true + type: string + meta: + description: Meta is user imported (uploaded) data and can be useful as input for an ML Backend for embeddings, advanced vectors, and other info. It is passed to ML during training/predicting steps. + nullable: true + overlap: + description: Number of distinct annotators that processed the current task + maximum: 2147483647 + minimum: -2147483648 + type: integer predictions_score: - type: number format: double - avg_lead_time: type: number - format: double - draft_exists: - type: boolean + project: + description: Project ID for this task + nullable: true + type: integer reviewed: type: boolean reviews_accepted: type: integer reviews_rejected: type: integer - ground_truth: - type: boolean - data: - description: User imported or uploaded data for a task. Data is formatted - according to the project label config. You can find examples of data for - your project on the Import page in the Label Studio Data Manager UI. - meta: - nullable: true - description: Meta is user imported (uploaded) data and can be useful as - input for an ML Backend for embeddings, advanced vectors, and other info. - It is passed to ML during training/predicting steps. - is_labeled: - type: boolean - description: True if the number of annotations for this task is greater - than or equal to the number of maximum_completions for the project - overlap: + total_annotations: type: integer - maximum: 2147483647 - minimum: -2147483648 - description: Number of distinct annotators that processed the current task - comment_count: + total_predictions: type: integer - maximum: 2147483647 - minimum: -2147483648 - description: Number of comments in the task including all annotations unresolved_comment_count: - type: integer + description: Number of unresolved comments in the task including all annotations maximum: 2147483647 minimum: -2147483648 - description: Number of unresolved comments in the task including all annotations - last_comment_updated_at: - type: string - format: date-time - nullable: true - description: When the last comment was updated - project: type: integer - nullable: true - description: Project ID for this task - PatchedLseUserSerializerUpdateRequest: type: object + PatchedLseUserSerializerUpdateRequest: description: |- 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: - first_name: - type: string - maxLength: 256 - last_name: - type: string - maxLength: 256 - username: - type: string - minLength: 1 - maxLength: 256 - custom_hotkeys: - nullable: true - description: Custom keyboard shortcuts configuration for the user interface - phone: - type: string - maxLength: 256 active_organization: - type: integer nullable: true + type: integer allow_newsletters: + description: Allow sending newsletters to user + nullable: true type: boolean + custom_hotkeys: + description: Custom keyboard shortcuts configuration for the user interface nullable: true - description: Allow sending newsletters to user date_joined: - type: string format: date-time - password: type: string + email_notification_settings: writeOnly: true - minLength: 1 - onboarding_state: + first_name: + maxLength: 256 type: string - writeOnly: true - nullable: true - minLength: 1 is_email_verified: + nullable: true type: boolean writeOnly: true + last_name: + maxLength: 256 + type: string + onboarding_state: + minLength: 1 nullable: true - email_notification_settings: + type: string writeOnly: true - PatchedModelInterfaceRequest: + password: + minLength: 1 + type: string + writeOnly: true + phone: + maxLength: 256 + type: string + username: + maxLength: 256 + minLength: 1 + type: string type: object + PatchedModelInterfaceRequest: properties: + associated_projects: + items: + type: integer + type: array created_by: allOf: - - $ref: '#/components/schemas/UserSimpleRequest' + - $ref: '#/components/schemas/UserSimpleRequest' description: User who created Dataset + description: + description: Model description + nullable: true + type: string + input_fields: {} + organization: + nullable: true + type: integer + output_classes: {} skill_name: allOf: - - $ref: '#/components/schemas/SkillNameEnum' + - $ref: '#/components/schemas/SkillNameEnum' default: TextClassification title: - type: string - minLength: 1 description: Model name maxLength: 500 - description: + minLength: 1 type: string - nullable: true - description: Model description - input_fields: {} - output_classes: {} - organization: - type: integer - nullable: true - associated_projects: - type: array - items: - type: integer - PatchedModelProviderConnectionRequest: type: object + PatchedModelProviderConnectionRequest: properties: - provider: - $ref: '#/components/schemas/ProviderEnum' api_key: + description: Model provider API key + nullable: true type: string writeOnly: true - nullable: true - description: Model provider API key auth_token: + description: Model provider Auth token + nullable: true type: string writeOnly: true + budget_alert_threshold: + description: Budget alert threshold for the given provider connection + format: double nullable: true - description: Model provider Auth token - deployment_name: - type: string + type: number + cached_available_models: + description: List of available models from the provider + maxLength: 4096 nullable: true + type: string + deployment_name: description: Azure OpenAI deployment name maxLength: 512 - endpoint: - type: string nullable: true + type: string + endpoint: description: Azure OpenAI endpoint maxLength: 512 + nullable: true + type: string google_application_credentials: + description: The content of GOOGLE_APPLICATION_CREDENTIALS json file + nullable: true type: string writeOnly: true + google_location: + description: Google project location + maxLength: 255 nullable: true - description: The content of GOOGLE_APPLICATION_CREDENTIALS json file - google_project_id: type: string - nullable: true + google_project_id: description: Google project ID maxLength: 255 - google_location: - type: string nullable: true - description: Google project location - maxLength: 255 - cached_available_models: type: string + is_internal: + description: Whether the model provider connection is internal, not visible to the user nullable: true - description: List of available models from the provider - maxLength: 4096 + type: boolean + provider: + $ref: '#/components/schemas/ProviderEnum' scope: $ref: '#/components/schemas/ScopeEnum' - is_internal: - type: boolean - nullable: true - description: Whether the model provider connection is internal, not visible - to the user - budget_alert_threshold: - type: number - format: double - nullable: true - description: Budget alert threshold for the given provider connection - PatchedOrganizationMemberCreateUpdateRequest: type: object + PatchedOrganizationMemberCreateUpdateRequest: properties: - user_id: - type: integer role: $ref: '#/components/schemas/Role9e7Enum' - PatchedPauseRequest: + user_id: + type: integer type: object + PatchedPauseRequest: description: |- A ModelSerializer that takes additional arguments for "fields", "omit" and "expand" in order to @@ -24400,7 +24002,7 @@ components: properties: reason: allOf: - - $ref: '#/components/schemas/ReasonEnum' + - $ref: '#/components/schemas/ReasonEnum' description: |- Reason for pausing @@ -24410,194 +24012,193 @@ components: * `ANNOTATION_LIMIT` - Annotation limit * `CUSTOM_SCRIPT` - Custom script verbose_reason: - type: string + description: Detailed description of why the project is paused, will be readable by paused annotators nullable: true - description: Detailed description of why the project is paused, will be - readable by paused annotators - PatchedProjectTemplateRequest: + type: string type: object + PatchedProjectTemplateRequest: properties: - name: + assignment_settings: + description: general dict serialized assignment settings + created_by: + nullable: true + type: integer + custom_script: + description: custom script for projects created from this template + minLength: 1 + nullable: true type: string + description: minLength: 1 + nullable: true + type: string + name: maxLength: 1000 - description: + minLength: 1 type: string + organization: nullable: true - minLength: 1 - tags: {} + type: integer project_settings: description: general dict serialized project settings - review_settings: - description: general dict serialized review settings - assignment_settings: - description: general dict serialized assignment settings require_comment_on_skip: - type: boolean description: flag to require comment on skip - custom_script: - type: string - nullable: true - minLength: 1 - description: custom script for projects created from this template - created_by: - type: integer - nullable: true - organization: - type: integer - nullable: true - PatchedS3DatasetStorageRequest: + type: boolean + review_settings: + description: general dict serialized review settings + tags: {} type: object + PatchedS3DatasetStorageRequest: properties: - synchronizable: - type: boolean - default: true - presign: - type: boolean - default: true - last_sync: - type: string - format: date-time - nullable: true - description: Last sync finished time - last_sync_count: - type: integer - maximum: 2147483647 - minimum: 0 + aws_access_key_id: + description: AWS_ACCESS_KEY_ID nullable: true - description: Count of tasks synced last time - last_sync_job: type: string + aws_secret_access_key: + description: AWS_SECRET_ACCESS_KEY nullable: true - description: Last sync job ID - maxLength: 256 - status: - $ref: '#/components/schemas/StatusC5aEnum' - traceback: type: string + aws_session_token: + description: AWS_SESSION_TOKEN nullable: true - description: Traceback report for the last failed sync - meta: - nullable: true - description: Meta and debug information about storage processes - title: type: string + aws_sse_kms_key_id: + description: AWS SSE KMS Key ID nullable: true - description: Cloud storage title - maxLength: 256 - description: type: string - nullable: true - description: Cloud storage description bucket: - type: string - nullable: true description: S3 bucket name - prefix: - type: string nullable: true - description: S3 bucket prefix - regex_filter: type: string + dataset: + description: A unique integer value identifying this dataset. + type: integer + description: + description: Cloud storage description nullable: true - description: Cloud storage regex for filtering objects - use_blob_urls: - type: boolean - description: Interpret objects as BLOBs and generate URLs - aws_access_key_id: type: string + glob_pattern: + description: Glob pattern for syncing from bucket nullable: true - description: AWS_ACCESS_KEY_ID - aws_secret_access_key: type: string + last_sync: + description: Last sync finished time + format: date-time nullable: true - description: AWS_SECRET_ACCESS_KEY - aws_session_token: type: string + last_sync_count: + description: Count of tasks synced last time + maximum: 2147483647 + minimum: 0 nullable: true - description: AWS_SESSION_TOKEN - aws_sse_kms_key_id: - type: string + type: integer + last_sync_job: + description: Last sync job ID + maxLength: 256 nullable: true - description: AWS SSE KMS Key ID - region_name: type: string + meta: + description: Meta and debug information about storage processes nullable: true - description: AWS Region - s3_endpoint: - type: string + prefix: + description: S3 bucket prefix nullable: true - description: S3 Endpoint + type: string + presign: + default: true + type: boolean presign_ttl: - type: integer + description: Presigned URLs TTL (in minutes) maximum: 32767 minimum: 0 - description: Presigned URLs TTL (in minutes) + type: integer recursive_scan: + description: Perform recursive scan over the bucket content + type: boolean + regex_filter: + description: Cloud storage regex for filtering objects + nullable: true + type: string + region_name: + description: AWS Region + nullable: true + type: string + s3_endpoint: + description: S3 Endpoint + nullable: true + type: string + status: + $ref: '#/components/schemas/StatusC5aEnum' + synced: + description: Flag if dataset has been previously synced or not type: boolean - description: Perform recursive scan over the bucket content - glob_pattern: + synchronizable: + default: true + type: boolean + title: + description: Cloud storage title + maxLength: 256 + nullable: true type: string + traceback: + description: Traceback report for the last failed sync nullable: true - description: Glob pattern for syncing from bucket - synced: + type: string + use_blob_urls: + description: Interpret objects as BLOBs and generate URLs type: boolean - description: Flag if dataset has been previously synced or not - dataset: - type: integer - description: A unique integer value identifying this dataset. - PatchedSessionTimeoutPolicyRequest: type: object + PatchedSessionTimeoutPolicyRequest: properties: max_session_age: - type: integer + description: Number of minutes that a session can be active before needing to re-login maximum: 2147483647 minimum: 1 title: Max session age (minutes) - description: Number of minutes that a session can be active before needing - to re-login - max_time_between_activity: type: integer + max_time_between_activity: + description: Number of minutes that a session stays active without any activity maximum: 2147483647 minimum: 1 title: Max time (minutes) between activity - description: Number of minutes that a session stays active without any activity - PatchedTaskAssignmentRequest: + type: integer type: object + PatchedTaskAssignmentRequest: properties: + assignee: + description: Assigned user + type: integer + task: + description: Assigned task + type: integer type: allOf: - - $ref: '#/components/schemas/TypeEnum' - title: Assignment type + - $ref: '#/components/schemas/TypeEnum' description: |- Type of assignment: Annotate|Review * `AN` - Annotate * `RE` - Review - assignee: - type: integer - description: Assigned user - task: - type: integer - description: Assigned task - PatchedThirdPartyModelVersionRequest: + title: Assignment type type: object + PatchedThirdPartyModelVersionRequest: properties: - parent_model: + model_provider_connection: + nullable: true + type: integer + organization: + nullable: true type: integer + parent_model: description: Parent model interface ID - title: - type: string - minLength: 1 - description: Model name - maxLength: 500 + type: integer prompt: - type: string - minLength: 1 description: Prompt to execute + minLength: 1 + type: string provider: allOf: - - $ref: '#/components/schemas/ProviderEnum' + - $ref: '#/components/schemas/ProviderEnum' description: |- The model provider to use e.g. OpenAI @@ -24609,107 +24210,117 @@ components: * `Anthropic` - Anthropic * `Custom` - Custom provider_model_id: - type: string - minLength: 1 description: The model ID to use within the given provider, e.g. gpt-3.5 maxLength: 255 - model_provider_connection: - type: integer - nullable: true - organization: - type: integer - nullable: true - PatchedWebhookSerializerForUpdateRequest: + minLength: 1 + type: string + title: + description: Model name + maxLength: 500 + minLength: 1 + type: string type: object + PatchedWebhookSerializerForUpdateRequest: description: |- Serializer class for updating webhooks Used to forbid updating project field. properties: - url: - type: string - format: uri - minLength: 1 - title: URL of webhook - description: URL of webhook - maxLength: 2048 - send_payload: - type: boolean - title: Does webhook send the payload - description: If value is False send only action - send_for_all_actions: - type: boolean - title: Use webhook for all actions - description: If value is False - used only for actions from WebhookAction + actions: + default: [] + items: + $ref: '#/components/schemas/ActionsEnum' + type: array headers: - title: Request extra headers of webhook description: Key Value Json of headers + title: Request extra headers of webhook is_active: - type: boolean - title: Is webhook active description: If value is False the webhook is disabled - actions: - type: array - items: - $ref: '#/components/schemas/ActionsEnum' - default: [] - PatchedWorkspaceRequest: + title: Is webhook active + type: boolean + send_for_all_actions: + description: If value is False - used only for actions from WebhookAction + title: Use webhook for all actions + type: boolean + send_payload: + description: If value is False send only action + title: Does webhook send the payload + type: boolean + url: + description: URL of webhook + format: uri + maxLength: 2048 + minLength: 1 + title: URL of webhook + type: string type: object + PatchedWorkspaceRequest: description: |- 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: - title: + color: + maxLength: 16 + nullable: true type: string - minLength: 1 - description: Workspace name - maxLength: 1000 description: - type: string - nullable: true description: Workspace description - color: - type: string nullable: true - maxLength: 16 - is_personal: + type: string + is_archived: + description: Workspace is archived + title: Archived type: boolean - title: Personal + is_personal: description: Workspace is a personal user workspace - is_archived: + title: Personal type: boolean - title: Archived - description: Workspace is archived - Pause: + title: + description: Workspace name + maxLength: 1000 + minLength: 1 + type: string type: object + Pause: description: |- 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: - type: integer + created_at: + description: Timestamp when this pause record was created + format: date-time readOnly: true - project: - type: integer + type: string + deleted_at: + description: Timestamp when this pause record was soft-deleted + format: date-time + nullable: true readOnly: true + type: string + deleted_by: + description: User who soft-deleted this pause record nullable: true - description: Related project for which the pause is set - user: + readOnly: true type: integer + id: readOnly: true - nullable: true - description: User who is paused + type: integer paused_by: allOf: - - $ref: '#/components/schemas/UserSimple' + - $ref: '#/components/schemas/UserSimple' + readOnly: true + project: + description: Related project for which the pause is set + nullable: true readOnly: true + type: integer reason: allOf: - - $ref: '#/components/schemas/ReasonEnum' + - $ref: '#/components/schemas/ReasonEnum' description: |- Reason for pausing @@ -24718,732 +24329,690 @@ components: * `ANNOTATOR_EVALUATION` - Annotator evaluation * `ANNOTATION_LIMIT` - Annotation limit * `CUSTOM_SCRIPT` - Custom script - verbose_reason: - type: string - nullable: true - description: Detailed description of why the project is paused, will be - readable by paused annotators - deleted_by: - type: integer - readOnly: true - nullable: true - description: User who soft-deleted this pause record - deleted_at: - type: string + updated_at: + description: Timestamp when this pause record was last updated format: date-time readOnly: true - nullable: true - description: Timestamp when this pause record was soft-deleted - created_at: type: string - format: date-time + user: + description: User who is paused + nullable: true readOnly: true - description: Timestamp when this pause record was created - updated_at: + type: integer + verbose_reason: + description: Detailed description of why the project is paused, will be readable by paused annotators + nullable: true type: string - format: date-time - readOnly: true - description: Timestamp when this pause record was last updated required: - - created_at - - deleted_at - - deleted_by - - id - - paused_by - - project - - reason - - updated_at - - user - PauseRequest: + - created_at + - deleted_at + - deleted_by + - id + - paused_by + - project + - reason + - updated_at + - user type: object + PauseRequest: description: |- 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: - reason: - allOf: - - $ref: '#/components/schemas/ReasonEnum' - description: |- - Reason for pausing - - * `MANUAL` - Manual - * `BEHAVIOR_BASED` - Behavior-based - * `ANNOTATOR_EVALUATION` - Annotator evaluation - * `ANNOTATION_LIMIT` - Annotation limit - * `CUSTOM_SCRIPT` - Custom script - verbose_reason: - type: string - nullable: true - description: Detailed description of why the project is paused, will be - readable by paused annotators - required: - - reason - Prediction: - type: object - properties: - id: - type: integer - readOnly: true - result: - type: array - title: Prediction result list - description: List of prediction results for the task - items: - type: object - title: Prediction result items (regions) - description: List of predicted regions for the task - model_version: - type: string - description: 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: - type: string - readOnly: true - default: '' - description: Delta time from creation time - score: - type: number - format: double + values with complex, nested serializations + properties: + reason: + allOf: + - $ref: '#/components/schemas/ReasonEnum' + description: |- + Reason for pausing + + * `MANUAL` - Manual + * `BEHAVIOR_BASED` - Behavior-based + * `ANNOTATOR_EVALUATION` - Annotator evaluation + * `ANNOTATION_LIMIT` - Annotation limit + * `CUSTOM_SCRIPT` - Custom script + verbose_reason: + description: Detailed description of why the project is paused, will be readable by paused annotators nullable: true - description: Prediction score + type: string + required: + - reason + type: object + Prediction: + properties: cluster: - type: integer + description: Cluster for the current prediction maximum: 2147483647 minimum: -2147483648 nullable: true - description: Cluster for the current prediction - neighbors: - nullable: true - description: Array of task IDs of the closest neighbors - mislabeling: - type: number - format: double - description: Related task mislabeling score - created_at: + type: integer + created_ago: + default: '' + description: Delta time from creation time + readOnly: true type: string + created_at: format: date-time readOnly: true - updated_at: type: string - format: date-time + id: readOnly: true - model: type: integer - nullable: true + mislabeling: + description: Related task mislabeling score + format: double + type: number + model: description: An ML Backend instance that created the prediction. - model_run: - type: integer nullable: true + type: integer + model_run: description: A run of a ModelVersion that created the prediction. - task: + nullable: true type: integer + model_version: + description: 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 + type: string + neighbors: + description: Array of task IDs of the closest neighbors + nullable: true project: - type: integer nullable: true - required: - - created_ago - - created_at - - id - - result - - task - - updated_at - PredictionRequest: - type: object - properties: + type: integer result: - type: array - title: Prediction result list description: List of prediction results for the task items: - type: object - title: Prediction result items (regions) description: List of predicted regions for the task - model_version: - type: string - description: 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 + title: Prediction result items (regions) + type: object + title: Prediction result list + type: array score: - type: number + description: Prediction score format: double nullable: true - description: Prediction score - cluster: + type: number + task: type: integer + updated_at: + format: date-time + readOnly: true + type: string + required: + - created_ago + - created_at + - id + - result + - task + - updated_at + type: object + PredictionRequest: + properties: + cluster: + description: Cluster for the current prediction maximum: 2147483647 minimum: -2147483648 nullable: true - description: Cluster for the current prediction - neighbors: - nullable: true - description: Array of task IDs of the closest neighbors + type: integer mislabeling: - type: number - format: double description: Related task mislabeling score + format: double + type: number model: - type: integer - nullable: true description: An ML Backend instance that created the prediction. - model_run: - type: integer nullable: true + type: integer + model_run: description: A run of a ModelVersion that created the prediction. - task: + nullable: true type: integer + model_version: + description: 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 + type: string + neighbors: + description: Array of task IDs of the closest neighbors + nullable: true project: + nullable: true type: integer + result: + description: List of prediction results for the task + items: + description: List of predicted regions for the task + title: Prediction result items (regions) + type: object + title: Prediction result list + type: array + score: + description: Prediction score + format: double nullable: true + type: number + task: + type: integer required: - - result - - task - Project: + - result + - task type: object + Project: description: |- Serializer get numbers from project queryset annotation, make sure, that you use correct one(Project.objects.with_counts()) properties: - id: - type: integer - readOnly: true - title: - type: string + color: + maxLength: 16 nullable: true - description: Project name. Must be between 3 and 50 characters long. - maxLength: 50 - minLength: 3 - description: type: string + config_has_control_tags: + description: Flag to detect is project ready for labeling + readOnly: true + type: boolean + config_suitable_for_bulk_annotation: + description: Flag to detect is project ready for bulk annotation + readOnly: true + type: boolean + control_weights: + 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}' nullable: true - description: Project description - label_config: + created_at: + format: date-time + readOnly: true type: string + created_by: + allOf: + - $ref: '#/components/schemas/UserSimple' + description: Project owner + description: + description: Project description nullable: true - description: Label config in XML format. See more about it in documentation - expert_instruction: type: string - nullable: true - description: Labeling instructions in HTML format - show_instruction: - type: boolean - description: Show instructions to the annotator before they start - show_skip_button: - type: boolean - description: Show a skip button in interface and allow annotators to skip - the task enable_empty_annotation: - type: boolean description: Allow annotators to submit empty annotations - show_annotation_history: type: boolean - description: Show annotation history to annotator - organization: - type: integer + evaluate_predictions_automatically: + description: Retrieve and display predictions when loading a task + type: boolean + expert_instruction: + description: Labeling instructions in HTML format nullable: true - color: type: string - nullable: true - maxLength: 16 - maximum_annotations: + finished_task_number: + description: Finished tasks + readOnly: true 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) - is_published: + ground_truth_number: + description: Honeypot annotation number in project + readOnly: true + type: integer + id: + readOnly: true + type: integer + is_draft: + description: Whether or not the project is in the middle of being created type: boolean - title: Published + is_published: description: Whether or not the project is published to annotators - model_version: - type: string - nullable: true - description: Machine learning model version - is_draft: + title: Published type: boolean - description: Whether or not the project is in the middle of being created - created_by: - allOf: - - $ref: '#/components/schemas/UserSimple' - description: Project owner - created_at: + label_config: + description: Label config in XML format. See more about it in documentation + nullable: true type: string - format: date-time - readOnly: true - min_annotations_to_start_training: + maximum_annotations: + 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) + maximum: 2147483647 + minimum: -2147483648 + title: Maximum annotation number type: integer + min_annotations_to_start_training: + description: Minimum number of completed tasks after which model training is started maximum: 2147483647 minimum: -2147483648 - description: Minimum number of completed tasks after which model training - is started - start_training_on_annotation_update: - type: boolean - readOnly: true - description: Start model training after any annotations are submitted or - updated - show_collab_predictions: - type: boolean - title: Show predictions to annotator - description: If set, the annotator can view model predictions - num_tasks_with_annotations: type: integer - readOnly: true + model_version: + description: Machine learning model version + nullable: true + type: string + num_tasks_with_annotations: description: Tasks with annotations count - task_number: - type: integer readOnly: true - description: Total task number in project - useful_annotation_number: type: integer - readOnly: true - description: 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: + organization: + nullable: true type: integer - readOnly: true - description: Honeypot annotation number in project - skipped_annotations_number: + overlap_cohort_percentage: + maximum: 2147483647 + minimum: -2147483648 type: integer + parsed_label_config: + description: JSON-formatted labeling configuration + readOnly: true + pinned_at: + description: Pinned date and time + format: date-time + nullable: true + type: string + queue_done: readOnly: true - description: Skipped by collaborators annotation number in project - total_annotations_number: type: integer + queue_total: readOnly: true - description: Total annotations number in project including skipped_annotations_number - and ground_truth_number. - total_predictions_number: type: integer - readOnly: true - description: Total predictions number in project including skipped_annotations_number, - ground_truth_number, and useful_annotation_number. + reveal_preannotations_interactively: + description: Reveal pre-annotations interactively + type: boolean sampling: nullable: true oneOf: - - $ref: '#/components/schemas/SamplingEnum' - - $ref: '#/components/schemas/NullEnum' + - $ref: '#/components/schemas/SamplingEnum' + - $ref: '#/components/schemas/NullEnum' + show_annotation_history: + description: Show annotation history to annotator + type: boolean + show_collab_predictions: + description: If set, the annotator can view model predictions + title: Show predictions to annotator + type: boolean show_ground_truth_first: type: boolean + show_instruction: + description: Show instructions to the annotator before they start + type: boolean show_overlap_first: type: boolean - overlap_cohort_percentage: + show_skip_button: + description: Show a skip button in interface and allow annotators to skip the task + type: boolean + skip_queue: + nullable: true + oneOf: + - $ref: '#/components/schemas/SkipQueueEnum' + - $ref: '#/components/schemas/NullEnum' + skipped_annotations_number: + description: Skipped by collaborators annotation number in project + readOnly: true type: integer - maximum: 2147483647 - minimum: -2147483648 + start_training_on_annotation_update: + description: Start model training after any annotations are submitted or updated + readOnly: true + type: boolean task_data_login: - type: string - nullable: true description: 'Task data credentials: login' maxLength: 256 - task_data_password: - type: string nullable: true + type: string + task_data_password: description: 'Task data credentials: password' maxLength: 256 - 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}' - parsed_label_config: - readOnly: true - description: JSON-formatted labeling configuration - evaluate_predictions_automatically: - type: boolean - description: Retrieve and display predictions when loading a task - config_has_control_tags: - type: boolean + type: string + task_number: + description: Total task number in project readOnly: true - description: Flag to detect is project ready for labeling - skip_queue: + type: integer + title: + description: Project name. Must be between 3 and 50 characters long. + maxLength: 50 + minLength: 3 nullable: true - oneOf: - - $ref: '#/components/schemas/SkipQueueEnum' - - $ref: '#/components/schemas/NullEnum' - reveal_preannotations_interactively: - type: boolean - description: Reveal pre-annotations interactively - pinned_at: type: string - format: date-time - nullable: true - description: Pinned date and time - finished_task_number: - type: integer + total_annotations_number: + description: Total annotations number in project including skipped_annotations_number and ground_truth_number. readOnly: true - description: Finished tasks - queue_total: type: integer + total_predictions_number: + description: Total predictions number in project including skipped_annotations_number, ground_truth_number, and useful_annotation_number. readOnly: true - queue_done: type: integer + useful_annotation_number: + description: Useful annotation number in project not including skipped_annotations_number and ground_truth_number. Total annotations = annotation_number + skipped_annotations_number + ground_truth_number readOnly: true - config_suitable_for_bulk_annotation: - type: boolean - readOnly: true - description: Flag to detect is project ready for bulk annotation + type: integer required: - - config_has_control_tags - - config_suitable_for_bulk_annotation - - created_at - - finished_task_number - - ground_truth_number - - id - - num_tasks_with_annotations - - parsed_label_config - - queue_done - - queue_total - - skipped_annotations_number - - start_training_on_annotation_update - - task_number - - total_annotations_number - - total_predictions_number - - useful_annotation_number - ProjectDuplicateRequest: + - config_has_control_tags + - config_suitable_for_bulk_annotation + - created_at + - finished_task_number + - ground_truth_number + - id + - num_tasks_with_annotations + - parsed_label_config + - queue_done + - queue_total + - skipped_annotations_number + - start_training_on_annotation_update + - task_number + - total_annotations_number + - total_predictions_number + - useful_annotation_number type: object + ProjectDuplicateRequest: properties: + description: + default: '' + description: Description of duplicated project + type: string mode: allOf: - - $ref: '#/components/schemas/ModeEnum' + - $ref: '#/components/schemas/ModeEnum' description: |- Data that you want to duplicate: settings only, with tasks, with annotations * `settings` - Only settings * `settings,data` - Settings and tasks - workspace: - type: integer - description: Workspace, where to place duplicated project title: - type: string - minLength: 3 description: Title of duplicated project maxLength: 50 - description: + minLength: 3 type: string - default: '' - description: Description of duplicated project + workspace: + description: Workspace, where to place duplicated project + type: integer required: - - mode - - title - - workspace - ProjectGroup: + - mode + - title + - workspace type: object + ProjectGroup: properties: - project_id: - type: integer group: type: string + project_id: + type: integer role: $ref: '#/components/schemas/ProjectGroupRoleEnum' required: - - group - - project_id - - role - ProjectGroupRequest: + - group + - project_id + - role type: object + ProjectGroupRequest: properties: - project_id: - type: integer group: - type: string minLength: 1 + type: string + project_id: + type: integer role: $ref: '#/components/schemas/ProjectGroupRoleEnum' required: - - group - - project_id - - role + - group + - project_id + - role + type: object ProjectGroupRoleEnum: - enum: - - Inherit - - Annotator - - Reviewer - type: string description: |- * `Inherit` - Inherit * `Annotator` - Annotator * `Reviewer` - Reviewer + enum: + - Inherit + - Annotator + - Reviewer + type: string ProjectImport: - type: object properties: - id: - type: integer - readOnly: true - project: + annotation_count: + maximum: 2147483647 + minimum: -2147483648 type: integer - nullable: true - preannotated_from_fields: - nullable: true commit_to_project: type: boolean - return_task_ids: + could_be_tasks_list: type: boolean - status: - $ref: '#/components/schemas/Status7bfEnum' - url: - type: string - nullable: true - maxLength: 2048 - error: - type: string - nullable: true created_at: - type: string - format: date-time - readOnly: true - nullable: true description: Creation time - updated_at: - type: string format: date-time + nullable: true readOnly: true + type: string + data_columns: {} + duration: + maximum: 2147483647 + minimum: -2147483648 + type: integer + error: nullable: true - description: Updated time - finished_at: type: string + file_upload_ids: {} + finished_at: + description: Complete or fail time format: date-time nullable: true - description: Complete or fail time - task_count: + type: string + found_formats: {} + id: + readOnly: true type: integer + preannotated_from_fields: + nullable: true + prediction_count: maximum: 2147483647 minimum: -2147483648 - annotation_count: type: integer - maximum: 2147483647 - minimum: -2147483648 - prediction_count: + project: + nullable: true type: integer + return_task_ids: + type: boolean + status: + $ref: '#/components/schemas/Status7bfEnum' + task_count: maximum: 2147483647 minimum: -2147483648 - duration: type: integer - maximum: 2147483647 - minimum: -2147483648 - file_upload_ids: {} - could_be_tasks_list: - type: boolean - found_formats: {} - data_columns: {} + task_ids: {} tasks: nullable: true - task_ids: {} + updated_at: + description: Updated time + format: date-time + nullable: true + readOnly: true + type: string + url: + maxLength: 2048 + nullable: true + type: string required: - - created_at - - id - - updated_at - ProjectLabelConfig: + - created_at + - id + - updated_at type: object + ProjectLabelConfig: properties: label_config: - type: string description: Label config in XML format. See more about it in documentation + type: string required: - - label_config - ProjectLabelConfigRequest: + - label_config type: object + ProjectLabelConfigRequest: properties: label_config: - type: string - minLength: 1 description: Label config in XML format. See more about it in documentation + minLength: 1 + type: string required: - - label_config - ProjectMember: + - label_config type: object + ProjectMember: properties: user: type: integer required: - - user - ProjectMemberRequest: + - user type: object + ProjectMemberRequest: properties: user: type: integer required: - - user - ProjectReimport: + - user type: object + ProjectReimport: properties: - id: + annotation_count: + maximum: 2147483647 + minimum: -2147483648 type: integer - readOnly: true - project: + data_columns: {} + duration: + maximum: 2147483647 + minimum: -2147483648 type: integer - nullable: true - status: - $ref: '#/components/schemas/Status7bfEnum' error: - type: string nullable: true - task_count: + type: string + file_upload_ids: {} + files_as_tasks_list: + type: boolean + found_formats: {} + id: + readOnly: true type: integer + prediction_count: maximum: 2147483647 minimum: -2147483648 - annotation_count: type: integer - maximum: 2147483647 - minimum: -2147483648 - prediction_count: + project: + nullable: true type: integer + status: + $ref: '#/components/schemas/Status7bfEnum' + task_count: maximum: 2147483647 minimum: -2147483648 - duration: type: integer - maximum: 2147483647 - minimum: -2147483648 - file_upload_ids: {} - files_as_tasks_list: - type: boolean - found_formats: {} - data_columns: {} required: - - id - ProjectRequest: + - id type: object + ProjectRequest: description: |- Serializer get numbers from project queryset annotation, make sure, that you use correct one(Project.objects.with_counts()) properties: - title: - type: string + color: + maxLength: 16 nullable: true - description: Project name. Must be between 3 and 50 characters long. - maxLength: 50 - minLength: 3 - description: type: string + control_weights: + 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}' nullable: true + created_by: + allOf: + - $ref: '#/components/schemas/UserSimpleRequest' + description: Project owner + description: description: Project description - label_config: - type: string nullable: true - description: Label config in XML format. See more about it in documentation - expert_instruction: type: string - nullable: true - description: Labeling instructions in HTML format - show_instruction: - type: boolean - description: Show instructions to the annotator before they start - show_skip_button: - type: boolean - description: Show a skip button in interface and allow annotators to skip - the task enable_empty_annotation: - type: boolean description: Allow annotators to submit empty annotations - show_annotation_history: type: boolean - description: Show annotation history to annotator - organization: - type: integer + evaluate_predictions_automatically: + description: Retrieve and display predictions when loading a task + type: boolean + expert_instruction: + description: Labeling instructions in HTML format nullable: true - color: type: string + is_draft: + description: Whether or not the project is in the middle of being created + type: boolean + is_published: + description: Whether or not the project is published to annotators + title: Published + type: boolean + label_config: + description: Label config in XML format. See more about it in documentation nullable: true - maxLength: 16 + type: string maximum_annotations: - type: integer + 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) 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) - is_published: - type: boolean - title: Published - description: Whether or not the project is published to annotators + type: integer + min_annotations_to_start_training: + description: Minimum number of completed tasks after which model training is started + maximum: 2147483647 + minimum: -2147483648 + type: integer model_version: + description: Machine learning model version + nullable: true type: string + organization: nullable: true - description: Machine learning model version - is_draft: - type: boolean - description: Whether or not the project is in the middle of being created - created_by: - allOf: - - $ref: '#/components/schemas/UserSimpleRequest' - description: Project owner - min_annotations_to_start_training: type: integer + overlap_cohort_percentage: maximum: 2147483647 minimum: -2147483648 - description: Minimum number of completed tasks after which model training - is started - show_collab_predictions: + type: integer + pinned_at: + description: Pinned date and time + format: date-time + nullable: true + type: string + reveal_preannotations_interactively: + description: Reveal pre-annotations interactively type: boolean - title: Show predictions to annotator - description: If set, the annotator can view model predictions sampling: nullable: true oneOf: - - $ref: '#/components/schemas/SamplingEnum' - - $ref: '#/components/schemas/NullEnum' + - $ref: '#/components/schemas/SamplingEnum' + - $ref: '#/components/schemas/NullEnum' + show_annotation_history: + description: Show annotation history to annotator + type: boolean + show_collab_predictions: + description: If set, the annotator can view model predictions + title: Show predictions to annotator + type: boolean show_ground_truth_first: type: boolean + show_instruction: + description: Show instructions to the annotator before they start + type: boolean show_overlap_first: type: boolean - overlap_cohort_percentage: - type: integer - maximum: 2147483647 - minimum: -2147483648 - task_data_login: - type: string + show_skip_button: + description: Show a skip button in interface and allow annotators to skip the task + type: boolean + skip_queue: nullable: true + oneOf: + - $ref: '#/components/schemas/SkipQueueEnum' + - $ref: '#/components/schemas/NullEnum' + task_data_login: description: 'Task data credentials: login' maxLength: 256 - task_data_password: - type: string nullable: true + type: string + task_data_password: description: 'Task data credentials: password' maxLength: 256 - 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}' - evaluate_predictions_automatically: - type: boolean - description: Retrieve and display predictions when loading a task - skip_queue: nullable: true - oneOf: - - $ref: '#/components/schemas/SkipQueueEnum' - - $ref: '#/components/schemas/NullEnum' - reveal_preannotations_interactively: - type: boolean - description: Reveal pre-annotations interactively - pinned_at: type: string - format: date-time + title: + description: Project name. Must be between 3 and 50 characters long. + maxLength: 50 + minLength: 3 nullable: true - description: Pinned date and time - ProjectRole: + type: string type: object + ProjectRole: properties: id: - type: integer readOnly: true + type: integer + project: + type: integer role: allOf: - - $ref: '#/components/schemas/Role9e7Enum' + - $ref: '#/components/schemas/Role9e7Enum' description: |- User role in project @@ -25456,19 +25025,19 @@ components: * `NO` - Not Activated user: type: integer - project: - type: integer required: - - id - - project - - role - - user - ProjectRoleRequest: + - id + - project + - role + - user type: object + ProjectRoleRequest: properties: + project: + type: integer role: allOf: - - $ref: '#/components/schemas/Role9e7Enum' + - $ref: '#/components/schemas/Role9e7Enum' description: |- User role in project @@ -25481,111 +25050,119 @@ components: * `NO` - Not Activated user: type: integer - project: - type: integer required: - - project - - role - - user + - project + - role + - user + type: object ProjectSubsetEnum: - enum: - - All - - HasGT - - Sample - type: string description: |- * `All` - All * `HasGT` - HasGT * `Sample` - Sample + enum: + - All + - HasGT + - Sample + type: string ProjectTemplate: - type: object properties: - id: - type: integer - readOnly: true - name: - type: string - maxLength: 1000 - description: - type: string - nullable: true - tags: {} - project_settings: - description: general dict serialized project settings - review_settings: - description: general dict serialized review settings assignment_settings: description: general dict serialized assignment settings - require_comment_on_skip: - type: boolean - description: flag to require comment on skip - custom_script: - type: string - nullable: true - description: custom script for projects created from this template created_at: - type: string format: date-time readOnly: true - updated_at: type: string - format: date-time - readOnly: true created_by: - type: integer nullable: true - organization: type: integer + custom_script: + description: custom script for projects created from this template nullable: true - required: - - created_at - - id - - name - - updated_at - ProjectTemplateRequest: - type: object - properties: - name: type: string - minLength: 1 - maxLength: 1000 description: + nullable: true + type: string + id: + readOnly: true + type: integer + name: + maxLength: 1000 type: string + organization: nullable: true - minLength: 1 - tags: {} + type: integer project_settings: description: general dict serialized project settings + require_comment_on_skip: + description: flag to require comment on skip + type: boolean review_settings: description: general dict serialized review settings + tags: {} + updated_at: + format: date-time + readOnly: true + type: string + required: + - created_at + - id + - name + - updated_at + type: object + ProjectTemplateRequest: + properties: assignment_settings: description: general dict serialized assignment settings - require_comment_on_skip: - type: boolean - description: flag to require comment on skip + created_by: + nullable: true + type: integer custom_script: - type: string + description: custom script for projects created from this template + minLength: 1 nullable: true + type: string + description: minLength: 1 - description: custom script for projects created from this template - created_by: - type: integer nullable: true + type: string + name: + maxLength: 1000 + minLength: 1 + type: string organization: - type: integer nullable: true + type: integer + project_settings: + description: general dict serialized project settings + require_comment_on_skip: + description: flag to require comment on skip + type: boolean + review_settings: + description: general dict serialized review settings + tags: {} required: - - name - ProviderEnum: + - name + type: object + PromptsStatusEnum: + description: |- + * `Enabled` - Enabled + * `Cloud license per organization disabled` - Cloud license per organization disabled + * `On-premise global license disabled` - On-premise global license disabled + * `Expired` - Expired + * `Adala not connected` - Adala not connected + * `Disabled for this organization [FF]` - Disabled for this organization [FF] + * `unknown` - unknown enum: - - OpenAI - - AzureOpenAI - - AzureAIFoundry - - VertexAI - - Gemini - - Anthropic - - Custom + - Enabled + - Cloud license per organization disabled + - On-premise global license disabled + - Expired + - Adala not connected + - Disabled for this organization [FF] + - unknown type: string + ProviderEnum: description: |- * `OpenAI` - OpenAI * `AzureOpenAI` - AzureOpenAI @@ -25594,419 +25171,417 @@ components: * `Gemini` - Gemini * `Anthropic` - Anthropic * `Custom` - Custom - ReasonEnum: enum: - - MANUAL - - BEHAVIOR_BASED - - ANNOTATOR_EVALUATION - - ANNOTATION_LIMIT - - CUSTOM_SCRIPT + - OpenAI + - AzureOpenAI + - AzureAIFoundry + - VertexAI + - Gemini + - Anthropic + - Custom type: string + ReasonEnum: description: |- * `MANUAL` - Manual * `BEHAVIOR_BASED` - Behavior-based * `ANNOTATOR_EVALUATION` - Annotator evaluation * `ANNOTATION_LIMIT` - Annotation limit * `CUSTOM_SCRIPT` - Custom script + enum: + - MANUAL + - BEHAVIOR_BASED + - ANNOTATOR_EVALUATION + - ANNOTATION_LIMIT + - CUSTOM_SCRIPT + type: string RedisExportStorage: - type: object properties: - id: - type: integer - readOnly: true - type: - type: string - readOnly: true - default: redis - synchronizable: - type: boolean - default: true - path: - type: string - nullable: true - description: Storage prefix (optional) - host: - type: string + can_delete_objects: + description: Deletion from storage enabled nullable: true - description: Server Host IP (optional) - port: + type: boolean + created_at: + description: Creation time + format: date-time + readOnly: true type: string + db: + description: Server Database + maximum: 32767 + minimum: 0 + type: integer + description: + description: Cloud storage description nullable: true - description: Server Port (optional) - password: type: string + host: + description: Server Host IP (optional) nullable: true - description: Server Password (optional) - regex_filter: type: string - nullable: true - title: Port - description: Cloud storage regex for filtering objects - use_blob_urls: - type: boolean - description: Interpret objects as BLOBs and generate URLs + id: + readOnly: true + type: integer last_sync: - type: string + description: Last sync finished time format: date-time nullable: true - description: Last sync finished time + type: string last_sync_count: - type: integer + description: Count of tasks synced last time maximum: 2147483647 minimum: 0 nullable: true - description: Count of tasks synced last time + type: integer last_sync_job: - type: string - nullable: true description: Last sync job ID maxLength: 256 - status: - $ref: '#/components/schemas/StatusC5aEnum' - traceback: - type: string nullable: true - description: Traceback report for the last failed sync + type: string meta: - nullable: true description: Meta and debug information about storage processes - title: - type: string nullable: true - description: Cloud storage title - maxLength: 256 - description: + password: + description: Server Password (optional) + nullable: true type: string + path: + description: Storage prefix (optional) nullable: true - description: Cloud storage description - created_at: type: string - format: date-time - readOnly: true - description: Creation time - can_delete_objects: - type: boolean + port: + description: Server Port (optional) nullable: true - description: Deletion from storage enabled - db: - type: integer - maximum: 32767 - minimum: 0 - description: Server Database + type: string project: - type: integer description: A unique integer value identifying this project. - required: - - created_at - - id - - project - - type - RedisImportStorage: - type: object - properties: - id: type: integer - readOnly: true - type: + regex_filter: + description: Cloud storage regex for filtering objects + nullable: true + title: Port type: string - readOnly: true - default: redis + status: + $ref: '#/components/schemas/StatusC5aEnum' synchronizable: - type: boolean default: true - path: - type: string + type: boolean + title: + description: Cloud storage title + maxLength: 256 nullable: true - description: Storage prefix (optional) - host: type: string + traceback: + description: Traceback report for the last failed sync nullable: true - description: Server Host IP (optional) - port: type: string - nullable: true - description: Server Port (optional) - password: + type: + default: redis + readOnly: true + type: string + use_blob_urls: + description: Interpret objects as BLOBs and generate URLs + type: boolean + required: + - created_at + - id + - project + - type + type: object + RedisImportStorage: + properties: + created_at: + description: Creation time + format: date-time + readOnly: true type: string + db: + description: Server Database + maximum: 32767 + minimum: 0 + type: integer + description: + description: Cloud storage description nullable: true - description: Server Password (optional) - regex_filter: type: string + host: + description: Server Host IP (optional) nullable: true - title: Port - description: Cloud storage regex for filtering objects - use_blob_urls: - type: boolean - description: Interpret objects as BLOBs and generate URLs - last_sync: type: string + id: + readOnly: true + type: integer + last_sync: + description: Last sync finished time format: date-time nullable: true - description: Last sync finished time + type: string last_sync_count: - type: integer + description: Count of tasks synced last time maximum: 2147483647 minimum: 0 nullable: true - description: Count of tasks synced last time + type: integer last_sync_job: - type: string - nullable: true description: Last sync job ID maxLength: 256 - status: - $ref: '#/components/schemas/StatusC5aEnum' - traceback: - type: string nullable: true - description: Traceback report for the last failed sync + type: string meta: - nullable: true description: Meta and debug information about storage processes - title: + nullable: true + password: + description: Server Password (optional) + nullable: true + type: string + path: + description: Storage prefix (optional) + nullable: true + type: string + port: + description: Server Port (optional) + nullable: true type: string + project: + description: A unique integer value identifying this project. + type: integer + regex_filter: + description: Cloud storage regex for filtering objects nullable: true + title: Port + type: string + status: + $ref: '#/components/schemas/StatusC5aEnum' + synchronizable: + default: true + type: boolean + title: description: Cloud storage title maxLength: 256 - description: + nullable: true type: string + traceback: + description: Traceback report for the last failed sync nullable: true - description: Cloud storage description - created_at: type: string - format: date-time + type: + default: redis readOnly: true - description: Creation time - db: - type: integer - maximum: 32767 - minimum: 0 - description: Server Database - project: - type: integer - description: A unique integer value identifying this project. + type: string + use_blob_urls: + description: Interpret objects as BLOBs and generate URLs + type: boolean required: - - created_at - - id - - project - - type - RefinePromptRequestRequest: + - created_at + - id + - project + - type type: object + RefinePromptRequestRequest: properties: - teacher_model_provider_connection_id: + project_id: + description: Project ID to target the refined prompt for type: integer - description: Model Provider Connection ID to use to refine the prompt teacher_model_name: - type: string - minLength: 1 description: Name of the model to use to refine the prompt - project_id: + minLength: 1 + type: string + teacher_model_provider_connection_id: + description: Model Provider Connection ID to use to refine the prompt type: integer - description: Project ID to target the refined prompt for required: - - project_id - - teacher_model_name - - teacher_model_provider_connection_id - RefinedPromptResponse: + - project_id + - teacher_model_name + - teacher_model_provider_connection_id type: object + RefinedPromptResponse: properties: - title: - type: string - nullable: true - description: Title of the refined prompt - reasoning: - type: string + previous_version: + allOf: + - $ref: '#/components/schemas/ThirdPartyModelVersion' + description: Previous version of the prompt nullable: true - description: Reasoning behind the refinement prompt: - type: string description: The refined prompt text - refinement_job_id: type: string + reasoning: + description: Reasoning behind the refinement nullable: true - description: Unique identifier for the refinement job - refinement_status: type: string + refinement_job_id: + description: Unique identifier for the refinement job nullable: true + type: string + refinement_status: description: Status of the refinement job - total_cost: + nullable: true type: string + title: + description: Title of the refined prompt nullable: true + type: string + total_cost: description: Total cost of the refinement job (in USD) - previous_version: - allOf: - - $ref: '#/components/schemas/ThirdPartyModelVersion' nullable: true - description: Previous version of the prompt + type: string required: - - previous_version - - prompt - - reasoning - - refinement_job_id - - refinement_status - - title - - total_cost + - previous_version + - prompt + - reasoning + - refinement_job_id + - refinement_status + - title + - total_cost + type: object RequeueRejectedTasksModeEnum: - enum: - - requeue - - remove - - flexible - type: string description: |- * `requeue` - Requeue * `remove` - Remove * `flexible` - Flexible - ReviewCriteriaEnum: enum: - - all - - one + - requeue + - remove + - flexible type: string + ReviewCriteriaEnum: description: |- * `all` - Task is reviewed if all annotations are reviewed * `one` - Task is reviewed if at least one annotation is reviewed + enum: + - all + - one + type: string ReviewSettings: - type: object properties: + anonymize_annotations: + description: Hide annotator names from annotations while review + type: boolean id: - type: integer readOnly: true - requeue_rejected_tasks_to_annotator: + type: integer + instruction: + description: Reviewer instructions in HTML format + nullable: true + type: string + only_finished_tasks: + description: Show only finished tasks in the review stream type: boolean + project: + nullable: true + type: integer + requeue_rejected_tasks_mode: + description: |- + Requeue mode for rejected tasks + + * `requeue` - Requeue + * `remove` - Remove + * `flexible` - Flexible + nullable: true + oneOf: + - $ref: '#/components/schemas/RequeueRejectedTasksModeEnum' + - $ref: '#/components/schemas/BlankEnum' + - $ref: '#/components/schemas/NullEnum' + requeue_rejected_tasks_to_annotator: readOnly: true + type: boolean + require_comment_on_reject: + description: If set, the reviewer must leave a comment on reject + type: boolean review_criteria: - nullable: true description: |- Criteria to mark task as reviewed * `all` - Task is reviewed if all annotations are reviewed * `one` - Task is reviewed if at least one annotation is reviewed + nullable: true oneOf: - - $ref: '#/components/schemas/ReviewCriteriaEnum' - - $ref: '#/components/schemas/NullEnum' - anonymize_annotations: + - $ref: '#/components/schemas/ReviewCriteriaEnum' + - $ref: '#/components/schemas/NullEnum' + review_only_manual_assignments: + description: When set True, review queue is built only from manually assigned tasks type: boolean - description: Hide annotator names from annotations while review - only_finished_tasks: + show_agreement_to_reviewers: + description: Show the agreement column to reviewers type: boolean - description: Show only finished tasks in the review stream - instruction: - type: string - nullable: true - description: Reviewer instructions in HTML format - show_instruction: + show_data_manager_to_reviewers: + description: Show the data manager to reviewers type: boolean + show_instruction: description: Show instructions to the reviewers before they start - show_data_manager_to_reviewers: type: boolean - description: Show the data manager to reviewers - show_agreement_to_reviewers: + required: + - id + - requeue_rejected_tasks_to_annotator + type: object + ReviewSettingsRequest: + properties: + anonymize_annotations: + description: Hide annotator names from annotations while review type: boolean - description: Show the agreement column to reviewers - require_comment_on_reject: + instruction: + description: Reviewer instructions in HTML format + nullable: true + type: string + only_finished_tasks: + description: Show only finished tasks in the review stream type: boolean - description: If set, the reviewer must leave a comment on reject - requeue_rejected_tasks_mode: + project: nullable: true + type: integer + requeue_rejected_tasks_mode: description: |- Requeue mode for rejected tasks * `requeue` - Requeue * `remove` - Remove * `flexible` - Flexible + nullable: true oneOf: - - $ref: '#/components/schemas/RequeueRejectedTasksModeEnum' - - $ref: '#/components/schemas/BlankEnum' - - $ref: '#/components/schemas/NullEnum' - review_only_manual_assignments: + - $ref: '#/components/schemas/RequeueRejectedTasksModeEnum' + - $ref: '#/components/schemas/BlankEnum' + - $ref: '#/components/schemas/NullEnum' + require_comment_on_reject: + description: If set, the reviewer must leave a comment on reject type: boolean - description: When set True, review queue is built only from manually assigned - tasks - project: - type: integer - nullable: true - required: - - id - - requeue_rejected_tasks_to_annotator - ReviewSettingsRequest: - type: object - properties: review_criteria: - nullable: true description: |- Criteria to mark task as reviewed * `all` - Task is reviewed if all annotations are reviewed * `one` - Task is reviewed if at least one annotation is reviewed + nullable: true oneOf: - - $ref: '#/components/schemas/ReviewCriteriaEnum' - - $ref: '#/components/schemas/NullEnum' - anonymize_annotations: - type: boolean - description: Hide annotator names from annotations while review - only_finished_tasks: + - $ref: '#/components/schemas/ReviewCriteriaEnum' + - $ref: '#/components/schemas/NullEnum' + review_only_manual_assignments: + description: When set True, review queue is built only from manually assigned tasks type: boolean - description: Show only finished tasks in the review stream - instruction: - type: string - nullable: true - description: Reviewer instructions in HTML format - show_instruction: + show_agreement_to_reviewers: + description: Show the agreement column to reviewers type: boolean - description: Show instructions to the reviewers before they start show_data_manager_to_reviewers: - type: boolean description: Show the data manager to reviewers - show_agreement_to_reviewers: type: boolean - description: Show the agreement column to reviewers - require_comment_on_reject: - type: boolean - description: If set, the reviewer must leave a comment on reject - requeue_rejected_tasks_mode: - nullable: true - description: |- - Requeue mode for rejected tasks - - * `requeue` - Requeue - * `remove` - Remove - * `flexible` - Flexible - oneOf: - - $ref: '#/components/schemas/RequeueRejectedTasksModeEnum' - - $ref: '#/components/schemas/BlankEnum' - - $ref: '#/components/schemas/NullEnum' - review_only_manual_assignments: + show_instruction: + description: Show instructions to the reviewers before they start type: boolean - description: When set True, review queue is built only from manually assigned - tasks - project: - type: integer - nullable: true + type: object ReviewedEnum: - enum: - - only - - exclude description: |- * `only` - only * `exclude` - exclude * `None` - None + enum: + - only + - exclude RevokeInviteRequest: - type: object properties: email: - type: string minLength: 1 + type: string required: - - email + - email + type: object Role9e7Enum: - enum: - - OW - - AD - - MA - - RE - - AN - - DI - - 'NO' - type: string description: |- * `OW` - Owner * `AD` - Administrator @@ -26015,751 +25590,750 @@ components: * `AN` - Annotator * `DI` - Deactivated * `NO` - Not Activated + enum: + - OW + - AD + - MA + - RE + - AN + - DI + - 'NO' + type: string RoleBasedTask: oneOf: - - $ref: '#/components/schemas/LseTask' - - $ref: '#/components/schemas/LseTaskSerializerForReviewers' - - $ref: '#/components/schemas/LseTaskSerializerForAnnotators' + - $ref: '#/components/schemas/LseTask' + - $ref: '#/components/schemas/LseTaskSerializerForReviewers' + - $ref: '#/components/schemas/LseTaskSerializerForAnnotators' S3DatasetStorage: - type: object properties: + aws_access_key_id: + description: AWS_ACCESS_KEY_ID + nullable: true + type: string + aws_secret_access_key: + description: AWS_SECRET_ACCESS_KEY + nullable: true + type: string + aws_session_token: + description: AWS_SESSION_TOKEN + nullable: true + type: string + aws_sse_kms_key_id: + description: AWS SSE KMS Key ID + nullable: true + type: string + bucket: + description: S3 bucket name + nullable: true + type: string + created_at: + description: Creation time + format: date-time + readOnly: true + type: string + dataset: + description: A unique integer value identifying this dataset. + type: integer + description: + description: Cloud storage description + nullable: true + type: string + glob_pattern: + description: Glob pattern for syncing from bucket + nullable: true + type: string id: + readOnly: true type: integer + job_id: + nullable: true readOnly: true - type: + title: The Job ID for the GCP Dataproc job that will import the records of this dataset into the vector db type: string - readOnly: true - default: s3 - synchronizable: - type: boolean - default: true - presign: - type: boolean - default: true last_sync: - type: string + description: Last sync finished time format: date-time nullable: true - description: Last sync finished time + type: string last_sync_count: - type: integer + description: Count of tasks synced last time maximum: 2147483647 minimum: 0 nullable: true - description: Count of tasks synced last time + type: integer last_sync_job: - type: string - nullable: true description: Last sync job ID maxLength: 256 - status: - $ref: '#/components/schemas/StatusC5aEnum' - traceback: - type: string nullable: true - description: Traceback report for the last failed sync + type: string meta: - nullable: true description: Meta and debug information about storage processes - title: - type: string nullable: true - description: Cloud storage title - maxLength: 256 - description: + prefix: + description: S3 bucket prefix + nullable: true type: string + presign: + default: true + type: boolean + presign_ttl: + description: Presigned URLs TTL (in minutes) + maximum: 32767 + minimum: 0 + type: integer + recursive_scan: + description: Perform recursive scan over the bucket content + type: boolean + regex_filter: + description: Cloud storage regex for filtering objects nullable: true - description: Cloud storage description - created_at: type: string - format: date-time - readOnly: true - description: Creation time - bucket: + region_name: + description: AWS Region + nullable: true type: string + s3_endpoint: + description: S3 Endpoint nullable: true - description: S3 bucket name - prefix: type: string + status: + $ref: '#/components/schemas/StatusC5aEnum' + synced: + description: Flag if dataset has been previously synced or not + type: boolean + synchronizable: + default: true + type: boolean + title: + description: Cloud storage title + maxLength: 256 nullable: true - description: S3 bucket prefix - regex_filter: type: string + traceback: + description: Traceback report for the last failed sync nullable: true - description: Cloud storage regex for filtering objects + type: string + type: + default: s3 + readOnly: true + type: string use_blob_urls: - type: boolean description: Interpret objects as BLOBs and generate URLs + type: boolean + required: + - created_at + - dataset + - id + - job_id + - type + type: object + S3DatasetStorageRequest: + properties: aws_access_key_id: - type: string - nullable: true description: AWS_ACCESS_KEY_ID - aws_secret_access_key: - type: string nullable: true - description: AWS_SECRET_ACCESS_KEY - aws_session_token: type: string + aws_secret_access_key: + description: AWS_SECRET_ACCESS_KEY nullable: true - description: AWS_SESSION_TOKEN - aws_sse_kms_key_id: type: string + aws_session_token: + description: AWS_SESSION_TOKEN nullable: true - description: AWS SSE KMS Key ID - region_name: type: string + aws_sse_kms_key_id: + description: AWS SSE KMS Key ID nullable: true - description: AWS Region - s3_endpoint: type: string + bucket: + description: S3 bucket name nullable: true - description: S3 Endpoint - presign_ttl: - type: integer - maximum: 32767 - minimum: 0 - description: Presigned URLs TTL (in minutes) - recursive_scan: - type: boolean - description: Perform recursive scan over the bucket content - glob_pattern: type: string + dataset: + description: A unique integer value identifying this dataset. + type: integer + description: + description: Cloud storage description nullable: true - description: Glob pattern for syncing from bucket - synced: - type: boolean - description: Flag if dataset has been previously synced or not - job_id: type: string - readOnly: true + glob_pattern: + description: Glob pattern for syncing from bucket nullable: true - title: The Job ID for the GCP Dataproc job that will import the records - of this dataset into the vector db - dataset: - type: integer - description: A unique integer value identifying this dataset. - required: - - created_at - - dataset - - id - - job_id - - type - S3DatasetStorageRequest: - type: object - properties: - synchronizable: - type: boolean - default: true - presign: - type: boolean - default: true - last_sync: type: string + last_sync: + description: Last sync finished time format: date-time nullable: true - description: Last sync finished time + type: string last_sync_count: - type: integer + description: Count of tasks synced last time maximum: 2147483647 minimum: 0 nullable: true - description: Count of tasks synced last time + type: integer last_sync_job: - type: string - nullable: true description: Last sync job ID maxLength: 256 - status: - $ref: '#/components/schemas/StatusC5aEnum' - traceback: - type: string nullable: true - description: Traceback report for the last failed sync + type: string meta: - nullable: true description: Meta and debug information about storage processes - title: + nullable: true + prefix: + description: S3 bucket prefix + nullable: true type: string + presign: + default: true + type: boolean + presign_ttl: + description: Presigned URLs TTL (in minutes) + maximum: 32767 + minimum: 0 + type: integer + recursive_scan: + description: Perform recursive scan over the bucket content + type: boolean + regex_filter: + description: Cloud storage regex for filtering objects nullable: true - description: Cloud storage title - maxLength: 256 - description: type: string + region_name: + description: AWS Region nullable: true - description: Cloud storage description - bucket: type: string + s3_endpoint: + description: S3 Endpoint nullable: true - description: S3 bucket name - prefix: type: string + status: + $ref: '#/components/schemas/StatusC5aEnum' + synced: + description: Flag if dataset has been previously synced or not + type: boolean + synchronizable: + default: true + type: boolean + title: + description: Cloud storage title + maxLength: 256 nullable: true - description: S3 bucket prefix - regex_filter: type: string + traceback: + description: Traceback report for the last failed sync nullable: true - description: Cloud storage regex for filtering objects + type: string use_blob_urls: - type: boolean description: Interpret objects as BLOBs and generate URLs + type: boolean + required: + - dataset + type: object + S3ExportStorage: + properties: aws_access_key_id: - type: string - nullable: true description: AWS_ACCESS_KEY_ID - aws_secret_access_key: - type: string nullable: true - description: AWS_SECRET_ACCESS_KEY - aws_session_token: type: string + aws_secret_access_key: + description: AWS_SECRET_ACCESS_KEY nullable: true - description: AWS_SESSION_TOKEN - aws_sse_kms_key_id: type: string + aws_session_token: + description: AWS_SESSION_TOKEN nullable: true - description: AWS SSE KMS Key ID - region_name: type: string + aws_sse_kms_key_id: + description: AWS SSE KMS Key ID nullable: true - description: AWS Region - s3_endpoint: type: string + bucket: + description: S3 bucket name nullable: true - description: S3 Endpoint - presign_ttl: - type: integer - maximum: 32767 - minimum: 0 - description: Presigned URLs TTL (in minutes) - recursive_scan: - type: boolean - description: Perform recursive scan over the bucket content - glob_pattern: type: string + can_delete_objects: + description: Deletion from storage enabled nullable: true - description: Glob pattern for syncing from bucket - synced: type: boolean - description: Flag if dataset has been previously synced or not - dataset: - type: integer - description: A unique integer value identifying this dataset. - required: - - dataset - S3ExportStorage: - type: object - properties: - id: - type: integer + created_at: + description: Creation time + format: date-time readOnly: true - type: type: string + description: + description: Cloud storage description + nullable: true + type: string + id: readOnly: true - default: s3 - synchronizable: - type: boolean - default: true + type: integer last_sync: - type: string + description: Last sync finished time format: date-time nullable: true - description: Last sync finished time + type: string last_sync_count: - type: integer + description: Count of tasks synced last time maximum: 2147483647 minimum: 0 nullable: true - description: Count of tasks synced last time + type: integer last_sync_job: - type: string - nullable: true description: Last sync job ID maxLength: 256 - status: - $ref: '#/components/schemas/StatusC5aEnum' - traceback: - type: string nullable: true - description: Traceback report for the last failed sync + type: string meta: - nullable: true description: Meta and debug information about storage processes - title: - type: string nullable: true - description: Cloud storage title - maxLength: 256 - description: + prefix: + description: S3 bucket prefix + nullable: true type: string + project: + description: A unique integer value identifying this project. + type: integer + regex_filter: + description: Cloud storage regex for filtering objects nullable: true - description: Cloud storage description - created_at: type: string - format: date-time - readOnly: true - description: Creation time - can_delete_objects: - type: boolean + region_name: + description: AWS Region nullable: true - description: Deletion from storage enabled - bucket: type: string + s3_endpoint: + description: S3 Endpoint nullable: true - description: S3 bucket name - prefix: type: string + status: + $ref: '#/components/schemas/StatusC5aEnum' + synchronizable: + default: true + type: boolean + title: + description: Cloud storage title + maxLength: 256 nullable: true - description: S3 bucket prefix - regex_filter: type: string + traceback: + description: Traceback report for the last failed sync nullable: true - description: Cloud storage regex for filtering objects + type: string + type: + default: s3 + readOnly: true + type: string use_blob_urls: - type: boolean description: Interpret objects as BLOBs and generate URLs + type: boolean + required: + - created_at + - id + - project + - type + type: object + S3ImportStorage: + properties: aws_access_key_id: - type: string - nullable: true description: AWS_ACCESS_KEY_ID - aws_secret_access_key: - type: string nullable: true - description: AWS_SECRET_ACCESS_KEY - aws_session_token: type: string + aws_secret_access_key: + description: AWS_SECRET_ACCESS_KEY nullable: true - description: AWS_SESSION_TOKEN - aws_sse_kms_key_id: type: string + aws_session_token: + description: AWS_SESSION_TOKEN nullable: true - description: AWS SSE KMS Key ID - region_name: type: string + aws_sse_kms_key_id: + description: AWS SSE KMS Key ID nullable: true - description: AWS Region - s3_endpoint: type: string + bucket: + description: S3 bucket name nullable: true - description: S3 Endpoint - project: - type: integer - description: A unique integer value identifying this project. - required: - - created_at - - id - - project - - type - S3ImportStorage: - type: object - properties: - id: - type: integer + type: string + created_at: + description: Creation time + format: date-time readOnly: true - type: type: string + description: + description: Cloud storage description + nullable: true + type: string + id: readOnly: true - default: s3 - synchronizable: - type: boolean - default: true - presign: - type: boolean - default: true + type: integer last_sync: - type: string + description: Last sync finished time format: date-time nullable: true - description: Last sync finished time + type: string last_sync_count: - type: integer + description: Count of tasks synced last time maximum: 2147483647 minimum: 0 nullable: true - description: Count of tasks synced last time + type: integer last_sync_job: - type: string - nullable: true description: Last sync job ID maxLength: 256 - status: - $ref: '#/components/schemas/StatusC5aEnum' - traceback: - type: string nullable: true - description: Traceback report for the last failed sync + type: string meta: - nullable: true description: Meta and debug information about storage processes - title: - type: string - nullable: true - description: Cloud storage title - maxLength: 256 - description: - type: string - nullable: true - description: Cloud storage description - created_at: - type: string - format: date-time - readOnly: true - description: Creation time - bucket: - type: string nullable: true - description: S3 bucket name prefix: - type: string - nullable: true description: S3 bucket prefix - regex_filter: - type: string nullable: true - description: Cloud storage regex for filtering objects - use_blob_urls: - type: boolean - description: Interpret objects as BLOBs and generate URLs - aws_access_key_id: type: string + presign: + default: true + type: boolean + presign_ttl: + description: Presigned URLs TTL (in minutes) + maximum: 32767 + minimum: 0 + type: integer + project: + description: A unique integer value identifying this project. + type: integer + recursive_scan: + description: Perform recursive scan over the bucket content + type: boolean + regex_filter: + description: Cloud storage regex for filtering objects nullable: true - description: AWS_ACCESS_KEY_ID - aws_secret_access_key: type: string + region_name: + description: AWS Region nullable: true - description: AWS_SECRET_ACCESS_KEY - aws_session_token: type: string + s3_endpoint: + description: S3 Endpoint nullable: true - description: AWS_SESSION_TOKEN - aws_sse_kms_key_id: type: string + status: + $ref: '#/components/schemas/StatusC5aEnum' + synchronizable: + default: true + type: boolean + title: + description: Cloud storage title + maxLength: 256 nullable: true - description: AWS SSE KMS Key ID - region_name: type: string + traceback: + description: Traceback report for the last failed sync nullable: true - description: AWS Region - s3_endpoint: type: string - nullable: true - description: S3 Endpoint - presign_ttl: - type: integer - maximum: 32767 - minimum: 0 - description: Presigned URLs TTL (in minutes) - recursive_scan: + type: + default: s3 + readOnly: true + type: string + use_blob_urls: + description: Interpret objects as BLOBs and generate URLs type: boolean - description: Perform recursive scan over the bucket content - project: - type: integer - description: A unique integer value identifying this project. required: - - created_at - - id - - project - - type - SamlSettings: + - created_at + - id + - project + - type type: object + SamlSettings: properties: - workspaces_groups: + projects_groups: + description: Projects to groups mapping nullable: true - description: Workspaces to groups mapping roles_groups: - nullable: true description: Roles to groups mapping - projects_groups: nullable: true - description: Projects to groups mapping - SamlSettingsUpdate: + workspaces_groups: + description: Workspaces to groups mapping + nullable: true type: object + SamlSettingsUpdate: properties: - workspaces_groups: + projects_groups: + items: + $ref: '#/components/schemas/ProjectGroup' type: array + roles_groups: items: - type: array items: type: string - roles_groups: + type: array type: array + workspaces_groups: items: - type: array items: type: string - projects_groups: + type: array type: array - items: - $ref: '#/components/schemas/ProjectGroup' - SamlSettingsUpdateRequest: type: object + SamlSettingsUpdateRequest: properties: - workspaces_groups: + projects_groups: + items: + $ref: '#/components/schemas/ProjectGroupRequest' type: array + roles_groups: items: - type: array items: - type: string minLength: 1 - roles_groups: + type: string + type: array type: array + workspaces_groups: items: - type: array items: - type: string minLength: 1 - projects_groups: + type: string + type: array type: array - items: - $ref: '#/components/schemas/ProjectGroupRequest' + type: object SamplingEnum: - enum: - - Sequential sampling - - Uniform sampling - - Uncertainty sampling - type: string description: |- * `Sequential sampling` - Tasks are ordered by Data manager ordering * `Uniform sampling` - Tasks are chosen randomly * `Uncertainty sampling` - Tasks are chosen according to model uncertainty scores (active learning mode) + enum: + - Sequential sampling + - Uniform sampling + - Uncertainty sampling + type: string ScimSettings: - type: object properties: - workspaces_groups: + projects_groups: + description: Projects to groups mapping nullable: true - description: Workspaces to groups mapping roles_groups: - nullable: true description: Roles to groups mapping - projects_groups: nullable: true - description: Projects to groups mapping - ScimSettingsUpdate: + workspaces_groups: + description: Workspaces to groups mapping + nullable: true type: object + ScimSettingsUpdate: properties: - workspaces_groups: + projects_groups: + items: + $ref: '#/components/schemas/ProjectGroup' type: array + roles_groups: items: - type: array items: type: string - roles_groups: + type: array type: array + workspaces_groups: items: - type: array items: type: string - projects_groups: + type: array type: array - items: - $ref: '#/components/schemas/ProjectGroup' - ScimSettingsUpdateRequest: type: object + ScimSettingsUpdateRequest: properties: - workspaces_groups: + projects_groups: + items: + $ref: '#/components/schemas/ProjectGroupRequest' type: array + roles_groups: items: - type: array items: - type: string minLength: 1 - roles_groups: + type: string + type: array type: array + workspaces_groups: items: - type: array items: - type: string minLength: 1 - projects_groups: + type: string + type: array type: array - items: - $ref: '#/components/schemas/ProjectGroupRequest' + type: object ScopeEnum: - enum: - - Organization - - User - - Model - type: string description: |- * `Organization` - Organization * `User` - User * `Model` - Model + enum: + - Organization + - User + - Model + type: string SelectedItemsRequest: - type: object properties: all: type: boolean - included: - type: array + excluded: items: type: integer - excluded: type: array + included: items: type: integer + type: array required: - - all - SendInviteRequest: + - all type: object + SendInviteRequest: properties: emails: - type: array items: - type: string minLength: 1 + type: string + type: array role: - type: string minLength: 1 + type: string required: - - emails - - role - SerializationOption: + - emails + - role type: object + SerializationOption: properties: only_id: - type: boolean default: false description: Include a full json body or IDs only - SerializationOptionRequest: + type: boolean type: object + SerializationOptionRequest: properties: only_id: - type: boolean default: false description: Include a full json body or IDs only - SerializationOptions: + type: boolean type: object + SerializationOptions: properties: - drafts: + annotations__completed_by: allOf: - - $ref: '#/components/schemas/SerializationOption' + - $ref: '#/components/schemas/SerializationOption' description: JSON dict with parameters - predictions: + drafts: allOf: - - $ref: '#/components/schemas/SerializationOption' + - $ref: '#/components/schemas/SerializationOption' description: JSON dict with parameters include_annotation_history: - type: boolean default: false description: Include annotation history - annotations__completed_by: - allOf: - - $ref: '#/components/schemas/SerializationOption' - description: JSON dict with parameters - interpolate_key_frames: type: boolean + interpolate_key_frames: default: false description: Interpolate video key frames - SerializationOptionsRequest: + type: boolean + predictions: + allOf: + - $ref: '#/components/schemas/SerializationOption' + description: JSON dict with parameters type: object + SerializationOptionsRequest: properties: - drafts: + annotations__completed_by: allOf: - - $ref: '#/components/schemas/SerializationOptionRequest' + - $ref: '#/components/schemas/SerializationOptionRequest' description: JSON dict with parameters - predictions: + drafts: allOf: - - $ref: '#/components/schemas/SerializationOptionRequest' + - $ref: '#/components/schemas/SerializationOptionRequest' description: JSON dict with parameters include_annotation_history: - type: boolean default: false description: Include annotation history - annotations__completed_by: - allOf: - - $ref: '#/components/schemas/SerializationOptionRequest' - description: JSON dict with parameters - interpolate_key_frames: type: boolean + interpolate_key_frames: default: false description: Interpolate video key frames - SessionTimeoutPolicy: + type: boolean + predictions: + allOf: + - $ref: '#/components/schemas/SerializationOptionRequest' + description: JSON dict with parameters type: object + SessionTimeoutPolicy: properties: + created_at: + format: date-time + readOnly: true + type: string max_session_age: - type: integer + description: Number of minutes that a session can be active before needing to re-login maximum: 2147483647 minimum: 1 title: Max session age (minutes) - description: Number of minutes that a session can be active before needing - to re-login - max_time_between_activity: type: integer + max_time_between_activity: + description: Number of minutes that a session stays active without any activity maximum: 2147483647 minimum: 1 title: Max time (minutes) between activity - description: Number of minutes that a session stays active without any activity - created_at: - type: string - format: date-time - readOnly: true + type: integer updated_at: - type: string format: date-time readOnly: true + type: string required: - - created_at - - updated_at + - created_at + - updated_at + type: object SkillNameEnum: - enum: - - TextClassification - - NamedEntityRecognition - type: string description: |- * `TextClassification` - TextClassification * `NamedEntityRecognition` - NamedEntityRecognition - SkipQueueEnum: enum: - - REQUEUE_FOR_ME - - REQUEUE_FOR_OTHERS - - IGNORE_SKIPPED + - TextClassification + - NamedEntityRecognition type: string + SkipQueueEnum: description: |- * `REQUEUE_FOR_ME` - Requeue for me * `REQUEUE_FOR_OTHERS` - Requeue for others * `IGNORE_SKIPPED` - Ignore skipped - SkippedEnum: enum: - - only - - exclude + - REQUEUE_FOR_ME + - REQUEUE_FOR_OTHERS + - IGNORE_SKIPPED + type: string + SkippedEnum: description: |- * `only` - only * `exclude` - exclude * `None` - None - StateEnum: enum: - - CO - - DI - - ER - - TR - - PR - type: string + - only + - exclude + StateEnum: description: |- * `CO` - Connected * `DI` - Disconnected * `ER` - Error * `TR` - Training * `PR` - Predicting - Status7bfEnum: enum: - - created - - in_progress - - failed - - completed + - CO + - DI + - ER + - TR + - PR type: string + Status7bfEnum: description: |- * `created` - Created * `in_progress` - In progress * `failed` - Failed * `completed` - Completed - StatusC5aEnum: enum: - - initialized - - queued - - in_progress - - failed - - completed - - completed_with_errors + - created + - in_progress + - failed + - completed type: string + StatusC5aEnum: description: |- * `initialized` - Initialized * `queued` - Queued @@ -26767,193 +26341,197 @@ components: * `failed` - Failed * `completed` - Completed * `completed_with_errors` - Completed with errors + enum: + - initialized + - queued + - in_progress + - failed + - completed + - completed_with_errors + type: string TaskAssignment: - type: object properties: - id: + assignee: + description: Assigned user type: integer - readOnly: true created_at: - type: string + description: Time of assignment format: date-time readOnly: true - description: Time of assignment + type: string + id: + readOnly: true + type: integer + task: + description: Assigned task + type: integer type: allOf: - - $ref: '#/components/schemas/TypeEnum' - title: Assignment type + - $ref: '#/components/schemas/TypeEnum' description: |- Type of assignment: Annotate|Review * `AN` - Annotate * `RE` - Review + title: Assignment type + required: + - assignee + - created_at + - id + - task + type: object + TaskAssignmentRequest: + properties: assignee: - type: integer description: Assigned user - task: type: integer + task: description: Assigned task - required: - - assignee - - created_at - - id - - task - TaskAssignmentRequest: - type: object - properties: + type: integer type: allOf: - - $ref: '#/components/schemas/TypeEnum' - title: Assignment type + - $ref: '#/components/schemas/TypeEnum' description: |- Type of assignment: Annotate|Review * `AN` - Annotate * `RE` - Review - assignee: - type: integer - description: Assigned user - task: - type: integer - description: Assigned task + title: Assignment type required: - - assignee - - task - TaskSimple: + - assignee + - task type: object + TaskSimple: properties: - id: - type: integer + annotations: + default: [] + items: + $ref: '#/components/schemas/Annotation' readOnly: true - data: - description: User imported or uploaded data for a task. Data is formatted - according to the project label config. You can find examples of data for - your project on the Import page in the Label Studio Data Manager UI. - meta: - nullable: true - description: Meta is user imported (uploaded) data and can be useful as - input for an ML Backend for embeddings, advanced vectors, and other info. - It is passed to ML during training/predicting steps. + type: array + cancelled_annotations: + description: Number of total cancelled annotations for the current task + maximum: 2147483647 + minimum: -2147483648 + type: integer + comment_authors: + description: Users who wrote comments + items: + type: integer + type: array + comment_count: + description: Number of comments in the task including all annotations + maximum: 2147483647 + minimum: -2147483648 + type: integer created_at: - type: string + description: Time a task was created format: date-time readOnly: true - description: Time a task was created - updated_at: type: string - format: date-time + data: + description: User imported or uploaded data for a task. Data is formatted according to the project label config. You can find examples of data for your project on the Import page in the Label Studio Data Manager UI. + file_upload: + description: Uploaded file used as data source for this task + nullable: true + type: integer + id: readOnly: true - description: Last time a task was updated - is_labeled: - type: boolean - description: 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: integer - maximum: 2147483647 - minimum: -2147483648 - description: Number of distinct annotators that processed the current task inner_id: - type: integer + description: Internal task ID in the project, starts with 1 + format: int64 maximum: 9223372036854775807 minimum: -9223372036854775808 - format: int64 nullable: true - description: Internal task ID in the project, starts with 1 - total_annotations: type: integer + is_labeled: + description: True if the number of annotations for this task is greater than or equal to the number of maximum_completions for the project + type: boolean + last_comment_updated_at: + description: When the last comment was updated + format: date-time + nullable: true + type: string + meta: + description: Meta is user imported (uploaded) data and can be useful as input for an ML Backend for embeddings, advanced vectors, and other info. It is passed to ML during training/predicting steps. + nullable: true + overlap: + description: Number of distinct annotators that processed the current task maximum: 2147483647 minimum: -2147483648 - description: Number of total annotations for the current task except cancelled - annotations - cancelled_annotations: type: integer - maximum: 2147483647 - minimum: -2147483648 - description: Number of total cancelled annotations for the current task - total_predictions: + predictions: + default: [] + items: + $ref: '#/components/schemas/Prediction' + readOnly: true + type: array + project: + description: Project ID for this task + nullable: true type: integer + total_annotations: + description: Number of total annotations for the current task except cancelled annotations maximum: 2147483647 minimum: -2147483648 - description: Number of total predictions for the current task - comment_count: type: integer + total_predictions: + description: Number of total predictions for the current task maximum: 2147483647 minimum: -2147483648 - description: Number of comments in the task including all annotations - unresolved_comment_count: type: integer + unresolved_comment_count: + description: Number of unresolved comments in the task including all annotations maximum: 2147483647 minimum: -2147483648 - description: Number of unresolved comments in the task including all annotations - last_comment_updated_at: - type: string - format: date-time - nullable: true - description: When the last comment was updated - project: type: integer - nullable: true - description: Project ID for this task + updated_at: + description: Last time a task was updated + format: date-time + readOnly: true + type: string updated_by: - type: integer - nullable: true description: Last annotator or reviewer who updated this task - file_upload: - type: integer nullable: true - description: Uploaded file used as data source for this task - comment_authors: - type: array - items: - type: integer - description: Users who wrote comments - annotations: - type: array - items: - $ref: '#/components/schemas/Annotation' - readOnly: true - default: [] - predictions: - type: array - items: - $ref: '#/components/schemas/Prediction' - readOnly: true - default: [] + type: integer required: - - annotations - - created_at - - data - - id - - predictions - - updated_at - ThirdPartyModelVersion: + - annotations + - created_at + - data + - id + - predictions + - updated_at type: object + ThirdPartyModelVersion: properties: - id: - type: integer + created_at: + format: date-time readOnly: true + type: string created_by: allOf: - - $ref: '#/components/schemas/UserSimple' - readOnly: true + - $ref: '#/components/schemas/UserSimple' description: User who created Dataset - score: - type: string readOnly: true - parent_model: + id: + readOnly: true + type: integer + model_provider_connection: + nullable: true + type: integer + organization: + nullable: true type: integer + parent_model: description: Parent model interface ID - title: - type: string - description: Model name - maxLength: 500 + type: integer prompt: - type: string description: Prompt to execute + type: string provider: allOf: - - $ref: '#/components/schemas/ProviderEnum' + - $ref: '#/components/schemas/ProviderEnum' description: |- The model provider to use e.g. OpenAI @@ -26965,50 +26543,48 @@ components: * `Anthropic` - Anthropic * `Custom` - Custom provider_model_id: - type: string description: The model ID to use within the given provider, e.g. gpt-3.5 maxLength: 255 - created_at: type: string - format: date-time + score: readOnly: true - updated_at: type: string + title: + description: Model name + maxLength: 500 + type: string + updated_at: format: date-time readOnly: true + type: string + required: + - created_at + - created_by + - id + - prompt + - provider_model_id + - score + - title + - updated_at + type: object + ThirdPartyModelVersionRequest: + properties: model_provider_connection: - type: integer nullable: true - organization: type: integer + organization: nullable: true - required: - - created_at - - created_by - - id - - prompt - - provider_model_id - - score - - title - - updated_at - ThirdPartyModelVersionRequest: - type: object - properties: - parent_model: type: integer + parent_model: description: Parent model interface ID - title: - type: string - minLength: 1 - description: Model name - maxLength: 500 + type: integer prompt: - type: string - minLength: 1 description: Prompt to execute + minLength: 1 + type: string provider: allOf: - - $ref: '#/components/schemas/ProviderEnum' + - $ref: '#/components/schemas/ProviderEnum' description: |- The model provider to use e.g. OpenAI @@ -27020,53 +26596,44 @@ components: * `Anthropic` - Anthropic * `Custom` - Custom provider_model_id: - type: string - minLength: 1 description: The model ID to use within the given provider, e.g. gpt-3.5 maxLength: 255 - model_provider_connection: - type: integer - nullable: true - organization: - type: integer - nullable: true + minLength: 1 + type: string + title: + description: Model name + maxLength: 500 + minLength: 1 + type: string required: - - prompt - - provider_model_id - - title - TokenRefreshRequest: + - prompt + - provider_model_id + - title type: object + TokenRefreshRequest: properties: refresh: + minLength: 1 type: string writeOnly: true - minLength: 1 required: - - refresh - TokenRefreshResponse: + - refresh type: object + TokenRefreshResponse: properties: access: type: string required: - - access - TokenRotateResponse: + - access type: object + TokenRotateResponse: properties: refresh: type: string required: - - refresh + - refresh + type: object TrialRoleEnum: - enum: - - annotator - - annotator_team_manager - - business_analyst - - business_or_data_team_leadership - - data_engineer_platform_engineer - - data_scientist - - other - type: string description: |- * `annotator` - Annotator * `annotator_team_manager` - Annotator Team Manager @@ -27075,445 +26642,450 @@ components: * `data_engineer_platform_engineer` - Data Engineer Platform Engineer * `data_scientist` - Data Scientist * `other` - Other - TypeEnum: enum: - - AN - - RE + - annotator + - annotator_team_manager + - business_analyst + - business_or_data_team_leadership + - data_engineer_platform_engineer + - data_scientist + - other type: string + TypeEnum: description: |- * `AN` - Annotate * `RE` - Review + enum: + - AN + - RE + type: string UserSimple: - type: object description: |- 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: - type: integer + avatar: readOnly: true - first_name: - type: string - maxLength: 256 - last_name: type: string - maxLength: 256 email: - type: string format: email - title: Email address maxLength: 254 - avatar: + title: Email address + type: string + first_name: + maxLength: 256 type: string + id: readOnly: true + type: integer + last_name: + maxLength: 256 + type: string required: - - avatar - - id - UserSimpleRequest: + - avatar + - id type: object + UserSimpleRequest: description: |- 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: - first_name: + email: + format: email + maxLength: 254 + title: Email address type: string + first_name: maxLength: 256 - last_name: type: string + last_name: maxLength: 256 - email: type: string - format: email - title: Email address - maxLength: 254 - VersionResponse: type: object + VersionResponse: properties: - release: - type: string - description: Current release version of Label Studio - label-studio-os-package: - description: Information about the Label Studio open source package - label-studio-os-backend: - description: Information about the Label Studio backend - label-studio-frontend: - description: Information about the Label Studio frontend + backend: + description: Additional backend information dm2: description: Information about the Data Manager 2.0 component - label-studio-converter: - description: Information about the Label Studio converter component edition: allOf: - - $ref: '#/components/schemas/EditionEnum' + - $ref: '#/components/schemas/EditionEnum' description: |- Label Studio edition (Community or Enterprise) * `Community` - Community * `Enterprise` - Enterprise + label-studio-converter: + description: Information about the Label Studio converter component + label-studio-frontend: + description: Information about the Label Studio frontend + label-studio-os-backend: + description: Information about the Label Studio backend + label-studio-os-package: + description: Information about the Label Studio open source package lsf: description: Information about the Label Studio Frontend library - backend: - description: Additional backend information + release: + description: Current release version of Label Studio + type: string required: - - backend - - dm2 - - edition - - label-studio-converter - - label-studio-frontend - - label-studio-os-backend - - label-studio-os-package - - lsf - - release - View: + - backend + - dm2 + - edition + - label-studio-converter + - label-studio-frontend + - label-studio-os-backend + - label-studio-os-package + - lsf + - release type: object + View: properties: - id: - type: integer - readOnly: true - filter_group: - $ref: '#/components/schemas/FilterGroup' data: - nullable: true description: Custom view data - ordering: nullable: true - description: Ordering parameters - order: + filter_group: + $ref: '#/components/schemas/FilterGroup' + id: + readOnly: true type: integer + order: + description: Position of the tab, starting at the left in data manager and increasing as the tabs go left to right maximum: 2147483647 minimum: -2147483648 nullable: true - description: Position of the tab, starting at the left in data manager and - increasing as the tabs go left to right - selected_items: + type: integer + ordering: + description: Ordering parameters nullable: true - description: Selected items - user: + project: + description: Project ID type: integer + selected_items: + description: Selected items nullable: true + user: description: User who made this view - project: + nullable: true type: integer - description: Project ID required: - - id - - project - ViewOrderRequest: + - id + - project type: object + ViewOrderRequest: properties: - project: - type: integer ids: - type: array + description: A list of view IDs in the desired order. items: type: integer - description: A list of view IDs in the desired order. + type: array + project: + type: integer required: - - ids - - project - Webhook: + - ids + - project type: object + Webhook: properties: + actions: + default: [] + items: + $ref: '#/components/schemas/ActionsEnum' + type: array + created_at: + description: Creation time + format: date-time + readOnly: true + type: string + headers: + description: Key Value Json of headers + title: Request extra headers of webhook id: - type: integer readOnly: true - organization: type: integer + is_active: + description: If value is False the webhook is disabled + title: Is webhook active + type: boolean + organization: readOnly: true - project: type: integer + project: nullable: true - url: - type: string - format: uri - title: URL of webhook - description: URL of webhook - maxLength: 2048 - send_payload: - type: boolean - title: Does webhook send the payload - description: If value is False send only action + type: integer send_for_all_actions: - type: boolean - title: Use webhook for all actions description: If value is False - used only for actions from WebhookAction - headers: - title: Request extra headers of webhook - description: Key Value Json of headers - is_active: + title: Use webhook for all actions + type: boolean + send_payload: + description: If value is False send only action + title: Does webhook send the payload type: boolean - title: Is webhook active - description: If value is False the webhook is disabled - actions: - type: array - items: - $ref: '#/components/schemas/ActionsEnum' - default: [] - created_at: - type: string - format: date-time - readOnly: true - description: Creation time updated_at: - type: string + description: Last update time format: date-time readOnly: true - description: Last update time + type: string + url: + description: URL of webhook + format: uri + maxLength: 2048 + title: URL of webhook + type: string required: - - created_at - - id - - organization - - updated_at - - url - WebhookRequest: + - created_at + - id + - organization + - updated_at + - url type: object + WebhookRequest: properties: + actions: + default: [] + items: + $ref: '#/components/schemas/ActionsEnum' + type: array + headers: + description: Key Value Json of headers + title: Request extra headers of webhook + is_active: + description: If value is False the webhook is disabled + title: Is webhook active + type: boolean project: - type: integer nullable: true + type: integer + send_for_all_actions: + description: If value is False - used only for actions from WebhookAction + title: Use webhook for all actions + type: boolean + send_payload: + description: If value is False send only action + title: Does webhook send the payload + type: boolean url: - type: string + description: URL of webhook format: uri + maxLength: 2048 minLength: 1 title: URL of webhook - description: URL of webhook - maxLength: 2048 - send_payload: - type: boolean - title: Does webhook send the payload - description: If value is False send only action - send_for_all_actions: - type: boolean - title: Use webhook for all actions - description: If value is False - used only for actions from WebhookAction - headers: - title: Request extra headers of webhook - description: Key Value Json of headers - is_active: - type: boolean - title: Is webhook active - description: If value is False the webhook is disabled - actions: - type: array - items: - $ref: '#/components/schemas/ActionsEnum' - default: [] + type: string required: - - url - WebhookSerializerForUpdate: + - url type: object + WebhookSerializerForUpdate: description: |- Serializer class for updating webhooks Used to forbid updating project field. properties: + actions: + default: [] + items: + $ref: '#/components/schemas/ActionsEnum' + type: array + created_at: + description: Creation time + format: date-time + readOnly: true + type: string + headers: + description: Key Value Json of headers + title: Request extra headers of webhook id: - type: integer readOnly: true - organization: type: integer + is_active: + description: If value is False the webhook is disabled + title: Is webhook active + type: boolean + organization: readOnly: true - project: type: integer - readOnly: true + project: nullable: true - url: - type: string - format: uri - title: URL of webhook - description: URL of webhook - maxLength: 2048 - send_payload: - type: boolean - title: Does webhook send the payload - description: If value is False send only action + readOnly: true + type: integer send_for_all_actions: - type: boolean - title: Use webhook for all actions description: If value is False - used only for actions from WebhookAction - headers: - title: Request extra headers of webhook - description: Key Value Json of headers - is_active: + title: Use webhook for all actions + type: boolean + send_payload: + description: If value is False send only action + title: Does webhook send the payload type: boolean - title: Is webhook active - description: If value is False the webhook is disabled - actions: - type: array - items: - $ref: '#/components/schemas/ActionsEnum' - default: [] - created_at: - type: string - format: date-time - readOnly: true - description: Creation time updated_at: - type: string + description: Last update time format: date-time readOnly: true - description: Last update time + type: string + url: + description: URL of webhook + format: uri + maxLength: 2048 + title: URL of webhook + type: string required: - - created_at - - id - - organization - - project - - updated_at - - url - WebhookSerializerForUpdateRequest: + - created_at + - id + - organization + - project + - updated_at + - url type: object + WebhookSerializerForUpdateRequest: description: |- Serializer class for updating webhooks Used to forbid updating project field. properties: - url: - type: string - format: uri - minLength: 1 - title: URL of webhook - description: URL of webhook - maxLength: 2048 - send_payload: - type: boolean - title: Does webhook send the payload - description: If value is False send only action - send_for_all_actions: - type: boolean - title: Use webhook for all actions - description: If value is False - used only for actions from WebhookAction + actions: + default: [] + items: + $ref: '#/components/schemas/ActionsEnum' + type: array headers: - title: Request extra headers of webhook description: Key Value Json of headers + title: Request extra headers of webhook is_active: - type: boolean - title: Is webhook active description: If value is False the webhook is disabled - actions: - type: array - items: - $ref: '#/components/schemas/ActionsEnum' - default: [] + title: Is webhook active + type: boolean + send_for_all_actions: + description: If value is False - used only for actions from WebhookAction + title: Use webhook for all actions + type: boolean + send_payload: + description: If value is False send only action + title: Does webhook send the payload + type: boolean + url: + description: URL of webhook + format: uri + maxLength: 2048 + minLength: 1 + title: URL of webhook + type: string required: - - url - Workspace: + - url type: object + Workspace: description: |- 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: - type: integer - readOnly: true - title: + color: + maxLength: 16 + nullable: true type: string - description: Workspace name - maxLength: 1000 + created_by: + readOnly: true + type: integer description: - type: string - nullable: true description: Workspace description - color: - type: string nullable: true - maxLength: 16 - is_personal: + type: string + id: + readOnly: true + type: integer + is_archived: + description: Workspace is archived + title: Archived type: boolean - title: Personal + is_personal: description: Workspace is a personal user workspace - is_archived: + title: Personal type: boolean - title: Archived - description: Workspace is archived - created_by: - type: integer - readOnly: true + title: + description: Workspace name + maxLength: 1000 + type: string required: - - created_by - - id - - title - WorkspaceMemberCreate: + - created_by + - id + - title type: object + WorkspaceMemberCreate: properties: user: - type: integer description: User ID - workspace: type: integer + workspace: description: Workspace ID + type: integer required: - - user - WorkspaceMemberCreateRequest: + - user type: object + WorkspaceMemberCreateRequest: properties: user: - type: integer description: User ID - workspace: type: integer + workspace: description: Workspace ID + type: integer required: - - user - WorkspaceMemberList: + - user type: object + WorkspaceMemberList: properties: user: $ref: '#/components/schemas/LseUser' workspace: - type: integer description: Workspace ID + type: integer required: - - user - WorkspaceRequest: + - user type: object + WorkspaceRequest: description: |- 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: - title: + color: + maxLength: 16 + nullable: true type: string - minLength: 1 - description: Workspace name - maxLength: 1000 description: - type: string - nullable: true description: Workspace description - color: - type: string nullable: true - maxLength: 16 - is_personal: + type: string + is_archived: + description: Workspace is archived + title: Archived type: boolean - title: Personal + is_personal: description: Workspace is a personal user workspace - is_archived: + title: Personal type: boolean - title: Archived - description: Workspace is archived + title: + description: Workspace name + maxLength: 1000 + minLength: 1 + type: string required: - - title + - title + type: object securitySchemes: Token: - type: apiKey - name: Authorization + description: 'The token (or API key) must be passed as a request header. You can find your user token on the User Account page in Label Studio. Example: 
    curl https://label-studio-host/api/projects -H "Authorization: Token [your-token]"
    ' in: header - description: 'The token (or API key) must be passed as a request header. You - can find your user token on the User Account page in Label Studio. Example: - 
    curl https://label-studio-host/api/projects
-        -H "Authorization: Token [your-token]"
    ' + name: Authorization + type: apiKey x-fern-header: - name: api_key env: LABEL_STUDIO_API_KEY + name: api_key prefix: 'Token ' servers: -- url: http://localhost:8000 - description: Label Studio + - description: Label Studio + url: http://localhost:8000