REST Resource: projects.locations.corpora.dataSchemas

Ressource: DataSchema

Das Datenschema gibt an, wie die vom Nutzer angegebene Anmerkung im System interpretiert wird.

JSON-Darstellung
{
  "name": string,
  "key": string,
  "schemaDetails": {
    object (DataSchemaDetails)
  }
}
Felder
name

string

Ressourcenname des Datenschemas im Format projects/{project_number}/locations/{location}/corpora/{corpus}/dataSchemas/{dataSchema}. Der Teil {dataSchema} muss mit dem Feld key unten übereinstimmen.

key

string

Pflichtangabe. Der Schlüssel dieses Datenschemas. Dieser Schlüssel muss mit dem Schlüssel der vom Nutzer angegebenen Anmerkung übereinstimmen und innerhalb des Korpus eindeutig sein. Dieser Wert kann bis zu 63 Zeichen umfassen. Gültige Zeichen sind /[a-z][0-9]-/. Das erste Zeichen muss ein Buchstabe sein, das letzte kann ein Buchstabe oder eine Zahl sein.

schemaDetails

object (DataSchemaDetails)

Die Schemadetails, die dem Schlüssel zugeordnet sind.

DataSchemaDetails

Die Datenschema-Details geben den Datentyp und die Datenstruktur an, die dem Schlüssel der vom Nutzer angegebenen Anmerkung entsprechen.

JSON-Darstellung
{
  "type": enum (DataType),
  "protoAnyConfig": {
    object (ProtoAnyConfig)
  },
  "listConfig": {
    object (ListConfig)
  },
  "customizedStructConfig": {
    object (CustomizedStructConfig)
  },
  "granularity": enum (Granularity),
  "searchStrategy": {
    object (SearchStrategy)
  }
}
Felder
type

enum (DataType)

Der Typ der Anmerkung.

protoAnyConfig

object (ProtoAnyConfig)

Konfiguration für protobuf-Any-Typ.

listConfig

object (ListConfig)

Konfiguration für den Listendatentyp.

customizedStructConfig

object (CustomizedStructConfig)

Konfiguration für den Datentyp „CustomizedStruct“.

granularity

enum (Granularity)

Die mit diesem DataSchema verknüpfte Granularität.

searchStrategy

object (SearchStrategy)

Die Suchstrategie, die auf die key oben angewendet werden soll.

DataType

Der Datentyp der Anmerkung.

Enums
DATA_TYPE_UNSPECIFIED Nicht definierter Typ.
INTEGER Ganzzahltyp. Zulässige Suchstrategien: - DataSchema.SearchStrategy.NO_SEARCH, - DataSchema.SearchStrategy.EXACT_SEARCH. Unterstützt Abfragen nach IntRangeArray.
FLOAT Gleitkommatyp. Zulässige Suchstrategien: - DataSchema.SearchStrategy.NO_SEARCH, - DataSchema.SearchStrategy.EXACT_SEARCH. Unterstützt Abfragen nach FloatRangeArray.
STRING Stringtyp. Zulässige Suchstrategien: - DataSchema.SearchStrategy.NO_SEARCH, - DataSchema.SearchStrategy.EXACT_SEARCH, - DataSchema.SearchStrategy.SMART_SEARCH.
DATETIME Unterstützte Formate: %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 Zulässige Suchstrategien: - DataSchema.SearchStrategy.NO_SEARCH, - DataSchema.SearchStrategy.EXACT_SEARCH. Unterstützt Abfragen nach DateTimeRangeArray.
GEO_COORDINATE Typ der geografischen Koordinaten. Zulässige Suchstrategien: - DataSchema.SearchStrategy.NO_SEARCH, - DataSchema.SearchStrategy.EXACT_SEARCH. Unterstützt Abfragen nach GeoLocationArray.
PROTO_ANY Geben Sie ein, um alle in annotations.proto verfügbaren Proto zu übergeben. Nur zur internen Verwendung. Verfügbare Prototypen und das entsprechende Suchverhalten: – „ImageObjectDetectionPredictionResult“ ermöglicht SMART_SEARCH für Anzeigenamen und NO_SEARCH. – ClassificationPredictionResult: Ermöglicht SMART_SEARCH für Anzeigenamen und NO_SEARCH. – „ImageSegmentationPredictionResult“ – erlaubt „NO_SEARCH“. – „VideoActionRecognitionPredictionResult“ erlaubt SMART_SEARCH für „displayName“ und „NO_SEARCH“. – „VideoObjectTrackingPredictionResult“ erlaubt SMART_SEARCH für „displayName“ und „NO_SEARCH“. – „VideoClassificationPredictionResult“ erlaubt „SMART_SEARCH“ für „displayName“ und „NO_SEARCH“. – OccupancyCountingPredictionResult: Ermöglicht EXACT_SEARCH für „stats.full_frame_count.count“ und „NO_SEARCH“. – „ObjectDetectionPredictionResult“ erlaubt SMART_SEARCH für „identifiedBoxes.entity.label_string“ und „NO_SEARCH“.
BOOLEAN Boolescher Typ. Zulässige Suchstrategien: - DataSchema.SearchStrategy.NO_SEARCH, - DataSchema.SearchStrategy.EXACT_SEARCH.
LIST Listentyp. – Alle Elemente in der Liste müssen genau dasselbe Datenschema haben. Andernfalls sind sie ungültige Argumente. – Auf Listenebene kann keine Suchstrategie festgelegt werden. Das ist auf Ebene der Endknoten möglich. Die Elemente dürfen keine andere Liste sein (keine Liste von Listen). – Elemente können CUSTOMIZED_STRUCT sein und die maximale Anzahl von Ebenen ist 10.
CUSTOMIZED_STRUCT Struct-Typ. – Suchstrategie: * Bei einem Datenschema vom Typ „CUSTOMIZED_STRUCT“ kann keine Suchstrategie festgelegt werden. * Bei Endknotenelementen kann die Suchstrategie basierend auf der SearchStrategy-Einschränkung des Elements festgelegt werden. – Einschränkungen für verschachtelte Ebenen: * Bei einem Datenschema vom Typ „CUSTOMIZED_STRUCT“ können die Felder auch vom Typ „CUSTOMIZED_STRUCT“ sein. Die Gesamtzahl der Ebenen ist jedoch auf 10 eingeschränkt.

