Class CheckGroundingSpec.Builder (0.79.0)

public static final class CheckGroundingSpec.Builder extends GeneratedMessage.Builder<CheckGroundingSpec.Builder> implements CheckGroundingSpecOrBuilder

Specification for the grounding check.

Protobuf type google.cloud.discoveryengine.v1beta.CheckGroundingSpec

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

build()

public CheckGroundingSpec build()
Returns
Type Description
CheckGroundingSpec

buildPartial()

public CheckGroundingSpec buildPartial()
Returns
Type Description
CheckGroundingSpec

clear()

public CheckGroundingSpec.Builder clear()
Returns
Type Description
CheckGroundingSpec.Builder
Overrides

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
Type Description
CheckGroundingSpec.Builder

This builder for chaining.

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;

Returns
Type Description
double

The citationThreshold.

getDefaultInstanceForType()

public CheckGroundingSpec getDefaultInstanceForType()
Returns
Type Description
CheckGroundingSpec

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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;

Returns
Type Description
boolean

Whether the citationThreshold field is set.

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(CheckGroundingSpec other)

public CheckGroundingSpec.Builder mergeFrom(CheckGroundingSpec other)
Parameter
Name Description
other CheckGroundingSpec
Returns
Type Description
CheckGroundingSpec.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public CheckGroundingSpec.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CheckGroundingSpec.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public CheckGroundingSpec.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
CheckGroundingSpec.Builder
Overrides

setCitationThreshold(double value)

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;

Parameter
Name Description
value double

The citationThreshold to set.

Returns
Type Description
CheckGroundingSpec.Builder

This builder for chaining.