Google Cloud Discovery Engine V1 Client - Class Answer (1.7.0)

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.

↳ grounding_score
float

A score in the range of [0, 1] describing how grounded the answer is by the reference chunks.

↳ citations
array< Answer\Citation >

Citations.

↳ grounding_supports
array< Answer\GroundingSupport >

Optional. Grounding supports.

↳ references
array< Answer\Reference >

References.

↳ related_questions
array

Suggested related questions.

↳ steps
array< Answer\Step >

Answer generation steps.

↳ query_understanding_info
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.

↳ safety_ratings
array< SafetyRating >

Optional. Safety ratings.

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

getGroundingScore

A score in the range of [0, 1] describing how grounded the answer is by the reference chunks.

Returns
Type
Description
float

hasGroundingScore

clearGroundingScore

setGroundingScore

A score in the range of [0, 1] describing how grounded the answer is by the reference chunks.

Parameter
Name
Description
var
float
Returns
Type
Description
$this

getCitations

Citations.

Returns
Type
Description

setCitations

Citations.

Parameter
Name
Description
var
array< Answer\Citation >
Returns
Type
Description
$this

getGroundingSupports

Optional. Grounding supports.

Returns
Type
Description

setGroundingSupports

Optional. Grounding supports.

Parameter
Name
Description
Returns
Type
Description
$this

getReferences

References.

Returns
Type
Description

setReferences

References.

Parameter
Name
Description
var
array< Answer\Reference >
Returns
Type
Description
$this

getRelatedQuestions

Suggested related questions.

Returns
Type
Description

setRelatedQuestions

Suggested related questions.

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

getSteps

Answer generation steps.

Returns
Type
Description

setSteps

Answer generation steps.

Parameter
Name
Description
var
array< Answer\Step >
Returns
Type
Description
$this

getQueryUnderstandingInfo

Query understanding information.

Returns
Type
Description

hasQueryUnderstandingInfo

clearQueryUnderstandingInfo

setQueryUnderstandingInfo

Query understanding information.

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

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

hasCreateTime

clearCreateTime

setCreateTime

Output only. Answer creation timestamp.

Parameter
Name
Description
Returns
Type
Description
$this

getCompleteTime

Output only. Answer completed timestamp.

Returns
Type
Description

hasCompleteTime

clearCompleteTime

setCompleteTime

Output only. Answer completed timestamp.

Parameter
Name
Description
Returns
Type
Description
$this

getSafetyRatings

Optional. Safety ratings.

Returns
Type
Description

setSafetyRatings

Optional. Safety ratings.

Parameter
Name
Description
var
array< SafetyRating >
Returns
Type
Description
$this
Design a Mobile Site
View Site in Mobile | Classic
Share by: