Skip to content

Commit 64eea73

Browse files
fern-api[bot]fern-api[bot]
authored
🌿 Fern Regeneration -- June 18, 2024 (#250)
* SDK regeneration * SDK regeneration * SDK regeneration * SDK regeneration --------- Co-authored-by: fern-api <115122769+fern-api[bot]@users.noreply.github.com>
1 parent a67c59c commit 64eea73

32 files changed

+1083
-166
lines changed

‎.mock/definition/__package__.yml

+173-8
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,19 @@
11
errors:
2+
BadRequestError:
3+
status-code: 400
4+
type: unknown
5+
NotFoundError:
6+
status-code: 404
7+
type: unknown
8+
docs: Project not found
29
InternalServerError:
310
status-code: 500
411
type: string
512
docs: Predicting error
6-
NotFoundError:
7-
status-code: 404
8-
type: unknown
9-
docs: Member not found
1013
MethodNotAllowedError:
1114
status-code: 405
1215
type: unknown
1316
docs: User cannot soft delete self.
14-
BadRequestError:
15-
status-code: 400
16-
type: string
17-
docs: ''
1817
types:
1918
AnnotationLastAction:
2019
enum:
@@ -1564,6 +1563,172 @@ types:
15641563
comment_authors:
15651564
type: optional<list<integer>>
15661565
docs: Users who wrote comments
1566+
AnnotationsDmFieldLastAction:
1567+
enum:
1568+
- prediction
1569+
- propagated_annotation
1570+
- imported
1571+
- submitted
1572+
- updated
1573+
- skipped
1574+
- accepted
1575+
- rejected
1576+
- fixed_and_accepted
1577+
- deleted_review
1578+
docs: Action which was performed in the last annotation history item
1579+
AnnotationsDmField:
1580+
properties:
1581+
id: optional<integer>
1582+
result:
1583+
type: optional<list<map<string, unknown>>>
1584+
docs: List of annotation results for the task
1585+
created_username:
1586+
type: optional<string>
1587+
docs: Username string
1588+
created_ago:
1589+
type: optional<string>
1590+
docs: Time delta from creation time
1591+
default: ''
1592+
validation:
1593+
minLength: 1
1594+
completed_by:
1595+
type: optional<map<string, unknown>>
1596+
docs: User details who completed this annotation.
1597+
unique_id:
1598+
type: optional<string>
1599+
validation:
1600+
minLength: 1
1601+
was_cancelled:
1602+
type: optional<boolean>
1603+
docs: User skipped the task
1604+
ground_truth:
1605+
type: optional<boolean>
1606+
docs: This annotation is a Ground Truth (ground_truth)
1607+
created_at:
1608+
type: optional<datetime>
1609+
docs: Creation time
1610+
updated_at:
1611+
type: optional<datetime>
1612+
docs: Last updated time
1613+
draft_created_at:
1614+
type: optional<datetime>
1615+
docs: Draft creation time
1616+
lead_time:
1617+
type: optional<double>
1618+
docs: How much time it took to annotate the task
1619+
import_id:
1620+
type: optional<integer>
1621+
docs: >-
1622+
Original annotation ID that was at the import step or NULL if this
1623+
annotation wasn't imported
1624+
last_action:
1625+
type: optional<AnnotationsDmFieldLastAction>
1626+
docs: Action which was performed in the last annotation history item
1627+
task:
1628+
type: optional<integer>
1629+
docs: Corresponding task for this annotation
1630+
project:
1631+
type: optional<integer>
1632+
docs: Project ID for this annotation
1633+
updated_by:
1634+
type: optional<integer>
1635+
docs: Last user who updated this annotation
1636+
parent_prediction:
1637+
type: optional<integer>
1638+
docs: Points to the prediction from which this annotation was created
1639+
parent_annotation:
1640+
type: optional<integer>
1641+
docs: Points to the parent annotation from which this annotation was created
1642+
last_created_by:
1643+
type: optional<integer>
1644+
docs: User who created the last annotation history item
1645+
DataManagerTaskSerializerPredictionsItem:
1646+
properties:
1647+
result: optional<list<map<string, unknown>>>
1648+
score: optional<double>
1649+
model_version: optional<string>
1650+
model: optional<map<string, unknown>>
1651+
model_run: optional<map<string, unknown>>
1652+
task: optional<integer>
1653+
project: optional<double>
1654+
created_at: optional<datetime>
1655+
updated_at: optional<datetime>
1656+
DataManagerTaskSerializerDraftsItem:
1657+
properties:
1658+
result: optional<list<map<string, unknown>>>
1659+
created_at: optional<datetime>
1660+
updated_at: optional<datetime>
1661+
DataManagerTaskSerializer:
1662+
properties:
1663+
id: optional<integer>
1664+
predictions:
1665+
type: optional<list<DataManagerTaskSerializerPredictionsItem>>
1666+
docs: Predictions for this task
1667+
annotations: optional<list<AnnotationsDmField>>
1668+
drafts:
1669+
type: optional<list<DataManagerTaskSerializerDraftsItem>>
1670+
docs: Drafts for this task
1671+
annotators:
1672+
type: optional<list<integer>>
1673+
docs: Annotators IDs who annotated this task
1674+
inner_id: optional<integer>
1675+
cancelled_annotations: optional<integer>
1676+
total_annotations: optional<integer>
1677+
total_predictions: optional<integer>
1678+
completed_at: optional<datetime>
1679+
annotations_results: optional<string>
1680+
predictions_results: optional<string>
1681+
predictions_score: optional<double>
1682+
file_upload: optional<string>
1683+
storage_filename: optional<string>
1684+
annotations_ids: optional<string>
1685+
predictions_model_versions: optional<string>
1686+
avg_lead_time: optional<double>
1687+
draft_exists: optional<boolean>
1688+
updated_by:
1689+
type: optional<list<map<string, unknown>>>
1690+
docs: User IDs who updated this task
1691+
data:
1692+
docs: >-
1693+
User imported or uploaded data for a task. Data is formatted according
1694+
to the project label config. You can find examples of data for your
1695+
project on the Import page in the Label Studio Data Manager UI.
1696+
type: map<string, unknown>
1697+
meta:
1698+
type: optional<map<string, unknown>>
1699+
docs: >-
1700+
Meta is user imported (uploaded) data and can be useful as input for
1701+
an ML Backend for embeddings, advanced vectors, and other info. It is
1702+
passed to ML during training/predicting steps.
1703+
created_at:
1704+
type: optional<datetime>
1705+
docs: Time a task was created
1706+
updated_at:
1707+
type: optional<datetime>
1708+
docs: Last time a task was updated
1709+
is_labeled:
1710+
type: optional<boolean>
1711+
docs: >-
1712+
True if the number of annotations for this task is greater than or
1713+
equal to the number of maximum_completions for the project
1714+
overlap:
1715+
type: optional<integer>
1716+
docs: Number of distinct annotators that processed the current task
1717+
comment_count:
1718+
type: optional<integer>
1719+
docs: Number of comments in the task including all annotations
1720+
unresolved_comment_count:
1721+
type: optional<integer>
1722+
docs: Number of unresolved comments in the task including all annotations
1723+
last_comment_updated_at:
1724+
type: optional<datetime>
1725+
docs: When the last comment was updated
1726+
project:
1727+
type: optional<integer>
1728+
docs: Project ID for this task
1729+
comment_authors:
1730+
type: optional<list<integer>>
1731+
docs: Users who wrote comments
15671732
WebhookActionsItem:
15681733
enum:
15691734
- PROJECT_CREATED

‎.mock/definition/actions.yml

+55-15
Original file line numberDiff line numberDiff line change
@@ -18,18 +18,22 @@ service:
1818
path: /api/dm/actions/
1919
method: POST
2020
auth: true
21-
docs: Perform a Data Manager action with the selected tasks and filters.
21+
docs: >-
22+
Perform a Data Manager action with the selected tasks and filters. Note:
23+
More complex actions require additional parameters in the request body.
24+
Call `GET api/actions?project=<id>` to explore them. <br>Example: `GET
25+
api/actions?id=delete_tasks&project=1`
2226
display-name: Post actions
2327
request:
2428
name: ActionsCreateRequest
2529
query-parameters:
2630
id:
27-
type: optional<ActionsCreateRequestId>
31+
type: ActionsCreateRequestId
2832
docs: >-
29-
Action name ID, the full list of actions can be retrieved with a
30-
GET request
33+
Action name ID, see the full list of actions in the `GET
34+
api/actions` request
3135
project:
32-
type: optional<integer>
36+
type: integer
3337
docs: Project ID
3438
view:
3539
type: optional<integer>
@@ -62,7 +66,25 @@ service:
6266
without the `filter:` prefix. To reverse the order, add a minus
6367
sign before the field name, e.g. `-tasks:created_at`.
6468
examples:
65-
- request: {}
69+
- query-parameters:
70+
id: retrieve_tasks_predictions
71+
project: 1
72+
request:
73+
filters:
74+
conjunction: or
75+
items:
76+
- filter: filter:tasks:id
77+
operator: greater
78+
type: Number
79+
value: 123
80+
selectedItems:
81+
all: true
82+
excluded:
83+
- 124
84+
- 125
85+
- 126
86+
ordering:
87+
- tasks:total_annotations
6688
audiences:
6789
- public
6890
types:
@@ -136,9 +158,11 @@ types:
136158
docs: >-
137159
Filter identifier, it should start with `filter:tasks:` prefix, e.g.
138160
`filter:tasks:agreement`. For `task.data` fields it may look like
139-
`filter:tasks:data.field_name`. Possible
140-
values:<br><li>`filter:tasks:agreement`<br> (Number) Agreement for
141-
annotation results for a specific task (Enterprise
161+
`filter:tasks:data.field_name`. If you need more info about columns, check
162+
the [Get data manager
163+
columns](#tag/Data-Manager/operation/api_dm_columns_list) API endpoint.
164+
Possible values:<br><li>`filter:tasks:agreement`<br> (Number) Agreement
165+
for annotation results for a specific task (Enterprise
142166
only)</li><br><li>`filter:tasks:annotations_results`<br> (String)
143167
Annotation results for the tasks</li><br><li>`filter:tasks:annotators`<br>
144168
(List) Annotators that completed the task (Community). Can include
@@ -207,18 +231,34 @@ types:
207231
to</li><br><li>`not_exists`<br> Does not exist</li><br><li>`not_in`<br> Is
208232
not between min and max values, so the filter `value` should be e.g.
209233
`{"min": 1, "max": 7}`</li><br><li>`starts_with`<br> Starts with</li>
234+
ActionsCreateRequestFiltersItemsItemValue:
235+
discriminated: false
236+
docs: Value to filter by
237+
union:
238+
- type: string
239+
docs: String
240+
- type: integer
241+
docs: Integer
242+
- type: double
243+
docs: Float
244+
- type: boolean
245+
docs: Boolean
246+
- docs: List of strings or integers
247+
type: map<string, unknown>
210248
ActionsCreateRequestFiltersItemsItem:
211249
properties:
212250
filter:
213251
type: ActionsCreateRequestFiltersItemsItemFilter
214252
docs: >-
215253
Filter identifier, it should start with `filter:tasks:` prefix, e.g.
216254
`filter:tasks:agreement`. For `task.data` fields it may look like
217-
`filter:tasks:data.field_name`. Possible
218-
values:<br><li>`filter:tasks:agreement`<br> (Number) Agreement for
219-
annotation results for a specific task (Enterprise
220-
only)</li><br><li>`filter:tasks:annotations_results`<br> (String)
221-
Annotation results for the
255+
`filter:tasks:data.field_name`. If you need more info about columns,
256+
check the [Get data manager
257+
columns](#tag/Data-Manager/operation/api_dm_columns_list) API
258+
endpoint. Possible values:<br><li>`filter:tasks:agreement`<br>
259+
(Number) Agreement for annotation results for a specific task
260+
(Enterprise only)</li><br><li>`filter:tasks:annotations_results`<br>
261+
(String) Annotation results for the
222262
tasks</li><br><li>`filter:tasks:annotators`<br> (List) Annotators that
223263
completed the task (Community). Can include assigned annotators
224264
(Enterprise only). Important note: the filter `type` should be List,
@@ -284,7 +324,7 @@ types:
284324
Integer</li><br><li>`String`<br> String</li><br><li>`Unknown`<br>
285325
Unknown is explicitly converted to string format</li>
286326
value:
287-
type: string
327+
type: ActionsCreateRequestFiltersItemsItemValue
288328
docs: Value to filter by
289329
ActionsCreateRequestFilters:
290330
docs: >-

0 commit comments

Comments
 (0)