XPSEvaluationMetrics (Cloud Natural Language API v2-rev20250824-2.0.0)

java.lang.Object
- java.util.AbstractMap<String,Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.language.v2.model.XPSEvaluationMetrics

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class XPSEvaluationMetrics
extends com.google.api.client.json.GenericJson
```
Contains xPS-specific model evaluation metrics either for a single annotation spec (label), or for the model overall. Next tag: 18.
This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Cloud Natural Language API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  com.google.api.client.util.GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

XPSEvaluationMetrics()

Constructors
Constructor and Description
`XPSEvaluationMetrics()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`XPSEvaluationMetrics`	`clone()`
`String`	`getAnnotationSpecIdToken()` The annotation_spec for which this evaluation metrics instance had been created.
`Integer`	`getCategory()` The integer category label for which this evaluation metric instance had been created.
`Integer`	`getEvaluatedExampleCount()` The number of examples used to create this evaluation metrics instance.
`XPSClassificationEvaluationMetrics`	`getImageClassificationEvalMetrics()`
`XPSImageObjectDetectionEvaluationMetrics`	`getImageObjectDetectionEvalMetrics()`
`XPSImageSegmentationEvaluationMetrics`	`getImageSegmentationEvalMetrics()`
`String`	`getLabel()` The label for which this evaluation metrics instance had been created.
`XPSRegressionEvaluationMetrics`	`getRegressionEvalMetrics()`
`XPSClassificationEvaluationMetrics`	`getTablesClassificationEvalMetrics()`
`XPSTablesEvaluationMetrics`	`getTablesEvalMetrics()`
`XPSClassificationEvaluationMetrics`	`getTextClassificationEvalMetrics()`
`XPSTextExtractionEvaluationMetrics`	`getTextExtractionEvalMetrics()`
`XPSTextSentimentEvaluationMetrics`	`getTextSentimentEvalMetrics()`
`XPSTranslationEvaluationMetrics`	`getTranslationEvalMetrics()`
`XPSVideoActionRecognitionEvaluationMetrics`	`getVideoActionRecognitionEvalMetrics()`
`XPSClassificationEvaluationMetrics`	`getVideoClassificationEvalMetrics()`
`XPSVideoObjectTrackingEvaluationMetrics`	`getVideoObjectTrackingEvalMetrics()`
`XPSEvaluationMetrics`	`set(String fieldName, Object value)`
`XPSEvaluationMetrics`	`setAnnotationSpecIdToken(String annotationSpecIdToken)` The annotation_spec for which this evaluation metrics instance had been created.
`XPSEvaluationMetrics`	`setCategory(Integer category)` The integer category label for which this evaluation metric instance had been created.
`XPSEvaluationMetrics`	`setEvaluatedExampleCount(Integer evaluatedExampleCount)` The number of examples used to create this evaluation metrics instance.
`XPSEvaluationMetrics`	`setImageClassificationEvalMetrics(XPSClassificationEvaluationMetrics imageClassificationEvalMetrics)`
`XPSEvaluationMetrics`	`setImageObjectDetectionEvalMetrics(XPSImageObjectDetectionEvaluationMetrics imageObjectDetectionEvalMetrics)`
`XPSEvaluationMetrics`	`setImageSegmentationEvalMetrics(XPSImageSegmentationEvaluationMetrics imageSegmentationEvalMetrics)`
`XPSEvaluationMetrics`	`setLabel(String label)` The label for which this evaluation metrics instance had been created.
`XPSEvaluationMetrics`	`setRegressionEvalMetrics(XPSRegressionEvaluationMetrics regressionEvalMetrics)`
`XPSEvaluationMetrics`	`setTablesClassificationEvalMetrics(XPSClassificationEvaluationMetrics tablesClassificationEvalMetrics)`
`XPSEvaluationMetrics`	`setTablesEvalMetrics(XPSTablesEvaluationMetrics tablesEvalMetrics)`
`XPSEvaluationMetrics`	`setTextClassificationEvalMetrics(XPSClassificationEvaluationMetrics textClassificationEvalMetrics)`
`XPSEvaluationMetrics`	`setTextExtractionEvalMetrics(XPSTextExtractionEvaluationMetrics textExtractionEvalMetrics)`
`XPSEvaluationMetrics`	`setTextSentimentEvalMetrics(XPSTextSentimentEvaluationMetrics textSentimentEvalMetrics)`
`XPSEvaluationMetrics`	`setTranslationEvalMetrics(XPSTranslationEvaluationMetrics translationEvalMetrics)`
`XPSEvaluationMetrics`	`setVideoActionRecognitionEvalMetrics(XPSVideoActionRecognitionEvaluationMetrics videoActionRecognitionEvalMetrics)`
`XPSEvaluationMetrics`	`setVideoClassificationEvalMetrics(XPSClassificationEvaluationMetrics videoClassificationEvalMetrics)`
`XPSEvaluationMetrics`	`setVideoObjectTrackingEvalMetrics(XPSVideoObjectTrackingEvaluationMetrics videoObjectTrackingEvalMetrics)`

Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - XPSEvaluationMetrics
```
public XPSEvaluationMetrics()
```
- Method Detail
  - getAnnotationSpecIdToken
