FactFinder-Suchparameter

Beim Senden einer Suchanfrage an den FactFinder Search Server (über die REST-API) können eine Reihe von Parametern angegeben werden, um zu steuern, welche Ergebnisse zurückgegeben werden und wie. Einige dieser Parameter sind erforderlich, andere sind optional oder kontextabhängig.

Wann immer Daten an FactFinder übermittelt werden, ist es wichtig, dass die Codierung korrekt eingestellt ist. UTF-8 ist die standardmäßige und erforderliche Codierung, damit FactFinder Sonderzeichen richtig verarbeiten kann

Die verfügbaren Suchparameter sind auch dokumentiert im Swagger-UI unter der Methode search.

Grundlegende Parameter

Dies sind die grundlegenden Parameter, die in nahezu jeder Suchanfrage häufig verwendet werden:

• query (String, erforderlich) – Der Suchbegriff oder die Phrase, die in der FactFinder-Datenbank gesucht werden soll. Dieser Parameter ist zusammen mit channel, für jede Suchanfrage obligatorisch. Er stellt dar, wonach der Benutzer sucht.

• channel (String, erforderlich, Pfad) – Die Kennung des Kanals, in dem gesucht werden soll. Wenn die Suchumgebung mehrere Kanäle enthält (z. B. einen pro Sprache oder Produktkategorie), legt dieser Parameter fest, welcher Kanal für die Abfrage verwendet werden soll. Wenn kein Kanal angegeben ist, verwendet das System standardmäßig den ersten auf dem Server konfigurierten Kanal.

• page (Ganzzahl) – Die Seitenzahl der Ergebnisse, die abgerufen werden sollen. Suchergebnisse werden paginiert, wenn mehr Elemente vorhanden sind als die Standardseitenanzahl. Mit diesem Parameter kann eine bestimmte Seite der Gesamtergebnisse angefordert werden. Die Seitenzählung beginnt bei 1 (page=1 ist die erste Ergebnisseite).

• hitsPerPage (Ganzzahl) – Die Anzahl der Ergebnisse, die pro Seite zurückgegeben werden sollen. Die FactFinder-Verwaltungsoberfläche definiert eine Standardanzahl von Treffern (Ergebnissen) pro Seite für die Suche. Durch die Verwendung von hitsPerPage wird dieser Standard für eine bestimmte Abfrage überschrieben. Zum Beispiel hitsPerPage=20 fordert 20 Ergebnisse in der Antwort an. Wenn nicht angegeben, wird der konfigurierte Standardwert verwendet.

• sort (Array von Strings) – Gibt Sortierkriterien für die Ergebnisse an, abgesehen von der standardmäßigen Relevanzsortierung. Es können ein oder mehrere Sortierkriterien angegeben werden. Jedes Kriterium wird üblicherweise als FieldName:orderangegeben. Die Reihenfolge kann asc (aufsteigend) oder desc (absteigend) sein. Wenn mehrere Sortierkriterien angegeben sind, werden sie nacheinander angewendet. Zum Beispiel sort=Manufacturer:asc würde die Ergebnisse nach dem Feld „Manufacturer“ in aufsteigender Reihenfolge sortieren.

• filter (Array von Strings) – Filtert die Ergebnisse nach angegebenen Feldwerten. Ein Filter schränkt die Ergebnismenge auf Datensätze ein, die bestimmte Werte in einem gegebenen Feld haben (oft verwendet für Kategorie- oder Attributfilter usw.). Das Format ist typischerweise filter=FieldName:Value

Ein Filter kann mehrere Werte haben; die Werte können mit den folgenden Zeichen getrennt werden (konfigurierbar in der config.xml)":

• ‘und’ = ___

• ‘oder’ = ~~~

Ein Filterwert kann mit dem Präfix ausgeschlossen werden ! Format: filter=color:Red~~~!Green kann interpretiert werden als Farbe ist Rot ODER Farbe ist NICHT Grün. In diesem Beispiel wird ~~~ als ODER-Trennzeichen zwischen „Red“ und „!Green“ verwendet. Der ! Präfix vor „Green“ kennzeichnet den Ausschluss dieses Wertes.

Numerische Filter verwenden die standardmäßige mathematische Intervallschreibweise, jedoch sind nur Intervalle zulässig, die links abgeschlossen und rechts geöffnet sind. Daher sind nur Intervalle der Form [a,b), [a,)oder [a,] zulässig. Eckige Klammern [ ] bezeichnen inklusive Grenzen und runde Klammern ( ) bezeichnen exklusive Grenzen.

Für Werte des Typs Datum kann die gleiche Notation wie für numerische Filter verwendet werden. Beispielsweise könnte ein Filter, um alle Elemente mit einem Startdatum in den 1990er Jahren einzuschließen, lauten: filter=startdate1: [1990-01-01T00:00:00+00:00,2000-01-01T00:00:00+00:00). Das Datumsformat kann entweder ISO-8601 mit Zeitzone (yyyy-MM-dd'T'HH:mm:ssZZ), ein Unix-Timestamp in Millisekunden oder das für das spezifische Feld definierte Format sein.

• substringFilter (Array von Strings) - Filter für eine Teilzeichenkette des Feldwerts. Ein Filter kann mehrere Werte haben; die Werte können mit den folgenden Zeichen getrennt werden (konfigurierbar in der config.xml)

  ‘und’ = ___

  ‘oder’ = ~~~

Ein Filterwert kann mit dem Präfix ausgeschlossen werden ! Format

• searchField (String) - Während FactFinder normalerweise alle Felder durchsucht, die als durchsuchbar definiert wurden, ist es auch möglich, die Suche mit diesem Parameter auf genau ein bestimmtes Feld zu beschränken.

• articleNumberSearch (String) - Gibt an, ob die Abfrage als Artikelnummer interpretiert werden soll. Der Standardwert ist DETECT

• sid (String) - Repräsentiert die Session-ID, die mit der Suchanfrage verknüpft ist.

• userInput (String) - Dieser Parameter wird verwendet, um die Zeichen zu übermitteln, die der Shop-Benutzer eingegeben hat, bis die Suchanfrage ausgelöst wurde.

• queryFromSuggest (Boolean) - Zeigt an, dass die Abfrage durch eine Auswahl aus der Vorschlagsliste initiiert wurde. In diesem Fall sollte der Parameter mit dem Wert true.

Parameter zur Steuerung des Suchprozesses

• useSearch (Boolean) - Wenn auf truegesetzt, wird die Suche für die angegebene Abfrage ausgeführt. Der Standardwert für diesen Parameter ist true.

• useAsn (Boolean) - Wenn auf true, sollten Filter für die Suchergebnisse generiert werden. Der Standardwert für diesen Parameter ist true.

• useFoundWords (Boolean) - Steuert, ob die Wörter, die zur Auffindung der Datensätze verwendet wurden, für die gefundenen Ergebnisse zurückgegeben werden. Die Ermittlung dieser Wörter erfordert CPU-Zeit, und aus diesem Grund ist diese Funktion standardmäßig deaktiviert (false). Setzen Sie den Parameter auf true um die Generierung der Suchwörter zu aktivieren oder auf false wenn Suchwörter nicht benötigt werden. Der Standardwert ist false.

• useCampaigns (Boolean) - Steuert, ob der Campaign Manager prüft, ob die Suchanfrage mit einer konfigurierten Kampagne übereinstimmt. Wenn auf truegesetzt, werden Kampagnen ausgewertet und gegebenenfalls zurückgegeben. Wenn auf falsegesetzt, werden Kampagnen ignoriert.

• idsOnly (Boolean) - Standardmäßig enthält das Suchergebnis alle Feldinformationen über die gefundenen Produkte. Wenn nur die IDs der Produkte benötigt werden, kann dieser Parameter auf true gesetzt werden, um zu verhindern, dass Feldinhalte zurückgegeben werden, und damit Bandbreite zu sparen. Der Standardwert ist false, was bedeutet, dass Feldinhalte übermittelt werden.

• useCache (Boolean) - Wenn auf true, wird das Suchergebnis aus dem Cache-Speicher zurückgegeben, wenn ein möglicherweise passendes Ergebnis bereits im Cache vorhanden ist. Der Standardwert für diesen Parameter ist true.

• cacheIrrelevant (Array von Strings) - Wird verwendet, um bestimmte Parameter als für Caching-Zwecke irrelevant zu kennzeichnen.

• usePersonalization (Boolean) - Ermöglicht die Aktivierung oder Deaktivierung der Personalisierung von Abfragen. Wenn auf truegesetzt, wird das Suchergebnis personalisiert, vorausgesetzt, das Personalisierungsmodul ist aktiviert und alle anderen relevanten Voraussetzungen sind erfüllt. Wenn auf falsegesetzt, wird das Suchergebnis nicht personalisiert. Der Standardwert für diesen Parameter ist true.

