Update a time range annotation
PATCH
/v1/datasets/{datasetId}/time-range-annotations/{annotationId}curl -X PATCH 'https://api.embodiflow.io/v1/datasets/{datasetId}/time-range-annotations/{annotationId}' \
-H 'Authorization: Bearer $EMBODIFLOW_PAT' \
-H 'Content-Type: application/json' \
-d '{
"datasetVersionId": "00000000-0000-0000-0000-000000000000",
"annotationSchemaId": "00000000-0000-0000-0000-000000000000",
"segmentKind": "action",
"startSec": 0,
"startNsec": 0,
"endSec": 0,
"endNsec": 0,
"timeReference": "string",
"title": "string",
"naturalLanguageInstruction": "string",
"success": true,
"score": 0,
"failureReason": "string",
"parentId": "00000000-0000-0000-0000-000000000000",
"orderIndex": 0,
"reviewStatus": "string",
"status": "string",
"attributesJson": {}
}'认证
每个请求都需要携带个人访问令牌(PAT)。
- Authorization: Bearer PAT
路径参数
- datasetIdstring必填
- annotationIdstring必填
请求头参数
- If-Matchstring
Optional precondition. A matching tag proceeds and returns the new ETag. A stale tag returns 412 PRECONDITION_FAILED with no write. Absent proceeds (opt-in this release). If-Match: * succeeds when the resource exists. Malformed values return 400 IF_MATCH_INVALID.
请求体
Content-Typeapplication/json
- datasetVersionIdstring (uuid) | null
- annotationSchemaIdstring (uuid) | null
- segmentKindstring可选值actionsegmenteventphasequality-issuetasksubtaskskill
- startSecnumber
- startNsecnumber
- endSecnumber
- endNsecnumber
- timeReferencestring
- titlestring | null
- naturalLanguageInstructionstring | null
- successboolean | null
- scorenumber | null
- failureReasonstring | null
- parentIdstring (uuid) | null
- orderIndexnumber
- reviewStatusstring
- statusstring
- attributesJsonobject | null
响应
Success
- dataobject必填
- idstring必填
- tenantIdstring必填
- projectIdstring必填
- datasetIdstring必填
- datasetVersionIdstring | null必填
- annotationSchemaIdstring | null必填
- segmentKindstring必填
- startSecnumber必填
- startNsecnumber必填
- endSecnumber必填
- endNsecnumber必填
- timeReferencestring必填
- titlestring | null必填
- naturalLanguageInstructionstring | null必填
- successone of | null必填
- scorenumber | null必填
- failureReasonstring | null必填
- parentIdstring | null必填
- orderIndexnumber必填
- reviewStatusstring必填
- statusstring必填
- publishedSnapshotIdstring | null必填
- createdBystring | null必填
- updatedBystring | null必填
- createdAtstring必填
- updatedAtstring必填
- deletedAtstring | null必填
- attributesJsonobject | null必填
响应示例
{
"data": {
"id": "string",
"tenantId": "string",
"projectId": "string",
"datasetId": "string",
"datasetVersionId": "string",
"annotationSchemaId": "string",
"segmentKind": "string",
"startSec": 0,
"startNsec": 0,
"endSec": 0,
"endNsec": 0,
"timeReference": "string",
"title": "string",
"naturalLanguageInstruction": "string",
"success": false,
"score": 0,
"failureReason": "string",
"parentId": "string",
"orderIndex": 0,
"reviewStatus": "string",
"status": "string",
"publishedSnapshotId": "string",
"createdBy": "string",
"updatedBy": "string",
"createdAt": "string",
"updatedAt": "string",
"deletedAt": "string",
"attributesJson": {}
}
}服务器https://api.embodiflow.io/v1https://api.embodiflow.dev/v1