Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class Candidate.
A response candidate generated from the model.
Generated from protobuf message google.cloud.aiplatform.v1.Candidate
Namespace
Google \ Cloud \ AIPlatform \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ index |
int
Output only. Index of the candidate. |
↳ content |
Google\Cloud\AIPlatform\V1\Content
Output only. Content parts of the candidate. |
↳ score |
float
Output only. Confidence score of the candidate. |
↳ avg_logprobs |
float
Output only. Average log probability score of the candidate. |
↳ finish_reason |
int
Output only. The reason why the model stopped generating tokens. If empty, the model has not stopped generating the tokens. |
↳ safety_ratings |
array<Google\Cloud\AIPlatform\V1\SafetyRating>
Output only. List of ratings for the safety of a response candidate. There is at most one rating per category. |
↳ finish_message |
string
Output only. Describes the reason the mode stopped generating tokens in more detail. This is only filled when |
↳ citation_metadata |
Google\Cloud\AIPlatform\V1\CitationMetadata
Output only. Source attribution of the generated content. |
↳ grounding_metadata |
Google\Cloud\AIPlatform\V1\GroundingMetadata
Output only. Metadata specifies sources used to ground generated content. |
getIndex
Output only. Index of the candidate.
| Returns | |
|---|---|
| Type | Description |
int |
|
setIndex
Output only. Index of the candidate.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getContent
Output only. Content parts of the candidate.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\AIPlatform\V1\Content|null |
|
hasContent
clearContent
setContent
Output only. Content parts of the candidate.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\AIPlatform\V1\Content
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getScore
Output only. Confidence score of the candidate.
| Returns | |
|---|---|
| Type | Description |
float |
|
setScore
Output only. Confidence score of the candidate.
| Parameter | |
|---|---|
| Name | Description |
var |
float
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAvgLogprobs
Output only. Average log probability score of the candidate.
| Returns | |
|---|---|
| Type | Description |
float |
|
setAvgLogprobs
Output only. Average log probability score of the candidate.
| Parameter | |
|---|---|
| Name | Description |
var |
float
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getFinishReason
Output only. The reason why the model stopped generating tokens.
If empty, the model has not stopped generating the tokens.
| Returns | |
|---|---|
| Type | Description |
int |
|
setFinishReason
Output only. The reason why the model stopped generating tokens.
If empty, the model has not stopped generating the tokens.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSafetyRatings
Output only. List of ratings for the safety of a response candidate.
There is at most one rating per category.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setSafetyRatings
Output only. List of ratings for the safety of a response candidate.
There is at most one rating per category.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\AIPlatform\V1\SafetyRating>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getFinishMessage
Output only. Describes the reason the mode stopped generating tokens in
more detail. This is only filled when finish_reason is set.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasFinishMessage
clearFinishMessage
setFinishMessage
Output only. Describes the reason the mode stopped generating tokens in
more detail. This is only filled when finish_reason is set.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCitationMetadata
Output only. Source attribution of the generated content.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\AIPlatform\V1\CitationMetadata|null |
|
hasCitationMetadata
clearCitationMetadata
setCitationMetadata
Output only. Source attribution of the generated content.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\AIPlatform\V1\CitationMetadata
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getGroundingMetadata
Output only. Metadata specifies sources used to ground generated content.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\AIPlatform\V1\GroundingMetadata|null |
|
hasGroundingMetadata
clearGroundingMetadata
setGroundingMetadata
Output only. Metadata specifies sources used to ground generated content.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\AIPlatform\V1\GroundingMetadata
|
| Returns | |
|---|---|
| Type | Description |
$this |
|