WordPress\AiClient\Results\DTO

GenerativeAiResult::__construct │ public │ WP 0.1.0

Constructor.

Method of the class: GenerativeAiResult{}

No Hooks.

Returns

null. Nothing (null).

Usage

$GenerativeAiResult = new GenerativeAiResult();
$GenerativeAiResult->__construct( $id, $candidates, $tokenUsage, $providerMetadata, $modelMetadata, $additionalData );

$id(string) (required)

Unique identifier for this result.

$candidates(Candidate[]) (required)

The generated candidates.

$tokenUsage(TokenUsage) (required)

Token usage statistics.

$providerMetadata(ProviderMetadata) (required)

Provider metadata.

$modelMetadata(ModelMetadata) (required)

Model metadata.

$additionalData(array)

.
Default: []

Changelog

GenerativeAiResult::__construct() GenerativeAiResult:: construct code ^{WP 7.0.2}

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;
}