Configuration of the barge-in behavior. Barge-in instructs the API
to return a detected utterance at a proper time while the client is
playing back the response audio from a previous request. When the
client sees the utterance, it should stop the playback and
immediately get ready for receiving the responses for the current
request.
The barge-in handling requires the client to start streaming audio
input as soon as it starts playing back the audio from the previous
response. The playback is modeled into two phases:
No barge-in phase: which goes first and during which speech
detection should not be carried out.
Barge-in phase: which follows the no barge-in phase and during
which the API starts speech detection and may inform the client
that an utterance has been detected. Note that no-speech event is
not expected in this phase.
The client provides this configuration in terms of the durations of
those two phases. The durations are measured in terms of the audio
length from the start of the input audio.
No-speech event is a response with END_OF_UTTERANCE without any
transcript following up.
Attributes
Name
Description
no_barge_in_duration
google.protobuf.duration_pb2.Duration
Duration that is not eligible for barge-in at
the beginning of the input audio.
total_duration
google.protobuf.duration_pb2.Duration
Total duration for the playback at the
beginning of the input audio.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-28 UTC."],[],[],null,["# Class BargeInConfig (1.42.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.42.0 (latest)](/python/docs/reference/dialogflow-cx/latest/google.cloud.dialogflowcx_v3.types.BargeInConfig)\n- [1.41.1](/python/docs/reference/dialogflow-cx/1.41.1/google.cloud.dialogflowcx_v3.types.BargeInConfig)\n- [1.40.0](/python/docs/reference/dialogflow-cx/1.40.0/google.cloud.dialogflowcx_v3.types.BargeInConfig)\n- [1.39.0](/python/docs/reference/dialogflow-cx/1.39.0/google.cloud.dialogflowcx_v3.types.BargeInConfig)\n- [1.38.0](/python/docs/reference/dialogflow-cx/1.38.0/google.cloud.dialogflowcx_v3.types.BargeInConfig)\n- [1.37.0](/python/docs/reference/dialogflow-cx/1.37.0/google.cloud.dialogflowcx_v3.types.BargeInConfig)\n- [1.36.0](/python/docs/reference/dialogflow-cx/1.36.0/google.cloud.dialogflowcx_v3.types.BargeInConfig)\n- [1.35.0](/python/docs/reference/dialogflow-cx/1.35.0/google.cloud.dialogflowcx_v3.types.BargeInConfig)\n- [1.34.1](/python/docs/reference/dialogflow-cx/1.34.1/google.cloud.dialogflowcx_v3.types.BargeInConfig)\n- [1.33.0](/python/docs/reference/dialogflow-cx/1.33.0/google.cloud.dialogflowcx_v3.types.BargeInConfig)\n- [1.32.1](/python/docs/reference/dialogflow-cx/1.32.1/google.cloud.dialogflowcx_v3.types.BargeInConfig)\n- [1.31.1](/python/docs/reference/dialogflow-cx/1.31.1/google.cloud.dialogflowcx_v3.types.BargeInConfig)\n- [1.30.1](/python/docs/reference/dialogflow-cx/1.30.1/google.cloud.dialogflowcx_v3.types.BargeInConfig)\n- [1.29.0](/python/docs/reference/dialogflow-cx/1.29.0/google.cloud.dialogflowcx_v3.types.BargeInConfig)\n- [1.28.0](/python/docs/reference/dialogflow-cx/1.28.0/google.cloud.dialogflowcx_v3.types.BargeInConfig)\n- [1.27.0](/python/docs/reference/dialogflow-cx/1.27.0/google.cloud.dialogflowcx_v3.types.BargeInConfig)\n- [1.26.0](/python/docs/reference/dialogflow-cx/1.26.0/google.cloud.dialogflowcx_v3.types.BargeInConfig)\n- [1.25.0](/python/docs/reference/dialogflow-cx/1.25.0/google.cloud.dialogflowcx_v3.types.BargeInConfig)\n- [1.24.0](/python/docs/reference/dialogflow-cx/1.24.0/google.cloud.dialogflowcx_v3.types.BargeInConfig)\n- [1.23.1](/python/docs/reference/dialogflow-cx/1.23.1/google.cloud.dialogflowcx_v3.types.BargeInConfig)\n- [1.22.0](/python/docs/reference/dialogflow-cx/1.22.0/google.cloud.dialogflowcx_v3.types.BargeInConfig)\n- [1.21.0](/python/docs/reference/dialogflow-cx/1.21.0/google.cloud.dialogflowcx_v3.types.BargeInConfig)\n- [1.20.1](/python/docs/reference/dialogflow-cx/1.20.1/google.cloud.dialogflowcx_v3.types.BargeInConfig)\n- [1.19.0](/python/docs/reference/dialogflow-cx/1.19.0/google.cloud.dialogflowcx_v3.types.BargeInConfig)\n- [1.18.0](/python/docs/reference/dialogflow-cx/1.18.0/google.cloud.dialogflowcx_v3.types.BargeInConfig)\n- [1.17.1](/python/docs/reference/dialogflow-cx/1.17.1/google.cloud.dialogflowcx_v3.types.BargeInConfig)\n- [1.16.0](/python/docs/reference/dialogflow-cx/1.16.0/google.cloud.dialogflowcx_v3.types.BargeInConfig)\n- [1.15.0](/python/docs/reference/dialogflow-cx/1.15.0/google.cloud.dialogflowcx_v3.types.BargeInConfig)\n- [1.14.1](/python/docs/reference/dialogflow-cx/1.14.1/google.cloud.dialogflowcx_v3.types.BargeInConfig)\n- [1.13.5](/python/docs/reference/dialogflow-cx/1.13.5/google.cloud.dialogflowcx_v3.types.BargeInConfig)\n- [1.12.1](/python/docs/reference/dialogflow-cx/1.12.1/google.cloud.dialogflowcx_v3.types.BargeInConfig)\n- [1.11.0](/python/docs/reference/dialogflow-cx/1.11.0/google.cloud.dialogflowcx_v3.types.BargeInConfig)\n- [1.10.0](/python/docs/reference/dialogflow-cx/1.10.0/google.cloud.dialogflowcx_v3.types.BargeInConfig)\n- [1.9.1](/python/docs/reference/dialogflow-cx/1.9.1/google.cloud.dialogflowcx_v3.types.BargeInConfig)\n- [1.8.0](/python/docs/reference/dialogflow-cx/1.8.0/google.cloud.dialogflowcx_v3.types.BargeInConfig)\n- [1.7.0](/python/docs/reference/dialogflow-cx/1.7.0/google.cloud.dialogflowcx_v3.types.BargeInConfig)\n- [1.6.0](/python/docs/reference/dialogflow-cx/1.6.0/google.cloud.dialogflowcx_v3.types.BargeInConfig)\n- [1.5.0](/python/docs/reference/dialogflow-cx/1.5.0/google.cloud.dialogflowcx_v3.types.BargeInConfig)\n- [1.4.0](/python/docs/reference/dialogflow-cx/1.4.0/google.cloud.dialogflowcx_v3.types.BargeInConfig)\n- [1.3.2](/python/docs/reference/dialogflow-cx/1.3.2/google.cloud.dialogflowcx_v3.types.BargeInConfig)\n- [1.2.0](/python/docs/reference/dialogflow-cx/1.2.0/google.cloud.dialogflowcx_v3.types.BargeInConfig)\n- [1.1.1](/python/docs/reference/dialogflow-cx/1.1.1/google.cloud.dialogflowcx_v3.types.BargeInConfig)\n- [1.0.0](/python/docs/reference/dialogflow-cx/1.0.0/google.cloud.dialogflowcx_v3.types.BargeInConfig)\n- [0.8.2](/python/docs/reference/dialogflow-cx/0.8.2/google.cloud.dialogflowcx_v3.types.BargeInConfig)\n- [0.7.1](/python/docs/reference/dialogflow-cx/0.7.1/google.cloud.dialogflowcx_v3.types.BargeInConfig)\n- [0.6.0](/python/docs/reference/dialogflow-cx/0.6.0/google.cloud.dialogflowcx_v3.types.BargeInConfig)\n- [0.5.0](/python/docs/reference/dialogflow-cx/0.5.0/google.cloud.dialogflowcx_v3.types.BargeInConfig)\n- [0.4.1](/python/docs/reference/dialogflow-cx/0.4.1/google.cloud.dialogflowcx_v3.types.BargeInConfig)\n- [0.3.0](/python/docs/reference/dialogflow-cx/0.3.0/google.cloud.dialogflowcx_v3.types.BargeInConfig)\n- [0.2.0](/python/docs/reference/dialogflow-cx/0.2.0/google.cloud.dialogflowcx_v3.types.BargeInConfig)\n- [0.1.1](/python/docs/reference/dialogflow-cx/0.1.1/google.cloud.dialogflowcx_v3.types.BargeInConfig) \n\n BargeInConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)\n\nConfiguration of the barge-in behavior. Barge-in instructs the API\nto return a detected utterance at a proper time while the client is\nplaying back the response audio from a previous request. When the\nclient sees the utterance, it should stop the playback and\nimmediately get ready for receiving the responses for the current\nrequest.\n\nThe barge-in handling requires the client to start streaming audio\ninput as soon as it starts playing back the audio from the previous\nresponse. The playback is modeled into two phases:\n\n- No barge-in phase: which goes first and during which speech\n detection should not be carried out.\n\n- Barge-in phase: which follows the no barge-in phase and during\n which the API starts speech detection and may inform the client\n that an utterance has been detected. Note that no-speech event is\n not expected in this phase.\n\nThe client provides this configuration in terms of the durations of\nthose two phases. The durations are measured in terms of the audio\nlength from the start of the input audio.\n\nNo-speech event is a response with END_OF_UTTERANCE without any\ntranscript following up."]]