Reference documentation and code samples for the Dialogflow CX V3 API class Google::Cloud::Dialogflow::CX::V3::BargeInConfig.
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.
[[["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-09-04 UTC."],[],[],null,["# Dialogflow CX V3 API - Class Google::Cloud::Dialogflow::CX::V3::BargeInConfig (v1.8.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.8.0 (latest)](/ruby/docs/reference/google-cloud-dialogflow-cx-v3/latest/Google-Cloud-Dialogflow-CX-V3-BargeInConfig)\n- [1.7.0](/ruby/docs/reference/google-cloud-dialogflow-cx-v3/1.7.0/Google-Cloud-Dialogflow-CX-V3-BargeInConfig)\n- [1.6.1](/ruby/docs/reference/google-cloud-dialogflow-cx-v3/1.6.1/Google-Cloud-Dialogflow-CX-V3-BargeInConfig)\n- [1.5.0](/ruby/docs/reference/google-cloud-dialogflow-cx-v3/1.5.0/Google-Cloud-Dialogflow-CX-V3-BargeInConfig)\n- [1.4.0](/ruby/docs/reference/google-cloud-dialogflow-cx-v3/1.4.0/Google-Cloud-Dialogflow-CX-V3-BargeInConfig)\n- [1.3.0](/ruby/docs/reference/google-cloud-dialogflow-cx-v3/1.3.0/Google-Cloud-Dialogflow-CX-V3-BargeInConfig)\n- [1.2.0](/ruby/docs/reference/google-cloud-dialogflow-cx-v3/1.2.0/Google-Cloud-Dialogflow-CX-V3-BargeInConfig)\n- [1.1.1](/ruby/docs/reference/google-cloud-dialogflow-cx-v3/1.1.1/Google-Cloud-Dialogflow-CX-V3-BargeInConfig)\n- [1.0.0](/ruby/docs/reference/google-cloud-dialogflow-cx-v3/1.0.0/Google-Cloud-Dialogflow-CX-V3-BargeInConfig)\n- [0.26.0](/ruby/docs/reference/google-cloud-dialogflow-cx-v3/0.26.0/Google-Cloud-Dialogflow-CX-V3-BargeInConfig)\n- [0.25.0](/ruby/docs/reference/google-cloud-dialogflow-cx-v3/0.25.0/Google-Cloud-Dialogflow-CX-V3-BargeInConfig)\n- [0.24.2](/ruby/docs/reference/google-cloud-dialogflow-cx-v3/0.24.2/Google-Cloud-Dialogflow-CX-V3-BargeInConfig)\n- [0.23.0](/ruby/docs/reference/google-cloud-dialogflow-cx-v3/0.23.0/Google-Cloud-Dialogflow-CX-V3-BargeInConfig)\n- [0.22.0](/ruby/docs/reference/google-cloud-dialogflow-cx-v3/0.22.0/Google-Cloud-Dialogflow-CX-V3-BargeInConfig)\n- [0.21.0](/ruby/docs/reference/google-cloud-dialogflow-cx-v3/0.21.0/Google-Cloud-Dialogflow-CX-V3-BargeInConfig)\n- [0.20.0](/ruby/docs/reference/google-cloud-dialogflow-cx-v3/0.20.0/Google-Cloud-Dialogflow-CX-V3-BargeInConfig)\n- [0.19.0](/ruby/docs/reference/google-cloud-dialogflow-cx-v3/0.19.0/Google-Cloud-Dialogflow-CX-V3-BargeInConfig)\n- [0.18.0](/ruby/docs/reference/google-cloud-dialogflow-cx-v3/0.18.0/Google-Cloud-Dialogflow-CX-V3-BargeInConfig)\n- [0.17.0](/ruby/docs/reference/google-cloud-dialogflow-cx-v3/0.17.0/Google-Cloud-Dialogflow-CX-V3-BargeInConfig)\n- [0.16.0](/ruby/docs/reference/google-cloud-dialogflow-cx-v3/0.16.0/Google-Cloud-Dialogflow-CX-V3-BargeInConfig)\n- [0.15.1](/ruby/docs/reference/google-cloud-dialogflow-cx-v3/0.15.1/Google-Cloud-Dialogflow-CX-V3-BargeInConfig)\n- [0.14.0](/ruby/docs/reference/google-cloud-dialogflow-cx-v3/0.14.0/Google-Cloud-Dialogflow-CX-V3-BargeInConfig)\n- [0.13.0](/ruby/docs/reference/google-cloud-dialogflow-cx-v3/0.13.0/Google-Cloud-Dialogflow-CX-V3-BargeInConfig)\n- [0.12.0](/ruby/docs/reference/google-cloud-dialogflow-cx-v3/0.12.0/Google-Cloud-Dialogflow-CX-V3-BargeInConfig)\n- [0.11.0](/ruby/docs/reference/google-cloud-dialogflow-cx-v3/0.11.0/Google-Cloud-Dialogflow-CX-V3-BargeInConfig)\n- [0.10.2](/ruby/docs/reference/google-cloud-dialogflow-cx-v3/0.10.2/Google-Cloud-Dialogflow-CX-V3-BargeInConfig)\n- [0.9.0](/ruby/docs/reference/google-cloud-dialogflow-cx-v3/0.9.0/Google-Cloud-Dialogflow-CX-V3-BargeInConfig)\n- [0.8.1](/ruby/docs/reference/google-cloud-dialogflow-cx-v3/0.8.1/Google-Cloud-Dialogflow-CX-V3-BargeInConfig)\n- [0.7.1](/ruby/docs/reference/google-cloud-dialogflow-cx-v3/0.7.1/Google-Cloud-Dialogflow-CX-V3-BargeInConfig)\n- [0.6.0](/ruby/docs/reference/google-cloud-dialogflow-cx-v3/0.6.0/Google-Cloud-Dialogflow-CX-V3-BargeInConfig)\n- [0.5.0](/ruby/docs/reference/google-cloud-dialogflow-cx-v3/0.5.0/Google-Cloud-Dialogflow-CX-V3-BargeInConfig)\n- [0.4.0](/ruby/docs/reference/google-cloud-dialogflow-cx-v3/0.4.0/Google-Cloud-Dialogflow-CX-V3-BargeInConfig) \nReference documentation and code samples for the Dialogflow CX V3 API class Google::Cloud::Dialogflow::CX::V3::BargeInConfig.\n\nConfiguration of the barge-in behavior. Barge-in instructs the API to return\na detected utterance at a proper time while the client is playing back the\nresponse audio from a previous request. When the client sees the\nutterance, it should stop the playback and immediately get ready for\nreceiving the responses for the current request.\n\n\nThe barge-in handling requires the client to start streaming audio input\nas soon as it starts playing back the audio from the previous response. The\nplayback is modeled into two phases:\n\n- No barge-in phase: which goes first and during which speech detection\n should not be carried out.\n\n- Barge-in phase: which follows the no barge-in phase and during which\n the API starts speech detection and may inform the client that an utterance\n has been detected. Note that no-speech event is not expected in this\n phase.\n\nThe client provides this configuration in terms of the durations of those\ntwo phases. The durations are measured in terms of the audio length from the\nstart of the input audio.\n\n\u003cbr /\u003e\n\nNo-speech event is a response with END_OF_UTTERANCE without any transcript\nfollowing up. \n\nInherits\n--------\n\n- Object \n\nExtended By\n-----------\n\n- Google::Protobuf::MessageExts::ClassMethods \n\nIncludes\n--------\n\n- Google::Protobuf::MessageExts\n\nMethods\n-------\n\n### #no_barge_in_duration\n\n def no_barge_in_duration() -\u003e ::Google::Protobuf::Duration\n\n**Returns**\n\n- ([::Google::Protobuf::Duration](./Google-Protobuf-Duration)) --- Duration that is not eligible for barge-in at the beginning of the input audio.\n\n### #no_barge_in_duration=\n\n def no_barge_in_duration=(value) -\u003e ::Google::Protobuf::Duration\n\n**Parameter**\n\n- **value** ([::Google::Protobuf::Duration](./Google-Protobuf-Duration)) --- Duration that is not eligible for barge-in at the beginning of the input audio. \n**Returns**\n\n- ([::Google::Protobuf::Duration](./Google-Protobuf-Duration)) --- Duration that is not eligible for barge-in at the beginning of the input audio.\n\n### #total_duration\n\n def total_duration() -\u003e ::Google::Protobuf::Duration\n\n**Returns**\n\n- ([::Google::Protobuf::Duration](./Google-Protobuf-Duration)) --- Total duration for the playback at the beginning of the input audio.\n\n### #total_duration=\n\n def total_duration=(value) -\u003e ::Google::Protobuf::Duration\n\n**Parameter**\n\n- **value** ([::Google::Protobuf::Duration](./Google-Protobuf-Duration)) --- Total duration for the playback at the beginning of the input audio. \n**Returns**\n\n- ([::Google::Protobuf::Duration](./Google-Protobuf-Duration)) --- Total duration for the playback at the beginning of the input audio."]]