Skip to content

Commit 7e7870e

Browse files
authored
Updates readme before release (#190)
1 parent 2572405 commit 7e7870e

File tree

2 files changed

+19
-9
lines changed

2 files changed

+19
-9
lines changed

README.md

Lines changed: 18 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,14 @@
1414
<br>
1515
</div>
1616

17+
## Migration Guide for Version 0.7.0
18+
19+
We've released version `0.7.0` of the SDK with significant architectural changes. This update introduces `AsyncHumeClient` and `HumeClient`, improves type safety and async support, and provides more granular configuration options. To help you transition, we've prepared a comprehensive migration guide:
20+
21+
**[View the Migration Guide](https://github.com/HumeAI/hume-python-sdk/wiki/Python-SDK-Migration-Guide)**
22+
23+
Please review this guide before updating, as it covers breaking changes and provides examples for updating your code. Legacy functionality is preserved for backward compatibility. If you have any questions, please open an issue or contact our support team.
24+
1725
## Documentation
1826

1927
API reference documentation is available [here](https://dev.hume.ai/reference/).
@@ -112,10 +120,10 @@ client.emapthic_voice. # APIs specific to Empathic Voice
112120
All errors thrown by the SDK will be subclasses of [`ApiError`](./src/hume/core/api_error.py).
113121

114122
```python
115-
import hume
123+
import hume.client
116124

117125
try:
118-
client.text_gen.create_chat_completion(...)
126+
client.expression_measurement.batch.get_job_predictions(...)
119127
except hume.core.ApiError as e: # Handle all errors
120128
print(e.status_code)
121129
print(e.body)
@@ -192,13 +200,14 @@ Use the `max_retries` request option to configure this behavior.
192200

193201
```python
194202
from hume.client import HumeClient
203+
from hume.core import RequestOptions
195204

196205
client = HumeClient(...)
197206

198207
# Override retries for a specific method
199-
client.text_gen.create_chat_completion(..., {
200-
max_retries=5
201-
})
208+
client.expression_measurement.batch.get_job_predictions(...,
209+
request_options=RequestOptions(max_retries=5)
210+
)
202211
```
203212

204213
#### Timeouts
@@ -208,16 +217,17 @@ timeout option at the client or request level.
208217

209218
```python
210219
from hume.client import HumeClient
220+
from hume.core import RequestOptions
211221

212222
client = HumeClient(
213223
# All timeouts are 20 seconds
214224
timeout=20.0,
215225
)
216226

217227
# Override timeout for a specific method
218-
client.text_gen.create_chat_completion(..., {
219-
timeout_in_seconds=20.0
220-
})
228+
client.expression_measurement.batch.get_job_predictions(...,
229+
request_options=RequestOptions(timeout_in_seconds=20)
230+
)
221231
```
222232

223233
#### Custom HTTP client

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[tool.poetry]
22
name = "hume"
3-
version = "0.6.1"
3+
version = "0.7.0"
44
description = "A Python SDK for Hume AI"
55
readme = "README.md"
66
authors = []

0 commit comments

Comments
 (0)