Brauche ich das npm-Paket?

Nein. Ist das npm-Paket nicht verfügbar, suche direkt mit fetch. Siehe Externe Integrationen.

Wie authentifiziere ich mich?

Mit einem API-Key im Header x-api-key. Der Key gehört ausschliesslich auf den Server. Siehe Voraussetzungen.

Kann ich direkt aus dem Browser suchen?

Nicht mit deinem API-Key: schickst du ihn in den Browser, ist er offengelegt. Rufe den Service aus deinem eigenen Backend auf und gib die Ergebnisse ans Frontend weiter. Siehe API-Keys.

Woher bekomme ich die Group ID?

Aus dem Tuix Dashboard: die Tabelle Knowledge groups zeigt die Group ID jeder Gruppe, mit einem Kopier-Symbol daneben. Siehe Eine Knowledge Group anlegen.

Kann ich steuern, ob die Suche eher Bedeutung oder genauen Wortlaut bevorzugt?

Nicht direkt: der Service kombiniert beides automatisch und verfeinert die Reihenfolge mit einem Reranking-Schritt, es gibt nichts, was du pro Knowledge Group konfigurieren müsstest. Siehe Suche und Ranking.

Wie beschränke ich eine Suche auf bestimmte Inhalte?

Markiere Resources mit einer Role und gib dieselbe Role in der Suchanfrage mit. Resources ohne Role werden immer einbezogen. Siehe Role Filter.

Was bekomme ich zurück?

Eine Liste passender Chunks unter results, jeweils mit Text und einem Relevanz-score, sortiert nach höchstem Wert zuerst. Siehe Request-Referenz.

Warum liefert eine Suche keine Ergebnisse, oder einen Hinweis?

Prüfe das notes-Array in der Antwort: es erklärt Dinge wie eine leere Knowledge Group oder eine Anfrage, die zu nichts wirklich gepasst hat. Siehe Ergebnisse verstehen.