Google Cloud Discovery Engine V1 Client - Class Answer (1.0.0-RC1)

Reference documentation and code samples for the Google Cloud Discovery Engine V1 Client class Answer.

Defines an answer.

Generated from protobuf message google.cloud.discoveryengine.v1.Answer

Namespace

Google \ Cloud \ DiscoveryEngine \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ name string

Immutable. Fully qualified name projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*/answers/*

↳ state int

The state of the answer generation.

↳ answer_text string

The textual answer.

↳ citations array<Google\Cloud\DiscoveryEngine\V1\Answer\Citation>

Citations.

↳ references array<Google\Cloud\DiscoveryEngine\V1\Answer\Reference>

References.

↳ related_questions array

Suggested related questions.

↳ steps array<Google\Cloud\DiscoveryEngine\V1\Answer\Step>

Answer generation steps.

↳ query_understanding_info Google\Cloud\DiscoveryEngine\V1\Answer\QueryUnderstandingInfo

Query understanding information.

↳ answer_skipped_reasons array

Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.

↳ create_time Google\Protobuf\Timestamp

Output only. Answer creation timestamp.

↳ complete_time Google\Protobuf\Timestamp

Output only. Answer completed timestamp.

getName

Immutable. Fully qualified name projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*/answers/*

Returns
Type Description
string

setName

Immutable. Fully qualified name projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*/answers/*

Parameter
Name Description
var string
Returns
Type Description
$this

getState

The state of the answer generation.

Returns
Type Description
int

setState

The state of the answer generation.

Parameter
Name Description
var int
Returns
Type Description
$this

getAnswerText

The textual answer.

Returns
Type Description
string

setAnswerText

The textual answer.

Parameter
Name Description
var string
Returns
Type Description
$this

getCitations

Citations.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setCitations

Citations.

Parameter
Name Description
var array<Google\Cloud\DiscoveryEngine\V1\Answer\Citation>
Returns
Type Description
$this

getReferences

References.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setReferences

References.

Parameter
Name Description
var array<Google\Cloud\DiscoveryEngine\V1\Answer\Reference>
Returns
Type Description
$this

getRelatedQuestions

Suggested related questions.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setRelatedQuestions

Suggested related questions.

Parameter
Name Description
var string[]
Returns
Type Description
$this

getSteps

Answer generation steps.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setSteps

Answer generation steps.

Parameter
Name Description
var array<Google\Cloud\DiscoveryEngine\V1\Answer\Step>
Returns
Type Description
$this

getQueryUnderstandingInfo

Query understanding information.

Returns
Type Description
Google\Cloud\DiscoveryEngine\V1\Answer\QueryUnderstandingInfo|null

hasQueryUnderstandingInfo

clearQueryUnderstandingInfo

setQueryUnderstandingInfo

Query understanding information.

Parameter
Name Description
var Google\Cloud\DiscoveryEngine\V1\Answer\QueryUnderstandingInfo
Returns
Type Description
$this

getAnswerSkippedReasons

Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setAnswerSkippedReasons

Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.

Parameter
Name Description
var int[]
Returns
Type Description
$this

getCreateTime

Output only. Answer creation timestamp.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. Answer creation timestamp.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getCompleteTime

Output only. Answer completed timestamp.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasCompleteTime

clearCompleteTime

setCompleteTime

Output only. Answer completed timestamp.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this