Package com.google.cloud.discoveryengine.v1beta

Interface GenerateGroundedContentResponse.Candidate.GroundingMetadata.DynamicRetrievalPredictorMetadataOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
GenerateGroundedContentResponse.Candidate.GroundingMetadata.DynamicRetrievalPredictorMetadata, GenerateGroundedContentResponse.Candidate.GroundingMetadata.DynamicRetrievalPredictorMetadata.Builder
Enclosing class:
GenerateGroundedContentResponse.Candidate.GroundingMetadata
public static interface GenerateGroundedContentResponse.Candidate.GroundingMetadata.DynamicRetrievalPredictorMetadataOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    float
    getPrediction()
    The value of the predictor.
    GenerateGroundedContentResponse.Candidate.GroundingMetadata.DynamicRetrievalPredictorMetadata.Version
    getVersion()
    The version of the predictor which was used in dynamic retrieval.
    int
    getVersionValue()
    The version of the predictor which was used in dynamic retrieval.
    boolean
    hasPrediction()
    The value of the predictor.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getVersionValue

      int getVersionValue()
       The version of the predictor which was used in dynamic retrieval.
      .google.cloud.discoveryengine.v1beta.GenerateGroundedContentResponse.Candidate.GroundingMetadata.DynamicRetrievalPredictorMetadata.Version version = 1;
      Returns:
      The enum numeric value on the wire for version.

    • getVersion

      GenerateGroundedContentResponse.Candidate.GroundingMetadata.DynamicRetrievalPredictorMetadata.Version getVersion()
       The version of the predictor which was used in dynamic retrieval.
      .google.cloud.discoveryengine.v1beta.GenerateGroundedContentResponse.Candidate.GroundingMetadata.DynamicRetrievalPredictorMetadata.Version version = 1;
      Returns:
      The version.

    • hasPrediction

      boolean hasPrediction()
       The value of the predictor. This should be between [0, 1] where
 a value of 0 means that the query would not benefit from grounding,
 while a value of 1.0 means that the query would benefit the most.
 In between values allow to differentiate between different usefulness
 scores for grounding.
      optional float prediction = 2;
      Returns:
      Whether the prediction field is set.

    • getPrediction

      float getPrediction()
       The value of the predictor. This should be between [0, 1] where
 a value of 0 means that the query would not benefit from grounding,
 while a value of 1.0 means that the query would benefit the most.
 In between values allow to differentiate between different usefulness
 scores for grounding.
      optional float prediction = 2;
      Returns:
      The prediction.