youjiageng1/doc-exports
1
0
Fork 0
forked from laiweijian4/doc-exports
Code Pull Requests Activity
doc-exports/docs/modelarts/api-ref/ListLabels.html
Lai, Weijian 14be84ba51 ModelArts api-ref version 21.430 update 
Reviewed-by: Jiang, Beibei <beibei.jiang@t-systems.com>
Co-authored-by: Lai, Weijian <laiweijian4@huawei.com>
Co-committed-by: Lai, Weijian <laiweijian4@huawei.com>
2023-03-01 15:55:34 +00:00

317 lines
23 KiB
HTML
Raw Blame History

<a name="ListLabels"></a><a name="ListLabels"></a>
<h1 class="topictitle1">Querying the Dataset Label List</h1>
<div id="body2186649103319"><div class="section" id="ListLabels__section11187114983313"><h4 class="sectiontitle">Function</h4><p id="ListLabels__p11187124919333">This API is used to query all labels of a dataset.</p>
</div>
<div class="section" id="ListLabels__section1618904923320"><h4 class="sectiontitle">URI</h4><p id="ListLabels__p17189164903318">GET /v2/{project_id}/datasets/{dataset_id}/data-annotations/labels</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListLabels__table419011498330" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="ListLabels__row1418911495339"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="ListLabels__p18191114920337">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="ListLabels__p1219117491336">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="ListLabels__p419115493337">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="ListLabels__p1519124910334">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListLabels__row161901349163313"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="ListLabels__p1192349133317">dataset_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="ListLabels__p1519234919333">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="ListLabels__p1019204916337">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="ListLabels__p18193144910331">Dataset ID.</p>
</td>
</tr>
<tr id="ListLabels__row16190349123311"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="ListLabels__p1319384983314">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="ListLabels__p31931749153315">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="ListLabels__p19194164910333">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="ListLabels__p15194194919335">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__table1819574943315" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Query Parameters</caption><thead align="left"><tr id="ListLabels__row2195204916332"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.1"><p id="ListLabels__p1619564918334">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.2"><p id="ListLabels__p161961549123320">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.3"><p id="ListLabels__p1419634913311">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.4.2.5.1.4"><p id="ListLabels__p519784973317">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListLabels__row121956499332"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListLabels__p319754913312">version_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListLabels__p31981049153318">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListLabels__p1119874973313">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListLabels__p161981497337">Dataset version ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ListLabels__section519944915334"><h4 class="sectiontitle">Request Parameters</h4><p id="ListLabels__p1219954913313">None</p>
</div>
<div class="section" id="ListLabels__section3199749103315"><h4 class="sectiontitle">Response Parameters</h4><p id="ListLabels__p7200174993317"><strong id="ListLabels__b1020014983310">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__row1220054963317"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="ListLabels__p520111496330">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.2"><p id="ListLabels__p202021649183317">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.3.2.4.1.3"><p id="ListLabels__p16202349123312">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListLabels__row142001149143312"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ListLabels__p142021149183313">labels</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ListLabels__p16202154916337">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__p1820313494331">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__row19203134963314"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.1"><p id="ListLabels__p20204249103313">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.2"><p id="ListLabels__p192054495333">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.4.2.4.1.3"><p id="ListLabels__p420514983312">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListLabels__row52038499336"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListLabels__p3205124963310">attributes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListLabels__p1820674983315">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__p9206549133310">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__row5204949153312"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListLabels__p320617495333">name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListLabels__p1720744914332">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListLabels__p202071749143319">Label name.</p>
</td>
</tr>
<tr id="ListLabels__row5204164963320"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListLabels__p11207154913318">property</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListLabels__p520834917339"><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__p18208144913338">Basic attribute key-value pair of a label, such as color and shortcut keys.</p>
</td>
</tr>
<tr id="ListLabels__row1204649183319"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListLabels__p0208174911332">type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListLabels__p14208549143315">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListLabels__p920911494338">Label type. The options are as follows:</p>
<ul id="ListLabels__ul8209174953315"><li id="ListLabels__li3209649203311"><strong id="ListLabels__b7209194912338">0</strong>: image classification</li><li id="ListLabels__li620994903315"><strong id="ListLabels__b1421020499338">1</strong>: object detection</li><li id="ListLabels__li152102495331"><strong id="ListLabels__b142101491339">100</strong>: text classification</li><li id="ListLabels__li5210849143317"><strong id="ListLabels__b82109497331">101</strong>: named entity recognition</li><li id="ListLabels__li721024915336"><strong id="ListLabels__b6211204923315">102</strong>: text triplet relationship</li><li id="ListLabels__li12111249173320"><strong id="ListLabels__b1821144983317">103</strong>: text triplet entity</li><li id="ListLabels__li9211144963315"><strong id="ListLabels__b6211194943316">200</strong>: speech classification</li><li id="ListLabels__li112115499331"><strong id="ListLabels__b192124495333">201</strong>: speech content</li><li id="ListLabels__li1621214920337"><strong id="ListLabels__b1021210498337">202</strong>: speech paragraph labeling</li><li id="ListLabels__li8212149113317"><strong id="ListLabels__b9213449193310">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__row182136497332"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.1"><p id="ListLabels__p1521484916338">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.2"><p id="ListLabels__p1621524993312">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.5.2.4.1.3"><p id="ListLabels__p13215549193311">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListLabels__row7213124923317"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListLabels__p1821514913310">default_value</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListLabels__p15216204911337">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListLabels__p10216249143310">Default value of a label attribute.</p>
</td>
</tr>
<tr id="ListLabels__row72131949193319"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListLabels__p1721694963311">id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListLabels__p921774911337">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListLabels__p52174494335">Label attribute ID.</p>
</td>
</tr>
<tr id="ListLabels__row221310491332"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListLabels__p121874913330">name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListLabels__p2218204918336">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListLabels__p18218114920332">Label attribute name.</p>
</td>
</tr>
<tr id="ListLabels__row1421364911338"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListLabels__p7219849173315">type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListLabels__p1221914917338">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListLabels__p122191349173318">Label attribute type. The options are as follows:</p>
<ul id="ListLabels__ul622034973312"><li id="ListLabels__li322094912332"><strong id="ListLabels__b2220154910335">text</strong>: text</li><li id="ListLabels__li1322011498333"><strong id="ListLabels__b20220104993316">select</strong>: single-choice drop-down list</li></ul>
</td>
</tr>
<tr id="ListLabels__row2021394913311"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListLabels__p82206496331">values</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListLabels__p17221174923320">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__p18221184913316">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__row162221049163313"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.6.2.4.1.1"><p id="ListLabels__p1922364993311">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.6.2.4.1.2"><p id="ListLabels__p2223194983311">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.6.2.4.1.3"><p id="ListLabels__p2223134993313">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListLabels__row4222154953320"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p id="ListLabels__p1222418491332">id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p id="ListLabels__p1522454912332">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p id="ListLabels__p822554910337">Label attribute value ID.</p>
</td>
</tr>
<tr id="ListLabels__row1622264943314"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p id="ListLabels__p5225174912335">value</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p id="ListLabels__p18225114914338">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p id="ListLabels__p19226949193313">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__row22267495339"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.7.2.4.1.1"><p id="ListLabels__p1422804933313">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.7.2.4.1.2"><p id="ListLabels__p18228134943310">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.7.2.4.1.3"><p id="ListLabels__p222914916330">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListLabels__row1422654912334"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="ListLabels__p182291749103311">@modelarts:color</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="ListLabels__p1122954963318">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="ListLabels__p102291449143312">Default attribute: Label color, which is a hexadecimal code of the color. By default, this parameter is left blank. Example: <strong id="ListLabels__b5230164912332">#FFFFF0</strong>.</p>
</td>
</tr>
<tr id="ListLabels__row022644953317"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="ListLabels__p323010492333">@modelarts:default_shape</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="ListLabels__p122302049133315">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="ListLabels__p6231249103319">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__ul123104993317"><li id="ListLabels__li152311649123318"><strong id="ListLabels__b2231114993316">bndbox</strong>: rectangle</li><li id="ListLabels__li523119493336"><strong id="ListLabels__b182321649153313">polygon</strong>: polygon</li><li id="ListLabels__li523211496337"><strong id="ListLabels__b142328492330">circle</strong>: circle</li><li id="ListLabels__li14232154911335"><strong id="ListLabels__b2233649103315">line</strong>: straight line</li><li id="ListLabels__li102331349153312"><strong id="ListLabels__b523384973313">dashed</strong>: dotted line</li><li id="ListLabels__li192331549153311"><strong id="ListLabels__b123316499332">point</strong>: point</li><li id="ListLabels__li142339494334"><strong id="ListLabels__b1234164943318">polyline</strong>: polyline</li></ul>
</td>
</tr>
<tr id="ListLabels__row11226114933319"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="ListLabels__p323454918332">@modelarts:from_type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="ListLabels__p1323474919336">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="ListLabels__p7235164943318">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__row1922644914335"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="ListLabels__p1223554993313">@modelarts:rename_to</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="ListLabels__p19235449183311">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="ListLabels__p2236124983318">Default attribute: The new name of the label.</p>
</td>
</tr>
<tr id="ListLabels__row18227164963320"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="ListLabels__p02361749183315">@modelarts:shortcut</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="ListLabels__p2236174911334">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="ListLabels__p7237149173316">Default attribute: Label shortcut key. By default, this parameter is left blank. For example: <strong id="ListLabels__b1237204993315">D</strong>.</p>
</td>
</tr>
<tr id="ListLabels__row7227174913338"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="ListLabels__p10237149153311">@modelarts:to_type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="ListLabels__p92371849163311">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="ListLabels__p4238249163319">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__section1223812499339"><h4 class="sectiontitle">Example Requests</h4><p id="ListLabels__p152381649153312">Querying All Labels of a Dataset</p>
<pre class="screen" id="ListLabels__screen16239124953315">GET https://{endpoint}/v2/{project_id}/datasets/WxCREuCkBSAlQr9xrde/data-annotations/labels</pre>
</div>
<div class="section" id="ListLabels__section14239124923319"><h4 class="sectiontitle">Example Responses</h4><p id="ListLabels__p1723914491333"><strong id="ListLabels__b17240154913320">Status code: 200</strong></p>
<p id="ListLabels__p424014492331">OK</p>
<pre class="screen" id="ListLabels__screen192401749183316">{
"labels" : [ {
"name" : "Cat",
"type" : 1,
"property" : {
"@modelarts:color" : "#3399ff"
}
}, {
"name" : "Rabbit",
"type" : 1,
"property" : {
"@modelarts:color" : "#3399ff"
}
} ]
}</pre>
</div>
<div class="section" id="ListLabels__section1024434963314"><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__row10245549123312"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="ListLabels__p124594953315">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__p62461749113312">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListLabels__row724514914333"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ListLabels__p82461249193317">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ListLabels__p324754919338">OK</p>
</td>
</tr>
<tr id="ListLabels__row92459492331"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ListLabels__p6247249103310">401</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ListLabels__p5248184910331">Unauthorized</p>
</td>
</tr>
<tr id="ListLabels__row1024564953318"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ListLabels__p192481949163318">403</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ListLabels__p1824824923316">Forbidden</p>
</td>
</tr>
<tr id="ListLabels__row122454490334"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ListLabels__p8249144917332">404</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ListLabels__p624964913337">Not Found</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ListLabels__section17249154933312"><h4 class="sectiontitle">Error Codes</h4><p id="ListLabels__p10250649103317">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="topic_300000012.html">Label Management</a></div>
</div>
</div>
View Git Blame Copy Permalink