Interfaz de API webWeb API Interface

Los archivos de modelo generados por Knowledge Exploration Service se pueden hospedar mediante un conjunto de API web y también se puede acceder a ellos mediante dichas API.The model files built by the Knowledge Exploration Service can be hosted and accessed via a set of web APIs. Las API pueden estar hospedadas en la máquina local mediante el comando host_service, o se pueden implementar en un servicio en la nube de Azure con el comando deploy_service.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. Ambas técnicas exponen los siguientes puntos de conexión de API:Both techniques expose the following API endpoints:

  • interpret: interpreta una cadena de consulta en lenguaje natural.interpret – Interprets a natural language query string. Devuelve interpretaciones anotadas para permitir completas experiencias de finalización automática en el cuadro de búsqueda que se anticipen a lo que el usuario escribe.Returns annotated interpretations to enable rich search-box auto-completion experiences that anticipate what the user is typing.
  • evaluate: evalúa y devuelve la salida de una expresión de consulta estructurada.evaluate – Evaluates and returns the output of a structured query expression.
  • calchistogram: calcula un histograma de valores de atributos para objetos devueltos por una expresión de consulta estructurada.calchistogram – Calculates a histogram of attribute values for objects returned by a structured query expression.

Cuando se usan juntos, estos métodos de API permiten la creación de una experiencia de búsqueda semántica completa.Used together, these API methods allow the creation of a rich semantic search experience. Dada una cadena de consulta en lenguaje natural, el método interpret proporciona versiones anotadas de la consulta de entrada con expresiones de consulta estructuradas que se basan en la gramática y los datos de índice subyacentes.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. El método evaluate evalúa la expresión de consulta estructurada y devuelve los objetos de índice coincidentes para mostrar.The evaluate method evaluates the structured query expression and returns the matching index objects for display. El método calchistogram calcula las distribuciones de valores de atributo para permitir filtrado y refinamiento.The calchistogram method computes the attribute value distributions to enable filtering and refinement.

EjemploExample

En un dominio de publicaciones académicas, si un usuario escribe la cadena "latent s", el método interpret puede proporcionar un conjunto de interpretaciones clasificadas, y sugerir que el usuario podría estar buscando la palabra clave "latent semantic analysis", el título "latent structure analysis" u otra expresión que empieza por "latent s".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". Esta información puede utilizarse para guiar rápidamente al usuario a los resultados de búsqueda deseados.This information can be used to quickly guide the user to the desired search results.

En este dominio, el método evaluate puede usarse para recuperar un conjunto de publicaciones coincidentes del índice académico, y el método calchistogram se puede usar para calcular la distribución de valores de atributo de las publicaciones coincidentes, que se puede usar para filtrar y refinar aún más los resultados de búsqueda.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.

Tenga en cuenta que, para mejorar la legibilidad de los ejemplos, las llamadas API REST contienen caracteres (como espacios) que no tienen codificación URL.Note that to improve the readability of the examples, the REST API calls contain characters (such as spaces) that have not been URL-encoded. El código deberá aplicar las codificaciones URL adecuadas.Your code will need to apply the appropriate URL-encodings.