Modiwl Chatbot Drupal

Defnyddiwch fodiwl Drupal swyddogol ChattyBox pan fyddwch eisiau gosodiad a reolir gan Composer ar gyfer safle Drupal 10 neu Drupal 11. Mae’n llwytho’r widget a gynhelir ar lwybrau HTML cyhoeddus ac yn cadw endpoint API cynhyrchu wedi’i ffurfweddu’n awtomatig. Mae'r canllaw hwn yn ymdrin â'r gosod gweithredol. Mae tudalen modiwl chatbot AI Drupal yn cwmpasu'r cynnyrch a'r broses gwerthuso.

Cyn Gosod

Cwblhewch y llif Cychwyn Arni yn gyntaf: cysylltwch eich URL Drupal cyhoeddus, adolygwch dudalennau sydd wedi’u mynegeio a gwiriwch atebion cynrychioliadol yn Test Chat. Yna crëwch allwedd gyhoeddus ddiogel i’r porwr yn Public Keys a’i chopïo o dab Embed y prosiect.

Gosod Composer

Caiff y modiwl ei ddosbarthu ar hyn o bryd fel pecyn â thag yn storfa GitHub gyhoeddus. Nid yw wedi'i restru eto ar Drupal.org na Packagist, felly mae angen datganiad y storfa VCS isod ar Composer cyn y gall composer require ei ddatrys.

Ychwanegwch y storfa GitHub gyhoeddus at composer.json gwraidd y prosiect Drupal sy’n ei defnyddio:

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

Os oes gan y prosiect adran repositories eisoes, unwch y cofnod chattybox-drupal â hi. Yna gosodwch y modiwl wedi’i dagio:

composer require openstaticfish/chattybox-drupal:^0.1

Mae’r pecyn wedi’i ddatgan fel drupal-module ac mae angen Drupal ^10 || ^11 arno. Mae llwybrau gosod Composer Drupal safonol yn ei roi o dan web/modules/contrib/.

Adolygwch god ffynhonnell modiwl Drupal cyhoeddus a newidiadau wedi’u tagio cyn uwchraddio. Nid yw diweddariadau Drupal.org a reolir gan gyfeiriadur ar gael eto.

I brofi’r gangen ddatblygu gyfredol yn lle hynny:

composer require openstaticfish/chattybox-drupal:dev-main

Galluogi a Ffurfweddu

1. Galluogwch ChattyBox o Extend, neu rhedwch drush en chattybox.
2. Agorwch Configuration > Web services > ChattyBox.
3. Gludwch allwedd API gyhoeddus y widget yn unig o dab Embed y prosiect.
4. Gadewch URL sgript y widget a gynhelir, oni bai bod ChattyBox wedi darparu URL loader rhagolwg neu hunangynhaliol.
5. Gadewch y diystyru iaith yn wag i ddilyn polisi locale y prosiect; yn Auto mae iaith y dudalen yn dod cyn iaith y porwr, ac yn Fixed defnyddir diofyn y prosiect. Mae cod fel en, fr neu de yn gweithio dim ond os caniateir diystyru sgript.
6. Galluogwch y chatbot ac arbedwch y ffurfweddiad.

Nid yw’r modiwl yn llwytho ar lwybrau gweinyddol nac ar gyfer ymatebion nad ydynt yn HTML. Mae’n ychwanegu’r allwedd gyhoeddus, endpoint cynhyrchu a reolir, locale dewisol a loader y widget drwy lyfrgell ddatganedig Drupal a drupalSettings.

Mae gosodiadau newydd yn dechrau’n anabl; mae’r ffurflen yn /admin/config/services/chattybox ac mae angen y caniatâd administer chattybox configuration. Mae’r modiwl yn llwytho’r widget, ond nid yw’n cropian nac yn cydamseru cynnwys Drupal. Mae’r endpoint API wedi’i hadeiladu i mewn, nid yw’n deillio o’r allwedd; defnyddiwch y pyt â llaw os yw Embed yn dangos deployment arall. Mae cyfyngiadau tarddiad yn ddewisol ac yn gofyn am union gynllun, enw gwesteiwr a phorth.

Eithrio Llwybrau Ychwanegol

Mae’r modiwl yn hepgor llwybrau gweinyddol yn awtomatig. Gall modiwl pwrpasol analluogi’r widget ar lwybrau cyhoeddus ychwanegol gyda hook_chattybox_load_widget_alter():

Nid yw hepgor llwybrau gweinyddol yn wiriad preifatrwydd ar bob llwybr frontend; ychwanegwch eithriadau ar gyfer checkout, cyfrif ac aelodaeth.

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

Wrth Gefn â Llaw

Composer yw’r llwybr gosod a argymhellir. Os na all eich deployment Drupal ddefnyddio Composer, copïwch y modiwl i web/modules/custom/chattybox neu gyfeiriadur modiwl pwrpasol arall, ei alluogi a’i ffurfweddu o Configuration > Web services > ChattyBox.

Peidiwch â gludo manylyn rheoli i’r modiwl. Mae allwedd API gyhoeddus y widget wedi’i bwriadu ar gyfer marcio frontend. Defnyddiwch un loader yn unig: nid y modiwl a phyt thema, GTM neu atodiad SDK gyda’i gilydd.

Dilysu

Ar ôl ffurfweddu’r modiwl:

• Agorwch dudalen Drupal gyhoeddus mewn ffenestr incognito.
• Cadarnhewch fod lansiwr y widget yn ymddangos unwaith.
• Gofynnwch gwestiwn go iawn gan ymwelydd.
• Gwiriwch fod ateb a gefnogir yn dyfynnu tudalennau Drupal cyhoeddus wedi’u mynegeio, a bod cwestiwn heb gefnogaeth yn dangos y fallback, a all fod heb ffynonellau.
• Gwiriwch gonsol y porwr am data-api-key, data-api-url coll neu wallau allwedd.

Profwch lwybrau wedi’u heithrio a rhai a gynhwysir gyda’r caches Drupal/tudalen/CDN yn oer ac wedi’u cynhesu, ac ailadeiladwch caches perthnasol ar ôl newid gosodiadau neu hooks. Nid yw eithriad llwybr ar y gweinydd yn tynnu widget sydd eisoes wedi’i lwytho yn ystod llywio ochr-cleient.

Ewch ymlaen â’r rhestr wirio lansio cyn cyhoeddi’r chatbot.