public static final class Answer.GroundingSupport extends GeneratedMessage implements Answer.GroundingSupportOrBuilder
Grounding support for a claim in answer_text.
Protobuf type google.cloud.discoveryengine.v1.Answer.GroundingSupport
Inherited Members
com.google.protobuf.GeneratedMessage.<ContainingT,T>newFileScopedGeneratedExtension(java.lang.Class<?>,com.google.protobuf.Message)
com.google.protobuf.GeneratedMessage.<ContainingT,T>newMessageScopedGeneratedExtension(com.google.protobuf.Message,int,java.lang.Class<?>,com.google.protobuf.Message)
com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessage.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessage.<V>serializeBooleanMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Boolean,V>,com.google.protobuf.MapEntry<java.lang.Boolean,V>,int)
com.google.protobuf.GeneratedMessage.<V>serializeIntegerMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Integer,V>,com.google.protobuf.MapEntry<java.lang.Integer,V>,int)
com.google.protobuf.GeneratedMessage.<V>serializeLongMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Long,V>,com.google.protobuf.MapEntry<java.lang.Long,V>,int)
com.google.protobuf.GeneratedMessage.<V>serializeStringMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.String,V>,com.google.protobuf.MapEntry<java.lang.String,V>,int)
com.google.protobuf.GeneratedMessage.canUseUnsafe()
com.google.protobuf.GeneratedMessage.emptyBooleanList()
com.google.protobuf.GeneratedMessage.emptyDoubleList()
com.google.protobuf.GeneratedMessage.emptyFloatList()
com.google.protobuf.GeneratedMessage.emptyIntList()
com.google.protobuf.GeneratedMessage.emptyLongList()
com.google.protobuf.GeneratedMessage.internalGetMapFieldReflection(int)
com.google.protobuf.GeneratedMessage.isStringEmpty(java.lang.Object)
com.google.protobuf.GeneratedMessage.mergeFromAndMakeImmutableInternal(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite)
com.google.protobuf.GeneratedMessage.newInstance(com.google.protobuf.GeneratedMessage.UnusedPrivateParameter)
com.google.protobuf.GeneratedMessage.parseUnknownFieldProto3(com.google.protobuf.CodedInputStream,com.google.protobuf.UnknownFieldSet.Builder,com.google.protobuf.ExtensionRegistryLite,int)
Static Fields
END_INDEX_FIELD_NUMBER
public static final int END_INDEX_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
GROUNDING_CHECK_REQUIRED_FIELD_NUMBER
public static final int GROUNDING_CHECK_REQUIRED_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
GROUNDING_SCORE_FIELD_NUMBER
public static final int GROUNDING_SCORE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
SOURCES_FIELD_NUMBER
public static final int SOURCES_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
START_INDEX_FIELD_NUMBER
public static final int START_INDEX_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static Answer.GroundingSupport getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static Answer.GroundingSupport.Builder newBuilder()
newBuilder(Answer.GroundingSupport prototype)
public static Answer.GroundingSupport.Builder newBuilder(Answer.GroundingSupport prototype)
public static Answer.GroundingSupport parseDelimitedFrom(InputStream input)
public static Answer.GroundingSupport parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static Answer.GroundingSupport parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Answer.GroundingSupport parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static Answer.GroundingSupport parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Answer.GroundingSupport parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Answer.GroundingSupport parseFrom(CodedInputStream input)
public static Answer.GroundingSupport parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static Answer.GroundingSupport parseFrom(InputStream input)
public static Answer.GroundingSupport parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static Answer.GroundingSupport parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Answer.GroundingSupport parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<Answer.GroundingSupport> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getDefaultInstanceForType()
public Answer.GroundingSupport getDefaultInstanceForType()
getEndIndex()
public long getEndIndex()
Required. End of the claim, exclusive.
int64 end_index = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns |
| Type |
Description |
long |
The endIndex.
|
getGroundingCheckRequired()
public boolean getGroundingCheckRequired()
Indicates that this claim required grounding check. When the
system decided this claim didn't require attribution/grounding check,
this field is set to false. In that case, no grounding check was
done for the claim and therefore grounding_score, sources is not
returned.
optional bool grounding_check_required = 4;
| Returns |
| Type |
Description |
boolean |
The groundingCheckRequired.
|
getGroundingScore()
public double getGroundingScore()
A score in the range of [0, 1] describing how grounded is a specific
claim by the references.
Higher value means that the claim is better supported by the reference
chunks.
optional double grounding_score = 3;
| Returns |
| Type |
Description |
double |
The groundingScore.
|
getParserForType()
public Parser<Answer.GroundingSupport> getParserForType()
Overrides
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
getSources(int index)
public Answer.CitationSource getSources(int index)
Optional. Citation sources for the claim.
repeated .google.cloud.discoveryengine.v1.Answer.CitationSource sources = 5 [(.google.api.field_behavior) = OPTIONAL];
| Parameter |
| Name |
Description |
index |
int
|
getSourcesCount()
public int getSourcesCount()
Optional. Citation sources for the claim.
repeated .google.cloud.discoveryengine.v1.Answer.CitationSource sources = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
int |
|
getSourcesList()
public List<Answer.CitationSource> getSourcesList()
Optional. Citation sources for the claim.
repeated .google.cloud.discoveryengine.v1.Answer.CitationSource sources = 5 [(.google.api.field_behavior) = OPTIONAL];
getSourcesOrBuilder(int index)
public Answer.CitationSourceOrBuilder getSourcesOrBuilder(int index)
Optional. Citation sources for the claim.
repeated .google.cloud.discoveryengine.v1.Answer.CitationSource sources = 5 [(.google.api.field_behavior) = OPTIONAL];
| Parameter |
| Name |
Description |
index |
int
|
getSourcesOrBuilderList()
public List<? extends Answer.CitationSourceOrBuilder> getSourcesOrBuilderList()
Optional. Citation sources for the claim.
repeated .google.cloud.discoveryengine.v1.Answer.CitationSource sources = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
List<? extends com.google.cloud.discoveryengine.v1.Answer.CitationSourceOrBuilder> |
|
getStartIndex()
public long getStartIndex()
Required. Index indicates the start of the claim, measured in bytes
(UTF-8 unicode).
int64 start_index = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns |
| Type |
Description |
long |
The startIndex.
|
hasGroundingCheckRequired()
public boolean hasGroundingCheckRequired()
Indicates that this claim required grounding check. When the
system decided this claim didn't require attribution/grounding check,
this field is set to false. In that case, no grounding check was
done for the claim and therefore grounding_score, sources is not
returned.
optional bool grounding_check_required = 4;
| Returns |
| Type |
Description |
boolean |
Whether the groundingCheckRequired field is set.
|
hasGroundingScore()
public boolean hasGroundingScore()
A score in the range of [0, 1] describing how grounded is a specific
claim by the references.
Higher value means that the claim is better supported by the reference
chunks.
optional double grounding_score = 3;
| Returns |
| Type |
Description |
boolean |
Whether the groundingScore field is set.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public Answer.GroundingSupport.Builder newBuilderForType()
newBuilderForType(AbstractMessage.BuilderParent parent)
protected Answer.GroundingSupport.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Overrides
toBuilder()
public Answer.GroundingSupport.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
