Package com.google.cloud.discoveryengine.v1

Class CheckGroundingSpec.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<CheckGroundingSpec.Builder>
com.google.cloud.discoveryengine.v1.CheckGroundingSpec.Builder
All Implemented Interfaces:
CheckGroundingSpecOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
CheckGroundingSpec
public static final class CheckGroundingSpec.Builder extends com.google.protobuf.GeneratedMessage.Builder<CheckGroundingSpec.Builder> implements CheckGroundingSpecOrBuilder
 Specification for the grounding check.
Protobuf type google.cloud.discoveryengine.v1.CheckGroundingSpec

  • Method Summary

    Modifier and Type
    Method
    Description
    CheckGroundingSpec
    build()
     
    CheckGroundingSpec
    buildPartial()
     
    CheckGroundingSpec.Builder
    clear()
     
    CheckGroundingSpec.Builder
    clearCitationThreshold()
    The threshold (in [0,1]) used for determining whether a fact must be cited for a claim in the answer candidate.
    CheckGroundingSpec.Builder
    clearEnableClaimLevelScore()
    The control flag that enables claim-level grounding score in the response.
    double
    getCitationThreshold()
    The threshold (in [0,1]) used for determining whether a fact must be cited for a claim in the answer candidate.
    CheckGroundingSpec
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.Descriptors.Descriptor
    getDescriptorForType()
     
    boolean
    getEnableClaimLevelScore()
    The control flag that enables claim-level grounding score in the response.
    boolean
    hasCitationThreshold()
    The threshold (in [0,1]) used for determining whether a fact must be cited for a claim in the answer candidate.
    boolean
    hasEnableClaimLevelScore()
    The control flag that enables claim-level grounding score in the response.
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    CheckGroundingSpec.Builder
    mergeFrom(CheckGroundingSpec other)
     
    CheckGroundingSpec.Builder
    mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    CheckGroundingSpec.Builder
    mergeFrom(com.google.protobuf.Message other)
     
    CheckGroundingSpec.Builder
    setCitationThreshold(double value)
    The threshold (in [0,1]) used for determining whether a fact must be cited for a claim in the answer candidate.
    CheckGroundingSpec.Builder
    setEnableClaimLevelScore(boolean value)
    The control flag that enables claim-level grounding score in the response.

    Methods inherited from class com.google.protobuf.GeneratedMessage.Builder

    addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, setUnknownFieldSetBuilder, setUnknownFieldsProto3

    Methods inherited from class com.google.protobuf.AbstractMessage.Builder

    findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

    addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

    Methods inherited from class java.lang.Object

    equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.Message.Builder

    mergeDelimitedFrom, mergeDelimitedFrom

    Methods inherited from interface com.google.protobuf.MessageLite.Builder

    mergeFrom

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<CheckGroundingSpec.Builder>

    • clear

      public CheckGroundingSpec.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<CheckGroundingSpec.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<CheckGroundingSpec.Builder>

    • getDefaultInstanceForType

      public CheckGroundingSpec getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

    • build

      public CheckGroundingSpec build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder

    • buildPartial

      public CheckGroundingSpec buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder

    • mergeFrom

      public CheckGroundingSpec.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<CheckGroundingSpec.Builder>

    • mergeFrom

      public CheckGroundingSpec.Builder mergeFrom(CheckGroundingSpec other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<CheckGroundingSpec.Builder>

    • mergeFrom

      public CheckGroundingSpec.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<CheckGroundingSpec.Builder>
      Throws:
      IOException

    • hasCitationThreshold

      public boolean hasCitationThreshold()
       The threshold (in [0,1]) used for determining whether a fact must be
 cited for a claim in the answer candidate. Choosing a higher threshold
 will lead to fewer but very strong citations, while choosing a lower
 threshold may lead to more but somewhat weaker citations. If unset, the
 threshold will default to 0.6.
      optional double citation_threshold = 1;
      Specified by:
      hasCitationThreshold in interface CheckGroundingSpecOrBuilder
      Returns:
      Whether the citationThreshold field is set.

    • getCitationThreshold

      public double getCitationThreshold()
       The threshold (in [0,1]) used for determining whether a fact must be
 cited for a claim in the answer candidate. Choosing a higher threshold
 will lead to fewer but very strong citations, while choosing a lower
 threshold may lead to more but somewhat weaker citations. If unset, the
 threshold will default to 0.6.
      optional double citation_threshold = 1;
      Specified by:
      getCitationThreshold in interface CheckGroundingSpecOrBuilder
      Returns:
      The citationThreshold.

    • setCitationThreshold

      public CheckGroundingSpec.Builder setCitationThreshold(double value)
       The threshold (in [0,1]) used for determining whether a fact must be
 cited for a claim in the answer candidate. Choosing a higher threshold
 will lead to fewer but very strong citations, while choosing a lower
 threshold may lead to more but somewhat weaker citations. If unset, the
 threshold will default to 0.6.
      optional double citation_threshold = 1;
      Parameters:
      value - The citationThreshold to set.
      Returns:
      This builder for chaining.

    • clearCitationThreshold

      public CheckGroundingSpec.Builder clearCitationThreshold()
       The threshold (in [0,1]) used for determining whether a fact must be
 cited for a claim in the answer candidate. Choosing a higher threshold
 will lead to fewer but very strong citations, while choosing a lower
 threshold may lead to more but somewhat weaker citations. If unset, the
 threshold will default to 0.6.
      optional double citation_threshold = 1;
      Returns:
      This builder for chaining.

    • hasEnableClaimLevelScore

      public boolean hasEnableClaimLevelScore()
       The control flag that enables claim-level grounding score in the response.
      optional bool enable_claim_level_score = 4;
      Specified by:
      hasEnableClaimLevelScore in interface CheckGroundingSpecOrBuilder
      Returns:
      Whether the enableClaimLevelScore field is set.

    • getEnableClaimLevelScore

      public boolean getEnableClaimLevelScore()
       The control flag that enables claim-level grounding score in the response.
      optional bool enable_claim_level_score = 4;
      Specified by:
      getEnableClaimLevelScore in interface CheckGroundingSpecOrBuilder
      Returns:
      The enableClaimLevelScore.

    • setEnableClaimLevelScore

      public CheckGroundingSpec.Builder setEnableClaimLevelScore(boolean value)
       The control flag that enables claim-level grounding score in the response.
      optional bool enable_claim_level_score = 4;
      Parameters:
      value - The enableClaimLevelScore to set.
      Returns:
      This builder for chaining.

    • clearEnableClaimLevelScore

      public CheckGroundingSpec.Builder clearEnableClaimLevelScore()
       The control flag that enables claim-level grounding score in the response.
      optional bool enable_claim_level_score = 4;
      Returns:
      This builder for chaining.