Reference documentation and code samples for the Google Cloud Dialogflow Cx V3 Client class SessionInfo.
Represents session information communicated to and from the webhook.
Generated from protobuf message google.cloud.dialogflow.cx.v3.SessionInfo
Namespace
Google \ Cloud \ Dialogflow \ Cx \ V3Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ session |
string
Always present for WebhookRequest. Ignored for WebhookResponse. The unique identifier of the session. This field can be used by the webhook to identify a session. Format: |
↳ parameters |
array|Google\Protobuf\Internal\MapField
Optional for WebhookRequest. Optional for WebhookResponse. All parameters collected from forms and intents during the session. Parameters can be created, updated, or removed by the webhook. To remove a parameter from the session, the webhook should explicitly set the parameter value to null in WebhookResponse. The map is keyed by parameters' display names. |
getSession
Always present for WebhookRequest. Ignored for WebhookResponse. The unique identifier of the session. This field can be used by the webhook to identify a session.
Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent
ID>/sessions/<Session ID> or projects/<Project ID>/locations/<Location
ID>/agents/<Agent ID>/environments/<Environment ID>/sessions/<Session ID>
if environment is specified.
| Returns | |
|---|---|
| Type | Description |
string |
|
setSession
Always present for WebhookRequest. Ignored for WebhookResponse. The unique identifier of the session. This field can be used by the webhook to identify a session.
Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent
ID>/sessions/<Session ID> or projects/<Project ID>/locations/<Location
ID>/agents/<Agent ID>/environments/<Environment ID>/sessions/<Session ID>
if environment is specified.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getParameters
Optional for WebhookRequest. Optional for WebhookResponse. All parameters collected from forms and intents during the session. Parameters can be created, updated, or removed by the webhook. To remove a parameter from the session, the webhook should explicitly set the parameter value to null in WebhookResponse.
The map is keyed by parameters' display names.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField |
|
setParameters
Optional for WebhookRequest. Optional for WebhookResponse. All parameters collected from forms and intents during the session. Parameters can be created, updated, or removed by the webhook. To remove a parameter from the session, the webhook should explicitly set the parameter value to null in WebhookResponse.
The map is keyed by parameters' display names.
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this |
|