vtx.GetAutoCompleteResult

Dieser Job liefert Auto-Complete-Vorschläge der Volltext-Engine für einen Suchbegriff. Wird typischerweise im Such-Eingabefeld zur Anzeige von Live-Vorschlägen verwendet.

Der Job ist in der offiziellen enaio®-Doku nicht beschrieben, im VTX-Engine-Übersichts-Eintrag „Nicht dokumentierte Endpunkte" aber als bekannt aufgelistet. Diese Beschreibung wurde aus dem Aufruf-Code des enaio-jobs-custom-Templates rekonstruiert.

1. Eingabeparameter

Name Typ Pflicht Beschreibung

Flags

INT

Ja

Reserviert; stets 0 übergeben.

Term

STRING

Ja

Eingabewort, zu dem Vorschläge geliefert werden sollen.

[ObjectTypes]

STRING

Nein

Filterung der Vorschläge auf bestimmte Objekttypen. Format: separator-getrennte Liste numerischer Objekttyp-IDs (Trennzeichen wird im Aufruf-Code unverändert weitergereicht — typischerweise , oder ;).

2. Ausgabeparameter

Name Typ Abhängigkeit Beschreibung

Result

STRING

—

Vorschlagsliste im Format term1,score1;term2,score2;…. Einzelne Treffer sind durch ; getrennt; term und score werden durch , getrennt.

3. Rückgabe

(INT): 0 = Job erfolgreich, sonst Fehlercode.

4. Siehe auch

  • vtx.IsAutoCompleteEnabled — Feature-Flag-Abfrage (ebenfalls offiziell undokumentiert)

  • vtx.GetSearchResult — eigentliche Volltextsuche