Web-API-SchnittstelleWeb API Interface

Die vom Knowledge Exploration Service erstellten Modelldateien können über eine Reihe von Web-APIs gehostet und abgerufen werden.The model files built by the Knowledge Exploration Service can be hosted and accessed via a set of web APIs. Die APIs können über den host_service-Befehl auf einem lokalen Computer gehostet oder mithilfe des deploy_service-Befehls für einen Azure-Clouddienst bereitgestellt werden.The APIs may be hosted on the local machine using the host_service command, or may be deployed to an Azure cloud service using the deploy_service command. Durch beide Ansätze werden die folgenden API-Endpunkte verfügbar gemacht:Both techniques expose the following API endpoints:

  • interpret – interpretiert die Zeichenfolge einer Abfrage in natürlicher Sprache.interpret – Interprets a natural language query string. Gibt mit Anmerkungen versehene Interpretationen zurück, mit denen sich die Benutzereingabe im Suchfeld vorhersagen und automatisch vervollständigen lässt.Returns annotated interpretations to enable rich search-box auto-completion experiences that anticipate what the user is typing.
  • evaluate – wertet die Ausgabe eines strukturierten Abfrageausdrucks aus und gibt diese zurück.evaluate – Evaluates and returns the output of a structured query expression.
  • calchistogram – berechnet ein Histogramm von Attributwerten für Objekte, die von einem strukturierten Abfrageausdruck zurückgegeben werden.calchistogram – Calculates a histogram of attribute values for objects returned by a structured query expression.

Gemeinsam ermöglichen diese API-Methoden die Erstellung einer umfangreichen semantischen Suchfunktionen.Used together, these API methods allow the creation of a rich semantic search experience. Anhand einer Abfragezeichenfolge in natürlicher Sprache liefert die interpret-Methode kommentierte Versionen der Eingabeabfrage mit strukturierten Abfrageausdrücken, die auf den zugrunde liegenden Grammatik- und Indexdaten basieren.Given a natural language query string, the interpret method provides annotated versions of the input query with structured query expressions, based on the underlying grammar and index data. Die evaluate-Methode wertet den strukturierten Abfrageausdruck aus und gibt die passenden Indexobjekte zur Anzeige zurück.The evaluate method evaluates the structured query expression and returns the matching index objects for display. Die calchistogram-Methode berechnet die Attributwertverteilungen, um Filterung und Verfeinerung zu ermöglichen.The calchistogram method computes the attribute value distributions to enable filtering and refinement.

BeispielExample

Wenn ein Benutzer in einer Domäne für akademische Veröffentlichungen also beispielsweise die Zeichenfolge „latent s“ eingibt, kann die interpret-Methode eine Reihe von nach Rangfolge sortierten Interpretationen bereitstellen und dem Benutzer Suchvorschläge für das Schlüsselwort „latent semantic analysis“, für den Titel „latent structure analysis“ oder für andere Ausdrücke anzeigen, die mit „latent s“ beginnen.In an academic publications domain, if a user types the string "latent s", the interpret method can provide a set of ranked interpretations, suggesting that the user might be searching for the keyword "latent semantic analysis", the title "latent structure analysis", or other expressions starting with "latent s". Auf der Grundlage dieser Informationen gelangt der Benutzer schnell zu den gewünschten Suchergebnissen.This information can be used to quickly guide the user to the desired search results.

Für diese Domäne kann die evaluate-Methode einen Satz übereinstimmender Veröffentlichungen aus dem akademischen Index abrufen, und diecalchistogram-Methode ermöglicht die Berechnung der Verteilung von Attributwerten für einen Satz von übereinstimmenden Veröffentlichungen, die zur weiteren Filterung und Verfeinerung der Suchergebnisse genutzt werden können.For this domain, the evaluate method can be used to retrieve a set of matching publications from the academic index, and the calchistogram method can be used to calculate the distribution of attribute values for the matching publications, which can be used to further filter and refine the search results.

Zur besseren Lesbarkeit der Beispiele enthalten die REST-API-Aufrufe Zeichen (etwa Leerzeichen), die nicht im URL-Format codiert wurden.Note that to improve the readability of the examples, the REST API calls contain characters (such as spaces) that have not been URL-encoded. In Ihrem Code muss allerdings die korrekte URL-Codierung verwendet werden.Your code will need to apply the appropriate URL-encodings.