```
public String getAnnotationSpecIdToken()
```
    The annotation_spec for which this evaluation metrics instance had been created. Empty iff this is an overall model evaluation (like Tables evaluation metrics), i.e. aggregated across all labels. The value comes from the input annotations in AnnotatedExample. For MVP product or for text sentiment models where annotation_spec_id_token is not available, set label instead.
    
    Returns:
    
    value or null for none
  - setAnnotationSpecIdToken
```
public XPSEvaluationMetrics setAnnotationSpecIdToken(String annotationSpecIdToken)
```
    The annotation_spec for which this evaluation metrics instance had been created. Empty iff this is an overall model evaluation (like Tables evaluation metrics), i.e. aggregated across all labels. The value comes from the input annotations in AnnotatedExample. For MVP product or for text sentiment models where annotation_spec_id_token is not available, set label instead.
    
    Parameters:
    
    annotationSpecIdToken - annotationSpecIdToken or null for none
  - getCategory
```
public Integer getCategory()
```
    The integer category label for which this evaluation metric instance had been created. Valid categories are 0 or higher. Overall model evaluation should set this to negative values (rather than implicit zero). Only used for Image Segmentation (prefer to set annotation_spec_id_token instead). Note: uCAIP Image Segmentation should use annotation_spec_id_token.
    
    Returns:
    
    value or null for none
  - setCategory
```
public XPSEvaluationMetrics setCategory(Integer category)
```
    The integer category label for which this evaluation metric instance had been created. Valid categories are 0 or higher. Overall model evaluation should set this to negative values (rather than implicit zero). Only used for Image Segmentation (prefer to set annotation_spec_id_token instead). Note: uCAIP Image Segmentation should use annotation_spec_id_token.
    
    Parameters:
    
    category - category or null for none
  - getEvaluatedExampleCount
```
public Integer getEvaluatedExampleCount()
```
    The number of examples used to create this evaluation metrics instance.
    
    Returns:
    
    value or null for none
  - setEvaluatedExampleCount
```
public XPSEvaluationMetrics setEvaluatedExampleCount(Integer evaluatedExampleCount)
```
    The number of examples used to create this evaluation metrics instance.
    
    Parameters:
    
    evaluatedExampleCount - evaluatedExampleCount or null for none
  - getImageClassificationEvalMetrics
```
public XPSClassificationEvaluationMetrics getImageClassificationEvalMetrics()
```
    Returns:
    
    value or null for none
  - setImageClassificationEvalMetrics
```
public XPSEvaluationMetrics setImageClassificationEvalMetrics(XPSClassificationEvaluationMetrics imageClassificationEvalMetrics)
```
    Parameters:
    
    imageClassificationEvalMetrics - imageClassificationEvalMetrics or null for none
  - getImageObjectDetectionEvalMetrics
