Title: wp-includes/php-ai-client/src/Results/DTO/GenerativeAiResult.php | Developer.WordPress.org

---

# File: wp-includes/php-ai-client/src/Results/DTO/GenerativeAiResult.php

 * method[GenerativeAiResult::toMessages()](https://developer.wordpress.org/reference/classes/wordpress-aiclient-results-dto-generativeairesult/tomessages/)
 * Converts all candidates to messages.
 * Used by [0 functions](https://developer.wordpress.org/reference/classes/wordpress-aiclient-results-dto-generativeairesult/tomessages/#used-by)
   | Uses [1 function](https://developer.wordpress.org/reference/classes/wordpress-aiclient-results-dto-generativeairesult/tomessages/#uses)
   | Source: [wp-includes/php-ai-client/src/Results/DTO/GenerativeAiResult.php:366](https://github.com/WordPress/wordpress-develop/blob/7.0/src/wp-includes/php-ai-client/src/Results/DTO/GenerativeAiResult.php#L366-L369)
 * method[GenerativeAiResult::getJsonSchema()](https://developer.wordpress.org/reference/classes/wordpress-aiclient-results-dto-generativeairesult/getjsonschema/)
 * {@inheritDoc}
 * Used by [1 function](https://developer.wordpress.org/reference/classes/wordpress-aiclient-results-dto-generativeairesult/getjsonschema/#used-by)
   | Uses [4 functions](https://developer.wordpress.org/reference/classes/wordpress-aiclient-results-dto-generativeairesult/getjsonschema/#uses)
   | Source: [wp-includes/php-ai-client/src/Results/DTO/GenerativeAiResult.php:375](https://github.com/WordPress/wordpress-develop/blob/7.0/src/wp-includes/php-ai-client/src/Results/DTO/GenerativeAiResult.php#L375-L378)
 * method[GenerativeAiResult::toArray()](https://developer.wordpress.org/reference/classes/wordpress-aiclient-results-dto-generativeairesult/toarray/)
 * {@inheritDoc}
 * Used by [0 functions](https://developer.wordpress.org/reference/classes/wordpress-aiclient-results-dto-generativeairesult/toarray/#used-by)
   | Uses [1 function](https://developer.wordpress.org/reference/classes/wordpress-aiclient-results-dto-generativeairesult/toarray/#uses)
   | Source: [wp-includes/php-ai-client/src/Results/DTO/GenerativeAiResult.php:386](https://github.com/WordPress/wordpress-develop/blob/7.0/src/wp-includes/php-ai-client/src/Results/DTO/GenerativeAiResult.php#L386-L389)
 * method[GenerativeAiResult::fromArray()](https://developer.wordpress.org/reference/classes/wordpress-aiclient-results-dto-generativeairesult/fromarray/)
 * {@inheritDoc}
 * Used by [1 function](https://developer.wordpress.org/reference/classes/wordpress-aiclient-results-dto-generativeairesult/fromarray/#used-by)
   | Uses [5 functions](https://developer.wordpress.org/reference/classes/wordpress-aiclient-results-dto-generativeairesult/fromarray/#uses)
   | Source: [wp-includes/php-ai-client/src/Results/DTO/GenerativeAiResult.php:395](https://github.com/WordPress/wordpress-develop/blob/7.0/src/wp-includes/php-ai-client/src/Results/DTO/GenerativeAiResult.php#L395-L400)
 * method[GenerativeAiResult::__clone()](https://developer.wordpress.org/reference/classes/wordpress-aiclient-results-dto-generativeairesult/__clone/)
 * Performs a deep clone of the result.
 * Used by [0 functions](https://developer.wordpress.org/reference/classes/wordpress-aiclient-results-dto-generativeairesult/__clone/#used-by)
   | Uses [0 functions](https://developer.wordpress.org/reference/classes/wordpress-aiclient-results-dto-generativeairesult/__clone/#uses)
   | Source: [wp-includes/php-ai-client/src/Results/DTO/GenerativeAiResult.php:409](https://github.com/WordPress/wordpress-develop/blob/7.0/src/wp-includes/php-ai-client/src/Results/DTO/GenerativeAiResult.php#L409-L419)
 * method[GenerativeAiResult::toVideoFile()](https://developer.wordpress.org/reference/classes/wordpress-aiclient-results-dto-generativeairesult/tovideofile/)
 * Converts the first candidate to a video file.
 * Used by [0 functions](https://developer.wordpress.org/reference/classes/wordpress-aiclient-results-dto-generativeairesult/tovideofile/#used-by)
   | Uses [1 function](https://developer.wordpress.org/reference/classes/wordpress-aiclient-results-dto-generativeairesult/tovideofile/#uses)
   | Source: [wp-includes/php-ai-client/src/Results/DTO/GenerativeAiResult.php:261](https://github.com/WordPress/wordpress-develop/blob/7.0/src/wp-includes/php-ai-client/src/Results/DTO/GenerativeAiResult.php#L261-L268)
 * method[GenerativeAiResult::toMessage()](https://developer.wordpress.org/reference/classes/wordpress-aiclient-results-dto-generativeairesult/tomessage/)
 * Converts the first candidate to a message.
 * Used by [0 functions](https://developer.wordpress.org/reference/classes/wordpress-aiclient-results-dto-generativeairesult/tomessage/#used-by)
   | Uses [0 functions](https://developer.wordpress.org/reference/classes/wordpress-aiclient-results-dto-generativeairesult/tomessage/#uses)
   | Source: [wp-includes/php-ai-client/src/Results/DTO/GenerativeAiResult.php:276](https://github.com/WordPress/wordpress-develop/blob/7.0/src/wp-includes/php-ai-client/src/Results/DTO/GenerativeAiResult.php#L276-L279)
 * method[GenerativeAiResult::toTexts()](https://developer.wordpress.org/reference/classes/wordpress-aiclient-results-dto-generativeairesult/totexts/)
 * Converts all candidates to text.
 * Used by [0 functions](https://developer.wordpress.org/reference/classes/wordpress-aiclient-results-dto-generativeairesult/totexts/#used-by)
   | Uses [1 function](https://developer.wordpress.org/reference/classes/wordpress-aiclient-results-dto-generativeairesult/totexts/#uses)
   | Source: [wp-includes/php-ai-client/src/Results/DTO/GenerativeAiResult.php:287](https://github.com/WordPress/wordpress-develop/blob/7.0/src/wp-includes/php-ai-client/src/Results/DTO/GenerativeAiResult.php#L287-L302)
 * method[GenerativeAiResult::toFiles()](https://developer.wordpress.org/reference/classes/wordpress-aiclient-results-dto-generativeairesult/tofiles/)
 * Converts all candidates to files.
 * Used by [3 functions](https://developer.wordpress.org/reference/classes/wordpress-aiclient-results-dto-generativeairesult/tofiles/#used-by)
   | Uses [1 function](https://developer.wordpress.org/reference/classes/wordpress-aiclient-results-dto-generativeairesult/tofiles/#uses)
   | Source: [wp-includes/php-ai-client/src/Results/DTO/GenerativeAiResult.php:310](https://github.com/WordPress/wordpress-develop/blob/7.0/src/wp-includes/php-ai-client/src/Results/DTO/GenerativeAiResult.php#L310-L325)
 * method[GenerativeAiResult::toImageFiles()](https://developer.wordpress.org/reference/classes/wordpress-aiclient-results-dto-generativeairesult/toimagefiles/)
 * Converts all candidates to image files.
 * Used by [0 functions](https://developer.wordpress.org/reference/classes/wordpress-aiclient-results-dto-generativeairesult/toimagefiles/#used-by)
   | Uses [1 function](https://developer.wordpress.org/reference/classes/wordpress-aiclient-results-dto-generativeairesult/toimagefiles/#uses)
   | Source: [wp-includes/php-ai-client/src/Results/DTO/GenerativeAiResult.php:333](https://github.com/WordPress/wordpress-develop/blob/7.0/src/wp-includes/php-ai-client/src/Results/DTO/GenerativeAiResult.php#L333-L336)
 * method[GenerativeAiResult::toAudioFiles()](https://developer.wordpress.org/reference/classes/wordpress-aiclient-results-dto-generativeairesult/toaudiofiles/)
 * Converts all candidates to audio files.
 * Used by [0 functions](https://developer.wordpress.org/reference/classes/wordpress-aiclient-results-dto-generativeairesult/toaudiofiles/#used-by)
   | Uses [1 function](https://developer.wordpress.org/reference/classes/wordpress-aiclient-results-dto-generativeairesult/toaudiofiles/#uses)
   | Source: [wp-includes/php-ai-client/src/Results/DTO/GenerativeAiResult.php:344](https://github.com/WordPress/wordpress-develop/blob/7.0/src/wp-includes/php-ai-client/src/Results/DTO/GenerativeAiResult.php#L344-L347)
 * method[GenerativeAiResult::toVideoFiles()](https://developer.wordpress.org/reference/classes/wordpress-aiclient-results-dto-generativeairesult/tovideofiles/)
 * Converts all candidates to video files.
 * Used by [0 functions](https://developer.wordpress.org/reference/classes/wordpress-aiclient-results-dto-generativeairesult/tovideofiles/#used-by)
   | Uses [1 function](https://developer.wordpress.org/reference/classes/wordpress-aiclient-results-dto-generativeairesult/tovideofiles/#uses)
   | Source: [wp-includes/php-ai-client/src/Results/DTO/GenerativeAiResult.php:355](https://github.com/WordPress/wordpress-develop/blob/7.0/src/wp-includes/php-ai-client/src/Results/DTO/GenerativeAiResult.php#L355-L358)
 * method[GenerativeAiResult::toText()](https://developer.wordpress.org/reference/classes/wordpress-aiclient-results-dto-generativeairesult/totext/)
 * Converts the first candidate to text.
 * Used by [0 functions](https://developer.wordpress.org/reference/classes/wordpress-aiclient-results-dto-generativeairesult/totext/#used-by)
   | Uses [0 functions](https://developer.wordpress.org/reference/classes/wordpress-aiclient-results-dto-generativeairesult/totext/#uses)
   | Source: [wp-includes/php-ai-client/src/Results/DTO/GenerativeAiResult.php:187](https://github.com/WordPress/wordpress-develop/blob/7.0/src/wp-includes/php-ai-client/src/Results/DTO/GenerativeAiResult.php#L187-L198)
 * method[GenerativeAiResult::toFile()](https://developer.wordpress.org/reference/classes/wordpress-aiclient-results-dto-generativeairesult/tofile/)
 * Converts the first candidate to a file.
 * Used by [3 functions](https://developer.wordpress.org/reference/classes/wordpress-aiclient-results-dto-generativeairesult/tofile/#used-by)
   | Uses [0 functions](https://developer.wordpress.org/reference/classes/wordpress-aiclient-results-dto-generativeairesult/tofile/#uses)
   | Source: [wp-includes/php-ai-client/src/Results/DTO/GenerativeAiResult.php:209](https://github.com/WordPress/wordpress-develop/blob/7.0/src/wp-includes/php-ai-client/src/Results/DTO/GenerativeAiResult.php#L209-L220)
 * method[GenerativeAiResult::toImageFile()](https://developer.wordpress.org/reference/classes/wordpress-aiclient-results-dto-generativeairesult/toimagefile/)
 * Converts the first candidate to an image file.
 * Used by [0 functions](https://developer.wordpress.org/reference/classes/wordpress-aiclient-results-dto-generativeairesult/toimagefile/#used-by)
   | Uses [1 function](https://developer.wordpress.org/reference/classes/wordpress-aiclient-results-dto-generativeairesult/toimagefile/#uses)
   | Source: [wp-includes/php-ai-client/src/Results/DTO/GenerativeAiResult.php:229](https://github.com/WordPress/wordpress-develop/blob/7.0/src/wp-includes/php-ai-client/src/Results/DTO/GenerativeAiResult.php#L229-L236)
 * method[GenerativeAiResult::toAudioFile()](https://developer.wordpress.org/reference/classes/wordpress-aiclient-results-dto-generativeairesult/toaudiofile/)
 * Converts the first candidate to an audio file.
 * Used by [0 functions](https://developer.wordpress.org/reference/classes/wordpress-aiclient-results-dto-generativeairesult/toaudiofile/#used-by)
   | Uses [1 function](https://developer.wordpress.org/reference/classes/wordpress-aiclient-results-dto-generativeairesult/toaudiofile/#uses)
   | Source: [wp-includes/php-ai-client/src/Results/DTO/GenerativeAiResult.php:245](https://github.com/WordPress/wordpress-develop/blob/7.0/src/wp-includes/php-ai-client/src/Results/DTO/GenerativeAiResult.php#L245-L252)
 * method[GenerativeAiResult::getAdditionalData()](https://developer.wordpress.org/reference/classes/wordpress-aiclient-results-dto-generativeairesult/getadditionaldata/)
 * {@inheritDoc}
 * Used by [0 functions](https://developer.wordpress.org/reference/classes/wordpress-aiclient-results-dto-generativeairesult/getadditionaldata/#used-by)
   | Uses [0 functions](https://developer.wordpress.org/reference/classes/wordpress-aiclient-results-dto-generativeairesult/getadditionaldata/#uses)
   | Source: [wp-includes/php-ai-client/src/Results/DTO/GenerativeAiResult.php:151](https://github.com/WordPress/wordpress-develop/blob/7.0/src/wp-includes/php-ai-client/src/Results/DTO/GenerativeAiResult.php#L151-L154)
 * method[GenerativeAiResult::getCandidateCount()](https://developer.wordpress.org/reference/classes/wordpress-aiclient-results-dto-generativeairesult/getcandidatecount/)
 * Gets the total number of candidates.
 * Used by [1 function](https://developer.wordpress.org/reference/classes/wordpress-aiclient-results-dto-generativeairesult/getcandidatecount/#used-by)
   | Uses [0 functions](https://developer.wordpress.org/reference/classes/wordpress-aiclient-results-dto-generativeairesult/getcandidatecount/#uses)
   | Source: [wp-includes/php-ai-client/src/Results/DTO/GenerativeAiResult.php:162](https://github.com/WordPress/wordpress-develop/blob/7.0/src/wp-includes/php-ai-client/src/Results/DTO/GenerativeAiResult.php#L162-L165)
 * method[GenerativeAiResult::hasMultipleCandidates()](https://developer.wordpress.org/reference/classes/wordpress-aiclient-results-dto-generativeairesult/hasmultiplecandidates/)
 * Checks if the result has multiple candidates.
 * Used by [0 functions](https://developer.wordpress.org/reference/classes/wordpress-aiclient-results-dto-generativeairesult/hasmultiplecandidates/#used-by)
   | Uses [1 function](https://developer.wordpress.org/reference/classes/wordpress-aiclient-results-dto-generativeairesult/hasmultiplecandidates/#uses)
   | Source: [wp-includes/php-ai-client/src/Results/DTO/GenerativeAiResult.php:173](https://github.com/WordPress/wordpress-develop/blob/7.0/src/wp-includes/php-ai-client/src/Results/DTO/GenerativeAiResult.php#L173-L176)
 * class[GenerativeAiResult](https://developer.wordpress.org/reference/classes/wordpress-aiclient-results-dto-generativeairesult/)
 * Represents the result of a generative AI operation.
 * Used by [0 functions](https://developer.wordpress.org/reference/classes/wordpress-aiclient-results-dto-generativeairesult/#used-by)
   | Uses [0 functions](https://developer.wordpress.org/reference/classes/wordpress-aiclient-results-dto-generativeairesult/#uses)
   | Source: [wp-includes/php-ai-client/src/Results/DTO/GenerativeAiResult.php:38](https://github.com/WordPress/wordpress-develop/blob/7.0/src/wp-includes/php-ai-client/src/Results/DTO/GenerativeAiResult.php#L38-L420)
 * method[GenerativeAiResult::__construct()](https://developer.wordpress.org/reference/classes/wordpress-aiclient-results-dto-generativeairesult/__construct/)
 * Constructor.
 * Used by [1 function](https://developer.wordpress.org/reference/classes/wordpress-aiclient-results-dto-generativeairesult/__construct/#used-by)
   | Uses [0 functions](https://developer.wordpress.org/reference/classes/wordpress-aiclient-results-dto-generativeairesult/__construct/#uses)
   | Source: [wp-includes/php-ai-client/src/Results/DTO/GenerativeAiResult.php:83](https://github.com/WordPress/wordpress-develop/blob/7.0/src/wp-includes/php-ai-client/src/Results/DTO/GenerativeAiResult.php#L83-L94)
 * method[GenerativeAiResult::getId()](https://developer.wordpress.org/reference/classes/wordpress-aiclient-results-dto-generativeairesult/getid/)
 * {@inheritDoc}
 * Used by [0 functions](https://developer.wordpress.org/reference/classes/wordpress-aiclient-results-dto-generativeairesult/getid/#used-by)
   | Uses [0 functions](https://developer.wordpress.org/reference/classes/wordpress-aiclient-results-dto-generativeairesult/getid/#uses)
   | Source: [wp-includes/php-ai-client/src/Results/DTO/GenerativeAiResult.php:100](https://github.com/WordPress/wordpress-develop/blob/7.0/src/wp-includes/php-ai-client/src/Results/DTO/GenerativeAiResult.php#L100-L103)
 * method[GenerativeAiResult::getCandidates()](https://developer.wordpress.org/reference/classes/wordpress-aiclient-results-dto-generativeairesult/getcandidates/)
 * Gets the generated candidates.
 * Used by [0 functions](https://developer.wordpress.org/reference/classes/wordpress-aiclient-results-dto-generativeairesult/getcandidates/#used-by)
   | Uses [0 functions](https://developer.wordpress.org/reference/classes/wordpress-aiclient-results-dto-generativeairesult/getcandidates/#uses)
   | Source: [wp-includes/php-ai-client/src/Results/DTO/GenerativeAiResult.php:111](https://github.com/WordPress/wordpress-develop/blob/7.0/src/wp-includes/php-ai-client/src/Results/DTO/GenerativeAiResult.php#L111-L114)
 * method[GenerativeAiResult::getTokenUsage()](https://developer.wordpress.org/reference/classes/wordpress-aiclient-results-dto-generativeairesult/gettokenusage/)
 * {@inheritDoc}
 * Used by [0 functions](https://developer.wordpress.org/reference/classes/wordpress-aiclient-results-dto-generativeairesult/gettokenusage/#used-by)
   | Uses [0 functions](https://developer.wordpress.org/reference/classes/wordpress-aiclient-results-dto-generativeairesult/gettokenusage/#uses)
   | Source: [wp-includes/php-ai-client/src/Results/DTO/GenerativeAiResult.php:120](https://github.com/WordPress/wordpress-develop/blob/7.0/src/wp-includes/php-ai-client/src/Results/DTO/GenerativeAiResult.php#L120-L123)
 * method[GenerativeAiResult::getProviderMetadata()](https://developer.wordpress.org/reference/classes/wordpress-aiclient-results-dto-generativeairesult/getprovidermetadata/)
 * Gets the provider metadata.
 * Used by [0 functions](https://developer.wordpress.org/reference/classes/wordpress-aiclient-results-dto-generativeairesult/getprovidermetadata/#used-by)
   | Uses [0 functions](https://developer.wordpress.org/reference/classes/wordpress-aiclient-results-dto-generativeairesult/getprovidermetadata/#uses)
   | Source: [wp-includes/php-ai-client/src/Results/DTO/GenerativeAiResult.php:131](https://github.com/WordPress/wordpress-develop/blob/7.0/src/wp-includes/php-ai-client/src/Results/DTO/GenerativeAiResult.php#L131-L134)
 * method[GenerativeAiResult::getModelMetadata()](https://developer.wordpress.org/reference/classes/wordpress-aiclient-results-dto-generativeairesult/getmodelmetadata/)
 * Gets the model metadata.
 * Used by [0 functions](https://developer.wordpress.org/reference/classes/wordpress-aiclient-results-dto-generativeairesult/getmodelmetadata/#used-by)
   | Uses [0 functions](https://developer.wordpress.org/reference/classes/wordpress-aiclient-results-dto-generativeairesult/getmodelmetadata/#uses)
   | Source: [wp-includes/php-ai-client/src/Results/DTO/GenerativeAiResult.php:142](https://github.com/WordPress/wordpress-develop/blob/7.0/src/wp-includes/php-ai-client/src/Results/DTO/GenerativeAiResult.php#L142-L145)