- 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 GenerateContentResponseOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getCandidates(int index)
public abstract Candidate getCandidates(int index)Output only. Generated candidates.
 
 repeated .google.cloud.aiplatform.v1.Candidate candidates = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
 
| Parameter | |
|---|---|
| Name | Description | 
index | 
        int | 
      
| Returns | |
|---|---|
| Type | Description | 
Candidate | 
        |
getCandidatesCount()
public abstract int getCandidatesCount()Output only. Generated candidates.
 
 repeated .google.cloud.aiplatform.v1.Candidate candidates = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
 
| Returns | |
|---|---|
| Type | Description | 
int | 
        |
getCandidatesList()
public abstract List<Candidate> getCandidatesList()Output only. Generated candidates.
 
 repeated .google.cloud.aiplatform.v1.Candidate candidates = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
 
| Returns | |
|---|---|
| Type | Description | 
List<Candidate> | 
        |
getCandidatesOrBuilder(int index)
public abstract CandidateOrBuilder getCandidatesOrBuilder(int index)Output only. Generated candidates.
 
 repeated .google.cloud.aiplatform.v1.Candidate candidates = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
 
| Parameter | |
|---|---|
| Name | Description | 
index | 
        int | 
      
| Returns | |
|---|---|
| Type | Description | 
CandidateOrBuilder | 
        |
getCandidatesOrBuilderList()
public abstract List<? extends CandidateOrBuilder> getCandidatesOrBuilderList()Output only. Generated candidates.
 
 repeated .google.cloud.aiplatform.v1.Candidate candidates = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
 
| Returns | |
|---|---|
| Type | Description | 
List<? extends com.google.cloud.aiplatform.v1.CandidateOrBuilder> | 
        |
getCreateTime()
public abstract Timestamp getCreateTime()Output only. Timestamp when the request is made to the server.
 .google.protobuf.Timestamp create_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
 
| Returns | |
|---|---|
| Type | Description | 
Timestamp | 
        The createTime.  | 
      
getCreateTimeOrBuilder()
public abstract TimestampOrBuilder getCreateTimeOrBuilder()Output only. Timestamp when the request is made to the server.
 .google.protobuf.Timestamp create_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
 
| Returns | |
|---|---|
| Type | Description | 
TimestampOrBuilder | 
        |
getModelVersion()
public abstract String getModelVersion()Output only. The model version used to generate the response.
 string model_version = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description | 
String | 
        The modelVersion.  | 
      
getModelVersionBytes()
public abstract ByteString getModelVersionBytes()Output only. The model version used to generate the response.
 string model_version = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description | 
ByteString | 
        The bytes for modelVersion.  | 
      
getPromptFeedback()
public abstract GenerateContentResponse.PromptFeedback getPromptFeedback()Output only. Content filter results for a prompt sent in the request. Note: Sent only in the first stream chunk. Only happens when no candidates were generated due to content violations.
 
 .google.cloud.aiplatform.v1.GenerateContentResponse.PromptFeedback prompt_feedback = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
 
| Returns | |
|---|---|
| Type | Description | 
GenerateContentResponse.PromptFeedback | 
        The promptFeedback.  | 
      
getPromptFeedbackOrBuilder()
public abstract GenerateContentResponse.PromptFeedbackOrBuilder getPromptFeedbackOrBuilder()Output only. Content filter results for a prompt sent in the request. Note: Sent only in the first stream chunk. Only happens when no candidates were generated due to content violations.
 
 .google.cloud.aiplatform.v1.GenerateContentResponse.PromptFeedback prompt_feedback = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
 
| Returns | |
|---|---|
| Type | Description | 
GenerateContentResponse.PromptFeedbackOrBuilder | 
        |
getResponseId()
public abstract String getResponseId()Output only. response_id is used to identify each response. It is the encoding of the event_id.
 string response_id = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description | 
String | 
        The responseId.  | 
      
getResponseIdBytes()
public abstract ByteString getResponseIdBytes()Output only. response_id is used to identify each response. It is the encoding of the event_id.
 string response_id = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description | 
ByteString | 
        The bytes for responseId.  | 
      
getUsageMetadata()
public abstract GenerateContentResponse.UsageMetadata getUsageMetadata()Usage metadata about the response(s).
 .google.cloud.aiplatform.v1.GenerateContentResponse.UsageMetadata usage_metadata = 4;
 
| Returns | |
|---|---|
| Type | Description | 
GenerateContentResponse.UsageMetadata | 
        The usageMetadata.  | 
      
getUsageMetadataOrBuilder()
public abstract GenerateContentResponse.UsageMetadataOrBuilder getUsageMetadataOrBuilder()Usage metadata about the response(s).
 .google.cloud.aiplatform.v1.GenerateContentResponse.UsageMetadata usage_metadata = 4;
 
| Returns | |
|---|---|
| Type | Description | 
GenerateContentResponse.UsageMetadataOrBuilder | 
        |
hasCreateTime()
public abstract boolean hasCreateTime()Output only. Timestamp when the request is made to the server.
 .google.protobuf.Timestamp create_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
 
| Returns | |
|---|---|
| Type | Description | 
boolean | 
        Whether the createTime field is set.  | 
      
hasPromptFeedback()
public abstract boolean hasPromptFeedback()Output only. Content filter results for a prompt sent in the request. Note: Sent only in the first stream chunk. Only happens when no candidates were generated due to content violations.
 
 .google.cloud.aiplatform.v1.GenerateContentResponse.PromptFeedback prompt_feedback = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
 
| Returns | |
|---|---|
| Type | Description | 
boolean | 
        Whether the promptFeedback field is set.  | 
      
hasUsageMetadata()
public abstract boolean hasUsageMetadata()Usage metadata about the response(s).
 .google.cloud.aiplatform.v1.GenerateContentResponse.UsageMetadata usage_metadata = 4;
 
| Returns | |
|---|---|
| Type | Description | 
boolean | 
        Whether the usageMetadata field is set.  |