Add test for OpenAI UploadedFile

Author: tarruda

tests/assets/smiley.pdf

@@ -0,0 +1,85 @@
+interactions:
+- request:
+    headers:
+      accept:
+      - application/json
+      accept-encoding:
+      - gzip, deflate
+      connection:
+      - keep-alive
+      content-length:
+      - '206'
+      content-type:
+      - application/json
+      host:
+      - api.openai.com
+    method: POST
+    parsed_body:
+      messages:
+      - content:
+        - text: Give me a short description of this image
+          type: text
+        - file:
+            file_id: file-7yEHnJNSSBeUYfkLq6G8KG
+          type: file
+        role: user
+      model: gpt-4o
+      stream: false
+    uri: https://api.openai.com/v1/chat/completions
+  response:
+    headers:
+      access-control-expose-headers:
+      - X-Request-ID
+      alt-svc:
+      - h3=":443"; ma=86400
+      connection:
+      - keep-alive
+      content-length:
+      - '919'
+      content-type:
+      - application/json
+      openai-organization:
+      - coplane
+      openai-processing-ms:
+      - '2777'
+      openai-project:
+      - proj_KGkpeAYM2vPXvZOVtXfnuZ9r
+      openai-version:
+      - '2020-10-01'
+      strict-transport-security:
+      - max-age=31536000; includeSubDomains; preload
+      transfer-encoding:
+      - chunked
+    parsed_body:
+      choices:
+      - finish_reason: stop
+        index: 0
+        logprobs: null
+        message:
+          annotations: []
+          content: The image is a simple yellow smiley face with a round shape and black eyes and mouth, conveying a happy
+            expression.
+          refusal: null
+          role: assistant
+      created: 1755612211
+      id: chatcmpl-C6HDvVjuYXrcPsCCSWarXSeHAKQVV
+      model: gpt-4o-2024-08-06
+      object: chat.completion
+      service_tier: default
+      system_fingerprint: fp_80956533cb
+      usage:
+        completion_tokens: 24
+        completion_tokens_details:
+          accepted_prediction_tokens: 0
+          audio_tokens: 0
+          reasoning_tokens: 0
+          rejected_prediction_tokens: 0
+        prompt_tokens: 312
+        prompt_tokens_details:
+          audio_tokens: 0
+          cached_tokens: 0
+        total_tokens: 336
+    status:
+      code: 200
+      message: OK
+version: 1

tests/models/cassettes/test_openai/test_uploaded_file_input.yaml

@@ -35,6 +35,7 @@
     ThinkingPartDelta,
     ToolCallPart,
     ToolReturnPart,
+    UploadedFile,
     UserPromptPart,
 )
 from pydantic_ai.models import ModelRequestParameters
@@ -52,7 +53,7 @@
 
 with try_import() as imports_successful:
     from openai import NOT_GIVEN, APIStatusError, AsyncOpenAI
-    from openai.types import chat
+    from openai.types import FileObject, chat
     from openai.types.chat.chat_completion import Choice, ChoiceLogprobs
     from openai.types.chat.chat_completion_chunk import (
         Choice as ChunkChoice,
@@ -2926,3 +2927,35 @@ async def test_openai_model_settings_temperature_ignored_on_gpt_5(allow_model_re
 
     result = await agent.run('What is the capital of France?', model_settings=ModelSettings(temperature=0.0))
     assert result.output == snapshot('Paris.')
+
+
+async def test_uploaded_file_input(allow_model_requests: None, openai_api_key: str):
+    provider = OpenAIProvider(api_key=openai_api_key)
+    m = OpenAIModel('gpt-4o', provider=provider)
+    # VCR recording breaks when dealing with openai file upload request due to
+    # binary contents. For that reason, we have manually run once the upload
+    # and rebuild the FileObject manually (from the print command output).
+    # with open('tests/assets/smiley.pdf', 'rb') as f:
+    #     file_bytes = f.read()
+    # openai_file = await provider.client.files.create(
+    #     file=('image.pdf', file_bytes, 'application/pdf'),
+    #     purpose='user_data',
+    # )
+    # print(openai_file)
+    openai_file = FileObject(
+        id='file-7yEHnJNSSBeUYfkLq6G8KG',
+        bytes=5930,
+        created_at=1755612061,
+        filename='image.pdf',  # OpenAI file upload API only accepts pdf
+        object='file',
+        purpose='user_data',
+        status='processed',
+        expires_at=None,
+        status_details=None,
+    )
+    agent = Agent(m)
+
+    result = await agent.run(['Give me a short description of this image', UploadedFile(file=openai_file)])
+    assert result.output == snapshot(
+        'The image is a simple yellow smiley face with a round shape and black eyes and mouth, conveying a happy expression.'
+    )