{"openapi":"3.1.0","info":{"title":"OwlEars Proxy Service for ThinkOwl","description":"<CENTER><img src=\"/static/owlears-proxy.png\"></CENTER><BR>\n                  The OwlEars-Proxy Service is used to combine realtime\n                  transcription alongside realtime translation. It uses\n                  owlears-transcription and babelbird-translation to achieve\n                  this goal.<BR>\n                  Furthermore this service is able to handle realtime updates\n                  of text that is produced. Unfortunately the semantics change\n                  as the realtime audio is coming in. This is due to the fact\n                  that the words are not yet complete and the meaning of the\n                  sentence is not yet clear. Therefore the service is able\n                  to handle updates of the text that is produced. This is done\n                  by sending a new request to the service with the same\n                  input but appended context.\n                  ","contact":{"url":"http://www.thinkowl.com/"},"license":{"name":"ThinkOwl Usage License","url":"http://www.thinkowl.com/"},"version":"v1"},"paths":{"/metrics":{"get":{"summary":"Combined Metrics","description":"Expose combined metrics from the local instrumentator and the external server.","operationId":"combined_metrics_metrics_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/owlears-proxy/v1/debug_callback":{"post":{"summary":"Debug Callback","description":"Logs the given JSON data as a string and returns a success message.\n\nArgs:\n    json_data (dict): The JSON data to be logged.\n\nReturns:\n    dict: A dictionary containing a success message.","operationId":"debug_callback_owlears_proxy_v1_debug_callback_post","requestBody":{"content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","title":"Json Data"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/owlears-proxy/v1/transcribe":{"get":{"summary":"Transcribe (WEBSOCKET)","description":"This endpoint is used to transcribe audio in realtime. It is used to combine the\ntranscription with the translation. The translation is done by babelbird-translation.\n\n:param ws_from_client: WebSocket object\n:param auth_token: Optional authentication token string\n:param language (deprecated): Legacy language selector. `auto` means language detection enabled; any other value fixes the language and disables language detection. Must not be combined with `initial_language` or `do_language_detection`.\n:param initial_language: Initial language code used at session start. If `language` is not used and this is omitted, service default is used. `\"auto\"` is not allowed here.\n:param do_language_detection: Enables/disables language detection while transcribing. If omitted and `language` is not used, defaults to `True`.\n:param destination_language: Optional destination language string\n:param audio_format: Audio format string\n:param callback_url: Optional callback URL string\n:param session_id: Optional session ID string, if it is none a new session ID (uuid4) is generated\n:param translate: Whether incoming segments should be translated.\n:param emit_nonfinal: owlears configuration parameter\n:param treat_semi_final_as_final: owlears configuration parameter\n:param min_silence: owlears configuration parameter\n:param emit_debug: owlears configuration parameter\n:param transcriber: owlears configuration parameter\n:return: None","operationId":"transcribe_owlears_proxy_v1_transcribe_get","parameters":[{"name":"auth_token","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Auth Token"}},{"name":"tenant","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"default":"ccw","title":"Tenant"}},{"name":"desk","in":"query","required":false,"schema":{"type":"string","default":"634d0027-c1d3-4df9-a260-25aef788e9f8","title":"Desk"}},{"name":"language","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Language"}},{"name":"initial_language","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Initial Language"}},{"name":"destination_language","in":"query","required":false,"schema":{"type":"string","title":"Destination Language"}},{"name":"do_language_detection","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Do Language Detection"}},{"name":"do_text_language_detection","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Do Text Language Detection"}},{"name":"audio_format","in":"query","required":false,"schema":{"type":"string","default":"auto","title":"Audio Format"}},{"name":"callback_url","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Callback Url"}},{"name":"session_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Session Id"}},{"name":"translate","in":"query","required":false,"schema":{"type":"boolean","default":true,"title":"Translate"}},{"name":"emit_nonfinal","in":"query","required":false,"schema":{"type":"boolean","title":"Emit Nonfinal"}},{"name":"treat_semi_final_as_final","in":"query","required":false,"schema":{"type":"boolean","title":"Treat Semi Final As Final"}},{"name":"min_silence","in":"query","required":false,"schema":{"type":"number","title":"Min Silence"}},{"name":"emit_debug","in":"query","required":false,"schema":{"type":"boolean","title":"Emit Debug"}},{"name":"transcriber","in":"query","required":false,"schema":{"type":"string","title":"Transcriber"}},{"name":"emit_speech_events","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Emit Speech Events"}},{"name":"emit_countdown_events","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Emit Countdown Events"}},{"name":"start_countdown_after","in":"query","required":false,"schema":{"type":"number","default":0.1,"title":"Start Countdown After"}},{"name":"use_context","in":"query","required":false,"schema":{"type":"boolean","default":true,"title":"Use Context"}},{"name":"multi_translate","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Multi Translate"}},{"name":"secondary_destination_language","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[],"title":"Secondary Destination Language"}},{"name":"auto_update_secondary_languages","in":"query","required":false,"schema":{"type":"boolean","default":true,"title":"Auto Update Secondary Languages"}},{"name":"align_to_sentences","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Align To Sentences"}},{"name":"max_secondary_languages","in":"query","required":false,"schema":{"type":"integer","default":1,"title":"Max Secondary Languages"}}],"responses":{"101":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}