pr-vision/includes/core/class-prv-probe-result.php

<?php
/**
 * Immutable value object returned by every probe provider.
 *
 * @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.
 *
 * v0.3.0 adds tokens_in/tokens_out for per-call cost attribution.
 *
 * 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.
	 * @param int|null $tokens_in      Input token count from the API response (null if unknown).
	 * @param int|null $tokens_out     Output token count from the API response (null if unknown).
	 */
	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,
		private readonly ?int $tokens_in = null,
		private readonly ?int $tokens_out = null
	) {}

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

	/**
	 * Get the input token count for this call (null if not reported by provider).
	 *
	 * @return int|null
	 */
	public function get_tokens_in(): ?int {
		return $this->tokens_in;
	}

	/**
	 * Get the output token count for this call (null if not reported by provider).
	 *
	 * @return int|null
	 */
	public function get_tokens_out(): ?int {
		return $this->tokens_out;
	}
}