mirror of
https://github.com/microsoft/agent-framework.git
synced 2026-06-16 21:04:09 +08:00
Python: Support GPT-5 verbosity option and restore Foundry agent_reference (#5619)
* Python: Support GPT-5 verbosity option and restore Foundry agent_reference Adds verbosity as a typed Literal["low","medium","high"] field on OpenAIChatOptions (Responses API) and OpenAIChatCompletionOptions (Chat Completions API), set in the same way as the existing reasoning options. For the Responses API, top-level verbosity is translated to the nested text.verbosity shape the OpenAI service expects. The same field flows through to FoundryChatClient via the existing FoundryChatOptions alias. Also fixes #5582: PR #5447 removed the agent_reference injection from RawFoundryAgentChatClient._prepare_options, so first-turn calls against a Foundry Prompt Agent went out without model and without agent_reference and were rejected by the Responses API with "Missing required parameter: 'model'". Restores the injection on the non-preview path (allow_preview=False) and adds a guard test that asserts the preview path does not inject agent_reference, since the preview SDK injects it via project_client.get_openai_client(agent_name=...). Closes #5516 Closes #5582 * Python: Address Copilot review on PR #5619 - Foundry verbosity sample docstring: replace the misleading "set deployment name on model=" instruction with the actual env-var pattern the sample relies on (FOUNDRY_PROJECT_ENDPOINT and FOUNDRY_MODEL). - _build_agent_reference docstring: clarify the helper is used for both Prompt Agents and HostedAgents on the non-preview path. - Add a Responses API test that locks in the documented precedence rule: when both top-level verbosity and text["verbosity"] are supplied, the top-level value wins. * Python: Drop redundant Foundry verbosity sample and list OpenAI sample in README - Remove samples/02-agents/providers/foundry/foundry_chat_client_verbosity.py per review feedback. The verbosity functionality is identical across the OpenAI and Foundry clients (FoundryChatOptions is an alias of OpenAIChatOptions), so a single sample on the OpenAI side is sufficient. - Add the new client_verbosity.py entry to the OpenAI samples README.
This commit is contained in:
committed by
GitHub
Unverified
parent
4a2da953ca
commit
f3db60fa65
@@ -204,6 +204,11 @@ class OpenAIChatOptions(ChatOptions[ResponseFormatT], Generic[ResponseFormatT],
|
||||
"""Configuration for reasoning models (gpt-5, o-series).
|
||||
See: https://platform.openai.com/docs/guides/reasoning"""
|
||||
|
||||
verbosity: Literal["low", "medium", "high"]
|
||||
"""Output verbosity for GPT-5 family models. Lower values yield shorter responses.
|
||||
Translated to ``text.verbosity`` when sent to the Responses API.
|
||||
See: https://developers.openai.com/cookbook/examples/gpt-5/gpt-5_new_params_and_tools#1-verbosity-parameter"""
|
||||
|
||||
safety_identifier: str
|
||||
"""A stable identifier for detecting policy violations.
|
||||
Recommend hashing username/email to avoid sending identifying info."""
|
||||
@@ -1322,6 +1327,11 @@ class RawOpenAIChatClient( # type: ignore[misc]
|
||||
response_format, text_config = self._prepare_response_and_text_format(
|
||||
response_format=response_format, text_config=text_config
|
||||
)
|
||||
# The Responses API nests verbosity under ``text.verbosity``; surface it as a
|
||||
# top-level option for parity with ``reasoning`` and translate here.
|
||||
if (verbosity := run_options.pop("verbosity", None)) is not None:
|
||||
text_config = dict(text_config) if text_config else {}
|
||||
text_config["verbosity"] = verbosity
|
||||
if text_config:
|
||||
run_options["text"] = text_config
|
||||
if response_format:
|
||||
|
||||
@@ -145,6 +145,9 @@ class OpenAIChatCompletionOptions(ChatOptions[ResponseModelT], Generic[ResponseM
|
||||
logprobs: bool
|
||||
top_logprobs: int
|
||||
prediction: Prediction
|
||||
verbosity: Literal["low", "medium", "high"]
|
||||
"""Output verbosity for GPT-5 family models. Lower values yield shorter responses.
|
||||
See: https://developers.openai.com/cookbook/examples/gpt-5/gpt-5_new_params_and_tools#1-verbosity-parameter"""
|
||||
|
||||
|
||||
OpenAIChatCompletionOptionsT = TypeVar(
|
||||
|
||||
Reference in New Issue
Block a user