Class GenerateGroundedContentResponse.Candidate.GroundingMetadata (0.49.0)

public static final class GenerateGroundedContentResponse.Candidate.GroundingMetadata extends GeneratedMessageV3 implements GenerateGroundedContentResponse.Candidate.GroundingMetadataOrBuilder

Citation for the generated content.

Protobuf type google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > GenerateGroundedContentResponse.Candidate.GroundingMetadata

Implements

GenerateGroundedContentResponse.Candidate.GroundingMetadataOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

GROUNDING_SUPPORT_FIELD_NUMBER

public static final int GROUNDING_SUPPORT_FIELD_NUMBER

Field Value
Type	Description
`int`

RETRIEVAL_METADATA_FIELD_NUMBER

public static final int RETRIEVAL_METADATA_FIELD_NUMBER

Field Value
Type	Description
`int`

SEARCH_ENTRY_POINT_FIELD_NUMBER

public static final int SEARCH_ENTRY_POINT_FIELD_NUMBER

Field Value
Type	Description
`int`

SUPPORT_CHUNKS_FIELD_NUMBER

public static final int SUPPORT_CHUNKS_FIELD_NUMBER

Field Value
Type	Description
`int`

WEB_SEARCH_QUERIES_FIELD_NUMBER

public static final int WEB_SEARCH_QUERIES_FIELD_NUMBER

Field Value
Type	Description
`int`

Static Methods

getDefaultInstance()

public static GenerateGroundedContentResponse.Candidate.GroundingMetadata getDefaultInstance()

Returns
Type	Description
`GenerateGroundedContentResponse.Candidate.GroundingMetadata`

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`Descriptor`

newBuilder()

public static GenerateGroundedContentResponse.Candidate.GroundingMetadata.Builder newBuilder()

Returns
Type	Description
`GenerateGroundedContentResponse.Candidate.GroundingMetadata.Builder`

newBuilder(GenerateGroundedContentResponse.Candidate.GroundingMetadata prototype)

public static GenerateGroundedContentResponse.Candidate.GroundingMetadata.Builder newBuilder(GenerateGroundedContentResponse.Candidate.GroundingMetadata prototype)

Parameter
Name	Description
`prototype`	`GenerateGroundedContentResponse.Candidate.GroundingMetadata`

Returns
Type	Description
`GenerateGroundedContentResponse.Candidate.GroundingMetadata.Builder`

parseDelimitedFrom(InputStream input)

public static GenerateGroundedContentResponse.Candidate.GroundingMetadata parseDelimitedFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`GenerateGroundedContentResponse.Candidate.GroundingMetadata`

Exceptions
Type	Description
`IOException`

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static GenerateGroundedContentResponse.Candidate.GroundingMetadata parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`GenerateGroundedContentResponse.Candidate.GroundingMetadata`

Exceptions
Type	Description
`IOException`

parseFrom(byte[] data)

public static GenerateGroundedContentResponse.Candidate.GroundingMetadata parseFrom(byte[] data)

Parameter
Name	Description
`data`	`byte[]`

Returns
Type	Description
`GenerateGroundedContentResponse.Candidate.GroundingMetadata`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static GenerateGroundedContentResponse.Candidate.GroundingMetadata parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`byte[]`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`GenerateGroundedContentResponse.Candidate.GroundingMetadata`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data)

public static GenerateGroundedContentResponse.Candidate.GroundingMetadata parseFrom(ByteString data)

Parameter
Name	Description
`data`	`ByteString`

Returns
Type	Description
`GenerateGroundedContentResponse.Candidate.GroundingMetadata`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static GenerateGroundedContentResponse.Candidate.GroundingMetadata parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteString`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`GenerateGroundedContentResponse.Candidate.GroundingMetadata`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(CodedInputStream input)

public static GenerateGroundedContentResponse.Candidate.GroundingMetadata parseFrom(CodedInputStream input)

Parameter
Name	Description
`input`	`CodedInputStream`

Returns
Type	Description
`GenerateGroundedContentResponse.Candidate.GroundingMetadata`

Exceptions
Type	Description
`IOException`

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static GenerateGroundedContentResponse.Candidate.GroundingMetadata parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`GenerateGroundedContentResponse.Candidate.GroundingMetadata`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input)

public static GenerateGroundedContentResponse.Candidate.GroundingMetadata parseFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`GenerateGroundedContentResponse.Candidate.GroundingMetadata`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static GenerateGroundedContentResponse.Candidate.GroundingMetadata parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`GenerateGroundedContentResponse.Candidate.GroundingMetadata`

Exceptions
Type	Description
`IOException`

parseFrom(ByteBuffer data)

public static GenerateGroundedContentResponse.Candidate.GroundingMetadata parseFrom(ByteBuffer data)

Parameter
Name	Description
`data`	`ByteBuffer`

Returns
Type	Description
`GenerateGroundedContentResponse.Candidate.GroundingMetadata`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static GenerateGroundedContentResponse.Candidate.GroundingMetadata parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteBuffer`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`GenerateGroundedContentResponse.Candidate.GroundingMetadata`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parser()

public static Parser<GenerateGroundedContentResponse.Candidate.GroundingMetadata> parser()

Returns
Type	Description
`Parser<GroundingMetadata>`

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
`obj`	`Object`

Returns
Type	Description
`boolean`

Overrides

AbstractMessage.equals(Object other)

getDefaultInstanceForType()

public GenerateGroundedContentResponse.Candidate.GroundingMetadata getDefaultInstanceForType()

Returns
Type	Description
`GenerateGroundedContentResponse.Candidate.GroundingMetadata`

getGroundingSupport(int index)

public GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport getGroundingSupport(int index)

GroundingSupport across all claims in the answer candidate. An support to a fact indicates that the claim is supported by the fact.

repeated .google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport grounding_support = 2;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport`

getGroundingSupportCount()

public int getGroundingSupportCount()

GroundingSupport across all claims in the answer candidate. An support to a fact indicates that the claim is supported by the fact.

repeated .google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport grounding_support = 2;

Returns
Type	Description
`int`

getGroundingSupportList()

public List<GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport> getGroundingSupportList()

GroundingSupport across all claims in the answer candidate. An support to a fact indicates that the claim is supported by the fact.

repeated .google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport grounding_support = 2;

Returns
Type	Description
`List<GroundingSupport>`

getGroundingSupportOrBuilder(int index)

public GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupportOrBuilder getGroundingSupportOrBuilder(int index)

GroundingSupport across all claims in the answer candidate. An support to a fact indicates that the claim is supported by the fact.

repeated .google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport grounding_support = 2;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupportOrBuilder`

getGroundingSupportOrBuilderList()

public List<? extends GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupportOrBuilder> getGroundingSupportOrBuilderList()

GroundingSupport across all claims in the answer candidate. An support to a fact indicates that the claim is supported by the fact.

repeated .google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport grounding_support = 2;

Returns
Type	Description
`List<? extends com.google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupportOrBuilder>`

getParserForType()

public Parser<GenerateGroundedContentResponse.Candidate.GroundingMetadata> getParserForType()

Returns
Type	Description
`Parser<GroundingMetadata>`

Overrides

GeneratedMessageV3.getParserForType()

getRetrievalMetadata(int index)

public GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadata getRetrievalMetadata(int index)

Retrieval metadata to provide an understanding in the retrieval steps performed by the model. There can be multiple such messages which can correspond to different parts of the retrieval. This is a mechanism used to ensure transparency to our users.

repeated .google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadata retrieval_metadata = 5;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadata`

getRetrievalMetadataCount()

public int getRetrievalMetadataCount()

repeated .google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadata retrieval_metadata = 5;

Returns
Type	Description
`int`

getRetrievalMetadataList()

public List<GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadata> getRetrievalMetadataList()

repeated .google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadata retrieval_metadata = 5;

Returns
Type	Description
`List<RetrievalMetadata>`

getRetrievalMetadataOrBuilder(int index)

public GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadataOrBuilder getRetrievalMetadataOrBuilder(int index)

repeated .google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadata retrieval_metadata = 5;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadataOrBuilder`

getRetrievalMetadataOrBuilderList()

public List<? extends GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadataOrBuilder> getRetrievalMetadataOrBuilderList()

repeated .google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadata retrieval_metadata = 5;

Returns
Type	Description
`List<? extends com.google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadataOrBuilder>`

getSearchEntryPoint()

public GenerateGroundedContentResponse.Candidate.GroundingMetadata.SearchEntryPoint getSearchEntryPoint()

Google search entry for the following-up web searches.

.google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata.SearchEntryPoint search_entry_point = 4;

Returns
Type	Description
`GenerateGroundedContentResponse.Candidate.GroundingMetadata.SearchEntryPoint`	The searchEntryPoint.

getSearchEntryPointOrBuilder()

public GenerateGroundedContentResponse.Candidate.GroundingMetadata.SearchEntryPointOrBuilder getSearchEntryPointOrBuilder()

Google search entry for the following-up web searches.

.google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata.SearchEntryPoint search_entry_point = 4;

Returns
Type	Description
`GenerateGroundedContentResponse.Candidate.GroundingMetadata.SearchEntryPointOrBuilder`

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
`int`

Overrides

GeneratedMessageV3.getSerializedSize()

getSupportChunks(int index)

public FactChunk getSupportChunks(int index)

List of chunks to be attributed across all claims in the candidate. These are derived from the grounding sources supplied in the request.