REST Resource: projects.locations.corpora.dataSchemas

Recurso: DataSchema

El esquema de datos indica cómo se interpreta la anotación especificada por el usuario en el sistema.

Representación JSON
{
  "name": string,
  "key": string,
  "schemaDetails": {
    object (DataSchemaDetails)
  }
}
Campos
name

string

Es el nombre del recurso del esquema de datos en el formato projects/{project_number}/locations/{location}/corpora/{corpus}/dataSchemas/{dataSchema}, en el que la parte {dataSchema} debe ser igual que el campo key que aparece a continuación.

key

string

Obligatorio. Es la clave de este esquema de datos. Esta clave debe coincidir con la clave de la anotación especificada por el usuario y ser única dentro del corpus. Este valor puede tener hasta 63 caracteres, y los caracteres válidos son /[a-z][0-9]-/. El primer carácter debe ser una letra, y el último puede ser una letra o un número.

schemaDetails

object (DataSchemaDetails)

Los detalles del esquema que se asignan a la clave

DataSchemaDetails

Los detalles del esquema de datos indican el tipo de datos y la estructura de datos correspondientes a la clave de la anotación especificada por el usuario.

Representación JSON
{
  "type": enum (DataType),
  "protoAnyConfig": {
    object (ProtoAnyConfig)
  },
  "listConfig": {
    object (ListConfig)
  },
  "customizedStructConfig": {
    object (CustomizedStructConfig)
  },
  "granularity": enum (Granularity),
  "searchStrategy": {
    object (SearchStrategy)
  }
}
Campos
type

enum (DataType)

Es el tipo de anotación.

protoAnyConfig

object (ProtoAnyConfig)

Configuración para cualquier tipo de protobuf.

listConfig

object (ListConfig)

Configuración para el tipo de datos de lista.

customizedStructConfig

object (CustomizedStructConfig)

Configuración para el tipo de datos CustomizedStruct.

granularity

enum (Granularity)

El nivel de detalle asociado con este DataSchema.

searchStrategy

object (SearchStrategy)

Es la estrategia de búsqueda que se aplicará en el key anterior.

DataType

Es el tipo de datos de la anotación.

Enums
DATA_TYPE_UNSPECIFIED Tipo no especificado
INTEGER Es un tipo de número entero. Estrategias de búsqueda permitidas: - DataSchema.SearchStrategy.NO_SEARCH, - DataSchema.SearchStrategy.EXACT_SEARCH. Admite la consulta por IntRangeArray.
FLOAT Tipo de número de punto flotante. Estrategias de búsqueda permitidas: - DataSchema.SearchStrategy.NO_SEARCH, - DataSchema.SearchStrategy.EXACT_SEARCH. Admite la consulta por FloatRangeArray.
STRING Es el tipo de cadena. Estrategias de búsqueda permitidas: - DataSchema.SearchStrategy.NO_SEARCH, - DataSchema.SearchStrategy.EXACT_SEARCH, - DataSchema.SearchStrategy.SMART_SEARCH.
DATETIME Formatos admitidos: %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 Estrategias de búsqueda permitidas: - DataSchema.SearchStrategy.NO_SEARCH, - DataSchema.SearchStrategy.EXACT_SEARCH. Admite la consulta por DateTimeRangeArray.
GEO_COORDINATE Tipo de coordenada geográfica. Estrategias de búsqueda permitidas: - DataSchema.SearchStrategy.NO_SEARCH, - DataSchema.SearchStrategy.EXACT_SEARCH. Admite la consulta por GeoLocationArray.
PROTO_ANY Escribe para pasar cualquier proto como disponible en annotations.proto. Solo para uso interno. Prototipos disponibles y su comportamiento de búsqueda correspondiente: - ImageObjectDetectionPredictionResult, permite SMART_SEARCH en displayNames y NO_SEARCH. - ClassificationPredictionResult, permite SMART_SEARCH en displayNames y NO_SEARCH. - ImageSegmentationPredictionResult, permite NO_SEARCH. - VideoActionRecognitionPredictionResult, permite SMART_SEARCH en displayName y NO_SEARCH. - VideoObjectTrackingPredictionResult, permite SMART_SEARCH en displayName y NO_SEARCH. - VideoClassificationPredictionResult, permite SMART_SEARCH en displayName y NO_SEARCH. - OccupancyCountingPredictionResult, permite EXACT_SEARCH en stats.full_frame_count.count y NO_SEARCH. - ObjectDetectionPredictionResult, permite SMART_SEARCH en identifiedBoxes.entity.label_string y NO_SEARCH.
BOOLEAN Tipo booleano. Estrategias de búsqueda permitidas: - DataSchema.SearchStrategy.NO_SEARCH, - DataSchema.SearchStrategy.EXACT_SEARCH.
LIST Tipo de lista. - Cada elemento de la lista debe tener exactamente el mismo esquema de datos; de lo contrario, los argumentos no son válidos. - No se puede establecer una estrategia de búsqueda a nivel de la lista. El nivel de nodo final puede hacerlo. - Los elementos no pueden ser otra lista (no una lista de listas). - Los elementos pueden ser CUSTOMIZED_STRUCT y la cantidad máxima de capas es 10.
CUSTOMIZED_STRUCT Tipo de struct. - SearchStrategy: * El esquema de datos que es CUSTOMIZED_STRUCT no puede establecer la estrategia de búsqueda. * Los elementos de nodo final permiten establecer la estrategia de búsqueda en función de la restricción de SearchStrategy del elemento. - Restricciones de capas anidadas: * El esquema de datos que es CUSTOMIZED_STRUCT permite que sus campos también sean de CUSTOMIZED_STRUCT, pero la restricción general de capas es de 10.

ProtoAnyConfig

Es la configuración del tipo de datos PROTO_ANY.

Representación JSON
{
  "typeUri": string
}
Campos
typeUri

string

El URI de tipo del mensaje proto.

ListConfig

Es la configuración del tipo de datos LIST.

Representación JSON
{
  "valueSchema": {
    object (DataSchemaDetails)
  }
}
Campos
valueSchema

object (DataSchemaDetails)

Es el esquema de datos del valor en la lista.

CustomizedStructConfig

Es la configuración del tipo de datos CUSTOMIZED_STRUCT.

Representación JSON
{
  "fieldSchemas": {
    string: {
      object (DataSchemaDetails)
    },
    ...
  }
}
Campos
fieldSchemas

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

Esquemas de datos de elementos secundarios directos

Un objeto que contiene una lista de pares "key": value. Ejemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

Nivel de detalle

El nivel de detalle de las anotaciones en este DataSchema.

Enums
GRANULARITY_UNSPECIFIED Nivel de detalle no especificado.
GRANULARITY_ASSET_LEVEL Nivel de detalle a nivel del activo (las anotaciones no deben contener información de partición).
GRANULARITY_PARTITION_LEVEL Nivel de detalle a nivel de la partición (las anotaciones deben contener información de la partición)

SearchStrategy

Es la estrategia de búsqueda para el valor de anotaciones de key.

Representación JSON
{
  "searchStrategyType": enum (SearchStrategyType)
}
Campos
searchStrategyType

enum (SearchStrategyType)

Es el tipo de estrategia de búsqueda que se aplicará en el key anterior. El searchStrategyType permitido es diferente para los distintos tipos de datos, lo que se documenta en DataSchemaDetails.DataType. Si especificas un searchStrategyType no admitido para los tipos de datos, se mostrará un error INVALID_ARGUMENT.

SearchStrategyType

Son los tipos de estrategias de búsqueda que se aplicarán en la clave de anotación.

Enums

Métodos

create

Crea un esquema de datos dentro del corpus.

delete

Borra el esquema de datos dentro del corpus.

get

Obtiene el esquema de datos dentro del corpus.

list

Muestra una lista de esquemas de datos dentro del corpus.

patch

Actualiza el esquema de datos dentro del corpus.