```
public XPSImageObjectDetectionEvaluationMetrics getImageObjectDetectionEvalMetrics()
```
    Returns:
    
    value or null for none
  - setImageObjectDetectionEvalMetrics
```
public XPSEvaluationMetrics setImageObjectDetectionEvalMetrics(XPSImageObjectDetectionEvaluationMetrics imageObjectDetectionEvalMetrics)
```
    Parameters:
    
    imageObjectDetectionEvalMetrics - imageObjectDetectionEvalMetrics or null for none
  - getImageSegmentationEvalMetrics
```
public XPSImageSegmentationEvaluationMetrics getImageSegmentationEvalMetrics()
```
    Returns:
    
    value or null for none
  - setImageSegmentationEvalMetrics
```
public XPSEvaluationMetrics setImageSegmentationEvalMetrics(XPSImageSegmentationEvaluationMetrics imageSegmentationEvalMetrics)
```
    Parameters:
    
    imageSegmentationEvalMetrics - imageSegmentationEvalMetrics or null for none
  - getLabel
```
public String getLabel()
```
    The label for which this evaluation metrics instance had been created. Empty iff this is an overall model evaluation (like Tables evaluation metrics), i.e. aggregated across all labels. The label maps to AnnotationSpec.display_name in Public API protos. Only used by MVP implementation and text sentiment FULL implementation.
    
    Returns:
    
    value or null for none
  - setLabel
```
public XPSEvaluationMetrics setLabel(String label)
```
    The label for which this evaluation metrics instance had been created. Empty iff this is an overall model evaluation (like Tables evaluation metrics), i.e. aggregated across all labels. The label maps to AnnotationSpec.display_name in Public API protos. Only used by MVP implementation and text sentiment FULL implementation.
    
    Parameters:
    
    label - label or null for none
  - getRegressionEvalMetrics
```
public XPSRegressionEvaluationMetrics getRegressionEvalMetrics()
```
    Returns:
    
    value or null for none
  - setRegressionEvalMetrics
```
public XPSEvaluationMetrics setRegressionEvalMetrics(XPSRegressionEvaluationMetrics regressionEvalMetrics)
```
    Parameters:
    
    regressionEvalMetrics - regressionEvalMetrics or null for none
  - getTablesClassificationEvalMetrics
```
public XPSClassificationEvaluationMetrics getTablesClassificationEvalMetrics()
```
    Returns:
    
    value or null for none
  - setTablesClassificationEvalMetrics
```
public XPSEvaluationMetrics setTablesClassificationEvalMetrics(XPSClassificationEvaluationMetrics tablesClassificationEvalMetrics)
```
    Parameters:
    
    tablesClassificationEvalMetrics - tablesClassificationEvalMetrics or null for none
  - getTablesEvalMetrics
```
public XPSTablesEvaluationMetrics getTablesEvalMetrics()
```
    Returns:
    
    value or null for none
  - setTablesEvalMetrics
```
public XPSEvaluationMetrics setTablesEvalMetrics(XPSTablesEvaluationMetrics tablesEvalMetrics)
```
    Parameters:
    
    tablesEvalMetrics - tablesEvalMetrics or null for none
  - getTextClassificationEvalMetrics
```
public XPSClassificationEvaluationMetrics getTextClassificationEvalMetrics()
```
    Returns:
    
    value or null for none
  - setTextClassificationEvalMetrics
```
public XPSEvaluationMetrics setTextClassificationEvalMetrics(XPSClassificationEvaluationMetrics textClassificationEvalMetrics)
```
    Parameters:
    
    textClassificationEvalMetrics - textClassificationEvalMetrics or null for none
  - getTextExtractionEvalMetrics
```
public XPSTextExtractionEvaluationMetrics getTextExtractionEvalMetrics()
```
    Returns:
    
    value or null for none
  - setTextExtractionEvalMetrics
```
public XPSEvaluationMetrics setTextExtractionEvalMetrics(XPSTextExtractionEvaluationMetrics textExtractionEvalMetrics)
```
    Parameters:
    
    textExtractionEvalMetrics - textExtractionEvalMetrics or null for none
  - getTextSentimentEvalMetrics
