public final class GenerateContentResponse extends GeneratedMessageV3 implements GenerateContentResponseOrBuilder
Response message for [PredictionService.GenerateContent].
Protobuf type google.cloud.aiplatform.v1.GenerateContentResponse
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
CANDIDATES_FIELD_NUMBER
public static final int CANDIDATES_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
MODEL_VERSION_FIELD_NUMBER
public static final int MODEL_VERSION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
PROMPT_FEEDBACK_FIELD_NUMBER
public static final int PROMPT_FEEDBACK_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
USAGE_METADATA_FIELD_NUMBER
public static final int USAGE_METADATA_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static GenerateContentResponse getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static GenerateContentResponse.Builder newBuilder()
newBuilder(GenerateContentResponse prototype)
public static GenerateContentResponse.Builder newBuilder(GenerateContentResponse prototype)
parseDelimitedFrom(InputStream input)
public static GenerateContentResponse parseDelimitedFrom(InputStream input)
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static GenerateContentResponse parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static GenerateContentResponse parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static GenerateContentResponse parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static GenerateContentResponse parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static GenerateContentResponse parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
parseFrom(CodedInputStream input)
public static GenerateContentResponse parseFrom(CodedInputStream input)
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static GenerateContentResponse parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(InputStream input)
public static GenerateContentResponse parseFrom(InputStream input)
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static GenerateContentResponse parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static GenerateContentResponse parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static GenerateContentResponse parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<GenerateContentResponse> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getCandidates(int index)
public 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
|
getCandidatesCount()
public 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 List<Candidate> getCandidatesList()
Output only. Generated candidates.
repeated .google.cloud.aiplatform.v1.Candidate candidates = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
getCandidatesOrBuilder(int index)
public 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
|
getCandidatesOrBuilderList()
public 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> |
|
getDefaultInstanceForType()
public GenerateContentResponse getDefaultInstanceForType()
getModelVersion()
public 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 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.
|
getParserForType()
public Parser<GenerateContentResponse> getParserForType()
Overrides
getPromptFeedback()
public 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];
getPromptFeedbackOrBuilder()
public 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];
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
getUsageMetadata()
public GenerateContentResponse.UsageMetadata getUsageMetadata()
Usage metadata about the response(s).
.google.cloud.aiplatform.v1.GenerateContentResponse.UsageMetadata usage_metadata = 4;
getUsageMetadataOrBuilder()
public GenerateContentResponse.UsageMetadataOrBuilder getUsageMetadataOrBuilder()
Usage metadata about the response(s).
.google.cloud.aiplatform.v1.GenerateContentResponse.UsageMetadata usage_metadata = 4;
hasPromptFeedback()
public 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 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.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public GenerateContentResponse.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected GenerateContentResponse.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public GenerateContentResponse.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
