68ae5b9b1a
All violations were present in v0.1.0 and hidden by continue-on-error. Now that PHPCS gates the build (P2-B), they must be fixed. - Add file-level @package doc comment to all PHP files (file doc requirement) - Add short descriptions to @var and constructor docblocks throughout - Fix @param type spacing throughout (PHPCS alignment rules) - Expand phpcs:ignore lines to include NoCaching where DirectQuery is already suppressed (uninstall.php, cost-ledger, table-manager, collector) - Suppress EscapeOutput.ExceptionNotEscaped on RuntimeException messages (exception strings are not HTML output) - Suppress error_log_error_log on the probe-runner failure log - Replace date() with gmdate() in panel (timezone-aware per WP standard) - Convert inline associative arrays to multi-line in config (WP array style) - Fix double-arrow alignment in probe-runner counts and insert arrays - Fix double-space before ?? in provider constructors - Expand phpcs:ignore for reads to include MissingUnslash - Fix $counts++ to ++$counts (prefix increment per WP standard) - Fix V1/v1 capitalisation in interface doc long description Agent-Session: pr-vision rename v0.1.1
83 lines
2.1 KiB
PHP
83 lines
2.1 KiB
PHP
<?php
|
|
/** @package PrVision */
|
|
declare(strict_types=1);
|
|
|
|
/**
|
|
* Value object: the result of a single LLM probe call.
|
|
*
|
|
* Returned by every PRV_Probe_Provider implementation. Immutable — all
|
|
* fields are set in the constructor and read via typed getters.
|
|
*
|
|
* Who triggers: PRV_Perplexity_Provider and PRV_OpenRouter_Provider.
|
|
* Dependencies: None.
|
|
*
|
|
* @see interface-prv-probe-provider.php — Provider interface that returns this.
|
|
* @see class-prv-probe-runner.php — Consumes the result for storage.
|
|
* @see CONTEXT.md — "probe result", "cited", "our_position".
|
|
* @package PrVision
|
|
*/
|
|
class PRV_Probe_Result {
|
|
|
|
/**
|
|
* Constructor.
|
|
*
|
|
* @param string $raw_excerpt First ~500 chars of the LLM's response.
|
|
* @param string[] $source_domains Domains extracted from the provider's citations.
|
|
* @param bool $cited Whether peptiderepo.com appears in source_domains.
|
|
* @param int|null $our_position 1-based position of peptiderepo.com in sources, or null.
|
|
* @param float $cost_usd Estimated call cost in USD.
|
|
*/
|
|
public function __construct(
|
|
private readonly string $raw_excerpt,
|
|
private readonly array $source_domains,
|
|
private readonly bool $cited,
|
|
private readonly ?int $our_position,
|
|
private readonly float $cost_usd
|
|
) {}
|
|
|
|
/**
|
|
* Get the raw LLM response excerpt.
|
|
*
|
|
* @return string
|
|
*/
|
|
public function get_raw_excerpt(): string {
|
|
return $this->raw_excerpt;
|
|
}
|
|
|
|
/**
|
|
* Get the extracted source domains.
|
|
*
|
|
* @return string[]
|
|
*/
|
|
public function get_source_domains(): array {
|
|
return $this->source_domains;
|
|
}
|
|
|
|
/**
|
|
* Whether peptiderepo.com was cited.
|
|
*
|
|
* @return bool
|
|
*/
|
|
public function is_cited(): bool {
|
|
return $this->cited;
|
|
}
|
|
|
|
/**
|
|
* Get 1-based position of peptiderepo.com in source list.
|
|
*
|
|
* @return int|null 1-based position or null when not cited.
|
|
*/
|
|
public function get_our_position(): ?int {
|
|
return $this->our_position;
|
|
}
|
|
|
|
/**
|
|
* Get the estimated cost of this probe call.
|
|
*
|
|
* @return float Estimated cost in USD.
|
|
*/
|
|
public function get_cost_usd(): float {
|
|
return $this->cost_usd;
|
|
}
|
|
}
|