ClusterVisualItems

Divides all of the items in a visual clustering database into clusters of similar items and returns the results. Media Server can return from three to ten clusters.

You can run this action as many times as necessary - for example you can cluster the items in a database, and then add more items and run the action again.

Type: asynchronous

Parameter Description Required
database The name of the database that contains the items to cluster. Yes
syncdatabase A Boolean value that specifies whether Media Server synchronizes with the database before beginning the action, to ensure it has the latest training (default true). No

Example

The following action clusters all of the items in the "BroadcastClips" database:

/action=ClusterVisualItems&database=BroadcastClips

Response

This action is asynchronous, so Media Server always returns success accompanied by a token. You can use this token with the QueueInfo action to retrieve the status of your request.

The following XML is an example response from the QueueInfo action.

The response includes a clusters element that describes the clusters. The same results are repeated in the items element, which allows you to more easily find the resulting cluster for an item you added to the database.

<autnresponse>
    <action>QUEUEINFO</action>
    <response>SUCCESS</response>
    <responsedata>
        <actions>
            <action>
                <status>Finished</status>
                <queued_time>2023-Aug-14 16:03:57</queued_time>
                <time_in_queue>1</time_in_queue>
                <process_start_time>2023-Aug-14 16:03:58</process_start_time>
                <time_processing>3</time_processing>
                <process_end_time>2023-Aug-14 16:04:01</process_end_time>
                <results>
                    <clusters>
                        <cluster>
                            <clustersize>1</clustersize>
                            <itemlist>
                                <identifier>item1</identifier>
                            </itemlist>
                        </cluster>
                        <cluster>
                            <clustersize>2</clustersize>
                            <itemlist>
                                <identifier>item2</identifier>
                                <identifier>item3</identifier>
                            </itemlist>
                        </cluster>
                        ...
                    </clusters>
                    <items>
                        <item>
                            <clusterlabel>0</clusterlabel>
                            <confidence>100</confidence>
                            <identifier>item1</identifier>
                        </item>
                        <item>
                            <clusterlabel>1</clusterlabel>
                            <confidence>100</confidence>
                            <identifier>item2</identifier>
                        </item>
                        ...
                    </items>
                </results>
                <token>...</token>
            </action>
        </actions>
    </responsedata>
</autnresponse>