public interface CandidateOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getAvgLogprobs()
public abstract double getAvgLogprobs()Output only. Average log probability score of the candidate.
double avg_logprobs = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
double |
The avgLogprobs. |
getCitationMetadata()
public abstract CitationMetadata getCitationMetadata()Output only. Source attribution of the generated content.
.google.cloud.vertexai.v1.CitationMetadata citation_metadata = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
CitationMetadata |
The citationMetadata. |
getCitationMetadataOrBuilder()
public abstract CitationMetadataOrBuilder getCitationMetadataOrBuilder()Output only. Source attribution of the generated content.
.google.cloud.vertexai.v1.CitationMetadata citation_metadata = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
CitationMetadataOrBuilder |
|
getContent()
public abstract Content getContent()Output only. Content parts of the candidate.
.google.cloud.vertexai.v1.Content content = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Content |
The content. |
getContentOrBuilder()
public abstract ContentOrBuilder getContentOrBuilder()Output only. Content parts of the candidate.
.google.cloud.vertexai.v1.Content content = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
ContentOrBuilder |
|
getFinishMessage()
public abstract String getFinishMessage() Output only. Describes the reason the mode stopped generating tokens in
more detail. This is only filled when finish_reason is set.
optional string finish_message = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
String |
The finishMessage. |
getFinishMessageBytes()
public abstract ByteString getFinishMessageBytes() Output only. Describes the reason the mode stopped generating tokens in
more detail. This is only filled when finish_reason is set.
optional string finish_message = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for finishMessage. |
getFinishReason()
public abstract Candidate.FinishReason getFinishReason()Output only. The reason why the model stopped generating tokens. If empty, the model has not stopped generating the tokens.
.google.cloud.vertexai.v1.Candidate.FinishReason finish_reason = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Candidate.FinishReason |
The finishReason. |
getFinishReasonValue()
public abstract int getFinishReasonValue()Output only. The reason why the model stopped generating tokens. If empty, the model has not stopped generating the tokens.
.google.cloud.vertexai.v1.Candidate.FinishReason finish_reason = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for finishReason. |
getGroundingMetadata()
public abstract GroundingMetadata getGroundingMetadata()Output only. Metadata specifies sources used to ground generated content.
.google.cloud.vertexai.v1.GroundingMetadata grounding_metadata = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
GroundingMetadata |
The groundingMetadata. |
getGroundingMetadataOrBuilder()
public abstract GroundingMetadataOrBuilder getGroundingMetadataOrBuilder()Output only. Metadata specifies sources used to ground generated content.
.google.cloud.vertexai.v1.GroundingMetadata grounding_metadata = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
GroundingMetadataOrBuilder |
|
getIndex()
public abstract int getIndex()Output only. Index of the candidate.
int32 index = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
int |
The index. |
getSafetyRatings(int index)
public abstract SafetyRating getSafetyRatings(int index)Output only. List of ratings for the safety of a response candidate.
There is at most one rating per category.
repeated .google.cloud.vertexai.v1.SafetyRating safety_ratings = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
SafetyRating |
|
getSafetyRatingsCount()
public abstract int getSafetyRatingsCount()Output only. List of ratings for the safety of a response candidate.
There is at most one rating per category.
repeated .google.cloud.vertexai.v1.SafetyRating safety_ratings = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
int |
|
getSafetyRatingsList()
public abstract List<SafetyRating> getSafetyRatingsList()Output only. List of ratings for the safety of a response candidate.
There is at most one rating per category.
repeated .google.cloud.vertexai.v1.SafetyRating safety_ratings = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
List<SafetyRating> |
|
getSafetyRatingsOrBuilder(int index)
public abstract SafetyRatingOrBuilder getSafetyRatingsOrBuilder(int index)Output only. List of ratings for the safety of a response candidate.
There is at most one rating per category.
repeated .google.cloud.vertexai.v1.SafetyRating safety_ratings = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
SafetyRatingOrBuilder |
|
getSafetyRatingsOrBuilderList()
public abstract List<? extends SafetyRatingOrBuilder> getSafetyRatingsOrBuilderList()Output only. List of ratings for the safety of a response candidate.
There is at most one rating per category.
repeated .google.cloud.vertexai.v1.SafetyRating safety_ratings = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.cloud.vertexai.api.SafetyRatingOrBuilder> |
|
getScore()
public abstract double getScore()Output only. Confidence score of the candidate.
double score = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
double |
The score. |
hasCitationMetadata()
public abstract boolean hasCitationMetadata()Output only. Source attribution of the generated content.
.google.cloud.vertexai.v1.CitationMetadata citation_metadata = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the citationMetadata field is set. |
hasContent()
public abstract boolean hasContent()Output only. Content parts of the candidate.
.google.cloud.vertexai.v1.Content content = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the content field is set. |
hasFinishMessage()
public abstract boolean hasFinishMessage() Output only. Describes the reason the mode stopped generating tokens in
more detail. This is only filled when finish_reason is set.
optional string finish_message = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the finishMessage field is set. |
hasGroundingMetadata()
public abstract boolean hasGroundingMetadata()Output only. Metadata specifies sources used to ground generated content.
.google.cloud.vertexai.v1.GroundingMetadata grounding_metadata = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the groundingMetadata field is set. |