Contact UsGet started
© 2024 Direct Cursus Technology L.L.C.

Vision Classifier API, gRPC: ImageClassifierService.Annotate

Written by
Updated at November 26, 2024

gRPC request

rpc Annotate (AnnotationRequest) returns (AnnotationResponse)

AnnotationRequest

{
  "image": {
    // Includes only one of the fields `content`
    "content": "bytes",
    // end of the list of possible fields
    "image_type": "ImageType"
  }
}

request for annotation

Field

Description

image

Image

image to annotate

Image

Field

Description

content

bytes

bytes with data

Includes only one of the fields content.

image_type

enum ImageType

type of data

  • IMAGE_TYPE_UNSPECIFIED
  • JPEG
  • PNG

AnnotationResponse

{
  "request_id": "string",
  "classifier_specification": {
    "labels": [
      {
        "name": "string",
        "description": "string"
      }
    ],
    "classification_type": "ClassificationType"
  },
  "annotations": [
    {
      "label": {
        "name": "string",
        "description": "string"
      },
      "confidence": "double"
    }
  ]
}

Field

Description

request_id

string

internal service requestId

classifier_specification

ClassifierSpecification

class specification

annotations[]

ClassAnnotation

annotations for each class

ClassifierSpecification

Specification of model used for annotation

Field

Description

labels[]

Label

List of labels, annotated by service

classification_type

enum ClassificationType

type of annotation: exclusive (multi-class) or non-exclusive (multi-label)

  • CLASSIFICATION_TYPE_UNSPECIFIED
  • MULTI_LABEL
  • MULTI_CLASS

Label

Description of single label

Field

Description

name

string

Label name

description

string

human readable description of label

ClassAnnotation

Image annotation for specific label

Field

Description

label

Label

list of annotated labels

confidence

double

confidence for each label