com.google.api.services.firebaseml.v2beta.model.GoogleCloudAiplatformV1beta1Candidate Maven / Gradle / Ivy
/*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
* in compliance with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software distributed under the License
* is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
* or implied. See the License for the specific language governing permissions and limitations under
* the License.
*/
/*
* This code was generated by https://github.com/googleapis/google-api-java-client-services/
* Modify at your own risk.
*/
package com.google.api.services.firebaseml.v2beta.model;
/**
* A response candidate generated from the model.
*
* This is the Java data model class that specifies how to parse/serialize into the JSON that is
* transmitted over HTTP when working with the Firebase ML API. For a detailed explanation see:
* https://developers.google.com/api-client-library/java/google-http-java-client/json
*
*
* @author Google, Inc.
*/
@SuppressWarnings("javadoc")
public final class GoogleCloudAiplatformV1beta1Candidate extends com.google.api.client.json.GenericJson {
/**
* Output only. Average log probability score of the candidate.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.Double avgLogprobs;
/**
* Output only. Source attribution of the generated content.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private GoogleCloudAiplatformV1beta1CitationMetadata citationMetadata;
/**
* Output only. Content parts of the candidate.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private GoogleCloudAiplatformV1beta1Content content;
/**
* Output only. Describes the reason the mode stopped generating tokens in more detail. This is
* only filled when `finish_reason` is set.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String finishMessage;
/**
* Output only. The reason why the model stopped generating tokens. If empty, the model has not
* stopped generating the tokens.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String finishReason;
/**
* Output only. Metadata specifies sources used to ground generated content.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private GoogleCloudAiplatformV1beta1GroundingMetadata groundingMetadata;
/**
* Output only. Index of the candidate.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.Integer index;
/**
* Output only. Log-likelihood scores for the response tokens and top tokens
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private GoogleCloudAiplatformV1beta1LogprobsResult logprobsResult;
/**
* Output only. List of ratings for the safety of a response candidate. There is at most one
* rating per category.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.util.List safetyRatings;
/**
* Output only. Average log probability score of the candidate.
* @return value or {@code null} for none
*/
public java.lang.Double getAvgLogprobs() {
return avgLogprobs;
}
/**
* Output only. Average log probability score of the candidate.
* @param avgLogprobs avgLogprobs or {@code null} for none
*/
public GoogleCloudAiplatformV1beta1Candidate setAvgLogprobs(java.lang.Double avgLogprobs) {
this.avgLogprobs = avgLogprobs;
return this;
}
/**
* Output only. Source attribution of the generated content.
* @return value or {@code null} for none
*/
public GoogleCloudAiplatformV1beta1CitationMetadata getCitationMetadata() {
return citationMetadata;
}
/**
* Output only. Source attribution of the generated content.
* @param citationMetadata citationMetadata or {@code null} for none
*/
public GoogleCloudAiplatformV1beta1Candidate setCitationMetadata(GoogleCloudAiplatformV1beta1CitationMetadata citationMetadata) {
this.citationMetadata = citationMetadata;
return this;
}
/**
* Output only. Content parts of the candidate.
* @return value or {@code null} for none
*/
public GoogleCloudAiplatformV1beta1Content getContent() {
return content;
}
/**
* Output only. Content parts of the candidate.
* @param content content or {@code null} for none
*/
public GoogleCloudAiplatformV1beta1Candidate setContent(GoogleCloudAiplatformV1beta1Content content) {
this.content = content;
return this;
}
/**
* Output only. Describes the reason the mode stopped generating tokens in more detail. This is
* only filled when `finish_reason` is set.
* @return value or {@code null} for none
*/
public java.lang.String getFinishMessage() {
return finishMessage;
}
/**
* Output only. Describes the reason the mode stopped generating tokens in more detail. This is
* only filled when `finish_reason` is set.
* @param finishMessage finishMessage or {@code null} for none
*/
public GoogleCloudAiplatformV1beta1Candidate setFinishMessage(java.lang.String finishMessage) {
this.finishMessage = finishMessage;
return this;
}
/**
* Output only. The reason why the model stopped generating tokens. If empty, the model has not
* stopped generating the tokens.
* @return value or {@code null} for none
*/
public java.lang.String getFinishReason() {
return finishReason;
}
/**
* Output only. The reason why the model stopped generating tokens. If empty, the model has not
* stopped generating the tokens.
* @param finishReason finishReason or {@code null} for none
*/
public GoogleCloudAiplatformV1beta1Candidate setFinishReason(java.lang.String finishReason) {
this.finishReason = finishReason;
return this;
}
/**
* Output only. Metadata specifies sources used to ground generated content.
* @return value or {@code null} for none
*/
public GoogleCloudAiplatformV1beta1GroundingMetadata getGroundingMetadata() {
return groundingMetadata;
}
/**
* Output only. Metadata specifies sources used to ground generated content.
* @param groundingMetadata groundingMetadata or {@code null} for none
*/
public GoogleCloudAiplatformV1beta1Candidate setGroundingMetadata(GoogleCloudAiplatformV1beta1GroundingMetadata groundingMetadata) {
this.groundingMetadata = groundingMetadata;
return this;
}
/**
* Output only. Index of the candidate.
* @return value or {@code null} for none
*/
public java.lang.Integer getIndex() {
return index;
}
/**
* Output only. Index of the candidate.
* @param index index or {@code null} for none
*/
public GoogleCloudAiplatformV1beta1Candidate setIndex(java.lang.Integer index) {
this.index = index;
return this;
}
/**
* Output only. Log-likelihood scores for the response tokens and top tokens
* @return value or {@code null} for none
*/
public GoogleCloudAiplatformV1beta1LogprobsResult getLogprobsResult() {
return logprobsResult;
}
/**
* Output only. Log-likelihood scores for the response tokens and top tokens
* @param logprobsResult logprobsResult or {@code null} for none
*/
public GoogleCloudAiplatformV1beta1Candidate setLogprobsResult(GoogleCloudAiplatformV1beta1LogprobsResult logprobsResult) {
this.logprobsResult = logprobsResult;
return this;
}
/**
* Output only. List of ratings for the safety of a response candidate. There is at most one
* rating per category.
* @return value or {@code null} for none
*/
public java.util.List getSafetyRatings() {
return safetyRatings;
}
/**
* Output only. List of ratings for the safety of a response candidate. There is at most one
* rating per category.
* @param safetyRatings safetyRatings or {@code null} for none
*/
public GoogleCloudAiplatformV1beta1Candidate setSafetyRatings(java.util.List safetyRatings) {
this.safetyRatings = safetyRatings;
return this;
}
@Override
public GoogleCloudAiplatformV1beta1Candidate set(String fieldName, Object value) {
return (GoogleCloudAiplatformV1beta1Candidate) super.set(fieldName, value);
}
@Override
public GoogleCloudAiplatformV1beta1Candidate clone() {
return (GoogleCloudAiplatformV1beta1Candidate) super.clone();
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy