REST Resource: projects.locations.corpora.dataSchemas

Ressource: DataSchema

Le schéma de données indique comment l'annotation spécifiée par l'utilisateur est interprétée dans le système.

Représentation JSON
{
  "name": string,
  "key": string,
  "schemaDetails": {
    object (DataSchemaDetails)
  }
}
Champs
name

string

Nom de la ressource du schéma de données au format: projects/{project_number}/locations/{location}/corpora/{corpus}/dataSchemas/{dataSchema}, où la partie {dataSchema} doit être identique au champ key ci-dessous.

key

string

Obligatoire. Clé de ce schéma de données. Cette clé doit correspondre à la clé de l'annotation spécifiée par l'utilisateur et être unique dans le corpus. Cette valeur peut comporter jusqu'à 63 caractères, et les caractères valides sont /[a-z][0-9]-/. Le premier caractère doit être une lettre, et le dernier peut être une lettre ou un chiffre.

schemaDetails

object (DataSchemaDetails)

Détails du schéma correspondant à la clé.

DataSchemaDetails

Les détails du schéma de données indiquent le type de données et la structure de données correspondant à la clé de l'annotation spécifiée par l'utilisateur.

Représentation JSON
{
  "type": enum (DataType),
  "protoAnyConfig": {
    object (ProtoAnyConfig)
  },
  "listConfig": {
    object (ListConfig)
  },
  "customizedStructConfig": {
    object (CustomizedStructConfig)
  },
  "granularity": enum (Granularity),
  "searchStrategy": {
    object (SearchStrategy)
  }
}
Champs
type

enum (DataType)

Type de l'annotation.

protoAnyConfig

object (ProtoAnyConfig)

Configuration pour tout type de protobuf.

listConfig

object (ListConfig)

Configuration pour le type de données "Liste".

customizedStructConfig

object (CustomizedStructConfig)

Configuration pour le type de données CustomizedStruct.

granularity

enum (Granularity)

Précision associée à ce DataSchema.

searchStrategy

object (SearchStrategy)

Stratégie de recherche à appliquer à l'key ci-dessus.

DataType

Type de données de l'annotation.

