GenerativeAiResult::toFile(): WordPressAiClientFilesDTOFile

Converts the first candidate to a file.

Description

Only files from the content channel are considered. Files within model thought or reasoning are ignored.

Return

WordPressAiClientFilesDTOFile The file.

Source

public function toFile(): File
{
    $message = $this->candidates[0]->getMessage();
    foreach ($message->getParts() as $part) {
        $channel = $part->getChannel();
        $file = $part->getFile();
        if ($channel->isContent() && $file !== null) {
            return $file;
        }
    }
    throw new RuntimeException('No file content found in first candidate');
}

View all references View on Trac View on GitHub

Used by	Description
GenerativeAiResult::toVideoFile()`wp-includes/php-ai-client/src/Results/DTO/GenerativeAiResult.php`	Converts the first candidate to a video file.
GenerativeAiResult::toImageFile()`wp-includes/php-ai-client/src/Results/DTO/GenerativeAiResult.php`	Converts the first candidate to an image file.
GenerativeAiResult::toAudioFile()`wp-includes/php-ai-client/src/Results/DTO/GenerativeAiResult.php`	Converts the first candidate to an audio file.

Changelog

Version	Description
0.1.0	Introduced.

User Contributed Notes

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