Class CheckGroundingSpec (0.41.0)

public final class CheckGroundingSpec extends GeneratedMessageV3 implements CheckGroundingSpecOrBuilder

Specification for the grounding check.

Protobuf type google.cloud.discoveryengine.v1beta.CheckGroundingSpec

Static Fields

CITATION_THRESHOLD_FIELD_NUMBER

public static final int CITATION_THRESHOLD_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static CheckGroundingSpec getDefaultInstance()
Returns
Type Description
CheckGroundingSpec

getDescriptor()

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

newBuilder()

public static CheckGroundingSpec.Builder newBuilder()
Returns
Type Description
CheckGroundingSpec.Builder

newBuilder(CheckGroundingSpec prototype)

public static CheckGroundingSpec.Builder newBuilder(CheckGroundingSpec prototype)
Parameter
Name Description
prototype CheckGroundingSpec
Returns
Type Description
CheckGroundingSpec.Builder

parseDelimitedFrom(InputStream input)

public static CheckGroundingSpec parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
CheckGroundingSpec
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CheckGroundingSpec parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CheckGroundingSpec
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static CheckGroundingSpec parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
CheckGroundingSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static CheckGroundingSpec parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CheckGroundingSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static CheckGroundingSpec parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
CheckGroundingSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static CheckGroundingSpec parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CheckGroundingSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static CheckGroundingSpec parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
CheckGroundingSpec
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static CheckGroundingSpec parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CheckGroundingSpec
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static CheckGroundingSpec parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
CheckGroundingSpec
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CheckGroundingSpec parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CheckGroundingSpec
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static CheckGroundingSpec parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
CheckGroundingSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static CheckGroundingSpec parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CheckGroundingSpec
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<CheckGroundingSpec> parser()
Returns
Type Description
Parser<CheckGroundingSpec>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

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

getParserForType()

public Parser<CheckGroundingSpec> getParserForType()
Returns
Type Description
Parser<CheckGroundingSpec>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public CheckGroundingSpec.Builder newBuilderForType()
Returns
Type Description
CheckGroundingSpec.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected CheckGroundingSpec.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
CheckGroundingSpec.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public CheckGroundingSpec.Builder toBuilder()
Returns
Type Description
CheckGroundingSpec.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException