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，可在 displayNames 和 NO_SEARCH 上使用 SMART_SEARCH。- ClassificationPredictionResult，允許在 displayNames 和 NO_SEARCH 上使用 SMART_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 和 NO_SEARCH 上使用 EXACT_SEARCH。- ObjectDetectionPredictionResult，允許在 identifiedBoxes.entity.label_string 和 NO_SEARCH 上使用 SMART_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

 更新詞彙庫中的資料結構定義。