REST Resource: projects.locations.corpora.assets.annotations

Ressource: Annotation

Une annotation est une ressource d'un composant. Il représente un mappage clé-valeur du contenu du composant.

Représentation JSON
{
  "name": string,
  "userSpecifiedAnnotation": {
    object (UserSpecifiedAnnotation)
  }
}
Champs
name

string

Nom de ressource de l'annotation. Format : projects/{project_number}/locations/{location}/corpora/{corpus}/assets/{asset}/annotations/{annotation}

userSpecifiedAnnotation

object (UserSpecifiedAnnotation)

Annotation fournie par l'utilisateur.

UserSpecifiedAnnotation

Annotation fournie par les utilisateurs.

Représentation JSON
{
  "key": string,
  "value": {
    object (AnnotationValue)
  },
  "partition": {
    object (Partition)
  }
}
Champs
key

string

Obligatoire. Clé de l'annotation. La clé doit être définie avec le type par CreateDataSchema.

value

object (AnnotationValue)

Valeur de l'annotation. La valeur doit pouvoir être convertie en type conformément au schéma de données.

partition

object (Partition)

Informations de partitionnement dans le temps et l'espace pour l'annotation au niveau des sous-composants.

AnnotationValue

Valeur de l'annotation, y compris tous les types disponibles dans le schéma de données.

Représentation JSON
{

  // Union field value can be only one of the following:
  "intValue": string,
  "floatValue": number,
  "strValue": string,
  "datetimeValue": string,
  "geoCoordinate": {
    object (GeoCoordinate)
  },
  "protoAnyValue": {
    "@type": string,
    field1: ...,
    ...
  },
  "boolValue": boolean,
  "customizedStructDataValue": {
    object
  },
  "listValue": {
    object (AnnotationList)
  },
  "customizedStructValue": {
    object (AnnotationCustomizedStruct)
  }
  // End of list of possible types for union field value.
}
Champs

Champ d'union value.

value ne peut être qu'un des éléments suivants :

intValue

string (int64 format)

Valeur de l'annotation de type int.

floatValue

number

Valeur de l'annotation de type float.

strValue

string

Valeur de l'annotation de type de chaîne.

datetimeValue

string

Valeur de l'annotation de type date/heure.

geoCoordinate

object (GeoCoordinate)

Valeur de l'annotation de type de coordonnées géographiques.

protoAnyValue

object

Valeur de toute valeur proto.

Objet contenant des champs d'un type arbitraire. Un champ supplémentaire "@type" contient un URI identifiant le type. Exemple : { "id": 1234, "@type": "types.example.com/standard/id" }.

boolValue

boolean

Valeur de l'annotation de type booléen.

customizedStructDataValue

object (Struct format)

Valeur de l'annotation de struct personnalisée. Ce champ n'a aucun effet. Utilisez plutôt customizedStructValue pour l'annotation de struct personnalisée.

listValue

object (AnnotationList)

Valeur de l'annotation de type liste.

customizedStructValue

object (AnnotationCustomizedStruct)

Valeur de l'annotation de type de structure personnalisée.

GeoCoordinate

Représentation des coordonnées géographiques

Représentation JSON
{
  "latitude": number,
  "longitude": number
}
Champs
latitude

number

Coordonnée de latitude. Degrés [-90 ; 90]

longitude

number

Longitude. Degrés [-180 ; 180]

AnnotationList

Représentation de la liste dans l'annotation.

Représentation JSON
{
  "values": [
    {
      object (AnnotationValue)
    }
  ]
}
Champs
values[]

object (AnnotationValue)

Valeurs de l'annotation de type de données LIST.

AnnotationCustomizedStruct

Représentation de struct personnalisée dans l'annotation.

Représentation JSON
{
  "elements": {
    string: {
      object (AnnotationValue)
    },
    ...
  }
}
Champs
elements

map (key: string, value: object (AnnotationValue))

Mappage des clés des éléments sur la valeur de l'annotation de l'élément.

Objet contenant une liste de paires "key": value. Exemple : { "name": "wrench", "mass": "1.3kg", "count": "3" }.

Partition

Partition pour spécifier la partition dans le temps et l'espace pour l'annotation au niveau des sous-éléments.

Représentation JSON
{
  "temporalPartition": {
    object (TemporalPartition)
  },
  "spatialPartition": {
    object (SpatialPartition)
  },
  "relativeTemporalPartition": {
    object (RelativeTemporalPartition)
  }
}
Champs
temporalPartition

object (TemporalPartition)

Partitionnement de l'élément dans le temps.

spatialPartition

object (SpatialPartition)

Partitionnement de l'élément dans l'espace.

relativeTemporalPartition

object (RelativeTemporalPartition)

Partitionnement de l'élément dans le temps.

TemporalPartition

Partition de l'asset au format UTC Epoch. Compatible avec le type de corpus STREAM_VIDEO.

Représentation JSON
{
  "startTime": string,
  "endTime": string
}
Champs
startTime

string (Timestamp format)

Heure de début de la partition.

Horodatage au format RFC3339 UTC "Zulu", avec une résolution de l'ordre de la nanoseconde et jusqu'à neuf chiffres décimaux. Exemples : "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".

endTime

string (Timestamp format)

Heure de fin de la partition.

Horodatage au format RFC3339 UTC "Zulu", avec une résolution de l'ordre de la nanoseconde et jusqu'à neuf chiffres décimaux. Exemples : "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".

SpatialPartition

Partitionnement de l'élément dans l'espace.

Représentation JSON
{
  "xMin": string,
  "yMin": string,
  "xMax": string,
  "yMax": string
}
Champs
xMin

string (int64 format)

Valeur de la coordonnée X minimale.

yMin

string (int64 format)

Valeur de la coordonnée Y minimale.

xMax

string (int64 format)

Valeur maximale de la coordonnée X.

yMax

string (int64 format)

Valeur maximale de la coordonnée Y.

RelativeTemporalPartition

Partitionnement de l'asset en temps relatif. Compatible avec le type de corpus VIDEO_ON_DEMAND.

Représentation JSON
{
  "startOffset": string,
  "endOffset": string
}
Champs
startOffset

string (Duration format)

Décalage de l'heure de début de la partition.

Durée en secondes avec neuf chiffres au maximum après la virgule et se terminant par "s". Exemple : "3.5s"

endOffset

string (Duration format)

Décalage de l'heure de fin de la partition.

Durée en secondes avec neuf chiffres au maximum après la virgule et se terminant par "s". Exemple : "3.5s"

Méthodes

create

Crée une annotation dans l'asset.

delete

Supprime l'annotation dans l'élément.

get

Lit l'annotation dans l'asset.

list

Répertorie les annotations de l'asset.

patch

Met à jour l'annotation dans l'élément.