public interface GenerateContentResponseOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getCandidates(int index)
public abstract Candidate getCandidates(int index)Output only. Generated candidates.
repeated .google.cloud.vertexai.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.vertexai.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.vertexai.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.vertexai.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.vertexai.v1.Candidate candidates = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.cloud.vertexai.api.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.vertexai.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.vertexai.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.vertexai.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.vertexai.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.vertexai.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.vertexai.v1.GenerateContentResponse.UsageMetadata usage_metadata = 4;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the usageMetadata field is set. |