Google Search Appliance Protocol Reference - Manual (Page 89)

Google Search Appliance: Search Protocol Reference Dynamic Result Clustering Service /cluster Protocol 89
The search appliance returns the following JSON response:
{ "clusters": [
{ "algorithm": "Concepts",
"clusters": [
{ "label": "canada chile culebra",
"docs": [ 18,19,20,21,23,26,27,29,30,32]
},
{ "label": "dewey culebra",
"docs": [ 1,9,36]
}
]
}
],
"documents": [
{ "url": "http://server.example.com/file42.pdf",
"title": "TLA Annual Report 2009--Acronyms in the Public Sector
...",
"snippet": "... Soy Flz (Culebra) Culebra
34,102 34,102 2.28 ... Soy Flz (Culebra)
was re-elected
Executive Director of Culebra,
effective May 1, 2009. ..."
},
...,
{ "url": "http://server.example.com/turtle_island.html",
"title": "Puerto Rico Travel",
"snippet": "... rentals and useful information about Culebra
..."
}
]
}
The top-level entries are described in the following table.
The dynamic result clustering service’s default JavaScript client ignores the documents element and does
not use the docs array.
Entry Description
clusters The output from different clustering algorithms. There is only one supported cluster
algorithm, so the value of algorithm must be Concepts.
The clusters category consists of:
• A series of algorithm and subordinate clusters pairs. The algorithm is the
name and Concepts is the only supported algorithm.
• The subordinate clusters is a series of labels and the array of docs that have
that label.
• The label is a query suggestion. The docs are indexes into the documents
section that follow.
Each label provides an alternative query, and each docs array tells the document
location indices.
documents A sequence of the URL, title, and snippet for each of up to 100 top search results
from a search query. The search appliance creates the docs arrays from the
documents list.