ruipfmendes commented 1 year ago

Description

Why

The project I'm working on is using mod_dialogflow in the infrastructure of FreeSWITCH + Drachtio Server + a Drachtio App.
The goal at the moment is to abstract ourselves from using Dialogflow's platform as much as possible and we have automated most steps, however one issue we were having is that we would always have to go to each Agent/Flow 's page to enable TTS and optionally configure the output audio (in the Speech tab of https://dialogflow.cloud.google.com/#/editAgent/<projectId/ ).

By sending the OutputAudioConfig ( https://cloud.google.com/dialogflow/es/docs/reference/rpc/google.cloud.dialogflow.v2beta1#google.cloud.dialogflow.v2beta1.OutputAudioConfig ) parameter explicitly in the Streaming Detect Intent Request, the TTS is enabled without needing to do it on the Dialogflow platform page manually
If ANY parameter related to OutputAudioConfig is sent on the dialogflow_start command it will overwrite the manual configuration with this per-request configuration.

Tested with usages of "dialogflow_start" where the new fields were ignored to guarantee retro compatibility
- project-id of dialogflow-project-id:environment:region for example still works
Tested with a flow/agent that had TTS disabled in Dialogflow's platform page
- project-id of dialogflow-project-id:environment:region:speakingRate:pitch:volume:voice-name:voice-gender:effect

Observations

Our goal was for this to not be a breaking change
This implementation is a bit focused in our use case and parameterizing so many details like this may be confusing to new people who try to use mod_dialogflow, so if you believe it doesn't make sense to merge this into the main fork I completely understand and we will be maintaining our separate fork
It is possible in the future we add more parameters such as sentiment analysis ( https://github.com/drachtio/drachtio-freeswitch-modules/issues/85 ) if my team considers the effort to be justified but, again, it might add even more complexity to this repo

ruipfmendes commented 1 year ago

created PR by mistake will reopen later with more details as to why this was necessary for me

davehorton commented 1 year ago

ok well I am happy to have a PR if you feel these changes are generally useful ie wont' break anyone's use case

ruipfmendes commented 1 year ago

@davehorton when you can please give me your opinion on this :)