Google Cloud Ai Platform V1 Client - Class GenerateContentResponse (1.7.0)

Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class GenerateContentResponse.

Response message for [PredictionService.GenerateContent].

Generated from protobuf message google.cloud.aiplatform.v1.GenerateContentResponse

Namespace

Google \ Cloud \ AIPlatform \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ candidates array<Google\Cloud\AIPlatform\V1\Candidate>

Output only. Generated candidates.
↳ model_version string

Output only. The model version used to generate the response.
↳ prompt_feedback Google\Cloud\AIPlatform\V1\GenerateContentResponse\PromptFeedback

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.
↳ usage_metadata Google\Cloud\AIPlatform\V1\GenerateContentResponse\UsageMetadata

Usage metadata about the response(s).

getCandidates

Output only. Generated candidates.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setCandidates

Output only. Generated candidates.

Parameter
Name Description
var array<Google\Cloud\AIPlatform\V1\Candidate>
Returns
Type Description
$this

getModelVersion

Output only. The model version used to generate the response.

Returns
Type Description
string

setModelVersion

Output only. The model version used to generate the response.

Parameter
Name Description
var string
Returns
Type Description
$this

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.

Returns
Type Description
Google\Cloud\AIPlatform\V1\GenerateContentResponse\PromptFeedback|null

hasPromptFeedback

clearPromptFeedback

setPromptFeedback

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.

Parameter
Name Description
var Google\Cloud\AIPlatform\V1\GenerateContentResponse\PromptFeedback
Returns
Type Description
$this

getUsageMetadata

Usage metadata about the response(s).

Returns
Type Description
Google\Cloud\AIPlatform\V1\GenerateContentResponse\UsageMetadata|null

hasUsageMetadata

clearUsageMetadata

setUsageMetadata

Usage metadata about the response(s).

Parameter
Name Description
var Google\Cloud\AIPlatform\V1\GenerateContentResponse\UsageMetadata
Returns
Type Description
$this