Reference documentation and code samples for the Google Cloud Document Ai V1 Client class Metrics.
Evaluation metrics, either in aggregate or about a specific entity.
Generated from protobuf message google.cloud.documentai.v1.Evaluation.Metrics
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ precision |
float
The calculated precision. |
↳ recall |
float
The calculated recall. |
↳ f1_score |
float
The calculated f1 score. |
↳ predicted_occurrences_count |
int
The amount of occurrences in predicted documents. |
↳ ground_truth_occurrences_count |
int
The amount of occurrences in ground truth documents. |
↳ predicted_document_count |
int
The amount of documents with a predicted occurrence. |
↳ ground_truth_document_count |
int
The amount of documents with a ground truth occurrence. |
↳ true_positives_count |
int
The amount of true positives. |
↳ false_positives_count |
int
The amount of false positives. |
↳ false_negatives_count |
int
The amount of false negatives. |
↳ total_documents_count |
int
The amount of documents that had an occurrence of this label. |
getPrecision
The calculated precision.
| Returns | |
|---|---|
| Type | Description |
float | |
setPrecision
The calculated precision.
| Parameter | |
|---|---|
| Name | Description |
var |
float
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getRecall
The calculated recall.
| Returns | |
|---|---|
| Type | Description |
float | |
setRecall
The calculated recall.
| Parameter | |
|---|---|
| Name | Description |
var |
float
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getF1Score
The calculated f1 score.
| Returns | |
|---|---|
| Type | Description |
float | |
setF1Score
The calculated f1 score.
| Parameter | |
|---|---|
| Name | Description |
var |
float
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPredictedOccurrencesCount
The amount of occurrences in predicted documents.
| Returns | |
|---|---|
| Type | Description |
int | |
setPredictedOccurrencesCount
The amount of occurrences in predicted documents.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getGroundTruthOccurrencesCount
The amount of occurrences in ground truth documents.
| Returns | |
|---|---|
| Type | Description |
int | |
setGroundTruthOccurrencesCount
The amount of occurrences in ground truth documents.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPredictedDocumentCount
The amount of documents with a predicted occurrence.
| Returns | |
|---|---|
| Type | Description |
int | |
setPredictedDocumentCount
The amount of documents with a predicted occurrence.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getGroundTruthDocumentCount
The amount of documents with a ground truth occurrence.
| Returns | |
|---|---|
| Type | Description |
int | |
setGroundTruthDocumentCount
The amount of documents with a ground truth occurrence.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getTruePositivesCount
The amount of true positives.
| Returns | |
|---|---|
| Type | Description |
int | |
setTruePositivesCount
The amount of true positives.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getFalsePositivesCount
The amount of false positives.
| Returns | |
|---|---|
| Type | Description |
int | |
setFalsePositivesCount
The amount of false positives.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getFalseNegativesCount
The amount of false negatives.
| Returns | |
|---|---|
| Type | Description |
int | |
setFalseNegativesCount
The amount of false negatives.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getTotalDocumentsCount
The amount of documents that had an occurrence of this label.
| Returns | |
|---|---|
| Type | Description |
int | |
setTotalDocumentsCount
The amount of documents that had an occurrence of this label.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |