com.google.cloud.discoveryengine.v1beta

Class GenerateGroundedContentResponse.Candidate

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.discoveryengine.v1beta.GenerateGroundedContentResponse.Candidate

All Implemented Interfaces:

GenerateGroundedContentResponse.CandidateOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

Enclosing class:

GenerateGroundedContentResponse

public static final class GenerateGroundedContentResponse.Candidate
extends com.google.protobuf.GeneratedMessageV3
implements GenerateGroundedContentResponse.CandidateOrBuilder

 A response candidate generated from the model.
 

Protobuf type google.cloud.discoveryengine.v1beta.GenerateGroundedContentResponse.Candidate

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GenerateGroundedContentResponse.Candidate.Builder A response candidate generated from the model.
static class	GenerateGroundedContentResponse.Candidate.GroundingMetadata Citation for the generated content.
static interface	GenerateGroundedContentResponse.Candidate.GroundingMetadataOrBuilder

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

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

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	CONTENT_FIELD_NUMBER
static int	GROUNDING_METADATA_FIELD_NUMBER
static int	GROUNDING_SCORE_FIELD_NUMBER
static int	INDEX_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, 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)
GroundedGenerationContent	getContent() Content of the candidate.
GroundedGenerationContentOrBuilder	getContentOrBuilder() Content of the candidate.
static GenerateGroundedContentResponse.Candidate	getDefaultInstance()
GenerateGroundedContentResponse.Candidate	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
GenerateGroundedContentResponse.Candidate.GroundingMetadata	getGroundingMetadata() Grounding metadata for the generated content.
GenerateGroundedContentResponse.Candidate.GroundingMetadataOrBuilder	getGroundingMetadataOrBuilder() Grounding metadata for the generated content.
float	getGroundingScore() The overall grounding score for the candidate, in the range of [0, 1].
int	getIndex() Index of the candidate.
com.google.protobuf.Parser<GenerateGroundedContentResponse.Candidate>	getParserForType()
int	getSerializedSize()
boolean	hasContent() Content of the candidate.
boolean	hasGroundingMetadata() Grounding metadata for the generated content.
boolean	hasGroundingScore() The overall grounding score for the candidate, in the range of [0, 1].
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static GenerateGroundedContentResponse.Candidate.Builder	newBuilder()
static GenerateGroundedContentResponse.Candidate.Builder	newBuilder(GenerateGroundedContentResponse.Candidate prototype)
GenerateGroundedContentResponse.Candidate.Builder	newBuilderForType()
protected GenerateGroundedContentResponse.Candidate.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static GenerateGroundedContentResponse.Candidate	parseDelimitedFrom(InputStream input)
static GenerateGroundedContentResponse.Candidate	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static GenerateGroundedContentResponse.Candidate	parseFrom(byte[] data)
static GenerateGroundedContentResponse.Candidate	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static GenerateGroundedContentResponse.Candidate	parseFrom(ByteBuffer data)
static GenerateGroundedContentResponse.Candidate	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static GenerateGroundedContentResponse.Candidate	parseFrom(com.google.protobuf.ByteString data)
static GenerateGroundedContentResponse.Candidate	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static GenerateGroundedContentResponse.Candidate	parseFrom(com.google.protobuf.CodedInputStream input)
static GenerateGroundedContentResponse.Candidate	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static GenerateGroundedContentResponse.Candidate	parseFrom(InputStream input)
static GenerateGroundedContentResponse.Candidate	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<GenerateGroundedContentResponse.Candidate>	parser()
GenerateGroundedContentResponse.Candidate.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

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, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, 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, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, 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

INDEX_FIELD_NUMBER

public static final int INDEX_FIELD_NUMBER

See Also:

Constant Field Values

CONTENT_FIELD_NUMBER

public static final int CONTENT_FIELD_NUMBER

See Also:

Constant Field Values

GROUNDING_SCORE_FIELD_NUMBER

public static final int GROUNDING_SCORE_FIELD_NUMBER

See Also:

Constant Field Values

GROUNDING_METADATA_FIELD_NUMBER

public static final int GROUNDING_METADATA_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getIndex

public int getIndex()

 Index of the candidate.
 

int32 index = 1;

Specified by:

getIndex in interface GenerateGroundedContentResponse.CandidateOrBuilder

Returns:

The index.

hasContent

public boolean hasContent()

 Content of the candidate.
 

.google.cloud.discoveryengine.v1beta.GroundedGenerationContent content = 2;

Specified by:

hasContent in interface GenerateGroundedContentResponse.CandidateOrBuilder

Returns:

Whether the content field is set.

getContent

public GroundedGenerationContent getContent()

 Content of the candidate.
 

.google.cloud.discoveryengine.v1beta.GroundedGenerationContent content = 2;

Specified by:

getContent in interface GenerateGroundedContentResponse.CandidateOrBuilder

Returns:

The content.

getContentOrBuilder

public GroundedGenerationContentOrBuilder getContentOrBuilder()

 Content of the candidate.
 

.google.cloud.discoveryengine.v1beta.GroundedGenerationContent content = 2;

Specified by:

getContentOrBuilder in interface GenerateGroundedContentResponse.CandidateOrBuilder

hasGroundingScore

public boolean hasGroundingScore()

 The overall grounding score for the candidate, in the range of [0, 1].
 

optional float grounding_score = 3;

Specified by:

hasGroundingScore in interface GenerateGroundedContentResponse.CandidateOrBuilder

Returns:

Whether the groundingScore field is set.

getGroundingScore

public float getGroundingScore()

 The overall grounding score for the candidate, in the range of [0, 1].
 

optional float grounding_score = 3;

Specified by:

getGroundingScore in interface GenerateGroundedContentResponse.CandidateOrBuilder

Returns:

The groundingScore.

hasGroundingMetadata

public boolean hasGroundingMetadata()

 Grounding metadata for the generated content.
 

.google.cloud.discoveryengine.v1beta.GenerateGroundedContentResponse.Candidate.GroundingMetadata grounding_metadata = 4;

Specified by:

hasGroundingMetadata in interface GenerateGroundedContentResponse.CandidateOrBuilder

Returns:

Whether the groundingMetadata field is set.

getGroundingMetadata

public GenerateGroundedContentResponse.Candidate.GroundingMetadata getGroundingMetadata()

 Grounding metadata for the generated content.
 

.google.cloud.discoveryengine.v1beta.GenerateGroundedContentResponse.Candidate.GroundingMetadata grounding_metadata = 4;

Specified by:

getGroundingMetadata in interface GenerateGroundedContentResponse.CandidateOrBuilder

Returns:

The groundingMetadata.

getGroundingMetadataOrBuilder

public GenerateGroundedContentResponse.Candidate.GroundingMetadataOrBuilder getGroundingMetadataOrBuilder()

 Grounding metadata for the generated content.
 

.google.cloud.discoveryengine.v1beta.GenerateGroundedContentResponse.Candidate.GroundingMetadata grounding_metadata = 4;

Specified by:

getGroundingMetadataOrBuilder in interface GenerateGroundedContentResponse.CandidateOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

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.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

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 GenerateGroundedContentResponse.Candidate parseFrom(ByteBuffer data)
                                                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static GenerateGroundedContentResponse.Candidate parseFrom(InputStream input)
                                                           throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

public static GenerateGroundedContentResponse.Candidate parseDelimitedFrom(InputStream input)
                                                                    throws IOException

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public GenerateGroundedContentResponse.Candidate.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static GenerateGroundedContentResponse.Candidate.Builder newBuilder()

newBuilder

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

toBuilder

public GenerateGroundedContentResponse.Candidate.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected GenerateGroundedContentResponse.Candidate.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static GenerateGroundedContentResponse.Candidate getDefaultInstance()

parser

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

getParserForType

public com.google.protobuf.Parser<GenerateGroundedContentResponse.Candidate> 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.GeneratedMessageV3

getDefaultInstanceForType

public GenerateGroundedContentResponse.Candidate getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder