Debian Codegraph @

docs/dyn/documentai_v1beta3.projects.locations.processors.processorVersions.evaluations.html

raw
1 <html><body>
2 <style>
3
4 body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13 }
14
15 body {
16 font-size: 13px;
17 padding: 1em;
18 }
19
20 h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23 }
24
25 h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28 }
29
30 h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34 }
35
36 pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39 }
40
41 pre {
42 margin-top: 0.5em;
43 }
44
45 h1, h2, h3, p {
46 font-family: Arial, sans serif;
47 }
48
49 h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51 }
52
53 .toc_element {
54 margin-top: 0.5em;
55 }
56
57 .firstline {
58 margin-left: 2 em;
59 }
60
61 .method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66 }
67
68 .details {
69 font-weight: bold;
70 font-size: 14px;
71 }
72
73 </style>
74
75 <h1><a href="documentai_v1beta3.html">Cloud Document AI API</a> . <a href="documentai_v1beta3.projects.html">projects</a> . <a href="documentai_v1beta3.projects.locations.html">locations</a> . <a href="documentai_v1beta3.projects.locations.processors.html">processors</a> . <a href="documentai_v1beta3.projects.locations.processors.processorVersions.html">processorVersions</a> . <a href="documentai_v1beta3.projects.locations.processors.processorVersions.evaluations.html">evaluations</a></h1>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="#close">close()</a></code></p>
79 <p class="firstline">Close httplib2 connections.</p>
80 <p class="toc_element">
81 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
82 <p class="firstline">Retrieves a specific evaluation.</p>
83 <p class="toc_element">
84 <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
85 <p class="firstline">Retrieves a set of evaluations for a given processor version.</p>
86 <p class="toc_element">
87 <code><a href="#list_next">list_next()</a></code></p>
88 <p class="firstline">Retrieves the next page of results.</p>
89 <h3>Method Details</h3>
90 <div class="method">
91 <code class="details" id="close">close()</code>
92 <pre>Close httplib2 connections.</pre>
93 </div>
94
95 <div class="method">
96 <code class="details" id="get">get(name, x__xgafv=None)</code>
97 <pre>Retrieves a specific evaluation.
98
99 Args:
100 name: string, Required. The resource name of the Evaluation to get. `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}/evaluations/{evaluation}` (required)
101 x__xgafv: string, V1 error format.
102 Allowed values
103 1 - v1 error format
104 2 - v2 error format
105
106 Returns:
107 An object of the form:
108
109 { # An evaluation of a ProcessorVersion&#x27;s performance.
110 &quot;allEntitiesMetrics&quot;: { # Metrics across multiple confidence levels. # Metrics for all the entities in aggregate.
111 &quot;auprc&quot;: 3.14, # The calculated area under the precision recall curve (AUPRC), computed by integrating over all confidence thresholds.
112 &quot;auprcExact&quot;: 3.14, # The AUPRC for metrics with fuzzy matching disabled, i.e., exact matching only.
113 &quot;confidenceLevelMetrics&quot;: [ # Metrics across confidence levels with fuzzy matching enabled.
114 { # Evaluations metrics, at a specific confidence level.
115 &quot;confidenceLevel&quot;: 3.14, # The confidence level.
116 &quot;metrics&quot;: { # Evaluation metrics, either in aggregate or about a specific entity. # The metrics at the specific confidence level.
117 &quot;f1Score&quot;: 3.14, # The calculated F1 score.
118 &quot;falseNegativesCount&quot;: 42, # The amount of false negatives.
119 &quot;falsePositivesCount&quot;: 42, # The amount of false positives.
120 &quot;groundTruthDocumentCount&quot;: 42, # The amount of documents with a ground truth occurrence.
121 &quot;groundTruthOccurrencesCount&quot;: 42, # The amount of occurrences in ground truth documents.
122 &quot;precision&quot;: 3.14, # The calculated precision.
123 &quot;predictedDocumentCount&quot;: 42, # The amount of documents with a predicted occurrence.
124 &quot;predictedOccurrencesCount&quot;: 42, # The amount of occurrences in predicted documents.
125 &quot;recall&quot;: 3.14, # The calculated recall.
126 &quot;totalDocumentsCount&quot;: 42, # The amount of documents that had an occurrence of this label.
127 &quot;truePositivesCount&quot;: 42, # The amount of true positives.
128 },
129 },
130 ],
131 &quot;confidenceLevelMetricsExact&quot;: [ # Metrics across confidence levels with only exact matching.
132 { # Evaluations metrics, at a specific confidence level.
133 &quot;confidenceLevel&quot;: 3.14, # The confidence level.
134 &quot;metrics&quot;: { # Evaluation metrics, either in aggregate or about a specific entity. # The metrics at the specific confidence level.
135 &quot;f1Score&quot;: 3.14, # The calculated F1 score.
136 &quot;falseNegativesCount&quot;: 42, # The amount of false negatives.
137 &quot;falsePositivesCount&quot;: 42, # The amount of false positives.
138 &quot;groundTruthDocumentCount&quot;: 42, # The amount of documents with a ground truth occurrence.
139 &quot;groundTruthOccurrencesCount&quot;: 42, # The amount of occurrences in ground truth documents.
140 &quot;precision&quot;: 3.14, # The calculated precision.
141 &quot;predictedDocumentCount&quot;: 42, # The amount of documents with a predicted occurrence.
142 &quot;predictedOccurrencesCount&quot;: 42, # The amount of occurrences in predicted documents.
143 &quot;recall&quot;: 3.14, # The calculated recall.
144 &quot;totalDocumentsCount&quot;: 42, # The amount of documents that had an occurrence of this label.
145 &quot;truePositivesCount&quot;: 42, # The amount of true positives.
146 },
147 },
148 ],
149 &quot;estimatedCalibrationError&quot;: 3.14, # The Estimated Calibration Error (ECE) of the confidence of the predicted entities.
150 &quot;estimatedCalibrationErrorExact&quot;: 3.14, # The ECE for the predicted entities with fuzzy matching disabled, i.e., exact matching only.
151 &quot;metricsType&quot;: &quot;A String&quot;, # The metrics type for the label.
152 },
153 &quot;createTime&quot;: &quot;A String&quot;, # The time that the evaluation was created.
154 &quot;documentCounters&quot;: { # Evaluation counters for the documents that were used. # Counters for the documents used in the evaluation.
155 &quot;evaluatedDocumentsCount&quot;: 42, # How many documents were used in the evaluation.
156 &quot;failedDocumentsCount&quot;: 42, # How many documents were not included in the evaluation as Document AI failed to process them.
157 &quot;inputDocumentsCount&quot;: 42, # How many documents were sent for evaluation.
158 &quot;invalidDocumentsCount&quot;: 42, # How many documents were not included in the evaluation as they didn&#x27;t pass validation.
159 },
160 &quot;entityMetrics&quot;: { # Metrics across confidence levels, for different entities.
161 &quot;a_key&quot;: { # Metrics across multiple confidence levels.
162 &quot;auprc&quot;: 3.14, # The calculated area under the precision recall curve (AUPRC), computed by integrating over all confidence thresholds.
163 &quot;auprcExact&quot;: 3.14, # The AUPRC for metrics with fuzzy matching disabled, i.e., exact matching only.
164 &quot;confidenceLevelMetrics&quot;: [ # Metrics across confidence levels with fuzzy matching enabled.
165 { # Evaluations metrics, at a specific confidence level.
166 &quot;confidenceLevel&quot;: 3.14, # The confidence level.
167 &quot;metrics&quot;: { # Evaluation metrics, either in aggregate or about a specific entity. # The metrics at the specific confidence level.
168 &quot;f1Score&quot;: 3.14, # The calculated F1 score.
169 &quot;falseNegativesCount&quot;: 42, # The amount of false negatives.
170 &quot;falsePositivesCount&quot;: 42, # The amount of false positives.
171 &quot;groundTruthDocumentCount&quot;: 42, # The amount of documents with a ground truth occurrence.
172 &quot;groundTruthOccurrencesCount&quot;: 42, # The amount of occurrences in ground truth documents.
173 &quot;precision&quot;: 3.14, # The calculated precision.
174 &quot;predictedDocumentCount&quot;: 42, # The amount of documents with a predicted occurrence.
175 &quot;predictedOccurrencesCount&quot;: 42, # The amount of occurrences in predicted documents.
176 &quot;recall&quot;: 3.14, # The calculated recall.
177 &quot;totalDocumentsCount&quot;: 42, # The amount of documents that had an occurrence of this label.
178 &quot;truePositivesCount&quot;: 42, # The amount of true positives.
179 },
180 },
181 ],
182 &quot;confidenceLevelMetricsExact&quot;: [ # Metrics across confidence levels with only exact matching.
183 { # Evaluations metrics, at a specific confidence level.
184 &quot;confidenceLevel&quot;: 3.14, # The confidence level.
185 &quot;metrics&quot;: { # Evaluation metrics, either in aggregate or about a specific entity. # The metrics at the specific confidence level.
186 &quot;f1Score&quot;: 3.14, # The calculated F1 score.
187 &quot;falseNegativesCount&quot;: 42, # The amount of false negatives.
188 &quot;falsePositivesCount&quot;: 42, # The amount of false positives.
189 &quot;groundTruthDocumentCount&quot;: 42, # The amount of documents with a ground truth occurrence.
190 &quot;groundTruthOccurrencesCount&quot;: 42, # The amount of occurrences in ground truth documents.
191 &quot;precision&quot;: 3.14, # The calculated precision.
192 &quot;predictedDocumentCount&quot;: 42, # The amount of documents with a predicted occurrence.
193 &quot;predictedOccurrencesCount&quot;: 42, # The amount of occurrences in predicted documents.
194 &quot;recall&quot;: 3.14, # The calculated recall.
195 &quot;totalDocumentsCount&quot;: 42, # The amount of documents that had an occurrence of this label.
196 &quot;truePositivesCount&quot;: 42, # The amount of true positives.
197 },
198 },
199 ],
200 &quot;estimatedCalibrationError&quot;: 3.14, # The Estimated Calibration Error (ECE) of the confidence of the predicted entities.
201 &quot;estimatedCalibrationErrorExact&quot;: 3.14, # The ECE for the predicted entities with fuzzy matching disabled, i.e., exact matching only.
202 &quot;metricsType&quot;: &quot;A String&quot;, # The metrics type for the label.
203 },
204 },
205 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The KMS key name used for encryption.
206 &quot;kmsKeyVersionName&quot;: &quot;A String&quot;, # The KMS key version with which data is encrypted.
207 &quot;name&quot;: &quot;A String&quot;, # The resource name of the evaluation. Format: `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}/evaluations/{evaluation}`
208 &quot;revisions&quot;: [ # Contains all revisions of the evaluation, excluding the latest one.
209 { # A revision of the evaluation.
210 &quot;allEntitiesMetrics&quot;: { # Metrics across multiple confidence levels. # Output only. Metrics for all the entities in aggregate.
211 &quot;auprc&quot;: 3.14, # The calculated area under the precision recall curve (AUPRC), computed by integrating over all confidence thresholds.
212 &quot;auprcExact&quot;: 3.14, # The AUPRC for metrics with fuzzy matching disabled, i.e., exact matching only.
213 &quot;confidenceLevelMetrics&quot;: [ # Metrics across confidence levels with fuzzy matching enabled.
214 { # Evaluations metrics, at a specific confidence level.
215 &quot;confidenceLevel&quot;: 3.14, # The confidence level.
216 &quot;metrics&quot;: { # Evaluation metrics, either in aggregate or about a specific entity. # The metrics at the specific confidence level.
217 &quot;f1Score&quot;: 3.14, # The calculated F1 score.
218 &quot;falseNegativesCount&quot;: 42, # The amount of false negatives.
219 &quot;falsePositivesCount&quot;: 42, # The amount of false positives.
220 &quot;groundTruthDocumentCount&quot;: 42, # The amount of documents with a ground truth occurrence.
221 &quot;groundTruthOccurrencesCount&quot;: 42, # The amount of occurrences in ground truth documents.
222 &quot;precision&quot;: 3.14, # The calculated precision.
223 &quot;predictedDocumentCount&quot;: 42, # The amount of documents with a predicted occurrence.
224 &quot;predictedOccurrencesCount&quot;: 42, # The amount of occurrences in predicted documents.
225 &quot;recall&quot;: 3.14, # The calculated recall.
226 &quot;totalDocumentsCount&quot;: 42, # The amount of documents that had an occurrence of this label.
227 &quot;truePositivesCount&quot;: 42, # The amount of true positives.
228 },
229 },
230 ],
231 &quot;confidenceLevelMetricsExact&quot;: [ # Metrics across confidence levels with only exact matching.
232 { # Evaluations metrics, at a specific confidence level.
233 &quot;confidenceLevel&quot;: 3.14, # The confidence level.
234 &quot;metrics&quot;: { # Evaluation metrics, either in aggregate or about a specific entity. # The metrics at the specific confidence level.
235 &quot;f1Score&quot;: 3.14, # The calculated F1 score.
236 &quot;falseNegativesCount&quot;: 42, # The amount of false negatives.
237 &quot;falsePositivesCount&quot;: 42, # The amount of false positives.
238 &quot;groundTruthDocumentCount&quot;: 42, # The amount of documents with a ground truth occurrence.
239 &quot;groundTruthOccurrencesCount&quot;: 42, # The amount of occurrences in ground truth documents.
240 &quot;precision&quot;: 3.14, # The calculated precision.
241 &quot;predictedDocumentCount&quot;: 42, # The amount of documents with a predicted occurrence.
242 &quot;predictedOccurrencesCount&quot;: 42, # The amount of occurrences in predicted documents.
243 &quot;recall&quot;: 3.14, # The calculated recall.
244 &quot;totalDocumentsCount&quot;: 42, # The amount of documents that had an occurrence of this label.
245 &quot;truePositivesCount&quot;: 42, # The amount of true positives.
246 },
247 },
248 ],
249 &quot;estimatedCalibrationError&quot;: 3.14, # The Estimated Calibration Error (ECE) of the confidence of the predicted entities.
250 &quot;estimatedCalibrationErrorExact&quot;: 3.14, # The ECE for the predicted entities with fuzzy matching disabled, i.e., exact matching only.
251 &quot;metricsType&quot;: &quot;A String&quot;, # The metrics type for the label.
252 },
253 &quot;documentCounters&quot;: { # Evaluation counters for the documents that were used. # Output only. Counters for the documents used in the evaluation.
254 &quot;evaluatedDocumentsCount&quot;: 42, # How many documents were used in the evaluation.
255 &quot;failedDocumentsCount&quot;: 42, # How many documents were not included in the evaluation as Document AI failed to process them.
256 &quot;inputDocumentsCount&quot;: 42, # How many documents were sent for evaluation.
257 &quot;invalidDocumentsCount&quot;: 42, # How many documents were not included in the evaluation as they didn&#x27;t pass validation.
258 },
259 &quot;entityMetrics&quot;: { # Output only. Metrics across confidence levels, for different entities.
260 &quot;a_key&quot;: { # Metrics across multiple confidence levels.
261 &quot;auprc&quot;: 3.14, # The calculated area under the precision recall curve (AUPRC), computed by integrating over all confidence thresholds.
262 &quot;auprcExact&quot;: 3.14, # The AUPRC for metrics with fuzzy matching disabled, i.e., exact matching only.
263 &quot;confidenceLevelMetrics&quot;: [ # Metrics across confidence levels with fuzzy matching enabled.
264 { # Evaluations metrics, at a specific confidence level.
265 &quot;confidenceLevel&quot;: 3.14, # The confidence level.
266 &quot;metrics&quot;: { # Evaluation metrics, either in aggregate or about a specific entity. # The metrics at the specific confidence level.
267 &quot;f1Score&quot;: 3.14, # The calculated F1 score.
268 &quot;falseNegativesCount&quot;: 42, # The amount of false negatives.
269 &quot;falsePositivesCount&quot;: 42, # The amount of false positives.
270 &quot;groundTruthDocumentCount&quot;: 42, # The amount of documents with a ground truth occurrence.
271 &quot;groundTruthOccurrencesCount&quot;: 42, # The amount of occurrences in ground truth documents.
272 &quot;precision&quot;: 3.14, # The calculated precision.
273 &quot;predictedDocumentCount&quot;: 42, # The amount of documents with a predicted occurrence.
274 &quot;predictedOccurrencesCount&quot;: 42, # The amount of occurrences in predicted documents.
275 &quot;recall&quot;: 3.14, # The calculated recall.
276 &quot;totalDocumentsCount&quot;: 42, # The amount of documents that had an occurrence of this label.
277 &quot;truePositivesCount&quot;: 42, # The amount of true positives.
278 },
279 },
280 ],
281 &quot;confidenceLevelMetricsExact&quot;: [ # Metrics across confidence levels with only exact matching.
282 { # Evaluations metrics, at a specific confidence level.
283 &quot;confidenceLevel&quot;: 3.14, # The confidence level.
284 &quot;metrics&quot;: { # Evaluation metrics, either in aggregate or about a specific entity. # The metrics at the specific confidence level.
285 &quot;f1Score&quot;: 3.14, # The calculated F1 score.
286 &quot;falseNegativesCount&quot;: 42, # The amount of false negatives.
287 &quot;falsePositivesCount&quot;: 42, # The amount of false positives.
288 &quot;groundTruthDocumentCount&quot;: 42, # The amount of documents with a ground truth occurrence.
289 &quot;groundTruthOccurrencesCount&quot;: 42, # The amount of occurrences in ground truth documents.
290 &quot;precision&quot;: 3.14, # The calculated precision.
291 &quot;predictedDocumentCount&quot;: 42, # The amount of documents with a predicted occurrence.
292 &quot;predictedOccurrencesCount&quot;: 42, # The amount of occurrences in predicted documents.
293 &quot;recall&quot;: 3.14, # The calculated recall.
294 &quot;totalDocumentsCount&quot;: 42, # The amount of documents that had an occurrence of this label.
295 &quot;truePositivesCount&quot;: 42, # The amount of true positives.
296 },
297 },
298 ],
299 &quot;estimatedCalibrationError&quot;: 3.14, # The Estimated Calibration Error (ECE) of the confidence of the predicted entities.
300 &quot;estimatedCalibrationErrorExact&quot;: 3.14, # The ECE for the predicted entities with fuzzy matching disabled, i.e., exact matching only.
301 &quot;metricsType&quot;: &quot;A String&quot;, # The metrics type for the label.
302 },
303 },
304 &quot;revisionId&quot;: &quot;A String&quot;, # Output only. The revision ID of the evaluation.
305 },
306 ],
307 }</pre>
308 </div>
309
310 <div class="method">
311 <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
312 <pre>Retrieves a set of evaluations for a given processor version.
313
314 Args:
315 parent: string, Required. The resource name of the ProcessorVersion to list evaluations for. `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}` (required)
316 pageSize: integer, The standard list page size. If unspecified, at most `5` evaluations are returned. The maximum value is `100`. Values above `100` are coerced to `100`.
317 pageToken: string, A page token, received from a previous `ListEvaluations` call. Provide this to retrieve the subsequent page.
318 x__xgafv: string, V1 error format.
319 Allowed values
320 1 - v1 error format
321 2 - v2 error format
322
323 Returns:
324 An object of the form:
325
326 { # The response from `ListEvaluations`.
327 &quot;evaluations&quot;: [ # The evaluations requested.
328 { # An evaluation of a ProcessorVersion&#x27;s performance.
329 &quot;allEntitiesMetrics&quot;: { # Metrics across multiple confidence levels. # Metrics for all the entities in aggregate.
330 &quot;auprc&quot;: 3.14, # The calculated area under the precision recall curve (AUPRC), computed by integrating over all confidence thresholds.
331 &quot;auprcExact&quot;: 3.14, # The AUPRC for metrics with fuzzy matching disabled, i.e., exact matching only.
332 &quot;confidenceLevelMetrics&quot;: [ # Metrics across confidence levels with fuzzy matching enabled.
333 { # Evaluations metrics, at a specific confidence level.
334 &quot;confidenceLevel&quot;: 3.14, # The confidence level.
335 &quot;metrics&quot;: { # Evaluation metrics, either in aggregate or about a specific entity. # The metrics at the specific confidence level.
336 &quot;f1Score&quot;: 3.14, # The calculated F1 score.
337 &quot;falseNegativesCount&quot;: 42, # The amount of false negatives.
338 &quot;falsePositivesCount&quot;: 42, # The amount of false positives.
339 &quot;groundTruthDocumentCount&quot;: 42, # The amount of documents with a ground truth occurrence.
340 &quot;groundTruthOccurrencesCount&quot;: 42, # The amount of occurrences in ground truth documents.
341 &quot;precision&quot;: 3.14, # The calculated precision.
342 &quot;predictedDocumentCount&quot;: 42, # The amount of documents with a predicted occurrence.
343 &quot;predictedOccurrencesCount&quot;: 42, # The amount of occurrences in predicted documents.
344 &quot;recall&quot;: 3.14, # The calculated recall.
345 &quot;totalDocumentsCount&quot;: 42, # The amount of documents that had an occurrence of this label.
346 &quot;truePositivesCount&quot;: 42, # The amount of true positives.
347 },
348 },
349 ],
350 &quot;confidenceLevelMetricsExact&quot;: [ # Metrics across confidence levels with only exact matching.
351 { # Evaluations metrics, at a specific confidence level.
352 &quot;confidenceLevel&quot;: 3.14, # The confidence level.
353 &quot;metrics&quot;: { # Evaluation metrics, either in aggregate or about a specific entity. # The metrics at the specific confidence level.
354 &quot;f1Score&quot;: 3.14, # The calculated F1 score.
355 &quot;falseNegativesCount&quot;: 42, # The amount of false negatives.
356 &quot;falsePositivesCount&quot;: 42, # The amount of false positives.
357 &quot;groundTruthDocumentCount&quot;: 42, # The amount of documents with a ground truth occurrence.
358 &quot;groundTruthOccurrencesCount&quot;: 42, # The amount of occurrences in ground truth documents.
359 &quot;precision&quot;: 3.14, # The calculated precision.
360 &quot;predictedDocumentCount&quot;: 42, # The amount of documents with a predicted occurrence.
361 &quot;predictedOccurrencesCount&quot;: 42, # The amount of occurrences in predicted documents.
362 &quot;recall&quot;: 3.14, # The calculated recall.
363 &quot;totalDocumentsCount&quot;: 42, # The amount of documents that had an occurrence of this label.
364 &quot;truePositivesCount&quot;: 42, # The amount of true positives.
365 },
366 },
367 ],
368 &quot;estimatedCalibrationError&quot;: 3.14, # The Estimated Calibration Error (ECE) of the confidence of the predicted entities.
369 &quot;estimatedCalibrationErrorExact&quot;: 3.14, # The ECE for the predicted entities with fuzzy matching disabled, i.e., exact matching only.
370 &quot;metricsType&quot;: &quot;A String&quot;, # The metrics type for the label.
371 },
372 &quot;createTime&quot;: &quot;A String&quot;, # The time that the evaluation was created.
373 &quot;documentCounters&quot;: { # Evaluation counters for the documents that were used. # Counters for the documents used in the evaluation.
374 &quot;evaluatedDocumentsCount&quot;: 42, # How many documents were used in the evaluation.
375 &quot;failedDocumentsCount&quot;: 42, # How many documents were not included in the evaluation as Document AI failed to process them.
376 &quot;inputDocumentsCount&quot;: 42, # How many documents were sent for evaluation.
377 &quot;invalidDocumentsCount&quot;: 42, # How many documents were not included in the evaluation as they didn&#x27;t pass validation.
378 },
379 &quot;entityMetrics&quot;: { # Metrics across confidence levels, for different entities.
380 &quot;a_key&quot;: { # Metrics across multiple confidence levels.
381 &quot;auprc&quot;: 3.14, # The calculated area under the precision recall curve (AUPRC), computed by integrating over all confidence thresholds.
382 &quot;auprcExact&quot;: 3.14, # The AUPRC for metrics with fuzzy matching disabled, i.e., exact matching only.
383 &quot;confidenceLevelMetrics&quot;: [ # Metrics across confidence levels with fuzzy matching enabled.
384 { # Evaluations metrics, at a specific confidence level.
385 &quot;confidenceLevel&quot;: 3.14, # The confidence level.
386 &quot;metrics&quot;: { # Evaluation metrics, either in aggregate or about a specific entity. # The metrics at the specific confidence level.
387 &quot;f1Score&quot;: 3.14, # The calculated F1 score.
388 &quot;falseNegativesCount&quot;: 42, # The amount of false negatives.
389 &quot;falsePositivesCount&quot;: 42, # The amount of false positives.
390 &quot;groundTruthDocumentCount&quot;: 42, # The amount of documents with a ground truth occurrence.
391 &quot;groundTruthOccurrencesCount&quot;: 42, # The amount of occurrences in ground truth documents.
392 &quot;precision&quot;: 3.14, # The calculated precision.
393 &quot;predictedDocumentCount&quot;: 42, # The amount of documents with a predicted occurrence.
394 &quot;predictedOccurrencesCount&quot;: 42, # The amount of occurrences in predicted documents.
395 &quot;recall&quot;: 3.14, # The calculated recall.
396 &quot;totalDocumentsCount&quot;: 42, # The amount of documents that had an occurrence of this label.
397 &quot;truePositivesCount&quot;: 42, # The amount of true positives.
398 },
399 },
400 ],
401 &quot;confidenceLevelMetricsExact&quot;: [ # Metrics across confidence levels with only exact matching.
402 { # Evaluations metrics, at a specific confidence level.
403 &quot;confidenceLevel&quot;: 3.14, # The confidence level.
404 &quot;metrics&quot;: { # Evaluation metrics, either in aggregate or about a specific entity. # The metrics at the specific confidence level.
405 &quot;f1Score&quot;: 3.14, # The calculated F1 score.
406 &quot;falseNegativesCount&quot;: 42, # The amount of false negatives.
407 &quot;falsePositivesCount&quot;: 42, # The amount of false positives.
408 &quot;groundTruthDocumentCount&quot;: 42, # The amount of documents with a ground truth occurrence.
409 &quot;groundTruthOccurrencesCount&quot;: 42, # The amount of occurrences in ground truth documents.
410 &quot;precision&quot;: 3.14, # The calculated precision.
411 &quot;predictedDocumentCount&quot;: 42, # The amount of documents with a predicted occurrence.
412 &quot;predictedOccurrencesCount&quot;: 42, # The amount of occurrences in predicted documents.
413 &quot;recall&quot;: 3.14, # The calculated recall.
414 &quot;totalDocumentsCount&quot;: 42, # The amount of documents that had an occurrence of this label.
415 &quot;truePositivesCount&quot;: 42, # The amount of true positives.
416 },
417 },
418 ],
419 &quot;estimatedCalibrationError&quot;: 3.14, # The Estimated Calibration Error (ECE) of the confidence of the predicted entities.
420 &quot;estimatedCalibrationErrorExact&quot;: 3.14, # The ECE for the predicted entities with fuzzy matching disabled, i.e., exact matching only.
421 &quot;metricsType&quot;: &quot;A String&quot;, # The metrics type for the label.
422 },
423 },
424 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The KMS key name used for encryption.
425 &quot;kmsKeyVersionName&quot;: &quot;A String&quot;, # The KMS key version with which data is encrypted.
426 &quot;name&quot;: &quot;A String&quot;, # The resource name of the evaluation. Format: `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}/evaluations/{evaluation}`
427 &quot;revisions&quot;: [ # Contains all revisions of the evaluation, excluding the latest one.
428 { # A revision of the evaluation.
429 &quot;allEntitiesMetrics&quot;: { # Metrics across multiple confidence levels. # Output only. Metrics for all the entities in aggregate.
430 &quot;auprc&quot;: 3.14, # The calculated area under the precision recall curve (AUPRC), computed by integrating over all confidence thresholds.
431 &quot;auprcExact&quot;: 3.14, # The AUPRC for metrics with fuzzy matching disabled, i.e., exact matching only.
432 &quot;confidenceLevelMetrics&quot;: [ # Metrics across confidence levels with fuzzy matching enabled.
433 { # Evaluations metrics, at a specific confidence level.
434 &quot;confidenceLevel&quot;: 3.14, # The confidence level.
435 &quot;metrics&quot;: { # Evaluation metrics, either in aggregate or about a specific entity. # The metrics at the specific confidence level.
436 &quot;f1Score&quot;: 3.14, # The calculated F1 score.
437 &quot;falseNegativesCount&quot;: 42, # The amount of false negatives.
438 &quot;falsePositivesCount&quot;: 42, # The amount of false positives.
439 &quot;groundTruthDocumentCount&quot;: 42, # The amount of documents with a ground truth occurrence.
440 &quot;groundTruthOccurrencesCount&quot;: 42, # The amount of occurrences in ground truth documents.
441 &quot;precision&quot;: 3.14, # The calculated precision.
442 &quot;predictedDocumentCount&quot;: 42, # The amount of documents with a predicted occurrence.
443 &quot;predictedOccurrencesCount&quot;: 42, # The amount of occurrences in predicted documents.
444 &quot;recall&quot;: 3.14, # The calculated recall.
445 &quot;totalDocumentsCount&quot;: 42, # The amount of documents that had an occurrence of this label.
446 &quot;truePositivesCount&quot;: 42, # The amount of true positives.
447 },
448 },
449 ],
450 &quot;confidenceLevelMetricsExact&quot;: [ # Metrics across confidence levels with only exact matching.
451 { # Evaluations metrics, at a specific confidence level.
452 &quot;confidenceLevel&quot;: 3.14, # The confidence level.
453 &quot;metrics&quot;: { # Evaluation metrics, either in aggregate or about a specific entity. # The metrics at the specific confidence level.
454 &quot;f1Score&quot;: 3.14, # The calculated F1 score.
455 &quot;falseNegativesCount&quot;: 42, # The amount of false negatives.
456 &quot;falsePositivesCount&quot;: 42, # The amount of false positives.
457 &quot;groundTruthDocumentCount&quot;: 42, # The amount of documents with a ground truth occurrence.
458 &quot;groundTruthOccurrencesCount&quot;: 42, # The amount of occurrences in ground truth documents.
459 &quot;precision&quot;: 3.14, # The calculated precision.
460 &quot;predictedDocumentCount&quot;: 42, # The amount of documents with a predicted occurrence.
461 &quot;predictedOccurrencesCount&quot;: 42, # The amount of occurrences in predicted documents.
462 &quot;recall&quot;: 3.14, # The calculated recall.
463 &quot;totalDocumentsCount&quot;: 42, # The amount of documents that had an occurrence of this label.
464 &quot;truePositivesCount&quot;: 42, # The amount of true positives.
465 },
466 },
467 ],
468 &quot;estimatedCalibrationError&quot;: 3.14, # The Estimated Calibration Error (ECE) of the confidence of the predicted entities.
469 &quot;estimatedCalibrationErrorExact&quot;: 3.14, # The ECE for the predicted entities with fuzzy matching disabled, i.e., exact matching only.
470 &quot;metricsType&quot;: &quot;A String&quot;, # The metrics type for the label.
471 },
472 &quot;documentCounters&quot;: { # Evaluation counters for the documents that were used. # Output only. Counters for the documents used in the evaluation.
473 &quot;evaluatedDocumentsCount&quot;: 42, # How many documents were used in the evaluation.
474 &quot;failedDocumentsCount&quot;: 42, # How many documents were not included in the evaluation as Document AI failed to process them.
475 &quot;inputDocumentsCount&quot;: 42, # How many documents were sent for evaluation.
476 &quot;invalidDocumentsCount&quot;: 42, # How many documents were not included in the evaluation as they didn&#x27;t pass validation.
477 },
478 &quot;entityMetrics&quot;: { # Output only. Metrics across confidence levels, for different entities.
479 &quot;a_key&quot;: { # Metrics across multiple confidence levels.
480 &quot;auprc&quot;: 3.14, # The calculated area under the precision recall curve (AUPRC), computed by integrating over all confidence thresholds.
481 &quot;auprcExact&quot;: 3.14, # The AUPRC for metrics with fuzzy matching disabled, i.e., exact matching only.
482 &quot;confidenceLevelMetrics&quot;: [ # Metrics across confidence levels with fuzzy matching enabled.
483 { # Evaluations metrics, at a specific confidence level.
484 &quot;confidenceLevel&quot;: 3.14, # The confidence level.
485 &quot;metrics&quot;: { # Evaluation metrics, either in aggregate or about a specific entity. # The metrics at the specific confidence level.
486 &quot;f1Score&quot;: 3.14, # The calculated F1 score.
487 &quot;falseNegativesCount&quot;: 42, # The amount of false negatives.
488 &quot;falsePositivesCount&quot;: 42, # The amount of false positives.
489 &quot;groundTruthDocumentCount&quot;: 42, # The amount of documents with a ground truth occurrence.
490 &quot;groundTruthOccurrencesCount&quot;: 42, # The amount of occurrences in ground truth documents.
491 &quot;precision&quot;: 3.14, # The calculated precision.
492 &quot;predictedDocumentCount&quot;: 42, # The amount of documents with a predicted occurrence.
493 &quot;predictedOccurrencesCount&quot;: 42, # The amount of occurrences in predicted documents.
494 &quot;recall&quot;: 3.14, # The calculated recall.
495 &quot;totalDocumentsCount&quot;: 42, # The amount of documents that had an occurrence of this label.
496 &quot;truePositivesCount&quot;: 42, # The amount of true positives.
497 },
498 },
499 ],
500 &quot;confidenceLevelMetricsExact&quot;: [ # Metrics across confidence levels with only exact matching.
501 { # Evaluations metrics, at a specific confidence level.
502 &quot;confidenceLevel&quot;: 3.14, # The confidence level.
503 &quot;metrics&quot;: { # Evaluation metrics, either in aggregate or about a specific entity. # The metrics at the specific confidence level.
504 &quot;f1Score&quot;: 3.14, # The calculated F1 score.
505 &quot;falseNegativesCount&quot;: 42, # The amount of false negatives.
506 &quot;falsePositivesCount&quot;: 42, # The amount of false positives.
507 &quot;groundTruthDocumentCount&quot;: 42, # The amount of documents with a ground truth occurrence.
508 &quot;groundTruthOccurrencesCount&quot;: 42, # The amount of occurrences in ground truth documents.
509 &quot;precision&quot;: 3.14, # The calculated precision.
510 &quot;predictedDocumentCount&quot;: 42, # The amount of documents with a predicted occurrence.
511 &quot;predictedOccurrencesCount&quot;: 42, # The amount of occurrences in predicted documents.
512 &quot;recall&quot;: 3.14, # The calculated recall.
513 &quot;totalDocumentsCount&quot;: 42, # The amount of documents that had an occurrence of this label.
514 &quot;truePositivesCount&quot;: 42, # The amount of true positives.
515 },
516 },
517 ],
518 &quot;estimatedCalibrationError&quot;: 3.14, # The Estimated Calibration Error (ECE) of the confidence of the predicted entities.
519 &quot;estimatedCalibrationErrorExact&quot;: 3.14, # The ECE for the predicted entities with fuzzy matching disabled, i.e., exact matching only.
520 &quot;metricsType&quot;: &quot;A String&quot;, # The metrics type for the label.
521 },
522 },
523 &quot;revisionId&quot;: &quot;A String&quot;, # Output only. The revision ID of the evaluation.
524 },
525 ],
526 },
527 ],
528 &quot;nextPageToken&quot;: &quot;A String&quot;, # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
529 }</pre>
530 </div>
531
532 <div class="method">
533 <code class="details" id="list_next">list_next()</code>
534 <pre>Retrieves the next page of results.
535
536 Args:
537 previous_request: The request for the previous page. (required)
538 previous_response: The response from the request for the previous page. (required)
539
540 Returns:
541 A request object that you can call &#x27;execute()&#x27; on to request the next
542 page. Returns None if there are no more items in the collection.
543 </pre>
544 </div>
545
546 </body></html>