- 3.79.0 (latest)
- 3.77.0
- 3.76.0
- 3.75.0
- 3.74.0
- 3.73.0
- 3.71.0
- 3.69.0
- 3.68.0
- 3.65.0
- 3.64.0
- 3.63.0
- 3.61.0
- 3.60.0
- 3.59.0
- 3.58.0
- 3.57.0
- 3.56.0
- 3.55.0
- 3.54.0
- 3.53.0
- 3.52.0
- 3.50.0
- 3.49.0
- 3.48.0
- 3.47.0
- 3.46.0
- 3.45.0
- 3.44.0
- 3.43.0
- 3.42.0
- 3.41.0
- 3.40.0
- 3.38.0
- 3.37.0
- 3.36.0
- 3.35.0
- 3.34.0
- 3.33.0
- 3.32.0
- 3.31.0
- 3.30.0
- 3.29.0
- 3.28.0
- 3.25.0
- 3.24.0
- 3.23.0
- 3.22.0
- 3.21.0
- 3.20.0
- 3.19.0
- 3.18.0
- 3.17.0
- 3.16.0
- 3.15.0
- 3.14.0
- 3.13.0
- 3.12.0
- 3.11.0
- 3.10.0
- 3.9.0
- 3.8.0
- 3.7.0
- 3.6.0
- 3.5.0
- 3.4.2
- 3.3.0
- 3.2.0
- 3.0.0
- 2.9.8
- 2.8.9
- 2.7.4
- 2.5.3
- 2.4.0
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.aiplatform.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.aiplatform.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.aiplatform.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.aiplatform.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.aiplatform.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.aiplatform.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.aiplatform.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.aiplatform.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. |
getLogprobsResult()
public abstract LogprobsResult getLogprobsResult()Output only. Log-likelihood scores for the response tokens and top tokens
.google.cloud.aiplatform.v1.LogprobsResult logprobs_result = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
LogprobsResult |
The logprobsResult. |
getLogprobsResultOrBuilder()
public abstract LogprobsResultOrBuilder getLogprobsResultOrBuilder()Output only. Log-likelihood scores for the response tokens and top tokens
.google.cloud.aiplatform.v1.LogprobsResult logprobs_result = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
LogprobsResultOrBuilder |
|
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.aiplatform.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.aiplatform.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.aiplatform.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.aiplatform.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.aiplatform.v1.SafetyRating safety_ratings = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.cloud.aiplatform.v1.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.aiplatform.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.aiplatform.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.aiplatform.v1.GroundingMetadata grounding_metadata = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the groundingMetadata field is set. |
hasLogprobsResult()
public abstract boolean hasLogprobsResult()Output only. Log-likelihood scores for the response tokens and top tokens
.google.cloud.aiplatform.v1.LogprobsResult logprobs_result = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the logprobsResult field is set. |