WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

PromptBuilder::withFile()

PromptBuilder::withFile( string|WordPressAiClientFilesDTOFile $file, string|null $mimeType = null ): self

In this article

Back to top

Adds a file to the current message.

Description

Accepts:

  • File object
  • URL string (remote file)
  • Base64-encoded data string
  • Data URI string (data:mime/type;base64,data)
  • Local file path string

Parameters

$filestring|WordPressAiClientFilesDTOFilerequired
The file (File object or string representation).
$mimeTypestring|nulloptional
The MIME type (optional, ignored if File object provided).

Default:null

Return

self

Source

public function withFile($file, ?string $mimeType = null): self
{
    $file = $file instanceof File ? $file : new File($file, $mimeType);
    $part = new MessagePart($file);
    $this->appendPartToMessages($part);
    return $this;
}

View all references View on Trac View on GitHub

UsesDescription
MessagePart::__construct()wp-includes/php-ai-client/src/Messages/DTO/MessagePart.php

Constructor that accepts various content types and infers the message part type.

File::__construct()wp-includes/php-ai-client/src/Files/DTO/File.php

Constructor.

PromptBuilder::appendPartToMessages()wp-includes/php-ai-client/src/Builders/PromptBuilder.php

Appends a MessagePart to the messages array.

Changelog

VersionDescription
0.1.0Introduced.

User Contributed Notes

You must log in before being able to contribute a note or feedback.