Some or all of the information on this page might not apply to Cloud de Confiance by S3NS. See Differences from Google Cloud for more details.

Class GenerateGroundedContentResponse.Candidate (0.81.0)

public static final class GenerateGroundedContentResponse.Candidate extends GeneratedMessage implements GenerateGroundedContentResponse.CandidateOrBuilder

A response candidate generated from the model.

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

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessage > GenerateGroundedContentResponse.Candidate

Implements

GenerateGroundedContentResponse.CandidateOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashCode()

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

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent)

AbstractMessage.toString()

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

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

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)

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

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

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

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

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

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

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()

GeneratedMessage.computeStringSize(int,Object)

GeneratedMessage.computeStringSizeNoTag(Object)

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()

GeneratedMessage.getAllFields()

GeneratedMessage.getDescriptorForType()

GeneratedMessage.getField(Descriptors.FieldDescriptor)

GeneratedMessage.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessage.getParserForType()

GeneratedMessage.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessage.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessage.getSerializedSize()

GeneratedMessage.getUnknownFields()

GeneratedMessage.hasField(Descriptors.FieldDescriptor)

GeneratedMessage.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessage.internalGetFieldAccessorTable()

GeneratedMessage.internalGetMapField(int)

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

GeneratedMessage.isInitialized()

com.google.protobuf.GeneratedMessage.isStringEmpty(java.lang.Object)

GeneratedMessage.makeExtensionsImmutable()

com.google.protobuf.GeneratedMessage.mergeFromAndMakeImmutableInternal(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite)

com.google.protobuf.GeneratedMessage.newInstance(com.google.protobuf.GeneratedMessage.UnusedPrivateParameter)

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

com.google.protobuf.GeneratedMessage.parseUnknownFieldProto3(com.google.protobuf.CodedInputStream,com.google.protobuf.UnknownFieldSet.Builder,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessage.writeReplace()

GeneratedMessage.writeString(CodedOutputStream,int,Object)

GeneratedMessage.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessage.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

CONTENT_FIELD_NUMBER

public static final int CONTENT_FIELD_NUMBER

Field Value
Type	Description
`int`

GROUNDING_METADATA_FIELD_NUMBER

public static final int GROUNDING_METADATA_FIELD_NUMBER

Field Value
Type	Description
`int`

GROUNDING_SCORE_FIELD_NUMBER

public static final int GROUNDING_SCORE_FIELD_NUMBER

Field Value
Type	Description
`int`

INDEX_FIELD_NUMBER

public static final int INDEX_FIELD_NUMBER

Field Value
Type	Description
`int`

Static Methods

getDefaultInstance()

public static GenerateGroundedContentResponse.Candidate getDefaultInstance()

Returns
Type	Description
`GenerateGroundedContentResponse.Candidate`

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`Descriptor`

newBuilder()

public static GenerateGroundedContentResponse.Candidate.Builder newBuilder()

Returns
Type	Description
`GenerateGroundedContentResponse.Candidate.Builder`

newBuilder(GenerateGroundedContentResponse.Candidate prototype)

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

Parameter
Name	Description
`prototype`	`GenerateGroundedContentResponse.Candidate`

Returns
Type	Description
`GenerateGroundedContentResponse.Candidate.Builder`

parseDelimitedFrom(InputStream input)

public static GenerateGroundedContentResponse.Candidate parseDelimitedFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`GenerateGroundedContentResponse.Candidate`

Exceptions
Type	Description
`IOException`

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

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

Returns
Type	Description
`GenerateGroundedContentResponse.Candidate`

Exceptions
Type	Description
`IOException`

parseFrom(byte[] data)

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

Parameter
Name	Description
`data`	`byte[]`

Returns
Type	Description
`GenerateGroundedContentResponse.Candidate`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

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

Returns
Type	Description
`GenerateGroundedContentResponse.Candidate`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data)

public static GenerateGroundedContentResponse.Candidate parseFrom(ByteString data)

Parameter
Name	Description
`data`	`ByteString`

Returns
Type	Description
`GenerateGroundedContentResponse.Candidate`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

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

Returns
Type	Description
`GenerateGroundedContentResponse.Candidate`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(CodedInputStream input)

public static GenerateGroundedContentResponse.Candidate parseFrom(CodedInputStream input)

Parameter
Name	Description
`input`	`CodedInputStream`

