Skip to content

feat: add log of base_url #2058

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

feat: add log of base_url #2058

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1d41669
feat: add log of base_url
EugeneJinXin Oct 6, 2025
931eca8
address comments on Captured baseURL once at wrap time
EugeneJinXin Oct 7, 2025
1245649
Merge branch 'main' into xin/log_openai_base_url
EugeneJinXin Oct 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions js/src/tests/wrapped_openai.int.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
/* eslint-disable @typescript-eslint/no-explicit-any */
/* eslint-disable no-process-env */
import { AzureOpenAI, OpenAI } from "openai";
Expand Down Expand Up @@ -374,6 +374,7 @@
ls_model_type: "chat",
ls_provider: "openai",
ls_temperature: 0,
openai_base_url: expect.any(String),
});
}
callSpy.mockClear();
Expand Down Expand Up @@ -620,6 +621,7 @@
ls_model_type: "chat",
ls_provider: "openai",
ls_temperature: 0,
openai_base_url: expect.any(String),
});
}
callSpy.mockClear();
Expand Down Expand Up @@ -671,6 +673,7 @@
ls_model_name: "gpt-4.1-nano",
ls_model_type: "llm",
ls_provider: "openai",
openai_base_url: expect.any(String),
});
}

Expand Down Expand Up @@ -725,6 +728,7 @@
ls_model_name: "gpt-4.1-nano",
ls_model_type: "llm",
ls_provider: "openai",
openai_base_url: expect.any(String),
});
}
callSpy.mockClear();
Expand Down
3 changes: 3 additions & 0 deletions js/src/wrappers/openai.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -346,6 +346,7 @@ export const wrapOpenAI = <T extends OpenAIType>(
params.max_completion_tokens ?? params.max_tokens ?? undefined,
ls_temperature: params.temperature ?? undefined,
ls_stop,
openai_base_url: (openai as any).baseURL,
};
},
processOutputs: processChatCompletion,
Expand Down Expand Up @@ -412,6 +413,7 @@ export const wrapOpenAI = <T extends OpenAIType>(
ls_max_tokens: params.max_tokens ?? undefined,
ls_temperature: params.temperature ?? undefined,
ls_stop,
openai_base_url: (openai as any).baseURL,
};
},
...options,
Expand Down Expand Up @@ -451,6 +453,7 @@ export const wrapOpenAI = <T extends OpenAIType>(
ls_provider: provider,
ls_model_type: "llm",
ls_model_name: params.model || "unknown",
openai_base_url: (openai as any).baseURL,
};
},
processOutputs: processChatCompletion,
Expand Down
15 changes: 8 additions & 7 deletions python/langsmith/wrappers/_openai.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ def _strip_not_given(d: dict) -> dict:
return d


def _infer_invocation_params(model_type: str, provider: str, kwargs: dict):
def _infer_invocation_params(model_type: str, provider: str, base_url: str, kwargs: dict):
stripped = _strip_not_given(kwargs)

stop = stripped.get("stop")
Expand All @@ -75,6 +75,7 @@ def _infer_invocation_params(model_type: str, provider: str, kwargs: dict):
or stripped.get("max_completion_tokens")
or stripped.get("max_output_tokens"),
"ls_stop": stop,
"openai_base_url": base_url,
}


Expand Down Expand Up @@ -434,7 +435,7 @@ def wrap_openai(
_reduce_chat,
tracing_extra=tracing_extra,
invocation_params_fn=functools.partial(
_infer_invocation_params, "chat", ls_provider
_infer_invocation_params, "chat", ls_provider, client.base_url
),
process_outputs=_process_chat_completion,
)
Expand All @@ -445,7 +446,7 @@ def wrap_openai(
_reduce_completions,
tracing_extra=tracing_extra,
invocation_params_fn=functools.partial(
_infer_invocation_params, "llm", ls_provider
_infer_invocation_params, "llm", ls_provider, client.base_url
),
)

Expand All @@ -462,7 +463,7 @@ def wrap_openai(
_process_chat_completion,
tracing_extra=tracing_extra,
invocation_params_fn=functools.partial(
_infer_invocation_params, "chat", ls_provider
_infer_invocation_params, "chat", ls_provider, client.base_url
),
)

Expand All @@ -478,7 +479,7 @@ def wrap_openai(
_process_chat_completion,
tracing_extra=tracing_extra,
invocation_params_fn=functools.partial(
_infer_invocation_params, "chat", ls_provider
_infer_invocation_params, "chat", ls_provider, client.base_url
),
)

