Google Cloud Ai Platform V1 Client - Class GenerateContentResponse (1.54.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<Candidate>` Output only. Generated candidates.
`↳ model_version`	`string` Output only. The model version used to generate the response.
`↳ create_time`	`Google\Protobuf\Timestamp` Output only. Timestamp when the request is made to the server.
`↳ response_id`	`string` Output only. response_id is used to identify each response. It is the encoding of the event_id.
`↳ prompt_feedback`	`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`	`GenerateContentResponse\UsageMetadata` Usage metadata about the response(s).

getCandidates

Output only. Generated candidates.

Returns
Type	Description
`Google\Protobuf\RepeatedField<Candidate>`

setCandidates

Output only. Generated candidates.

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

getCreateTime

Output only. Timestamp when the request is made to the server.

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasCreateTime

clearCreateTime

setCreateTime

Output only. Timestamp when the request is made to the server.

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`

getResponseId

Output only. response_id is used to identify each response. It is the encoding of the event_id.

Returns
Type	Description
`string`

setResponseId

Output only. response_id is used to identify each response. It is the encoding of the event_id.

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
`GenerateContentResponse\PromptFeedback\|null`

hasPromptFeedback

clearPromptFeedback

setPromptFeedback