Returns
Type	Description
`GenerateGroundedContentResponse.Candidate`

Exceptions
Type	Description
`IOException`

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

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

Returns
Type	Description
`GenerateGroundedContentResponse.Candidate`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input)

public static GenerateGroundedContentResponse.Candidate parseFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`GenerateGroundedContentResponse.Candidate`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

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

Returns
Type	Description
`GenerateGroundedContentResponse.Candidate`

Exceptions
Type	Description
`IOException`

parseFrom(ByteBuffer data)

public static GenerateGroundedContentResponse.Candidate parseFrom(ByteBuffer data)

Parameter
Name	Description
`data`	`ByteBuffer`

Returns
Type	Description
`GenerateGroundedContentResponse.Candidate`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

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

Returns
Type	Description
`GenerateGroundedContentResponse.Candidate`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parser()

public static Parser<GenerateGroundedContentResponse.Candidate> parser()

Returns
Type	Description
`Parser<Candidate>`

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
`obj`	`Object`

Returns
Type	Description
`boolean`

Overrides

AbstractMessage.equals(Object other)

getContent()

public GroundedGenerationContent getContent()

Content of the candidate.

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

Returns
Type	Description
`GroundedGenerationContent`	The content.

getContentOrBuilder()

public GroundedGenerationContentOrBuilder getContentOrBuilder()

Content of the candidate.

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

Returns
Type	Description
`GroundedGenerationContentOrBuilder`

getDefaultInstanceForType()

public GenerateGroundedContentResponse.Candidate getDefaultInstanceForType()

Returns
Type	Description
`GenerateGroundedContentResponse.Candidate`

getGroundingMetadata()

public GenerateGroundedContentResponse.Candidate.GroundingMetadata getGroundingMetadata()

Grounding metadata for the generated content.

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

Returns
Type	Description
`GenerateGroundedContentResponse.Candidate.GroundingMetadata`	The groundingMetadata.

getGroundingMetadataOrBuilder()

public GenerateGroundedContentResponse.Candidate.GroundingMetadataOrBuilder getGroundingMetadataOrBuilder()

Grounding metadata for the generated content.

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

Returns
Type	Description
`GenerateGroundedContentResponse.Candidate.GroundingMetadataOrBuilder`

getGroundingScore()

public float getGroundingScore()

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

optional float grounding_score = 3;

Returns
Type	Description
`float`	The groundingScore.

getIndex()

public int getIndex()

Index of the candidate.

int32 index = 1;

Returns
Type	Description
`int`	The index.

getParserForType()

public Parser<GenerateGroundedContentResponse.Candidate> getParserForType()

Returns
Type	Description
`Parser<Candidate>`

Overrides

GeneratedMessage.getParserForType()

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
`int`

Overrides

GeneratedMessage.getSerializedSize()

hasContent()

public boolean hasContent()

Content of the candidate.

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

Returns
Type	Description
`boolean`	Whether the content field is set.

hasGroundingMetadata()

public boolean hasGroundingMetadata()

Grounding metadata for the generated content.

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

Returns
Type	Description
`boolean`	Whether the groundingMetadata field is set.

hasGroundingScore()

public boolean hasGroundingScore()

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

optional float grounding_score = 3;

Returns
Type	Description
`boolean`	Whether the groundingScore field is set.

hashCode()

public int hashCode()

Returns
Type	Description
`int`

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessage.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessage.isInitialized()

newBuilderForType()

public GenerateGroundedContentResponse.Candidate.Builder newBuilderForType()

Returns
Type	Description
`GenerateGroundedContentResponse.Candidate.Builder`

newBuilderForType(AbstractMessage.BuilderParent parent)

protected GenerateGroundedContentResponse.Candidate.Builder newBuilderForType(AbstractMessage.BuilderParent parent)

Parameter
Name	Description
`parent`	`BuilderParent`

Returns
Type	Description
`GenerateGroundedContentResponse.Candidate.Builder`

Overrides

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent parent)

toBuilder()

public GenerateGroundedContentResponse.Candidate.Builder toBuilder()

Returns
Type	Description
`GenerateGroundedContentResponse.Candidate.Builder`

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
`output`	`CodedOutputStream`

Overrides

GeneratedMessage.writeTo(CodedOutputStream output)

Exceptions
Type	Description
`IOException`