XPSTrainResponse (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.XPSTrainResponse

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class XPSTrainResponse
extends com.google.api.client.json.GenericJson
```
Model definition for XPSTrainResponse.
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

XPSTrainResponse()

Constructors
Constructor and Description
`XPSTrainResponse()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`XPSTrainResponse`	`clone()`
`byte[]`	`decodeModelToken()` Token that represents the trained model.
`XPSTrainResponse`	`encodeModelToken(byte[] modelToken)` Token that represents the trained model.
`Long`	`getDeployedModelSizeBytes()` Estimated model size in bytes once deployed.
`List<XPSVisionErrorAnalysisConfig>`	`getErrorAnalysisConfigs()` Optional vision model error analysis configuration.
`XPSExampleSet`	`getEvaluatedExampleSet()` Examples used to evaluate the model (usually the test set), with the predicted annotations.
`XPSEvaluationMetricsSet`	`getEvaluationMetricsSet()` The trained model evaluation metrics.
`List<XPSResponseExplanationSpec>`	`getExplanationConfigs()` VisionExplanationConfig for XAI on test set.
`XPSImageClassificationTrainResponse`	`getImageClassificationTrainResp()`
`XPSImageObjectDetectionModelSpec`	`getImageObjectDetectionTrainResp()`
`XPSImageSegmentationTrainResponse`	`getImageSegmentationTrainResp()`
`String`	`getModelToken()` Token that represents the trained model.
`XPSSpeechModelSpec`	`getSpeechTrainResp()`
`XPSTablesTrainResponse`	`getTablesTrainResp()`
`XPSTextToSpeechTrainResponse`	`getTextToSpeechTrainResp()`
`XPSTextTrainResponse`	`getTextTrainResp()` Will only be needed for uCAIP from Beta.
`XPSTranslationTrainResponse`	`getTranslationTrainResp()`
`XPSVideoActionRecognitionTrainResponse`	`getVideoActionRecognitionTrainResp()`
`XPSVideoClassificationTrainResponse`	`getVideoClassificationTrainResp()`
`XPSVideoObjectTrackingTrainResponse`	`getVideoObjectTrackingTrainResp()`
`XPSTrainResponse`	`set(String fieldName, Object value)`
`XPSTrainResponse`	`setDeployedModelSizeBytes(Long deployedModelSizeBytes)` Estimated model size in bytes once deployed.
`XPSTrainResponse`	`setErrorAnalysisConfigs(List<XPSVisionErrorAnalysisConfig> errorAnalysisConfigs)` Optional vision model error analysis configuration.
`XPSTrainResponse`	`setEvaluatedExampleSet(XPSExampleSet evaluatedExampleSet)` Examples used to evaluate the model (usually the test set), with the predicted annotations.
`XPSTrainResponse`	`setEvaluationMetricsSet(XPSEvaluationMetricsSet evaluationMetricsSet)` The trained model evaluation metrics.
`XPSTrainResponse`	`setExplanationConfigs(List<XPSResponseExplanationSpec> explanationConfigs)` VisionExplanationConfig for XAI on test set.
`XPSTrainResponse`	`setImageClassificationTrainResp(XPSImageClassificationTrainResponse imageClassificationTrainResp)`
`XPSTrainResponse`	`setImageObjectDetectionTrainResp(XPSImageObjectDetectionModelSpec imageObjectDetectionTrainResp)`
`XPSTrainResponse`	`setImageSegmentationTrainResp(XPSImageSegmentationTrainResponse imageSegmentationTrainResp)`
`XPSTrainResponse`	`setModelToken(String modelToken)` Token that represents the trained model.
`XPSTrainResponse`	`setSpeechTrainResp(XPSSpeechModelSpec speechTrainResp)`
`XPSTrainResponse`	`setTablesTrainResp(XPSTablesTrainResponse tablesTrainResp)`
`XPSTrainResponse`	`setTextToSpeechTrainResp(XPSTextToSpeechTrainResponse textToSpeechTrainResp)`
`XPSTrainResponse`	`setTextTrainResp(XPSTextTrainResponse textTrainResp)` Will only be needed for uCAIP from Beta.
`XPSTrainResponse`	`setTranslationTrainResp(XPSTranslationTrainResponse translationTrainResp)`
`XPSTrainResponse`	`setVideoActionRecognitionTrainResp(XPSVideoActionRecognitionTrainResponse videoActionRecognitionTrainResp)`
`XPSTrainResponse`	`setVideoClassificationTrainResp(XPSVideoClassificationTrainResponse videoClassificationTrainResp)`
`XPSTrainResponse`	`setVideoObjectTrackingTrainResp(XPSVideoObjectTrackingTrainResponse videoObjectTrackingTrainResp)`

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
  - XPSTrainResponse
```
public XPSTrainResponse()
```
- Method Detail
  - getDeployedModelSizeBytes
```
public Long getDeployedModelSizeBytes()
```
    Estimated model size in bytes once deployed.
    
    Returns:
    
    value or null for none
  - setDeployedModelSizeBytes
```
public XPSTrainResponse setDeployedModelSizeBytes(Long deployedModelSizeBytes)
```
    Estimated model size in bytes once deployed.
    
    Parameters:
    
    deployedModelSizeBytes - deployedModelSizeBytes or null for none
  - getErrorAnalysisConfigs
```
public List<XPSVisionErrorAnalysisConfig> getErrorAnalysisConfigs()
```
    Optional vision model error analysis configuration. The field is set when model error analysis is enabled in the training request. The results of error analysis will be binded together with evaluation results (in the format of AnnotatedExample).
    
    Returns:
    
    value or null for none
  - setErrorAnalysisConfigs
```
public XPSTrainResponse setErrorAnalysisConfigs(List<XPSVisionErrorAnalysisConfig> errorAnalysisConfigs)
```
    Optional vision model error analysis configuration. The field is set when model error analysis is enabled in the training request. The results of error analysis will be binded together with evaluation results (in the format of AnnotatedExample).
    
    Parameters:
    
    errorAnalysisConfigs - errorAnalysisConfigs or null for none
  - getEvaluatedExampleSet
```
public XPSExampleSet getEvaluatedExampleSet()
```
    Examples used to evaluate the model (usually the test set), with the predicted annotations. The file_spec should point to recordio file(s) of AnnotatedExample. For each returned example, the example_id_token and annotations predicted by the model must be set. The example payload can and is recommended to be omitted.
    
    Returns:
    
    value or null for none
  - setEvaluatedExampleSet
```
public XPSTrainResponse setEvaluatedExampleSet(XPSExampleSet evaluatedExampleSet)
```
    Examples used to evaluate the model (usually the test set), with the predicted annotations. The file_spec should point to recordio file(s) of AnnotatedExample. For each returned example, the example_id_token and annotations predicted by the model must be set. The example payload can and is recommended to be omitted.
    
    Parameters:
    
    evaluatedExampleSet - evaluatedExampleSet or null for none
  - getEvaluationMetricsSet
```
public XPSEvaluationMetricsSet getEvaluationMetricsSet()
```
    The trained model evaluation metrics. This can be optionally returned.
    
    Returns:
    
    value or null for none
  - setEvaluationMetricsSet
```
public XPSTrainResponse setEvaluationMetricsSet(XPSEvaluationMetricsSet evaluationMetricsSet)
```
    The trained model evaluation metrics. This can be optionally returned.
    
    Parameters:
    
    evaluationMetricsSet - evaluationMetricsSet or null for none
  - getExplanationConfigs
```
public List<XPSResponseExplanationSpec> getExplanationConfigs()
```
    VisionExplanationConfig for XAI on test set. Optional for when XAI is enable in training request.
    
    Returns:
    
    value or null for none
  - setExplanationConfigs
```
public XPSTrainResponse setExplanationConfigs(List<XPSResponseExplanationSpec> explanationConfigs)
```
    VisionExplanationConfig for XAI on test set. Optional for when XAI is enable in training request.
    
    Parameters:
    
    explanationConfigs - explanationConfigs or null for none
  - getImageClassificationTrainResp
```
public XPSImageClassificationTrainResponse getImageClassificationTrainResp()
```
    Returns:
    
    value or null for none
  - setImageClassificationTrainResp
```
public XPSTrainResponse setImageClassificationTrainResp(XPSImageClassificationTrainResponse imageClassificationTrainResp)
```
    Parameters:
    
    imageClassificationTrainResp - imageClassificationTrainResp or null for none
  - getImageObjectDetectionTrainResp
```
public XPSImageObjectDetectionModelSpec getImageObjectDetectionTrainResp()
```
    Returns:
    
    value or null for none
  - setImageObjectDetectionTrainResp
```
public XPSTrainResponse setImageObjectDetectionTrainResp(XPSImageObjectDetectionModelSpec imageObjectDetectionTrainResp)
```
    Parameters:
    
    imageObjectDetectionTrainResp - imageObjectDetectionTrainResp or null for none
  - getImageSegmentationTrainResp
```
public XPSImageSegmentationTrainResponse getImageSegmentationTrainResp()
```
    Returns:
    
    value or null for none
  - setImageSegmentationTrainResp
```
public XPSTrainResponse setImageSegmentationTrainResp(XPSImageSegmentationTrainResponse imageSegmentationTrainResp)
```
    Parameters:
    
    imageSegmentationTrainResp - imageSegmentationTrainResp or null for none
  - getModelToken
```
public String getModelToken()
```
    Token that represents the trained model. This is considered immutable and is persisted in AutoML. xPS can put their own proto in the byte string, to e.g. point to the model checkpoints. The token is passed to other xPS APIs to refer to the model.
    
    Returns:
    
    value or null for none
    
    See Also:
    
    decodeModelToken()
  - decodeModelToken
```
public byte[] decodeModelToken()
```
    Token that represents the trained model. This is considered immutable and is persisted in AutoML. xPS can put their own proto in the byte string, to e.g. point to the model checkpoints. The token is passed to other xPS APIs to refer to the model.
    
    Returns:
    
    Base64 decoded value or null for none
    
    Since:
    
    1.14
    
    See Also:
    
    getModelToken()
  - setModelToken
```
public XPSTrainResponse setModelToken(String modelToken)
```
    Token that represents the trained model. This is considered immutable and is persisted in AutoML. xPS can put their own proto in the byte string, to e.g. point to the model checkpoints. The token is passed to other xPS APIs to refer to the model.
    
    Parameters:
    
    modelToken - modelToken or null for none
    
    See Also:
    
    #encodeModelToken()
  - encodeModelToken
```
public XPSTrainResponse encodeModelToken(byte[] modelToken)
```
    Token that represents the trained model. This is considered immutable and is persisted in AutoML. xPS can put their own proto in the byte string, to e.g. point to the model checkpoints. The token is passed to other xPS APIs to refer to the model.
    
    Since:
    
    1.14
    
    See Also:
    
    The value is encoded Base64 or {@code null} for none.
  - getSpeechTrainResp
```
public XPSSpeechModelSpec getSpeechTrainResp()
```
    Returns:
    
    value or null for none
  - setSpeechTrainResp
```
public XPSTrainResponse setSpeechTrainResp(XPSSpeechModelSpec speechTrainResp)
```
    Parameters:
    
    speechTrainResp - speechTrainResp or null for none
  - getTablesTrainResp
```
public XPSTablesTrainResponse getTablesTrainResp()
```
    Returns:
    
    value or null for none
  - setTablesTrainResp
```
public XPSTrainResponse setTablesTrainResp(XPSTablesTrainResponse tablesTrainResp)
```
    Parameters:
    
    tablesTrainResp - tablesTrainResp or null for none
  - getTextToSpeechTrainResp
```
public XPSTextToSpeechTrainResponse getTextToSpeechTrainResp()
```
    Returns:
    
    value or null for none
  - setTextToSpeechTrainResp
```
public XPSTrainResponse setTextToSpeechTrainResp(XPSTextToSpeechTrainResponse textToSpeechTrainResp)
```
    Parameters:
    
    textToSpeechTrainResp - textToSpeechTrainResp or null for none
  - getTextTrainResp
```
public XPSTextTrainResponse getTextTrainResp()
```
    Will only be needed for uCAIP from Beta.
    
    Returns:
    
    value or null for none
  - setTextTrainResp
```
public XPSTrainResponse setTextTrainResp(XPSTextTrainResponse textTrainResp)
```
    Will only be needed for uCAIP from Beta.
    
    Parameters:
    
    textTrainResp - textTrainResp or null for none
  - getTranslationTrainResp
```
public XPSTranslationTrainResponse getTranslationTrainResp()
```
    Returns:
    
    value or null for none
  - setTranslationTrainResp
```
public XPSTrainResponse setTranslationTrainResp(XPSTranslationTrainResponse translationTrainResp)
```
    Parameters:
    
    translationTrainResp - translationTrainResp or null for none
  - getVideoActionRecognitionTrainResp
```
public XPSVideoActionRecognitionTrainResponse getVideoActionRecognitionTrainResp()
```
    Returns:
    
    value or null for none
  - setVideoActionRecognitionTrainResp
```
public XPSTrainResponse setVideoActionRecognitionTrainResp(XPSVideoActionRecognitionTrainResponse videoActionRecognitionTrainResp)
```
    Parameters:
    
    videoActionRecognitionTrainResp - videoActionRecognitionTrainResp or null for none
  - getVideoClassificationTrainResp
```
public XPSVideoClassificationTrainResponse getVideoClassificationTrainResp()
```
    Returns:
    
    value or null for none
  - setVideoClassificationTrainResp
```
public XPSTrainResponse setVideoClassificationTrainResp(XPSVideoClassificationTrainResponse videoClassificationTrainResp)
```
    Parameters:
    
    videoClassificationTrainResp - videoClassificationTrainResp or null for none
  - getVideoObjectTrackingTrainResp
```
public XPSVideoObjectTrackingTrainResponse getVideoObjectTrackingTrainResp()
```
    Returns:
    
    value or null for none
  - setVideoObjectTrackingTrainResp
```
public XPSTrainResponse setVideoObjectTrackingTrainResp(XPSVideoObjectTrackingTrainResponse videoObjectTrackingTrainResp)
```
    Parameters:
    
    videoObjectTrackingTrainResp - videoObjectTrackingTrainResp or null for none
  - set
```
public XPSTrainResponse set(String fieldName,
                            Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public XPSTrainResponse clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Class XPSTrainResponse

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

XPSTrainResponse

Method Detail

getDeployedModelSizeBytes

setDeployedModelSizeBytes

getErrorAnalysisConfigs

setErrorAnalysisConfigs

getEvaluatedExampleSet

setEvaluatedExampleSet

getEvaluationMetricsSet

setEvaluationMetricsSet

getExplanationConfigs

setExplanationConfigs

getImageClassificationTrainResp

setImageClassificationTrainResp

getImageObjectDetectionTrainResp

setImageObjectDetectionTrainResp

getImageSegmentationTrainResp

setImageSegmentationTrainResp

getModelToken

decodeModelToken

setModelToken

encodeModelToken

getSpeechTrainResp

setSpeechTrainResp

getTablesTrainResp

setTablesTrainResp

getTextToSpeechTrainResp

setTextToSpeechTrainResp

getTextTrainResp

setTextTrainResp

getTranslationTrainResp

setTranslationTrainResp

getVideoActionRecognitionTrainResp

setVideoActionRecognitionTrainResp

getVideoClassificationTrainResp

setVideoClassificationTrainResp

getVideoObjectTrackingTrainResp

setVideoObjectTrackingTrainResp

set

clone