WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

GenerativeAiResult::__construct()

GenerativeAiResult::__construct( string $id, WordPressAiClientResultsDTOCandidate[] $candidates, WordPressAiClientResultsDTOTokenUsage $tokenUsage, WordPressAiClientProvidersDTOProviderMetadata $providerMetadata, WordPressAiClientProvidersModelsDTOModelMetadata $modelMetadata,  $additionalData = [] )

In this article

Back to top

Constructor.

Parameters

$idstringrequired
Unique identifier for this result.
$candidatesWordPressAiClientResultsDTOCandidate[]required
The generated candidates.
$tokenUsageWordPressAiClientResultsDTOTokenUsagerequired
Token usage statistics.
$providerMetadataWordPressAiClientProvidersDTOProviderMetadatarequired
Provider metadata.
$modelMetadataWordPressAiClientProvidersModelsDTOModelMetadatarequired
Model metadata.
mixed> $additionalData Additional data.

Source

public function __construct(string $id, array $candidates, \WordPress\AiClient\Results\DTO\TokenUsage $tokenUsage, ProviderMetadata $providerMetadata, ModelMetadata $modelMetadata, array $additionalData = [])
{
    if (empty($candidates)) {
        throw new InvalidArgumentException('At least one candidate must be provided');
    }
    $this->id = $id;
    $this->candidates = $candidates;
    $this->tokenUsage = $tokenUsage;
    $this->providerMetadata = $providerMetadata;
    $this->modelMetadata = $modelMetadata;
    $this->additionalData = $additionalData;
}

View all references View on Trac View on GitHub

Used byDescription
GenerativeAiResult::fromArray()wp-includes/php-ai-client/src/Results/DTO/GenerativeAiResult.php

{@inheritDoc}

Changelog

VersionDescription
0.1.0Introduced.

User Contributed Notes

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