Google Cloud Dialogflow Cx V3 Client - Class CloudConversationDebuggingInfo (0.2.1)

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

Cloud conversation info for easier debugging.

It will get populated in StreamingDetectIntentResponse or StreamingAnalyzeContentResponse when the flag enable_debugging_info is set to true in corresponding requests.

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

Namespace

Google \ Cloud \ Dialogflow \ Cx \ V3

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ audio_data_chunks`	`int` Number of input audio data chunks in streaming requests.
`↳ result_end_time_offset`	`Google\Protobuf\Duration` Time offset of the end of speech utterance relative to the beginning of the first audio chunk.
`↳ first_audio_duration`	`Google\Protobuf\Duration` Duration of first audio chunk.
`↳ single_utterance`	`bool` Whether client used single utterance mode.
`↳ speech_partial_results_end_times`	`array<Google\Protobuf\Duration>` Time offsets of the speech partial results relative to the beginning of the stream.
`↳ speech_final_results_end_times`	`array<Google\Protobuf\Duration>` Time offsets of the speech final results (is_final=true) relative to the beginning of the stream.
`↳ partial_responses`	`int` Total number of partial responses.
`↳ speaker_id_passive_latency_ms_offset`	`int` Time offset of Speaker ID stream close time relative to the Speech stream close time in milliseconds. Only meaningful for conversations involving passive verification.
`↳ bargein_event_triggered`	`bool` Whether a barge-in event is triggered in this request.
`↳ speech_single_utterance`	`bool` Whether speech uses single utterance mode.
`↳ dtmf_partial_results_times`	`array<Google\Protobuf\Duration>` Time offsets of the DTMF partial results relative to the beginning of the stream.
`↳ dtmf_final_results_times`	`array<Google\Protobuf\Duration>` Time offsets of the DTMF final results relative to the beginning of the stream.
`↳ single_utterance_end_time_offset`	`Google\Protobuf\Duration` Time offset of the end-of-single-utterance signal relative to the beginning of the stream.
`↳ no_speech_timeout`	`Google\Protobuf\Duration` No speech timeout settings for the stream.
`↳ endpointing_timeout`	`Google\Protobuf\Duration` Speech endpointing timeout settings for the stream.
`↳ is_input_text`	`bool` Whether the streaming terminates with an injected text query.
`↳ client_half_close_time_offset`	`Google\Protobuf\Duration` Client half close time in terms of input audio duration.
`↳ client_half_close_streaming_time_offset`	`Google\Protobuf\Duration` Client half close time in terms of API streaming duration.

getAudioDataChunks

Number of input audio data chunks in streaming requests.

Returns
Type	Description
`int`

setAudioDataChunks

Number of input audio data chunks in streaming requests.

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getResultEndTimeOffset

Time offset of the end of speech utterance relative to the beginning of the first audio chunk.

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

hasResultEndTimeOffset

clearResultEndTimeOffset

setResultEndTimeOffset

Time offset of the end of speech utterance relative to the beginning of the first audio chunk.

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

Returns
Type	Description
`$this`

getFirstAudioDuration

Duration of first audio chunk.

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

hasFirstAudioDuration

clearFirstAudioDuration

setFirstAudioDuration

Duration of first audio chunk.

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

Returns
Type	Description
`$this`

getSingleUtterance

Whether client used single utterance mode.

Returns
Type	Description
`bool`

setSingleUtterance

Whether client used single utterance mode.

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`

getSpeechPartialResultsEndTimes

Time offsets of the speech partial results relative to the beginning of the stream.

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setSpeechPartialResultsEndTimes

Time offsets of the speech partial results relative to the beginning of the stream.

Parameter
Name	Description
`var`	`array<Google\Protobuf\Duration>`

Returns
Type	Description
`$this`

getSpeechFinalResultsEndTimes

Time offsets of the speech final results (is_final=true) relative to the beginning of the stream.

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setSpeechFinalResultsEndTimes

Time offsets of the speech final results (is_final=true) relative to the beginning of the stream.

Parameter
Name	Description
`var`	`array<Google\Protobuf\Duration>`

Returns
Type	Description
`$this`

getPartialResponses

Total number of partial responses.

Returns
Type	Description
`int`

setPartialResponses

Total number of partial responses.

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getSpeakerIdPassiveLatencyMsOffset

Time offset of Speaker ID stream close time relative to the Speech stream close time in milliseconds. Only meaningful for conversations involving passive verification.

Returns
Type	Description
`int`

setSpeakerIdPassiveLatencyMsOffset

Time offset of Speaker ID stream close time relative to the Speech stream close time in milliseconds. Only meaningful for conversations involving passive verification.

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getBargeinEventTriggered

Whether a barge-in event is triggered in this request.

Returns
Type	Description
`bool`

setBargeinEventTriggered

Whether a barge-in event is triggered in this request.

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`

getSpeechSingleUtterance

Whether speech uses single utterance mode.

Returns
Type	Description
`bool`

setSpeechSingleUtterance

Whether speech uses single utterance mode.

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`

getDtmfPartialResultsTimes

Time offsets of the DTMF partial results relative to the beginning of the stream.

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setDtmfPartialResultsTimes

Time offsets of the DTMF partial results relative to the beginning of the stream.

Parameter
Name	Description
`var`	`array<Google\Protobuf\Duration>`

Returns
Type	Description
`$this`

getDtmfFinalResultsTimes

Time offsets of the DTMF final results relative to the beginning of the stream.

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setDtmfFinalResultsTimes

Time offsets of the DTMF final results relative to the beginning of the stream.

Parameter
Name	Description
`var`	`array<Google\Protobuf\Duration>`

Returns
Type	Description
`$this`

getSingleUtteranceEndTimeOffset

Time offset of the end-of-single-utterance signal relative to the beginning of the stream.

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

hasSingleUtteranceEndTimeOffset

clearSingleUtteranceEndTimeOffset

setSingleUtteranceEndTimeOffset

Time offset of the end-of-single-utterance signal relative to the beginning of the stream.

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

Returns
Type	Description
`$this`

getNoSpeechTimeout

No speech timeout settings for the stream.

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

hasNoSpeechTimeout

clearNoSpeechTimeout

setNoSpeechTimeout

No speech timeout settings for the stream.

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

Returns
Type	Description
`$this`

getEndpointingTimeout

Speech endpointing timeout settings for the stream.

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

hasEndpointingTimeout

clearEndpointingTimeout

setEndpointingTimeout

Speech endpointing timeout settings for the stream.

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

Returns
Type	Description
`$this`

getIsInputText

Whether the streaming terminates with an injected text query.

Returns
Type	Description
`bool`

setIsInputText

Whether the streaming terminates with an injected text query.

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`

getClientHalfCloseTimeOffset

Client half close time in terms of input audio duration.

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

hasClientHalfCloseTimeOffset

clearClientHalfCloseTimeOffset

setClientHalfCloseTimeOffset

Client half close time in terms of input audio duration.

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

Returns
Type	Description
`$this`

getClientHalfCloseStreamingTimeOffset

Client half close time in terms of API streaming duration.

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

hasClientHalfCloseStreamingTimeOffset

clearClientHalfCloseStreamingTimeOffset

setClientHalfCloseStreamingTimeOffset

Client half close time in terms of API streaming duration.

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

Returns
Type	Description
`$this`