Home » Talis Platform » Reference Guide » API Reference » Bigfoot

Bigfoot Facet Service

Submitted by Richard Wallis on Fri, 2007-02-09 12:36.

Bigfoot Facet Service

Service URI

http://api.talis.com/bf/stores/{store}/services/facet

GET

Required Parameters

  • query - the query expression for which the top ranking terms should be calculated. Supports any expression in the Bigfoot Query Syntax
  • fields - a comma delimited list of fields for which top ranking terms are to be returned

Optional Parameters

  • top - The maximum number of terms to return for each field. If this parameter is not supplied it defaults to a value of 5
  • output - a string representing the format of the output. The following formats are supported:
    • xml (the default if no other is specified)
    • html

XML Output Format

The root element of the result is <facet-service>. This contains a <head> element which contains one child element for each of the service parameters containing the values supplied for this request.

The <fields> element contains one <field> child element per field that is analysed by the service. Fields that have no matching terms are included as empty elements. Fields specified in the request that do not exist in the bigfoot store are not included as child elements.

The search-uri attribute contains the URI the user can use to obtain the results for the given field value. The number attribute contains an indicative number of items that match the given query and field value - this is not guaranteed to be the same as the number of results obtained by querying the contentbox directly. 


<?xml version="1.0"?>
<facet-results xmlns="http://schemas.talis.com/2007/facet-results#">
  <head>
    <query>austen</query>
    <fields>title,author,some-other-field</fields>
  </head>
  <fields>
    <field name="title">
      <term number="19" search-uri="http://api.talis.com/bf/stores/ukbib/items?query=austen+title:%22Pride+and+prejudice%22" >Pride and prejudice</term>
      <term number="12" search-uri="http://api.talis.com/bf/stores/ukbib/items?query=austen+title:%22Emma%22">Emma</term>
      <term number="9" search-uri="http://api.talis.com/bf/stores/ukbib/items?query=austen+title:%22Northanger+Abbey%22">Northanger Abbey</term>
      <term number="8" search-uri="http://api.talis.com/bf/stores/ukbib/items?query=austen+title:%22Mansfield+Park%22">Mansfield Park</term>
    </field>
  
    <field name="some-other-field"/>
    
    <field name="author">
      <term number="91" search-uri="http://api.talis.com/bf/stores/ukbib/items?query=austen+author:%22Austen,+Jane,%22">Austen, Jane,</term>
      <term number="6" search-uri="http://api.talis.com/bf/stores/ukbib/items?query=austen+author:%22Jane+Austen+Society.%22">Jane Austen Society.</term>
      <term number="3" search-uri="http://api.talis.com/bf/stores/ukbib/items?query=austen+author:%22Evans,+J.+M.+(Jessie+Maud)%22">Evans, J. M. (Jessie Maud)</term>
      <term number="3" search-uri="http://api.talis.com/bf/stores/ukbib/items?query=austen+author:%22Chapman,+R.+W.+(Robert+William)%22">Chapman, R. W. (Robert William)</term>
    </field>
  </fields>
</facet-result>
‹ Bigfoot Augment ServiceupDirectory Collections ›
»