Использование веб-службы запросов

Дата последнего изменения: 20 июля 2010 г.

Применимо к: SharePoint Server 2010

Доступ к веб-службе "Запрос"

Веб-служба запросов расположена по следующему пути:

http://Server\_Name/\[sites/\]\[Site\_Name/\]\_vti\_bin/sea

Можно использовать средство разработки, такое как Microsoft Visual Studio, для создания клиентского приложения для доступа к веб-службе Запрос. В среде разработки Visual Studio можно автоматически создать прокси-класс для доступа к веб-службе Запрос, добавив веб-ссылку в клиентское приложение. Пошаговые инструкции по добавлению веб-ссылки на веб-службу Запрос с помощью Microsoft Visual Studio 2010 см. в статье Добавление веб-ссылки на веб-службу "Запрос".

Также можно использовать инструмент языка WSDL (Web Services Description Language) для создания прокси для веб-службы Запрос. Дополнительные сведения см. в статьях Web Services Description Language Tool (Wsdl.exe) и Creating an XML Web Service Proxy. Дополнительные сведения о создании клиентских приложений, вызывающих веб-службы, см. в статье Building XML Web Service Clients.

Веб-методы

В следующей таблице описываются веб-методы, доступные в веб-службе запросов.

Имя

Описание

GetPortalSearchInfo()

Возвращает список областей.

GetQuerySuggestions

Возвращает список предложений запроса (предложений перед запросом или после запроса).

GetSearchMetadata

Возвращает список управляемых свойств и областей.

Query

Возвращает набор результатов в строке XML для указанного запроса.

QueryEx

Возвращает набор результатов в DataSet для указанного запроса.

RecordClick(String)

Записывает сведения о запросе поиска для ведения журнала запросов.

Registration(String)

Возвращает имя указанного сайта.

Status()

Возвращает доступность службы поиска.

Методы запроса

Веб-служба запросов включает в себя два метода для возврата результатов поиска: Query и QueryEx. Оба принимают одни и те же входные данные — строку, содержащую код XML, задающий параметры запроса поиска. Однако формат возвращаемых результатов различается.

Выбор метода веб-службы "Запрос"

Для возврата нескольких типов результатов (релевантных, специальных и уточнений) в результатах поиска необходимо использовать метод QueryEx.

Построение XML для запроса поиска

Формат XML для запроса поиска определен в Схема Microsoft.Search.Query.

Фактический запрос поиска указывается в Элемент QueryText в схеме Microsoft.Search.Query. Укажите синтаксис запроса, используемый в атрибуте type элемента QueryText. Ссылки на синтаксис запроса в корпоративной среде SharePoint см. в статье Построение поисковых запросов.

Следующий пример кода является образцом XML для элемента QueryText, задающего запрос поиска с использованием синтаксиса SQL.

<QueryText language=xml:lang type='MSSQLFT'>
SELECT Title, Path, Description, Write, Rank, Size FROM Scope() WHERE CONTAINS(Description,'SharePoint')
</QueryText>
ПримечаниеПримечание

При использовании синтаксиса SQL с методом Query необходимо указать следующие свойства в инструкции SELECT запроса SQL: Title, Path, Description, Write, Rank и Size.

Следующий пример кода является образцом XML для элемента QueryText, задающего запрос поиска с использованием синтаксиса ключевых слов.

<QueryText language=xml:lang type='STRING'>
SharePoint
</QueryText>
ПримечаниеПримечание

Есть некоторые различия в XML, в зависимости то того, используется ли в качестве поставщика поиска SharePoint Server или FAST Search Server 2010 for SharePoint. Это указывается явным образом с помощью оператора "applies to" для каждого элемента.

Можно указать возвращаемые свойства для запроса ключевого слова при помощи элемента Элемент Property в схеме Microsoft.Search.Query.

Если в XML запроса свойства не указаны, возвращается набор свойств по умолчанию.

Ниже приводится набор свойств по умолчанию, возвращаемый для метода Query:

  • Title

  • Description

  • Date

  • Relevance

Ниже приводится набор свойств по умолчанию, возвращаемый для метода QueryEx при использовании SharePoint Server в качестве поставщика поиска:

  • WorkId

  • Rank

  • Title

  • Author

  • Size

  • Path

  • Description

  • Write

  • SiteName

  • CollapsingStatus

  • HitHighlightedSummary

  • HitHighlightedProperties

  • ContentClass

  • IsDocument

  • PictureThumbnailURL

Ниже приводится набор свойств по умолчанию, возвращаемый для метода QueryEx при использовании FAST Search Server 2010 for SharePoint в качестве поставщика поиска:

  • WorkId

  • Rank

  • Title

  • Author

  • Size

  • Path

  • Description

  • Write

  • SiteName

  • CollapsingStatus

  • HitHighlightedSummary

  • HitHighlightedProperties

  • ContentClass

  • IsDocument

  • PictureThumbnailURL

  • Url

  • ServerRedirectedUrl

  • FileExtension

  • SpSiteUrl

  • docvector

  • fcocount

  • fcoid

  • PictureWidth

  • PictureHeight

Возврат результатов поиска

Метод QueryEx возвращает результаты поиска в объекте DataSet, а метод Query возвращает результаты поиска в строке как XML.

ПримечаниеПримечание

Метод Query поддерживает единственный тип результатов — релевантные результаты.

Метод Query

Формат для XML, возвращаемого методом Query, определяется Схема Microsoft.Search.Response и Схема Microsoft.Search.Response.Document. Полный набор результатов поиска содержится в Элемент Results в схеме Microsoft.Search.Response, где каждый отдельный результат представлен Элемент Document в схеме Microsoft.Search.Response.Document.

Метод QueryEx

Объект DataSet, возвращаемый методом QueryEx, содержит свойства ExtendedProperties, которые предоставляют дополнительные сведения о запросе. В таблице 1 описываются расширенные возвращаемые свойства.

Таблица 1. Расширенные свойства

Имя

Применяется к

Описание

QueryModification

FAST Search Server 2010 for SharePoint

Модификация запроса для запроса поиска. Если исходный запрос возвращает нулевые результаты, FAST Search Server 2010 for SharePoint может изменить запрос в соответствии с настройкой элемента ResubmitFlags в XML запроса.

Keyword

SharePoint Server
FAST Search Server 2010 for SharePoint

Маркер, определяемый в расширенном свойстве Definition.

IgnoredNoiseWords

SharePoint Server

Список пропускаемых слов, игнорируемых в исходном запросе, если исходный запрос содержит пропускаемые слова.

QueryTerms

SharePoint Server
FAST Search Server 2010 for SharePoint

Термины в исходном запросе поиска.

Для SharePoint Server термины запроса разделяются точкой с запятой (;). Для FAST Search Server 2010 for SharePoint возвращается текст исходного запроса.

ElapsedTime

SharePoint Server
FAST Search Server 2010 for SharePoint

Время, затраченное на выполнение запроса поиска, в миллисекундах.

Definition

SharePoint Server
FAST Search Server 2010 for SharePoint

Определение термина, указанного в расширенном свойстве Keyword.

SpellingSuggestion

SharePoint Server
FAST Search Server 2010 for SharePoint

Предлагаемый вариант написания для запроса поиска.

В зависимости от параметров, указанных в запросе QueryEx, и поставщика поиска, возвращаемый набор данных может содержать до пяти таблиц данных, описанных в таблице 2.

Таблица 2. Таблицы, содержащиеся в возвращаемом наборе данных для QueryEx

Имя таблицы данных

Применяется к

Описание

RelevantResults

SharePoint Server
FAST Search Server 2010 for SharePoint

Основной набор результатов, содержащий результаты поиска из указателя, соответствующего запросу. Эта таблица содержит по одной строке для каждого результата и по одному столбцу для каждого запрошенного управляемого свойства.

HighConfidenceResults

SharePoint Server

Набор результатов, содержащий результаты, определенные как наиболее достоверные для запроса поиска.

SpecialTermResults

SharePoint Server
FAST Search Server 2010 for SharePoint

Набор, содержащий наиболее подходящие элементы, соответствующие запросу поиска. Эта таблица содержит по одной строке для каждого результата поиска и следующие столбцы:

  • Title  Заголовок наиболее подходящего элемента.

  • Url  URL-адрес для ссылки на наиболее подходящий элемент.

  • Description  Описание наиболее подходящего элемента.

RefinementResults

FAST Search Server 2010 for SharePoint

Сведения об уточнении запроса для результатов, соответствующий запросу поиска. Эта таблица содержит по одной строке на уточнение, а также столбцы RefinerName, RefinementName, RefinementValue, RefinementCount и RefinementToken.

Дополнительные сведения см. в статье ff394639(v=office.14).md.

VisualBestBetsResults

FAST Search Server 2010 for SharePoint

Наиболее подходящие визуальные элементы, соответствующие запросу поиска. Эта таблица содержит по одной строке на наиболее подходящий визуальный элемент, а также столбцы Name, Uri, Description, Keyword, Teaser и TeaserContentType. Столбцы содержат имя наиболее подходящего визуального элемента, URL-адрес, с которым связан наиболее подходящий визуальный элемент, понятное для человека описание наиболее подходящего визуального элемента, короткий фрагмент для отображения и тип контента этого фрагмента.