refactor docs

easonsshi · easonsshi · commit 691057f0a012 · 2025-04-30T14:14:33.000+08:00
diff --git a/_docs/README.md b/_docs/README.md
@@ -1,3 +1,14 @@
+NOTE: 参见 [agent_ref/doc]
+
+## 更新到 0.1.13
+1. 支持 LiteLLM 模型 (src/agents/extensions/models/litellm_model.py)
+2. 支持 multi_provider (src/agents/models/multi_provider.py)
+3. 支持 extra_headers 参数 (src/agents/model_settings.py)
+4. 支持非严格JSON输出 (src/agents/agent_output.py)
+5. 分离 Converter (src/agents/models/chatcmpl_converter.py)
+6. 分离 ChatCmlpStreamHandler (src/agents/models/chatcmpl_stream_handler.py)
+7. 对于 RunResultStreaming 增加 `cancel` 方法 (src/agents/result.py)
+
 ## RULES
 1. 透明封装? 
 2. 变更: 将修改点记录到 OVERWRITE.md
@@ -21,7 +32,7 @@
 3. 通过git submodule将SDK引入应用仓库 (pip install -e ./lib/openai-agents)
 4. 定期执行上游同步：
 ```sh
-git remote add upstream [原仓库URL]
+git remote add upstream https://github.com/openai/openai-agents-python
 git fetch upstream
 git merge upstream/main
 ```
diff --git a/_docs/agents.pyi b/_docs/agents.pyi
diff --git a/_docs/runs.sh b/_docs/runs.sh
@@ -0,0 +1,6 @@
+# merge upstream changes (upstream/main -> eason)
+git remote add upstream https://github.com/openai/openai-agents-python
+git fetch upstream
+git merge upstream/main
+# push changes to eason branch
+git push origin eason
diff --git a/_docs/tracing/phoenix/101.py b/_docs/tracing/phoenix/101.py
@@ -0,0 +1,27 @@
+from phoenix.otel import register
+
+# configure the Phoenix tracer
+tracer_provider = register(
+    protocol="grpc", # "http/protobuf",
+    project_name="default",
+    batch=True,
+    auto_instrument=True,
+    endpoint="http://9.134.230.111:4317" # 6006"
+)
+tracer = tracer_provider.get_tracer(__name__)
+
+@tracer.chain
+def my_func(input: str) -> str:
+    return "output"
+
+my_func("input")
+
+# Add OpenAI API Key
+import openai
+
+client = openai.OpenAI()
+response = client.chat.completions.create(
+    model="gpt-4o",
+    messages=[{"role": "user", "content": "Write a haiku."}],
+)
+print(response.choices[0].message.content)
diff --git a/_docs/tracing/phoenix/102_openai.py b/_docs/tracing/phoenix/102_openai.py
@@ -0,0 +1,75 @@
+""" 
+OpenAI
+    - ChatCompletion
+    - Responses
+
+pip install openinference-instrumentation-openai
+"""
+from openinference.instrumentation.openai import OpenAIInstrumentor
+from phoenix.otel import register
+
+tracer_provider = register(
+    protocol="grpc", # "http/protobuf",
+    project_name="default",
+    batch=True,
+    # auto_instrument=True,
+    endpoint="http://9.134.230.111:4317" # 6006"
+)
+OpenAIInstrumentor().instrument(tracer_provider=tracer_provider)
+
+
+import openai
+client = openai.OpenAI()
+tools = [{
+    "type": "function",
+    "name": "get_weather",
+    "description": "Get current temperature for a given location.",
+    "parameters": {
+        "type": "object",
+        "properties": {
+            "location": {
+                "type": "string",
+                "description": "City and country e.g. Bogotá, Colombia"
+            }
+        },
+        "required": [
+            "location"
+        ],
+        "additionalProperties": False
+    }
+}]
+response = client.responses.create(
+    model="gpt-4o",
+    input=[{"role": "user", "content": "What is the weather like in Paris today?"}],
+    tools=tools
+)
+print(response)
+
+
+tools = [{
+    "type": "function",
+    "function": {
+        "name": "get_weather",
+        "description": "Get current temperature for a given location.",
+        "parameters": {
+            "type": "object",
+            "properties": {
+                "location": {
+                    "type": "string",
+                    "description": "City and country e.g. Bogotá, Colombia"
+                }
+            },
+            "required": [
+                "location"
+            ],
+            "additionalProperties": False
+        },
+        "strict": True
+    }
+}]
+response = client.chat.completions.create(
+    model="gpt-4o",
+    messages=[{"role": "user", "content": "What is the weather like in Paris today?"}],
+    tools=tools
+)
+print(response)
diff --git a/_docs/tracing/phoenix/103_agents.py b/_docs/tracing/phoenix/103_agents.py
@@ -0,0 +1,24 @@
+""" 
+pip install openinference-instrumentation-openai-agents openai-agents
+"""
+from openinference.instrumentation.openai_agents import OpenAIAgentsInstrumentor
+from phoenix.otel import register
+
+tracer_provider = register(
+    protocol="grpc", # "http/protobuf",
+    project_name="default",
+    batch=True,
+    # auto_instrument=True,
+    endpoint="http://9.134.230.111:4317" # 6006"
+)
+OpenAIAgentsInstrumentor().instrument(tracer_provider=tracer_provider)
+
+from agents import Agent, Runner, function_tool
+@function_tool
+def get_weather(city: str) -> str:
+    """Get current temperature for a given location."""
+    return f"The weather in {city} is sunny."
+
+agent = Agent(name="Assistant", instructions="You are a helpful assistant", tools=[get_weather])
+result = Runner.run_sync(agent, "What is the weather like in Paris today?")
+print(result.final_output)
diff --git a/_docs/tracing/phoenix/103_agents_with_openai.py b/_docs/tracing/phoenix/103_agents_with_openai.py
@@ -0,0 +1,25 @@
+""" 
+pip install openinference-instrumentation-openai-agents openai-agents
+"""
+# NOTE: 这里强制用 OpenAIInstrumentor 而非 Agents 的也可以! 
+from openinference.instrumentation.openai import OpenAIInstrumentor
+from phoenix.otel import register
+
+tracer_provider = register(
+    protocol="grpc", # "http/protobuf",
+    project_name="default",
+    batch=True,
+    # auto_instrument=True,
+    endpoint="http://9.134.230.111:4317" # 6006"
+)
+OpenAIInstrumentor().instrument(tracer_provider=tracer_provider)
+
+from agents import Agent, Runner, function_tool
+@function_tool
+def get_weather(city: str) -> str:
+    """Get current temperature for a given location."""
+    return f"The weather in {city} is sunny."
+
+agent = Agent(name="Assistant", instructions="You are a helpful assistant", tools=[get_weather])
+result = Runner.run_sync(agent, "What is the weather like in Paris today?")
+print(result.final_output)
