public static final class GenerateGroundedContentResponse.Candidate.Builder extends GeneratedMessageV3.Builder<GenerateGroundedContentResponse.Candidate.Builder> implements GenerateGroundedContentResponse.CandidateOrBuilderA response candidate generated from the model.
Protobuf type
google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > GenerateGroundedContentResponse.Candidate.BuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public GenerateGroundedContentResponse.Candidate.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
GenerateGroundedContentResponse.Candidate.Builder |
|
build()
public GenerateGroundedContentResponse.Candidate build()| Returns | |
|---|---|
| Type | Description |
GenerateGroundedContentResponse.Candidate |
|
buildPartial()
public GenerateGroundedContentResponse.Candidate buildPartial()| Returns | |
|---|---|
| Type | Description |
GenerateGroundedContentResponse.Candidate |
|
clear()
public GenerateGroundedContentResponse.Candidate.Builder clear()| Returns | |
|---|---|
| Type | Description |
GenerateGroundedContentResponse.Candidate.Builder |
|
clearContent()
public GenerateGroundedContentResponse.Candidate.Builder clearContent()Content of the candidate.
.google.cloud.discoveryengine.v1.GroundedGenerationContent content = 2;
| Returns | |
|---|---|
| Type | Description |
GenerateGroundedContentResponse.Candidate.Builder |
|
clearField(Descriptors.FieldDescriptor field)
public GenerateGroundedContentResponse.Candidate.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
GenerateGroundedContentResponse.Candidate.Builder |
|
clearGroundingMetadata()
public GenerateGroundedContentResponse.Candidate.Builder clearGroundingMetadata()Grounding metadata for the generated content.
.google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata grounding_metadata = 4;
| Returns | |
|---|---|
| Type | Description |
GenerateGroundedContentResponse.Candidate.Builder |
|
clearGroundingScore()
public GenerateGroundedContentResponse.Candidate.Builder clearGroundingScore()The overall grounding score for the candidate, in the range of [0, 1].
optional float grounding_score = 3;
| Returns | |
|---|---|
| Type | Description |
GenerateGroundedContentResponse.Candidate.Builder |
This builder for chaining. |
clearIndex()
public GenerateGroundedContentResponse.Candidate.Builder clearIndex()Index of the candidate.
int32 index = 1;
| Returns | |
|---|---|
| Type | Description |
GenerateGroundedContentResponse.Candidate.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public GenerateGroundedContentResponse.Candidate.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
GenerateGroundedContentResponse.Candidate.Builder |
|
clone()
public GenerateGroundedContentResponse.Candidate.Builder clone()| Returns | |
|---|---|
| Type | Description |
GenerateGroundedContentResponse.Candidate.Builder |
|
getContent()
public GroundedGenerationContent getContent()Content of the candidate.
.google.cloud.discoveryengine.v1.GroundedGenerationContent content = 2;
| Returns | |
|---|---|
| Type | Description |
GroundedGenerationContent |
The content. |
getContentBuilder()
public GroundedGenerationContent.Builder getContentBuilder()Content of the candidate.
.google.cloud.discoveryengine.v1.GroundedGenerationContent content = 2;
| Returns | |
|---|---|
| Type | Description |
GroundedGenerationContent.Builder |
|
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 |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
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. |
getGroundingMetadataBuilder()
public GenerateGroundedContentResponse.Candidate.GroundingMetadata.Builder getGroundingMetadataBuilder()Grounding metadata for the generated content.
.google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata grounding_metadata = 4;
| Returns | |
|---|---|
| Type | Description |
GenerateGroundedContentResponse.Candidate.GroundingMetadata.Builder |
|
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. |
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. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeContent(GroundedGenerationContent value)
public GenerateGroundedContentResponse.Candidate.Builder mergeContent(GroundedGenerationContent value)Content of the candidate.
.google.cloud.discoveryengine.v1.GroundedGenerationContent content = 2;
| Parameter | |
|---|---|
| Name | Description |
value |
GroundedGenerationContent |
| Returns | |
|---|---|
| Type | Description |
GenerateGroundedContentResponse.Candidate.Builder |
|
mergeFrom(GenerateGroundedContentResponse.Candidate other)
public GenerateGroundedContentResponse.Candidate.Builder mergeFrom(GenerateGroundedContentResponse.Candidate other)| Parameter | |
|---|---|
| Name | Description |
other |
GenerateGroundedContentResponse.Candidate |
| Returns | |
|---|---|
| Type | Description |
GenerateGroundedContentResponse.Candidate.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public GenerateGroundedContentResponse.Candidate.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
GenerateGroundedContentResponse.Candidate.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public GenerateGroundedContentResponse.Candidate.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
GenerateGroundedContentResponse.Candidate.Builder |
|
mergeGroundingMetadata(GenerateGroundedContentResponse.Candidate.GroundingMetadata value)
public GenerateGroundedContentResponse.Candidate.Builder mergeGroundingMetadata(GenerateGroundedContentResponse.Candidate.GroundingMetadata value)Grounding metadata for the generated content.
.google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata grounding_metadata = 4;
| Parameter | |
|---|---|
| Name | Description |
value |
GenerateGroundedContentResponse.Candidate.GroundingMetadata |
| Returns | |
|---|---|
| Type | Description |
GenerateGroundedContentResponse.Candidate.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final GenerateGroundedContentResponse.Candidate.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
GenerateGroundedContentResponse.Candidate.Builder |
|
setContent(GroundedGenerationContent value)
public GenerateGroundedContentResponse.Candidate.Builder setContent(GroundedGenerationContent value)Content of the candidate.
.google.cloud.discoveryengine.v1.GroundedGenerationContent content = 2;
| Parameter | |
|---|---|
| Name | Description |
value |
GroundedGenerationContent |
| Returns | |
|---|---|
| Type | Description |
GenerateGroundedContentResponse.Candidate.Builder |
|
setContent(GroundedGenerationContent.Builder builderForValue)
public GenerateGroundedContentResponse.Candidate.Builder setContent(GroundedGenerationContent.Builder builderForValue)Content of the candidate.
.google.cloud.discoveryengine.v1.GroundedGenerationContent content = 2;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
GroundedGenerationContent.Builder |
| Returns | |
|---|---|
| Type | Description |
GenerateGroundedContentResponse.Candidate.Builder |
|
setField(Descriptors.FieldDescriptor field, Object value)
public GenerateGroundedContentResponse.Candidate.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
GenerateGroundedContentResponse.Candidate.Builder |
|
setGroundingMetadata(GenerateGroundedContentResponse.Candidate.GroundingMetadata value)
public GenerateGroundedContentResponse.Candidate.Builder setGroundingMetadata(GenerateGroundedContentResponse.Candidate.GroundingMetadata value)Grounding metadata for the generated content.
.google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata grounding_metadata = 4;
| Parameter | |
|---|---|
| Name | Description |
value |
GenerateGroundedContentResponse.Candidate.GroundingMetadata |
| Returns | |
|---|---|
| Type | Description |
GenerateGroundedContentResponse.Candidate.Builder |
|
setGroundingMetadata(GenerateGroundedContentResponse.Candidate.GroundingMetadata.Builder builderForValue)
public GenerateGroundedContentResponse.Candidate.Builder setGroundingMetadata(GenerateGroundedContentResponse.Candidate.GroundingMetadata.Builder builderForValue)Grounding metadata for the generated content.
.google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata grounding_metadata = 4;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
GenerateGroundedContentResponse.Candidate.GroundingMetadata.Builder |
| Returns | |
|---|---|
| Type | Description |
GenerateGroundedContentResponse.Candidate.Builder |
|
setGroundingScore(float value)
public GenerateGroundedContentResponse.Candidate.Builder setGroundingScore(float value)The overall grounding score for the candidate, in the range of [0, 1].
optional float grounding_score = 3;
| Parameter | |
|---|---|
| Name | Description |
value |
floatThe groundingScore to set. |
| Returns | |
|---|---|
| Type | Description |
GenerateGroundedContentResponse.Candidate.Builder |
This builder for chaining. |
setIndex(int value)
public GenerateGroundedContentResponse.Candidate.Builder setIndex(int value)Index of the candidate.
int32 index = 1;
| Parameter | |
|---|---|
| Name | Description |
value |
intThe index to set. |
| Returns | |
|---|---|
| Type | Description |
GenerateGroundedContentResponse.Candidate.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public GenerateGroundedContentResponse.Candidate.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
GenerateGroundedContentResponse.Candidate.Builder |
|
setUnknownFields(UnknownFieldSet unknownFields)
public final GenerateGroundedContentResponse.Candidate.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
GenerateGroundedContentResponse.Candidate.Builder |
|