Option

Beschreibung

Beispiel/Standardeinstellung

Column Name

Gibt die Spaltennamen des Indexes an, die für die Aggregation verwendet werden.

Beispiel:

mes:lang

Query Constraint

Gibt verschiedene Einschränkungen der Anfrage an. Zum Beispiel das Filtern nach Dokumentdatum.

Die Suche ist auf Systemmetadaten beschränkt:

• category
• categoryinstance
• fqcategory
• mes:key
• datasource/mes:key
• url
• extension
• mes:uniformdocid
• mes:date
• mes:size
• mes:lang
• mes:nonfilterable
• mes:filteredbymetadataonly
• store:modificationdate
• store:creationdate

Beispiel:

extension:html

Aggregation operator

• Definiert die Aggregationsoperation.

Vier Operatoren stehen zur Auswahl:

• COUNT
• SUM
• AVG
• CONCAT

Standardeinstellung:

COUNT

Concatenation max value count

Gibt die maximale Anzahl der zu konkatenierenden Werte an.

Standardeinstellung:

0 - unlimited

Concatenation value order

Gibt an, wie die Werte für die „CONCAT“ Funktion sortiert werden.

Die folgenden Sortierungsoptionen sind verfügbar:

• UNORDERED
• ORDERED_DESCENDING
• ORDERED_ASCENDING

Standardeinstellung:

UNORDERED

Output Format

Gibt das Ausgabeformat an.

Die folgenden Formate sind verfügbar:

• csv
• protobuf_textual

Standardeinstellung:

csv

Expand Query

Wenn Expand Query auf false gesetzt (oder nicht bereitgestellt) ist, werden die internen Query Expression Transformers nicht verwendet. Dies kann für die folgenden Anwendungsfälle hilfreich sein:

• Optional Terms ist nur aktiv, wenn der interne Term Series to Terms Transformer aktiv ist. Die Option Expand Query auf false zu setzen deaktiviert daher die Option Optional Terms.
• Wenn Natural Language Question Answering (NLQA) deaktiviert ist, werden standardmäßig alle Suchbegriffe automatisch in Ähnlichkeitsausdrücke umgewandelt. Die Option Expand Query auf false zu setzen deaktiviert daher die Similarity Search und man kehrt zu einer normalen Stichwortsuche zurück.

Standardeinstellung:

false

Einstellung

Option/Eingabe

Column Name

mes:lang

Query Constraint

extension:html

Aggregation operator

COUNT (Standardeinstellung)

Concatenation max value count

0 – unlimited (Standardeinstellung)

Concatenation value order

UNORDERED (Standardeinstellung)

Output Format

csv (Standardeinstellung)

Expand Query

false (Standardeinstellung)

Option

Beschreibung

Beispiel/Standardeinstellung

By docID

Hier können Sie die docID des gewünschten Dokuments eingeben.

Die docID eines Dokumentes kann mit dem Index-Servlet „Query Documents (/find)“ gefunden werden.

Achtung: Um Ergebnisse vom Index-Servlet zu erhaten, ist die Angabe einer docID oder eines Key zwingend notwendig.

Beispiel:

148

By Key

Hier können Sie den Key des gewünschten Dokuments eingeben.

Der Key eines Dokumentes kann auf zwei Arten gefunden werden:

• Mithilfe des Index-Servlet „Query Documents (/find)“.
• Mithilfe der Export-Funktion im Standard-Client, indem man „mes:key“ als Spalte hinzufügt.

Achtung: Um Ergebnisse vom Index-Servlet zu erhaten, ist die Angabe einer docID oder eines Key zwingend notwendig.

Beispiel:

https://inspire.mindbreeze.com/blog

By UnifomItemID

Hier können Sie die UniformItemID des Dokuments eingeben. Die UnformItemID bleibt im Gegensatz zur dokID gleich, wenn das Dokument ein Update, zum Beispiel ein zusätzliches Kapitel, erhält.

Die UniformItemID findet man folgendermaßen:

1. Geben Sie eine docID oder einen Key an.
2. Wählen Sie bei der Einstellung „Output Format“ die Option „Item“.
3. Führen Sie das Index-Servlet aus und suchen Sie im Ergebnis nach „uniform_item_id“.
4. Der Wert bei „uniform_item_id“ ist die gesuchte UniformItemID.

Hinweis: docID und UniformItemID können denselben oder einen unterschiedlichen Wert besitzen.

Beispiel:

212

Output Format

Hier können Sie auswählen in welchem Format das Dokument angezeigt werden soll und welcher Inhalt dargestellt werden soll.

Folgende Optionen stehen zur Auswahl:

• DocumentAndContents – zeigt Informationen zum Dokument und den Dokumenteninhalt an.
• Item - zeigt Informationen zum Dokument an.
• Content - zeigt den Dokumenteninhalt an.
• ERDataset – zeigt Informationen an, die für das Debugging der Named Entity Recognition (NER) verwendet werden.
• Sentence Segmentation - zeigt Informationen an, die für das Debugging des Sentence Transformers verwendet werden. Diese sind unabhängig von der aktuellen Index-Konfiguration und verwenden die Standardeinstellungen für die Sentence Segmentation.
• ERDatasetAndSentenceSegmentation - zeigt Informationen an, die für das Debugging der Named Entity Recognition (NER) und des Sentence Transformers verwendet werden.

Standardeinstellung:

DocumentAndContents

Deleted documents

Hier können Sie auswählen ob auch gelöschte Dokumente in die Suche miteinbezogen werden sollen.

Folgende Optionen stehen zur Auswahl:

• Exclude
• Include

Standardeinstellung:

Exclude

Einstellung

Option/Eingabe

By docID

148

Output Format

Item

Deleted documents

Exclude (Standardeinstellung)

Option

Beschreibung

Beispiel/Standardeinstellung

Query

Gibt ähnlich wie im Standard Mindbreeze Suchfenster eine Suchanfrage an. Die Suche ist auf folgende Systemmetadaten beschränkt:

• category
• categoryinstance
• fqcategory
• mes:key
• datasource/mes:key
• url
• extension
• mes:uniformdocid
• mes:date
• mes:size
• mes:lang
• mes:nonfilterable
• mes:filteredbymetadataonly
• store:modificationdate
• store:creationdate

Beispiel:

category:web

Query Protobuf Textual

Wird nur für interne Zwecke vom Mindbreeze Support verwendet.

-

Order by

Gibt das Metadatum an, wonach die Dokumente sortiert werden sollen.

Beispiel:

mes:key

Order Direction

Gibt die Reihenfolge an, in der die Dokumente sortiert werden. Die Dokumente können in aufsteigender oder absteigender Reihenfolge sortiert werden.

Folgende Optionen stehen zur Auswahl:

• descending
• ascending

Standardeinstellung:

descending

Group by

Gibt an, ob und nach welchem Metadatum die Dokumente gruppiert werden sollen.

-

Group by Parent Reference

Ermöglicht das Gruppieren nach Referenzen.

-

Group by Parent Reference Mode

Gibt an, wie weit referenziert werden soll.

Folgende Optionen stehen zur Auswahl:

• disabled
• enabled
• normalize_to_root

Standardeinstellung:

disabled

Summarize by property

Gibt die Eigenschaften an, wonach Dokumente zusammengefasst werden, wie zum Beispiel Name oder Dateierweiterung.

Beispiel:

mes:lang

Order summarized by

Gibt an, wie die Zusammenfassung sortiert werden soll.

Beispiel:

mes:key

Order direction

Gibt die Reihenfolge der Sortierung an. Die Zusammenfassung kann in aufsteigender oder absteigender Reihenfolge sortiert werden.

Folgende Optionen stehen zur Auswahl:

• descending
• ascending

Standardeinstellung:

descending

Output Format

Gibt das Ausgabeformat an, in dem die Ergebnisse angezeigt werden.

Folgende Optionen stehen zur Auswahl:

• csv
• protobuf_textual
• docids

Standardeinstellung:

csv

Expand Query

Wenn Expand Query auf false gesetzt (oder nicht bereitgestellt) ist, werden die internen Query Expression Transformers nicht verwendet. Dies kann für die folgenden Anwendungsfälle hilfreich sein:

• Optional Terms ist nur aktiv wenn der interne Term Series to Terms Transformer aktiv ist. Die Option Expand Query auf false zu setzen deaktiviert daher die Option Optional Terms.
• Wenn Natural Language Question Answering (NLQA) deaktiviert ist, werden standardmäßig alle Suchbegriffe automatisch in Ähnlichkeitsausdrücke umgewandelt. Die Option Expand Query auf false zu setzen deaktiviert daher Similarity Search und man kehrt zu einer normalen Stichwortsuche zurück.

Folgende Optionen stehen zur Auswahl:

• true
• false

Standardeinstellung:

false

Diacritic Similar Terms

Gibt an, ob bei einer Suche auch Diakritische Zeichen miteinbezogen werden. Diakritische Zeichen sind zum Beispiel Umlautzeichen oder das Hatschek über gewissen Buchstaben.

Durch das Einbeziehen von diakritischen Zeichen wird bei der Suche, zum Beispiel, beim Wort „Losung“ auch das Wort „Lösung“ miteinbezogen. Dies ist bei Dokumenten zu beachten, die zum Beispiel in Deutsch, Tschechisch oder Finnisch geschrieben sind.

Folgende Optionen stehen zur Auswahl:

• no_query_expansion
• query_expansion

Standardeinstellung:

no_query_expansion

Requested Properties (CSV)

Gibt an, welche spezifischen Dokumenteigenschaften gesucht werden sollen. Wenn mehrere Eigenschaften gesucht werden sollen, müssen die Eigenschaften wie bei einer CSV-Datei durch ein Semikolon getrennt werden.