• useSemanticEnhancer (Boolean) - Ermöglicht die Aktivierung oder Deaktivierung der semantischen Verbesserung von Abfragen. Wenn auf truegesetzt, wird das Suchergebnis semantisch verbessert, vorausgesetzt, das Enhancer-Modul ist aktiviert und alle anderen relevanten Voraussetzungen sind erfüllt. Wenn auf falsegesetzt, wird keine semantische Verbesserung angewendet. Der Standardwert für diesen Parameter ist true.

• useAso (Boolean) - Ermöglicht die Aktivierung oder Deaktivierung der automatischen Suchoptimierung. Wenn auf truegesetzt, wird das Suchergebnis automatisch optimiert. Wenn auf falsegesetzt, wird das Suchergebnis nicht optimiert. Der Standardwert für diesen Parameter ist true.

• maxCountVariants (Ganzzahl) - Wenn Produktvarianten in den Daten verwendet werden (z. B. ein Produkt mit mehreren Varianten wie verschiedene Größen oder Farben), definiert dieser Parameter die maximale Anzahl von Variantenartikeln, die für jeden Hauptproduktdatensatz in den Ergebnissen zurückgegeben werden sollen. Dies kann verwendet werden, um zu begrenzen, wie viele Varianten zurückgegeben werden, um eine übermäßig große Antwort zu vermeiden.

• advisorStatus (String) - Wird in Verbindung mit Advisor (einer Guided-Selling- oder Kampagnenfunktion) verwendet. Dieser Parameter kann die aktuelle Kampagnen-ID und den Antwortpfad des Benutzers in einem Guided-Selling-Szenario tragen. Das erwartete Format ist typischerweise campaignId-answerPath. Es hilft FactFinder, den Zustand eines Dialogs oder einer Advisor-Kampagne bei der Verarbeitung der Abfrage zu kennen.

• useDeduplication (Boolean) - Wenn auf true, wird die konfigurierte Deduplizierung von Varianten auf die Suchergebnisse angewendet. Der Standardwert für diesen Parameter ist true.

• deduplicationField (String) - Gibt das Feld an, nach dem Varianten dedupliziert werden sollen.

Zusätzliche Parameter

• Format - Das Antwortformat der Suchergebnisse. Da die XML- und JSON-Schnittstellen über eine URL aufgerufen werden, ist ein Parameter erforderlich, um das Format zu spezifizieren, in dem das Suchergebnis geliefert werden soll. Wenn diesem Parameter kein Wert zugewiesen wird, wird das Ergebnis standardmäßig im HTML-Format zurückgegeben. Mögliche Werte, die verwendet werden können, sind xml, jsonund jsonp.

• version - Um die Migration zu neueren Versionen zu erleichtern, stellt FactFinder versionierte APIs bereit. Dies ermöglicht Aktualisierungen auf eine neuere FactFinder-Version, ohne sofortige Änderungen am Integrationscode zu erfordern. Falls nötig, kann der Integrationscode anschließend angepasst werden, um neue Funktionen der neueren Version zu nutzen. In FactFinder 7.2 können die Werte 6.11, 7.0, 7.1und 7.2 für diesen Parameter verwendet werden. Bitte beachten Sie, dass in den Anwendungseinstellungen eine Standardversion konfiguriert ist, wodurch die explizite Verwendung dieses Parameters standardmäßig nicht erforderlich ist.

• omitContextName- Wenn für diesen Parameter der Wert true übergeben wird, beginnen die zurückgegebenen Suchparameter-URLs mit dem Aktionsnamen anstelle des Namens der FactFinder-Serveranwendung. Diese Funktionalität kann in Lastverteilungsinstallationen von Vorteil sein, in denen verschiedene FactFinder-Anwendungen unterschiedliche Namen haben können, oder sie kann in Standardbereitstellungen verwendet werden, um möglicherweise das zu übertragende Datenvolumen zu reduzieren.

• log - Ein optionaler Parameter, der das Anhängen eines benutzerdefinierten Beschreibungsstrings an die Suchanfrage für Protokollierungszwecke ermöglicht. Muss zusätzlich zur Suchanfrage übergeben werden. Der Wert des Parameters ist die Beschreibung der Logdatei. In bestimmten Situationen ist es nützlich, eine Beschreibung innerhalb einer Logdatei zu hinterlegen, z. B. wenn nur bestimmte Suchanfragen ausgewertet werden sollen. Die angegebene Beschreibung ist dann bei der Analyse der Logdatei sichtbar. Der Wert dieses Parameters sollte nur Buchstaben und Zahlen enthalten.