ListVisualClusteringItems

Lists the items that have been added to a visual clustering database.

Type: synchronous

Parameter Description Required
database The name of a visual clustering database. Yes
maxresults The maximum number of items to list. No
start The starting point for the list when you set the maxresults parameter. For example, to start listing items from the tenth item in the database, set start=10. The entries in the database are indexed from 1. No

Example

The following example lists up to 10 items contained in the BroadcastClips database.

/action=ListVisualClusteringItems&database=BroadcastClips&start=1&maxresults=10

Response

The response always includes the following information for each item:

  • identifier - The identifier for the item.
  • hassourcedata - Specifies whether the samples used for training are stored in the database. To remove this data from the database you can use the action NullVisualClusteringItemSourceData. However, future enhancements to visual clustering might require retraining and this is not possible without the samples (you would need to provide the source media again).
<autnresponse>
    <action>LISTVISUALCLUSTERINGITEMS</action>
    <response>SUCCESS</response>
    <responsedata>
        <entry>
            <identifier>item1</identifier>
            <hassourcedata>true</hassourcedata>
        </entry>
        <entry>
            <identifier>item2</identifier>
            <hassourcedata>true</hassourcedata>
        </entry>
        ...
    </responsedata>
</autnresponse>