Add metadata to ModelSettings (openai#431)

drewy-openai · web-flow · commit 0110f3ad9615 · 2025-04-03T17:50:24.000-04:00
diff --git a/src/agents/model_settings.py b/src/agents/model_settings.py
@@ -40,6 +40,9 @@ class ModelSettings:
     max_tokens: int | None = None
     """The maximum number of output tokens to generate."""
 
+    metadata: dict[str, str] | None = None
+    """Metadata to include with the model response call."""
+
     store: bool | None = None
     """Whether to store the generated model response for later retrieval.
     Defaults to True if not provided."""
diff --git a/src/agents/models/openai_chatcompletions.py b/src/agents/models/openai_chatcompletions.py
@@ -537,6 +537,7 @@ async def _fetch_response(
             stream_options={"include_usage": True} if stream else NOT_GIVEN,
             store=store,
             extra_headers=_HEADERS,
+            metadata=model_settings.metadata,
         )
 
         if isinstance(ret, ChatCompletion):
diff --git a/src/agents/models/openai_responses.py b/src/agents/models/openai_responses.py
@@ -247,6 +247,7 @@ async def _fetch_response(
             extra_headers=_HEADERS,
             text=response_format,
             store=self._non_null_or_not_given(model_settings.store),
+            metadata=model_settings.metadata,
         )
 
     def _get_client(self) -> AsyncOpenAI:

Original file line number	Diff line number	Diff line change
`@@ -537,6 +537,7 @@ async def _fetch_response(`
`537`	`537`	`stream_options={"include_usage": True} if stream else NOT_GIVEN,`
`538`	`538`	`store=store,`
`539`	`539`	`extra_headers=_HEADERS,`
	`540`	`+ metadata=model_settings.metadata,`
`540`	`541`	`)`
`541`	`542`
`542`	`543`	`if isinstance(ret, ChatCompletion):`
Original file line number	Diff line number	Diff line change
`@@ -247,6 +247,7 @@ async def _fetch_response(`
`247`	`247`	`extra_headers=_HEADERS,`
`248`	`248`	`text=response_format,`
`249`	`249`	`store=self._non_null_or_not_given(model_settings.store),`
	`250`	`+ metadata=model_settings.metadata,`
`250`	`251`	`)`
`251`	`252`
`252`	`253`	`def _get_client(self) -> AsyncOpenAI:`