Reference documentation and code samples for the Google Cloud Discovery Engine V1 Client class ConversationInfo.
The conversation information such as the question index and session name.
Generated from protobuf message google.cloud.discoveryengine.v1.Feedback.ConversationInfo
Namespace
Google \ Cloud \ DiscoveryEngine \ V1 \ FeedbackMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ question_index |
int
The index of the user input within the conversation messages. |
↳ session |
string
Name of the newly generated or continued session. |
↳ query |
Google\Cloud\DiscoveryEngine\V1\Query
Required. The user's search query. |
↳ assist_token |
string
Optional. The token which could be used to fetch the assistant log. |
↳ answer_query_token |
string
Optional. The token which could be used to fetch the answer log. |
↳ task_name |
string
Optional. The full resource name of the Sobi task if the conversation was handled by a long-running agent task. Format (canonical, or the short alias the Task API also accepts): projects/{project}/locations/{location}/agents/{agent}/tasks/{task} projects/{project}/locations/{location}/tasks/{task} |
↳ trajectory_id |
string
Optional. The runtime trajectory id of the rated agent task turn, as set on |
↳ step_seq_num |
int|string
Optional. The |
getQuestionIndex
The index of the user input within the conversation messages.
| Returns | |
|---|---|
| Type | Description |
int |
|
setQuestionIndex
The index of the user input within the conversation messages.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSession
Name of the newly generated or continued session.
| Returns | |
|---|---|
| Type | Description |
string |
|
setSession
Name of the newly generated or continued session.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getQuery
Required. The user's search query.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\DiscoveryEngine\V1\Query|null |
|
hasQuery
clearQuery
setQuery
Required. The user's search query.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\DiscoveryEngine\V1\Query
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAssistToken
Optional. The token which could be used to fetch the assistant log.
| Returns | |
|---|---|
| Type | Description |
string |
|
setAssistToken
Optional. The token which could be used to fetch the assistant log.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAnswerQueryToken
Optional. The token which could be used to fetch the answer log.
| Returns | |
|---|---|
| Type | Description |
string |
|
setAnswerQueryToken
Optional. The token which could be used to fetch the answer log.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getTaskName
Optional. The full resource name of the Sobi task if the conversation was handled by a long-running agent task. Format (canonical, or the short alias the Task API also accepts): projects/{project}/locations/{location}/agents/{agent}/tasks/{task} projects/{project}/locations/{location}/tasks/{task}
| Returns | |
|---|---|
| Type | Description |
string |
|
setTaskName
Optional. The full resource name of the Sobi task if the conversation was handled by a long-running agent task. Format (canonical, or the short alias the Task API also accepts): projects/{project}/locations/{location}/agents/{agent}/tasks/{task} projects/{project}/locations/{location}/tasks/{task}
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getTrajectoryId
Optional. The runtime trajectory id of the rated agent task turn, as set
on TaskServerEvent.trajectory_id. Shared by all steps of the turn.
| Returns | |
|---|---|
| Type | Description |
string |
|
setTrajectoryId
Optional. The runtime trajectory id of the rated agent task turn, as set
on TaskServerEvent.trajectory_id. Shared by all steps of the turn.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getStepSeqNum
Optional. The TaskServerEvent.seq_num of the step that opened the rated
agent task reply.
| Returns | |
|---|---|
| Type | Description |
int|string |
|
setStepSeqNum
Optional. The TaskServerEvent.seq_num of the step that opened the rated
agent task reply.
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|