```
public XPSTextSentimentEvaluationMetrics getTextSentimentEvalMetrics()
```
    Returns:
    
    value or null for none
  - setTextSentimentEvalMetrics
```
public XPSEvaluationMetrics setTextSentimentEvalMetrics(XPSTextSentimentEvaluationMetrics textSentimentEvalMetrics)
```
    Parameters:
    
    textSentimentEvalMetrics - textSentimentEvalMetrics or null for none
  - getTranslationEvalMetrics
```
public XPSTranslationEvaluationMetrics getTranslationEvalMetrics()
```
    Returns:
    
    value or null for none
  - setTranslationEvalMetrics
```
public XPSEvaluationMetrics setTranslationEvalMetrics(XPSTranslationEvaluationMetrics translationEvalMetrics)
```
    Parameters:
    
    translationEvalMetrics - translationEvalMetrics or null for none
  - getVideoActionRecognitionEvalMetrics
```
public XPSVideoActionRecognitionEvaluationMetrics getVideoActionRecognitionEvalMetrics()
```
    Returns:
    
    value or null for none
  - setVideoActionRecognitionEvalMetrics
```
public XPSEvaluationMetrics setVideoActionRecognitionEvalMetrics(XPSVideoActionRecognitionEvaluationMetrics videoActionRecognitionEvalMetrics)
```
    Parameters:
    
    videoActionRecognitionEvalMetrics - videoActionRecognitionEvalMetrics or null for none
  - getVideoClassificationEvalMetrics
```
public XPSClassificationEvaluationMetrics getVideoClassificationEvalMetrics()
```
    Returns:
    
    value or null for none
  - setVideoClassificationEvalMetrics
```
public XPSEvaluationMetrics setVideoClassificationEvalMetrics(XPSClassificationEvaluationMetrics videoClassificationEvalMetrics)
```
    Parameters:
    
    videoClassificationEvalMetrics - videoClassificationEvalMetrics or null for none
  - getVideoObjectTrackingEvalMetrics
```
public XPSVideoObjectTrackingEvaluationMetrics getVideoObjectTrackingEvalMetrics()
```
    Returns:
    
    value or null for none
  - setVideoObjectTrackingEvalMetrics
```
public XPSEvaluationMetrics setVideoObjectTrackingEvalMetrics(XPSVideoObjectTrackingEvaluationMetrics videoObjectTrackingEvalMetrics)
```
    Parameters:
    
    videoObjectTrackingEvalMetrics - videoObjectTrackingEvalMetrics or null for none
  - set
```
public XPSEvaluationMetrics set(String fieldName,
                                Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public XPSEvaluationMetrics clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Class XPSEvaluationMetrics

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

XPSEvaluationMetrics

Method Detail

getAnnotationSpecIdToken

setAnnotationSpecIdToken

getCategory

setCategory

getEvaluatedExampleCount

setEvaluatedExampleCount

getImageClassificationEvalMetrics

setImageClassificationEvalMetrics

getImageObjectDetectionEvalMetrics

setImageObjectDetectionEvalMetrics

getImageSegmentationEvalMetrics

setImageSegmentationEvalMetrics

getLabel

setLabel

getRegressionEvalMetrics

setRegressionEvalMetrics

getTablesClassificationEvalMetrics

setTablesClassificationEvalMetrics

getTablesEvalMetrics

setTablesEvalMetrics

getTextClassificationEvalMetrics

setTextClassificationEvalMetrics

getTextExtractionEvalMetrics

setTextExtractionEvalMetrics

getTextSentimentEvalMetrics

setTextSentimentEvalMetrics

getTranslationEvalMetrics

setTranslationEvalMetrics

getVideoActionRecognitionEvalMetrics

setVideoActionRecognitionEvalMetrics

getVideoClassificationEvalMetrics

setVideoClassificationEvalMetrics

getVideoObjectTrackingEvalMetrics

setVideoObjectTrackingEvalMetrics

set

clone