Schnittstellenbeschreibung

api.v2.search

Einleitung

Dieses Dokument beschäftigt sich mit der Mindbreeze Web API zum Abfragen von Suchresultaten. Sie wurde an Anlehnung zu der Dokumentation api.v2.search auf help.mindbreeze.com implementiert. Dabei werden die Inhalte anhand von Beispielen illustriert und erklärt. Dabei wird der Fokus vor allem in die Verwendung mittels Backend beleuchtet. Die Kommunikation der API wird in dieser Dokumentation mithilfe des Chromium Browser und dem Plugin Postman durchgeführt. Die API verwendet dabei das Protokoll JSON für die Kommunikation.

Suchanfragen werden als HTTP POST-Request an ein Client Service gesendet. Der Pfad für Suchanfragen lautet: <Client Service URL>/api/v2/search

Im Body des HTTP-Request wird ein JSON-Dokument mitgeschickt, das die Suchanfrage beschreibt. Wie dieses JSON-Dokument auszusehen hat, wird in Kapitel 3 und Kapitel 4 beschrieben.

Als Response erhält man ebenfalls ein JSON-Dokument. Dieses wird in Kapitel 2 beschrieben.

Felder im Suchergebnis

search_request

Das JSON-Dokument der Suchanfrage (vom Request).

alternatives

Enthält Informationen zu alternativen Suchbegriffen, die nach Typ gruppiert sind.

Der Eintrag mit id user_query enthält die erweiterte Query des Benutzers, falls eine Transformation wie Synonyme oder Stemming angewandt wurde. Wenn id user_query nicht vorhanden ist, kann die Query aus dem search_request Teil der Suchantwort (search_request.user.query) entnommen werden.

Der Eintrag mit id query_spelling bietet Rechtschreibkorrektur.

Die Einträge enthalten jeweils Listen von Alternativen (entries). Darin ist der Suchbegriff in html enthalten, eine Abschätzung der zu erwartenden Ergebnisse in count und die Query Expression in query_expr.

{

    "id": "user_query",

    "name": "user_query",

    "entries": [{

            "html": "mindbreeze",

            "count": 1,

            "query_expr": {

                "unparsed": "mindbreeze"

            }

        }

    ]

}

name

Name der Suche. Kann im search_request mit name gesendet werden.

estimated_count

Abschätzung der erwarteten Trefferanzahl.

facets

Eine Liste von Filtern für die aktuelle Suche. id enthält den Namen des Metadatums, name den Anzeigenamen.

Die Einträge liegen in entries. Mit html kann auf den Wert zugegriffen werden, mit count auf die geschätzte Anzahl von Ergebnissen, mit query_expr auf die Query Expression, die zur Einschränkung verwendet werden kann. Filter können auch hierarchisch sein, dann gibt es auch ein entries-Feld für einen Wert.

order_criteria und order_direction (ASCENDING, DESCENDING) zeigen die Sortierung der Filter.

Sortierungsbeschreibung order_criteria

{

  "id": "mes:date",

  "name": "Date",

  "entries": [{

    "html": "2016",

    "count": 676,

    "query_expr": {

      …

    },

    "entries": [{

      "html": "July",

      …

    }],

  }],

  "order_criteria": "COUNT",

  "order_direction": "DESCENDING"

}

orderby

Enthält die Eigenschaft, nach der die Ergebnisse sortiert sind.

orderable

Eine Liste von Eigenschaften, die für die Sortierung verwendet werden können. Jeweils mit Name (name) und Anzeigenname (localized_name).

available_properties

Eine Liste von Eigenschaften, die für die Anzeige verwendet werden können. Jeweils mit Name (name) und Anzeigenname (localized_name).

available_facets

Eine Liste von Eigenschaften, die als Filter zur Verfügung stehen. Jeweils mit Name (name) und Anzeigenname (localized_name).

resultset

Enthält die Liste der Resultate (results), Informationen zum Blättern (prev_avail, next_avail, per_service_dataset) und die Sortierrichtung der Ergebnisse (order_direction, ASCENDING oder DESCENDING).

prev_avail enthält true, wenn in der Liste der Ergebnisse zurück, next_avail, wenn nach vorne geblättert werden kann.

per_service_dataset besitzt die id des angefragten Service, termination_cause.

und paging_state zum Blättern.

{

  "id": "https://demo.mindbreeze.com/public/",

  "termination_cause": "COUNT_LIMIT",

  "paging_state": {

    "id": "unnamed",

    "state": "\n\u00010\u0010\u0000\u0018\u0001",

    "digest": "dBCFawAIMiGsGEflr6JYhw=="

  }

}

Resultate

properties enthält die Liste der angeforderten Metadaten. Jeweils mit Name (id) und Anzeigename (name), sowie einer Liste der Einträge (data).

Wurde bei der Suchanfrage Gruppierung verwendet, enthält group den Wert.

id ist eine Kennung des Treffers, location wird für die Vorschau benötigt. rank_score kann für die Sortierung verwendet werden und relevance_score enthält die Relevanzbewertung.

{

  "id": "Web:wwwmindbreezecom:https://www.mindbreeze.com/…",

  "location": "aHR0cHM6Ly9pbnNwaXJlcHJvZC5pbnNwa…",

  "rank_score": 53.4155,

  "relevance_score": 53.4155,

  "properties": [{

    "id": "title",

    "name": "Title",

    "data": [{

      "html": "Vertragsmanagement | <em>Mindbreeze</em>"

    }]

  },{

    "id": "content",

    "name": "content",

    "data": [{

      "html": "ist \nLösung mit <em>Mindbreeze</em> …"

    }]

  }],

  "order": {

    "num": 534155

  },

  "group": {

    "str": ""

  }

}

groupable

Eine Liste von Eigenschaften, die für die Gruppierung verwendet werden können. Jeweils mit Name (name) und Anzeigenname (localized_name).

show_query_spelling_alternatives

Zeigt an, ob Query Spelling Alternativen (z.B. ein Did You Mean) in der Antwort vorhanden sein können. In der Anfrage gibt es die Option alternative_query_spelling_max_estimated_count dieser wird hier mit dem estimated_count geprüft.

Hinweis: falls wider Erwarten keine Query Spelling Alternatives erscheinen und eigene logische Operatoren in der Query verwendet werden, siehe: Hinweise zu Query Spelling Alternativen

order_direction_available

Enthält true, wenn die Sortierungsreihenfolge in der Suchanfrage angegeben werden kann.

sort_date_facets_by_value

Gibt an, wie Datumsfilter sortiert werden. ‚true‘ sortiert die Werte nach Jahr und Monat und ‚false‘ sortiert die Werte nach Anzahlt der Treffer.
Type: Boolean

alternatives_query_spelling_max_estimated_count

Siehe show_query_spelling_alternatives

source_context

Schränkt die Suche zusätzlich ein.

"source_context": {

  "constraints": [{

    id: "searchcontainer",

    unparsed: "extension:PDF"   

  }]

}

query_context

Enthält detaillierte Informationen über die Application und zur Suche selbst, die in der app.telemetry eingesehen werden können.

Beispiel:

"query_context": {

  "application_id": "Default Application",

  "prev_query_id": "1649054355394",

  "properties": [{

    "key": "my_extension",

    "value": "html"

  }],

  "query_id": "1649054355849",

  "query_trigger_action": "submit",

  "refinement_id": "164905355394",

  "prev_refinement_id": "164905344394"

}

query_context_user_query

Enthält die Userquery und kann im LogPool der App.Telemetry angezeigt werden.
Type: String

Felder in der Suchanfrage

Suchtypen

Dieser Abschnitt beschäftigt sich mit den 3 Typen von Suchen die sie mit der in diesem Document beschriebenen API gegen Mindbreeze InSpire absetzten können.

Unstrukturierte Suche

Der Wert unparsed entspricht der Suche, wie sie auch im Suchfeld eingegeben werden kann.

{

  "unparsed": "mindbreeze OR inpsire"

}

Termsuche

Findet Wörter und Wortteile. Das Beispiel findet Treffer mit mind, aber auch z.B. mindbreeze.

{

  "term": "mind"

}

Phrasensuche

Findet nur Vorkommnisse der gesamten Phrase.

{

  "quoted_term": "mindbreeze inspire"

}

Blättern

Um die Größe des HTTP Responses einzuschränken, werden im HTTP Response nicht alle Suchergebnisse zurückgegeben, sondern immer nur ein Auszug der Suchergebnisse. Dabei kann man im Request-JSON in count definieren, wie viele Suchergebnisse im Response maximal enthalten sein dürfen.

{                                                

  "query": {                                    

    "unparsed": "mindbreeze"                    

  },                                            

"count": 5
}

Die Suchantwort enthält resultset.prev_avail und resultset.next_avail um mitzuteilen, ob man zurück und/oder vor blättern kann.

"resultset": {

  …

  "prev_avail": false,

  "next_avail": true,

  "per_service_dataset": [

    {

      "id": "https://demo.mindbreeze.com/public/",

      "termination_cause": "COUNT_LIMIT",

      "paging_state": {

        "id": "unnamed",

        "state": "\n\u00010\u0010\u0000\u0018\u0001",

        "digest": "dBCFawAIMiGsGEflr6JYhw=="

      }

    }

  ]

}

Soll geblättert werden, gibt man die Richtung mit paging.direction (PREV, NEXT) an und übernimmt resultset.per_service_dataset.paging_state in paging_states:

{                                                

  "query": {                                    

    "unparsed": "mindbreeze"                    

  },                                            

  "count": 5,                                    

  "paging_states": [{                            

    "id": "unnamed",                            

    "state": "\n\u00010\u0010\u0000\u0018\u0001",

    "digest": "dBCFawAIMiGsGEflr6JYhw=="        

  }],                                            

  "paging": {                                    

    "direction": "NEXT"                          

  }                                              

}                  

Seitenweise Navigation

Ist das seitenweise Navigieren aktiviert (die Option max_page_count ist gesetzt), enthält die Suchantwort resultset.result_pages, um direkt auf einzelne Ergebnisseiten zu springen.

"result_pages": {

    "qeng_ids": [{

            "service_id": "https://demo.mindbreeze.com/public/",

            "qeng_id": "https://demo.mindbreeze.com:23300",

            "digest": "t/y1e0hHmK/VzgZNMwczHA=="

        }

    ], {

        "pages": [{

                "starts": [0],

                "counts": [5],

                "current_page": true,

                "page_number": 0

            }, {

                "starts": [5],

                "counts": [5],

                "page_number": 1

            }, {

                "starts": [10],

                "counts": [5],

                "page_number": 2

            }, {

                "starts": [15],

                "counts": [5],

                "page_number": 3

            }, {

                "starts": [20],

                "counts": [5],

                "page_number": 4

            }

        ],

        "page_size": 5,

        "page_count": 5,

        "more_avail": true

    },

    "page_size": 5,

    "page_count": 5,

    "more_avail": true

}

