Docstring changes and updates (#74)

Author: jamesathume

docs/index.md

@@ -29,11 +29,12 @@ Jupyter example notebooks can be found in the [Python SDK GitHub repo](https://g
 ```python
 from hume import HumeBatchClient
 from hume.models.config import FaceConfig
+from hume.models.config import ProsodyConfig
 
 client = HumeBatchClient("<your-api-key>")
-urls = ["https://tinyurl.com/hume-img"]
-config = FaceConfig(identify_faces=True)
-job = client.submit_job(urls, [config])
+urls = ["https://storage.googleapis.com/hume-test-data/video/armisen-clip.mp4"]
+configs = [FaceConfig(identify_faces=True), ProsodyConfig()]
+job = client.submit_job(urls, configs)
 
 print(job)
 print("Running...")
@@ -69,13 +70,14 @@ print(job)
 import asyncio
 
 from hume import HumeStreamClient
-from hume.models.config import FaceConfig
+from hume.models.config import BurstConfig
+from hume.models.config import ProsodyConfig
 
 async def main():
     client = HumeStreamClient("<your-api-key>")
-    config = FaceConfig(identify_faces=True)
-    async with client.connect([config]) as socket:
-        result = await socket.send_file("<your-image-filepath>")
+    configs = [BurstConfig(), ProsodyConfig()]
+    async with client.connect(configs) as socket:
+        result = await socket.send_file("<your-audio-filepath>")
         print(result)
 
 asyncio.run(main())

hume/_batch/hume_batch_client.py

@@ -22,11 +22,12 @@ class HumeBatchClient(ClientBase):
         ```python
         from hume import HumeBatchClient
         from hume.models.config import FaceConfig
+        from hume.models.config import ProsodyConfig
 
         client = HumeBatchClient("<your-api-key>")
-        urls = ["https://tinyurl.com/hume-img"]
-        config = FaceConfig(identify_faces=True)
-        job = client.submit_job(urls, [config])
+        urls = ["https://storage.googleapis.com/hume-test-data/video/armisen-clip.mp4"]
+        configs = [FaceConfig(identify_faces=True), ProsodyConfig()]
+        job = client.submit_job(urls, configs)
 
         print(job)
         print("Running...")

hume/_stream/hume_stream_client.py

@@ -23,14 +23,15 @@ class HumeStreamClient(ClientBase):
         ```python
         import asyncio
 
-        from hume import HumeStreamClient, StreamSocket
-        from hume.models.config import FaceConfig
+        from hume import HumeStreamClient
+        from hume.models.config import BurstConfig
+        from hume.models.config import ProsodyConfig
 
         async def main():
             client = HumeStreamClient("<your-api-key>")
-            config = FaceConfig(identify_faces=True)
-            async with client.connect([config]) as socket:
-                result = await socket.send_file("<your-image-filepath>")
+            configs = [BurstConfig(), ProsodyConfig()]
+            async with client.connect(configs) as socket:
+                result = await socket.send_file("<your-audio-filepath>")
                 print(result)
 
         asyncio.run(main())

hume/_stream/stream_socket.py

@@ -106,7 +106,7 @@ async def send_text(self, text: str) -> Any:
         return await self._send_payload(payload)
 
     async def send_facemesh(self, landmarks: List[List[List[float]]]) -> Any:
-        """Send text on the `StreamSocket`.
+        """Send facemesh landmarks on the `StreamSocket`.
 
         Note: This method is intended for use with a `FacemeshConfig`.
             When the socket is configured for other modalities this method will fail.