move support for file_id to OpenAI only

Author: Gertiozuni

docs/input-modalities/documents.md

@@ -41,6 +41,7 @@ use Prism\Enums\Provider;
 use Prism\Prism\Prism;
 use Prism\Prism\ValueObjects\Messages\UserMessage;
 use Prism\Prism\ValueObjects\Messages\Support\Document;
+use Prism\Prism\ValueObjects\Messages\Support\OpenAIFile;
 
 Prism::text()
     ->using(Provider::Anthropic, 'claude-3-5-sonnet-20241022')
@@ -63,9 +64,9 @@ Prism::text()
         ]),
         // Or from a file_id
         new UserMessage('Here is the document from file_id', [
-            Document::fromFileId('file-lsfgSXyV2xEb8gw8fYjXU6'),
+            new OpenAIFile('file-lsfgSXyV2xEb8gw8fYjXU6'),
         ]),
     ])
     ->generate();
 
-```
+```

src/Providers/OpenAI/Maps/MessageMap.php

@@ -9,6 +9,7 @@
 use Prism\Prism\ValueObjects\Messages\AssistantMessage;
 use Prism\Prism\ValueObjects\Messages\Support\Document;
 use Prism\Prism\ValueObjects\Messages\Support\Image;
+use Prism\Prism\ValueObjects\Messages\Support\OpenAIFile;
 use Prism\Prism\ValueObjects\Messages\SystemMessage;
 use Prism\Prism\ValueObjects\Messages\ToolResultMessage;
 use Prism\Prism\ValueObjects\Messages\UserMessage;
@@ -84,6 +85,7 @@ protected function mapUserMessage(UserMessage $message): void
                 ['type' => 'text', 'text' => $message->text()],
                 ...self::mapImageParts($message->images()),
                 ...self::mapDocumentParts($message->documents()),
+                ...self::mapFileParts($message->files()),
             ],
         ];
     }
@@ -111,22 +113,34 @@ protected static function mapImageParts(array $images): array
     protected static function mapDocumentParts(array $documents): array
     {
         return array_map(function (Document $document): array {
-            if (! in_array($document->dataFormat, ['base64', 'file_id'])) {
+            if ($document->dataFormat !== 'base64') {
                 throw new \InvalidArgumentException("OpenAI does not support $document->dataFormat documents.");
             }
 
             return [
                 'type' => 'file',
-                'file' => $document->dataFormat === 'base64' ? [
+                'file' => [
                     'file_data' => sprintf('data:%s;base64,%s', $document->mimeType, $document->document), // @phpstan-ignore argument.type
                     'filename' => $document->documentTitle,
-                ] : [
-                    'file_id' => $document->document,
                 ],
             ];
         }, $documents);
     }
 
+    /**
+     * @param  OpenAIFile[]  $files
+     * @return array<int, mixed>
+     */
+    protected static function mapFileParts(array $files): array
+    {
+        return array_map(fn (OpenAIFile $file): array => [
+            'type' => 'file',
+            'file' => [
+                'file_id' => $file->fileId,
+            ],
+        ], $files);
+    }
+
     protected function mapAssistantMessage(AssistantMessage $message): void
     {
         $toolCalls = array_map(fn (ToolCall $toolCall): array => [

src/ValueObjects/Messages/Support/Document.php

@@ -134,15 +134,6 @@ public static function fromUrl(string $url, ?string $title = null, ?string $cont
         );
     }
 
-    public static function fromFileId(string $fileId): self
-    {
-        return new self(
-            document: $fileId,
-            mimeType: null,
-            dataFormat: 'file_id',
-        );
-    }
-
     public function isUrl(): bool
     {
         return $this->dataFormat === 'url';

src/ValueObjects/Messages/Support/OpenAIFile.php

@@ -0,0 +1,10 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Prism\Prism\ValueObjects\Messages\Support;
+
+readonly class OpenAIFile
+{
+    public function __construct(public string $fileId) {}
+}

src/ValueObjects/Messages/UserMessage.php

@@ -8,14 +8,15 @@
 use Prism\Prism\Contracts\Message;
 use Prism\Prism\ValueObjects\Messages\Support\Document;
 use Prism\Prism\ValueObjects\Messages\Support\Image;
+use Prism\Prism\ValueObjects\Messages\Support\OpenAIFile;
 use Prism\Prism\ValueObjects\Messages\Support\Text;
 
 class UserMessage implements Message
 {
     use HasProviderMeta;
 
     /**
-     * @param  array<int, Text|Image|Document>  $additionalContent
+     * @param  array<int, Text|Image|Document|OpenAIFile>  $additionalContent
      */
     public function __construct(
         protected readonly string $content,
@@ -58,4 +59,16 @@ public function documents(): array
             ->where(fn ($part): bool => $part instanceof Document)
             ->toArray();
     }
+
+    /**
+     * Note: Prism currently only supports previously uploaded Files with OpenAI.
+     *
+     * @return OpenAIFile[]
+     */
+    public function files(): array
+    {
+        return collect($this->additionalContent)
+            ->where(fn ($part): bool => $part instanceof OpenAIFile)
+            ->toArray();
+    }
 }

tests/Providers/OpenAI/MessageMapTest.php

@@ -8,6 +8,7 @@
 use Prism\Prism\ValueObjects\Messages\AssistantMessage;
 use Prism\Prism\ValueObjects\Messages\Support\Document;
 use Prism\Prism\ValueObjects\Messages\Support\Image;
+use Prism\Prism\ValueObjects\Messages\Support\OpenAIFile;
 use Prism\Prism\ValueObjects\Messages\SystemMessage;
 use Prism\Prism\ValueObjects\Messages\ToolResultMessage;
 use Prism\Prism\ValueObjects\Messages\UserMessage;
@@ -204,11 +205,11 @@
             ->toContain(base64_encode(file_get_contents('tests/Fixtures/test-pdf.pdf')));
     });
 
-    it('maps user messages with file_id documents', function (): void {
-        $messageMap = new MessageMap(
+    it('maps previously uploaded files', function (): void {
+        $messageMap = new \Prism\Prism\Providers\OpenAi\Maps\MessageMap(
             messages: [
                 new UserMessage('Here is the document', [
-                    Document::fromFileId('previously-uploaded-file-id'),
+                    new OpenAIFile('previously-uploaded-file-id'),
                 ]),
             ],
             systemPrompts: []

tests/ValueObjects/Messages/Support/DocumentTest.php

@@ -30,11 +30,3 @@
     expect($document->documentTitle)->toBe('title');
     expect($document->documentContext)->toBe('context');
 });
-
-it('can create a document from file_id', function (): void {
-    $document = Document::fromFileId('the-file-id');
-
-    expect($document->document)->toBe('the-file-id');
-    expect($document->mimeType)->toBeNull();
-    expect($document->dataFormat)->toBe('file_id');
-});