youjiageng1/doc-exports
1
0
Fork 0
forked from laiweijian4/doc-exports
Code Pull Requests Activity
doc-exports/docs/modelarts/api-ref/ListStats.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

480 lines
36 KiB
HTML
Raw Blame History

<a name="ListStats"></a><a name="ListStats"></a>
<h1 class="topictitle1">Querying Dataset Statistics</h1>
<div id="body118615101583"><div class="section" id="ListStats__section18611210989"><h4 class="sectiontitle">Function</h4><p id="ListStats__p28628101288">This API is used to query dataset statistics.</p>
</div>
<div class="section" id="ListStats__section148636101184"><h4 class="sectiontitle">URI</h4><p id="ListStats__p198633103811">GET /v2/{project_id}/datasets/{dataset_id}/data-annotations/stats</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListStats__table186421011815" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="ListStats__row18863910686"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="ListStats__p12864151011817">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="ListStats__p10865151010810">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="ListStats__p68651710584">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="ListStats__p118651103815">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListStats__row13864181016816"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="ListStats__p386511101814">dataset_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="ListStats__p1486611017812">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="ListStats__p6866101012819">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="ListStats__p1386714101687">Dataset ID.</p>
</td>
</tr>
<tr id="ListStats__row8864111017814"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="ListStats__p586715104815">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="ListStats__p286731019813">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="ListStats__p386713101782">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="ListStats__p9868131018816">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="ListStats__table14869101012811" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Query Parameters</caption><thead align="left"><tr id="ListStats__row38685101881"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.1"><p id="ListStats__p687010101686">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.2"><p id="ListStats__p7870121010817">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.3"><p id="ListStats__p18702101282">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.4.2.5.1.4"><p id="ListStats__p187061018817">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListStats__row4868210286"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListStats__p987113101184">email</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListStats__p1987131012818">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListStats__p1487111103812">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListStats__p187212108811">Email address of a labeling team member.</p>
</td>
</tr>
<tr id="ListStats__row0868111013820"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListStats__p148728101189">locale</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListStats__p3872410181">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListStats__p148736101388">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListStats__p16873141015816">Language. The options are as follows:</p>
<p id="ListStats__p164623589292"><strong id="ListStats__b198741110388">en-us</strong>: English (default value)</p>
</td>
</tr>
<tr id="ListStats__row786931020818"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListStats__p148741910384">sample_state</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListStats__p78740101882">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListStats__p2087515101818">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListStats__p188755101789">Query statistics on samples in a specified state. The options are as follows:</p>
<ul id="ListStats__ul68751410884"><li id="ListStats__li198757109810"><strong id="ListStats__b1087616100818"><strong>ALL</strong></strong>: labeled</li><li id="ListStats__li78767108812"><strong id="ListStats__b987651011816"><strong>NONE</strong></strong>: unlabeled</li><li id="ListStats__li78769108817"><strong id="ListStats__b8876610289"><strong>UNCHECK</strong></strong>: pending acceptance</li><li id="ListStats__li1887610102814"><strong id="ListStats__b2877181013817"><strong>ACCEPTED</strong></strong>: accepted</li><li id="ListStats__li168776101289"><strong id="ListStats__b88771510686"><strong>REJECTED</strong></strong>: rejected</li><li id="ListStats__li287717103818"><strong id="ListStats__b587715108810"><strong>UNREVIEWED</strong></strong>: pending review</li><li id="ListStats__li1587711101283"><strong id="ListStats__b10878181013815"><strong>REVIEWED</strong></strong>: reviewed</li><li id="ListStats__li78781510281"><strong id="ListStats__b28786107820"><strong>WORKFORCE_SAMPLED</strong></strong>: sampled</li><li id="ListStats__li1987814101882"><strong id="ListStats__b10878161018817"><strong>WORKFORCE_SAMPLED_UNCHECK</strong></strong>: sampling unchecked</li><li id="ListStats__li987911101685"><strong id="ListStats__b28795101285"><strong>WORKFORCE_SAMPLED_CHECKED</strong></strong>: sampling checked</li><li id="ListStats__li188795109815"><strong id="ListStats__b178791410388"><strong>WORKFORCE_SAMPLED_ACCEPTED</strong></strong>: sampling accepted</li><li id="ListStats__li88799106818"><strong id="ListStats__b1887912103815"><strong>WORKFORCE_SAMPLED_REJECTED</strong></strong>: sampling rejected</li><li id="ListStats__li118801210688"><strong id="ListStats__b14880201018815"><strong>AUTO_ANNOTATION</strong></strong>: to be confirmed</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ListStats__section158808101588"><h4 class="sectiontitle">Request Parameters</h4><p id="ListStats__p158809101181">None</p>
</div>
<div class="section" id="ListStats__section158818108811"><h4 class="sectiontitle">Response Parameters</h4><p id="ListStats__p58814101088"><strong id="ListStats__b088121014820">Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListStats__response_ListStatsResp" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response body parameters</caption><thead align="left"><tr id="ListStats__row14882101018811"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="ListStats__p08831710684">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.2"><p id="ListStats__p108834101985">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.3.2.4.1.3"><p id="ListStats__p1188311109813">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListStats__row1888201011813"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ListStats__p98835101815">data_path</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ListStats__p8884191011816">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ListStats__p1088421011817">Path for storing data of a dataset.</p>
</td>
</tr>
<tr id="ListStats__row2882101015810"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ListStats__p3884310386">data_spliting_enable</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ListStats__p19884810485">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ListStats__p18885310282">Whether the dataset can be split into training set and validation set based on the sample labeling statistics. The options are as follows:</p>
<ul id="ListStats__ul68851610889"><li id="ListStats__li1885210881"><strong id="ListStats__b1088510101989">true</strong>: The dataset can be split into training set and validation set.</li><li id="ListStats__li168858101986"><strong id="ListStats__b688519103816">false</strong>: The dataset cannot be split into training set and validation set.</li></ul>
</td>
</tr>
<tr id="ListStats__row68827103813"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ListStats__p158851107812">grouped_label_stats</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ListStats__p11886910081">Map&lt;String,Array&lt;<a href="#ListStats__response_LabelStats">LabelStats</a>&gt;&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ListStats__p1988651018813">Label statistics grouped by labeling type.</p>
</td>
</tr>
<tr id="ListStats__row9882410782"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ListStats__p14887161019816">hard_detail_stats</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ListStats__p788771012812">Map&lt;String,<a href="#ListStats__response_PairOfintAndHardDetail">PairOfintAndHardDetail</a>&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ListStats__p8887171015814">Statistics on hard example reasons. The type is <strong id="ListStats__b88871810686">Map&lt;Integer, Pair&lt;Integer, HardDetail&gt;&gt;</strong>. The <strong id="ListStats__b388713101284">key</strong> of Map indicates the ID of the hard example reason, the <strong id="ListStats__b38885102817">key</strong> of Pair indicates the number of times that the hard example reason occurs, and the <strong id="ListStats__b128882101480">value</strong> of Pair indicates the hard example reason.</p>
</td>
</tr>
<tr id="ListStats__row48821310185"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ListStats__p19888910083">key_sample_stats</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ListStats__p188817101587">Map&lt;String,Integer&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ListStats__p12888121018814">Statistics on hard examples.</p>
</td>
</tr>
<tr id="ListStats__row188827109813"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ListStats__p488920101489">label_stats</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ListStats__p1988913101083">Array of <a href="#ListStats__response_LabelStats">LabelStats</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ListStats__p1188917101886">List of label statistics.</p>
</td>
</tr>
<tr id="ListStats__row98829101885"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ListStats__p188911011815">metadata_stats</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ListStats__p3890191017815">Map&lt;String,Object&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ListStats__p2890191011816">Statistics on sample metadata, in JSON format.</p>
</td>
</tr>
<tr id="ListStats__row1188219101988"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ListStats__p289020100819">sample_stats</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ListStats__p98911410683">Map&lt;String,Integer&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ListStats__p48911810485">Statistics on sample status.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="ListStats__response_LabelStats"></a><a name="response_LabelStats"></a><table cellpadding="4" cellspacing="0" summary="" id="ListStats__response_LabelStats" frame="border" border="1" rules="all"><caption><b>Table 4 </b>LabelStats</caption><thead align="left"><tr id="ListStats__row1289210101589"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.1"><p id="ListStats__p19893121013817">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.2"><p id="ListStats__p089415107817">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.4.2.4.1.3"><p id="ListStats__p208948100813">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListStats__row389210104811"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListStats__p28941710283">attributes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListStats__p289516101586">Array of <a href="#ListStats__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="ListStats__p4895210289">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="ListStats__row389212101286"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListStats__p148956102815">count</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListStats__p58964101586">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListStats__p20897121018818">Number of labels.</p>
</td>
</tr>
<tr id="ListStats__row48929105815"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListStats__p18971810782">name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListStats__p188971910188">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListStats__p1689791011814">Label name.</p>
</td>
</tr>
<tr id="ListStats__row1189211101686"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListStats__p78984101287">property</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListStats__p589811019814"><a href="#ListStats__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="ListStats__p11898141010811">Basic attribute key-value pair of a label, such as color and shortcut keys.</p>
</td>
</tr>
<tr id="ListStats__row48929101811"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListStats__p889820101980">sample_count</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListStats__p8899610882">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListStats__p1089918104817">Number of samples containing the label.</p>
</td>
</tr>
<tr id="ListStats__row6892181012818"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListStats__p158995103816">type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListStats__p68991310183">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListStats__p5900161016812">Label type. The options are as follows:</p>
<ul id="ListStats__ul590012101882"><li id="ListStats__li890031012816"><strong id="ListStats__b79001510182">0</strong>: image classification</li><li id="ListStats__li2901161017811"><strong id="ListStats__b69011710580">1</strong>: object detection</li><li id="ListStats__li20901121018812"><strong id="ListStats__b159018100815">100</strong>: text classification</li><li id="ListStats__li1990171015818"><strong id="ListStats__b10901510489">101</strong>: named entity recognition</li><li id="ListStats__li29014101981"><strong id="ListStats__b190214101819">102</strong>: text triplet relationship</li><li id="ListStats__li29022106813"><strong id="ListStats__b4902161012815">103</strong>: text triplet entity</li><li id="ListStats__li169022101088"><strong id="ListStats__b990217106819">200</strong>: speech classification</li><li id="ListStats__li29021410587"><strong id="ListStats__b1590281016818">201</strong>: speech content</li><li id="ListStats__li690310101681"><strong id="ListStats__b1390318104811">202</strong>: speech paragraph labeling</li><li id="ListStats__li1790311101289"><strong id="ListStats__b13903710284">600</strong>: video classification</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="ListStats__response_LabelProperty"></a><a name="response_LabelProperty"></a><table cellpadding="4" cellspacing="0" summary="" id="ListStats__response_LabelProperty" frame="border" border="1" rules="all"><caption><b>Table 5 </b>LabelProperty</caption><thead align="left"><tr id="ListStats__row3904201013810"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.1"><p id="ListStats__p690512105820">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.2"><p id="ListStats__p209058108819">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.5.2.4.1.3"><p id="ListStats__p119058108812">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListStats__row49041101385"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListStats__p8906181013814">@modelarts:color</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListStats__p09061510682">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListStats__p89061910585">Default attribute: Label color, which is a hexadecimal code of the color. By default, this parameter is left blank. Example: <strong id="ListStats__b1590641015817">#FFFFF0</strong>.</p>
</td>
</tr>
<tr id="ListStats__row19904161012819"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListStats__p139073106816">@modelarts:default_shape</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListStats__p1290720101189">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListStats__p129071910888">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="ListStats__ul490720108816"><li id="ListStats__li9907101017810"><strong id="ListStats__b1390715101485">bndbox</strong>: rectangle</li><li id="ListStats__li20908181011815"><strong id="ListStats__b8908111010817">polygon</strong>: polygon</li><li id="ListStats__li129084103811"><strong id="ListStats__b69088101080">circle</strong>: circle</li><li id="ListStats__li1090819101686"><strong id="ListStats__b29091010086">line</strong>: straight line</li><li id="ListStats__li69094101383"><strong id="ListStats__b1190916100812">dashed</strong>: dotted line</li><li id="ListStats__li179098101787"><strong id="ListStats__b69098101789">point</strong>: point</li><li id="ListStats__li2090918106811"><strong id="ListStats__b9910121015814">polyline</strong>: polyline</li></ul>
</td>
</tr>
<tr id="ListStats__row129044101987"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListStats__p109104101788">@modelarts:from_type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListStats__p891013101587">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListStats__p139105101816">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="ListStats__row179043101782"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListStats__p8911151012814">@modelarts:rename_to</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListStats__p49111610882">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListStats__p791112102086">Default attribute: The new name of the label.</p>
</td>
</tr>
<tr id="ListStats__row189042101289"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListStats__p109128105818">@modelarts:shortcut</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListStats__p139121110780">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListStats__p891219107817">Default attribute: Label shortcut key. By default, this parameter is left blank. For example: <strong id="ListStats__b491214101286">D</strong>.</p>
</td>
</tr>
<tr id="ListStats__row139041810789"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListStats__p69131610583">@modelarts:to_type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListStats__p2913111018813">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListStats__p19913810988">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 class="tablenoborder"><a name="ListStats__response_PairOfintAndHardDetail"></a><a name="response_PairOfintAndHardDetail"></a><table cellpadding="4" cellspacing="0" summary="" id="ListStats__response_PairOfintAndHardDetail" frame="border" border="1" rules="all"><caption><b>Table 6 </b>PairOfintAndHardDetail</caption><thead align="left"><tr id="ListStats__row2091401014812"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.6.2.4.1.1"><p id="ListStats__p39157101484">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.6.2.4.1.2"><p id="ListStats__p14916151014810">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.6.2.4.1.3"><p id="ListStats__p49169101483">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListStats__row1191512106819"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p id="ListStats__p1791613109813">key</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p id="ListStats__p1192361012812">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p id="ListStats__p139231510785">Number of times that a hard example reason occurs.</p>
</td>
</tr>
<tr id="ListStats__row091512101087"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p id="ListStats__p29242101785">value</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p id="ListStats__p59247101386"><a href="#ListStats__response_HardDetail">HardDetail</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p id="ListStats__p1092412101789">Reason for a hard example.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="ListStats__response_HardDetail"></a><a name="response_HardDetail"></a><table cellpadding="4" cellspacing="0" summary="" id="ListStats__response_HardDetail" frame="border" border="1" rules="all"><caption><b>Table 7 </b>HardDetail</caption><thead align="left"><tr id="ListStats__row592517108815"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.7.2.4.1.1"><p id="ListStats__p69278104820">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.7.2.4.1.2"><p id="ListStats__p179276107810">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.7.2.4.1.3"><p id="ListStats__p12927110680">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListStats__row9925610583"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="ListStats__p99288101819">alo_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="ListStats__p19928161017819">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="ListStats__p1492813106816">Alias.</p>
</td>
</tr>
<tr id="ListStats__row179251510584"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="ListStats__p79292010688">id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="ListStats__p592981012811">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="ListStats__p15929131014818">Reason ID.</p>
</td>
</tr>
<tr id="ListStats__row189251010585"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="ListStats__p09301510984">reason</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="ListStats__p09309101388">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="ListStats__p1793016101812">Reason description.</p>
</td>
</tr>
<tr id="ListStats__row179251110087"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="ListStats__p793115101280">suggestion</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="ListStats__p139314106814">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="ListStats__p39314101789">Handling suggestion.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="ListStats__response_LabelAttribute"></a><a name="response_LabelAttribute"></a><table cellpadding="4" cellspacing="0" summary="" id="ListStats__response_LabelAttribute" frame="border" border="1" rules="all"><caption><b>Table 8 </b>LabelAttribute</caption><thead align="left"><tr id="ListStats__row1993216101887"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.8.2.4.1.1"><p id="ListStats__p109334101082">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.8.2.4.1.2"><p id="ListStats__p993341010815">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.8.2.4.1.3"><p id="ListStats__p79341610889">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListStats__row159323101284"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.1 "><p id="ListStats__p1993411015816">default_value</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.2 "><p id="ListStats__p993421014818">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.8.2.4.1.3 "><p id="ListStats__p12935310382">Default value of a label attribute.</p>
</td>
</tr>
<tr id="ListStats__row49321101880"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.1 "><p id="ListStats__p1093581011813">id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.2 "><p id="ListStats__p1293661011810">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.8.2.4.1.3 "><p id="ListStats__p149363101187">Label attribute ID.</p>
</td>
</tr>
<tr id="ListStats__row193251018820"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.1 "><p id="ListStats__p1393612101988">name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.2 "><p id="ListStats__p189372106811">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.8.2.4.1.3 "><p id="ListStats__p1993712101486">Label attribute name.</p>
</td>
</tr>
<tr id="ListStats__row199321110189"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.1 "><p id="ListStats__p1493715109820">type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.2 "><p id="ListStats__p169383101586">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.8.2.4.1.3 "><p id="ListStats__p093891010818">Label attribute type. The options are as follows:</p>
<ul id="ListStats__ul10938110884"><li id="ListStats__li1693851011819"><strong id="ListStats__b693812102089">text</strong>: text</li><li id="ListStats__li1939131018813"><strong id="ListStats__b593915101985">select</strong>: single-choice drop-down list</li></ul>
</td>
</tr>
<tr id="ListStats__row293218106816"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.1 "><p id="ListStats__p179391210885">values</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.2 "><p id="ListStats__p827614111688">Array of <a href="#ListStats__response_LabelAttributeValue">LabelAttributeValue</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.8.2.4.1.3 "><p id="ListStats__p527611116819">List of label attribute values.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="ListStats__response_LabelAttributeValue"></a><a name="response_LabelAttributeValue"></a><table cellpadding="4" cellspacing="0" summary="" id="ListStats__response_LabelAttributeValue" frame="border" border="1" rules="all"><caption><b>Table 9 </b>LabelAttributeValue</caption><thead align="left"><tr id="ListStats__row13941151016812"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.9.2.4.1.1"><p id="ListStats__p227791113811">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.9.2.4.1.2"><p id="ListStats__p1227717111818">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.9.2.4.1.3"><p id="ListStats__p7278811487">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListStats__row1094131013810"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.4.1.1 "><p id="ListStats__p6278171110819">id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.4.1.2 "><p id="ListStats__p92785111788">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.9.2.4.1.3 "><p id="ListStats__p5278811689">Label attribute value ID.</p>
</td>
</tr>
<tr id="ListStats__row1194114102811"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.4.1.1 "><p id="ListStats__p192781111986">value</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.4.1.2 "><p id="ListStats__p14278131114814">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.9.2.4.1.3 "><p id="ListStats__p627818119811">Label attribute value.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ListStats__section8278311582"><h4 class="sectiontitle">Example Requests</h4><p id="ListStats__p227815117815">Querying Dataset Statistics</p>
<pre class="screen" id="ListStats__screen82790111184">GET https://{endpoint}/v2/{project_id}/datasets/WxCREuCkBSAlQr9xrde/data-annotations/stats</pre>
</div>
<div class="section" id="ListStats__section22796111687"><h4 class="sectiontitle">Example Responses</h4><p id="ListStats__p827912117819"><strong id="ListStats__b62791011480">Status code: 200</strong></p>
<p id="ListStats__p142791112819">OK</p>
<pre class="screen" id="ListStats__screen1027910116817">{
"label_stats" : [ {
"name" : "Rabbit",
"type" : 1,
"property" : {
"@modelarts:color" : "#3399ff"
},
"count" : 8,
"sample_count" : 5
} ],
"sample_stats" : {
"un_annotation" : 309,
"all" : 317,
"total" : 317,
"deleted" : 0,
"manual_annotation" : 8,
"auto_annotation" : 0,
"lefted" : 317
},
"key_sample_stats" : {
"total" : 317,
"non_key_sample" : 315,
"key_sample" : 2
},
"deletion_stats" : { },
"metadata_stats" : { },
"data_spliting_enable" : false
}</pre>
</div>
<div class="section" id="ListStats__section02811711388"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListStats__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="ListStats__row15951121011811"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="ListStats__p202811311881">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p id="ListStats__p928111119813">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListStats__row1195141012818"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ListStats__p14281101120810">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ListStats__p52813112816">OK</p>
</td>
</tr>
<tr id="ListStats__row995119102810"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ListStats__p928214112087">401</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ListStats__p112821311983">Unauthorized</p>
</td>
</tr>
<tr id="ListStats__row18951131010810"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ListStats__p16282151119812">403</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ListStats__p14282161118818">Forbidden</p>
</td>
</tr>
<tr id="ListStats__row1895161010815"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ListStats__p1928218111689">404</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ListStats__p928251113812">Not Found</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ListStats__section1282511684"><h4 class="sectiontitle">Error Codes</h4><p id="ListStats__p2282141113817">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">Dataset Management</a></div>
</div>
</div>
View Git Blame Copy Permalink