GenerativeAiResult

Description

Compatibility

Present in 2 of the 5 tracked releases, added in 0.1.0.

Properties · 6

$idstringprivate

$candidatesWordPress\AiClient\Results\DTO\Candidate[]private

$tokenUsageWordPress\AiClient\Results\DTO\TokenUsageprivate

$providerMetadataWordPress\AiClient\Providers\DTO\ProviderMetadataprivate

$modelMetadataWordPress\AiClient\Providers\Models\DTO\ModelMetadataprivate

$additionalDataWordPress\AiClient\Results\DTO\array<string,private

Methods · 25

• __construct()Constructor.
• getId(){@inheritDoc}
• getCandidates()Gets the generated candidates.
• getTokenUsage(){@inheritDoc}
• getProviderMetadata()Gets the provider metadata.
• getModelMetadata()Gets the model metadata.
• getAdditionalData(){@inheritDoc}
• getCandidateCount()Gets the total number of candidates.
• hasMultipleCandidates()Checks if the result has multiple candidates.
• toText()Converts the first candidate to text.
• toFile()Converts the first candidate to a file.
• toImageFile()Converts the first candidate to an image file.
• toAudioFile()Converts the first candidate to an audio file.
• toVideoFile()Converts the first candidate to a video file.
• toMessage()Converts the first candidate to a message.
• toTexts()Converts all candidates to text.
• toFiles()Converts all candidates to files.
• toImageFiles()Converts all candidates to image files.
• toAudioFiles()Converts all candidates to audio files.
• toVideoFiles()Converts all candidates to video files.
• toMessages()Converts all candidates to messages.
• getJsonSchema(){@inheritDoc}
• toArray(){@inheritDoc}
• fromArray(){@inheritDoc}
• __clone()Performs a deep clone of the result.

Source code

View on Trac ↗View on GitHub ↗

38class GenerativeAiResult extends AbstractDataTransferObject implements ResultInterface39{40    public const KEY_ID = 'id';41    public const KEY_CANDIDATES = 'candidates';42    public const KEY_TOKEN_USAGE = 'tokenUsage';43    public const KEY_PROVIDER_METADATA = 'providerMetadata';44    public const KEY_MODEL_METADATA = 'modelMetadata';45    public const KEY_ADDITIONAL_DATA = 'additionalData';46    /**47     * @var string Unique identifier for this result.48     */49    private string $id;50    /**51     * @var Candidate[] The generated candidates.52     */53    private array $candidates;54    /**55     * @var TokenUsage Token usage statistics.56     */57    private \WordPress\AiClient\Results\DTO\TokenUsage $tokenUsage;58    /**59     * @var ProviderMetadata Provider metadata.60     */61    private ProviderMetadata $providerMetadata;62    /**63     * @var ModelMetadata Model metadata.64     */65    private ModelMetadata $modelMetadata;66    /**67     * @var array<string, mixed> Additional data.68     */69    private array $additionalData;70    /**71     * Constructor.72     *73     * @since 0.1.074     *75     * @param string $id Unique identifier for this result.76     * @param Candidate[] $candidates The generated candidates.77     * @param TokenUsage $tokenUsage Token usage statistics.78     * @param ProviderMetadata $providerMetadata Provider metadata.79     * @param ModelMetadata $modelMetadata Model metadata.80     * @param array<string, mixed> $additionalData Additional data.81     * @throws InvalidArgumentException If no candidates provided.82     */83    public function __construct(string $id, array $candidates, \WordPress\AiClient\Results\DTO\TokenUsage $tokenUsage, ProviderMetadata $providerMetadata, ModelMetadata $modelMetadata, array $additionalData = [])84    {85        if (empty($candidates)) {86            throw new InvalidArgumentException('At least one candidate must be provided');87        }88        $this->id = $id;89        $this->candidates = $candidates;90        $this->tokenUsage = $tokenUsage;91        $this->providerMetadata = $providerMetadata;92        $this->modelMetadata = $modelMetadata;93        $this->additionalData = $additionalData;94    }95    /**96     * {@inheritDoc}97     *98     * @since 0.1.099     */100    public function getId(): string101    {102        return $this->id;103    }104    /**105     * Gets the generated candidates.106     *107     * @since 0.1.0108     *109     * @return Candidate[] The candidates.110     */111    public function getCandidates(): array112    {113        return $this->candidates;114    }115    /**116     * {@inheritDoc}117     *

Changelog

Introduced in 0.1.0. Unchanged from 7.0.4 through 7.1.0.

1. 7.0.4
2. 7.1.0

Signature, return type and hooks compared across 2 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 7.1.0 tag, from src/wp-includes/php-ai-client/src/Results/DTO/GenerativeAiResult.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.