Expand All @@ -492,7 +493,7 @@ def wrap_openai(
process_outputs=_process_responses_api_output,
tracing_extra=tracing_extra,
invocation_params_fn=functools.partial(
_infer_invocation_params, "chat", ls_provider
_infer_invocation_params, "chat", ls_provider, client.base_url
),
)
if hasattr(client.responses, "parse"):
Expand All @@ -502,7 +503,7 @@ def wrap_openai(
_process_responses_api_output,
tracing_extra=tracing_extra,
invocation_params_fn=functools.partial(
_infer_invocation_params, "chat", ls_provider
_infer_invocation_params, "chat", ls_provider, client.base_url
),
)

Expand Down
29 changes: 29 additions & 0 deletions python/tests/integration_tests/wrappers/test_openai.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -815,3 +815,32 @@
time.sleep(0.1)
for call in mock_session.request.call_args_list:
assert call[0][0].upper() in ["POST", "GET", "PATCH"]


def test_openai_base_url_in_metadata():
"""Test that openai_base_url is captured in metadata."""
import openai

mock_session = mock.MagicMock()
client = langsmith.Client(session=mock_session)
patched_client = wrap_openai(openai.Client(), tracing_extra={"client": client})

collect = Collect()
with langsmith.tracing_context(enabled=True):
patched_client.chat.completions.create(
messages=[{"role": "user", "content": "Say 'foo'"}],
model="gpt-4o-mini",
langsmith_extra={"on_end": collect},
)

time.sleep(0.1)
for call in mock_session.request.call_args_list:
if json_bytes := call.kwargs.get("data"):
data = json.loads(json_bytes.decode("utf-8"))
for event in [*data.get("post", []), *data.get("patch", [])]:
metadata = event.get("extra", {}).get("metadata", {})
if base_url := metadata.get("openai_base_url"):
assert "api.openai.com" in base_url

Check failure

Code scanning / CodeQL

Incomplete URL substring sanitization High test

The string
api.openai.com
Loading
may be at an arbitrary position in the sanitized URL.

Copilot Autofix

AI 20 days ago

To fix the problem, the code should extract the host part from base_url using urllib.parse.urlparse, then check if the hostname matches or ends with the expected domain. This ensures malicious domains such as "evil-api.openai.com.attacker.com" do not get accepted, and prevents accidental substring matches in arbitrary positions.

Specifically:

  • Import urllib.parse.urlparse.
  • Replace the substring check if "api.openai.com" in base_url: with logic that parses base_url and checks if the hostname is exactly "api.openai.com" (or, if subdomains are desired, ends with .api.openai.com). Since the original code wants to check for presence of "api.openai.com", matching exactly is the clearest option.

Required changes:

  • Add the import line.
  • Change the assertion block so that base_url is parsed via urlparse, and then the hostname property is tested accordingly.
Suggested changeset 1
python/tests/integration_tests/wrappers/test_openai.py

Autofix patch

Autofix patch
Run the following command in your local git repository to apply this patch
cat << 'EOF' | git apply
diff --git a/python/tests/integration_tests/wrappers/test_openai.py b/python/tests/integration_tests/wrappers/test_openai.py
--- a/python/tests/integration_tests/wrappers/test_openai.py
+++ b/python/tests/integration_tests/wrappers/test_openai.py
@@ -840,7 +840,8 @@
             for event in [*data.get("post", []), *data.get("patch", [])]:
                 metadata = event.get("extra", {}).get("metadata", {})
                 if base_url := metadata.get("openai_base_url"):
-                    assert "api.openai.com" in base_url
+                    from urllib.parse import urlparse
+                    assert urlparse(base_url).hostname == "api.openai.com"
                     return
 
     raise AssertionError("openai_base_url not found in metadata")
EOF
@@ -840,7 +840,8 @@
for event in [*data.get("post", []), *data.get("patch", [])]:
metadata = event.get("extra", {}).get("metadata", {})
if base_url := metadata.get("openai_base_url"):
assert "api.openai.com" in base_url
from urllib.parse import urlparse
assert urlparse(base_url).hostname == "api.openai.com"
return

raise AssertionError("openai_base_url not found in metadata")
Copilot is powered by AI and may make mistakes. Always verify output.
return

raise AssertionError("openai_base_url not found in metadata")
Loading