Rename ModelResponse.provider_request_id to provider_response_id (#2710)

Author: DouweM

docs/models/index.md

@@ -118,7 +118,7 @@ print(response.all_messages())
         model_name='claude-3-5-sonnet-latest',
         timestamp=datetime.datetime(...),
         kind='response',
-        provider_request_id=None,
+        provider_response_id=None,
     ),
 ]
 """

pydantic_ai_slim/pydantic_ai/messages.py

@@ -938,7 +938,7 @@ class ModelResponse:
     For OpenAI models, this may include 'logprobs', 'finish_reason', etc.
     """
 
-    provider_request_id: str | None = None
+    provider_response_id: str | None = None
     """request ID as specified by the model provider. This can be used to track the specific request to the model."""
 
     def price(self) -> genai_types.PriceCalculation:
@@ -1026,9 +1026,14 @@ def vendor_details(self) -> dict[str, Any] | None:
         return self.provider_details
 
     @property
-    @deprecated('`vendor_id` is deprecated, use `provider_request_id` instead')
+    @deprecated('`vendor_id` is deprecated, use `provider_response_id` instead')
     def vendor_id(self) -> str | None:
-        return self.provider_request_id
+        return self.provider_response_id
+
+    @property
+    @deprecated('`provider_request_id` is deprecated, use `provider_response_id` instead')
+    def provider_request_id(self) -> str | None:
+        return self.provider_response_id
 
     __repr__ = _utils.dataclasses_no_defaults_repr
 

pydantic_ai_slim/pydantic_ai/models/anthropic.py

@@ -330,7 +330,7 @@ def _process_response(self, response: BetaMessage) -> ModelResponse:
             items,
             usage=_map_usage(response),
             model_name=response.model,
-            provider_request_id=response.id,
+            provider_response_id=response.id,
             provider_name=self._provider.name,
         )
 

pydantic_ai_slim/pydantic_ai/models/bedrock.py

@@ -301,9 +301,13 @@ async def _process_response(self, response: ConverseResponseTypeDef) -> ModelRes
             input_tokens=response['usage']['inputTokens'],
             output_tokens=response['usage']['outputTokens'],
         )
-        vendor_id = response.get('ResponseMetadata', {}).get('RequestId', None)
+        response_id = response.get('ResponseMetadata', {}).get('RequestId', None)
         return ModelResponse(
-            items, usage=u, model_name=self.model_name, provider_request_id=vendor_id, provider_name=self._provider.name
+            items,
+            usage=u,
+            model_name=self.model_name,
+            provider_response_id=response_id,
+            provider_name=self._provider.name,
         )
 
     @overload

pydantic_ai_slim/pydantic_ai/models/gemini.py

@@ -690,7 +690,7 @@ def _process_response_from_parts(
                 f'Unsupported response from Gemini, expected all parts to be function calls or text, got: {part!r}'
             )
     return ModelResponse(
-        parts=items, usage=usage, model_name=model_name, provider_request_id=vendor_id, provider_details=vendor_details
+        parts=items, usage=usage, model_name=model_name, provider_response_id=vendor_id, provider_details=vendor_details
     )
 
 

pydantic_ai_slim/pydantic_ai/models/google.py

@@ -648,7 +648,7 @@ def _process_response_from_parts(
         parts=items,
         model_name=model_name,
         usage=usage,
-        provider_request_id=vendor_id,
+        provider_response_id=vendor_id,
         provider_details=vendor_details,
         provider_name=provider_name,
     )

pydantic_ai_slim/pydantic_ai/models/groq.py

@@ -289,7 +289,7 @@ def _process_response(self, response: chat.ChatCompletion) -> ModelResponse:
             usage=_map_usage(response),
             model_name=response.model,
             timestamp=timestamp,
-            provider_request_id=response.id,
+            provider_response_id=response.id,
             provider_name=self._provider.name,
         )
 

pydantic_ai_slim/pydantic_ai/models/huggingface.py

@@ -271,7 +271,7 @@ def _process_response(self, response: ChatCompletionOutput) -> ModelResponse:
             usage=_map_usage(response),
             model_name=response.model,
             timestamp=timestamp,
-            provider_request_id=response.id,
+            provider_response_id=response.id,
             provider_name=self._provider.name,
         )
 

pydantic_ai_slim/pydantic_ai/models/mistral.py

@@ -352,7 +352,7 @@ def _process_response(self, response: MistralChatCompletionResponse) -> ModelRes
             usage=_map_usage(response),
             model_name=response.model,
             timestamp=timestamp,
-            provider_request_id=response.id,
+            provider_response_id=response.id,
             provider_name=self._provider.name,
         )
 

pydantic_ai_slim/pydantic_ai/models/openai.py

@@ -517,7 +517,7 @@ def _process_response(self, response: chat.ChatCompletion | str) -> ModelRespons
             model_name=response.model,
             timestamp=timestamp,
             provider_details=vendor_details,
-            provider_request_id=response.id,
+            provider_response_id=response.id,
             provider_name=self._provider.name,
         )
 
@@ -831,7 +831,7 @@ def _process_response(self, response: responses.Response) -> ModelResponse:
             items,
             usage=_map_usage(response),
             model_name=response.model,
-            provider_request_id=response.id,
+            provider_response_id=response.id,
             timestamp=timestamp,
             provider_name=self._provider.name,
         )