forked from docs/doc-exports
Reviewed-by: Pruthi, Vineet <vineet.pruthi@t-systems.com> Co-authored-by: Lai, Weijian <laiweijian4@huawei.com> Co-committed-by: Lai, Weijian <laiweijian4@huawei.com>
317 lines
23 KiB
HTML
317 lines
23 KiB
HTML
<a name="ListLabels"></a><a name="ListLabels"></a>
|
|
|
|
<h1 class="topictitle1">Querying the Dataset Label List</h1>
|
|
<div id="body0000001296308412"><div class="section" id="ListLabels__section17722184015589"><h4 class="sectiontitle">Function</h4><p id="ListLabels__p17311405581">This API is used to query all labels of a dataset.</p>
|
|
</div>
|
|
<div class="section" id="ListLabels__section17757114015584"><h4 class="sectiontitle">URI</h4><p id="ListLabels__p15766204015816">GET /v2/{project_id}/datasets/{dataset_id}/data-annotations/labels</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListLabels__table07792040155812" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="ListLabels__row8772840135817"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="ListLabels__p15782140155816">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="ListLabels__p678934075813">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="ListLabels__p18797164075817">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="ListLabels__p580534095812">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ListLabels__row1877216403581"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="ListLabels__p19812184055810">dataset_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="ListLabels__p0821540155810">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="ListLabels__p1882844018585">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="ListLabels__p1836174019580">Dataset ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListLabels__row777213407584"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="ListLabels__p684415408582">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="ListLabels__p7852164075818">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="ListLabels__p1785904017583">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="ListLabels__p13870104095810">Project ID. For details about how to obtain the project ID, see <a href="modelarts_03_0147.html">Obtaining a Project ID</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListLabels__table4885840155811" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Query Parameters</caption><thead align="left"><tr id="ListLabels__row1787620403582"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.1"><p id="ListLabels__p158896406585">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.2"><p id="ListLabels__p490074095816">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.3"><p id="ListLabels__p6909194010588">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.4.2.5.1.4"><p id="ListLabels__p7918144095817">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ListLabels__row78761440125814"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListLabels__p179271240155813">version_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListLabels__p19934340175810">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListLabels__p594113404589">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListLabels__p694915409586">Dataset version ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="ListLabels__section1795615409588"><h4 class="sectiontitle">Request Parameters</h4><p id="ListLabels__p1696744075811">None</p>
|
|
</div>
|
|
<div class="section" id="ListLabels__section2097974095812"><h4 class="sectiontitle">Response Parameters</h4><p id="ListLabels__p189881940115812"><strong id="ListLabels__b9991164019582">Status code: 200</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListLabels__response_ListLabelsResp" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response body parameters</caption><thead align="left"><tr id="ListLabels__row89951640115815"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="ListLabels__p08134155817">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.2"><p id="ListLabels__p915164185811">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.3.2.4.1.3"><p id="ListLabels__p1424194135815">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ListLabels__row15995114075810"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ListLabels__p233841195818">labels</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ListLabels__p74364114588">Array of <a href="#ListLabels__response_Label">Label</a> objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ListLabels__p351441205820">Label list.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="ListLabels__response_Label"></a><a name="response_Label"></a><table cellpadding="4" cellspacing="0" summary="" id="ListLabels__response_Label" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Label</caption><thead align="left"><tr id="ListLabels__row1656164119588"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.1"><p id="ListLabels__p86794113582">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.2"><p id="ListLabels__p1674104155813">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.4.2.4.1.3"><p id="ListLabels__p683154145813">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ListLabels__row1056104112583"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListLabels__p119114135817">attributes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListLabels__p13101164120581">Array of <a href="#ListLabels__response_LabelAttribute">LabelAttribute</a> objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListLabels__p11091541195811">Multi-dimensional attribute of a label. For example, if the label is music, attributes such as style and artist may be included.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListLabels__row17561341185812"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListLabels__p161185417587">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListLabels__p13126154115814">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListLabels__p5135194115584">Label name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListLabels__row125784125818"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListLabels__p8143184115583">property</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListLabels__p12152174114586"><a href="#ListLabels__response_LabelProperty">LabelProperty</a> object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListLabels__p716034120588">Basic attribute key-value pair of a label, such as color and shortcut keys.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListLabels__row1857134114589"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListLabels__p81677418584">type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListLabels__p817474135810">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListLabels__p1318394165813">Label type. The options are as follows:</p>
|
|
<ul id="ListLabels__ul919984105818"><li id="ListLabels__li820104110580"><strong id="ListLabels__b120774119582">0</strong>: image classification</li><li id="ListLabels__li92111441115816"><strong id="ListLabels__b4218174125820">1</strong>: object detection</li><li id="ListLabels__li132221041155813"><strong id="ListLabels__b9229841175817">100</strong>: text classification</li><li id="ListLabels__li17232204111587"><strong id="ListLabels__b172391241205818">101</strong>: named entity recognition</li><li id="ListLabels__li1242241115810"><strong id="ListLabels__b11249184125813">102</strong>: text triplet relationship</li><li id="ListLabels__li725264105812"><strong id="ListLabels__b125894115586">103</strong>: text triplet entity</li><li id="ListLabels__li17262174145813"><strong id="ListLabels__b52671419584">200</strong>: speech classification</li><li id="ListLabels__li152711417586"><strong id="ListLabels__b1027784112589">201</strong>: speech content</li><li id="ListLabels__li52803412586"><strong id="ListLabels__b1128714418586">202</strong>: speech paragraph labeling</li><li id="ListLabels__li2291164165817"><strong id="ListLabels__b629724114584">600</strong>: video classification</li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="ListLabels__response_LabelAttribute"></a><a name="response_LabelAttribute"></a><table cellpadding="4" cellspacing="0" summary="" id="ListLabels__response_LabelAttribute" frame="border" border="1" rules="all"><caption><b>Table 5 </b>LabelAttribute</caption><thead align="left"><tr id="ListLabels__row8299641165813"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.1"><p id="ListLabels__p13311134115585">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.2"><p id="ListLabels__p193181941115812">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.5.2.4.1.3"><p id="ListLabels__p73251941105818">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ListLabels__row102991941165815"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListLabels__p13332154165811">default_value</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListLabels__p333934119586">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListLabels__p183461341175812">Default value of a label attribute.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListLabels__row5300194125818"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListLabels__p14353124110581">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListLabels__p1936114112584">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListLabels__p14368154175816">Label attribute ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListLabels__row11300184155820"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListLabels__p1375114117584">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListLabels__p1384164117584">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListLabels__p193913413586">Label attribute name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListLabels__row130015419583"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListLabels__p8399134111586">type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListLabels__p1140518418588">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListLabels__p8417104119581">Label attribute type. The options are as follows:</p>
|
|
<ul id="ListLabels__ul342494165813"><li id="ListLabels__li9426194195811"><strong id="ListLabels__b843254120585">text</strong>: text</li><li id="ListLabels__li1143584117581"><strong id="ListLabels__b544144125811">select</strong>: single-choice drop-down list</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListLabels__row3300174195812"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListLabels__p9446541175814">values</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListLabels__p154552041145817">Array of <a href="#ListLabels__response_LabelAttributeValue">LabelAttributeValue</a> objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListLabels__p24631414587">List of label attribute values.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="ListLabels__response_LabelAttributeValue"></a><a name="response_LabelAttributeValue"></a><table cellpadding="4" cellspacing="0" summary="" id="ListLabels__response_LabelAttributeValue" frame="border" border="1" rules="all"><caption><b>Table 6 </b>LabelAttributeValue</caption><thead align="left"><tr id="ListLabels__row11468204111582"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.6.2.4.1.1"><p id="ListLabels__p44826417581">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.6.2.4.1.2"><p id="ListLabels__p448954111589">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.6.2.4.1.3"><p id="ListLabels__p1649774111583">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ListLabels__row1746844110584"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p id="ListLabels__p75047417583">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p id="ListLabels__p85115413587">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p id="ListLabels__p155197415583">Label attribute value ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListLabels__row1246818414589"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p id="ListLabels__p185261441175815">value</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p id="ListLabels__p19532114115815">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p id="ListLabels__p3539184117588">Label attribute value.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="ListLabels__response_LabelProperty"></a><a name="response_LabelProperty"></a><table cellpadding="4" cellspacing="0" summary="" id="ListLabels__response_LabelProperty" frame="border" border="1" rules="all"><caption><b>Table 7 </b>LabelProperty</caption><thead align="left"><tr id="ListLabels__row10546124110586"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.7.2.4.1.1"><p id="ListLabels__p3557641115816">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.7.2.4.1.2"><p id="ListLabels__p115659415582">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.7.2.4.1.3"><p id="ListLabels__p657304185819">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ListLabels__row554674110581"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="ListLabels__p16581204165817">@modelarts:color</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="ListLabels__p19589114115820">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="ListLabels__p1659954165814">Default attribute: Label color, which is a hexadecimal code of the color. By default, this parameter is left blank. Example: <strong id="ListLabels__b2603941105812">#FFFFF0</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListLabels__row7546114125810"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="ListLabels__p960618411589">@modelarts:default_shape</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="ListLabels__p1613174119588">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="ListLabels__p762014119583">Default attribute: Default shape of an object detection label (dedicated attribute). By default, this parameter is left blank. The options are as follows:</p>
|
|
<ul id="ListLabels__ul19632541175818"><li id="ListLabels__li19634194135811"><strong id="ListLabels__b463910416589">bndbox</strong>: rectangle</li><li id="ListLabels__li186421441145814"><strong id="ListLabels__b9648124117588">polygon</strong>: polygon</li><li id="ListLabels__li1565154165811"><strong id="ListLabels__b1765774111586">circle</strong>: circle</li><li id="ListLabels__li666120417587"><strong id="ListLabels__b16668941195810">line</strong>: straight line</li><li id="ListLabels__li1867194119585"><strong id="ListLabels__b9677841205817">dashed</strong>: dotted line</li><li id="ListLabels__li86802412583"><strong id="ListLabels__b4686241105810">point</strong>: point</li><li id="ListLabels__li5689641205820"><strong id="ListLabels__b669413410587">polyline</strong>: polyline</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListLabels__row0546144195816"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="ListLabels__p19698204110582">@modelarts:from_type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="ListLabels__p1270504185813">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="ListLabels__p1471364113589">Default attribute: 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="ListLabels__row55465412588"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="ListLabels__p172018414588">@modelarts:rename_to</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="ListLabels__p11728134115583">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="ListLabels__p17734124112583">Default attribute: The new name of the label.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListLabels__row1654654125815"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="ListLabels__p13742174117580">@modelarts:shortcut</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="ListLabels__p207491241195814">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="ListLabels__p11759174113584">Default attribute: Label shortcut key. By default, this parameter is left blank. For example: <strong id="ListLabels__b57620415585">D</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListLabels__row354619419589"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="ListLabels__p6767194118581">@modelarts:to_type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="ListLabels__p1777413414587">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="ListLabels__p19781141185811">Default attribute: 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="ListLabels__section278912418588"><h4 class="sectiontitle">Example Requests</h4><p id="ListLabels__p379618418589">Querying All Labels of a Dataset</p>
|
|
<pre class="screen" id="ListLabels__screen0804184175815">GET https://{endpoint}/v2/{project_id}/datasets/WxCREuCkBSAlQr9xrde/data-annotations/labels</pre>
|
|
</div>
|
|
<div class="section" id="ListLabels__section1181211412581"><h4 class="sectiontitle">Example Responses</h4><p id="ListLabels__p1682094114583"><strong id="ListLabels__b482320419589">Status code: 200</strong></p>
|
|
<p id="ListLabels__p582524175812">OK</p>
|
|
<pre class="screen" id="ListLabels__screen584234118582">{
|
|
"labels" : [ {
|
|
"name" : "Cat",
|
|
"type" : 1,
|
|
"property" : {
|
|
"@modelarts:color" : "#3399ff"
|
|
}
|
|
}, {
|
|
"name" : "Rabbit",
|
|
"type" : 1,
|
|
"property" : {
|
|
"@modelarts:color" : "#3399ff"
|
|
}
|
|
} ]
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="ListLabels__section894054110582"><h4 class="sectiontitle">Status Codes</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListLabels__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="ListLabels__row15952114117581"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="ListLabels__p1296164120586">Status Code</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p id="ListLabels__p169681641165811">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ListLabels__row169526419584"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ListLabels__p19975141195820">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ListLabels__p498364175817">OK</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListLabels__row2952134195810"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ListLabels__p12990144119586">401</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ListLabels__p899724116587">Unauthorized</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListLabels__row39529416580"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ListLabels__p194124218580">403</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ListLabels__p1612174275813">Forbidden</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListLabels__row1895294195812"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ListLabels__p102020426584">404</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ListLabels__p1528144218582">Not Found</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="ListLabels__section103784205813"><h4 class="sectiontitle">Error Codes</h4><p id="ListLabels__p9477421582">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="label_management.html">Label Management</a></div>
|
|
</div>
|
|
</div>
|
|
|