vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/modelarts/api-ref/ListStats.html
Lai, Weijian 2f0818cf3d ModelArts API 22.3.0 version-20240311 
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>
2024-04-05 09:35:42 +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="body0000001349428221"><div class="section" id="ListStats__section2086920576427"><h4 class="sectiontitle">Function</h4><p id="ListStats__p1886945720427">This API is used to query dataset statistics.</p>
</div>
<div class="section" id="ListStats__section1387085715423"><h4 class="sectiontitle">URI</h4><p id="ListStats__p687115744211">GET /v2/{project_id}/datasets/{dataset_id}/data-annotations/stats</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListStats__table108722057114211" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="ListStats__row12871957134219"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="ListStats__p1987210577425">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="ListStats__p78721957164217">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="ListStats__p58739578425">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="ListStats__p28730577423">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListStats__row38712057144214"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="ListStats__p3873195717424">dataset_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="ListStats__p887495714213">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="ListStats__p1874145744216">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="ListStats__p5875657114211">Dataset ID.</p>
</td>
</tr>
<tr id="ListStats__row1087116570423"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="ListStats__p5876175714219">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="ListStats__p1287705710427">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="ListStats__p17878195717425">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="ListStats__p1987895717422">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__table88791957154210" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Query Parameters</caption><thead align="left"><tr id="ListStats__row78781557184219"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.1"><p id="ListStats__p18879857164212">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.2"><p id="ListStats__p1988025719422">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.3"><p id="ListStats__p168801257184216">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.4.2.5.1.4"><p id="ListStats__p1388012576428">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListStats__row138793575420"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListStats__p5881185710422">email</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListStats__p1881165784218">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListStats__p48819574423">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListStats__p1088135710423">Email address of a labeling team member.</p>
</td>
</tr>
<tr id="ListStats__row188792057104214"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListStats__p188211577428">locale</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListStats__p9882657114213">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListStats__p0882657134216">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListStats__p14882135719425">Language. The options are as follows:</p>
<p id="ListStats__p1178461165211"><strong id="ListStats__b388312574423">en-us</strong>: English (default value)</p>
</td>
</tr>
<tr id="ListStats__row1879457194210"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListStats__p19883145716424">sample_state</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListStats__p1888325794211">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListStats__p15884155718429">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListStats__p168841957134215">Query statistics on samples in a specified state. The options are as follows:</p>
<ul id="ListStats__ul788485720423"><li id="ListStats__li1688455734218"><strong id="ListStats__b388411572421"><strong>ALL</strong></strong>: labeled</li><li id="ListStats__li488565754217"><strong id="ListStats__b128852057184220"><strong>NONE</strong></strong>: unlabeled</li><li id="ListStats__li3885557194213"><strong id="ListStats__b188851457174214"><strong>UNCHECK</strong></strong>: pending acceptance</li><li id="ListStats__li148855570428"><strong id="ListStats__b20885155724218"><strong>ACCEPTED</strong></strong>: accepted</li><li id="ListStats__li158859579428"><strong id="ListStats__b13886145715424"><strong>REJECTED</strong></strong>: rejected</li><li id="ListStats__li2886257134218"><strong id="ListStats__b688625714426"><strong>UNREVIEWED</strong></strong>: pending review</li><li id="ListStats__li8886105754219"><strong id="ListStats__b2088615794210"><strong>REVIEWED</strong></strong>: reviewed</li><li id="ListStats__li388618576429"><strong id="ListStats__b88861457174220"><strong>WORKFORCE_SAMPLED</strong></strong>: sampled</li><li id="ListStats__li1488765704218"><strong id="ListStats__b4887145744211"><strong>WORKFORCE_SAMPLED_UNCHECK</strong></strong>: sampling unchecked</li><li id="ListStats__li3887157184216"><strong id="ListStats__b128871757184216"><strong>WORKFORCE_SAMPLED_CHECKED</strong></strong>: sampling checked</li><li id="ListStats__li888715715424"><strong id="ListStats__b198871357134215"><strong>WORKFORCE_SAMPLED_ACCEPTED</strong></strong>: sampling accepted</li><li id="ListStats__li178871457124216"><strong id="ListStats__b158881057154218"><strong>WORKFORCE_SAMPLED_REJECTED</strong></strong>: sampling rejected</li><li id="ListStats__li138881570426"><strong id="ListStats__b13888105784214"><strong>AUTO_ANNOTATION</strong></strong>: to be confirmed</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ListStats__section18888155716427"><h4 class="sectiontitle">Request Parameters</h4><p id="ListStats__p19888457134219">None</p>
</div>
<div class="section" id="ListStats__section1088915724218"><h4 class="sectiontitle">Response Parameters</h4><p id="ListStats__p12889357164216"><strong id="ListStats__b158899578429">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__row138901257114213"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="ListStats__p989210577427">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.2"><p id="ListStats__p189275704211">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.3.2.4.1.3"><p id="ListStats__p5892115744218">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListStats__row1489045764217"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ListStats__p1989285717424">data_path</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ListStats__p08931457144218">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ListStats__p28939574428">Path for storing data of a dataset.</p>
</td>
</tr>
<tr id="ListStats__row1289012578429"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ListStats__p188935575426">data_spliting_enable</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ListStats__p1489355764217">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ListStats__p6894145716424">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__ul2089455744219"><li id="ListStats__li1889485764212"><strong id="ListStats__b4894125715422">true</strong>: The dataset can be split into training set and validation set.</li><li id="ListStats__li13894115713423"><strong id="ListStats__b98947579420">false</strong>: The dataset cannot be split into training set and validation set.</li></ul>
</td>
</tr>
<tr id="ListStats__row13890557114213"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ListStats__p3894185710424">grouped_label_stats</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ListStats__p18895105717426">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__p789595719421">Label statistics grouped by labeling type.</p>
</td>
</tr>
<tr id="ListStats__row38901578422"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ListStats__p889555744210">hard_detail_stats</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ListStats__p118952575429">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__p98966572427">Statistics on hard example reasons. The type is <strong id="ListStats__b1896115784211">Map&lt;Integer, Pair&lt;Integer, HardDetail&gt;&gt;</strong>. The <strong id="ListStats__b589617575429">key</strong> of Map indicates the ID of the hard example reason, the <strong id="ListStats__b1389615719421">key</strong> of Pair indicates the number of times that the hard example reason occurs, and the <strong id="ListStats__b18961457154215">value</strong> of Pair indicates the hard example reason.</p>
</td>
</tr>
<tr id="ListStats__row1589085716429"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ListStats__p489615734219">key_sample_stats</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ListStats__p1489611573421">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__p13897155754219">Statistics on hard examples.</p>
</td>
</tr>
<tr id="ListStats__row989015578427"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ListStats__p1389745717429">label_stats</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ListStats__p11897185715426">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__p9897135714212">List of label statistics.</p>
</td>
</tr>
<tr id="ListStats__row17891657174214"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ListStats__p8898357144218">metadata_stats</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ListStats__p18898257204219">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__p189825715428">Statistics on sample metadata, in JSON format.</p>
</td>
</tr>
<tr id="ListStats__row14891125714425"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ListStats__p1689820578428">sample_stats</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ListStats__p15899175704210">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__p12899857104212">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__row19899457134219"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.1"><p id="ListStats__p3901957124215">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.2"><p id="ListStats__p14901957184218">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.4.2.4.1.3"><p id="ListStats__p29029576428">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListStats__row118999575427"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListStats__p4902357174210">attributes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListStats__p7902145717422">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__p690311575429">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__row18991757174212"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListStats__p10903105794216">count</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListStats__p199032057114216">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListStats__p390411571424">Number of labels.</p>
</td>
</tr>
<tr id="ListStats__row2090055754218"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListStats__p490475711424">name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListStats__p19904145712426">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListStats__p7905105718425">Label name.</p>
</td>
</tr>
<tr id="ListStats__row119007572424"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListStats__p16905125724214">property</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListStats__p890595744216"><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__p5906105712423">Basic attribute key-value pair of a label, such as color and shortcut keys.</p>
</td>
</tr>
<tr id="ListStats__row1900185713423"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListStats__p209061557144213">sample_count</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListStats__p1690615754216">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListStats__p17906105764218">Number of samples containing the label.</p>
</td>
</tr>
<tr id="ListStats__row1490010575428"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListStats__p190714576423">type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListStats__p179082574424">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListStats__p1790917577429">Label type. The options are as follows:</p>
<ul id="ListStats__ul15910145724217"><li id="ListStats__li6910185720426"><strong id="ListStats__b89101157134210">0</strong>: image classification</li><li id="ListStats__li10910757204219"><strong id="ListStats__b1491005710427">1</strong>: object detection</li><li id="ListStats__li1991155724217"><strong id="ListStats__b119111557194218">100</strong>: text classification</li><li id="ListStats__li209117571428"><strong id="ListStats__b19911115718423">101</strong>: named entity recognition</li><li id="ListStats__li139111057144211"><strong id="ListStats__b991255734219">102</strong>: text triplet relationship</li><li id="ListStats__li591275744218"><strong id="ListStats__b7912145719422">103</strong>: text triplet entity</li><li id="ListStats__li6912105718426"><strong id="ListStats__b15912145714219">200</strong>: speech classification</li><li id="ListStats__li109121857104215"><strong id="ListStats__b11912557154210">201</strong>: speech content</li><li id="ListStats__li1191365713425"><strong id="ListStats__b89131857144214">202</strong>: speech paragraph labeling</li><li id="ListStats__li19913145713424"><strong id="ListStats__b20913157164218">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__row891455716425"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.1"><p id="ListStats__p169152572424">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.2"><p id="ListStats__p2915115711422">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.5.2.4.1.3"><p id="ListStats__p39163574421">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListStats__row9914115716420"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListStats__p291617579421">@modelarts:color</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListStats__p129165571426">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListStats__p9916357184216">Default attribute: Label color, which is a hexadecimal code of the color. By default, this parameter is left blank. Example: <strong id="ListStats__b12916155717425">#FFFFF0</strong>.</p>
</td>
</tr>
<tr id="ListStats__row1791419572427"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListStats__p13917185712427">@modelarts:default_shape</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListStats__p139171157154218">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListStats__p1917135784214">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__ul6917155724211"><li id="ListStats__li2918155719428"><strong id="ListStats__b99182570421">bndbox</strong>: rectangle</li><li id="ListStats__li691835744210"><strong id="ListStats__b29188571428">polygon</strong>: polygon</li><li id="ListStats__li391895710429"><strong id="ListStats__b169194578426">circle</strong>: circle</li><li id="ListStats__li3919857164213"><strong id="ListStats__b291935716422">line</strong>: straight line</li><li id="ListStats__li5919135711428"><strong id="ListStats__b139192578426">dashed</strong>: dotted line</li><li id="ListStats__li9919115724210"><strong id="ListStats__b1991945716428">point</strong>: point</li><li id="ListStats__li4919155744217"><strong id="ListStats__b1792065774218">polyline</strong>: polyline</li></ul>
</td>
</tr>
<tr id="ListStats__row1091485711424"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListStats__p0920185718427">@modelarts:from_type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListStats__p1092012575427">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListStats__p1892085774212">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__row4914155714420"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListStats__p39218577425">@modelarts:rename_to</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListStats__p692175718422">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListStats__p39211257134218">Default attribute: The new name of the label.</p>
</td>
</tr>
<tr id="ListStats__row179141457134217"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListStats__p169225571424">@modelarts:shortcut</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListStats__p2922157174216">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListStats__p492211575424">Default attribute: Label shortcut key. By default, this parameter is left blank. For example: <strong id="ListStats__b8922125711424">D</strong>.</p>
</td>
</tr>
<tr id="ListStats__row15914145716423"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListStats__p392318573425">@modelarts:to_type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListStats__p592316572426">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListStats__p189241657124220">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__row1292415764217"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.6.2.4.1.1"><p id="ListStats__p17925195710425">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.6.2.4.1.2"><p id="ListStats__p1292617579421">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.6.2.4.1.3"><p id="ListStats__p1792665711424">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListStats__row19924135718420"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p id="ListStats__p1292775719422">key</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p id="ListStats__p0927657144219">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p id="ListStats__p39279579424">Number of times that a hard example reason occurs.</p>
</td>
</tr>
<tr id="ListStats__row4924457174217"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p id="ListStats__p179281757164215">value</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p id="ListStats__p1292813575420"><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__p11928125754212">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__row1092905711421"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.7.2.4.1.1"><p id="ListStats__p593015713422">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.7.2.4.1.2"><p id="ListStats__p1931957144210">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.7.2.4.1.3"><p id="ListStats__p2931457194211">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListStats__row14929115784211"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="ListStats__p1593111572422">alo_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="ListStats__p189321571429">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="ListStats__p69321957144214">Alias.</p>
</td>
</tr>
<tr id="ListStats__row892920573420"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="ListStats__p129322057104210">id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="ListStats__p393245712426">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="ListStats__p293365716428">Reason ID.</p>
</td>
</tr>
<tr id="ListStats__row1892915714427"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="ListStats__p29336578427">reason</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="ListStats__p2093355734214">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="ListStats__p18933175744216">Reason description.</p>
</td>
</tr>
<tr id="ListStats__row9929125714216"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="ListStats__p4934457134213">suggestion</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="ListStats__p1893405717426">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="ListStats__p1593495715420">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__row393525744218"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.8.2.4.1.1"><p id="ListStats__p169371557124213">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.8.2.4.1.2"><p id="ListStats__p1593717571427">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.8.2.4.1.3"><p id="ListStats__p16937205724213">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListStats__row14935115713425"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.1 "><p id="ListStats__p20938857164215">default_value</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.2 "><p id="ListStats__p793825710429">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.8.2.4.1.3 "><p id="ListStats__p0938125719421">Default value of a label attribute.</p>
</td>
</tr>
<tr id="ListStats__row149354571426"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.1 "><p id="ListStats__p17939257154214">id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.2 "><p id="ListStats__p793910577428">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.8.2.4.1.3 "><p id="ListStats__p1493965715424">Label attribute ID.</p>
</td>
</tr>
<tr id="ListStats__row69351257114218"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.1 "><p id="ListStats__p19401657184213">name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.2 "><p id="ListStats__p09418574422">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.8.2.4.1.3 "><p id="ListStats__p3941125717422">Label attribute name.</p>
</td>
</tr>
<tr id="ListStats__row1935195744216"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.1 "><p id="ListStats__p13941175713422">type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.2 "><p id="ListStats__p294285712422">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.8.2.4.1.3 "><p id="ListStats__p1794215744216">Label attribute type. The options are as follows:</p>
<ul id="ListStats__ul1794245713422"><li id="ListStats__li19432578425"><strong id="ListStats__b149431157124219">text</strong>: text</li><li id="ListStats__li894345718421"><strong id="ListStats__b79431157114215">select</strong>: single-choice drop-down list</li></ul>
</td>
</tr>
<tr id="ListStats__row49362057154215"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.1 "><p id="ListStats__p99431757174214">values</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.2 "><p id="ListStats__p0181185814422">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__p1418112581420">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__row3945195720427"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.9.2.4.1.1"><p id="ListStats__p20181125817424">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.9.2.4.1.2"><p id="ListStats__p1418115884211">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.9.2.4.1.3"><p id="ListStats__p21829588422">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListStats__row294511571427"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.4.1.1 "><p id="ListStats__p1118219588426">id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.4.1.2 "><p id="ListStats__p2182135811428">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.9.2.4.1.3 "><p id="ListStats__p13182158164214">Label attribute value ID.</p>
</td>
</tr>
<tr id="ListStats__row139451357164210"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.4.1.1 "><p id="ListStats__p19182458104215">value</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.4.1.2 "><p id="ListStats__p151821958104213">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.9.2.4.1.3 "><p id="ListStats__p19182125864220">Label attribute value.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ListStats__section10182458184220"><h4 class="sectiontitle">Example Requests</h4><p id="ListStats__p2018210587426">Querying Dataset Statistics</p>
<pre class="screen" id="ListStats__screen10182145813426">GET https://{endpoint}/v2/{project_id}/datasets/WxCREuCkBSAlQr9xrde/data-annotations/stats</pre>
</div>
<div class="section" id="ListStats__section71828585420"><h4 class="sectiontitle">Example Responses</h4><p id="ListStats__p61821458154215"><strong id="ListStats__b4183145811426">Status code: 200</strong></p>
<p id="ListStats__p918385817423">OK</p>
<pre class="screen" id="ListStats__screen14183185812420">{
"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__section1184185815428"><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__row795235744213"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="ListStats__p1418516585428">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__p218513583429">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListStats__row13953057144219"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ListStats__p5185175894213">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ListStats__p41851858184213">OK</p>
</td>
</tr>
<tr id="ListStats__row129535577422"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ListStats__p11185105814214">401</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ListStats__p1418535817424">Unauthorized</p>
</td>
</tr>
<tr id="ListStats__row9953957154212"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ListStats__p21854581421">403</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ListStats__p6185125824219">Forbidden</p>
</td>
</tr>
<tr id="ListStats__row695375794211"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ListStats__p3185158104217">404</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ListStats__p1218514580423">Not Found</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ListStats__section151859581420"><h4 class="sectiontitle">Error Codes</h4><p id="ListStats__p718513589422">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