Skip to content

Commit f4427b6

Browse files
committed
fix(docs): cleanup README.md
1 parent 1fc6b78 commit f4427b6

1 file changed

Lines changed: 13 additions & 14 deletions

File tree

README.md

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -19,12 +19,10 @@ The REST API documentation can be found on [docs.lmnt.com](https://docs.lmnt.com
1919
## Installation
2020

2121
```sh
22+
# install from PyPI
2223
pip install lmnt
2324
```
2425

25-
> [!NOTE]
26-
> Once this package is [published to PyPI](https://www.stainless.com/docs/guides/publish), this will become: `pip install --pre lmnt`
27-
2826
## Usage
2927

3028
The full API of this library can be found in [api.md](api.md).
@@ -39,7 +37,7 @@ client = Lmnt(
3937

4038
response = client.speech.generate(
4139
text="hello world.",
42-
voice="ava",
40+
voice="leah",
4341
)
4442
```
4543

@@ -65,7 +63,7 @@ client = AsyncLmnt(
6563
async def main() -> None:
6664
response = await client.speech.generate(
6765
text="hello world.",
68-
voice="ava",
66+
voice="leah",
6967
)
7068

7169

@@ -99,7 +97,7 @@ async def main() -> None:
9997
) as client:
10098
response = await client.speech.generate(
10199
text="hello world.",
102-
voice="ava",
100+
voice="leah",
103101
)
104102

105103

@@ -125,9 +123,10 @@ from lmnt import Lmnt
125123

126124
client = Lmnt()
127125

128-
client.speech.convert(
129-
audio=Path("/path/to/file"),
130-
voice="ava",
126+
client.voices.create(
127+
name="My Voice",
128+
files=[Path("sample1.wav"), Path("sample2.wav")],
129+
enhance=False,
131130
)
132131
```
133132

@@ -151,7 +150,7 @@ client = Lmnt()
151150
try:
152151
client.speech.generate(
153152
text="hello world.",
154-
voice="ava",
153+
voice="leah",
155154
)
156155
except lmnt.APIConnectionError as e:
157156
print("The server could not be reached")
@@ -197,7 +196,7 @@ client = Lmnt(
197196
# Or, configure per-request:
198197
client.with_options(max_retries=5).speech.generate(
199198
text="hello world.",
200-
voice="ava",
199+
voice="leah",
201200
)
202201
```
203202

@@ -223,7 +222,7 @@ client = Lmnt(
223222
# Override per-request:
224223
client.with_options(timeout=5.0).speech.generate(
225224
text="hello world.",
226-
voice="ava",
225+
voice="leah",
227226
)
228227
```
229228

@@ -267,7 +266,7 @@ from lmnt import Lmnt
267266
client = Lmnt()
268267
response = client.speech.with_raw_response.generate(
269268
text="hello world.",
270-
voice="ava",
269+
voice="leah",
271270
)
272271
print(response.headers.get('X-My-Header'))
273272

@@ -288,7 +287,7 @@ To stream the response body, use `.with_streaming_response` instead, which requi
288287
```python
289288
with client.speech.with_streaming_response.generate(
290289
text="hello world.",
291-
voice="ava",
290+
voice="leah",
292291
) as response:
293292
print(response.headers.get("X-My-Header"))
294293

0 commit comments

Comments
 (0)