Compartir a través de

Uso del servicio web de consulta

  • Artículo

Última modificación: martes, 20 de julio de 2010

Hace referencia a: SharePoint Server 2010

Se aplica a: Búsqueda de Microsoft SharePoint Server 2010 y Microsoft FAST Search Server 2010 for SharePoint
El servicio web de consulta expone las funcionalidades del Motor de búsqueda Enterprise Search de SharePoint de Microsoft SharePoint Server 2010 en las aplicaciones cliente. Esto le permite obtener acceso a los resultados de la búsqueda desde el cliente y las aplicaciones web fuera del contexto de un sitio de SharePoint.

Acceso al servicio web de consulta

El servicio web de consulta se encuentra en la ruta de acceso siguiente:

https://Server_Name/[sites/][Site_Name/]_vti_bin/search.asmx

Puede usar una herramienta de desarrollo como Microsoft Visual Studio para crear una aplicación cliente para obtener acceso al servicio web de consulta. En el entorno de desarrollo de Visual Studio, puede generar automáticamente una clase de proxy para obtener acceso al servicio web de consulta mediante la adición de una referencia web a la aplicación cliente. Para obtener instrucciones paso a paso acerca de cómo agregar una referencia web al servicio web de consulta mediante Microsoft Visual Studio 2010, vea Procedimiento para agregar una referencia web al Servicio web de consulta.

Como alternativa, puede usar la herramienta Lenguaje de descripción de servicios web (WSDL) para generar un proxy para el servicio web de consulta. Para obtener más información, vea Web Services Description Language Tool (Wsdl.exe) y Creating an XML Web Service Proxy. Para obtener más información acerca de cómo crear aplicaciones cliente que llamen a servicios web, vea Building XML Web Service Clients.

Métodos web

En la tabla siguiente se describen los métodos web disponibles en el servicio web de consulta.

Nombre

Descripción

GetPortalSearchInfo()

Devuelve una lista de ámbitos.

GetQuerySuggestions

Devuelve una lista de sugerencias de consulta, ya sea sugerencias anteriores a la consulta o posteriores a ella.

GetSearchMetadata

Devuelve una lista de ámbitos y propiedades administradas.

Query

Devuelve un conjunto de resultados en una cadena XML para la consulta especificada.

QueryEx

Devuelve un conjunto de resultados en un DataSet para la consulta especificada.

RecordClick(String)

Registra información acerca de la consulta de búsqueda para el registro de consultas.

Registration(String)

Devuelve el nombre de un sitio especificado.

Status()

Devuelve la disponibilidad del servicio de búsqueda.

Métodos de consulta

El servicio web de consulta incluye dos métodos para recuperar los resultados de la búsqueda: Query y QueryEx. Ambos métodos aceptan la misma entrada, una cadena que contiene XML que especifica los parámetros de consulta de búsqueda. Sin embargo, el formato de los resultados devueltos es diferente.

Elección del método del servicio web de consulta

Para devolver varios tipos de resultados, como tipos de resultados relevantes, de término especial o de refinamiento, en los resultados de la búsqueda, debe usar el método QueryEx.

Generación del XML para la consulta de búsqueda

El formato XML para la consulta de búsqueda se define en el Esquema de Microsoft.Search.Query.

La consulta de búsqueda real se especifica en el Elemento QueryText en el esquema Microsoft.Search.Query. La sintaxis de consulta usada se especifica en el atributo type del elemento QueryText. Para obtener las referencias de la sintaxis de consulta del Motor de búsqueda Enterprise Search de SharePoint, vea Creación de consultas de búsqueda.

El siguiente ejemplo de código es el XML de ejemplo para el elemento QueryText que especifica una consulta de búsqueda mediante sintaxis SQL.

<QueryText language=xml:lang type='MSSQLFT'>
SELECT Title, Path, Description, Write, Rank, Size FROM Scope() WHERE CONTAINS(Description,'SharePoint')
</QueryText>

Nota

Si usa sintaxis SQL con el método Query, debe especificar las siguientes propiedades en la instrucción SELECT de la consulta SQL: Title, Path, Description, Write, Rank y Size.

El siguiente ejemplo de código es el XML de ejemplo para el elemento QueryText que especifica una consulta de búsqueda mediante sintaxis de palabras clave.

<QueryText language=xml:lang type='STRING'>
SharePoint
</QueryText>

Nota

Existen algunas diferencias en el XML, en función de si se usa la Búsqueda de SharePoint Server o FAST Search Server 2010 for SharePoint como el proveedor de búsquedas. Esto se especifica explícitamente mediante una cláusula "se aplica a" para cada elemento.

Puede especificar qué propiedades se devolverán para la consulta de palabras clave mediante el elemento Elemento Property del esquema Microsoft.Search.Query.

Si no especifica ninguna propiedad en el XML de consulta, se devolverá un conjunto predeterminado de propiedades.

A continuación aparece el conjunto predeterminado de propiedades devueltas para el método Query:

  • Title

  • Description

  • Date

  • Relevance

A continuación aparece el conjunto de propiedades predeterminadas devueltas para el método QueryEx al usar Búsqueda de SharePoint Server como proveedor de búsqueda:

  • WorkId

  • Rank

  • Title

  • Author

  • Size

  • Path

  • Description

  • Write

  • SiteName

  • CollapsingStatus

  • HitHighlightedSummary

  • HitHighlightedProperties

  • ContentClass

  • IsDocument

  • PictureThumbnailURL

