OpenAIConversationsSession and OpenAIResponsesCompactionSession ignore set_default_openai_key()

オープン 初心者向け
#5,471 コメント 2 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

まだ誰も着手していません。

評価

難易度
2/5
見積もり時間
1〜3時間
初心者へのやさしさ
78/100
issue の種類
バグ
明瞭さ
明確に書かれている
活発さ
活発
技術スタック
python
領域
backend

調査の方向性

src/agents/memory/openai_conversations_session.py から始め、フォールバックの AsyncOpenAI() が21行目と50行目付近で作られている箇所を確認してください。次に、src/agents/memory/openai_responses_compaction_session.py の196行目付近と、src/agents/models/openai_provider.py の get_default_openai_key() パターンを確認し、それに倣ってください。issue の再現スクリプトを両方のフェーズで実行し、その後 tests/memory を実行します。両方のセッションが、OPENAI_API_KEY が設定されているかどうかに関係なく set_default_openai_key() で設定されたキーを報告すれば完了です。

索引モデルが issue の本文から書いたものです。

説明

Please read this first
  • Have you read the docs? Yes
  • Have you searched for related issues? Yes. Nothing covers it. #2164 is a feature request for several keys per run.
Describe the bug

set_default_openai_key() is documented as the key that "will be used instead of the OPENAI_API_KEY environment variable". OpenAIProvider honors it, and so do the voice provider and the Codex tool. OpenAIConversationsSession and OpenAIResponsesCompactionSession don't. When no default client is set, they build a bare AsyncOpenAI(), which reads only OPENAI_API_KEY. That causes two problems:

  • When the key is set only through the SDK, OpenAIConversationsSession() raises OpenAIError: Missing credentials when it's constructed, and the compaction session raises on its first responses.compact call.
  • When OPENAI_API_KEY is also set, the sessions quietly use the environment key while model calls use the SDK key. Conversation items and the billed responses.compact calls land in a different project or org than the run's responses.
Debug information
  • Agents SDK version: main (e355d69), also 0.24.0
  • Related library versions: openai 3.29.0
  • Python version: 3.14.7
  • Operating system: macOS
  • Model and model provider: OpenAI
  • Does the issue reproduce with the latest Agents SDK release? Yes
  • Does the issue occur consistently or intermittently? Consistently
Repro steps
import os
os.environ.pop("OPENAI_API_KEY", None)  # key is configured only through the SDK

from agents import SQLiteSession, set_default_openai_key
from agents.memory import OpenAIConversationsSession, OpenAIResponsesCompactionSession
from agents.models.multi_provider import MultiProvider

set_default_openai_key("sk-from-set-default-openai-key")

def show(label, make):
    try:
        print(f"{label}:", make().api_key)
    except Exception as e:
        print(f"{label}:", type(e).__name__, "-", str(e)[:40])

for phase in ("SDK key only", "OPENAI_API_KEY also set"):
    if phase == "OPENAI_API_KEY also set":
        os.environ["OPENAI_API_KEY"] = "sk-other-project-from-env"
    print("--", phase)
    print("model client        :", MultiProvider().get_model("gpt-4.1")._client.api_key)
    show("ConversationsSession", lambda: OpenAIConversationsSession()._openai_client)
    show("CompactionSession   ", lambda: OpenAIResponsesCompactionSession("s", SQLiteSession("s")).client)
-- SDK key only
model client        : sk-from-set-default-openai-key
ConversationsSession: OpenAIError - Missing credentials. Please pass a
CompactionSession   : OpenAIError - Missing credentials. Please pass a
-- OPENAI_API_KEY also set
model client        : sk-from-set-default-openai-key
ConversationsSession: sk-other-project-from-env
CompactionSession   : sk-other-project-from-env
Expected behavior

With no client passed and no default client set, both sessions use the key from set_default_openai_key(), as model calls do.

Root cause and a possible fix

The sessions fall back to AsyncOpenAI(): openai_conversations_session.py#L21, #L50 and openai_responses_compaction_session.py#L196. The provider passes get_default_openai_key() instead (openai_provider.py#L156-L161).

--- a/src/agents/memory/openai_conversations_session.py
+++ b/src/agents/memory/openai_conversations_session.py
-from agents.models._openai_shared import get_default_openai_client
+from agents.models._openai_shared import get_default_openai_client, get_default_openai_key
@@ async def start_openai_conversations_session(
-        _maybe_openai_client = default_client if default_client is not None else AsyncOpenAI()
+        _maybe_openai_client = (
+            default_client
+            if default_client is not None
+            else AsyncOpenAI(api_key=get_default_openai_key())
+        )
@@ class OpenAIConversationsSession(SessionABC):
-            _openai_client = default_client if default_client is not None else AsyncOpenAI()
+            _openai_client = (
+                default_client
+                if default_client is not None
+                else AsyncOpenAI(api_key=get_default_openai_key())
+            )
--- a/src/agents/memory/openai_responses_compaction_session.py
+++ b/src/agents/memory/openai_responses_compaction_session.py
-from ..models._openai_shared import get_default_openai_client
+from ..models._openai_shared import get_default_openai_client, get_default_openai_key
@@ def client(self) -> AsyncOpenAI:
-            self._client = default_client if default_client is not None else AsyncOpenAI()
+            self._client = (
+                default_client
+                if default_client is not None
+                else AsyncOpenAI(api_key=get_default_openai_key())
+            )

AsyncOpenAI(api_key=None) still falls back to OPENAI_API_KEY, so nothing changes for callers who haven't set a default key. With the patch, both sessions report the SDK key in both phases, and tests/memory passes (444 passed).

主要言語
Python
スター
30.5k
フォーク
5k
平均マージ
18時間 26分
マージ済み PR(30日)
142

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

openai/openai-agents-python のほかの issue

openai/openai-agents-python の issue をすべて見る

似ている issue

Python の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。