Candidate

24class Candidate extends AbstractDataTransferObject25{26    public const KEY_MESSAGE = 'message';27    public const KEY_FINISH_REASON = 'finishReason';28    /**29     * @var Message The generated message.30     */31    private Message $message;32    /**33     * @var FinishReasonEnum The reason generation stopped.34     */35    private FinishReasonEnum $finishReason;36    /**37     * Constructor.38     *39     * @since 0.1.040     *41     * @param Message $message The generated message.42     * @param FinishReasonEnum $finishReason The reason generation stopped.43     */44    public function __construct(Message $message, FinishReasonEnum $finishReason)45    {46        if (!$message->getRole()->isModel()) {47            throw new InvalidArgumentException('Message must be a model message.');48        }49        $this->message = $message;50        $this->finishReason = $finishReason;51    }52    /**53     * Gets the generated message.54     *55     * @since 0.1.056     *57     * @return Message The message.58     */59    public function getMessage(): Message60    {61        return $this->message;62    }63    /**64     * Gets the finish reason.65     *66     * @since 0.1.067     *68     * @return FinishReasonEnum The finish reason.69     */70    public function getFinishReason(): FinishReasonEnum71    {72        return $this->finishReason;73    }74    /**75     * {@inheritDoc}76     *77     * @since 0.1.078     */79    public static function getJsonSchema(): array80    {81        return ['type' => 'object', 'properties' => [self::KEY_MESSAGE => Message::getJsonSchema(), self::KEY_FINISH_REASON => ['type' => 'string', 'enum' => FinishReasonEnum::getValues(), 'description' => 'The reason generation stopped.']], 'required' => [self::KEY_MESSAGE, self::KEY_FINISH_REASON]];82    }83    /**84     * {@inheritDoc}85     *86     * @since 0.1.087     *88     * @return CandidateArrayShape89     */90    public function toArray(): array91    {92        return [self::KEY_MESSAGE => $this->message->toArray(), self::KEY_FINISH_REASON => $this->finishReason->value];93    }94    /**95     * {@inheritDoc}96     *97     * @since 0.1.098     */99    public static function fromArray(array $array): self100    {101        static::validateFromArrayData($array, [self::KEY_MESSAGE, self::KEY_FINISH_REASON]);102        $messageData = $array[self::KEY_MESSAGE];103        return new self(Message::fromArray($messageData), FinishReasonEnum::from($array[self::KEY_FINISH_REASON]));