REST Resource: projects.locations.corpora.dataSchemas

Recurso: DataSchema

O esquema de dados indica como a anotação especificada pelo usuário é interpretada no sistema.

Representação JSON
{
  "name": string,
  "key": string,
  "schemaDetails": {
    object (DataSchemaDetails)
  }
}
Campos
name

string

Nome do recurso do esquema de dados no formato: projects/{project_number}/locations/{location}/corpora/{corpus}/dataSchemas/{dataSchema}, em que a parte {dataSchema} precisa ser igual ao campo key abaixo.

key

string

Obrigatório. A chave deste esquema de dados. Essa chave precisa corresponder à chave da anotação especificada pelo usuário e ser exclusiva no corpus. Esse valor pode ter até 63 caracteres, e os caracteres válidos são /[a-z][0-9]-/. O primeiro caractere precisa ser uma letra, e o último pode ser uma letra ou um número.

schemaDetails

object (DataSchemaDetails)

O mapeamento de detalhes do esquema para a chave.

DataSchemaDetails

Os detalhes do esquema de dados indicam o tipo de dados e a estrutura de dados correspondente à chave da anotação especificada pelo usuário.

Representação JSON
{
  "type": enum (DataType),
  "protoAnyConfig": {
    object (ProtoAnyConfig)
  },
  "listConfig": {
    object (ListConfig)
  },
  "customizedStructConfig": {
    object (CustomizedStructConfig)
  },
  "granularity": enum (Granularity),
  "searchStrategy": {
    object (SearchStrategy)
  }
}
Campos
type

enum (DataType)

Tipo da anotação.

protoAnyConfig

object (ProtoAnyConfig)

Configuração para qualquer tipo de protobuf.

listConfig

object (ListConfig)

Configuração para o tipo de dados "Lista".

customizedStructConfig

object (CustomizedStructConfig)

Configuração para o tipo de dados CustomizedStruct.

granularity

enum (Granularity)

A granularidade associada a esse DataSchema.

searchStrategy

object (SearchStrategy)

A estratégia de pesquisa a ser aplicada no key acima.

DataType

Tipo de dados da anotação.

Enums
DATA_TYPE_UNSPECIFIED Tipo não especificado.
INTEGER Tipo inteiro. Estratégias de pesquisa permitidas: - DataSchema.SearchStrategy.NO_SEARCH, - DataSchema.SearchStrategy.EXACT_SEARCH. Suporte a consultas por IntRangeArray.
FLOAT Tipo flutuante. Estratégias de pesquisa permitidas: - DataSchema.SearchStrategy.NO_SEARCH, - DataSchema.SearchStrategy.EXACT_SEARCH. Suporte a consultas por FloatRangeArray.
STRING Tipo de string. Estratégias de pesquisa permitidas: - DataSchema.SearchStrategy.NO_SEARCH, - DataSchema.SearchStrategy.EXACT_SEARCH, - DataSchema.SearchStrategy.SMART_SEARCH.
DATETIME Formatos aceitos: %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 Estratégias de pesquisa permitidas: - DataSchema.SearchStrategy.NO_SEARCH, - DataSchema.SearchStrategy.EXACT_SEARCH. Suporta consultas por DateTimeRangeArray.
GEO_COORDINATE Tipo de coordenada geográfica. Estratégias de pesquisa permitidas: - DataSchema.SearchStrategy.NO_SEARCH, - DataSchema.SearchStrategy.EXACT_SEARCH. Oferece suporte a consultas por GeoLocationArray.
PROTO_ANY Digite para transmitir qualquer proto disponível em annotations.proto. Use apenas internamente. Tipos de proto disponíveis e o comportamento de pesquisa correspondente: - ImageObjectDetectionPredictionResult, permite SMART_SEARCH em displayNames e NO_SEARCH. - ClassificationPredictionResult, permite SMART_SEARCH em displayNames e NO_SEARCH. - ImageSegmentationPredictionResult, permite NO_SEARCH. - VideoActionRecognitionPredictionResult, permite SMART_SEARCH em displayName e NO_SEARCH. - VideoObjectTrackingPredictionResult, permite SMART_SEARCH em displayName e NO_SEARCH. - VideoClassificationPredictionResult, permite SMART_SEARCH em displayName e NO_SEARCH. - O OccupancyCountingPredictionResult permite EXACT_SEARCH em stats.full_frame_count.count e NO_SEARCH. - ObjectDetectionPredictionResult: permite SMART_SEARCH em identifiedBoxes.entity.label_string e NO_SEARCH.
BOOLEAN Tipo booleano. Estratégias de pesquisa permitidas: - DataSchema.SearchStrategy.NO_SEARCH, - DataSchema.SearchStrategy.EXACT_SEARCH.
LIST Tipo de lista. - Cada elemento na lista precisa ter o mesmo esquema de dados. Caso contrário, eles são argumentos inválidos. - O nível da lista não pode definir a estratégia de pesquisa. O nível do nó de folha pode. - Os elementos não podem ser outra lista (sem lista de listas). - Os elementos podem ser CUSTOMIZED_STRUCT, e o número máximo de camadas é 10.
CUSTOMIZED_STRUCT Tipo de struct. - SearchStrategy: * o esquema de dados CUSTOMIZED_STRUCT não pode definir a estratégia de pesquisa. * Os elementos de nó-folha permitem definir a estratégia de pesquisa com base na restrição SearchStrategy do elemento. - Restrições de camadas aninhadas: * O esquema de dados que é CUSTOMIZED_STRUCT permite que os campos também sejam CUSTOMIZED_STRUCT, mas a restrição geral de camadas é 10.

ProtoAnyConfig

A configuração do tipo de dados PROTO_ANY.

Representação JSON
{
  "typeUri": string
}
Campos
typeUri

string

O URI de tipo da mensagem proto.

ListConfig

A configuração do tipo de dados LIST.

Representação JSON
{
  "valueSchema": {
    object (DataSchemaDetails)
  }
}
Campos
valueSchema

object (DataSchemaDetails)

O esquema de dados do valor na lista.

CustomizedStructConfig

A configuração do tipo de dados CUSTOMIZED_STRUCT.

Representação JSON
{
  "fieldSchemas": {
    string: {
      object (DataSchemaDetails)
    },
    ...
  }
}
Campos
fieldSchemas

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

Esquemas de dados de elementos filhos diretos.

Um objeto com uma lista de pares "key": value. Exemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

Granularidade

A granularidade das anotações nesse DataSchema.

Enums
GRANULARITY_UNSPECIFIED Granularidade não especificada.
GRANULARITY_ASSET_LEVEL Granularidade no nível do recurso (as anotações não podem conter informações de partição).
GRANULARITY_PARTITION_LEVEL Granularidade no nível da partição (as anotações precisam conter informações da partição).

SearchStrategy

A estratégia de pesquisa para o valor de anotações do key.

Representação JSON
{
  "searchStrategyType": enum (SearchStrategyType)
}
Campos
searchStrategyType

enum (SearchStrategyType)

O tipo de estratégia de pesquisa a ser aplicado no key acima. O searchStrategyType permitido é diferente para diferentes tipos de dados, o que está documentado em DataSchemaDetails.DataType. Especificar searchStrategyType sem suporte para tipos de dados vai resultar em um erro INVALID_ARGUMENT.

SearchStrategyType

Os tipos de estratégias de pesquisa a serem aplicados à chave de anotação.

Enums

Métodos

create

Cria um esquema de dados no corpus.

delete

Exclui o esquema de dados no corpus.

get

Recebe o esquema de dados dentro do corpus.

list

Lista uma lista de esquemas de dados no corpus.

patch

Atualiza o esquema de dados no corpus.