AI-Kit Backend REST API WordPress AI-hoz

Az AI‑Kit AWS-háttérrendszere a Chrome beépített AI-jával egyenértékű végpontokat tesz elérhetővé az /admin/* és /frontend/* alatt, továbbá segédeket biztosít a Tudásbázis listázásához és az előre aláírt feltöltésekhez.

A telepítés részletei, a paraméterleírások és a beállítási megjegyzések a Serverless Application Repository nyilvános README-fájljában találhatók: wpsuite-ai-kit az AWS SAR-ban.


Hitelesítés

A hitelesítést teljes egészében az alkalmazás telepítésekor választott SAR-paraméterek szabályozzák; lásd a fent hivatkozott nyilvános README-fájlt:

  • AdminApiAuthMode
  • FrontendApiAuthMode

Mindkettő NONE, IAM vagy COGNITO értékre állítható. A kiválasztott érték határozza meg az /admin/* vagy /frontend/* végpontokra irányuló kérések hitelesítését. A NONE értéket rendszerint reCAPTCHA vagy WAF (tűzfal) használatával párosítja a SAR-konfigurációban.

Engedélyezett reCAPTCHA-védelemnél a látogatói végpontok ezenfelül X-Recaptcha-Token fejlécet is igényelhetnek.


Hogyan használja a WordPress-bővítmény a háttérrendszert?

  • Az AI-Kit blokkjai, chatbotja és JavaScript API-jai az AI-Kit beállításai adminisztrációs képernyőn megadott értékek szerint automatikusan meghívják a háttérrendszert.
  • Ha a látogatói forgalom reCAPTCHA-védett, a bővítmény kliensoldalon kér tokeneket, így a kérések tartalmazzák a várt X-Recaptcha-Token fejlécet.
  • Ha a Gateyt átvitelként integrálja, és egyező apiName értéket állít be a Gatey beállításai → API-beállítások alatt, az IAM/Cognito-védett telepítések a felhasználó Gateyen keresztüli WordPress-bejelentkezése után észrevétlenül cserélhetik és frissíthetik a tokeneket.
  • Gatey-bekötés nélkül is közvetlenül meghívhatja a háttérrendszert saját kódjából, például fetch használatával a nyilvános végponton, a beállított hitelesítési móddal vagy hálózati szintű vezérlőkkel, például tűzfalakkal és engedélyezési listákkal.
  • Ezt a dokumentumot akkor használja, ha a beépített bővítményfunkciók helyett egyéni folyamatokat vagy külső eszközöket szeretne a telepített háttérrendszerre építeni.

Végpontok

A végpontok adminisztrációs (WordPress irányítópult) és látogatói (nyilvános felület) előtagokra oszlanak. Eltérő jelzés hiányában mindkét készlet application/json tartalmat fogad.

Adminisztrációs végpontok (/admin/*)

ÚtvonalMetódusCél
/admin/knowledge-basesGETRAG-integrációhoz elérhető Bedrock-tudásbázisok listázása
/admin/promptPOSTÁltalános utasításkezelési API-egyenértékűség, SEO-folyamatok használják
/admin/generate-upload-urlGETElőre aláírt S3 feltöltési URL-ek multimodális utasításokhoz
/admin/summarizePOSTÖsszefoglaló háttérrendszerbeli tartaléka
/admin/writePOSTSzövegíró háttérrendszerbeli tartaléka, alapértelmezetten engedélyezett KB-val
/admin/rewritePOSTÁtíró háttérrendszerbeli tartaléka
/admin/translatePOSTFordító háttérrendszerbeli tartaléka
/admin/proofreadPOSTKorrektor háttérrendszerbeli tartaléka
/admin/detect-languagePOSTNyelvfelismerő háttérrendszerbeli tartaléka

Látogatói végpontok (/frontend/*)

Ezeket SAR-paraméterek (EnableSummarizerBackend, EnableChatbotBackend, EnableLanguageAIBackend) kapcsolják. Engedélyezve az adminisztrációs útvonalakat tükrözik, és X-Recaptcha-Token értéket igényelhetnek.

ÚtvonalMetódusMegjegyzés
/frontend/promptPOSTA chatbot sendChatMessage és sendFeedbackMessage metódusa használja
/frontend/generate-upload-urlGETElőre aláírt feltöltések a nyilvános chatbothoz
/frontend/summarizePOSTAz adminisztrációs összefoglalóval azonos adattartalom
/frontend/writePOSTAz adminisztrációs szövegíróval azonos adattartalom
/frontend/rewritePOSTAz adminisztrációs átíróval azonos adattartalom
/frontend/translatePOSTAz adminisztrációs fordítóval azonos adattartalom
/frontend/proofreadPOSTAz adminisztrációs korrektorral azonos adattartalom
/frontend/detect-languagePOSTAz adminisztrációs nyelvfelismerővel azonos adattartalom

Minta-adattartalmak

// /admin/prompt (or /frontend/prompt)
{
"messages": [
{ "role": "system", "content": "You are a helpful assistant." },
{ "role": "user", "content": "Extract a title and 5 bullet points from the text below..." }
],
"saveChatSession": false
}
// /admin/write
{
"text": "Write a short product description...",
"tone": "professional",
"format": "markdown",
"length": "short",
"outputLanguage": "en"
}
// /admin/translate (source language required)
{
"text": "Hello world",
"sourceLanguage": "en",
"targetLanguage": "hu"
}
// /admin/language-detector
{
"text": "Szia! Hogy vagy?"
}
// /admin/proofread
{
"text": "I has a apple.",
"expectedInputLanguages": ["en"]
}

Hibaválaszok

A hibák ErrorResponse alakzatot adnak vissza állapotkóddal, üzenettel és választható részletekkel. Gyakori okok:

  • túl nagy adattartalom (képfeltöltések, hosszú utasítások)
  • érvénytelen felsorolási értékek, például hiányzó sourceLanguage a fordítóhoz
  • hiányzó hitelesítő adatok vagy az IAM, Cognito, WAF, illetve reCAPTCHA elutasítása