com.google.cloud.aiplatform.v1beta1

Interface GenerateContentResponseOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

GenerateContentResponse, GenerateContentResponse.Builder

public interface GenerateContentResponseOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
Candidate	getCandidates(int index) Output only.
int	getCandidatesCount() Output only.
List<Candidate>	getCandidatesList() Output only.
CandidateOrBuilder	getCandidatesOrBuilder(int index) Output only.
List<? extends CandidateOrBuilder>	getCandidatesOrBuilderList() Output only.
GenerateContentResponse.PromptFeedback	getPromptFeedback() Output only.
GenerateContentResponse.PromptFeedbackOrBuilder	getPromptFeedbackOrBuilder() Output only.
GenerateContentResponse.UsageMetadata	getUsageMetadata() Usage metadata about the response(s).
GenerateContentResponse.UsageMetadataOrBuilder	getUsageMetadataOrBuilder() Usage metadata about the response(s).
boolean	hasPromptFeedback() Output only.
boolean	hasUsageMetadata() Usage metadata about the response(s).

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getCandidatesList

List<Candidate> getCandidatesList()

 Output only. Generated candidates.
 

repeated .google.cloud.aiplatform.v1beta1.Candidate candidates = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

getCandidates

Candidate getCandidates(int index)

 Output only. Generated candidates.
 

repeated .google.cloud.aiplatform.v1beta1.Candidate candidates = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

getCandidatesCount

int getCandidatesCount()

 Output only. Generated candidates.
 

repeated .google.cloud.aiplatform.v1beta1.Candidate candidates = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

getCandidatesOrBuilderList

List<? extends CandidateOrBuilder> getCandidatesOrBuilderList()

 Output only. Generated candidates.
 

repeated .google.cloud.aiplatform.v1beta1.Candidate candidates = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

getCandidatesOrBuilder

CandidateOrBuilder getCandidatesOrBuilder(int index)

 Output only. Generated candidates.
 

repeated .google.cloud.aiplatform.v1beta1.Candidate candidates = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

hasPromptFeedback

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.v1beta1.GenerateContentResponse.PromptFeedback prompt_feedback = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

Whether the promptFeedback field is set.

getPromptFeedback

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.v1beta1.GenerateContentResponse.PromptFeedback prompt_feedback = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The promptFeedback.

getPromptFeedbackOrBuilder

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.v1beta1.GenerateContentResponse.PromptFeedback prompt_feedback = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

hasUsageMetadata

boolean hasUsageMetadata()

 Usage metadata about the response(s).
 

.google.cloud.aiplatform.v1beta1.GenerateContentResponse.UsageMetadata usage_metadata = 4;

Returns:

Whether the usageMetadata field is set.

getUsageMetadata

GenerateContentResponse.UsageMetadata getUsageMetadata()

 Usage metadata about the response(s).
 

.google.cloud.aiplatform.v1beta1.GenerateContentResponse.UsageMetadata usage_metadata = 4;

Returns:

The usageMetadata.

getUsageMetadataOrBuilder

GenerateContentResponse.UsageMetadataOrBuilder getUsageMetadataOrBuilder()

 Usage metadata about the response(s).
 

.google.cloud.aiplatform.v1beta1.GenerateContentResponse.UsageMetadata usage_metadata = 4;