Web service API

How to use PageSeeder's Web service API

autosuggest group fields

/groups/{group}/autosuggest/fields [GET]

com.pageseeder.search.AutoSuggest

This service is deprecated since version 5.9400

Description

Deprecation warning!

This service is now deprecated please use Service: /groups/{group}/autosuggest [GET] instead.

Return result suggestions from a query for a specific field

This service returns the list of result suggestions from a prefix match on a set of fields.

Auto-suggest vs auto-complete

The auto-complete function simply returns the list of possible search terms using prefix matching.

For example, for term "ali", the auto-complete will return terms like "align", "alignment", etc.

The auto-suggest feature returns possible search results by using the auto-complete function on a list of terms and the executing the corresponding query with these terms.

For example, for term "ali", the auto-suggest will first determine the list of possible match terms and then will return the best matching search results including these terms.

Parameters

NameDescriptionRequiredTypeDefault value
fieldsThe index fields to searchyesstring
termThe prefix of the  termsyesstring
predicateA additional predicate - this is an advanced optionnoLucene predicate+type:document

Note

Although the fields and term parameters are not strictly required, that is an error will not be thrown is they are not specified, this service will only return search results if both parameters are specified. This behaviour may change in future releases.

Permission

Undocumented permissions requirements.

Response

Example XML output:

<autosuggest term="lorem">
  <query empty="false" predicate="...">
    <suggestion-query>
      <terms>
        <term field="pstitle" text="lorem"/>
        <term field="psfilename" text="lorem"/>
        <term field="psdocid" text="lorem"/>
        <term field="psid" text="lorem"/>
      </terms>
      <condition>pstype:document</condition>
    </suggestion-query>
  </query>
  <results page="1" page-size="10" total-pages="1" total-results="2" first-result="1" last-result="2">
    <result score="1.6665791">
      <field name="psid">4482</field>
      <field name="pstitle">lorem_ipsum.psml</field>
      ...
    </result>
    <result score="1.6665700">
      <field name="psid">4400</field>
      <field name="pstitle">lorem.psml</field>
      ...
    </result>
  </results>
</autosuggest>

Error Handling

No specific errors expected for this service.

Created on , last edited on