Merge pull request #8 from mmacy/chat.completions.create

docstrings for resource module & chat.completions.create() impl

Author: mmacy

.devcontainer/Dockerfile

@@ -3,7 +3,7 @@ FROM mcr.microsoft.com/vscode/devcontainers/python:0-${VARIANT}
 
 USER vscode
 
-RUN curl -sSf https://rye-up.com/get | RYE_VERSION="0.15.2" RYE_INSTALL_OPTION="--yes" bash
+RUN curl -sSf https://rye-up.com/get | RYE_VERSION="0.24.0" RYE_INSTALL_OPTION="--yes" bash
 ENV PATH=/home/vscode/.rye/shims:$PATH
 
 RUN echo "[[ -d .venv ]] && source .venv/bin/activate" >> /home/vscode/.bashrc

.github/workflows/ci.yml

@@ -21,7 +21,7 @@ jobs:
           curl -sSf https://rye-up.com/get | bash
           echo "$HOME/.rye/shims" >> $GITHUB_PATH
         env:
-          RYE_VERSION: 0.15.2
+          RYE_VERSION: 0.24.0
           RYE_INSTALL_OPTION: "--yes"
 
       - name: Install dependencies

.github/workflows/create-releases.yml

@@ -0,0 +1,39 @@
+name: Create releases
+on:
+  schedule:
+    - cron: '0 5 * * *' # every day at 5am UTC
+  push:
+    branches:
+      - main
+
+jobs:
+  release:
+    name: release
+    if: github.ref == 'refs/heads/main' && github.repository == 'openai/openai-python'
+    runs-on: ubuntu-latest
+    environment: publish
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - uses: stainless-api/trigger-release-please@v1
+        id: release
+        with:
+          repo: ${{ github.event.repository.full_name }}
+          stainless-api-key: ${{ secrets.STAINLESS_API_KEY }}
+
+      - name: Install Rye
+        if: ${{ steps.release.outputs.releases_created }}
+        run: |
+          curl -sSf https://rye-up.com/get | bash
+          echo "$HOME/.rye/shims" >> $GITHUB_PATH
+        env:
+          RYE_VERSION: 0.24.0
+          RYE_INSTALL_OPTION: "--yes"
+
+      - name: Publish to PyPI
+        if: ${{ steps.release.outputs.releases_created }}
+        run: |
+          bash ./bin/publish-pypi
+        env:
+          PYPI_TOKEN: ${{ secrets.OPENAI_PYPI_TOKEN || secrets.PYPI_TOKEN }}

.github/workflows/publish-pypi.yml

@@ -1,13 +1,9 @@
-# This workflow is triggered when a GitHub release is created.
-# It can also be run manually to re-publish to PyPI in case it failed for some reason.
-# You can run this workflow by navigating to https://www.github.com/openai/openai-python/actions/workflows/publish-pypi.yml
+# workflow for re-running publishing to PyPI in case it fails for some reason
+# you can run this workflow by navigating to https://www.github.com/openai/openai-python/actions/workflows/publish-pypi.yml
 name: Publish PyPI
 on:
   workflow_dispatch:
 
-  release:
-    types: [published]
-
 jobs:
   publish:
     name: publish
@@ -21,7 +17,7 @@ jobs:
           curl -sSf https://rye-up.com/get | bash
           echo "$HOME/.rye/shims" >> $GITHUB_PATH
         env:
-          RYE_VERSION: 0.15.2
+          RYE_VERSION: 0.24.0
           RYE_INSTALL_OPTION: "--yes"
 
       - name: Publish to PyPI

.github/workflows/release-doctor.yml

@@ -19,4 +19,5 @@ jobs:
         run: |
           bash ./bin/check-release-environment
         env:
+          STAINLESS_API_KEY: ${{ secrets.STAINLESS_API_KEY }}
           PYPI_TOKEN: ${{ secrets.OPENAI_PYPI_TOKEN || secrets.PYPI_TOKEN }}

.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "1.13.0"
+  ".": "1.13.2"
 }

CHANGELOG.md

@@ -1,5 +1,21 @@
 # Changelog
 
+## 1.13.2 (2024-02-20)
+
+Full Changelog: [v1.13.1...v1.13.2](https://github.com/openai/openai-python/compare/v1.13.1...v1.13.2)
+
+### Bug Fixes
+
+* **ci:** revert "move github release logic to github app" ([#1170](https://github.com/openai/openai-python/issues/1170)) ([f1adc2e](https://github.com/openai/openai-python/commit/f1adc2e6f2f29acb4404e84137a9d3109714c585))
+
+## 1.13.1 (2024-02-20)
+
+Full Changelog: [v1.13.0...v1.13.1](https://github.com/openai/openai-python/compare/v1.13.0...v1.13.1)
+
+### Chores
+
+* **internal:** bump rye to v0.24.0 ([#1168](https://github.com/openai/openai-python/issues/1168)) ([84c4256](https://github.com/openai/openai-python/commit/84c4256316f2a79068ecadb852e5e69b6b104a1f))
+
 ## 1.13.0 (2024-02-19)
 
 Full Changelog: [v1.12.0...v1.13.0](https://github.com/openai/openai-python/compare/v1.12.0...v1.13.0)

bin/check-release-environment

@@ -2,6 +2,10 @@
 
 errors=()
 
+if [ -z "${STAINLESS_API_KEY}" ]; then
+  errors+=("The STAINLESS_API_KEY secret has not been set. Please contact Stainless for an API key & set it in your organization secrets on GitHub.")
+fi
+
 if [ -z "${PYPI_TOKEN}" ]; then
   errors+=("The OPENAI_PYPI_TOKEN secret has not been set. Please set it in either this repository's secrets or your organization secrets.")
 fi

docs/reference/include/openai.resources.py

@@ -1,5 +1,18 @@
 """Snippets in this docstring are ingested by other documentation (including library docstrings) during the MkDocs build process.
 
+# --8<-- [start:resources]
+The `resources` module aggregates classes and functions for interacting with the OpenAI API into several submodules,
+each representing a specific resource or feature of the API.
+
+The submodules' classes mirror the structure of the API's endpoints and offer synchronous and asynchronous
+communication with the API.
+
+Each resource is accessible as an attribute on the [`OpenAI`][src.openai.OpenAI] and [`AsyncOpenAI`][src.openai.AsyncOpenAI]
+clients. To work with a resource, initialize an instance of one of the clients and access the resource as an attribute
+on the client instance. For example, to work with the `chat` resource, create an instance of the `OpenAI` client and
+access the attributes and methods on `your_client_instance.chat`.
+# --8<-- [end:resources]
+
 # --8<-- [start:audio]
 The `audio` module provides classes for handling various audio processing operations, including transcription of audio to text, translation of spoken content, and speech synthesis.
 
@@ -15,7 +28,7 @@
 # --8<-- [start:chat]
 The `chat` module provides classes for creating and managing chat sessions that leverage OpenAI's language models to generate conversational responses.
 
-The module supports both synchronous and asynchronous operations, offering interfaces for direct interaction with the completion endpoints tailored for chat applications. Designed for developers looking to integrate AI-powered chat functionalities into their applicationsand features like raw and streaming response handling for more flexible integration.
+The module supports both synchronous and asynchronous operations, offering interfaces for direct interaction with the completion endpoints tailored for chat applications. Designed for developers looking to integrate AI-powered chat functionalities into their applications and features like raw and streaming response handling for more flexible integration.
 # --8<-- [end:chat]
 
 # --8<-- [start:chat_completions]

docs/reference/include/openai_init.py

@@ -8,15 +8,34 @@
 provides both synchronous and asynchronous API clients, options to configure their behavior, and modules that provide
 Python code with an API surface to interact with the OpenAI platform.
 
-To get started, check out the documentation for the module representing the [resource][src.openai.resources] you're interested in using for your
-project. For example, the [`resources.chat.completions`][src.openai.resources.chat.completions] module is what you'd use
+To get started, read the submodule descriptions in [`resources`][src.openai.resources] to determine which best fits your
+project. For example, the [`resources.chat`][src.openai.resources.chat] submodule description indicates it's a good fit
 for conversational chat-style interactions with an LLM like [GPT-4 Turbo](https://platform.openai.com/docs/models/gpt-4-and-gpt-4-turbo).
-Or, maybe you need the [`resources.audio`][src.openai.resources.audio] module for performing audio transcription, translation, and
-speech synthesis in your app.
+Or, maybe you need the [`resources.audio`][src.openai.resources.audio] module to perform audio transcription,
+translation, and speech synthesis in your app.
 
-Documentation for the library's main API client classes, [`OpenAI`][src.openai.OpenAI] and
-[`AsyncOpenAI`][src.openai.AsyncOpenAI], is another good place to start. The clients are the primary contact point for
-your code that needs to work with any of the resources available on OpenAI API endpoints.
+Once you've determined the resource to use, create an [`OpenAI`][src.openai.OpenAI] or [`AsyncOpenAI`][src.openai.AsyncOpenAI]
+client instance and access the instance attribute for that resource on the client object. For example, if you instantiate
+an `OpenAI` client object named `client`, youd access the [`OpenAI.chat`][src.openai.OpenAI.chat] instance attribute:
+
+```python
+from openai import OpenAI
+
+# Reads API key from OPENAI_API_KEY environment variable
+client = OpenAI()
+
+# Use the `chat` resource to interact with the OpenAI chat completions endpoint
+completion = client.chat.completions.create(
+    model="gpt-4",
+    messages=[
+        {
+            "role": "user",
+            "content": "Say this is a test",
+        },
+    ],
+)
+print(completion.choices[0].message.content)
+```
 
 For more information about the REST API this package talks to or to find client libraries for other programming
 languages, see:

mkdocs-requirements.txt

@@ -1,13 +1,20 @@
+annotated-types==0.6.0
+anyio==4.3.0
 Babel==2.14.0
 black==24.1.1
 certifi==2024.2.2
 charset-normalizer==3.3.2
 click==8.1.7
 colorama==0.4.6
+distro==1.9.0
 ghp-import==2.1.0
 griffe==0.40.1
 griffe-inherited-docstrings==1.0.0
+h11==0.14.0
+httpcore==1.0.3
+httpx==0.26.0
 idna==3.6
+iniconfig==2.0.0
 Jinja2==3.1.3
 Markdown==3.5.2
 MarkupSafe==2.1.5
@@ -16,22 +23,31 @@ mkdocs==1.5.3
 mkdocs-autorefs==0.5.0
 mkdocs-gen-files==0.5.0
 mkdocs-literate-nav==0.6.1
-mkdocs-material==9.5.8
+mkdocs-material==9.5.9
 mkdocs-material-extensions==1.3.1
 mkdocstrings==0.24.0
 mkdocstrings-python @ git+ssh://[email protected]/pawamoy-insiders/mkdocstrings-python.git@157224dddefd2f2b979f9e92f0506e44c1548f64
 mypy-extensions==1.0.0
+openai==1.12.0
 packaging==23.2
 paginate==0.5.6
 pathspec==0.12.1
 platformdirs==4.2.0
+pluggy==1.4.0
+pydantic==2.6.1
+pydantic_core==2.16.2
 Pygments==2.17.2
 pymdown-extensions==10.7
+pytest==8.0.1
 python-dateutil==2.8.2
 PyYAML==6.0.1
 pyyaml_env_tag==0.1
 regex==2023.12.25
 requests==2.31.0
+respx==0.20.2
 six==1.16.0
+sniffio==1.3.0
+tqdm==4.66.2
+typing_extensions==4.9.0
 urllib3==2.2.0
 watchdog==4.0.0

package-lock.json

@@ -1,6 +1,6 @@
 [project]
 name = "openai"
-version = "1.13.0"
+version = "1.13.2"
 description = "The official Python library for the openai API"
 readme = "README.md"
 license = "Apache-2.0"