ProtoAnyConfig

Die Konfiguration für den Datentyp PROTO_ANY.

JSON-Darstellung
{
  "typeUri": string
}
Felder
typeUri

string

Der Typ-URI der Proto-Nachricht.

ListConfig

Die Konfiguration für den Datentyp LIST.

JSON-Darstellung
{
  "valueSchema": {
    object (DataSchemaDetails)
  }
}
Felder
valueSchema

object (DataSchemaDetails)

Das Datenschema des Werts in der Liste.

CustomizedStructConfig

Die Konfiguration für den Datentyp CUSTOMIZED_STRUCT.

JSON-Darstellung
{
  "fieldSchemas": {
    string: {
      object (DataSchemaDetails)
    },
    ...
  }
}
Felder
fieldSchemas

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

Datenschemata für direkte untergeordnete Elemente.

Ein Objekt, das eine Liste von "key": value-Paaren enthält. Beispiel: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

Detaillierungsgrad

Die Granularität der Anmerkungen unter diesem DataSchema.

Enums
GRANULARITY_UNSPECIFIED Nicht angegebene Detailebene.
GRANULARITY_ASSET_LEVEL Detailebene auf Asset-Ebene (Anmerkungen dürfen keine Partitionsinformationen enthalten).
GRANULARITY_PARTITION_LEVEL Detaillierungsgrad auf Partitionsebene (Anmerkungen müssen Partitionsinformationen enthalten).

SearchStrategy

Die Suchstrategie für Anmerkungen des key.

JSON-Darstellung
{
  "searchStrategyType": enum (SearchStrategyType)
}
Felder
searchStrategyType

enum (SearchStrategyType)

Die Art der Suchstrategie, die auf die key oben angewendet werden soll. Die zulässige searchStrategyType unterscheidet sich je nach Datentyp. Weitere Informationen finden Sie unter „DataSchemaDetails.DataType“. Wenn Sie für Datentypen nicht unterstützte searchStrategyType angeben, wird der Fehler INVALID_ARGUMENT zurückgegeben.

SearchStrategyType

Die Arten von Suchstrategien, die auf den Anmerkungsschlüssel angewendet werden sollen.

Enums

Methoden

create

Erstellt ein Datenschema im Korpus.

delete

Löscht das Datenschema im Korpus.

get

Ruft das Datenschema im Korpus ab.

list

Liste der Datenschemata im Korpus.

patch

Aktualisiert das Datenschema im Corpus.