# betterdocs/4.9.2/includes/REST/AIFaq.php

BetterDocs – AI Documentation, Knowledge Base, MCP Server, Docs, Wikis, FAQ & Chatbot, version 4.9.2. 144 lines.

- Page: https://pluginprobe.com/plugins/betterdocs/4.9.2/code/includes/REST/AIFaq.php
- Raw: https://pluginprobe.com/plugins/betterdocs/4.9.2/raw/includes/REST/AIFaq.php
- Modified: 2026-07-07T09:55:00+00:00

Line numbers below start at 1. Link to a line or a range by appending a fragment to the
page URL, for example `https://pluginprobe.com/plugins/betterdocs/4.9.2/code/includes/REST/AIFaq.php#L10-L20`.

````php
<?php

namespace WPDeveloper\BetterDocs\REST;

use WP_REST_Request;
use WPDeveloper\BetterDocs\Core\BaseAPI;
use WPDeveloper\BetterDocs\Utils\AIUsage;

/**
 * Server-side proxy for the "Write FAQ with BetterDocs AI" feature.
 *
 * The FAQ builder used to call OpenAI directly from the browser with the secret API key —
 * this endpoint moves that call server-side so the key never leaves the site. Uses the
 * same dynamic model/token settings as Write with AI (write_with_ai_model).
 */
class AIFaq extends BaseAPI {

    const MAX_QUESTION_LENGTH = 500;
    const MAX_KEYWORDS_LENGTH = 300;

    public function register() {
        $this->post(
            '/ai-faq',
            array( $this, 'generate' ),
            array(
                'question' => array(
                    'type'     => 'string',
                    'required' => true
                ),
                'keywords' => array(
                    'type'     => 'string',
                    'required' => false,
                    'default'  => ''
                )
            )
        );
    }

    public function permission_check() {
        return current_user_can( 'edit_others_posts' );
    }

    public function generate( WP_REST_Request $request ) {
        $settings = betterdocs()->settings;

        if ( ! $settings->get( 'enable_faq_write_with_ai', true ) ) {
            return $this->error(
                'ai_disabled',
                __( 'Write FAQ with AI is disabled. Enable it from BetterDocs settings.', 'betterdocs' ),
                400
            );
        }

        $write_ai = betterdocs()->ai_autowrtie;
        if ( empty( $write_ai ) || empty( $write_ai->get_api_key() ) ) {
            return $this->error(
                'ai_no_key',
                __( 'OpenAI API key is missing. Add one in BetterDocs settings.', 'betterdocs' ),
                400
            );
        }

        $question = trim( wp_strip_all_tags( (string) $request->get_param( 'question' ) ) );
        $keywords = trim( wp_strip_all_tags( (string) $request->get_param( 'keywords' ) ) );

        if ( $question === '' ) {
            return $this->error(
                'ai_empty_question',
                __( 'Please provide a question for the AI.', 'betterdocs' ),
                400
            );
        }

        if ( strlen( $question ) > self::MAX_QUESTION_LENGTH ) {
            $question = substr( $question, 0, self::MAX_QUESTION_LENGTH );
        }
        if ( strlen( $keywords ) > self::MAX_KEYWORDS_LENGTH ) {
            $keywords = substr( $keywords, 0, self::MAX_KEYWORDS_LENGTH );
        }

        $prompt = sprintf(
            'Write a clear, concise answer in plain text for the following FAQ question related to %s. The question: %s',
            $keywords,
            $question
        );
        $system = __( 'You are a helpful assistant that writes clear, concise FAQ answers in plain text. Do not use any Markdown or special formatting — no asterisks, bold, italics, headings, bullet points, backticks or code fences. Reply with a direct answer written in plain sentences.', 'betterdocs' );

        $result = $write_ai->generate_text( $prompt, $system );

        if ( empty( $result['success'] ) ) {
            $message = isset( $result['error'] ) ? (string) $result['error'] : __( 'Unknown AI error.', 'betterdocs' );
            return $this->error( 'ai_upstream', $message, 502 );
        }

        $answer = $this->clean_response( (string) $result['content'] );

        if ( $answer === '' ) {
            return $this->error(
                'ai_empty_response',
                __( 'The AI returned no answer. Try again or rephrase your question.', 'betterdocs' ),
                502
            );
        }

        // FAQ answers are generated before the FAQ post exists — no reliable post id.
        AIUsage::record( 'faq_write_with_ai' );

        return $this->success(
            array(
                'answer' => $answer,
                'model'  => isset( $result['model'] ) ? $result['model'] : null
            )
        );
    }

    /**
     * Strip the leading "Answer:" label / stray leading "?" the browser-side code removed.
     */
    protected function clean_response( $text ) {
        $text = trim( $text );
        $text = preg_replace( '/^\s*answer\s*:\s*/i', '', $text );
        $text = preg_replace( '/^\s*\?/', '', $text );
        $text = $this->strip_markdown( $text );

        return trim( $text );
    }

    /**
     * Safety net: strip the common Markdown the model may still emit despite the
     * plain-text instruction, so FAQ answers never render literal asterisks.
     */
    protected function strip_markdown( $text ) {
        $text = preg_replace( '/```.*?```/s', '', $text );          // fenced code blocks
        $text = preg_replace( '/\*\*(.+?)\*\*/s', '$1', $text );    // **bold**
        $text = preg_replace( '/__(.+?)__/s', '$1', $text );        // __bold__
        $text = preg_replace( '/`([^`]*)`/', '$1', $text );         // `inline code`
        $text = preg_replace( '/^\s{0,3}#{1,6}\s+/m', '', $text );  // # headings
        $text = preg_replace( '/^\s{0,3}>\s?/m', '', $text );       // > blockquotes
        $text = preg_replace( '/^\s{0,3}[-*+]\s+/m', '', $text );   // -, *, + bullet markers

        return trim( $text );
    }
}

````