Constructing a value search query

You create a value search query by issuing a request that uses the ValueSearchConfig type.

Use the parameters for ValueSearchConfig specified in its format.

As a rule of thumb, for any record attribute in the data store that could contain more than 100 possible results, use <RestrictToProperties> and MaxPerProperty attributes to help control the results returned from the corpus. Without these controls, the size of the resulting response from the Conversation Web Service could cause slow response times between your front-end application and the Oracle Endeca Server.

To create a value search query:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
   xmlns:ns="http://www.endeca.com/MDEX/conversation/1/0" 
   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
   xmlns:typ="http://www.endeca.com/MDEX/lql_parser/types">
  <soapenv:Header/>
  <soapenv:Body>
    <ns:Request>
      <ns:State>
      </ns:State>
      <ns:Operator/>
      <ns:ContentElementConfig Id="ValueSearchConfig"
        xsi:type="ns:ValueSearchConfig"
        HandlerNamespace="http://www.endeca.com/MDEX/conversation/1/0"
        HandlerFunction="ValueSearchHandler" 
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
        MaxPerProperty="5"
        RelevanceRankingStrategy="static (nbins,descending)" 
        Mode="Any">
        <ns:SearchTerm>26</ns:SearchTerm>
        <ns:RestrictToProperties>
          <ns:Property>ProductCategory</ns:Property>
          <ns:Property>Bike Racks</ns:Property>
        </ns:RestrictToProperties>
      </ns:ContentElementConfig>
      <ns:PassThrough />
    </ns:Request>
  </soapenv:Body>
</soapenv:Envelope>
The results of a value search query are returned in the ValueSearch type of ContentElementConfig. In the response, the following information is returned:
  • The PropertyMatches element appears only for those standard and managed record attributes in which matches were found, and contains values for those matches.
  • TotalValuesCount specifies the number of values returned for each value-searchable attribute.
  • HasMore specifies whether there exist more attribute matches, beyond those that are returned. Because the request may limit the number of result values, the list of results returned may contain returned values and also indicate that a additional matching values exist that are not returned.
The HasMore attribute specifies whether any results are cut off because of a limit specified in the request.