Skip to content

Commit b6727ad

Browse files
committed
feat: add support for optional metadata in task creation and updates
1 parent e39c27e commit b6727ad

2 files changed

Lines changed: 162 additions & 12 deletions

File tree

README.md

Lines changed: 72 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ task_id = client.create_image_task(
9999
)
100100
```
101101

102-
Create a new task with pre-defined annotations. (Class should be configured on your project in advance)
102+
Create a new task with pre-defined annotations and metadatas. (Class and metadata should be configured on your project in advance)
103103

104104
```python
105105
task_id = client.create_image_task(
@@ -122,7 +122,13 @@ task_id = client.create_image_task(
122122
200, # bottom-right x
123123
200 # bottom-right y
124124
]
125-
}]
125+
}],
126+
metadatas=[ # (optional) pre-defined metadata key-value pairs
127+
{
128+
"key": "metadata_key",
129+
"value": "metadata_value"
130+
}
131+
]
126132
)
127133
```
128134

@@ -265,6 +271,12 @@ task_id = client.update_image_task(
265271
"startIndex": 2,
266272
"endIndex": 0
267273
}
274+
],
275+
metadatas=[ # (optional) metadata key-value pairs (metadata should be configured on your project in advance)
276+
{
277+
"key": "metadata_key",
278+
"value": "metadata_value"
279+
}
268280
]
269281
)
270282
```
@@ -863,7 +875,7 @@ task_id = client.create_video_task(
863875
)
864876
```
865877

866-
Create a new task with pre-defined annotations. (Class should be configured on your project in advance)
878+
Create a new task with pre-defined annotations and metadatas. (Class and metadata should be configured on your project in advance)
867879

868880
```python
869881
task_id = client.create_video_task(
@@ -905,7 +917,13 @@ task_id = client.create_video_task(
905917
"autogenerated": False
906918
}
907919
}
908-
}]
920+
}],
921+
metadatas=[ # (optional) pre-defined metadata key-value pairs
922+
{
923+
"key": "metadata_key",
924+
"value": "metadata_value"
925+
}
926+
]
909927
)
910928
```
911929

@@ -980,7 +998,13 @@ task_id = client.update_video_task(
980998
"autogenerated": False
981999
}
9821000
}
983-
}]
1001+
}],
1002+
metadatas=[ # (optional) metadata key-value pairs
1003+
{
1004+
"key": "metadata_key",
1005+
"value": "metadata_value"
1006+
}
1007+
]
9841008
)
9851009
```
9861010

@@ -1165,7 +1189,7 @@ task_id = client.create_text_task(
11651189
)
11661190
```
11671191

1168-
Create a new task with pre-defined annotations. (Class should be configured on your project in advance)
1192+
Create a new task with pre-defined annotations and metadatas. (Class and metadata should be configured on your project in advance)
11691193

11701194
```python
11711195
task_id = client.create_text_task(
@@ -1179,7 +1203,13 @@ task_id = client.create_text_task(
11791203
"start": 0,
11801204
"end": 10,
11811205
"text": "1234567890"
1182-
}]
1206+
}],
1207+
metadatas=[ # (optional) pre-defined metadata key-value pairs
1208+
{
1209+
"key": "metadata_key",
1210+
"value": "metadata_value"
1211+
}
1212+
]
11831213
)
11841214
```
11851215

@@ -1226,7 +1256,13 @@ task_id = client.update_text_task(
12261256
"start": 0,
12271257
"end": 10,
12281258
"text": "0123456789"
1229-
}]
1259+
}],
1260+
metadatas=[ # (optional) metadata key-value pairs
1261+
{
1262+
"key": "metadata_key",
1263+
"value": "metadata_value"
1264+
}
1265+
]
12301266
)
12311267
```
12321268

@@ -1353,7 +1389,7 @@ task_id = client.create_audio_task(
13531389
)
13541390
```
13551391

1356-
Create a new task with pre-defined annotations. (Class should be configured on your project in advance)
1392+
Create a new task with pre-defined annotations and metadatas. (Class and metadata should be configured on your project in advance)
13571393

13581394
```python
13591395
task_id = client.create_audio_task(
@@ -1366,7 +1402,13 @@ task_id = client.create_audio_task(
13661402
"value": "person",
13671403
"start": 0.4,
13681404
"end": 0.5
1369-
}]
1405+
}],
1406+
metadatas=[ # (optional) pre-defined metadata key-value pairs
1407+
{
1408+
"key": "metadata_key",
1409+
"value": "metadata_value"
1410+
}
1411+
]
13701412
)
13711413
```
13721414

@@ -1412,7 +1454,13 @@ task_id = client.update_audio_task(
14121454
"value": "bird",
14131455
"start": 0.4,
14141456
"end": 0.5
1415-
}]
1457+
}],
1458+
metadatas=[ # (optional) metadata key-value pairs
1459+
{
1460+
"key": "metadata_key",
1461+
"value": "metadata_value"
1462+
}
1463+
]
14161464
)
14171465
```
14181466

@@ -1589,7 +1637,7 @@ task_id = client.create_pcd_task(
15891637
)
15901638
```
15911639

1592-
Create a new task with pre-defined annotations. (Class should be configured on your project in advance)
1640+
Create a new task with pre-defined annotations and metadatas. (Class and metadata should be configured on your project in advance)
15931641

15941642
Annotation Type: cuboid
15951643

@@ -1616,6 +1664,12 @@ task_id = client.create_pcd_task(
16161664
],
16171665
}
16181666
],
1667+
metadatas=[ # (optional) pre-defined metadata key-value pairs
1668+
{
1669+
"key": "metadata_key",
1670+
"value": "metadata_value"
1671+
}
1672+
]
16191673
)
16201674
```
16211675

@@ -1691,6 +1745,12 @@ task_id = client.update_pcd_task(
16911745
],
16921746
}
16931747
],
1748+
metadatas=[ # (optional) metadata key-value pairs
1749+
{
1750+
"key": "metadata_key",
1751+
"value": "metadata_value"
1752+
}
1753+
]
16941754
)
16951755
```
16961756

0 commit comments

Comments
 (0)