Google Cloud Discovery Engine V1 Client - Class Turn (1.6.1)

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

Represents a turn, including a query from the user and a answer from service.

Generated from protobuf message google.cloud.discoveryengine.v1.Session.Turn

Namespace

Google \ Cloud \ DiscoveryEngine \ V1 \ Session

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ query
↳ answer
string

The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn.

↳ detailed_answer
Google\Cloud\DiscoveryEngine\V1\Answer

Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting answer query session.

getQuery

The user query.

Returns
Type
Description

hasQuery

clearQuery

setQuery

The user query.

Parameter
Name
Description
Returns
Type
Description
$this

getAnswer

The resource name of the answer to the user query.

Only set if the answer generation (/answer API call) happened in this turn.

Returns
Type
Description
string

setAnswer

The resource name of the answer to the user query.

Only set if the answer generation (/answer API call) happened in this turn.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getDetailedAnswer

Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting answer query session.

Returns
Type
Description

hasDetailedAnswer

clearDetailedAnswer

setDetailedAnswer

Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting answer query session.

Parameter
Name
Description
Returns
Type
Description
$this
Design a Mobile Site
View Site in Mobile | Classic
Share by: