REST Resource: projects.locations.corpora.dataSchemas

资源：DataSchema

数据架构指示系统如何解读用户指定的注释。

JSON 表示法 
{
  "name": string,
  "key": string,
  "schemaDetails": {
    object (DataSchemaDetails)
  }
}
字段
name

string

数据架构的资源名称，格式为：projects/{project_number}/locations/{location}/corpora/{corpus}/dataSchemas/{dataSchema}，其中 {dataSchema} 部分应与下面的 key 字段相同。
key

string

必需。此数据架构的键。此键应与用户指定的注释的键匹配，并且在语料库内是唯一的。此值最多可包含 63 个字符，有效字符为 /[a-z][0-9]-/。第一个字符必须是字母，最后一个字符可以是字母或数字。
schemaDetails

object (DataSchemaDetails)

与键对应的架构详细信息。

DataSchemaDetails

数据架构详情指示与用户指定注解的键对应的数据类型和数据结构。

JSON 表示法 
{
  "type": enum (DataType),
  "protoAnyConfig": {
    object (ProtoAnyConfig)
  },
  "listConfig": {
    object (ListConfig)
  },
  "customizedStructConfig": {
    object (CustomizedStructConfig)
  },
  "granularity": enum (Granularity),
  "searchStrategy": {
    object (SearchStrategy)
  }
}
字段
type

enum (DataType)

注释的类型。
protoAnyConfig

object (ProtoAnyConfig)

适用于任何类型的 protobuf 的配置。
listConfig

object (ListConfig)

列表数据类型的配置。
customizedStructConfig

object (CustomizedStructConfig)

CustomizedStruct 数据类型的配置。
granularity

enum (Granularity)

与此 DataSchema 关联的精细程度。
searchStrategy

object (SearchStrategy)

要应用于上述 key 的搜索策略。

DataType

注解的数据类型。

枚举
DATA_TYPE_UNSPECIFIED 未指定类型。
INTEGER 整数类型。允许的搜索策略：- DataSchema.SearchStrategy.NO_SEARCH、- DataSchema.SearchStrategy.EXACT_SEARCH。支持按 IntRangeArray 进行查询。
FLOAT 浮点类型。允许的搜索策略：- DataSchema.SearchStrategy.NO_SEARCH、- DataSchema.SearchStrategy.EXACT_SEARCH。支持按 FloatRangeArray 进行查询。
STRING 字符串类型。允许的搜索策略：- DataSchema.SearchStrategy.NO_SEARCH、- DataSchema.SearchStrategy.EXACT_SEARCH、- DataSchema.SearchStrategy.SMART_SEARCH。
DATETIME 支持的格式：%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 允许的搜索策略：- DataSchema.SearchStrategy.NO_SEARCH、- DataSchema.SearchStrategy.EXACT_SEARCH。支持按 DateTimeRangeArray 进行查询。
GEO_COORDINATE 地理坐标类型。允许的搜索策略：- DataSchema.SearchStrategy.NO_SEARCH、- DataSchema.SearchStrategy.EXACT_SEARCH。支持按 GeoLocationArray 进行查询。
PROTO_ANY 输入内容以传递 annotations.proto 中提供的任何 proto。仅限内部使用。可用的 proto 类型及其对应的搜索行为：- ImageObjectDetectionPredictionResult，允许对 displayName 使用 SMART_SEARCH 和 NO_SEARCH。- ClassificationPredictionResult，允许对 displayName 使用 SMART_SEARCH 和 NO_SEARCH。- ImageSegmentationPredictionResult，允许 NO_SEARCH。- VideoActionRecognitionPredictionResult，允许对 displayName 和 NO_SEARCH 使用 SMART_SEARCH。- VideoObjectTrackingPredictionResult，允许对 displayName 和 NO_SEARCH 使用 SMART_SEARCH。- VideoClassificationPredictionResult，允许对 displayName 和 NO_SEARCH 使用 SMART_SEARCH。- OccupancyCountingPredictionResult，允许对 stats.full_frame_count.count 使用 EXACT_SEARCH 和 NO_SEARCH。- ObjectDetectionPredictionResult，允许对 identifiedBoxes.entity.label_string 使用 SMART_SEARCH 和 NO_SEARCH。
BOOLEAN 布尔值类型。允许的搜索策略：- DataSchema.SearchStrategy.NO_SEARCH、- DataSchema.SearchStrategy.EXACT_SEARCH。
LIST 列表类型。- 列表中的每个元素都必须采用完全相同的数据架构；否则，它们是无效的参数。- 列表级别无法设置搜索策略。叶节点级别可以。- 元素不能是另一个列表（不能是列表的列表）。- 元素可以是 CUSTOMIZED_STRUCT，图层数量上限为 10。
CUSTOMIZED_STRUCT 结构体类型。- SearchStrategy：* 数据架构为 CUSTOMIZED_STRUCT 时无法设置搜索策略。* 叶节点元素允许根据元素的 SearchStrategy 限制设置搜索策略。- 嵌套层限制：* 数据架构为 CUSTOMIZED_STRUCT 时，其字段也可以是 CUSTOMIZED_STRUCT，但总层数限制为 10。

ProtoAnyConfig

PROTO_ANY 数据类型的配置。

JSON 表示法 
{
  "typeUri": string
}
字段
typeUri

string

proto 消息的类型 URI。

ListConfig

LIST 数据类型的配置。

JSON 表示法 
{
  "valueSchema": {
    object (DataSchemaDetails)
  }
}
字段
valueSchema

object (DataSchemaDetails)

列表中相应值的数据架构。

CustomizedStructConfig

CUSTOMIZED_STRUCT 数据类型的配置。

JSON 表示法 
{
  "fieldSchemas": {
    string: {
      object (DataSchemaDetails)
    },
    ...
  }
}
字段
fieldSchemas

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

直接子元素数据架构。

包含一系列 "key": value 对的对象。示例：{ "name": "wrench", "mass": "1.3kg", "count": "3" }。

细化程度

此 DataSchema 下的注释的粒度。

枚举
GRANULARITY_UNSPECIFIED 未指定粒度。
GRANULARITY_ASSET_LEVEL 资源级粒度（注释不得包含分区信息）。
GRANULARITY_PARTITION_LEVEL 分区级粒度（注释必须包含分区信息）。

SearchStrategy

key 的注解值的搜索策略。

JSON 表示法 
{
  "searchStrategyType": enum (SearchStrategyType)
}
字段
searchStrategyType

enum (SearchStrategyType)

要应用于上述 key 的搜索策略类型。允许的 searchStrategyType 因数据类型而异，具体详见 DataSchemaDetails.DataType。为数据类型指定不受支持的 searchStrategyType 会导致 INVALID_ARGUMENT 错误。

SearchStrategyType

要应用于注释键的搜索策略类型。

枚举

方法

create

 在语料库中创建数据架构。

delete

 删除语料库中的数据架构。

get

 获取语料库中的数据架构。

list

 列出语料库中的数据架构列表。

patch

 更新了语料库中的数据架构。