vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/modelarts/api-ref/UpdateDataset.html
Wuwan, Qi f81ead2467 ModelArts API 24.3.0 20241128 version 
Reviewed-by: Pruthi, Vineet <vineet.pruthi@t-systems.com>
Co-authored-by: Wuwan, Qi <wuwanqi1@noreply.gitea.eco.tsi-dev.otc-service.com>
Co-committed-by: Wuwan, Qi <wuwanqi1@noreply.gitea.eco.tsi-dev.otc-service.com>
2024-11-29 09:04:54 +00:00

422 lines
37 KiB
HTML
Raw Blame History

<a name="EN-US_TOPIC_0000001909907364"></a><a name="EN-US_TOPIC_0000001909907364"></a>
<h1 class="topictitle1">Modifying a Dataset</h1>
<div id="body0000001713052073"><div class="section" id="EN-US_TOPIC_0000001909907364__section106035443012"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0000001909907364__p166048415309">Modify basic information about a dataset, such as name, description, version, and labels.</p>
</div>
<div class="section" id="EN-US_TOPIC_0000001909907364__section760411423013"><h4 class="sectiontitle">Debugging</h4><p id="EN-US_TOPIC_0000001909907364__p760418410301">You can debug this API in which supports automatic authentication. API Explorer can automatically generate SDK code examples and provide the SDK code example debugging.</p>
</div>
<div class="section" id="EN-US_TOPIC_0000001909907364__section5605348301"><h4 class="sectiontitle">URI</h4><p id="EN-US_TOPIC_0000001909907364__p1860511415309">PUT /v2/{project_id}/datasets/{dataset_id}</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001909907364__table1960713493012" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001909907364__row2060618453017"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="EN-US_TOPIC_0000001909907364__p7607154113015">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.2"><p id="EN-US_TOPIC_0000001909907364__p2607945301">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.3"><p id="EN-US_TOPIC_0000001909907364__p860804163010">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.3.2.5.1.4"><p id="EN-US_TOPIC_0000001909907364__p196081449302">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001909907364__row660604153014"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001909907364__p14608643308">dataset_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001909907364__p36099412306">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001909907364__p166096417309">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001909907364__p86101744304">Dataset ID</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001909907364__row760624103012"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001909907364__p8610174173019">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001909907364__p361019417303">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001909907364__p9611104113019">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001909907364__p1961124113014">Project ID. For details, see <a href="modelarts_03_0147.html">Obtaining a Project ID and Name</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000001909907364__section1061194173018"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001909907364__request_UpdateDatasetReq" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request body parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001909907364__row761314413012"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.1"><p id="EN-US_TOPIC_0000001909907364__p17616164153011">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.2"><p id="EN-US_TOPIC_0000001909907364__p116161447301">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.3"><p id="EN-US_TOPIC_0000001909907364__p10616241304">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.2.2.5.1.4"><p id="EN-US_TOPIC_0000001909907364__p46171410302">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001909907364__row7614549306"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001909907364__p261716493019">add_labels</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001909907364__p9618184143013">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001909907364__p0618149307">Array of <a href="#EN-US_TOPIC_0000001909907364__request_Label">Label</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="EN-US_TOPIC_0000001909907364__p156181345309">List of added labels</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001909907364__row66141741302"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001909907364__p166185403014">current_version_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001909907364__p761910493010">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001909907364__p156191441302">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="EN-US_TOPIC_0000001909907364__p1861915463015">Current version ID of a dataset</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001909907364__row156148453011"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001909907364__p1662020483015">dataset_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001909907364__p562012420302">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001909907364__p1462084183010">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="EN-US_TOPIC_0000001909907364__p156213423010">Dataset name</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001909907364__row1261415411301"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001909907364__p1662134183010">delete_labels</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001909907364__p116213473013">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001909907364__p662214433012">Array of <a href="#EN-US_TOPIC_0000001909907364__request_Label">Label</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="EN-US_TOPIC_0000001909907364__p2622144193016">List of labels to be deleted</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001909907364__row5614184183017"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001909907364__p16228493015">description</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001909907364__p19623104143011">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001909907364__p1962320493019">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="EN-US_TOPIC_0000001909907364__p5623046307">Dataset description. The value contains 0 to 256 characters. Special characters (^!&lt;&gt;=&amp;") are not allowed.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001909907364__row10614204183012"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001909907364__p1862414183013">update_labels</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001909907364__p662416415300">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001909907364__p862519473012">Array of <a href="#EN-US_TOPIC_0000001909907364__request_Label">Label</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="EN-US_TOPIC_0000001909907364__p962519473015">List of labels to be updated</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001909907364__request_Label"></a><a name="request_Label"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001909907364__request_Label" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Label</caption><thead align="left"><tr id="EN-US_TOPIC_0000001909907364__row26266410304"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.5.1.1"><p id="EN-US_TOPIC_0000001909907364__p262916413307">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.5.1.2"><p id="EN-US_TOPIC_0000001909907364__p962913463018">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.5.1.3"><p id="EN-US_TOPIC_0000001909907364__p7630124113013">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.3.2.5.1.4"><p id="EN-US_TOPIC_0000001909907364__p66303414301">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001909907364__row12627248304"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001909907364__p46312413020">attributes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001909907364__p1631144183018">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001909907364__p86325483015">Array of <a href="#EN-US_TOPIC_0000001909907364__request_LabelAttribute">LabelAttribute</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001909907364__p163215433014">Multi-dimensional attribute of a label. For example, if the label is <strong id="EN-US_TOPIC_0000001909907364__b034925878">music</strong>, attributes can be <strong id="EN-US_TOPIC_0000001909907364__b71661156377">genre</strong> or <strong id="EN-US_TOPIC_0000001909907364__b10943125715714">artist</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001909907364__row46271843302"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001909907364__p156335411303">name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001909907364__p116339493011">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001909907364__p1863312411301">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001909907364__p86344410304">Label name</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001909907364__row16274419309"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001909907364__p1363454163018">property</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001909907364__p7634843304">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001909907364__p166351442308"><a href="#EN-US_TOPIC_0000001909907364__request_LabelProperty">LabelProperty</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001909907364__p116351448305">Basic attribute key-value pair of a label, such as color and shortcut keys.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001909907364__row962712433017"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001909907364__p1763516412301">type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001909907364__p0636174193010">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001909907364__p4636134143010">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001909907364__p1063613433012">Label type. Options:</p>
<ul id="EN-US_TOPIC_0000001909907364__ul186362433018"><li id="EN-US_TOPIC_0000001909907364__li263724153017"><p id="EN-US_TOPIC_0000001909907364__p1637746307"><a name="EN-US_TOPIC_0000001909907364__li263724153017"></a><a name="li263724153017"></a><strong id="EN-US_TOPIC_0000001909907364__b499356076101258">0</strong>: image classification</p>
</li><li id="EN-US_TOPIC_0000001909907364__li186371542308"><p id="EN-US_TOPIC_0000001909907364__p96378414301"><a name="EN-US_TOPIC_0000001909907364__li186371542308"></a><a name="li186371542308"></a><strong id="EN-US_TOPIC_0000001909907364__b12322121101258">1</strong>: object detection</p>
</li><li id="EN-US_TOPIC_0000001909907364__li563764153018"><p id="EN-US_TOPIC_0000001909907364__p14637194153011"><a name="EN-US_TOPIC_0000001909907364__li563764153018"></a><a name="li563764153018"></a><strong id="EN-US_TOPIC_0000001909907364__b9672351881">3</strong>: image segmentation</p>
</li><li id="EN-US_TOPIC_0000001909907364__li116381847307"><p id="EN-US_TOPIC_0000001909907364__p16638134143016"><a name="EN-US_TOPIC_0000001909907364__li116381847307"></a><a name="li116381847307"></a><strong id="EN-US_TOPIC_0000001909907364__b961607443101258">100</strong>: text classification</p>
</li><li id="EN-US_TOPIC_0000001909907364__li163816414303"><p id="EN-US_TOPIC_0000001909907364__p1863817415309"><a name="EN-US_TOPIC_0000001909907364__li163816414303"></a><a name="li163816414303"></a><strong id="EN-US_TOPIC_0000001909907364__b319215353101258">101</strong>: named entity recognition</p>
</li><li id="EN-US_TOPIC_0000001909907364__li136383463019"><p id="EN-US_TOPIC_0000001909907364__p19638124143014"><a name="EN-US_TOPIC_0000001909907364__li136383463019"></a><a name="li136383463019"></a><strong id="EN-US_TOPIC_0000001909907364__b1915511254101258">102</strong>: text triplet relationship</p>
</li><li id="EN-US_TOPIC_0000001909907364__li2638543301"><p id="EN-US_TOPIC_0000001909907364__p063912420300"><a name="EN-US_TOPIC_0000001909907364__li2638543301"></a><a name="li2638543301"></a><strong id="EN-US_TOPIC_0000001909907364__b715223386101258">103</strong>: text triplet entity</p>
</li><li id="EN-US_TOPIC_0000001909907364__li1063912433018"><p id="EN-US_TOPIC_0000001909907364__p563919473013"><a name="EN-US_TOPIC_0000001909907364__li1063912433018"></a><a name="li1063912433018"></a><strong id="EN-US_TOPIC_0000001909907364__b632959711101258">200</strong>: sound classification</p>
</li><li id="EN-US_TOPIC_0000001909907364__li1163913419302"><p id="EN-US_TOPIC_0000001909907364__p46393419307"><a name="EN-US_TOPIC_0000001909907364__li1163913419302"></a><a name="li1163913419302"></a><strong id="EN-US_TOPIC_0000001909907364__b487061084101258">201</strong>: speech content</p>
</li><li id="EN-US_TOPIC_0000001909907364__li56391041303"><p id="EN-US_TOPIC_0000001909907364__p116406414308"><a name="EN-US_TOPIC_0000001909907364__li56391041303"></a><a name="li56391041303"></a><strong id="EN-US_TOPIC_0000001909907364__b1826003492101258">202</strong>: speech paragraph labeling</p>
</li><li id="EN-US_TOPIC_0000001909907364__li364019413010"><p id="EN-US_TOPIC_0000001909907364__p1064004153012"><a name="EN-US_TOPIC_0000001909907364__li364019413010"></a><a name="li364019413010"></a><strong id="EN-US_TOPIC_0000001909907364__b63827587101258">600</strong>: video labeling</p>
</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001909907364__request_LabelAttribute"></a><a name="request_LabelAttribute"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001909907364__request_LabelAttribute" frame="border" border="1" rules="all"><caption><b>Table 4 </b>LabelAttribute</caption><thead align="left"><tr id="EN-US_TOPIC_0000001909907364__row7641114133019"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.5.1.1"><p id="EN-US_TOPIC_0000001909907364__p186432410305">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.5.1.2"><p id="EN-US_TOPIC_0000001909907364__p26446416307">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.5.1.3"><p id="EN-US_TOPIC_0000001909907364__p16451444302">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.4.2.5.1.4"><p id="EN-US_TOPIC_0000001909907364__p126451548309">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001909907364__row764217433010"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.1 "><p id="EN-US_TOPIC_0000001909907364__p164517417309">default_value</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.2 "><p id="EN-US_TOPIC_0000001909907364__p06461348308">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.3 "><p id="EN-US_TOPIC_0000001909907364__p86462044309">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.4.2.5.1.4 "><p id="EN-US_TOPIC_0000001909907364__p8646045303">Default value of a label attribute</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001909907364__row17642445302"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.1 "><p id="EN-US_TOPIC_0000001909907364__p1164712416304">id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.2 "><p id="EN-US_TOPIC_0000001909907364__p76471146307">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.3 "><p id="EN-US_TOPIC_0000001909907364__p96476411309">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.4.2.5.1.4 "><p id="EN-US_TOPIC_0000001909907364__p56478483013">Label attribute ID, which can be obtained in the label list.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001909907364__row186425433011"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.1 "><p id="EN-US_TOPIC_0000001909907364__p0648244304">name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.2 "><p id="EN-US_TOPIC_0000001909907364__p8648049308">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.3 "><p id="EN-US_TOPIC_0000001909907364__p064819416300">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.4.2.5.1.4 "><p id="EN-US_TOPIC_0000001909907364__p26491419308">Label attribute name, which can contain a maximum of 64 characters. Special characters (!&lt;&gt;=&amp;"') cannot be included.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001909907364__row1564214423017"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.1 "><p id="EN-US_TOPIC_0000001909907364__p1264934113013">type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.2 "><p id="EN-US_TOPIC_0000001909907364__p764944133013">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.3 "><p id="EN-US_TOPIC_0000001909907364__p13650749309">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.4.2.5.1.4 "><p id="EN-US_TOPIC_0000001909907364__p1365014413011">Label attribute type. Options:</p>
<ul id="EN-US_TOPIC_0000001909907364__ul26504414301"><li id="EN-US_TOPIC_0000001909907364__li86502044308"><p id="EN-US_TOPIC_0000001909907364__p565034123010"><a name="EN-US_TOPIC_0000001909907364__li86502044308"></a><a name="li86502044308"></a><strong id="EN-US_TOPIC_0000001909907364__b58152013553">text</strong>: Select a text label.</p>
</li><li id="EN-US_TOPIC_0000001909907364__li126508413308"><p id="EN-US_TOPIC_0000001909907364__p9650443308"><a name="EN-US_TOPIC_0000001909907364__li126508413308"></a><a name="li126508413308"></a><strong id="EN-US_TOPIC_0000001909907364__b577423125517">select</strong>: Select from the drop-down list.</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001909907364__row36421413305"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.1 "><p id="EN-US_TOPIC_0000001909907364__p1965115419308">values</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.2 "><p id="EN-US_TOPIC_0000001909907364__p46516463014">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.3 "><p id="EN-US_TOPIC_0000001909907364__p16511742307">Array of <a href="#EN-US_TOPIC_0000001909907364__request_LabelAttributeValue">LabelAttributeValue</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.4.2.5.1.4 "><p id="EN-US_TOPIC_0000001909907364__p565215410305">List of label attribute values</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001909907364__request_LabelAttributeValue"></a><a name="request_LabelAttributeValue"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001909907364__request_LabelAttributeValue" frame="border" border="1" rules="all"><caption><b>Table 5 </b>LabelAttributeValue</caption><thead align="left"><tr id="EN-US_TOPIC_0000001909907364__row13652184113010"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.5.1.1"><p id="EN-US_TOPIC_0000001909907364__p2065413453012">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.5.1.2"><p id="EN-US_TOPIC_0000001909907364__p116541645301">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.5.1.3"><p id="EN-US_TOPIC_0000001909907364__p1655043306">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.5.2.5.1.4"><p id="EN-US_TOPIC_0000001909907364__p5655184203017">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001909907364__row20653154123014"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.5.1.1 "><p id="EN-US_TOPIC_0000001909907364__p9655164173011">id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.5.1.2 "><p id="EN-US_TOPIC_0000001909907364__p206561546303">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.5.1.3 "><p id="EN-US_TOPIC_0000001909907364__p1365612419303">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.5.2.5.1.4 "><p id="EN-US_TOPIC_0000001909907364__p965610453019">Label attribute value ID</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001909907364__row36531541308"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.5.1.1 "><p id="EN-US_TOPIC_0000001909907364__p9656444303">value</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.5.1.2 "><p id="EN-US_TOPIC_0000001909907364__p1657647302">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.5.1.3 "><p id="EN-US_TOPIC_0000001909907364__p265724113013">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.5.2.5.1.4 "><p id="EN-US_TOPIC_0000001909907364__p12657154133013">Label attribute value</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001909907364__request_LabelProperty"></a><a name="request_LabelProperty"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001909907364__request_LabelProperty" frame="border" border="1" rules="all"><caption><b>Table 6 </b>LabelProperty</caption><thead align="left"><tr id="EN-US_TOPIC_0000001909907364__row1165811453016"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.6.2.5.1.1"><p id="EN-US_TOPIC_0000001909907364__p1566154113013">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.6.2.5.1.2"><p id="EN-US_TOPIC_0000001909907364__p1066214103018">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.6.2.5.1.3"><p id="EN-US_TOPIC_0000001909907364__p26621642304">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.6.2.5.1.4"><p id="EN-US_TOPIC_0000001909907364__p7663174143011">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001909907364__row7659174143017"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.5.1.1 "><p id="EN-US_TOPIC_0000001909907364__p16663846302">@modelarts:color</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.5.1.2 "><p id="EN-US_TOPIC_0000001909907364__p366416473011">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.5.1.3 "><p id="EN-US_TOPIC_0000001909907364__p176641145304">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.6.2.5.1.4 "><p id="EN-US_TOPIC_0000001909907364__p366515403017">Label color, which is a hexadecimal code of the color. The default value is left blank. For example, <strong id="EN-US_TOPIC_0000001909907364__b1510479210101258">#FFFFF0</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001909907364__row865913412308"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.5.1.1 "><p id="EN-US_TOPIC_0000001909907364__p06651747304">@modelarts:default_shape</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.5.1.2 "><p id="EN-US_TOPIC_0000001909907364__p7665204153015">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.5.1.3 "><p id="EN-US_TOPIC_0000001909907364__p13666346309">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.6.2.5.1.4 "><p id="EN-US_TOPIC_0000001909907364__p1366615493010">Default shape of an object detection label (dedicated attribute). By default, this parameter is left blank. Options:</p>
<ul id="EN-US_TOPIC_0000001909907364__ul26678411301"><li id="EN-US_TOPIC_0000001909907364__li566713453010"><p id="EN-US_TOPIC_0000001909907364__p56671340307"><a name="EN-US_TOPIC_0000001909907364__li566713453010"></a><a name="li566713453010"></a><strong id="EN-US_TOPIC_0000001909907364__b1366512555101258">bndbox</strong>: rectangle</p>
</li><li id="EN-US_TOPIC_0000001909907364__li1667184183016"><p id="EN-US_TOPIC_0000001909907364__p16671453013"><a name="EN-US_TOPIC_0000001909907364__li1667184183016"></a><a name="li1667184183016"></a><strong id="EN-US_TOPIC_0000001909907364__b1359131116101258">polygon</strong>: polygon</p>
</li><li id="EN-US_TOPIC_0000001909907364__li466714419302"><p id="EN-US_TOPIC_0000001909907364__p1366717415304"><a name="EN-US_TOPIC_0000001909907364__li466714419302"></a><a name="li466714419302"></a><strong id="EN-US_TOPIC_0000001909907364__b4560075101258">circle</strong>: circle</p>
</li><li id="EN-US_TOPIC_0000001909907364__li9668242307"><p id="EN-US_TOPIC_0000001909907364__p1066884133013"><a name="EN-US_TOPIC_0000001909907364__li9668242307"></a><a name="li9668242307"></a><strong id="EN-US_TOPIC_0000001909907364__b2018893960101258">line</strong>: straight line</p>
</li><li id="EN-US_TOPIC_0000001909907364__li46681948304"><p id="EN-US_TOPIC_0000001909907364__p146687453018"><a name="EN-US_TOPIC_0000001909907364__li46681948304"></a><a name="li46681948304"></a><strong id="EN-US_TOPIC_0000001909907364__b393502785101258">dashed</strong>: dashed line</p>
</li><li id="EN-US_TOPIC_0000001909907364__li2066815419303"><p id="EN-US_TOPIC_0000001909907364__p76682417302"><a name="EN-US_TOPIC_0000001909907364__li2066815419303"></a><a name="li2066815419303"></a><strong id="EN-US_TOPIC_0000001909907364__b571997468101258">point</strong>: point</p>
</li><li id="EN-US_TOPIC_0000001909907364__li10669174123016"><p id="EN-US_TOPIC_0000001909907364__p266920412307"><a name="EN-US_TOPIC_0000001909907364__li10669174123016"></a><a name="li10669174123016"></a><strong id="EN-US_TOPIC_0000001909907364__b932404219101258">polyline</strong>: polyline</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001909907364__row96599473010"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.5.1.1 "><p id="EN-US_TOPIC_0000001909907364__p0669541303">@modelarts:from_type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.5.1.2 "><p id="EN-US_TOPIC_0000001909907364__p196693493018">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.5.1.3 "><p id="EN-US_TOPIC_0000001909907364__p126706443012">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.6.2.5.1.4 "><p id="EN-US_TOPIC_0000001909907364__p8670184123015">Type of the head entity in the triplet relationship label. This attribute must be specified when a relationship label is created. This parameter is used only for the text triplet dataset.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001909907364__row066011433013"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.5.1.1 "><p id="EN-US_TOPIC_0000001909907364__p1967010423017">@modelarts:rename_to</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.5.1.2 "><p id="EN-US_TOPIC_0000001909907364__p1867113403017">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.5.1.3 "><p id="EN-US_TOPIC_0000001909907364__p1067116453010">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.6.2.5.1.4 "><p id="EN-US_TOPIC_0000001909907364__p126716411303">The new name of the label</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001909907364__row66601418304"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.5.1.1 "><p id="EN-US_TOPIC_0000001909907364__p206721414301">@modelarts:shortcut</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.5.1.2 "><p id="EN-US_TOPIC_0000001909907364__p1367215483010">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.5.1.3 "><p id="EN-US_TOPIC_0000001909907364__p126737416304">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.6.2.5.1.4 "><p id="EN-US_TOPIC_0000001909907364__p367319403012">Label shortcut key, for example, <strong id="EN-US_TOPIC_0000001909907364__b20968185574219">D</strong>. By default, this parameter is left blank.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001909907364__row166012416302"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.5.1.1 "><p id="EN-US_TOPIC_0000001909907364__p14674104173015">@modelarts:to_type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.5.1.2 "><p id="EN-US_TOPIC_0000001909907364__p17674948307">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.5.1.3 "><p id="EN-US_TOPIC_0000001909907364__p116741944309">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.6.2.5.1.4 "><p id="EN-US_TOPIC_0000001909907364__p967412413018">Type of the tail entity in the triplet relationship label. This attribute must be specified when a relationship label is created. This parameter is used only for the text triplet dataset.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000001909907364__section156751248300"><h4 class="sectiontitle">Response Parameters</h4><p id="EN-US_TOPIC_0000001909907364__p136756423017"><strong id="EN-US_TOPIC_0000001909907364__b1050074357101258">Status code</strong>: <strong id="EN-US_TOPIC_0000001909907364__b250643040101258">200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001909907364__response_UpdateDatasetResp" frame="border" border="1" rules="all"><caption><b>Table 7 </b>Response body parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001909907364__row26762473019"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.3.2.4.1.1"><p id="EN-US_TOPIC_0000001909907364__p1267734113016">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.3.2.4.1.2"><p id="EN-US_TOPIC_0000001909907364__p667816411306">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.3.2.4.1.3"><p id="EN-US_TOPIC_0000001909907364__p367911418302">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001909907364__row3676134163017"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001909907364__p1067994163013">dataset_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001909907364__p156802443013">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001909907364__p868020463014">Dataset ID</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000001909907364__section1368014143013"><h4 class="sectiontitle">Request Example</h4><p id="EN-US_TOPIC_0000001909907364__p116811841305">Run the following command to update a dataset:</p>
<pre class="screen" id="EN-US_TOPIC_0000001909907364__screen968184133016">{
"description" : "just a test",
"add_labels" : [ {
"name" : "Ants",
"type" : 0,
"property" : {
"@modelarts:color" : "#3399ff"
}
} ]
}</pre>
</div>
<div class="section" id="EN-US_TOPIC_0000001909907364__section16683343303"><h4 class="sectiontitle">Response Example</h4><p id="EN-US_TOPIC_0000001909907364__p1668316417303"><strong id="EN-US_TOPIC_0000001909907364__b1640611173014">Status code</strong>: <strong id="EN-US_TOPIC_0000001909907364__b1640131183016">200</strong></p>
<p id="EN-US_TOPIC_0000001909907364__p1568417412307">OK</p>
<pre class="screen" id="EN-US_TOPIC_0000001909907364__screen16684141304">{
"dataset_id" : "gfghHSokody6AJigS5A"
}</pre>
</div>
<div class="section" id="EN-US_TOPIC_0000001909907364__section268574193010"><h4 class="sectiontitle">Status Code</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001909907364__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0000001909907364__row19685184133012"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.8.2.1.3.1.1"><p id="EN-US_TOPIC_0000001909907364__p14687154103010">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.8.2.1.3.1.2"><p id="EN-US_TOPIC_0000001909907364__p168718414304">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001909907364__row568634123020"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="EN-US_TOPIC_0000001909907364__p7688104173020">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="EN-US_TOPIC_0000001909907364__p156882463016">OK</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001909907364__row126869412308"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="EN-US_TOPIC_0000001909907364__p176881411309">401</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="EN-US_TOPIC_0000001909907364__p65091769304">Unauthorized</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001909907364__row17686134113015"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="EN-US_TOPIC_0000001909907364__p1350916623011">403</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="EN-US_TOPIC_0000001909907364__p15090617308">Forbidden</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001909907364__row196863433012"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="EN-US_TOPIC_0000001909907364__p85101162307">404</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="EN-US_TOPIC_0000001909907364__p135103693018">Not Found</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000001909907364__section15510156123012"><h4 class="sectiontitle">Error Code</h4><p id="EN-US_TOPIC_0000001909907364__p1251018613020">For details, see <a href="modelarts_03_0095.html">Error Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="dataset_management.html">Data Management (Old Version)</a></div>
</div>
</div>
View Git Blame Copy Permalink