2.2.5.5 KeywordFilter

Namespace: http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration

The KeywordFilter simple type enumeration, together with an associated string value, form a keyword filter. This filter is used on web methods GetSpecialTermsCount and GetSpecialTermsInfo. Keyword definitions MUST be considered included in the filtered set if the property specified by this enumeration’s value matches the value string. The matching is successful if the property being matched contains the value.

 <xs:simpleType name="KeywordFilter">
   <xs:restriction base="xs:string">
     <xs:enumeration value="Keyword"/>
     <xs:enumeration value="Synonyms"/>
     <xs:enumeration value="BestBetTitle"/>
     <xs:enumeration value="BestBetUrl"/>
     <xs:enumeration value="Contact"/>
     <xs:enumeration value="None"/>
   </xs:restriction>
 </xs:simpleType>

The following table specifies the allowable values for KeywordFilter:

Value

Meaning

Keyword

Match the keyword search term (Keyword.term element, as specified in 2.2.4.20).

Synonyms

Match any of the search terms of the keyword synonyms associated with the keyword. (Synonym.term element, as specified in section 2.2.4.29)

BestBetTitle

Match the title of any best bet associated with the keyword (BestBet.title element as specified in section 2.2.4.15).

BestBetUrl

Match the URL of any best bet associated with the keyword (BestBet.url element as specified in section 2.2.4.15).

Contact

Matches the keyword’s contact name (Keyword.contact element, as specified in 2.2.4.20).

None

No matching is done, all keywords being filtered are included in the filtered set.