- 0.59.0 (latest)
- 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 interface AnswerOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getAnswerSkippedReasons(int index)
public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract String getAnswerText()The textual answer.
string answer_text = 3;
| Returns | |
|---|---|
| Type | Description |
String |
The answerText. |
getAnswerTextBytes()
public abstract ByteString getAnswerTextBytes()The textual answer.
string answer_text = 3;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for answerText. |
getCitations(int index)
public abstract 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 |
|
getCitationsCount()
public abstract int getCitationsCount()Citations.
repeated .google.cloud.discoveryengine.v1.Answer.Citation citations = 4;
| Returns | |
|---|---|
| Type | Description |
int |
|
getCitationsList()
public abstract List<Answer.Citation> getCitationsList()Citations.
repeated .google.cloud.discoveryengine.v1.Answer.Citation citations = 4;
| Returns | |
|---|---|
| Type | Description |
List<Citation> |
|
getCitationsOrBuilder(int index)
public abstract 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 abstract 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 abstract 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. |
getCompleteTimeOrBuilder()
public abstract 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 abstract 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. |
getCreateTimeOrBuilder()
public abstract TimestampOrBuilder getCreateTimeOrBuilder()Output only. Answer creation timestamp.
.google.protobuf.Timestamp create_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
getGroundingScore()
public abstract 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 abstract 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 |
|
getGroundingSupportsCount()
public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract Answer.QueryUnderstandingInfo getQueryUnderstandingInfo()Query understanding information.
.google.cloud.discoveryengine.v1.Answer.QueryUnderstandingInfo query_understanding_info = 10;
| Returns | |
|---|---|
| Type | Description |
Answer.QueryUnderstandingInfo |
The queryUnderstandingInfo. |
getQueryUnderstandingInfoOrBuilder()
public abstract 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 abstract 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 |
|
getReferencesCount()
public abstract int getReferencesCount()References.
repeated .google.cloud.discoveryengine.v1.Answer.Reference references = 5;
| Returns | |
|---|---|
| Type | Description |
int |
|
getReferencesList()
public abstract List<Answer.Reference> getReferencesList()References.
repeated .google.cloud.discoveryengine.v1.Answer.Reference references = 5;
| Returns | |
|---|---|
| Type | Description |
List<Reference> |
|
getReferencesOrBuilder(int index)
public abstract 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 abstract 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 abstract 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 abstract 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 abstract int getRelatedQuestionsCount()Suggested related questions.
repeated string related_questions = 6;
| Returns | |
|---|---|
| Type | Description |
int |
The count of relatedQuestions. |
getRelatedQuestionsList()
public abstract List<String> getRelatedQuestionsList()Suggested related questions.
repeated string related_questions = 6;
| Returns | |
|---|---|
| Type | Description |
List<String> |
A list containing the relatedQuestions. |
getSafetyRatings(int index)
public abstract 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 |
|
getSafetyRatingsCount()
public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 |
|
getStepsCount()
public abstract int getStepsCount()Answer generation steps.
repeated .google.cloud.discoveryengine.v1.Answer.Step steps = 7;
| Returns | |
|---|---|
| Type | Description |
int |
|
getStepsList()
public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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. |