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

Version 1.9.0

• 1.11.0 (latest)
• 1.10.0
• 1.9.0
• 1.8.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0
• 0.39.0
• 0.38.0
• 0.37.1
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.26.2
• 0.25.0
• 0.24.0
• 0.23.0
• 0.22.0
• 0.21.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.13.0
• 0.12.0
• 0.11.1
• 0.10.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