Enums
DATA_TYPE_UNSPECIFIED Type non spécifié.
INTEGER Type entier. Stratégies de recherche autorisées: - DataSchema.SearchStrategy.NO_SEARCH, - DataSchema.SearchStrategy.EXACT_SEARCH. Compatible avec les requêtes par IntRangeArray.
FLOAT Type de flottant. Stratégies de recherche autorisées: - DataSchema.SearchStrategy.NO_SEARCH, - DataSchema.SearchStrategy.EXACT_SEARCH. Compatible avec les requêtes par FloatRangeArray.
STRING Type de chaîne. Stratégies de recherche autorisées: - DataSchema.SearchStrategy.NO_SEARCH, - DataSchema.SearchStrategy.EXACT_SEARCH, - DataSchema.SearchStrategy.SMART_SEARCH.
DATETIME Formats acceptés: %Y-%m-%dT%H:%M:%E*S%E*z (absl::RFC3339_full) %Y-%m-%dT%H:%M:%E*S %Y-%m-%dT%H:%M%E*z %Y-%m-%dT%H:%M %Y-%m-%dT%H%E*z %Y-%m-%dT%H %Y-%m-%d%E*z %Y-%m-%d %Y-%m %Y Stratégies de recherche autorisées: - DataSchema.SearchStrategy.NO_SEARCH, - DataSchema.SearchStrategy.EXACT_SEARCH. Compatible avec les requêtes par DateTimeRangeArray.
GEO_COORDINATE Type de coordonnées géographiques. Stratégies de recherche autorisées: - DataSchema.SearchStrategy.NO_SEARCH, - DataSchema.SearchStrategy.EXACT_SEARCH. Compatible avec les requêtes par GeoLocationArray.
PROTO_ANY Saisissez un proto à transmettre comme disponible dans annotations.proto. À utiliser en interne uniquement. Types de proto disponibles et comportement de recherche correspondant: - ImageObjectDetectionPredictionResult, permet SMART_SEARCH sur les displayNames et NO_SEARCH. - ClassificationPredictionResult, permet SMART_SEARCH sur les noms à afficher et NO_SEARCH. - ImageSegmentationPredictionResult, autorise NO_SEARCH. - VideoActionRecognitionPredictionResult, permet SMART_SEARCH sur displayName et NO_SEARCH. - VideoObjectTrackingPredictionResult, permet SMART_SEARCH sur displayName et NO_SEARCH. - VideoClassificationPredictionResult, permet SMART_SEARCH sur displayName et NO_SEARCH. - OccupancyCountingPredictionResult, permet EXACT_SEARCH sur stats.full_frame_count.count et NO_SEARCH. - ObjectDetectionPredictionResult, permet SMART_SEARCH sur identifiedBoxes.entity.label_string et NO_SEARCH.
BOOLEAN Type booléen. Stratégies de recherche autorisées: - DataSchema.SearchStrategy.NO_SEARCH, - DataSchema.SearchStrategy.EXACT_SEARCH.
LIST Type de liste. - Chaque élément de la liste doit avoir exactement le même schéma de données. Sinon, il s'agit d'arguments non valides. - Au niveau de la liste, vous ne pouvez pas définir de stratégie de recherche. Le niveau du nœud de feuille peut le faire. - Les éléments ne peuvent pas être une autre liste (pas de liste de listes). - Les éléments peuvent être CUSTOMIZED_STRUCT, et le nombre maximal de calques est de 10.
CUSTOMIZED_STRUCT Type de struct. - SearchStrategy: * Le schéma de données CUSTOMIZED_STRUCT ne peut pas définir de stratégie de recherche. * Les éléments de nœuds terminaux permettent de définir une stratégie de recherche en fonction de la restriction de la stratégie de recherche de l'élément. - Restrictions de couches imbriquées: * Le schéma de données CUSTOMIZED_STRUCT permet également à ses champs d'être de type CUSTOMIZED_STRUCT, mais la restriction globale des couches est de 10.

ProtoAnyConfig

Configuration du type de données PROTO_ANY.

Représentation JSON
{
  "typeUri": string
}
Champs
typeUri

string

URI de type du message proto.

ListConfig

Configuration du type de données LIST.

Représentation JSON
{
  "valueSchema": {
    object (DataSchemaDetails)
  }
}
Champs
valueSchema

object (DataSchemaDetails)

Schéma de données de la valeur dans la liste.

CustomizedStructConfig

Configuration du type de données CUSTOMIZED_STRUCT.

Représentation JSON
{
  "fieldSchemas": {
    string: {
      object (DataSchemaDetails)
    },
    ...
  }
}
Champs
fieldSchemas

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

Schémas de données des éléments enfants directs.

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

Précision

Précision des annotations sous ce DataSchema.

Enums
GRANULARITY_UNSPECIFIED Précision non spécifiée.
GRANULARITY_ASSET_LEVEL Granularité au niveau de l'élément (les annotations ne doivent pas contenir d'informations de partition).
GRANULARITY_PARTITION_LEVEL Précision au niveau de la partition (les annotations doivent contenir des informations sur la partition).

SearchStrategy

Stratégie de recherche pour la valeur des annotations de key.

Représentation JSON
{
  "searchStrategyType": enum (SearchStrategyType)
}
Champs
searchStrategyType

enum (SearchStrategyType)

Type de stratégie de recherche à appliquer à l'key ci-dessus. L'searchStrategyType autorisé est différent pour chaque type de données, comme indiqué dans DataSchemaDetails.DataType. Si vous spécifiez un searchStrategyType non compatible pour les types de données, une erreur INVALID_ARGUMENT s'affiche.

SearchStrategyType

Types de stratégies de recherche à appliquer à la clé d'annotation.

Enums

Méthodes

create

Crée un schéma de données dans le corpus.

delete

Supprime le schéma de données dans le corpus.

get

Récupère le schéma de données dans le corpus.

list

Répertorie les schémas de données dans le corpus.

patch

Met à jour le schéma de données dans le corpus.