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 を入力して渡します。社内でのみ使用してください。使用可能なプロトタイプと、それに応じた検索動作: - 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

 コーパス内のデータスキーマを更新します。