A continuación aparece el conjunto de propiedades predeterminadas devueltas para el método QueryEx al usar FAST Search Server 2010 for SharePoint como proveedor de búsqueda:

  • WorkId

  • Rank

  • Title

  • Author

  • Size

  • Path

  • Description

  • Write

  • SiteName

  • CollapsingStatus

  • HitHighlightedSummary

  • HitHighlightedProperties

  • ContentClass

  • IsDocument

  • PictureThumbnailURL

  • Url

  • ServerRedirectedUrl

  • FileExtension

  • SpSiteUrl

  • docvector

  • fcocount

  • fcoid

  • PictureWidth

  • PictureHeight

Devolución de los resultados de la búsqueda

El método QueryEx devuelve los resultados de la búsqueda en un objeto DataSet, y el método Query devuelve los resultados de la búsqueda en una cadena como XML.

Nota

Los resultados relevantes son el único tipo de resultado admitido por el método Query.

Método Query

El formato del XML devuelto por el método Query se define mediante el Esquema Microsoft.Search.Response y el Esquema Microsoft.Search.Response.Document. El conjunto completo de resultados de la búsqueda se incluye en el Elemento Results en el esquema Microsoft.Search.Response, donde cada resultado individual está representado por un Elemento Document del esquema Microsoft.Search.Response.Document.

Método QueryEx

El objeto DataSet devuelto por el método QueryEx contiene propiedades ExtendedProperties que proporcionan información adicional acerca de la consulta. En la Tabla 1 se describen las propiedades extendidas que se devuelven.

Tabla 1. Propiedades extendidas

Nombre

Se aplica a

Descripción

QueryModification

FAST Search Server 2010 for SharePoint

Modificación de consulta para la consulta de búsqueda. Si la consulta original no devuelve ningún resultado, FAST Search Server 2010 for SharePoint puede modificar la consulta de acuerdo con la configuración del elemento ResubmitFlags del XML de consulta de la consulta.

Keyword

Búsqueda de SharePoint Server
FAST Search Server 2010 for SharePoint

Token definido en la propiedad extendida Definition.

IgnoredNoiseWords

Búsqueda de SharePoint Server

Lista de palabras irrelevantes omitidas en la consulta original, si la consulta original contenía palabras irrelevantes.

QueryTerms

Búsqueda de SharePoint Server
FAST Search Server 2010 for SharePoint

Términos de la consulta de búsqueda original.

En la Búsqueda de SharePoint Server, los términos de consulta se separan con un punto y coma (";"). En FAST Search Server 2010 for SharePoint, se devuelve el texto de la consulta original.

ElapsedTime

Búsqueda de SharePoint Server
FAST Search Server 2010 for SharePoint

Tiempo que se tardó en ejecutar la consulta de búsqueda, en milisegundos.

Definition

Búsqueda de SharePoint Server
FAST Search Server 2010 for SharePoint

Definición del término especificado en la propiedad extendida Keyword.

SpellingSuggestion

Búsqueda de SharePoint Server
FAST Search Server 2010 for SharePoint

Sugerencia de ortografía para la consulta de búsqueda.

En función de las opciones especificadas en la solicitud QueryEx y el proveedor de búsquedas, el conjunto de datos devuelto puede contener hasta cinco tablas de datos, que se describen en la Tabla 2.

Tabla 2. Tablas incluidas en el conjunto de datos devuelto para QueryEx

Nombre de DataTable

Se aplica a

Descripción

RelevantResults

Búsqueda de SharePoint Server
FAST Search Server 2010 for SharePoint

Conjunto de resultados principal que contiene los resultados de la búsqueda del índice de contenido que coincide con la consulta. Esta tabla contiene una fila para cada resultado de la búsqueda y una columna para cada propiedad administrada solicitada.

HighConfidenceResults

Búsqueda de SharePoint Server

Conjunto de resultados que contiene los resultados definidos como resultados de alta confianza para la consulta de búsqueda.

SpecialTermResults

Búsqueda de SharePoint Server
FAST Search Server 2010 for SharePoint

Conjunto que contiene las opciones más probables que coinciden con la consulta de búsqueda. Esta tabla contiene una fila para cada resultado de la búsqueda. Las columnas de la tabla son las siguientes:

  • Title  Título de la opción más probable.

  • URL  Dirección URL del vínculo a la opción más probable.

  • Description  Descripción de la opción más probable.

RefinementResults

FAST Search Server 2010 for SharePoint

Información de refinamiento de consultas de los resultados que coinciden con la consulta de búsqueda. La tabla contiene una fila para cada contenedor de refinamiento e incluye las columnas RefinerName, RefinementName, RefinementValue, RefinementCount y RefinementToken.

Para obtener más información, vea ff394639(v=office.14).md.

VisualBestBetsResults

FAST Search Server 2010 for SharePoint

Opciones visuales más probables que coinciden con la consulta de búsqueda. La tabla contiene una fila para cada opción visual más probable e incluye las columnas Name, URI, Description, Keyword, Teaser y TeaserContentType. Las columnas contienen el nombre de la opción visual más probable, la dirección URL a la que se vincula la opción visual más probable, una descripción legible de la opción visual más probable, un teaser corto para mostrar y el tipo de contenido del teaser.