Export (0) Print
Expand All

Microsoft.Search.Query Schema

Last modified: August 17, 2011

Applies to: SharePoint Server 2010

You can use the Query method and QueryEx method to execute a query and return search results.

<QueryPacket>
    <Query>
        <QueryId />
        <OriginatorId />
        <Context>
            <QueryText />
        </Context>
        <Range>
            <StartAt />
            <Count />
        </Range>
        <Properties>
            <Property />
        </Properties>
        <SortByProperties>
            <SortByProperty />
        </SortByProperties>
        <ImplicitAndBehavior />
        <RelevanceModel />
        <EnableStemming />
        <TrimDuplicates />
        <IncludeSpecialTermResults />
        <PreQuerySuggestions />
        <HighlightQuerySuggestions />
        <CapitalizeFirstLetters />
        <ResultProvider />
        <ResubmitFlags>
            <ResubmitFlag />
        </ResubmitFlags>
        <EnableSpellcheck />
        <UserContext>
            <UserContextData />
        </UserContext>
        <FindSimilar>
            <SimilarTo />
            <SimilarType />
            <SortSimilar />
        </FindSimilar>
        <IncludeRefinementResults>
            <Refiners>
               <Refiner />
            </Refiners>
            <MaxShallowRefinementHits />
        </IncludeRefinementResults>
        <RefinementFilters>
            <RefinementFilter />
        </RefinementFilters>
        <IgnoreAllNoiseQuery />
        <IncludeRelevantResults />
        <IncludeHighConfidenceResults />
    </Query>
</QueryPacket>

Name

Description

QueryPacket

Contains all the elements for the search query request.

Query

Contains the elements that define the search query.

QueryId

A GUID that uniquely identifies a query request.

Context

Represents the elements of the search query.

QueryText

Represents the search query issued to the Web service.

Range

Specifies the range of the search results.

StartAt

Specifies the search result to return as the initial result.

Count

Specifies the maximum number of results to return.

Properties

Contains the managed properties to include in the search results.

Property

Contains a managed property to include in the search results.

SortByProperties

Contains the managed properties by which to sort the search results.

SortByProperty

Specifies the managed property to sort the search results on.

ImplicitAndBehavior

Specifies whether there is a default AND between keyword terms in the query.

RelevanceModel

A GUID that uniquely identifies a ranking model to use for the search query.

This element applies only to SharePoint Server search.

EnableStemming

Specifies whether stemming is enabled.

TrimDuplicates

Specifies whether duplicate results collapsing is enabled.

IncludeSpecialTermResults

Specifies whether special term results (for instance best bets) should be included in the response.

PreQuerySuggestions

Specifies whether pre-query suggestions should be included in the response.

HighlightQuerySuggestions

Specifies whether parts of the query suggestion should be highlighted.

This element applies only to SharePoint Server search.

CapitalizeFirstLetters

Specifies whether the first letter in the query suggestion should be capitalized.

This element applies only to SharePoint Server search.

ResultProvider

Represents the result provider for the search query.

ResubmitFlags

Specifies the criteria for automatically resubmitting a query that yielded no results.

This element applies only to FAST Search Server 2010 for SharePoint.

ResubmitFlag

Contains one value indicating an action to be taken if no hits are found.

This element applies only to FAST Search Server 2010 for SharePoint.

EnableSpellcheck

Specifies how to apply spelling correction of the query text when processing the request to the Query Web service.

This element applies only to FAST Search Server 2010 for SharePoint.

UserContext

Contains user context data associated with search settings (best bets, visual best bets, and keyword boosting).

This element applies only to FAST Search Server 2010 for SharePoint.

UserContextData

Contains one user context specification associated with search settings (best bets, visual best bets, and keyword boosting).

This element is applies only to FAST Search Server 2010 for SharePoint.

FindSimilar

Contains information about how to search for similar items.

This element applies only to FAST Search Server 2010 for SharePoint.

SimilarTo

Contains the similarity reference when searching for similar items.

This element applies only to FAST Search Server 2010 for SharePoint.

SimilarType

Contains the type of find similar query to perform.

This element applies only to FAST Search Server 2010 for SharePoint.

SortSimilar

Specifies whether query results based on similarity are sorted by similarity.

This element applies only to FAST Search Server 2010 for SharePoint.

IncludeRefinementResults

Contains information about what type of query refinement data to be returned in the result.

This element applies only to FAST Search Server 2010 for SharePoint.

Refiners

Contains the set of refiners to be returned in a query result.

This element applies only to FAST Search Server 2010 for SharePoint.

Refiner

Contains one refiner to be returned in a query result.

This element applies only to FAST Search Server 2010 for SharePoint.

MaxShallowRefinementHits

Contains the number of results to be used to calculate shallow refinement results.

This element applies only to FAST Search Server 2010 for SharePoint.

RefinementFilters

Contains the set of query refinement filters used when issuing a refinement query.

This element applies only to FAST Search Server 2010 for SharePoint.

RefinementFilter

Contains one query refinement (drill down) filter used when issuing a refinement query.

This element applies only to FAST Search Server 2010 for SharePoint.

IgnoreAllNoiseQuery

Specifies whether noise words in the query should be ignored.

This element applies only to SharePoint Server search.

IncludeRelevantResults

Specifies whether relevant results should be returned.

IncludeHighConfidenceResults

Specifies whether high confidence results should be returned.

This element applies only to SharePoint Server search.

Community Additions

ADD
Show:
© 2014 Microsoft