Google Cloud Dialogflow Cx V3 Client - Class TraceBlock (0.11.0)

Reference documentation and code samples for the Google Cloud Dialogflow Cx V3 Client class TraceBlock.

The trace block tracks a sequence of actions taken by the agent in a flow or a playbook.

Generated from protobuf message google.cloud.dialogflow.cx.v3.TraceBlock

Namespace

Google \ Cloud \ Dialogflow \ Cx \ V3

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ playbook_trace_metadata`	`PlaybookTraceMetadata` Metadata of the playbook trace.
`↳ flow_trace_metadata`	`FlowTraceMetadata` Metadata of the flow trace.
`↳ speech_processing_metadata`	`SpeechProcessingMetadata` Metadata of the speech-to-text and speech-to-text processing.
`↳ actions`	`array<Action>` The actions performed by the agent and the user during this session.
`↳ start_time`	`Google\Protobuf\Timestamp` Output only. Timestamp of the start of the trace block.
`↳ complete_time`	`Google\Protobuf\Timestamp` Output only. Timestamp of the end of the trace block.
`↳ input_parameters`	`Google\Protobuf\Struct` Optional. A list of input parameters of the trace block.
`↳ output_parameters`	`Google\Protobuf\Struct` Optional. A list of output parameters of the trace block.
`↳ end_state`	`int` Optional. Output only. The end state of the trace block.

getPlaybookTraceMetadata

Metadata of the playbook trace.

Returns
Type	Description
`PlaybookTraceMetadata\|null`

hasPlaybookTraceMetadata

setPlaybookTraceMetadata

Metadata of the playbook trace.

Parameter
Name	Description
`var`	`PlaybookTraceMetadata`

Returns
Type	Description
`$this`

getFlowTraceMetadata

Metadata of the flow trace.

Returns
Type	Description
`FlowTraceMetadata\|null`

hasFlowTraceMetadata

setFlowTraceMetadata

Metadata of the flow trace.

Parameter
Name	Description
`var`	`FlowTraceMetadata`

Returns
Type	Description
`$this`

getSpeechProcessingMetadata

Metadata of the speech-to-text and speech-to-text processing.

Returns
Type	Description
`SpeechProcessingMetadata\|null`

hasSpeechProcessingMetadata

setSpeechProcessingMetadata

Metadata of the speech-to-text and speech-to-text processing.

Parameter
Name	Description
`var`	`SpeechProcessingMetadata`

Returns
Type	Description
`$this`

getActions

The actions performed by the agent and the user during this session.

Returns
Type	Description
`Google\Protobuf\RepeatedField<Action>`

setActions

The actions performed by the agent and the user during this session.

Parameter
Name	Description
`var`	`array<Action>`

Returns
Type	Description
`$this`

getStartTime

Output only. Timestamp of the start of the trace block.

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasStartTime

clearStartTime

setStartTime

Output only. Timestamp of the start of the trace block.

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`

getCompleteTime

Output only. Timestamp of the end of the trace block.

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasCompleteTime

clearCompleteTime

setCompleteTime