Media Server 24.3

# ListObjectClassRecognizers

Lists the recognizers that exist in the training database for use with object class recognition.

Type: synchronous

Parameter | Description | Required
--- | --- | ---
`trainingoptions` | A Boolean value (default false) that specifies whether to return the training options set for each recognizer. | No

## Example

    /action=ListObjectClassRecognizers

## Response

The response includes a list of recognizers, with the following information:

- `recognizer` - the name of the recognizer.

- `state` - describes the state of the recognizer.

  - `TRAINED` - the recognizer has been trained and is ready to use.
  - `TRAINING` - training is in progress.
  - `SNAPSHOTTED` - the recognizer has been trained but a snapshot should be selected. You can use the recognizer in this state (Media Server uses the model with the greatest number of iterations). You can evaluate a snapshot with the action TestObjectClassRecognizerSnapshot followed by GetObjectClassRecognizerSnapshotStatistics. You can then select the snapshot to use by running SelectObjectClassRecognizerSnapshot, which moves the recognizer to the `TRAINED` state. For more information about snapshots, see Training Requirements and Create and Train a Recognizer.
  - `STALE` - the recognizer requires training. You can begin training with the action BuildObjectClassRecognizer.
  - `PAUSED` - training has been paused by the action PauseBuildObjectClassRecognizer. You cannot use the recognizer in this state. Resume training by running the action BuildObjectClassRecognizer.
- `numclasses` - the number of object classes that exist in the recognizer.
- `remaining_iterations` - the number of training iterations that are remaining. This element is present only when training is paused.
- `snapshots` - lists the snapshots that were generated during training. A snapshot captures the state of a recognizer after a certain number of iterations.
- `trainingoptions` - shows the training options that are associated with the recognizer. This element is present only when you set the action parameter `trainingoptions=true`, and have set one or more training options with the action SetObjectClassRecognizerTrainingOption.

    <autnresponse>
        <action>LISTOBJECTCLASSRECOGNIZERS</action>
        <response>SUCCESS</response>
        <responsedata>
            <recognizer>
                <recognizer>vehicles</recognizer>
                <state>SNAPSHOTTED</state>
                <numclasses>3</numclasses>
                <snapshots>
                    <snapshot>
                        <index>0</index>
                        <iterations>1500</iterations>
                    </snapshot>
                    <snapshot>
                        <index>1</index>
                        <iterations>500</iterations>
                    </snapshot>
                    <snapshot>
                        <index>2</index>
                        <iterations>1000</iterations>
                    </snapshot>
                </snapshots>
                <trainingoptions>
                    <trainingoption>
                        <key>iterations</key>
                        <value>1500</value>
                    </trainingoption>
                    <trainingoption>
                        <key>snapshot_frequency</key>
                        <value>500</value>
                    </trainingoption>
                </trainingoptions>
            </recognizer>
        </responsedata>
    </autnresponse>

Copyright 2024 Open Text
Version 24.3 | Last updated June 2024

Send documentation feedback

Close

Send documentation feedback

To send feedback using your default email client, open an email window.

Otherwise, send your feedback and the information below to MFI-swpdl.idoldocsfeedback@opentext.com.

We appreciate your feedback!

Product: IDOL Media Server 24.3

Topic Title: ListObjectClassRecognizers