Some or all of the information on this page might not apply to Cloud de Confiance by S3NS. See Differences from Google Cloud for more details.

Google Cloud Ai Platform V1 Client - Class Candidate (1.41.0)

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 \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ index`	`int` Output only. Index of the candidate.
`↳ content`	`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.
`↳ logprobs_result`	`LogprobsResult` Output only. Log-likelihood scores for the response tokens and top tokens
`↳ 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<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 `finish_reason` is set.
`↳ citation_metadata`	`CitationMetadata` Output only. Source attribution of the generated content.
`↳ grounding_metadata`	`GroundingMetadata` Output only. Metadata specifies sources used to ground generated content.
`↳ url_context_metadata`	`UrlContextMetadata` Output only. Metadata related to url context retrieval tool.

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
`Content\|null`

hasContent

clearContent

setContent

Output only. Content parts of the candidate.

Parameter
Name	Description
`var`	`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`

getLogprobsResult

Output only. Log-likelihood scores for the response tokens and top tokens

Returns
Type	Description
`LogprobsResult\|null`

hasLogprobsResult

clearLogprobsResult

setLogprobsResult

Output only. Log-likelihood scores for the response tokens and top tokens

Parameter
Name	Description
`var`	`LogprobsResult`

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`	Enum of type FinishReason.

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` Enum of type FinishReason.

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<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
`CitationMetadata\|null`

hasCitationMetadata

clearCitationMetadata

setCitationMetadata

Output only. Source attribution of the generated content.

Parameter
Name	Description
`var`	`CitationMetadata`

Returns
Type	Description
`$this`

getGroundingMetadata

Output only. Metadata specifies sources used to ground generated content.

Returns
Type	Description
`GroundingMetadata\|null`

hasGroundingMetadata

clearGroundingMetadata

setGroundingMetadata

Output only. Metadata specifies sources used to ground generated content.

Parameter
Name	Description
`var`	`GroundingMetadata`

Returns
Type	Description
`$this`

getUrlContextMetadata

Output only. Metadata related to url context retrieval tool.

Returns
Type	Description
`UrlContextMetadata\|null`

hasUrlContextMetadata

clearUrlContextMetadata

setUrlContextMetadata

Output only. Metadata related to url context retrieval tool.

Parameter
Name	Description
`var`	`UrlContextMetadata`

Returns
Type	Description
`$this`