Skip to content

Commit 9b47651

Browse files
committed
minor clarity edits
1 parent be99ad1 commit 9b47651

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

docs/reference/include/openai_init.py

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,23 +5,23 @@
55
to call the [OpenAI REST API](https://platform.openai.com/docs/api-reference). It inclues modules for working with OpenAI
66
resources that provide access to its AI [models](https://platform.openai.com/docs/models),
77
including large language models (LLMs) like GPT-4 and models for working with images and audio. The `openai` package
8-
provides both synchronous and asynchronous API clients, their configuration options, and modules that provide the API
9-
surface for interacting with the services in the OpenAI platform.
8+
provides both synchronous and asynchronous API clients, options to configure their behavior, and modules that provide
9+
Python code with an API surface to interact with the OpenAI platform.
1010
1111
To get started, check out the documentation for the module representing the [resource][src.openai.resources] you're interested in using for your
1212
project. For example, the [`resources.chat.completions`][src.openai.resources.chat.completions] module is what you'd use
1313
for conversational chat-style interactions with an LLM like [GPT-4 Turbo](https://platform.openai.com/docs/models/gpt-4-and-gpt-4-turbo).
14-
Or, maybe you want the [`resources.audio`][src.openai.resources.audio] module for performing audio transcription, translation, and
14+
Or, maybe you need the [`resources.audio`][src.openai.resources.audio] module for performing audio transcription, translation, and
1515
speech synthesis in your app.
1616
17-
The documentation for the library's main client classes, [`OpenAI`][src.openai.OpenAI] and
18-
[`AsyncOpenAI`][src.openai.AsyncOpenAI], is another good place to start. Those clients are the primary contact points for
19-
your code working with any of the resources available on OpenAI API endpoints.
17+
Documentation for the library's main API client classes, [`OpenAI`][src.openai.OpenAI] and
18+
[`AsyncOpenAI`][src.openai.AsyncOpenAI], is another good place to start. The clients are the primary contact point for
19+
your code that needs to work with any of the resources available on OpenAI API endpoints.
2020
2121
For more information about the REST API this package talks to or to find client libraries for other programming
2222
languages, see:
2323
24-
- [Reference documentation](https://platform.openai.com/docs/api-reference) for the OpenAPI REST API (platform.openai.com)
24+
- [REST API reference documentation](https://platform.openai.com/docs/api-reference) for the OpenAPI REST API (platform.openai.com)
2525
- [OpenAPI Description (OAD)](https://github.com/openai/openai-openapi) file for the OpenAPI REST API (GitHub)
2626
- More [client libraries](https://platform.openai.com/docs/libraries) for the OpenAI API (platform.openai.com)
2727
# --8<-- [end:openai]

0 commit comments

Comments
 (0)