Skip to content

#10703 メタデータのSDK対応 #258

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rikunosuke merged 4 commits into from
Jan 21, 2026
+290 −19
Merged

#10703 メタデータのSDK対応 #258

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a43c001
feat: get_metadatas method
kmkkiii Jan 14, 2026
7cabf41
feat: add support for optional metadata in task creation and updates
kmkkiii Jan 14, 2026
ce37882
feat: add optional metadata parameter to robotics task creation
kmkkiii Jan 16, 2026
a947212
chore: update REAMDE.md
kmkkiii Jan 16, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
177 changes: 158 additions & 19 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@
- [Common](#common)
- [Appendix](#appendix)
- [Annotation](#annotation)
- [Metadata](#metadata)
- [Project](#project)
- [Dataset](#dataset)
- [Converter](#converter)
Expand Down Expand Up @@ -99,7 +100,7 @@ task_id = client.create_image_task(
)
```

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

```python
task_id = client.create_image_task(
Expand All @@ -122,7 +123,13 @@ task_id = client.create_image_task(
200, # bottom-right x
200 # bottom-right y
]
}]
}],
metadatas=[ # (optional) pre-defined metadata key-value pairs
{
"key": "metadata_key",
"value": "metadata_value"
}
]
)
```

Expand All @@ -145,10 +152,10 @@ task_id = client.create_integrated_image_task(
)
```

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

```python
task_id = client.create_image_task(
task_id = client.create_integrated_image_task(
project="YOUR_PROJECT_SLUG",
file_path="<integrated-storage-dir>/sample.jpg",
storage_type="gcp",
Expand All @@ -167,7 +174,13 @@ task_id = client.create_image_task(
200, # bottom-right x
200 # bottom-right y
]
}]
}],
metadatas=[ # (optional) pre-defined metadata key-value pairs
{
"key": "metadata_key",
"value": "some_value"
}
]
)
```

Expand Down Expand Up @@ -265,6 +278,12 @@ task_id = client.update_image_task(
"startIndex": 2,
"endIndex": 0
}
],
metadatas=[ # (optional) metadata key-value pairs (metadata should be configured on your project in advance)
{
"key": "metadata_key",
"value": "metadata_value"
}
]
)
```
Expand Down Expand Up @@ -735,7 +754,13 @@ task = client.create_sequential_image_task(
100,
100
]]] # clockwise rotation
}]
}],
metadatas=[ # (optional) pre-defined metadata key-value pairs
{
"key": "metadata_key",
"value": "some_value"
}
]
)
```

Expand Down Expand Up @@ -788,6 +813,12 @@ task_id = client.update_sequential_image_task(
],
"points": [990, 560, 980, 550]
}
],
metadatas=[ # (optional) metadata key-value pairs
{
"key": "metadata_key",
"value": "metadata_value"
}
]
)
```
Expand Down Expand Up @@ -863,7 +894,7 @@ task_id = client.create_video_task(
)
```

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

```python
task_id = client.create_video_task(
Expand Down Expand Up @@ -905,7 +936,13 @@ task_id = client.create_video_task(
"autogenerated": False
}
}
}]
}],
metadatas=[ # (optional) pre-defined metadata key-value pairs
{
"key": "metadata_key",
"value": "metadata_value"
}
]
)
```

Expand Down Expand Up @@ -980,7 +1017,13 @@ task_id = client.update_video_task(
"autogenerated": False
}
}
}]
}],
metadatas=[ # (optional) metadata key-value pairs
{
"key": "metadata_key",
"value": "metadata_value"
}
]
)
```

Expand Down Expand Up @@ -1165,7 +1208,7 @@ task_id = client.create_text_task(
)
```

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

```python
task_id = client.create_text_task(
Expand All @@ -1179,7 +1222,13 @@ task_id = client.create_text_task(
"start": 0,
"end": 10,
"text": "1234567890"
}]
}],
metadatas=[ # (optional) pre-defined metadata key-value pairs
{
"key": "metadata_key",
"value": "metadata_value"
}
]
)
```

Expand Down Expand Up @@ -1226,7 +1275,13 @@ task_id = client.update_text_task(
"start": 0,
"end": 10,
"text": "0123456789"
}]
}],
metadatas=[ # (optional) metadata key-value pairs
{
"key": "metadata_key",
"value": "metadata_value"
}
]
)
```

Expand Down Expand Up @@ -1353,7 +1408,7 @@ task_id = client.create_audio_task(
)
```

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

