com.google.cloud.discoveryengine.v1

Class CheckGroundingSpec

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessage

com.google.cloud.discoveryengine.v1.CheckGroundingSpec

All Implemented Interfaces:

CheckGroundingSpecOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

@Generated
public final class CheckGroundingSpec
extends com.google.protobuf.GeneratedMessage
implements CheckGroundingSpecOrBuilder

 Specification for the grounding check.
 

Protobuf type google.cloud.discoveryengine.v1.CheckGroundingSpec

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CheckGroundingSpec.Builder Specification for the grounding check.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

com.google.protobuf.AbstractMessage.BuilderParent

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	CITATION_THRESHOLD_FIELD_NUMBER
static int	ENABLE_CLAIM_LEVEL_SCORE_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessage

alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
double	getCitationThreshold() The threshold (in [0,1]) used for determining whether a fact must be cited for a claim in the answer candidate.
static CheckGroundingSpec	getDefaultInstance()
CheckGroundingSpec	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
boolean	getEnableClaimLevelScore() The control flag that enables claim-level grounding score in the response.
com.google.protobuf.Parser<CheckGroundingSpec>	getParserForType()
int	getSerializedSize()
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.
int	hashCode()
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static CheckGroundingSpec.Builder	newBuilder()
static CheckGroundingSpec.Builder	newBuilder(CheckGroundingSpec prototype)
CheckGroundingSpec.Builder	newBuilderForType()
protected CheckGroundingSpec.Builder	newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
static CheckGroundingSpec	parseDelimitedFrom(InputStream input)
static CheckGroundingSpec	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static CheckGroundingSpec	parseFrom(byte[] data)
static CheckGroundingSpec	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static CheckGroundingSpec	parseFrom(ByteBuffer data)
static CheckGroundingSpec	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static CheckGroundingSpec	parseFrom(com.google.protobuf.ByteString data)
static CheckGroundingSpec	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static CheckGroundingSpec	parseFrom(com.google.protobuf.CodedInputStream input)
static CheckGroundingSpec	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static CheckGroundingSpec	parseFrom(InputStream input)
static CheckGroundingSpec	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<CheckGroundingSpec>	parser()
CheckGroundingSpec.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessage

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashFields, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

CITATION_THRESHOLD_FIELD_NUMBER

public static final int CITATION_THRESHOLD_FIELD_NUMBER

See Also:

Constant Field Values

ENABLE_CLAIM_LEVEL_SCORE_FIELD_NUMBER

public static final int ENABLE_CLAIM_LEVEL_SCORE_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

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

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.

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.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessage

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessage

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessage

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static CheckGroundingSpec parseFrom(ByteBuffer data)
                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static CheckGroundingSpec parseFrom(ByteBuffer data,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static CheckGroundingSpec parseFrom(com.google.protobuf.ByteString data)
                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static CheckGroundingSpec parseFrom(com.google.protobuf.ByteString data,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static CheckGroundingSpec parseFrom(byte[] data)
                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static CheckGroundingSpec parseFrom(byte[] data,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static CheckGroundingSpec parseFrom(InputStream input)
                                    throws IOException

Throws:

IOException

parseFrom

public static CheckGroundingSpec parseFrom(InputStream input,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws IOException

Throws:

IOException

parseDelimitedFrom

public static CheckGroundingSpec parseDelimitedFrom(InputStream input)
                                             throws IOException

Throws:

IOException

parseDelimitedFrom

public static CheckGroundingSpec parseDelimitedFrom(InputStream input,
                                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                             throws IOException

Throws:

IOException

parseFrom

public static CheckGroundingSpec parseFrom(com.google.protobuf.CodedInputStream input)
                                    throws IOException

Throws:

IOException

parseFrom

public static CheckGroundingSpec parseFrom(com.google.protobuf.CodedInputStream input,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws IOException

Throws:

IOException

newBuilderForType

public CheckGroundingSpec.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static CheckGroundingSpec.Builder newBuilder()

newBuilder

public static CheckGroundingSpec.Builder newBuilder(CheckGroundingSpec prototype)

toBuilder

public CheckGroundingSpec.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected CheckGroundingSpec.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)

Overrides:

newBuilderForType in class com.google.protobuf.AbstractMessage

getDefaultInstance

public static CheckGroundingSpec getDefaultInstance()

parser

public static com.google.protobuf.Parser<CheckGroundingSpec> parser()

getParserForType

public com.google.protobuf.Parser<CheckGroundingSpec> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessage

getDefaultInstanceForType

public CheckGroundingSpec getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder