openai/openai-python

解決的問題

此套件為 Python 開發者提供了一種便利且具類型安全的與 OpenAI REST API 互動方式，無需手動建構 HTTP 請求即可存取 OpenAI 的模型與服務。

工作原理

它作為 OpenAI REST API 的封裝器，由 OpenAPI 規格生成。預設使用 HTTPX2 進行網路通訊，並提供同步與非同步客戶端（OpenAI 與 AsyncOpenAI）。該套件透過 API 金鑰或工作負載身分提供者（如 Kubernetes、Azure 與 GCP）處理驗證，支援透過伺服器端事件（SSE）的串流回應，並提供 Pydantic 模型以實現結構化、類型檢查的回應。

適用對象

建構整合 OpenAI AI 模型之應用程式的 Python 開發者，特別是需要高併發非同步請求或在雲端環境中使用安全企業級驗證的使用者。

主要特色

• 多模態支援：透過回應與 Realtime API 支援文字、影像與音訊的輸入/輸出。
• 彈性驗證方式：支援 API 金鑰、工作負載身分聯合（K8s、Azure、GCP）以及 X.509 相互 TLS。
• Realtime API：使用 WebSocket 實現低延遲、多模態的對話體驗。
• 開發者體驗：請求參數的完整類型定義，以及透過 Pydantic 與 TypedDict 提供的自動補完。
• 自動分頁：簡化對分頁列表回應的迭代處理。
• Webhook 驗證：內建工具用於驗證與解包傳入的 OpenAI Webhook 簽章。