Bump for 5f87e2c

Author: stainless-bot

.stats.yml

@@ -0,0 +1 @@
+configured_endpoints: 16

LICENSE

@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright 2022 openai
+   Copyright 2022 OpenAI
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

README.md

@@ -1,8 +1,8 @@
-# Open AI Python API Library
+# OpenAI Python API Library
 
-[![PyPI version](https://img.shields.io/pypi/v/openai.svg)](https://pypi.org/project/openai/)
+[![PyPI version](https://img.shields.io/pypi/v/OpenAI.svg)](https://pypi.org/project/OpenAI/)
 
-The Open AI Python library provides convenient access to the Open AI REST API from any Python 3.7+
+The OpenAI Python library provides convenient access to the OpenAI REST API from any Python 3.7+
 application. It includes type definitions for all request params and response fields,
 and offers both synchronous and asynchronous clients powered by [httpx](https://github.com/encode/httpx).
 
@@ -13,7 +13,7 @@ The API documentation can be found [here](https://beta.openai.com/docs/).
 ## Installation
 
 ```sh
-pip install openai
+pip install OpenAI
 ```
 
 ## Usage
@@ -26,18 +26,17 @@ openai = OpenAI(
     api_key="my api key",
 )
 
-completion = openai.completions.create({
-    "model": "text-davinci-002",
-    "prompt": "Say this is a test",
-    "max_tokens": 6,
-    "temperature": 0,
-})
-
+completion = openai.completions.create(
+    model="text-davinci-002",
+    prompt="Say this is a test",
+    max_tokens=6,
+    temperature=0,
+)
 print(completion.choices)
 ```
 
 While you can provide an `api_key` keyword argument, we recommend using [python-dotenv](https://pypi.org/project/python-dotenv/)
-and adding `OPENAI_API_KEY="my api key"` to your `.env` file so that your API keys are not stored in source control.
+and adding `OPENAI_API_KEY="my api key"` to your `.env` file so that your API Key is not stored in source control.
 
 ## Async Usage
 
@@ -51,34 +50,35 @@ openai = AsyncOpenAI(
     api_key="my api key",
 )
 
+
 async def main():
-    completion = await openai.completions.create({
-        "model": "text-davinci-002",
-        "prompt": "Say this is a test",
-        "max_tokens": 6,
-        "temperature": 0,
-    })
+    completion = await openai.completions.create(
+        model="text-davinci-002",
+        prompt="Say this is a test",
+        max_tokens=6,
+        temperature=0,
+    )
     print(completion.choices)
 
+
 asyncio.run(main())
 ```
 
 Functionality between the synchronous and asynchronous clients are otherwise identical.
 
 ## Using Types
 
-Request parameters are [TypedDicts](https://docs.python.org/3/library/typing.html#typing.TypedDict), while responses are [Pydantic](https://pydantic-docs.helpmanual.io/) models. This helps provide autocomplete and documentation within your editor.
+Nested request parameters are [TypedDicts](https://docs.python.org/3/library/typing.html#typing.TypedDict), while responses are [Pydantic](https://pydantic-docs.helpmanual.io/) models. This helps provide autocomplete and documentation within your editor.
 
 If you would like to see type errors in VS Code to help catch bugs earlier, set `python.analysis.typeCheckingMode` to `"basic"`.
 
 ## Pagination
 
-List methods in the Open AI API are paginated.
+List methods in the OpenAI API are paginated.
 
 This library provides auto-paginating iterators with each list response, so you do not have to request successive pages manually:
 
 ```py
-from typing import List
 import openai
 
 openai = OpenAI()
@@ -95,44 +95,35 @@ Or, asynchronously:
 
 ```python
 import asyncio
-from typing import List
 import openai
 
 openai = AsyncOpenAI()
 
+
 async def main() -> None:
     all_files = []
     # Iterate through items across all pages, issuing requests as needed.
     async for file in openai.files.list():
         all_files.append(file)
-    return all_files
+    print(all_files)
+
 
 asyncio.run(main())
 ```
 
 Alternatively, you can use the `.has_next_page()`, `.next_page_params()`,
 or `.get_next_page()` methods for more granular control working with pages:
 
-```python
-first_page = await client.cards.list({"page_size": 2})
-if first_page.has_next_page():
-    print("will fetch next page, with params", first_page.next_page_params())
-    next_page = await first_page.get_next_page()
-    print(f"number of items we just fetched: {len(next_page.data)}")
+## Nested params
 
-# Remove `await` for non-async usage.
-```
+Nested parameters are dictionaries, typed using `TypedDict`, for example:
 
-Or just work directly with the returned data:
-
-```python
-first_page = await client.cards.list()
+```py
+from openai import OpenAI
 
-print(f"page number: {first_page.page}") # => "page number: 1"
-for card in first_page.data:
-    print(card.token)
+openai = OpenAI()
 
-# Remove `await` for non-async usage.
+openai.files.list()
 ```
 
 ## Handling errors
@@ -150,12 +141,12 @@ from openai import OpenAI
 openai = OpenAI()
 
 try:
-    openai.fine_tunes.create({
-        "training_file": "file-XGinujblHPwGLSztz8cPS8XY"
-    })
+    openai.fine_tunes.create(
+        training_file="file-XGinujblHPwGLSztz8cPS8XY",
+    )
 except openai.APIConnectionError as e:
     print("The server could not be reached")
-    print(e.__cause__) # an underlying Exception, likely raised within httpx.
+    print(e.__cause__)  # an underlying Exception, likely raised within httpx.
 except openai.RateLimitError as e:
     print("A 429 status code was received; we should back off a bit.")
 except openai.APIStatusError as e:
@@ -195,10 +186,10 @@ openai = OpenAI(
 )
 
 # Or, configure per-request:
-openai.embeddings.create({
-    "model": "text-similarity-babbage-001",
-    "input": "The food was delicious and the waiter...",
-}, max_retries=5);
+openai.with_options(max_retries=5).embeddings.create(
+    model="text-similarity-babbage-001",
+    input="The food was delicious and the waiter...",
+)
 ```
 
 ### Timeouts
@@ -221,11 +212,11 @@ openai = OpenAI(
 )
 
 # Override per-request:
-openai.edits.create({
-    "model": "text-davinci-edit-001",
-    "input": "What day of the wek is it?",
-    "instruction": "Fix the spelling mistakes",
-}, timeout=5 * 1000)
+openai.with_options(timeout=5 * 1000).edits.create(
+    model="text-davinci-edit-001",
+    input="What day of the wek is it?",
+    instruction="Fix the spelling mistakes",
+)
 ```
 
 On timeout, an `APITimeoutError` is thrown.
@@ -260,4 +251,4 @@ bugs, or suggestions.
 
 ## Requirements
 
-Python 3.7 or higher.
+Python 3.7 or higher.