Skip to content

Made capitalization consistent #1229

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
leftmove wants to merge 2 commits into from
Closed

Made capitalization consistent #1229

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7bfabe4
changed params to parameters
leftmove Mar 12, 2024
3e9e851
Merge branch 'main' into readme-headers
leftmove Mar 14, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ we recommend using [python-dotenv](https://pypi.org/project/python-dotenv/)
to add `OPENAI_API_KEY="My API Key"` to your `.env` file
so that your API Key is not stored in source control.

## Async usage
## Async Usage

Simply import `AsyncOpenAI` instead of `OpenAI` and use `await` with each API call:

Expand Down Expand Up @@ -122,7 +122,7 @@ async def main():
asyncio.run(main())
```

## Module-level client
## Module-level Client

> [!IMPORTANT]
> We highly recommend instantiating client instances instead of relying on the global client.
Expand Down Expand Up @@ -162,7 +162,7 @@ We recommend that you always instantiate a client (e.g., with `client = OpenAI()
- It's harder to mock for testing purposes
- It's not possible to control cleanup of network connections

## Using types
## Using Types

Nested request parameters are [TypedDicts](https://docs.python.org/3/library/typing.html#typing.TypedDict). Responses are [Pydantic models](https://docs.pydantic.dev), which provide helper methods for things like:

Expand Down Expand Up @@ -242,7 +242,7 @@ for job in first_page.data:
# Remove `await` for non-async usage.
```

## Nested params
## Nested Parameters

Nested parameters are dictionaries, typed using `TypedDict`, for example:

Expand Down Expand Up @@ -281,7 +281,7 @@ client.files.create(

The async client uses the exact same interface. If you pass a [`PathLike`](https://docs.python.org/3/library/os.html#os.PathLike) instance, the file contents will be read asynchronously automatically.

## Handling errors
## Handling Errors

When the library is unable to connect to the API (for example, due to network connection problems or a timeout), a subclass of `openai.APIConnectionError` is raised.

Expand Down