```python
task_id = client.create_audio_task(
Expand All @@ -1366,7 +1421,13 @@ task_id = client.create_audio_task(
"value": "person",
"start": 0.4,
"end": 0.5
}]
}],
metadatas=[ # (optional) pre-defined metadata key-value pairs
{
"key": "metadata_key",
"value": "metadata_value"
}
]
)
```

Expand Down Expand Up @@ -1412,7 +1473,13 @@ task_id = client.update_audio_task(
"value": "bird",
"start": 0.4,
"end": 0.5
}]
}],
metadatas=[ # (optional) metadata key-value pairs
{
"key": "metadata_key",
"value": "metadata_value"
}
]
)
```

Expand Down Expand Up @@ -1589,7 +1656,7 @@ task_id = client.create_pcd_task(
)
```

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

Annotation Type: cuboid

Expand All @@ -1616,6 +1683,12 @@ task_id = client.create_pcd_task(
],
}
],
metadatas=[ # (optional) pre-defined metadata key-value pairs
{
"key": "metadata_key",
"value": "metadata_value"
}
]
)
```

Expand Down Expand Up @@ -1691,6 +1764,12 @@ task_id = client.update_pcd_task(
],
}
],
metadatas=[ # (optional) metadata key-value pairs
{
"key": "metadata_key",
"value": "metadata_value"
}
]
)
```

Expand Down Expand Up @@ -1816,6 +1895,12 @@ task_id = client.create_sequential_pcd_task(
},
},
},
],
metadatas=[ # (optional) pre-defined metadata key-value pairs
{
"key": "metadata_key",
"value": "some_value"
}
]
)
```
Expand Down Expand Up @@ -1892,6 +1977,12 @@ task_id = client.update_sequential_pcd_task(
},
},
},
],
metadatas=[ # (optional) metadata key-value pairs
{
"key": "metadata_key",
"value": "metadata_value"
}
]
)
```
Expand Down Expand Up @@ -1988,7 +2079,13 @@ Once you receive the status completed, you can get the task.
```python
history = client.create_dicom_task(
project="YOUR_PROJECT_SLUG",
file_path="./sample.zip"
file_path="./sample.zip",
metadatas=[ # (optional) pre-defined metadata key-value pairs
{
"key": "metadata_key",
"value": "some_value"
}
]
)
```

Expand Down Expand Up @@ -2027,7 +2124,13 @@ task_id = client.update_dicom_task(
task_id="YOUR_TASK_ID",
status="approved",
assignee="USER_SLUG",
tags=["tag1", "tag2"]
tags=["tag1", "tag2"],
metadatas=[ # (optional) metadata key-value pairs
{
"key": "metadata_key",
"value": "metadata_value"
}
]
)
```

Expand Down Expand Up @@ -2079,6 +2182,12 @@ Create a new task (Content creation is required separately).
task_id = client.create_robotics_task(
project="YOUR_PROJECT_SLUG",
name="TASK_NAME",
metadatas=[ # (optional) pre-defined metadata key-value pairs
{
"key": "metadata_key",
"value": "some_value"
}
]
)
```

Expand Down Expand Up @@ -2512,6 +2621,35 @@ Delete an annotation.
client.delete_annotation(annotation_id="YOUR_ANNOTATION_ID")
```

## Metadata

### Get Metadatas

Get metadatas. (Up to 1000 metadatas)

```python
metadatas = client.get_metadatas(project="YOUR_PROJECT_SLUG")
```

### Response

Example of a metadata object

```python
{
"id": "YOUR_METADATA_ID",
"key": "YOUR_METADATA_KEY",
"type": "text",
"options": [],
"defaultValue": "",
"order": 1,
"isAdmin": True,
"isRequired": False,
"createdAt": "2021-04-20T03:20:41.427Z",
"updatedAt": "2021-04-20T03:20:41.427Z",
}
```

## Project

### Create Project
Expand Down Expand Up @@ -2622,8 +2760,9 @@ result = client.update_project_user_permission(
```

Available roles:

- `annotator`: Annotator
- `reviewer`: Reviewer
- `reviewer`: Reviewer
- `owner`: Project owner
- `none`: Remove user from project

Expand Down
8 changes: 8 additions & 0 deletions examples/get_metadatas.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
from pprint import pprint

import fastlabel

client = fastlabel.Client()

metadatas = client.get_metadatas(project="robotics-task-classification")
pprint(metadatas)
Loading