- 0.72.0 (latest)
- 0.71.0
- 0.70.0
- 0.69.0
- 0.68.0
- 0.66.0
- 0.64.0
- 0.63.0
- 0.60.0
- 0.59.0
- 0.58.0
- 0.56.0
- 0.55.0
- 0.54.0
- 0.53.0
- 0.52.0
- 0.51.0
- 0.50.0
- 0.49.0
- 0.48.0
- 0.47.0
- 0.45.0
- 0.44.0
- 0.43.0
- 0.42.0
- 0.41.0
- 0.40.0
- 0.39.0
- 0.38.0
- 0.37.0
- 0.36.0
- 0.35.0
- 0.33.0
- 0.32.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.26.0
- 0.25.0
- 0.24.0
- 0.23.0
- 0.20.0
- 0.19.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
- 0.14.0
- 0.13.0
- 0.12.0
- 0.11.0
- 0.10.0
- 0.9.0
- 0.8.0
- 0.7.0
- 0.5.0
- 0.4.0
- 0.3.0
- 0.2.0
- 0.1.0
public static final class Answer.Builder extends GeneratedMessageV3.Builder<Answer.Builder> implements AnswerOrBuilderDefines an answer.
Protobuf type google.cloud.discoveryengine.v1.Answer
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Answer.BuilderImplements
AnswerOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addAllAnswerSkippedReasons(Iterable<? extends Answer.AnswerSkippedReason> values)
public Answer.Builder addAllAnswerSkippedReasons(Iterable<? extends Answer.AnswerSkippedReason> values)Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.
repeated .google.cloud.discoveryengine.v1.Answer.AnswerSkippedReason answer_skipped_reasons = 11;
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<? extends com.google.cloud.discoveryengine.v1.Answer.AnswerSkippedReason>The answerSkippedReasons to add. |
| Returns | |
|---|---|
| Type | Description |
Answer.Builder |
This builder for chaining. |
addAllAnswerSkippedReasonsValue(Iterable<Integer> values)
public Answer.Builder addAllAnswerSkippedReasonsValue(Iterable<Integer> values)Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.
repeated .google.cloud.discoveryengine.v1.Answer.AnswerSkippedReason answer_skipped_reasons = 11;
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<Integer>The enum numeric values on the wire for answerSkippedReasons to add. |
| Returns | |
|---|---|
| Type | Description |
Answer.Builder |
This builder for chaining. |
addAllCitations(Iterable<? extends Answer.Citation> values)
public Answer.Builder addAllCitations(Iterable<? extends Answer.Citation> values)Citations.
repeated .google.cloud.discoveryengine.v1.Answer.Citation citations = 4;
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<? extends com.google.cloud.discoveryengine.v1.Answer.Citation> |
| Returns | |
|---|---|
| Type | Description |
Answer.Builder |
|
addAllGroundingSupports(Iterable<? extends Answer.GroundingSupport> values)
public Answer.Builder addAllGroundingSupports(Iterable<? extends Answer.GroundingSupport> values)Optional. Grounding supports.
repeated .google.cloud.discoveryengine.v1.Answer.GroundingSupport grounding_supports = 13 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<? extends com.google.cloud.discoveryengine.v1.Answer.GroundingSupport> |
| Returns | |
|---|---|
| Type | Description |
Answer.Builder |
|
addAllReferences(Iterable<? extends Answer.Reference> values)
public Answer.Builder addAllReferences(Iterable<? extends Answer.Reference> values)References.
repeated .google.cloud.discoveryengine.v1.Answer.Reference references = 5;
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<? extends com.google.cloud.discoveryengine.v1.Answer.Reference> |
| Returns | |
|---|---|
| Type | Description |
Answer.Builder |
|
addAllRelatedQuestions(Iterable<String> values)
public Answer.Builder addAllRelatedQuestions(Iterable<String> values)Suggested related questions.
repeated string related_questions = 6;
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<String>The relatedQuestions to add. |
| Returns | |
|---|---|
| Type | Description |
Answer.Builder |
This builder for chaining. |
addAllSafetyRatings(Iterable<? extends SafetyRating> values)
public Answer.Builder addAllSafetyRatings(Iterable<? extends SafetyRating> values)Optional. Safety ratings.
repeated .google.cloud.discoveryengine.v1.SafetyRating safety_ratings = 14 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<? extends com.google.cloud.discoveryengine.v1.SafetyRating> |
| Returns | |
|---|---|
| Type | Description |
Answer.Builder |
|
addAllSteps(Iterable<? extends Answer.Step> values)
public Answer.Builder addAllSteps(Iterable<? extends Answer.Step> values)Answer generation steps.
repeated .google.cloud.discoveryengine.v1.Answer.Step steps = 7;
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<? extends com.google.cloud.discoveryengine.v1.Answer.Step> |
| Returns | |
|---|---|
| Type | Description |
Answer.Builder |
|
addAnswerSkippedReasons(Answer.AnswerSkippedReason value)
public Answer.Builder addAnswerSkippedReasons(Answer.AnswerSkippedReason value)Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.
repeated .google.cloud.discoveryengine.v1.Answer.AnswerSkippedReason answer_skipped_reasons = 11;
| Parameter | |
|---|---|
| Name | Description |
value |
Answer.AnswerSkippedReasonThe answerSkippedReasons to add. |
| Returns | |
|---|---|
| Type | Description |
Answer.Builder |
This builder for chaining. |
addAnswerSkippedReasonsValue(int value)
public Answer.Builder addAnswerSkippedReasonsValue(int value)Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.
repeated .google.cloud.discoveryengine.v1.Answer.AnswerSkippedReason answer_skipped_reasons = 11;
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for answerSkippedReasons to add. |
| Returns | |
|---|---|
| Type | Description |
Answer.Builder |
This builder for chaining. |
addCitations(Answer.Citation value)
public Answer.Builder addCitations(Answer.Citation value)Citations.
repeated .google.cloud.discoveryengine.v1.Answer.Citation citations = 4;
| Parameter | |
|---|---|
| Name | Description |
value |
Answer.Citation |
| Returns | |
|---|---|
| Type | Description |
Answer.Builder |
|
addCitations(Answer.Citation.Builder builderForValue)
public Answer.Builder addCitations(Answer.Citation.Builder builderForValue)Citations.
repeated .google.cloud.discoveryengine.v1.Answer.Citation citations = 4;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Answer.Citation.Builder |
| Returns | |
|---|---|
| Type | Description |
Answer.Builder |
|
addCitations(int index, Answer.Citation value)
public Answer.Builder addCitations(int index, Answer.Citation value)Citations.
repeated .google.cloud.discoveryengine.v1.Answer.Citation citations = 4;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
Answer.Citation |
| Returns | |
|---|---|
| Type | Description |
Answer.Builder |
|
addCitations(int index, Answer.Citation.Builder builderForValue)
public Answer.Builder addCitations(int index, Answer.Citation.Builder builderForValue)Citations.
repeated .google.cloud.discoveryengine.v1.Answer.Citation citations = 4;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
Answer.Citation.Builder |
| Returns | |
|---|---|
| Type | Description |
Answer.Builder |
|
addCitationsBuilder()
public Answer.Citation.Builder addCitationsBuilder()Citations.
repeated .google.cloud.discoveryengine.v1.Answer.Citation citations = 4;
| Returns | |
|---|---|
| Type | Description |
Answer.Citation.Builder |
|
addCitationsBuilder(int index)
public Answer.Citation.Builder addCitationsBuilder(int index)Citations.
repeated .google.cloud.discoveryengine.v1.Answer.Citation citations = 4;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
Answer.Citation.Builder |
|
addGroundingSupports(Answer.GroundingSupport value)
public Answer.Builder addGroundingSupports(Answer.GroundingSupport value)Optional. Grounding supports.
repeated .google.cloud.discoveryengine.v1.Answer.GroundingSupport grounding_supports = 13 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
Answer.GroundingSupport |
| Returns | |
|---|---|
| Type | Description |
Answer.Builder |
|
addGroundingSupports(Answer.GroundingSupport.Builder builderForValue)
public Answer.Builder addGroundingSupports(Answer.GroundingSupport.Builder builderForValue)Optional. Grounding supports.
repeated .google.cloud.discoveryengine.v1.Answer.GroundingSupport grounding_supports = 13 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Answer.GroundingSupport.Builder |
| Returns | |
|---|---|
| Type | Description |
Answer.Builder |
|
addGroundingSupports(int index, Answer.GroundingSupport value)
public Answer.Builder addGroundingSupports(int index, Answer.GroundingSupport value)Optional. Grounding supports.
repeated .google.cloud.discoveryengine.v1.Answer.GroundingSupport grounding_supports = 13 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
Answer.GroundingSupport |
| Returns | |
|---|---|
| Type | Description |
Answer.Builder |
|
addGroundingSupports(int index, Answer.GroundingSupport.Builder builderForValue)
public Answer.Builder addGroundingSupports(int index, Answer.GroundingSupport.Builder builderForValue)Optional. Grounding supports.
repeated .google.cloud.discoveryengine.v1.Answer.GroundingSupport grounding_supports = 13 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
Answer.GroundingSupport.Builder |
| Returns | |
|---|---|
| Type | Description |
Answer.Builder |
|
addGroundingSupportsBuilder()
public Answer.GroundingSupport.Builder addGroundingSupportsBuilder()Optional. Grounding supports.
repeated .google.cloud.discoveryengine.v1.Answer.GroundingSupport grounding_supports = 13 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Answer.GroundingSupport.Builder |
|
addGroundingSupportsBuilder(int index)
public Answer.GroundingSupport.Builder addGroundingSupportsBuilder(int index)Optional. Grounding supports.
repeated .google.cloud.discoveryengine.v1.Answer.GroundingSupport grounding_supports = 13 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
Answer.GroundingSupport.Builder |
|
addReferences(Answer.Reference value)
public Answer.Builder addReferences(Answer.Reference value)References.
repeated .google.cloud.discoveryengine.v1.Answer.Reference references = 5;
| Parameter | |
|---|---|
| Name | Description |
value |
Answer.Reference |
| Returns | |
|---|---|
| Type | Description |
Answer.Builder |
|
addReferences(Answer.Reference.Builder builderForValue)
public Answer.Builder addReferences(Answer.Reference.Builder builderForValue)References.
repeated .google.cloud.discoveryengine.v1.Answer.Reference references = 5;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Answer.Reference.Builder |
| Returns | |
|---|---|
| Type | Description |
Answer.Builder |
|
addReferences(int index, Answer.Reference value)
public Answer.Builder addReferences(int index, Answer.Reference value)References.
repeated .google.cloud.discoveryengine.v1.Answer.Reference references = 5;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
Answer.Reference |
| Returns | |
|---|---|
| Type | Description |
Answer.Builder |
|
addReferences(int index, Answer.Reference.Builder builderForValue)
public Answer.Builder addReferences(int index, Answer.Reference.Builder builderForValue)References.
repeated .google.cloud.discoveryengine.v1.Answer.Reference references = 5;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
Answer.Reference.Builder |
| Returns | |
|---|---|
| Type | Description |
Answer.Builder |
|
addReferencesBuilder()
public Answer.Reference.Builder addReferencesBuilder()References.
repeated .google.cloud.discoveryengine.v1.Answer.Reference references = 5;
| Returns | |
|---|---|
| Type | Description |
Answer.Reference.Builder |
|
addReferencesBuilder(int index)
public Answer.Reference.Builder addReferencesBuilder(int index)References.
repeated .google.cloud.discoveryengine.v1.Answer.Reference references = 5;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
Answer.Reference.Builder |
|
addRelatedQuestions(String value)
public Answer.Builder addRelatedQuestions(String value)Suggested related questions.
repeated string related_questions = 6;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe relatedQuestions to add. |
| Returns | |
|---|---|
| Type | Description |
Answer.Builder |
This builder for chaining. |
addRelatedQuestionsBytes(ByteString value)
public Answer.Builder addRelatedQuestionsBytes(ByteString value)Suggested related questions.
repeated string related_questions = 6;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes of the relatedQuestions to add. |
| Returns | |
|---|---|
| Type | Description |
Answer.Builder |
This builder for chaining. |
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public Answer.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
Answer.Builder |
|
addSafetyRatings(SafetyRating value)
public Answer.Builder addSafetyRatings(SafetyRating value)Optional. Safety ratings.
repeated .google.cloud.discoveryengine.v1.SafetyRating safety_ratings = 14 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
SafetyRating |
| Returns | |
|---|---|
| Type | Description |
Answer.Builder |
|
addSafetyRatings(SafetyRating.Builder builderForValue)
public Answer.Builder addSafetyRatings(SafetyRating.Builder builderForValue)Optional. Safety ratings.
repeated .google.cloud.discoveryengine.v1.SafetyRating safety_ratings = 14 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
SafetyRating.Builder |
| Returns | |
|---|---|
| Type | Description |
Answer.Builder |
|
addSafetyRatings(int index, SafetyRating value)
public Answer.Builder addSafetyRatings(int index, SafetyRating value)Optional. Safety ratings.
repeated .google.cloud.discoveryengine.v1.SafetyRating safety_ratings = 14 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
SafetyRating |
| Returns | |
|---|---|
| Type | Description |
Answer.Builder |
|
addSafetyRatings(int index, SafetyRating.Builder builderForValue)
public Answer.Builder addSafetyRatings(int index, SafetyRating.Builder builderForValue)Optional. Safety ratings.
repeated .google.cloud.discoveryengine.v1.SafetyRating safety_ratings = 14 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
SafetyRating.Builder |
| Returns | |
|---|---|
| Type | Description |
Answer.Builder |
|
addSafetyRatingsBuilder()
public SafetyRating.Builder addSafetyRatingsBuilder()Optional. Safety ratings.
repeated .google.cloud.discoveryengine.v1.SafetyRating safety_ratings = 14 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
SafetyRating.Builder |
|
addSafetyRatingsBuilder(int index)
public SafetyRating.Builder addSafetyRatingsBuilder(int index)Optional. Safety ratings.
repeated .google.cloud.discoveryengine.v1.SafetyRating safety_ratings = 14 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
SafetyRating.Builder |
|
addSteps(Answer.Step value)
public Answer.Builder addSteps(Answer.Step value)Answer generation steps.
repeated .google.cloud.discoveryengine.v1.Answer.Step steps = 7;
| Parameter | |
|---|---|
| Name | Description |
value |
Answer.Step |
| Returns | |
|---|---|
| Type | Description |
Answer.Builder |
|
addSteps(Answer.Step.Builder builderForValue)
public Answer.Builder addSteps(Answer.Step.Builder builderForValue)Answer generation steps.
repeated .google.cloud.discoveryengine.v1.Answer.Step steps = 7;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Answer.Step.Builder |
| Returns | |
|---|---|
| Type | Description |
Answer.Builder |
|
addSteps(int index, Answer.Step value)
public Answer.Builder addSteps(int index, Answer.Step value)Answer generation steps.
repeated .google.cloud.discoveryengine.v1.Answer.Step steps = 7;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
Answer.Step |
| Returns | |
|---|---|
| Type | Description |
Answer.Builder |
|
addSteps(int index, Answer.Step.Builder builderForValue)
public Answer.Builder addSteps(int index, Answer.Step.Builder builderForValue)Answer generation steps.
repeated .google.cloud.discoveryengine.v1.Answer.Step steps = 7;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
Answer.Step.Builder |
| Returns | |
|---|---|
| Type | Description |
Answer.Builder |
|
addStepsBuilder()
public Answer.Step.Builder addStepsBuilder()Answer generation steps.
repeated .google.cloud.discoveryengine.v1.Answer.Step steps = 7;
| Returns | |
|---|---|
| Type | Description |
Answer.Step.Builder |
|
addStepsBuilder(int index)
public Answer.Step.Builder addStepsBuilder(int index)Answer generation steps.
repeated .google.cloud.discoveryengine.v1.Answer.Step steps = 7;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
Answer.Step.Builder |
|
build()
public Answer build()| Returns | |
|---|---|
| Type | Description |
Answer |
|
buildPartial()
public Answer buildPartial()| Returns | |
|---|---|
| Type | Description |
Answer |
|
clear()
public Answer.Builder clear()| Returns | |
|---|---|
| Type | Description |
Answer.Builder |
|
clearAnswerSkippedReasons()
public Answer.Builder clearAnswerSkippedReasons()Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.
repeated .google.cloud.discoveryengine.v1.Answer.AnswerSkippedReason answer_skipped_reasons = 11;
| Returns | |
|---|---|
| Type | Description |
Answer.Builder |
This builder for chaining. |
clearAnswerText()
public Answer.Builder clearAnswerText()The textual answer.
string answer_text = 3;
| Returns | |
|---|---|
| Type | Description |
Answer.Builder |
This builder for chaining. |
clearCitations()
public Answer.Builder clearCitations()Citations.
repeated .google.cloud.discoveryengine.v1.Answer.Citation citations = 4;
| Returns | |
|---|---|
| Type | Description |
Answer.Builder |
|
clearCompleteTime()
public Answer.Builder clearCompleteTime()Output only. Answer completed timestamp.
.google.protobuf.Timestamp complete_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Answer.Builder |
|
clearCreateTime()
public Answer.Builder clearCreateTime()Output only. Answer creation timestamp.
.google.protobuf.Timestamp create_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Answer.Builder |
|
clearField(Descriptors.FieldDescriptor field)
public Answer.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
Answer.Builder |
|
clearGroundingScore()
public Answer.Builder clearGroundingScore()A score in the range of [0, 1] describing how grounded the answer is by the reference chunks.
optional double grounding_score = 12;
| Returns | |
|---|---|
| Type | Description |
Answer.Builder |
This builder for chaining. |
clearGroundingSupports()
public Answer.Builder clearGroundingSupports()Optional. Grounding supports.
repeated .google.cloud.discoveryengine.v1.Answer.GroundingSupport grounding_supports = 13 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Answer.Builder |
|
clearName()
public Answer.Builder clearName() Immutable. Fully qualified name
projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*/answers/*
string name = 1 [(.google.api.field_behavior) = IMMUTABLE];
| Returns | |
|---|---|
| Type | Description |
Answer.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public Answer.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
Answer.Builder |
|
clearQueryUnderstandingInfo()
public Answer.Builder clearQueryUnderstandingInfo()Query understanding information.
.google.cloud.discoveryengine.v1.Answer.QueryUnderstandingInfo query_understanding_info = 10;
| Returns | |
|---|---|
| Type | Description |
Answer.Builder |
|
clearReferences()
public Answer.Builder clearReferences()References.
repeated .google.cloud.discoveryengine.v1.Answer.Reference references = 5;
| Returns | |
|---|---|
| Type | Description |
Answer.Builder |
|
clearRelatedQuestions()
public Answer.Builder clearRelatedQuestions()Suggested related questions.
repeated string related_questions = 6;
| Returns | |
|---|---|
| Type | Description |
Answer.Builder |
This builder for chaining. |
clearSafetyRatings()
public Answer.Builder clearSafetyRatings()Optional. Safety ratings.
repeated .google.cloud.discoveryengine.v1.SafetyRating safety_ratings = 14 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Answer.Builder |
|
clearState()
public Answer.Builder clearState()The state of the answer generation.
.google.cloud.discoveryengine.v1.Answer.State state = 2;
| Returns | |
|---|---|
| Type | Description |
Answer.Builder |
This builder for chaining. |
clearSteps()
public Answer.Builder clearSteps()Answer generation steps.
repeated .google.cloud.discoveryengine.v1.Answer.Step steps = 7;
| Returns | |
|---|---|
| Type | Description |
Answer.Builder |
|
clone()
public Answer.Builder clone()| Returns | |
|---|---|
| Type | Description |
Answer.Builder |
|
getAnswerSkippedReasons(int index)
public Answer.AnswerSkippedReason getAnswerSkippedReasons(int index)Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.
repeated .google.cloud.discoveryengine.v1.Answer.AnswerSkippedReason answer_skipped_reasons = 11;
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
Answer.AnswerSkippedReason |
The answerSkippedReasons at the given index. |
getAnswerSkippedReasonsCount()
public int getAnswerSkippedReasonsCount()Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.
repeated .google.cloud.discoveryengine.v1.Answer.AnswerSkippedReason answer_skipped_reasons = 11;
| Returns | |
|---|---|
| Type | Description |
int |
The count of answerSkippedReasons. |
getAnswerSkippedReasonsList()
public List<Answer.AnswerSkippedReason> getAnswerSkippedReasonsList()Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.
repeated .google.cloud.discoveryengine.v1.Answer.AnswerSkippedReason answer_skipped_reasons = 11;
| Returns | |
|---|---|
| Type | Description |
List<AnswerSkippedReason> |
A list containing the answerSkippedReasons. |
getAnswerSkippedReasonsValue(int index)
public int getAnswerSkippedReasonsValue(int index)Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.
repeated .google.cloud.discoveryengine.v1.Answer.AnswerSkippedReason answer_skipped_reasons = 11;
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire of answerSkippedReasons at the given index. |
getAnswerSkippedReasonsValueList()
public List<Integer> getAnswerSkippedReasonsValueList()Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.
repeated .google.cloud.discoveryengine.v1.Answer.AnswerSkippedReason answer_skipped_reasons = 11;
| Returns | |
|---|---|
| Type | Description |
List<Integer> |
A list containing the enum numeric values on the wire for answerSkippedReasons. |
getAnswerText()
public String getAnswerText()The textual answer.
string answer_text = 3;
| Returns | |
|---|---|
| Type | Description |
String |
The answerText. |
getAnswerTextBytes()
public ByteString getAnswerTextBytes()The textual answer.
string answer_text = 3;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for answerText. |
getCitations(int index)
public Answer.Citation getCitations(int index)Citations.
repeated .google.cloud.discoveryengine.v1.Answer.Citation citations = 4;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
Answer.Citation |
|
getCitationsBuilder(int index)
public Answer.Citation.Builder getCitationsBuilder(int index)Citations.
repeated .google.cloud.discoveryengine.v1.Answer.Citation citations = 4;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
Answer.Citation.Builder |
|
getCitationsBuilderList()
public List<Answer.Citation.Builder> getCitationsBuilderList()Citations.
repeated .google.cloud.discoveryengine.v1.Answer.Citation citations = 4;
| Returns | |
|---|---|
| Type | Description |
List<Builder> |
|
getCitationsCount()
public int getCitationsCount()Citations.
repeated .google.cloud.discoveryengine.v1.Answer.Citation citations = 4;
| Returns | |
|---|---|
| Type | Description |
int |
|
getCitationsList()
public List<Answer.Citation> getCitationsList()Citations.
repeated .google.cloud.discoveryengine.v1.Answer.Citation citations = 4;
| Returns | |
|---|---|
| Type | Description |
List<Citation> |
|
getCitationsOrBuilder(int index)
public Answer.CitationOrBuilder getCitationsOrBuilder(int index)Citations.
repeated .google.cloud.discoveryengine.v1.Answer.Citation citations = 4;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
Answer.CitationOrBuilder |
|
getCitationsOrBuilderList()
public List<? extends Answer.CitationOrBuilder> getCitationsOrBuilderList()Citations.
repeated .google.cloud.discoveryengine.v1.Answer.Citation citations = 4;
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.cloud.discoveryengine.v1.Answer.CitationOrBuilder> |
|
getCompleteTime()
public Timestamp getCompleteTime()Output only. Answer completed timestamp.
.google.protobuf.Timestamp complete_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Timestamp |
The completeTime. |
getCompleteTimeBuilder()
public Timestamp.Builder getCompleteTimeBuilder()Output only. Answer completed timestamp.
.google.protobuf.Timestamp complete_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Builder |
|
getCompleteTimeOrBuilder()
public TimestampOrBuilder getCompleteTimeOrBuilder()Output only. Answer completed timestamp.
.google.protobuf.Timestamp complete_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
getCreateTime()
public Timestamp getCreateTime()Output only. Answer creation timestamp.
.google.protobuf.Timestamp create_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Timestamp |
The createTime. |
getCreateTimeBuilder()
public Timestamp.Builder getCreateTimeBuilder()Output only. Answer creation timestamp.
.google.protobuf.Timestamp create_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Builder |
|
getCreateTimeOrBuilder()
public TimestampOrBuilder getCreateTimeOrBuilder()Output only. Answer creation timestamp.
.google.protobuf.Timestamp create_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
getDefaultInstanceForType()
public Answer getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
Answer |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getGroundingScore()
public double getGroundingScore()A score in the range of [0, 1] describing how grounded the answer is by the reference chunks.
optional double grounding_score = 12;
| Returns | |
|---|---|
| Type | Description |
double |
The groundingScore. |
getGroundingSupports(int index)
public Answer.GroundingSupport getGroundingSupports(int index)Optional. Grounding supports.
repeated .google.cloud.discoveryengine.v1.Answer.GroundingSupport grounding_supports = 13 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
Answer.GroundingSupport |
|
getGroundingSupportsBuilder(int index)
public Answer.GroundingSupport.Builder getGroundingSupportsBuilder(int index)Optional. Grounding supports.
repeated .google.cloud.discoveryengine.v1.Answer.GroundingSupport grounding_supports = 13 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
Answer.GroundingSupport.Builder |
|
getGroundingSupportsBuilderList()
public List<Answer.GroundingSupport.Builder> getGroundingSupportsBuilderList()Optional. Grounding supports.
repeated .google.cloud.discoveryengine.v1.Answer.GroundingSupport grounding_supports = 13 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
List<Builder> |
|
getGroundingSupportsCount()
public int getGroundingSupportsCount()Optional. Grounding supports.
repeated .google.cloud.discoveryengine.v1.Answer.GroundingSupport grounding_supports = 13 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
|
getGroundingSupportsList()
public List<Answer.GroundingSupport> getGroundingSupportsList()Optional. Grounding supports.
repeated .google.cloud.discoveryengine.v1.Answer.GroundingSupport grounding_supports = 13 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
List<GroundingSupport> |
|
getGroundingSupportsOrBuilder(int index)
public Answer.GroundingSupportOrBuilder getGroundingSupportsOrBuilder(int index)Optional. Grounding supports.
repeated .google.cloud.discoveryengine.v1.Answer.GroundingSupport grounding_supports = 13 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
Answer.GroundingSupportOrBuilder |
|
getGroundingSupportsOrBuilderList()
public List<? extends Answer.GroundingSupportOrBuilder> getGroundingSupportsOrBuilderList()Optional. Grounding supports.
repeated .google.cloud.discoveryengine.v1.Answer.GroundingSupport grounding_supports = 13 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.cloud.discoveryengine.v1.Answer.GroundingSupportOrBuilder> |
|
getName()
public String getName() Immutable. Fully qualified name
projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*/answers/*
string name = 1 [(.google.api.field_behavior) = IMMUTABLE];
| Returns | |
|---|---|
| Type | Description |
String |
The name. |
getNameBytes()
public ByteString getNameBytes() Immutable. Fully qualified name
projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*/answers/*
string name = 1 [(.google.api.field_behavior) = IMMUTABLE];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for name. |
getQueryUnderstandingInfo()
public Answer.QueryUnderstandingInfo getQueryUnderstandingInfo()Query understanding information.
.google.cloud.discoveryengine.v1.Answer.QueryUnderstandingInfo query_understanding_info = 10;
| Returns | |
|---|---|
| Type | Description |
Answer.QueryUnderstandingInfo |
The queryUnderstandingInfo. |
getQueryUnderstandingInfoBuilder()
public Answer.QueryUnderstandingInfo.Builder getQueryUnderstandingInfoBuilder()Query understanding information.
.google.cloud.discoveryengine.v1.Answer.QueryUnderstandingInfo query_understanding_info = 10;
| Returns | |
|---|---|
| Type | Description |
Answer.QueryUnderstandingInfo.Builder |
|
getQueryUnderstandingInfoOrBuilder()
public Answer.QueryUnderstandingInfoOrBuilder getQueryUnderstandingInfoOrBuilder()Query understanding information.
.google.cloud.discoveryengine.v1.Answer.QueryUnderstandingInfo query_understanding_info = 10;
| Returns | |
|---|---|
| Type | Description |
Answer.QueryUnderstandingInfoOrBuilder |
|
getReferences(int index)
public Answer.Reference getReferences(int index)References.
repeated .google.cloud.discoveryengine.v1.Answer.Reference references = 5;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
Answer.Reference |
|
getReferencesBuilder(int index)
public Answer.Reference.Builder getReferencesBuilder(int index)References.
repeated .google.cloud.discoveryengine.v1.Answer.Reference references = 5;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
Answer.Reference.Builder |
|
getReferencesBuilderList()
public List<Answer.Reference.Builder> getReferencesBuilderList()References.
repeated .google.cloud.discoveryengine.v1.Answer.Reference references = 5;
| Returns | |
|---|---|
| Type | Description |
List<Builder> |
|
getReferencesCount()
public int getReferencesCount()References.
repeated .google.cloud.discoveryengine.v1.Answer.Reference references = 5;
| Returns | |
|---|---|
| Type | Description |
int |
|
getReferencesList()
public List<Answer.Reference> getReferencesList()References.
repeated .google.cloud.discoveryengine.v1.Answer.Reference references = 5;
| Returns | |
|---|---|
| Type | Description |
List<Reference> |
|
getReferencesOrBuilder(int index)
public Answer.ReferenceOrBuilder getReferencesOrBuilder(int index)References.
repeated .google.cloud.discoveryengine.v1.Answer.Reference references = 5;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
Answer.ReferenceOrBuilder |
|
getReferencesOrBuilderList()
public List<? extends Answer.ReferenceOrBuilder> getReferencesOrBuilderList()References.
repeated .google.cloud.discoveryengine.v1.Answer.Reference references = 5;
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.cloud.discoveryengine.v1.Answer.ReferenceOrBuilder> |
|
getRelatedQuestions(int index)
public String getRelatedQuestions(int index)Suggested related questions.
repeated string related_questions = 6;
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
String |
The relatedQuestions at the given index. |
getRelatedQuestionsBytes(int index)
public ByteString getRelatedQuestionsBytes(int index)Suggested related questions.
repeated string related_questions = 6;
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes of the relatedQuestions at the given index. |
getRelatedQuestionsCount()
public int getRelatedQuestionsCount()Suggested related questions.
repeated string related_questions = 6;
| Returns | |
|---|---|
| Type | Description |
int |
The count of relatedQuestions. |
getRelatedQuestionsList()
public ProtocolStringList getRelatedQuestionsList()Suggested related questions.
repeated string related_questions = 6;
| Returns | |
|---|---|
| Type | Description |
ProtocolStringList |
A list containing the relatedQuestions. |
getSafetyRatings(int index)
public SafetyRating getSafetyRatings(int index)Optional. Safety ratings.
repeated .google.cloud.discoveryengine.v1.SafetyRating safety_ratings = 14 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
SafetyRating |
|
getSafetyRatingsBuilder(int index)
public SafetyRating.Builder getSafetyRatingsBuilder(int index)Optional. Safety ratings.
repeated .google.cloud.discoveryengine.v1.SafetyRating safety_ratings = 14 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
SafetyRating.Builder |
|
getSafetyRatingsBuilderList()
public List<SafetyRating.Builder> getSafetyRatingsBuilderList()Optional. Safety ratings.
repeated .google.cloud.discoveryengine.v1.SafetyRating safety_ratings = 14 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
List<Builder> |
|
getSafetyRatingsCount()
public int getSafetyRatingsCount()Optional. Safety ratings.
repeated .google.cloud.discoveryengine.v1.SafetyRating safety_ratings = 14 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
|
getSafetyRatingsList()
public List<SafetyRating> getSafetyRatingsList()Optional. Safety ratings.
repeated .google.cloud.discoveryengine.v1.SafetyRating safety_ratings = 14 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
List<SafetyRating> |
|
getSafetyRatingsOrBuilder(int index)
public SafetyRatingOrBuilder getSafetyRatingsOrBuilder(int index)Optional. Safety ratings.
repeated .google.cloud.discoveryengine.v1.SafetyRating safety_ratings = 14 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
SafetyRatingOrBuilder |
|
getSafetyRatingsOrBuilderList()
public List<? extends SafetyRatingOrBuilder> getSafetyRatingsOrBuilderList()Optional. Safety ratings.
repeated .google.cloud.discoveryengine.v1.SafetyRating safety_ratings = 14 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.cloud.discoveryengine.v1.SafetyRatingOrBuilder> |
|
getState()
public Answer.State getState()The state of the answer generation.
.google.cloud.discoveryengine.v1.Answer.State state = 2;
| Returns | |
|---|---|
| Type | Description |
Answer.State |
The state. |
getStateValue()
public int getStateValue()The state of the answer generation.
.google.cloud.discoveryengine.v1.Answer.State state = 2;
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for state. |
getSteps(int index)
public Answer.Step getSteps(int index)Answer generation steps.
repeated .google.cloud.discoveryengine.v1.Answer.Step steps = 7;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
Answer.Step |
|
getStepsBuilder(int index)
public Answer.Step.Builder getStepsBuilder(int index)Answer generation steps.
repeated .google.cloud.discoveryengine.v1.Answer.Step steps = 7;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
Answer.Step.Builder |
|
getStepsBuilderList()
public List<Answer.Step.Builder> getStepsBuilderList()Answer generation steps.
repeated .google.cloud.discoveryengine.v1.Answer.Step steps = 7;
| Returns | |
|---|---|
| Type | Description |
List<Builder> |
|
getStepsCount()
public int getStepsCount()Answer generation steps.
repeated .google.cloud.discoveryengine.v1.Answer.Step steps = 7;
| Returns | |
|---|---|
| Type | Description |
int |
|
getStepsList()
public List<Answer.Step> getStepsList()Answer generation steps.
repeated .google.cloud.discoveryengine.v1.Answer.Step steps = 7;
| Returns | |
|---|---|
| Type | Description |
List<Step> |
|
getStepsOrBuilder(int index)
public Answer.StepOrBuilder getStepsOrBuilder(int index)Answer generation steps.
repeated .google.cloud.discoveryengine.v1.Answer.Step steps = 7;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
Answer.StepOrBuilder |
|
getStepsOrBuilderList()
public List<? extends Answer.StepOrBuilder> getStepsOrBuilderList()Answer generation steps.
repeated .google.cloud.discoveryengine.v1.Answer.Step steps = 7;
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.cloud.discoveryengine.v1.Answer.StepOrBuilder> |
|
hasCompleteTime()
public boolean hasCompleteTime()Output only. Answer completed timestamp.
.google.protobuf.Timestamp complete_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the completeTime field is set. |
hasCreateTime()
public boolean hasCreateTime()Output only. Answer creation timestamp.
.google.protobuf.Timestamp create_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the createTime field is set. |
hasGroundingScore()
public boolean hasGroundingScore()A score in the range of [0, 1] describing how grounded the answer is by the reference chunks.
optional double grounding_score = 12;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the groundingScore field is set. |
hasQueryUnderstandingInfo()
public boolean hasQueryUnderstandingInfo()Query understanding information.
.google.cloud.discoveryengine.v1.Answer.QueryUnderstandingInfo query_understanding_info = 10;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the queryUnderstandingInfo field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeCompleteTime(Timestamp value)
public Answer.Builder mergeCompleteTime(Timestamp value)Output only. Answer completed timestamp.
.google.protobuf.Timestamp complete_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
Answer.Builder |
|
mergeCreateTime(Timestamp value)
public Answer.Builder mergeCreateTime(Timestamp value)Output only. Answer creation timestamp.
.google.protobuf.Timestamp create_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
Answer.Builder |
|
mergeFrom(Answer other)
public Answer.Builder mergeFrom(Answer other)| Parameter | |
|---|---|
| Name | Description |
other |
Answer |
| Returns | |
|---|---|
| Type | Description |
Answer.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public Answer.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Answer.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public Answer.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
Answer.Builder |
|
mergeQueryUnderstandingInfo(Answer.QueryUnderstandingInfo value)
public Answer.Builder mergeQueryUnderstandingInfo(Answer.QueryUnderstandingInfo value)Query understanding information.
.google.cloud.discoveryengine.v1.Answer.QueryUnderstandingInfo query_understanding_info = 10;
| Parameter | |
|---|---|
| Name | Description |
value |
Answer.QueryUnderstandingInfo |
| Returns | |
|---|---|
| Type | Description |
Answer.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final Answer.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
Answer.Builder |
|
removeCitations(int index)
public Answer.Builder removeCitations(int index)Citations.
repeated .google.cloud.discoveryengine.v1.Answer.Citation citations = 4;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
Answer.Builder |
|
removeGroundingSupports(int index)
public Answer.Builder removeGroundingSupports(int index)Optional. Grounding supports.
repeated .google.cloud.discoveryengine.v1.Answer.GroundingSupport grounding_supports = 13 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
Answer.Builder |
|
removeReferences(int index)
public Answer.Builder removeReferences(int index)References.
repeated .google.cloud.discoveryengine.v1.Answer.Reference references = 5;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
Answer.Builder |
|
removeSafetyRatings(int index)
public Answer.Builder removeSafetyRatings(int index)Optional. Safety ratings.
repeated .google.cloud.discoveryengine.v1.SafetyRating safety_ratings = 14 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
Answer.Builder |
|
removeSteps(int index)
public Answer.Builder removeSteps(int index)Answer generation steps.
repeated .google.cloud.discoveryengine.v1.Answer.Step steps = 7;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
Answer.Builder |
|
setAnswerSkippedReasons(int index, Answer.AnswerSkippedReason value)
public Answer.Builder setAnswerSkippedReasons(int index, Answer.AnswerSkippedReason value)Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.
repeated .google.cloud.discoveryengine.v1.Answer.AnswerSkippedReason answer_skipped_reasons = 11;
| Parameters | |
|---|---|
| Name | Description |
index |
intThe index to set the value at. |
value |
Answer.AnswerSkippedReasonThe answerSkippedReasons to set. |
| Returns | |
|---|---|
| Type | Description |
Answer.Builder |
This builder for chaining. |
setAnswerSkippedReasonsValue(int index, int value)
public Answer.Builder setAnswerSkippedReasonsValue(int index, int value)Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.
repeated .google.cloud.discoveryengine.v1.Answer.AnswerSkippedReason answer_skipped_reasons = 11;
| Parameters | |
|---|---|
| Name | Description |
index |
intThe index to set the value at. |
value |
intThe enum numeric value on the wire for answerSkippedReasons to set. |
| Returns | |
|---|---|
| Type | Description |
Answer.Builder |
This builder for chaining. |
setAnswerText(String value)
public Answer.Builder setAnswerText(String value)The textual answer.
string answer_text = 3;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe answerText to set. |
| Returns | |
|---|---|
| Type | Description |
Answer.Builder |
This builder for chaining. |
setAnswerTextBytes(ByteString value)
public Answer.Builder setAnswerTextBytes(ByteString value)The textual answer.
string answer_text = 3;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for answerText to set. |
| Returns | |
|---|---|
| Type | Description |
Answer.Builder |
This builder for chaining. |
setCitations(int index, Answer.Citation value)
public Answer.Builder setCitations(int index, Answer.Citation value)Citations.
repeated .google.cloud.discoveryengine.v1.Answer.Citation citations = 4;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
Answer.Citation |
| Returns | |
|---|---|
| Type | Description |
Answer.Builder |
|
setCitations(int index, Answer.Citation.Builder builderForValue)
public Answer.Builder setCitations(int index, Answer.Citation.Builder builderForValue)Citations.
repeated .google.cloud.discoveryengine.v1.Answer.Citation citations = 4;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
Answer.Citation.Builder |
| Returns | |
|---|---|
| Type | Description |
Answer.Builder |
|
setCompleteTime(Timestamp value)
public Answer.Builder setCompleteTime(Timestamp value)Output only. Answer completed timestamp.
.google.protobuf.Timestamp complete_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
Answer.Builder |
|
setCompleteTime(Timestamp.Builder builderForValue)
public Answer.Builder setCompleteTime(Timestamp.Builder builderForValue)Output only. Answer completed timestamp.
.google.protobuf.Timestamp complete_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Builder |
| Returns | |
|---|---|
| Type | Description |
Answer.Builder |
|
setCreateTime(Timestamp value)
public Answer.Builder setCreateTime(Timestamp value)Output only. Answer creation timestamp.
.google.protobuf.Timestamp create_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
Answer.Builder |
|
setCreateTime(Timestamp.Builder builderForValue)
public Answer.Builder setCreateTime(Timestamp.Builder builderForValue)Output only. Answer creation timestamp.
.google.protobuf.Timestamp create_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Builder |
| Returns | |
|---|---|
| Type | Description |
Answer.Builder |
|
setField(Descriptors.FieldDescriptor field, Object value)
public Answer.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
Answer.Builder |
|
setGroundingScore(double value)
public Answer.Builder setGroundingScore(double value)A score in the range of [0, 1] describing how grounded the answer is by the reference chunks.
optional double grounding_score = 12;
| Parameter | |
|---|---|
| Name | Description |
value |
doubleThe groundingScore to set. |
| Returns | |
|---|---|
| Type | Description |
Answer.Builder |
This builder for chaining. |
setGroundingSupports(int index, Answer.GroundingSupport value)
public Answer.Builder setGroundingSupports(int index, Answer.GroundingSupport value)Optional. Grounding supports.
repeated .google.cloud.discoveryengine.v1.Answer.GroundingSupport grounding_supports = 13 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
Answer.GroundingSupport |
| Returns | |
|---|---|
| Type | Description |
Answer.Builder |
|
setGroundingSupports(int index, Answer.GroundingSupport.Builder builderForValue)
public Answer.Builder setGroundingSupports(int index, Answer.GroundingSupport.Builder builderForValue)Optional. Grounding supports.
repeated .google.cloud.discoveryengine.v1.Answer.GroundingSupport grounding_supports = 13 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
Answer.GroundingSupport.Builder |
| Returns | |
|---|---|
| Type | Description |
Answer.Builder |
|
setName(String value)
public Answer.Builder setName(String value) Immutable. Fully qualified name
projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*/answers/*
string name = 1 [(.google.api.field_behavior) = IMMUTABLE];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe name to set. |
| Returns | |
|---|---|
| Type | Description |
Answer.Builder |
This builder for chaining. |
setNameBytes(ByteString value)
public Answer.Builder setNameBytes(ByteString value) Immutable. Fully qualified name
projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*/answers/*
string name = 1 [(.google.api.field_behavior) = IMMUTABLE];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for name to set. |
| Returns | |
|---|---|
| Type | Description |
Answer.Builder |
This builder for chaining. |
setQueryUnderstandingInfo(Answer.QueryUnderstandingInfo value)
public Answer.Builder setQueryUnderstandingInfo(Answer.QueryUnderstandingInfo value)Query understanding information.
.google.cloud.discoveryengine.v1.Answer.QueryUnderstandingInfo query_understanding_info = 10;
| Parameter | |
|---|---|
| Name | Description |
value |
Answer.QueryUnderstandingInfo |
| Returns | |
|---|---|
| Type | Description |
Answer.Builder |
|
setQueryUnderstandingInfo(Answer.QueryUnderstandingInfo.Builder builderForValue)
public Answer.Builder setQueryUnderstandingInfo(Answer.QueryUnderstandingInfo.Builder builderForValue)Query understanding information.
.google.cloud.discoveryengine.v1.Answer.QueryUnderstandingInfo query_understanding_info = 10;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Answer.QueryUnderstandingInfo.Builder |
| Returns | |
|---|---|
| Type | Description |
Answer.Builder |
|
setReferences(int index, Answer.Reference value)
public Answer.Builder setReferences(int index, Answer.Reference value)References.
repeated .google.cloud.discoveryengine.v1.Answer.Reference references = 5;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
Answer.Reference |
| Returns | |
|---|---|
| Type | Description |
Answer.Builder |
|
setReferences(int index, Answer.Reference.Builder builderForValue)
public Answer.Builder setReferences(int index, Answer.Reference.Builder builderForValue)References.
repeated .google.cloud.discoveryengine.v1.Answer.Reference references = 5;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
Answer.Reference.Builder |
| Returns | |
|---|---|
| Type | Description |
Answer.Builder |
|
setRelatedQuestions(int index, String value)
public Answer.Builder setRelatedQuestions(int index, String value)Suggested related questions.
repeated string related_questions = 6;
| Parameters | |
|---|---|
| Name | Description |
index |
intThe index to set the value at. |
value |
StringThe relatedQuestions to set. |
| Returns | |
|---|---|
| Type | Description |
Answer.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public Answer.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
Answer.Builder |
|
setSafetyRatings(int index, SafetyRating value)
public Answer.Builder setSafetyRatings(int index, SafetyRating value)Optional. Safety ratings.
repeated .google.cloud.discoveryengine.v1.SafetyRating safety_ratings = 14 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
SafetyRating |
| Returns | |
|---|---|
| Type | Description |
Answer.Builder |
|
setSafetyRatings(int index, SafetyRating.Builder builderForValue)
public Answer.Builder setSafetyRatings(int index, SafetyRating.Builder builderForValue)Optional. Safety ratings.
repeated .google.cloud.discoveryengine.v1.SafetyRating safety_ratings = 14 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
SafetyRating.Builder |
| Returns | |
|---|---|
| Type | Description |
Answer.Builder |
|
setState(Answer.State value)
public Answer.Builder setState(Answer.State value)The state of the answer generation.
.google.cloud.discoveryengine.v1.Answer.State state = 2;
| Parameter | |
|---|---|
| Name | Description |
value |
Answer.StateThe state to set. |
| Returns | |
|---|---|
| Type | Description |
Answer.Builder |
This builder for chaining. |
setStateValue(int value)
public Answer.Builder setStateValue(int value)The state of the answer generation.
.google.cloud.discoveryengine.v1.Answer.State state = 2;
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for state to set. |
| Returns | |
|---|---|
| Type | Description |
Answer.Builder |
This builder for chaining. |
setSteps(int index, Answer.Step value)
public Answer.Builder setSteps(int index, Answer.Step value)Answer generation steps.
repeated .google.cloud.discoveryengine.v1.Answer.Step steps = 7;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
Answer.Step |
| Returns | |
|---|---|
| Type | Description |
Answer.Builder |
|
setSteps(int index, Answer.Step.Builder builderForValue)
public Answer.Builder setSteps(int index, Answer.Step.Builder builderForValue)Answer generation steps.
repeated .google.cloud.discoveryengine.v1.Answer.Step steps = 7;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
Answer.Step.Builder |
| Returns | |
|---|---|
| Type | Description |
Answer.Builder |
|
setUnknownFields(UnknownFieldSet unknownFields)
public final Answer.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
Answer.Builder |
|