docs: add return types in docstring for transcribe and run function (d…

…eepset-ai#6177)
OwaisAzad · Oct 28, 2023 · 3f3d2c3 · 3f3d2c3
1 parent 8a2a3c9
commit 3f3d2c3
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/haystack/nodes/audio/whisper_transcriber.py b/haystack/nodes/audio/whisper_transcriber.py
@@ -91,6 +91,7 @@ def transcribe(
         :param return_segments: If True, returns the transcription for each segment of the audio file. Supported with
         local installation of whisper only.
         :param translate: If True, translates the transcription to English.
+        :return: A dictionary containing the transcription text and metadata like timings, segments etc.
 
         """
         transcript: Dict[str, Any] = {}
@@ -176,6 +177,8 @@ def run(
         :param labels: Ignored
         :param documents: Ignored
         :param meta: Ignored
+        :return: A dictionary containing a list of Document objects, one for each input file.
+
         """
         transcribed_documents: List[Document] = []
         if file_paths: