Drupal-chatbotmoduuli

Käytä virallista ChattyBoxin Drupal-moduulia, kun haluat Composerin hallitseman asennuksen Drupal 10- tai Drupal 11 -sivustolle. Se lataa isännöidyn widgetin julkisilla HTML-reiteillä ja määrittää tuotannon API-päätepisteen automaattisesti. Tämä opas kattaa käyttöönoton. Drupalin AI-chatbotmoduulin sivu esittelee tuotteen ja arviointiprosessin.

Ennen asennusta

Suorita ensin Aloittaminen -prosessi: yhdistä julkinen Drupal-URL-osoitteesi, tarkista indeksoidut sivut ja varmista edustavat vastaukset Test Chat -osiossa. Luo sitten selaimessa turvallinen julkinen avain kohdassa Public Keys ja kopioi se projektin Embed-välilehdeltä.

Composer-asennus

Moduuli jaellaan tällä hetkellä tagattuna pakettina julkisessa GitHub-repositoriossa. Sitä ei ole vielä listattu Drupal.orgissa tai Packagistissa, joten Composer tarvitsee alla olevan VCS-repositorion määrityksen ennen kuin composer require voi ratkaista paketin.

Lisää julkinen GitHub-repositorio sitä käyttävän Drupal-projektin juuren composer.json-tiedostoon:

{
  "repositories": {
    "chattybox-drupal": {
      "type": "vcs",
      "url": "https://github.com/OpenStaticFish/chattybox-drupal.git"
    }
  }
}

Jos projektissa on jo repositories-osio, yhdistä chattybox-drupal-merkintä siihen. Asenna sitten merkitty moduuli:

composer require openstaticfish/chattybox-drupal:^0.1

Paketti on määritelty drupal-module-paketiksi ja se vaatii Drupalin ^10 || ^11. Drupalin tavalliset Composer-asennuspolut sijoittavat sen hakemistoon web/modules/contrib/.

Tutustu julkiseen Drupal-moduulin lähdekoodiin ja tagattuihin muutoksiin ennen päivittämistä. Drupal.orgin hakemistosta hallittuja päivityksiä ei ole vielä saatavilla.

Voit testata nykyistä kehityshaaraa sen sijaan näin:

composer require openstaticfish/chattybox-drupal:dev-main

Ota käyttöön ja määritä

1. Ota ChattyBox käyttöön kohdassa Extend tai suorita drush en chattybox.
2. Avaa Configuration > Web services > ChattyBox.
3. Liitä vain projektin Embed-välilehdeltä saatava widgetin julkinen API-avain.
4. Säilytä isännöidyn widget-komentosarjan URL-osoite, ellei ChattyBox ole antanut esikatselun tai itse isännöidyn loaderin URL-osoitetta.
5. Jätä kieliohitus tyhjäksi, jotta projekti noudattaa locale-käytäntöään, tai anna tuettu pienaakkosinen koodi, kuten en, fr tai de. Auto-tilassa sivun kieli voittaa selaimen kielen, Fixed-tila käyttää projektin oletuslokaalia ja ohitus vaikuttaa vain, jos projekti sallii skriptiohitukset.
6. Ota chatbot käyttöön ja tallenna asetukset.

Moduulia ei ladata hallintareiteillä eikä muissa kuin HTML-vastauksissa. Se lisää julkisen avaimen, hallitun tuotannon päätepisteen, valinnaisen lokaalinsäätimen ja widgetin loaderin Drupalin ilmoitetun kirjaston sekä drupalSettings-asetusten kautta. Uusi asennus on pois käytöstä, ja avain sekä kieliohitus ovat tyhjiä.

API-päätepiste on sisäänrakennettu moduuliin, eikä sitä päätellä avaimesta. Loader-URL:n muuttaminen ei muuta päätepistettä; käytä manuaalista widget-katkelmaa, jos Embed-katkelma käyttää toista API-käyttöönottoa. Julkiset avaimet toimivat oletuksena kaikista selainorigineista. Jos otat origin-rajoituksen käyttöön, lisää jokainen sallittu scheme, isäntänimi ja portti.

Sulje muita reittejä pois

Moduuli ohittaa hallintareitit automaattisesti. Tämä ei ole kaikkien frontend-reittien yksityisyystarkistus; sulje kassa-, tili- ja jäsenyysreitit erikseen. Mukautettu moduuli voi poistaa widgetin käytöstä muilla julkisilla reiteillä hook_chattybox_load_widget_alter()-funktion avulla:

/**
 * Implements hook_chattybox_load_widget_alter().
 */
function mymodule_chattybox_load_widget_alter(&$should_load, $config, $route_match) {
  if ('commerce_checkout.form' === $route_match->getRouteName()) {
    $should_load = FALSE;
  }
}

Manuaalinen varavaihtoehto

Composer on suositeltu asennustapa. Jos Drupal-julkaisusi ei voi käyttää Composeria, kopioi moduuli hakemistoon web/modules/custom/chattybox tai muuhun mukautettujen moduulien hakemistoon, ota se käyttöön ja määritä se kohdassa Configuration > Web services > ChattyBox.

Älä liitä moduuliin hallintatunnusta. Widgetin julkinen API-avain on tarkoitettu frontend-merkintää varten.

Vahvistus

Kun olet määrittänyt moduulin:

• Avaa julkinen Drupal-sivu incognito-ikkunassa.
• Varmista, että widgetin käynnistin näkyy kerran.
• Esitä todellinen kävijän kysymys.
• Varmista, että tuettu vastaus viittaa indeksoituihin julkisiin Drupal-sivuihin ja että tukematon kysymys käyttää varavastausta, jolla voi olla tyhjät lähteet.
• Tarkista selaimen konsolista puuttuvat data-api-key- tai data-api-url-arvot ja avainvirheet.

Jatka julkaisun tarkistuslistaan ennen chatbotin julkistamista.