Share via

3.1.4.3.3.5 SuggestionType Complex Type

  • Article

The SuggestionType complex type represents a query suggestion.

   <xs:complexType name="SuggestionType">
     <xs:sequence>
       <xs:element name="SuggestedQuery" type="xs:string" minOccurs="1" maxOccurs="1"/>
       <xs:element name="DisplayText" type="xs:string" minOccurs="1" maxOccurs="1"/>
       <xs:element name="SuggestionType" type="t:SuggestionKindType" minOccurs="1" maxOccurs="1"/>
       <xs:element name="Trigger" type="xs:string" minOccurs="0" maxOccurs="1"/>
       <xs:element name="TDSuggestionId" type="xs:int"/>
       <xs:element name="IsDeletable" type="xs:boolean"/>
     </xs:sequence>
   </xs:complexType>

The following table lists the child elements of the SuggestionType complex type.

Element

Type

Description

SuggestedQuery

xs:string ([XMLSCHEMA2/2])

The suggested query, which can be used as the Query element of the ExecuteSearch operation (section 3.1.4.2).

DisplayText

xs:string

A form of the suggested query that is suitable for display to the user. This value can be the same as the value of the SuggestedQuery element. This is not supposed to be used as the Query element of the ExecuteSearch operation.

SuggestionType

t:SuggestionKindType (section 2.2.5.1)

The type of the suggestion. This MUST be compatible with the SuggestionTypes specified in the GetSearchSuggestions operation (section 3.1.4.3).

Trigger

xs:string

The query (or fragment) that elicited this suggestion.

TDSuggestionId

xs:int ([XMLSCHEMA2/2])

This identifies the suggestion uniquely within the batch of suggestions returned in the GetSearchSuggestionsResponseMessage response (section 3.1.4.3.2.2). Servers MUST arrange the suggestions such that the identities increase monotonically through the batch. Clients SHOULD display suggestions in this order.

IsDeletable

xs:boolean ([XMLSCHEMA2/2])

For internal use only.