Skip to content

Commit a58a052

Browse files
authored
docs(readme): improve some wording (#1392)
fixed a few typos
1 parent c34cb64 commit a58a052

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

README.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ so that your API Key is not stored in source control.
5555

5656
When interacting with the API some actions such as starting a Run and adding files to vector stores are asynchronous and take time to complete. The SDK includes
5757
helper functions which will poll the status until it reaches a terminal state and then return the resulting object.
58-
If an API method results in an action which could benefit from polling there will be a corresponding version of the
58+
If an API method results in an action that could benefit from polling there will be a corresponding version of the
5959
method ending in '\_and_poll'.
6060

6161
For instance to create a Run and poll until it reaches a terminal state you can run:
@@ -71,7 +71,7 @@ More information on the lifecycle of a Run can be found in the [Run Lifecycle Do
7171

7272
### Bulk Upload Helpers
7373

74-
When creating an interacting with vector stores, you can use the polling helpers to monitor the status of operations.
74+
When creating and interacting with vector stores, you can use polling helpers to monitor the status of operations.
7575
For convenience, we also provide a bulk upload helper to allow you to simultaneously upload several files at once.
7676

7777
```python
@@ -85,7 +85,7 @@ batch = await client.vector_stores.file_batches.upload_and_poll(
8585

8686
### Streaming Helpers
8787

88-
The SDK also includes helpers to process streams and handle the incoming events.
88+
The SDK also includes helpers to process streams and handle incoming events.
8989

9090
```python
9191
with client.beta.threads.runs.stream(
@@ -201,7 +201,7 @@ completion = openai.chat.completions.create(
201201
print(completion.choices[0].message.content)
202202
```
203203

204-
The API is the exact same as the standard client instance based API.
204+
The API is the exact same as the standard client instance-based API.
205205

206206
This is intended to be used within REPLs or notebooks for faster iteration, **not** in application code.
207207

0 commit comments

Comments
 (0)