Skip to content

Commit b64dbea

Browse files
authored
Update README.md (#239)
1 parent 2db598c commit b64dbea

File tree

1 file changed

+14
-19
lines changed

1 file changed

+14
-19
lines changed

README.md

Lines changed: 14 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -30,15 +30,16 @@ API reference documentation is available [here](https://dev.hume.ai/reference/).
3030

3131
The Hume Python SDK is compatible across several Python versions and operating systems.
3232

33-
- For the Empathic Voice Interface, Python versions `3.9` through `3.11` are supported on macOS and Linux.
34-
35-
- For Expression Measurement, Python versions `3.9` through `3.12` are supported on macOS, Linux, and Windows.
33+
- For the [Empathic Voice Interface](https://dev.hume.ai/docs/empathic-voice-interface-evi/overview), Python versions `3.9` through `3.11` are supported on macOS and Linux.
34+
- For [Text-to-speech (TTS)](https://dev.hume.ai/docs/text-to-speech-tts/overview), Python versions `3.9` through `3.12` are supported on macOS, Linux, and Windows.
35+
- For [Expression Measurement](https://dev.hume.ai/docs/expression-measurement/overview), Python versions `3.9` through `3.12` are supported on macOS, Linux, and Windows.
3636

3737
Below is a table which shows the version and operating system compatibilities by product:
3838

3939
| | Python Version | Operating System |
4040
| ------------------------ | ----------------------------- | --------------------- |
4141
| Empathic Voice Interface | `3.9`, `3.10`, `3.11` | macOS, Linux |
42+
| Text-to-speech (TTS) | `3.9`, `3.10`, `3.11`, `3.12` | macOS, Linux, Windows |
4243
| Expression Measurement | `3.9`, `3.10`, `3.11`, `3.12` | macOS, Linux, Windows |
4344

4445
## Installation
@@ -47,16 +48,16 @@ Below is a table which shows the version and operating system compatibilities by
4748
pip install hume
4849
# or
4950
poetry add hume
51+
# or
52+
uv add hume
5053
```
5154

5255
## Other Resources
5356

5457
```python
5558
from hume.client import HumeClient
5659

57-
client = HumeClient(
58-
api_key="YOUR_API_KEY", # Defaults to HUME_API_KEY
59-
)
60+
client = HumeClient(api_key="YOUR_API_KEY")
6061
client.empathic_voice.configs.list_configs()
6162
```
6263

@@ -69,9 +70,7 @@ import asyncio
6970

7071
from hume.client import AsyncHumeClient
7172

72-
client = AsyncHumeClient(
73-
api_key="YOUR_API_KEY",
74-
)
73+
client = AsyncHumeClient(api_key="YOUR_API_KEY")
7574

7675
async def main() -> None:
7776
await client.empathic_voice.configs.list_configs()
@@ -112,22 +111,20 @@ config = client.empathic_voice.configs.get_config_version(
112111

113112
## Namespaces
114113

115-
This SDK contains the APIs for expression measurement, empathic voice and custom models. Even
114+
This SDK contains the APIs for empathic voice, tts, and expression measurement. Even
116115
if you do not plan on using more than one API to start, the SDK provides easy access in
117-
case you find additional APIs in the future.
116+
case you would like to use additional APIs in the future.
118117

119118
Each API is namespaced accordingly:
120119

121120
```python
122121
from hume.client import HumeClient
123122

124-
client = HumeClient(
125-
api_key="YOUR_API_KEY",
126-
)
127-
128-
client.expression_measurement. # APIs specific to Expression Measurement
123+
client = HumeClient(api_key="YOUR_API_KEY")
129124

130125
client.emapthic_voice. # APIs specific to Empathic Voice
126+
client.tts. # APIs specific to Text-to-speech
127+
client.expression_measurement. # APIs specific to Expression Measurement
131128
```
132129

133130
## Exception Handling
@@ -151,9 +148,7 @@ Paginated requests will return a `SyncPager` or `AsyncPager`, which can be used
151148
```python
152149
import hume.client
153150

154-
client = HumeClient(
155-
api_key="YOUR_API_KEY",
156-
)
151+
client = HumeClient(api_key="YOUR_API_KEY")
157152

158153
for tool in client.empathic_voice.tools.list_tools():
159154
print(tool)

0 commit comments

Comments
 (0)