Soll auf eine Resultatsseite navigiert werden, setzt man die result_pages auf die Suchanfrage und setzt jene Seite als current_page auf die gezeigt werden soll.

"result_pages": {

    "qeng_ids": [{

            "service_id": "https://demo.mindbreeze.com/public/",

            "qeng_id": "https://demo.mindbreeze.com:23300",

            "digest": "t/y1e0hHmK/VzgZNMwczHA=="

        }

    ], {

        "pages": [{

                "starts": [0],

                "counts": [5],

                "page_number": 0

            }, {

                "starts": [5],

                "counts": [5],

                "current_page": true,

                "page_number": 1

            }, {

                "starts": [10],

                "counts": [5],

                "page_number": 2

            }, {

                "starts": [15],

                "counts": [5],

                "page_number": 3

            }, {

                "starts": [20],

                "counts": [5],

                "page_number": 4

            }

        ],

        "page_size": 5,

        "page_count": 5,

        "more_avail": true

    },

    "page_size": 5,

    "page_count": 5,

    "more_avail": true

}

Logische Operatoren

Erklärung

Queries können wie in der Dokumentation auf help.mindbreeze.com auch mit and, or, not und vielen weiteren logischen Operatoren verknüpft werden. Nachstehend werden zur Illustration 2 queries mit einem und-operator verknüpft. Die Ergebnisse müssen „mindbreeze“ und gleichzeitig auch „About“ matchen.

Code

{

    "query": {

        "and": [{

                "unparsed": "mindbreeze"

            }, {

                "unparsed": "About"

            }

        ]

    }

    "count": 5,

    "properties": [{

            "name": "title",

            "formats": ["HTML"]

        }, {

            "name": "content",

            "formats": ["HTML"]

        }

    ]

}

Ergebnis

…