Man kann zusätzliche Systemmetadaten anfordern.

Beispiel:

mes:lang

Einstellung

Option/Eingabe

Query

Open positions

Order by:

title

Order direction:

ascending

Group By Parent Reference Mode:

disabled (Standardeinstellung)

Order direction:

descending (Standardeinstellung)

Output Format:

csv (Standardeinstellung)

Expand Query:

false (Standardeinstellung)

Diacritic Similar Terms:

no_query_expansion (Standardeinstellung)

Option

Beschreibung

Beispiel/Standardeinstellung

Detail Level

Hier können Sie den Detailgrad angeben in dem die Statistiken ausgegeben werden sollen.

Folgende Optionen stehen zur Auswahl:

• basic – nur der Status ob etwas invertiert wird.
• document_count – Infos zur Anzahl der Dokus Pro Bucket.
• aggregated_document_count - Infos zur Anzahl der Dokus für alle Buckets.
• cached_document_count – wird periodisch ausgerechnet und vom Index gespeichert. Dass wird vom Cache ausgeliefert. Wird genutzt für Lizenzchecks.
• forward_index_document_count – wie viele Dokus sich im Forward Index befinden. Forward Index = aktueller und effektiver Status zu Dokumenten über alle Buckets.

Standardeinstellung:

basic

Output Format

Hier können Sie das Format angeben in dem die Statistiken ausgegeben werden sollen.

Folgende Optionen stehen zur Auswahl:

• protobuf_textual
• protobuf_binary – ladet eine Datei herunter. Wird zum Beispiel vom Support verwendet.
• json

Standardeinstellung:

protobuf_textual

Einstellung

Option/Eingabe

Detail Level:

document_count

Output Format:

protobuf_textual

Einstellung

Beschreibung

Beispiel/Standardeinstellung

Rules

Definiert mit einem Regex-Muster die Regel, die getestet werden soll.

Hinweis: Die Angabe einer Regel ist zwingend notwendig.

Achtung: Damit das Regex-Muster entsprechend funktioniert, muss folgender Syntax befolgt werden:

/meinRegexMuster/.

Beispiel:

year=/[1-9][0-9][0-9][0-9]/.

Query

Definiert ein oder mehrere Dokument(e) wofür die Regel angewandt wird.

Die Regel wird auf die Ergebnisse des Query angewandt.

Beispiel:

Blog

Element

Einstellung

Beschreibung

Beispiel

Element 1

Name

Name vom Property wo die Metadatum gespeichert wird.

fullyear

Value

Definition wie der Wert aussehen wird.

{{year}}

Source

Definiert von wo das Metadatum kommen soll.

Document Content

Element

Beschreibung

Beispiel

data

Ist ein JSON formatierter Plain Text, dessen Content „finished“ erst in der letzten Nachricht „true“ wird.

-

invertingCompleteFraction

Gibt die Vollständigkeit in Bruchteilen an und wird durch die Multiplikation mit 100 zur Prozentangabe.

Beispiel:

invertingCompleteFraction":0.5

Der Wert „0.5“ bedeutet 50%.

mergingCompleteFraction

Gibt die Vollständigkeit in Bruchteilen an und wird durch die Multiplikation mit 100 zur Prozentangabe.

Beispiel:

mergingCompleteFraction":1.0

Der Wert „1.0“ bedeutet 100%.

totalBucketCount

Gibt die Anzahl der Buckets am Index an. Die Anzahl kann steigen, wenn gerade neue Dokumente indiziert werden.

Beispiel:

totalBucketCount":2

totalCompleteFraction

Gibt die Vollständigkeit in Bruchteilen an und wird durch die Multiplikation mit 100 zur Prozentangabe.

Beispiel:

totalCompleteFraction":0.5

Der Wert „0.5“ bedeutet 50%.

URL-Parameter

Beschreibung

Beispiel/Standardeinstellung

event

Schränkt ein worauf der Index warten soll. Die Werte all_finished und inverting_finished sind gültig:

• all_finished: wartet auf die Invertierung und das Merging.
• inverting_finished: wartet nur auf die Invertierung.

Beispiel:

mindbreeze.com:8443/index/23100/wait?event=all_finished

update_interval

Setzt eine Zeitüberschreitung nach dem spätestens ein Update geschrieben wird. Wenn dieser Parameter nicht gesetzt ist, wird auf die Einstellung „Wait for Event Servlet Update Status Interval (Seconds)“ aus der Index-Konfiguration zurückgegriffen.

Es kann minimal ein Interval von fünf Sekunden gesetzt werden.

Hinweis: Die Abfrage ist nicht Laufzeitintensiv, allerdings müssen Threads synchronisiert werden (Lock mutex), daher wird empfohlen diese Option so hoch wie möglich einzustellen.

Beispiel:

mindbreeze.com:8443/index/23100/wait?update_interval=5