Skip to content

Part Annotation Server API

Angel Chang edited this page Sep 23, 2024 · 1 revision

Server side API

Endpoints

/part-annotations/list       # Listing annotations (format=json for json)
/part-annotations/submit              # Submit part annotations    
/query?qt=parts                       # Labeled parts (json)
/annotations/edit                     # Updating annotation record
/annotations/preview                  # Fetch preview image for an annotation

/part-viewer                          # Webview of a single annotation
/part-annotator                       # Part annotator interface
/part-annotator-single                # Part annotator interface for a single model

Examples

Last part annotations http://localhost:8010/part-annotations/list?task=&$latest=true

Submit

{
    appId: "PartAnnotator.v2",
    sessionId: "...",
    condition: "...",
    task: "...",
    taskMode: "...",
    userId: "workerId", 
    annotations: [...],   // Part annotations
    screenshot: "",    // Image encoded as dataUrl
    parts: ["", ""],   // Array of part names
    score: 100, 
    data: {            // Additional data for the part annotations
      stats: {         // Annotation statistics
         initial: {},  // Initial statistics
         delta: {},    // Summary of delta statistics
         total: {},    // Final statistics
      },
      timings: {
      },
      metadata: {      // Metadata about task/annotation (not from annotator)
      },
      form: {          // Answers to questions in survey
      },
    }
}

Each annotation is stored as:
{
  label: "part label",
  meshIds: [...],          // Strings of mesh ids
  data: {...}              // Arbitrary data associated with the part
}
Clone this wiki locally