"resultset": {

    "results": [

      {

        "id": "SAP KMC:Default:/irj/go/km/docs/documents/MarketingPRTestdaten/DateienWebsite/Fabasoft%20Sales%20Kit%20(EN)/Mindbreeze/2013-02-27%20Mindbreeze%20Sales%20(English%2c%2016-9).pptx:",

        "location": "aHR0cHM6Ly9pbnNwaXJlcHJvZC5pbnNwaXJlLm1pbmRicmVlemUuY29tOjIzMzM5OjUzNzE=",

        "rank_score": 36.9355,

        "relevance_score": 36.9355,

        "properties": [

          {

            "id": "title",

            "name": "Title",

            "data": [

              {

                "html": "2013-02-27 <em>Mindbreeze</em> Sales (English, 16-9).pptx"

              }

            ]

          },

          {

            "id": "content",

            "name": "content",

            "data": [

              {

                "html": "<em>About Mindbreeze</em> \nVienna, February 28...– 10:30 \t<em>Mindbreeze</em>  \n\t10:30 – 12:00 \t<em>Mindbreeze</em> InSite  \n\t12:00...– 14:30 \t<em>Mindbreeze</em> InSpire  \n\t14:30...– 16:00 \t<em>Mindbreeze</em> InApp  \n\t16:00...– 17:30 \t<em>Mindbreeze</em> InTouch  \n \n \n \n \n<em>Mindbreeze</em> Products \n \nLIGHT IN...arbeitet, findet mit <em>Mindbreeze</em> Enterprise Search relevante...website: http://insite.<em>mindbreeze</em>.com  \nBenefits and"

              }

            ]

          }

        ],

        "order": {

          "num": 369355

        },

        "group": {

          "str": ""

        }

      },…

Near

Erklärung

Mit near können Suchbegriffe eingeschränkt werden auf die Distanz der Vorkommnisse. Wird Beispielsweise nach mindbreeze NEAR inspire gesucht. So darf die Distanz zwischen mindbreeze und inspire nicht über 6 Wörter betragen damit das Ergebnis der Suchanfrage matched. Die Reihenfolge wird dabei ignoriert (mindbreeze NEAR inspire == inspire NEAR mindbreeze).

Code

{

  "query": {

    "near": ["mindbreeze","inspire"]

  }

  "count": 1,

  "properties": [{

    "name": "title",

    "formats": ["HTML"]

  },{

    "name": "content",

    "formats": ["HTML"]

  }]

}

Ergebnis

"resultset": {

    "results": [

      {

        "id": "Web:wwwmindbreezecom:https://www.mindbreeze.com/de/inspire-training-feb2017:",

        "location": "aHR0cHM6Ly9pbnNwaXJlcHJvZC5pbnNwaXJlLm1pbmRicmVlemUuY29tOjIzMzMxOjM1MTA=",

        "rank_score": 43.8645,

        "relevance_score": 43.8645,

        "properties": [

          {

            "id": "title",

            "name": "Title",

            "data": [

              {

                "html": "<em>Mindbreeze InSpire</em> Training"

              }

            ]

          },

          {

            "id": "content",

            "name": "content",

            "data": [

              {

                "html": "<em>Mindbreeze InSpire</em> Training\nDauer: 3...wichtigsten Neuerungen von <em>Mindbreeze InSpire</em>. Wir freuen uns...richtigen Umgang mit <em>Mindbreeze InSpire</em> und im Speziellen...Einführung in das <em>Mindbreeze InSpire</em> SDK Entwicklung\n\tDetails...Sicherheitsmodells\n        Know-how: <em>Mindbreeze InSpire</em> SDK (z. B"

              }

            ]

          }

        ],

        "order": {

          "num": 438645

        },

        "group": {

          "str": ""

        }

„To“-Operator

Erklärung

Bei numerischen Werten kann darüber hinaus automatisch der TO Operator angewendet werden. Dies ist sogar bei nummerischen Werten im Fließtext eines Ergebnisses möglich. In unserem Beispiel werden nur jene Ergebnisse zurückgegeben, die einen Zahl zwischen 100 und 103 enthalten.

Code

{

  "query": {

    "from":"100",

    "to":"103"

  }

  "count": 5,

  "properties": [{

    "name": "title",

    "formats": ["HTML"]

  },{

    "name": "content",

    "formats": ["HTML"]

  }]

}

Ergebnis

…

"resultset": {

    "results": [

      {

        "id": "Web:wwwmindbreezecom:https://www.mindbreeze.com/de/presse/100-companies-that-matter.html:",

        "location": "aHR0cHM6Ly9pbnNwaXJlcHJvZC5pbnNwaXJlLm1pbmRicmVlemUuY29tOjIzMzMxOjM3MTA=",

        "rank_score": 39.933,

        "relevance_score": 39.933,

        "properties": [

          {

            "id": "title",

            "name": "Title",

            "data": [

              {

                "html": "<em>100</em>-companies-that-matter.html"

              }

            ]

          }

        ],

        "order": {

          "num": 399330

        },

        "group": {

          "str": ""

        }

      },…

Reguläre Ausdrücke

Erklärung

Mit der Mindbreeze Search API ist es auch möglich anstelle eines normalen Queries ein Regex abzusetzen. Matched dieses Regex so wird das Ergebnis returniert. Wichtig dabei ist das man den Backslash in JSON extra escapen muss. Das bedeutet, dass bei einem regex-Escape 2 Backslash anstelle von einen erforderlich sind (1 mal JSON und 1 mal regex Escape). In unserem Beispiel muss das Dokument im mes:key dem regex-Pattern (Beginn eines URLs) matchen damit es returniert wird. Dies funktioniert nur mit jenen Metadaten die regexmatchable oder aggregateable sind. Zu beachten ist hierbei, dass, Regex nur in bestimmten Metadaten gesucht werden kann und nicht ohne einem label.

Code

{

  "query": {

"label":"mes:key"

"regex": "https:\\/\\/www\\.mindbreeze\\.com\\/de.*"

  }

  "count": 1,

  "properties": [{

    "name": "title",

    "formats": ["HTML"]

  },{

    "name": "content",

    "formats": ["HTML"]

  }]

}

Ergebnis

"resultset": {

    "results": [

      {

        "id": "Web:wwwmindbreezecom:https://www.mindbreeze.com/de/mindbreeze-basic-training-oktober-2015.html:",

        "location": "aHR0cHM6Ly9pbnNwaXJlcHJvZC5pbnNwaXJlLm1pbmRicmVlemUuY29tOjIzMzMxOjY=",

        "rank_score": 0,

        "relevance_score": 0,

        "properties": [

          {

            "id": "title",

            "name": "Title",

            "data": [

              {

                "html": "Mindbreeze Basic Training / Schulung"

              }

            ]

          },

          {

            "id": "content",

            "name": "content",

            "data": [

              {

                "html": "Mindbreeze Basic Training / Schulung\nTrainingsdatum: 13.10.2015\nOrt: Mindbreeze Academy, Honauerstraße 4, 4020 Linz, Austria\nDauer: 1 Tag, 09:00 - 17:00\nPreis: EUR 600,-- (exkl. MWSt.) pro Person\nTeilnehmeranzahl: mindestens 5 Personen\nLevel: Einsteiger\nVorausgesetzte Kurse: keine\nSprache: Englisch ¹)\n¹) Falls sich ausschließlich deutschsprachige Teilnehmer anmelden, wird auch die Ausbildung auf Deutsch gehalten.\nKommen Sie zu uns und erfahren Sie direkt von den Mindbreeze-Experten alles üb..."

              }

            ]

          }

        ],

        "order": {

          "num": 0

        },

        "group": {

          "str": ""

        }

      }

Zeitangaben

Erklärung

Mit der Mindbreeze InSpire Search API ist es möglich Inhalte die sich in einem bestimmten Zeitraum bewegen als Ergebnisse zu returnieren. Als Einschränkung werden dafür timestamps (UNIX time) verwendet. In unseren Fall wollen wir alle Ergebnisse von 1.1.2016 bis 7.6.2017 um 10:26 UTC anzeigen. Neben einer Verundung der beiden Zeitstempel kann auch eine Veroderung verwendet werden.

Code

{

    "query": {

        "label": "mes:date",

        "and": [{

                "num": 1451606400000,

                "cmp": "GE",

                "unit": "ms_since_1970"

            }, {

                "num": 1496831176874,

                "cmp": "LE",

                "unit": "ms_since_1970"

            }

        ]

    }

    "count": 1,

    "properties": [{

            "name": "title",

            "formats": ["HTML"]

        }, {

            "name": "content",

            "formats": ["HTML"]

        }

    ]

}

Ergebnis

"resultset": {

    "results": [

      {

        "id": "Web:wwwmindbreezecom:https://www.mindbreeze.com/inspire-contact:",

        "location": "aHR0cHM6Ly9pbnNwaXJlcHJvZC5pbnNwaXJlLm1pbmRicmVlemUuY29tOjIzMzMxOjQ=",

        "rank_score": 0,

        "relevance_score": 0,

        "properties": [

          {

            "id": "title",

            "name": "Title",

            "data": [

              {

                "html": "Contact"

              }

            ]

          },

          {

            "id": "content",

            "name": "content",

            "data": [

              {

                "html": "Contact\nWe are delighted that you have chosen Mindbreeze InSpire.\nPlease name a contact person and suitable dates for the on-site support.\nFor other data sources, please add also the IP address or DNS name of the data sources. The ports that are required to these data sources have to be unlocked bidirectional between Mindbreeze Appliance and data sources."

              }

            ]

          }

Hinweise zu Query Spelling Alternativen ("Did you mean")

Erklärung

Die Query Spelling Alternativen werden auf Basis der ursprünglichen Benutzer-Query berechnet. Die ursprüngliche Benutzer-Query wird aus der Query aus dem unparsed-Wert entnommen (direkt oder innerhalb eines and-Operators).

Falls die Query nicht dieser Form entspricht, (weil beispielsweise zusätzliche logische Operatoren verwendet wurden) dann muss die ursprüngliche Benutzer-Query als separater original_unparsed Parameter übergeben werden.

(Falls dies nicht geschieht, dann kann keine ursprüngliche Benutzer-Query ermittelt werden und es können keine Query Spelling Alternativen angeboten werden.)

Code

{

  "user": {

    "query": {

      "and": [

        {

          "or": [

            {

              "unparsed": "\"eamples\""

            },

            {

              "unparsed": "eamples"

            }

          ]

        }

      ],

      "original_unparsed": "eamples"

    }

  }

}

Ergebnis

{

  ...

  "alternatives": [

    {

      "id": "query_spelling",

      "name": "query_spelling",

      "entries": [

        {

          "html": "<em>examples</em>",

          "count": 863,

          "query_expr": {

            "unparsed": "examples",

            "description": "examples"

          }

        }

      ]

    }

  ],

  ...

  "show_query_spelling_alternatives": true,

  "status_messages": [

    {

      "id": "no_results",

      "info": "No results found"

    }

  ]

}

Filter/Facets

Erklärung

Mit der Mindbreeze Search API ist es möglich Parameter anzugeben, die einen Filter/Facet retournieren. In unserem Beispiel soll zusätzlich zu den Metadaten auch ein Filter/Facet für die Dateiendung/ das Metadatum extension zurückgegeben werden. Wichtige Informationen über die Filter sind Beispielsweise die Anzahl der Resultate die einen bestimmten Filterwert haben. Als Beispiel wurde nachstehend die Anzahl der .png-Dateien der Suche nach mindbreeze grün markiert.

Code

{

  "query": {

    "unparsed": "mindbreeze"

  },

  "count": 1,

  "properties": [{

    "name": "title",

    "formats": ["HTML"]

  },{

    "name": "content",

    "formats": ["HTML"]

  }],

  "facets":[

{

"name":"extension"

"formats":[

  "HTML"

]

}

  ]

}

Erweitertes Beispiel filter_include_all_descendants

Mit der Option filter_include_all_descendants ist es möglich, die komplette Hierarchie ohne Einschränkung zurückzuliefern. Achtung: Durch diese Einstellung ist es möglich, dass die Suche ineffizient wird.

Code

{

  "query": {

    "unparsed": "mindbreeze"

  },

  "count": 1,

  "properties": [{

    "name": "title",

    "formats": ["HTML"]

  },{

    "name": "content",

    "formats": ["HTML"]

  }],

  "facets":[

      {

"name":"my_hierarchical_filter"

"formats":[

  "HTML"

],

"filter_include_all_descendants": true

}

  ]

}

Ergebnis

"facets": [

      {

        "name": "extension",

        "formats": [

          "HTML"

        ]

      }

    ],

    "properties": [

      {

        "name": "title",

        "formats": [

          "HTML"

        ]

      },

      {

        "name": "content",

        "formats": [

          "HTML"

        ]

      }

    ],

    "user_context": {}

  },

  "alternatives": [

    {

      "id": "user_query",

      "name": "user_query",

      "entries": [

        {

          "html": "mindbreeze",

          "count": 1,

          "query_expr": {

            "unparsed": "mindbreeze"

          }

        }

      ]

    }

  ],

  "name": "unnamed",

  "estimated_count": 4827,

  "facets": [

    {

      "id": "extension",

      "name": "File type",

      "entries": [

        {

          "html": "png",

          "count": 1437,

          "query_expr": {

            "label": "extension",

            "regex": "^\\Qpng\\E$",

            "description": "png",

            "id": "png",

            "value": {

              "str": "png"

            }

          },

          "value": {

            "str": "png"

          }

        },

        {

          "html": "html",

          "count": 863,

          "query_expr": {

            "label": "extension",

            "regex": "^\\Qhtml\\E$",

            "description": "html",

            "id": "html",

            "value": {

              "str": "html"

            }

          },

          "value": {

            "str": "html"

          }

        },

        {

          "html": "jpg",

          "count": 546,

          "query_expr": {

            "label": "extension",

            "regex": "^\\Qjpg\\E$",

            "description": "jpg",

            "id": "jpg",

            "value": {

              "str": "jpg"

            }

          },

          "value": {

            "str": "jpg"

          }

        },

        {

          "html": "gif",

          "count": 350,

          "query_expr": {

            "label": "extension",

            "regex": "^\\Qgif\\E$",

            "description": "gif",

            "id": "gif",

            "value": {

              "str": "gif"

            }

          },

          "value": {

            "str": "gif"

          }

        },

        {

          "html": "pdf",

          "count": 344,

          "query_expr": {

            "label": "extension",

            "regex": "^\\Qpdf\\E$",

            "description": "pdf",

            "id": "pdf",

            "value": {

              "str": "pdf"

            }

          },

          "value": {

            "str": "pdf"

          }

        },

        {

          "html": "docx",

          "count": 261,

          "query_expr": {

            "label": "extension",

            "regex": "^\\Qdocx\\E$",

            "description": "docx",

            "id": "docx",

            "value": {

              "str": "docx"

            }

          },

          "value": {

            "str": "docx"

          }

        },

        {

          "html": "xml",

          "count": 211,

          "query_expr": {

            "label": "extension",

            "regex": "^\\Qxml\\E$",

            "description": "xml",

            "id": "xml",

            "value": {

              "str": "xml"

            }

          },

          "value": {

            "str": "xml"

          }

        },

        {

          "html": "msg",

          "count": 195,

          "query_expr": {

            "label": "extension",

            "regex": "^\\Qmsg\\E$",

            "description": "msg",

            "id": "msg",

            "value": {

              "str": "msg"

            }

          },

          "value": {

            "str": "msg"

          }

        },

        {

          "html": "zip",

          "count": 113,

          "query_expr": {

            "label": "extension",

            "regex": "^\\Qzip\\E$",

            "description": "zip",

            "id": "zip",

            "value": {

              "str": "zip"

            }

          },

          "value": {

            "str": "zip"

          }

        },

        {

          "html": "doc",

          "count": 100,

          "query_expr": {

            "label": "extension",

            "regex": "^\\Qdoc\\E$",

            "description": "doc",

            "id": "doc",

            "value": {

              "str": "doc"

            }

          },

          "value": {

            "str": "doc"

          }

        },

        {

          "html": "jpeg",

          "count": 77,

          "query_expr": {

            "label": "extension",

            "regex": "^\\Qjpeg\\E$",

            "description": "jpeg",

            "id": "jpeg",

            "value": {

              "str": "jpeg"

            }

          },

          "value": {

            "str": "jpeg"

          }

        },

        {

          "html": "ppt",

          "count": 73,

          "query_expr": {

            "label": "extension",

            "regex": "^\\Qppt\\E$",

            "description": "ppt",

            "id": "ppt",

            "value": {

              "str": "ppt"

            }

          },

          "value": {

            "str": "ppt"

          }

        },

        {

          "html": "tif",

          "count": 62,

          "query_expr": {

            "label": "extension",

            "regex": "^\\Qtif\\E$",

            "description": "tif",

            "id": "tif",

            "value": {

              "str": "tif"

            }

          },

          "value": {

            "str": "tif"

          }

        },

        {

          "html": "txt",

          "count": 58,

          "query_expr": {

            "label": "extension",

            "regex": "^\\Qtxt\\E$",

            "description": "txt",

            "id": "txt",

            "value": {

              "str": "txt"

            }

          },

          "value": {

            "str": "txt"

          }

        },

        {

          "html": "pptx",

          "count": 39,

          "query_expr": {

            "label": "extension",

            "regex": "^\\Qpptx\\E$",

            "description": "pptx",

            "id": "pptx",

            "value": {

              "str": "pptx"

            }

          },

          "value": {

            "str": "pptx"

          }

        }

      ],

Erweitertes Beispiel filter_max_value_count

Die maximale Anzahl der Werte, die im Filter zurückgeliefert werden, werden im Client Service über die Einstellung „Maximum Number of Displayed Values“ bestimmt. Diese Einstellung gilt für alle Filter gemeinsam. Hinweis: Der Standardwert für Maximum Number of Displayed Values“ ist 15. Wir empfehlen den Wert nicht zu hoch zu setzen, da sich dies auf alle Filter auswirkt und die Performanz der Suche reduziere kann.

Mit der Option filter_max_value_count im Search Request ist es möglich, pro Filter die maximale Anzahl der Werte zu setzen. Damit können nur für einzelne Filter mehr Werte angefordert werden, ohne die Performanz der gesamten Suche zu beeinträchtigen.

In diesem Beispiel werden zwei Filter/Facets angefordert. Bei myname1 werden keine besonderen Angaben gemacht, bei myname2 wird filter_max_value_count auf den Wert 5 gesetzt. Im der Client Service Konfiguration ist „Maximum Number of Displayed Values“ auf den Wert 3 gestellt.

Im Ergebnis wird für den Filter/Facet myname1 daher der Wert der Client Services übernommen und es werden 3 Entries zurückgeliefert. Für den Filter/Facet myname2 ist explizit filter_max_value_count auf den Wert 5 gesetzt, daher werden hier 5 Entries zurückgeliefert.

Code

{

    "facets": [

        {

            "formats": [

                "HTML"

            ],

            "name": "myname1"

        },

        {

            "formats": [

                "HTML"

            ],

            "name": "myname2",

            "filter_max_value_count": 5

        }

    ],

    "query": {

        "unparsed": "mindbreeze"

    }

}

Ergebnis

{

    "search_request": {

        "query": {

            "unparsed": "mindbreeze"

        },

        "facets": [

            {

                "name": "myname1",

                "formats": [

                    "HTML"

                ]

            },

            {

                "name": "myname2",

                "formats": [

                    "HTML"

                ],

                "filter_max_value_count": 5

            }

        ],

        "user_context": {}

    }

    "name": "unnamed",

    "estimated_count": 254,

    "facets": [

        {

            "id": "myname1",

            "name": "myname1",

            "entries": [

                {

                    "html": "Case Studies",

                    "count": 2,

                    "query_expr": {

                        "label": "myname1",

                        "regex": "^\\QCase Studies\\E$",

                        "description": "Case Studies",

                        "id": "Case Studies",

                        "value": {

                            "str": "Case Studies"

                        }

                    },

                    "value": {

                        "str": "Case Studies"

                    }

                },

                {

                    "html": "Developer",

                    "count": 2,

                    "query_expr": {

                        "label": "myname1",

                        "regex": "^\\QDeveloper\\E$",

                        "description": "Developer",

                        "id": "Developer",

                        "value": {

                            "str": "Developer"

                        }

                    },

                    "value": {

                        "str": "Developer"

                    }

                },

                {

                    "html": "Management",

                    "count": 2,

                    "query_expr": {

                        "label": "myname1",

                        "regex": "^\\QManagement\\E$",

                        "description": "Management",

                        "id": "Management",

                        "value": {

                            "str": "Management"

                        }

                    },

                    "value": {

                        "str": "Management"

                    }

                }

            ],

            "order_criteria": "COUNT",

            "order_direction": "DESCENDING",

            "total_value_count": 254,

            "distinct_value_count": 226,

            "entries_truncated": true,

            "count_filtered_facet_values": true,

            "incomplete": false

        },

        {

            "id": "myname2",

            "name": "myname2",

            "entries": [

                {

                    "html": "Basic Indexing",

                    "count": 2,

                    "query_expr": {

                        "label": "myname2",

                        "regex": "^\\QBasic Indexing\\E$",

                        "description": "Basic Indexing",

                        "id": "Basic Indexing",

                        "value": {

                            "str": "Basic Indexing"

                        }

                    },

                    "value": {

                        "str": "Basic Indexing"

                    }

                },

                {

                    "html": "Case Studies",

                    "count": 2,

                    "query_expr": {

                        "label": "myname2",

                        "regex": "^\\QCase Studies\\E$",

                        "description": "Case Studies",

                        "id": "Case Studies",

                        "value": {

                            "str": "Case Studies"

                        }

                    },

                    "value": {

                        "str": "Case Studies"

                    }

                },

                {

                    "html": "Developer",

                    "count": 2,

                    "query_expr": {

                        "label": "myname2",

                        "regex": "^\\QDeveloper\\E$",

                        "description": "Developer",

                        "id": "Developer",

                        "value": {

                            "str": "Developer"

                        }

                    },

                    "value": {

                        "str": "Developer"

                    }

                },

                {

                    "html": "GSA Replacement",

                    "count": 2,

                    "query_expr": {

                        "label": "myname2",

                        "regex": "^\\QGSA Replacement\\E$",

                        "description": "GSA Replacement",

                        "id": "GSA Replacement",

                        "value": {

                            "str": "GSA Replacement"

                        }

                    },

                    "value": {

                        "str": "GSA Replacement"

                    }

                },

                {

                    "html": "Management",

                    "count": 2,

                    "query_expr": {

                        "label": "myname2",

                        "regex": "^\\QManagement\\E$",

                        "description": "Management",

                        "id": "Management",

                        "value": {

                            "str": "Management"

                        }

                    },

                    "value": {

                        "str": "Management"

                    }

                }

            ],

            "order_criteria": "COUNT",

            "order_direction": "DESCENDING",

            "total_value_count": 254,

            "distinct_value_count": 226,

            "entries_truncated": true,

            "count_filtered_facet_values": true,

            "incomplete": false

        }

    ]

}

Filter im Request zu setzten

Darüber hinaus ist es möglich Filter im Request zu setzten. Dies führt zu demselben Verhalten als würde man eine Filterwert im Client selektieren um die Suche einzuschränken. Dazu muss wie im nachstehenden Beispiel die Query Expression des ausgewählten Filterwertes im Request gesetzt werden. Zu beachten ist hierbei, dass man auch mehrere Query Expressions in Form einer Liste als Request verwenden kann um mehrere Filterwerte gleichzeitig auszuwählen.

Code

{

"user":{

  "query": {

    "unparsed": "mindbreeze"

  },"constraints": [

    {

     "label": "extension",

     "filter_base": [

   { "label": "extension",

        "regex": "^\\Qpng\\E$",

   "description": "png",

   "id": "png",

   "value": {"str": "png"}

},{

          "label": "extension",

        "regex": "^\\Qpdf\\E$",

   "description": "pdf",

   "id": "pdf",

   "value": {"str": "pdf"}

}

     ]

    },{

     "label": "mes:date",

     "filter_base": [

   { "and": [

    {num: 1514764800000, cmp: "GE", unit: "ms_since_1970"},

    {num: 1546300799999, cmp: "LE", unit: "ms_since_1970"}

   ],

   "label": "mes:date",

   "description": "2018",

   "id": "2018",

   "value": {

     num: 1514764800000,

     unit: "ms_since_1970"

   }

}

     ]

    }

   ]

  },

  "count": 1,

  "properties": [{

    "name": "title",

    "formats": ["HTML"]

  },{

    "name": "content",

    "formats": ["HTML"]

  }],

  "facets":[

{

"name":"extension"

"formats":[

  "HTML"

]

}

  ]

}

Ergebnis

  "resultset": {

    "results": [

      {

        "id": "SAP KMC:Default:/irj/go/km/docs/documents/MarketingPRTestdaten/Vorschlag%20Fotos%20zur%20Verwendung%20FFPR%20_%20Mobile%20Suche/Mindbreeze-Suche%20am%20iPad%20%c2%a9%20Mindbreeze.png:",

        "location": "aHR0cHM6Ly9pbnNwaXJlcHJvZC5pbnNwaXJlLm1pbmRicmVlemUuY29tOjIzMzM5OjIxNzc=",

        "rank_score": 35.896,

        "relevance_score": 35.896,

        "properties": [

          {

            "id": "title",

            "name": "Title",

            "data": [

              {

                "html": "<em>Mindbreeze</em>-Suche am iPad © <em>Mindbreeze</em>.png"

              }

            ]

          }

        ],

        "order": {

          "num": 358960

        },

        "group": {

          "str": ""

        }

      }

Deaktivieren/Aktivieren des Zählens von gefilterten Werten

Mit der Option count_filtered_facet_values in der Suchanfrage, kann gesteuert werden, ob gefilterte Werte mitgezählt werden sollen. Wird die Option nicht angegeben, ist das Standardverhalten so, dass die Konfiguration von Mindbreeze InSpire herangezogen wird. Ist es nicht anders konfiguriert, werden die gefilterten Werte mitgezählt (true), Die Option in der Anfrage überschreibt die Konfiguration unbedingt.

Code

{

"user":{

  "query": {

    "unparsed": "mindbreeze"

  },"constraints": [{ "label": "extension","filter_base": [

  {"label": "extension", "regex": "^\\Qpng\\E$", "description": "png", "id": "png", "value": {"str": "png"}}]}]

  },

  "count": 1,

  "count_filtered_facet_values": false,

  "properties": [{

    "name": "title",

    "formats": ["HTML"]

  },{

    "name": "content",

    "formats": ["HTML"]

  }],

  "facets":[

{

"name":"extension"

"formats":[

  "HTML"

]

}

  ]

}

Suchergebnisse zusammenfassen

Mit dem Feld summarize_by kann man Ergebnisse nach auswählbaren Eigenschaften gruppieren und sortieren.

Code

{

    "query": {

        "unparsed": "mindbreeze"

    },

    "count": 1,

    "properties": [{

            "name": "title",

            "formats": ["HTML"]

        }, {

            "name": "content",

            "formats": ["HTML"]

        }

    ],

    "query_context_user_query": "mindbreeze",

    "summarize_by": {

        "property": "mes:extension",

        "orderby": "mes:date",

        "order_direction": "ASCENDING",

        "aggregated_properties": [{

                "name": "countName",

                "expr": "count()"

            }, {

                "name": "sumName",

                "expr": "sum(mes:size)"

            }

        ],

        "summarize_non_existent": false

    }

}

Beschreibung der Felder

• property: Die Eigenschaft, nach der die Ergebnisse gruppierbar sein sollen.
  Beispiel: mes:extension
• orderby: Die Eigenschaft, nach der die gruppierten Ergebnisse geordnet sein sollen.
  Beispiel: mes:date
• order_direction: Ob die Ergebnisse in aufsteigender (ASCENDING) oder absteigender (DESCENDING) Reihenfolge geordnet sein sollen.
• aggregated_properties: Gruppierte Ergebnisse können zusätzlich nach aggregierten Eigenschaften zusammengefasst werden.
  Hinweis: Die Ergebnisse werden, damit nicht verändert, sondern es wird lediglich eine neues Property zur Verfügung gestellt, welches man an einem beliebigen Platz im HTML via Mustache-Template einfügen kann (z.B.: neben dem Titel).
  • name: Der Name des Properties. Kann beliebig sein, muss jedoch eindeutig sein.
  • expr: Die Eigenschaft bzw. Methode nachdem die Ergebnisse zusammengefasst werden.
    Beispiele:
    • count(): Zählt bzw. gibt die Anzahl pro gruppiertes Ergebnis zurück.
    • sum(<parameter>): Summiert die im Parameter angegebene Eigenschaft (Property) aller Ergebnisse, die sich in einer Gruppe befinden. Es sind nur Summen von numerischen Eigenschaften möglich.
      Beispiel: sum(mes:size): Summiert die Dateigrößen zusammen.
    • avg(<parameter>): Berechnet den Durchschnitt der im Parameter angegebenen Eigenschaft aller Ergebnisse, die sich in einer Gruppe befinden. Es sind nur Durchschnittswerte für numerische Eigenschaften möglich.
      Beispiel: avg(mes:size): Berechnet den Durchschnitt der Dateigrößen.
    • min(<parameter>): Berechnet den kleinsten Wert der im Parameter angegebenen Eigenschaft aller Ergebnisse, die sich in einer Gruppe befinden. Es sind nur Minimumwerte für numerische Eigenschaften möglich.
      Beispiel: min(mes:size): Berechnet den kleinsten Wert der Dateigrößen.
    • max(<parameter>): Berechnet den größten Wert der im Parameter angegebenen Eigenschaft aller Ergebnisse, die sich in einer Gruppe befinden. Es sind nur Maximumwerte für numerische Eigenschaften möglich.
      Beispiel: max(mes:size): Berechnet den größten Wert der Dateigrößen.
• summarize_non_existent: Ob alle anderen Ergebnisse, die die angegebene Eigenschaft (property) nicht besitzen, ebenfalls in einer gemeinsamen Gruppe zusammengefasst werden.

Performance und weitere Parameter bei Abfragen

Sprache

Optional kann auch die Sprache angegeben werden.

Dies bietet die Möglichkeit Metadaten labels bereits übersetzt zu erhalten:

{

  "query": {

    "unparsed": "mindbreeze"

  },