Reference documentation and code samples for the Google Cloud Ces V1 Client class SessionInput.
Input for the session.
Generated from protobuf message google.cloud.ces.v1.SessionInput
Namespace
Google \ Cloud \ Ces \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ text |
string
Optional. Text data from the end user. |
↳ dtmf |
string
Optional. DTMF digits from the end user. |
↳ audio |
string
Optional. Audio data from the end user. |
↳ tool_responses |
ToolResponses
Optional. Execution results for the tool calls from the client. |
↳ image |
Image
Optional. Image data from the end user. |
↳ blob |
Blob
Optional. Blob data from the end user. |
↳ variables |
Google\Protobuf\Struct
Optional. Contextual variables for the session, keyed by name. Only variables declared in the app will be used by the CES agent. Unrecognized variables will still be sent to the Dialogflow agent as additional session parameters. |
↳ event |
Event
Optional. Event input. |
↳ will_continue |
bool
Optional. A flag to indicate if the current message is a fragment of a larger input in the bidi streaming session. When |
getText
Optional. Text data from the end user.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasText
setText
Optional. Text data from the end user.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDtmf
Optional. DTMF digits from the end user.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasDtmf
setDtmf
Optional. DTMF digits from the end user.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAudio
Optional. Audio data from the end user.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasAudio
setAudio
Optional. Audio data from the end user.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getToolResponses
Optional. Execution results for the tool calls from the client.
| Returns | |
|---|---|
| Type | Description |
ToolResponses|null |
|
hasToolResponses
setToolResponses
Optional. Execution results for the tool calls from the client.
| Parameter | |
|---|---|
| Name | Description |
var |
ToolResponses
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getImage
Optional. Image data from the end user.
| Returns | |
|---|---|
| Type | Description |
Image|null |
|
hasImage
setImage
Optional. Image data from the end user.
| Parameter | |
|---|---|
| Name | Description |
var |
Image
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getBlob
Optional. Blob data from the end user.
| Returns | |
|---|---|
| Type | Description |
Blob|null |
|
hasBlob
setBlob
Optional. Blob data from the end user.
| Parameter | |
|---|---|
| Name | Description |
var |
Blob
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getVariables
Optional. Contextual variables for the session, keyed by name. Only variables declared in the app will be used by the CES agent.
Unrecognized variables will still be sent to the Dialogflow agent as additional session parameters.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Struct|null |
|
hasVariables
setVariables
Optional. Contextual variables for the session, keyed by name. Only variables declared in the app will be used by the CES agent.
Unrecognized variables will still be sent to the Dialogflow agent as additional session parameters.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Struct
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEvent
Optional. Event input.
| Returns | |
|---|---|
| Type | Description |
Event|null |
|
hasEvent
setEvent
Optional. Event input.
| Parameter | |
|---|---|
| Name | Description |
var |
Event
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getWillContinue
Optional. A flag to indicate if the current message is a fragment of a
larger input in the bidi streaming session. When true, the agent will
defer processing until a subsequent message with will_continue set to
false is received.
Note: This flag has no effect on audio and DTMF inputs, which are always processed in real-time.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setWillContinue
Optional. A flag to indicate if the current message is a fragment of a
larger input in the bidi streaming session. When true, the agent will
defer processing until a subsequent message with will_continue set to
false is received.
Note: This flag has no effect on audio and DTMF inputs, which are always processed in real-time.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getInputType
| Returns | |
|---|---|
| Type | Description |
string |
|