> For the complete documentation index, see [llms.txt](https://docs.fact-finder.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.fact-finder.com/integration/de/factfinder-search-integration/fact-finder-search-parameters.md). # FactFinder-Suchparameter Wenn Sie über die REST-API eine Suchanfrage an den FactFinder Search-Server senden, können Sie mehrere Parameter verwenden, um zu steuern, welche Ergebnisse zurückgegeben werden und wie sie zurückgegeben werden. Einige Parameter sind erforderlich. Andere sind optional oder nur in bestimmten Fällen relevant. Immer wenn Sie Daten an FactFinder senden, stellen Sie sicher, dass die Kodierung korrekt eingestellt ist. UTF-8 ist die Standard- und erforderliche Kodierung, um Sonderzeichen korrekt zu verarbeiten. > Die verfügbaren Suchparameter sind außerdem in der Suchanwendung **Swagger UI** unter dem `search` Methode. ## Grundlegende Parameter Dies sind die grundlegenden Parameter, die in nahezu jeder Suchanfrage verwendet werden: * `query` *(String, erforderlich)* – Der Suchbegriff oder die Suchphrase, die in der FactFinder-Datenbank nachgeschlagen werden soll. Dieser Parameter ist zusammen mit `channel`, für jede Suchanfrage zwingend erforderlich. Er repräsentiert, wonach der Nutzer sucht. * `channel` *(String, erforderlich, Pfad)* – Die Kennung des Kanals, in dem gesucht werden soll. Wenn die Suchumgebung mehrere Kanäle enthält, etwa einen pro Sprache oder Produktkategorie, gibt dieser Parameter an, welcher Kanal verwendet werden soll. Wenn kein Kanal angegeben wird, verwendet das System den ersten auf dem Server konfigurierten Kanal. * `page` *(Ganzzahl)* – Die Seitennummer der abzurufenden Ergebnisse. Suchergebnisse werden paginiert, wenn es mehr Einträge gibt als die Standard-Seitengröße. Mit diesem Parameter können Sie eine bestimmte Ergebnisseite anfordern. Die Seitennummerierung beginnt bei 1, daher ist `page=1` die erste Seite. * `hitsPerPage` *(Ganzzahl)* – Die Anzahl der Ergebnisse, die pro Seite zurückgegeben werden. Die FactFinder-Managementoberfläche definiert eine Standardanzahl von Treffern pro Seite. Die Verwendung von `hitsPerPage` überschreibt diesen Standard für eine bestimmte Abfrage. Zum Beispiel `hitsPerPage=20` fordert 20 Ergebnisse an. Wenn Sie keinen Wert angeben, wird der konfigurierte Standard verwendet. * `sort` *(Array von Strings)* – Sortierkriterien für die Ergebnisse, abgesehen von der standardmäßigen Sortierung nach Relevanz. Sie können ein oder mehrere Sortierkriterien angeben. Jedes Kriterium wird normalerweise als `FieldName:order`, wobei `Reihenfolge` ist `asc` oder `desc`. Wenn mehrere Kriterien angegeben werden, werden sie nacheinander angewendet. Zum Beispiel `sort=Manufacturer:asc` sortiert die Ergebnisse nach dem Feld "Manufacturer" in aufsteigender Reihenfolge. * `filter` *(Array von Strings)* – Filter/Navigation: Filtert die Ergebnisse nach bestimmten Feldwerten. Ein Filter schränkt den Ergebnissatz auf Datensätze ein, die bestimmte Werte in einem Feld enthalten, oft für Kategorie- oder Attributfilterung. Das Format ist normalerweise `filter=FieldName:Value`. Ein Filter kann mehrere Werte haben. Die Werte können durch die folgenden Zeichen getrennt werden, die in `config.xml`: * ‚und‘ = `___` * ‚oder‘ = `~~~` Ein Filterwert kann mit dem Präfix `!`ausgeschlossen werden. Zum Beispiel, `filter=color:Red~~~!Green` kann interpretiert werden als *color ist Red ODER color ist NICHT Green*. In diesem Beispiel, `~~~` dient als ODER-Trennzeichen zwischen "Red" und "!Green". Das `!` Präfix vor "Green" schließt diesen Wert aus. Numerische Filter/Navigation verwenden die standardmäßige mathematische Intervallschreibweise, aber als Eingabe sind nur Intervalle zulässig, die links geschlossen und rechts offen sind. Daher sind nur Intervalle der Form `[a,b)`, `[a,)`, oder `[a,]` sind zulässig. Eckige Klammern `[` `]` kennzeichnen inklusive Grenzen und runde Klammern `(` `)` kennzeichnen exklusive Grenzen. Für Werte vom Typ Datum kann dieselbe Notation wie bei numerischen Filter/Navigation verwendet werden. Zum Beispiel könnte ein Filter, um alle Elemente mit einem Startdatum innerhalb der 1990er Jahre einzuschließen, wie folgt aussehen: `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:flag\_mm:ssZZ), ein Unix-Zeitstempel in Millisekunden oder das für das jeweilige Feld definierte Format sein. * `substringFilter` *(Array von Strings)* – Filtert nach einem Teilstring des Feldwerts. Ein Filter kann mehrere Werte haben. Die Werte können durch die folgenden Zeichen getrennt werden, die in `config.xml`: ‚und‘ = `___` ‚oder‘ = `~~~` Ein Filterwert kann mit dem Präfix `!`. * `searchField` *(String)* – Während FactFinder normalerweise in allen durchsuchbaren Feldern sucht, beschränkt dieser Parameter die Suche auf ein einzelnes Feld. * `articleNumberSearch` *(String)* – Gibt an, ob die Abfrage als Artikelnummer interpretiert werden soll. Der Standardwert ist `DETECT`. * `sid` *(String)* – Repräsentiert die Sitzungs-ID, die der Suchanfrage zugeordnet ist. * `userInput` *(String)* – Übermittelt die vom Shop-Benutzer eingegebenen Zeichen, bevor die Suchanfrage ausgelöst wurde. * `queryFromSuggest` *(boolean)* – Gibt an, dass die Abfrage aus der Vorschlagsliste gestartet wurde. In diesem Fall senden Sie den Parameter mit dem Wert `true`. ## Parameter zur Steuerung des Suchvorgangs * `useSearch` *(boolean)* - Wenn auf `true`gesetzt wird, 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/Navigation für die Suchergebnisse erzeugt werden. Der Standardwert für diesen Parameter ist `true`. * `useFoundWords` *(boolean)* - Steuert, ob die Wörter, die verwendet wurden, um die Datensätze zu finden, für die gefundenen Ergebnisse zurückgegeben werden. Die Ermittlung dieser Wörter benötigt CPU-Zeit, und aus diesem Grund ist diese Funktion standardmäßig deaktiviert (`false`). Setzen Sie den Parameter auf `true` true `false` wenn Suchwörter nicht erforderlich sind. Der Standardwert ist `false`. * `useCampaigns` *(boolean)* - Steuert, ob der Campaign Manager prüft, ob die Suchanfrage zu einer konfigurierten Kampagne passt. Wenn auf `true`true `false`gesetzt wird, werden Kampagnen ausgewertet und entsprechend zurückgegeben. Wenn auf * `idsOnly` *(boolean)* - Standardmäßig enthält das Suchergebnis alle Feldinformationen für die gefundenen Produkte. Wenn Sie nur Produkt-IDs benötigen, setzen Sie diesen Parameter auf `true`. Dadurch wird verhindert, dass Feldinhalte zurückgegeben werden, und Bandbreite gespart. Der Standardwert ist `false`. * `useCache` *(boolean)* - Wenn auf `true`, wird das Suchergebnis aus dem Cache-Speicher zurückgegeben, wenn bereits ein möglicher passender Treffer im Cache vorhanden ist. Der Standardwert für diesen Parameter ist `true`. * `cacheIrrelevant` *(Array von Strings)* - Wird verwendet, um bestimmte Parameter für Caching-Zwecke als irrelevant zu kennzeichnen. * `usePersonalization` *(boolean)* - Ermöglicht die Aktivierung oder Deaktivierung der Abfrage-Personalisierung. Wenn auf `true`true `false`gesetzt wird, wird das Suchergebnis personalisiert, sofern das Personalisierungsmodul aktiviert ist und alle anderen relevanten Voraussetzungen erfüllt sind. Wenn auf `true`. * `useSemanticEnhancer` *(boolean)* - Ermöglicht die Aktivierung oder Deaktivierung der semantischen Anreicherung von Abfragen. Wenn auf `true`true `false`gesetzt wird, wird das Suchergebnis semantisch angereichert, sofern das Enhancer-Modul aktiviert ist und alle anderen relevanten Voraussetzungen erfüllt sind. Wenn auf `true`. * `useAso` *(boolean)* - Ermöglicht die Aktivierung oder Deaktivierung der automatischen Suchoptimierung. Wenn auf `true`true `false`gesetzt wird, wird das Suchergebnis automatisch optimiert. Wenn auf `true`. * `maxCountVariants` *(Ganzzahl)* - Wenn Produktvarianten in den Daten verwendet werden (beispielsweise ein Produkt mit mehreren Varianten wie unterschiedlichen Größen oder Farben), definiert dieser Parameter die maximale Anzahl von Varianten, die für jeden Hauptproduktdatensatz in den Ergebnissen zurückgegeben werden. Damit lässt sich begrenzen, wie viele Varianten zurückgegeben werden, um eine übermäßig große Antwort zu vermeiden. * `advisorStatus` *(String)* - Wird zusammen mit Advisor, einer Guided-Selling- oder Kampagnenfunktion, verwendet. Dieser Parameter kann die aktuelle Kampagnen-ID und den Antwortpfad des Benutzers in einem Guided-Selling-Ablauf enthalten. Das Format ist typischerweise `campaignId-answerPath`. Es teilt FactFinder den aktuellen Zustand des Dialogs mit, wenn die Abfrage verarbeitet wird. * `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, auf dessen Basis Varianten dedupliziert werden sollen. ## Zusätzliche Parameter * `format` - Das Ausgabeformat der Suchergebnisse. Da die XML- und JSON-Schnittstellen über eine URL aufgerufen werden, legt dieser Parameter fest, welches Format zurückgegeben werden soll. Wenn kein Wert angegeben wird, wird das Ergebnis standardmäßig im HTML-Format zurückgegeben. Unterstützte Werte sind `xml`, `json`, und `jsonp`. * `version` - FactFinder bietet versionierte APIs, um reibungslosere Migrationen zu unterstützen. Dadurch ist es möglich, auf eine neuere FactFinder-Version zu aktualisieren, ohne den Integrationscode sofort ändern zu müssen. Sie können die Integration später aktualisieren, um neue Funktionen zu nutzen. In FactFinder 7.2 werden die Werte `6.11`, `7.0`, `7.1`, und `7.2` werden unterstützt. In der Regel ist eine Standardversion in den Anwendungseinstellungen konfiguriert, sodass Sie diesen Parameter normalerweise nicht explizit übergeben müssen. * `omitContextName` - Wenn Sie `true`übergeben, beginnen die zurückgegebenen URLs der Suchparameter mit dem Aktionsnamen statt mit dem Namen der FactFinder-Anwendung. Dies kann in load-balancierten Setups nützlich sein, in denen verschiedene FactFinder-Anwendungen unterschiedliche Namen verwenden. Es kann außerdem die Menge der übertragenen Daten in Standardbereitstellungen reduzieren. * `Log` - Ein optionaler Parameter, der der Suchanfrage für Protokollierungszwecke eine benutzerdefinierte Beschreibungszeichenfolge hinzufügt. Er muss zusätzlich zur Suchanfrage übergeben werden. Dies ist nützlich, wenn Sie nur bestimmte Suchanfragen auswerten möchten. Die bereitgestellte Beschreibung bleibt bei der Protokollanalyse sichtbar. Der Wert sollte nur Buchstaben und Zahlen enthalten. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.fact-finder.com/integration/de/factfinder-search-integration/fact-finder-search-parameters.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.