Paket google.cloud.automl.v1beta1

Index

AutoMl

AutoML Server API

Die Ressourcennamen werden vom Server zugewiesen. Wenn Ressourcen gelöscht werden, werden die entsprechenden vom Server erstellten Ressourcennamen nicht wieder verwendet.

Die Ressourcen-ID ist das letzte Element des Ressourcennamens. Bei projects/{project_id}/locations/{location_id}/datasets/{dataset_id} ist die ID des Elements also {dataset_id}.

CreateDataset

RPC CreateDataset (CreateDatasetRequest) gibt (Dataset) zurück

Erstellt ein Dataset.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

  • https://www.googleapis.com/auth/cloud-platform

Weitere Informationen finden Sie in der Authentifizierungsübersicht.
CreateModel

rpc CreateModel (CreateModelRequest) gibt (Operation) zurück

Erstellt ein Modell. Gibt nach Abschluss des Vorgangs ein Modell im Feld response zurück. Wird ein Modell erstellt, werden mehrere Modellbewertungen dafür erzeugt: eine globale Bewertung und eine Bewertung für jede Annotationsspezifikation.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

  • https://www.googleapis.com/auth/cloud-platform

Weitere Informationen finden Sie in der Authentifizierungsübersicht.
DeleteDataset

rpc DeleteDataset (DeleteDatasetRequest) gibt (Operation) zurück

Löscht ein Dataset und seinen gesamten Inhalt. Gibt nach Abschluss des Vorgangs eine leere Antwort im Feld response und delete_details im Feld metadata zurück.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

  • https://www.googleapis.com/auth/cloud-platform

Weitere Informationen finden Sie in der Authentifizierungsübersicht.
DeleteModel

rpc DeleteModel (DeleteModelRequest) gibt (Operation) zurück

Löscht ein Modell. Wenn ein Modell bereits bereitgestellt wurde, löscht dies nur das Modell in AutoML BE, ändert den Status des bereitgestellten Modells in der Produktionsumgebung aber nicht. Gibt nach Abschluss des Vorgangs google.protobuf.Empty im Feld response und delete_details im Feld metadata zurück.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

  • https://www.googleapis.com/auth/cloud-platform

Weitere Informationen finden Sie in der Authentifizierungsübersicht.
DeployModel

rpc DeployModel (DeployModelRequest) gibt (Operation) zurück

Stellt ein Modell bereit. Gibt nach Abschluss des Vorgangs [DeployModelResponse][] im Feld response zurück.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

  • https://www.googleapis.com/auth/cloud-platform

Weitere Informationen finden Sie in der Authentifizierungsübersicht.
ExportData

rpc ExportData (ExportDataRequest) gibt (Operation) zurück

Exportiert die Daten des Datasets in einen Google Cloud Storage-Bucket. Gibt nach Abschluss des Vorgangs eine leere Antwort im Feld response zurück.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

  • https://www.googleapis.com/auth/cloud-platform

Weitere Informationen finden Sie in der Authentifizierungsübersicht.
GetDataset

rpc GetDataset (GetDatasetRequest) gibt (Dataset) zurück

Ruft ein Dataset ab.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

  • https://www.googleapis.com/auth/cloud-platform

Weitere Informationen finden Sie in der Authentifizierungsübersicht.
GetModel

rpc GetModel (GetModelRequest) gibt (Model) zurück

Ruft ein Modell ab.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

  • https://www.googleapis.com/auth/cloud-platform

Weitere Informationen finden Sie in der Authentifizierungsübersicht.
GetModelEvaluation

rpc GetModelEvaluation (GetModelEvaluationRequest) gibt (ModelEvaluation) zurück

Ruft eine Modellbewertung ab.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

  • https://www.googleapis.com/auth/cloud-platform

Weitere Informationen finden Sie in der Authentifizierungsübersicht.
ImportData

rpc ImportData (ImportDataRequest) gibt (Operation) zurück

Importiert Daten in ein Dataset. Gibt nach Abschluss des Vorgangs eine leere Antwort im Feld response zurück.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

  • https://www.googleapis.com/auth/cloud-platform

Weitere Informationen finden Sie in der Authentifizierungsübersicht.
ListDatasets

rpc ListDatasets (ListDatasetsRequest) gibt (ListDatasetsResponse) zurück

Listet Datasets in einem Projekt auf.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

  • https://www.googleapis.com/auth/cloud-platform

Weitere Informationen finden Sie in der Authentifizierungsübersicht.
ListModelEvaluations

rpc ListModelEvaluations (ListModelEvaluationsRequest) gibt (ListModelEvaluationsResponse) zurück

Listet Modellbewertungen auf.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

  • https://www.googleapis.com/auth/cloud-platform

Weitere Informationen finden Sie in der Authentifizierungsübersicht.
ListModels

rpc ListModels (ListModelsRequest) gibt (ListModelsResponse) zurück

Listet Modelle auf.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

  • https://www.googleapis.com/auth/cloud-platform

Weitere Informationen finden Sie in der Authentifizierungsübersicht.
UndeployModel

rpc UndeployModel (UndeployModelRequest) gibt (Operation) zurück

Macht die Bereitstellung eines Modells rückgängig. Gibt nach Abschluss des Vorgangs UndeployModelResponse im Feld response zurück.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

  • https://www.googleapis.com/auth/cloud-platform

Weitere Informationen finden Sie in der Authentifizierungsübersicht.

PredictionService

AutoML Prediction API.

Predict

RPC Predict (PredictRequest) gibt (PredictResponse) zurück

Trifft eine Vorhersage.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

  • https://www.googleapis.com/auth/cloud-platform

Weitere Informationen finden Sie in der Authentifizierungsübersicht.

AnnotationPayload

Enthält Annotationsinformationen, die für AutoML relevant sind.

Felder
annotation_spec_id

string

Nur Ausgabe. Die Ressourcen-ID der Annotationsspezifikation, auf die sich diese Annotation bezieht. Die Annotationsspezifikation stammt entweder aus einem Ancestor-Dataset oder aus dem Dataset, das zum Trainieren des eingesetzten Modells verwendet wurde.

display_name

string

Nur Ausgabe. Der Wert für AnnotationSpec.display_name, wenn das Modell trainiert wurde. Da dieses Feld beim Modelltraining einen Wert zurückgibt, kann der zurückgegebene Wert für verschiedene Modelle, die mit demselben Dataset trainiert werden, unterschiedlich sein. Das liegt daran, dass der Modellinhaber display_name zwischen zwei beliebigen Modelltrainings aktualisieren kann.

Union-Feld detail. Nur Ausgabe. Zusätzliche Informationen zur Annotation, die für die AutoML-Lösung spezifisch ist. Für detail ist nur eine der folgenden Annotationen zulässig:
translation

TranslationAnnotation

Annotationsdetails für die Übersetzung.

classification

ClassificationAnnotation

Annotationsdetails für die Inhalts- oder Bildklassifizierung.

ClassificationAnnotation

Enthält Annotationsdetails, die speziell für die Klassifizierung gelten.

Felder
score

float

Nur Ausgabe. Eine Konfidenzschätzung zwischen 0,0 und 1,0. Je höherer der Wert ist, desto wahrscheinlicher ist eine positive Annotation. Bestätigt der Nutzer eine Annotation als negativ oder positiv, bleibt der Wert unverändert. Erstellt der Nutzer eine Annotation, ist 0 der Wert für negativ und 1 der Wert für positiv.

ClassificationEvaluationMetrics

Modellbewertungsmesswerte für Klassifizierungsprobleme. Nur für v1beta1 sichtbar

Felder
au_prc

float

Nur Ausgabe. Die Fläche unter dem Messwert der Genauigkeits-/Trefferquotenkurve.

base_au_prc

float

Nur Ausgabe. Die Fläche unter dem Messwert der Genauigkeits-/Trefferquotenkurve basierend auf vorherigen Messwerten.

confidence_metrics_entry[]

ConfidenceMetricsEntry

Nur Ausgabe. Messwerte mit Konfidenzschwellenwerten. Genauigkeits-/Trefferquotenkurven können daraus abgeleitet werden.

confusion_matrix

ConfusionMatrix

Nur Ausgabe. Wahrheitsmatrix (auch Konfusionsmatrix genannt) der Bewertung. Nur für MULTICLASS-Klassifizierungsprobleme, bei denen die Anzahl der Labels nicht mehr als 10 beträgt. Nur für die Bewertung auf Modellebene, nicht für die Bewertung pro Label.

annotation_spec_id[]

string

Nur Ausgabe. Die Annotationsspezifikations-IDs, die für diese Auswertung verwendet werden.

ConfidenceMetricsEntry

Messwerte für einen einzelnen Konfidenzschwellenwert.

Felder
confidence_threshold

float

Nur Ausgabe. Der Konfidenzschwellenwert, der zur Berechnung der Messwerte verwendet wird.

recall

float

Nur Ausgabe. Trefferquote unter dem angegebenen Konfidenzschwellenwert.

precision

float

Nur Ausgabe. Genauigkeit unter dem angegebenen Konfidenzschwellenwert.

f1_score

float

Nur Ausgabe. Der harmonische Mittelwert von Trefferquote und Genauigkeit.

recall_at1

float

Nur Ausgabe. Die Trefferquote unter alleiniger Berücksichtigung des Labels, das für jedes Beispiel den höchsten Vorhersagewert hat, der nicht unter dem Konfidenzschwellenwert liegt.

precision_at1

float

Nur Ausgabe. Die Genauigkeit unter alleiniger Berücksichtigung des Labels, das für jedes Beispiel den höchsten Vorhersagewert hat, der nicht unter dem Konfidenzschwellenwert liegt.

f1_score_at1

float

Nur Ausgabe. Der harmonische Mittelwert von recall_at1 und precision_at1.

ConfusionMatrix

Wahrheitsmatrix des Modells, das die Klassifizierung ausführt.

Felder
annotation_spec_id[]

string

Nur Ausgabe. Die Annotationsspezifikations-IDs, die in der Wahrheitsmatrix verwendet werden.

row[]

Row

Nur Ausgabe. Zeilen in der Wahrheitsmatrix. Die Anzahl der Zeilen entspricht der Größe von annotation_spec_id. row[i].value[j] ist die Anzahl der Beispiele, die Ground Truth von annotation_spec_id[i] haben und von dem zu bewertenden Modell als annotation_spec_id[j] vorhergesagt werden.

Row

Nur Ausgabe. Eine Zeile in der Wahrheitsmatrix.

Felder
example_count[]

int32

Nur Ausgabe. Wert einer bestimmten Zelle in der Wahrheitsmatrix. Die Anzahl der Werte in jeder Zeile entspricht der Größe von annotation_spec_id.

ClassificationType

Typ des Klassifizierungsproblems.

Enums
CLASSIFICATION_TYPE_UNSPECIFIED Sollte nicht verwendet werden. Ein nicht festgelegtes Enum hat standardmäßig diesen Wert.
MULTICLASS Es ist höchstens ein Label pro Beispiel zulässig.
MULTILABEL Für ein Beispiel sind mehrere Labels zulässig.

CreateDatasetRequest

Anfragenachricht für AutoMl.CreateDataset.

Felder
parent

string

Der Ressourcenname des Projekts, für das das Dataset erstellt werden soll.

Zur Autorisierung ist die folgende Google IAM-Berechtigung für die angegebene Ressource parent erforderlich:

  • automl.datasets.create
dataset

Dataset

Das Dataset, das erstellt werden soll.

CreateModelOperationMetadata

Details zum Vorgang "CreateModel".

CreateModelRequest

Anfragenachricht für AutoMl.CreateModel.

Felder
parent

string

Der Ressourcenname des übergeordneten Projekts, in dem das Modell erstellt wird.

Zur Autorisierung ist die folgende Google IAM-Berechtigung für die angegebene Ressource parent erforderlich:

  • automl.models.create
model

Model

Das Modell, das erstellt werden soll.

Dataset

Ein Arbeitsbereich zum Lösen eines einzelnen, speziellen Problems beim maschinellen Lernen (ML). Ein Arbeitsbereich enthält Beispiele, die möglicherweise annotiert sind.

Felder
name

string

Nur Ausgabe. Der Ressourcenname des Datasets. Format: projects/{project_id}/locations/{location_id}/datasets/{dataset_id}

display_name

string

Erforderlich. Der Name des Datasets, das auf der Benutzeroberfläche angezeigt werden soll. Der Name kann bis zu 32 Zeichen lang sein und darf gemäß ASCII-Codierung nur aus lateinischen Groß- und Kleinbuchstaben (A–Z bzw. a–z), Unterstrichen (_) und den Ziffern 0–9 bestehen.

example_count

int32

Nur Ausgabe. Anzahl der Beispiele im Dataset.

create_time

Timestamp

Nur Ausgabe. Zeitstempel für die Zeit, zu der dieses Dataset erstellt wurde.

Union-Feld dataset_metadata. Erforderlich. Die Dataset-Metadaten, die für den Problemtyp spezifisch sind. Für dataset_metadata sind nur folgende Dataset-Metadaten zulässig:
translation_dataset_metadata

TranslationDatasetMetadata

Metadaten eines Datasets, das für die Übersetzung verwendet wird.

image_classification_dataset_metadata

ImageClassificationDatasetMetadata

Metadaten eines Datasets, das für die Bildklassifizierung verwendet wird.

text_classification_dataset_metadata

TextClassificationDatasetMetadata

Metadaten eines Datasets, das für die Textklassifizierung verwendet wird.

DeleteDatasetRequest

Anfragenachricht für AutoMl.DeleteDataset.

Felder
name

string

Der Ressourcenname des Datasets, das gelöscht werden soll.

Zur Autorisierung ist die folgende Google IAM-Berechtigung für die angegebene Ressource name erforderlich:

  • automl.datasets.delete

DeleteModelRequest

Anfragenachricht für AutoMl.DeleteModel.

Felder
name

string

Der Ressourcenname des Modells, das gelöscht wird.

Zur Autorisierung ist die folgende Google IAM-Berechtigung für die angegebene Ressource name erforderlich:

  • automl.models.delete

DeployModelRequest

Anfragenachricht für AutoMl.DeployModel.

Felder
name

string

Ressourcenname des Modells, das bereitgestellt werden soll.

Zur Autorisierung ist die folgende Google IAM-Berechtigung für die angegebene Ressource name erforderlich:

  • automl.models.deploy

ExamplePayload

Beispieldaten für Training oder Vorhersage.

Felder
Union-Feld payload. Erforderlich. Nur Eingabe. Beispieldaten. Für payload ist nur einer der folgenden Werte zulässig:
image

Image

Ein Beispielbild.

text_snippet

TextSnippet

Beispieltext.

ExportDataRequest

Anfragenachricht für AutoMl.ExportData.

Felder
name

string

Erforderlich. Der Ressourcenname des Datasets.

Zur Autorisierung ist die folgende Google IAM-Berechtigung für die angegebene Ressource name erforderlich:

  • automl.datasets.export
output_config

OutputConfig

Erforderlich. Der gewünschte Ausgabeort.

GcsDestination

Der Google Cloud Storage-Speicherort, an den die Ausgabe geschrieben werden muss.

Felder
output_uri_prefix

string

Erforderlich. Der Google Cloud Storage-URI für Ausgabeverzeichnisse mit bis zu 2.000 Zeichen. Akzeptierte Formen: * Präfixpfad: gs://bucket/directory Der anfragende Nutzer muss Schreibberechtigung für den Bucket haben. Das Verzeichnis wird erstellt, falls es nicht existiert.

GcsSource

Der Google Cloud Storage-Speicherort für den eingegebenen Inhalt.

Felder
input_uris[]

string

Erforderlich. Der Google Cloud Storage-URI für Eingabedateien mit bis zu 2.000 Zeichen. Akzeptierte Formen: * Vollständiger Objektpfad: gs://bucket/directory/object.csv

GetDatasetRequest

Anfragenachricht für AutoMl.GetDataset.

Felder
name

string

Der Ressourcenname des abzurufenden Datasets.

Zur Autorisierung ist die folgende Google IAM-Berechtigung für die angegebene Ressource name erforderlich:

  • automl.datasets.get

GetModelEvaluationRequest

Anfragenachricht für AutoMl.GetModelEvaluation.

Felder
name

string

Ressourcenname für die Modellbewertung.

Zur Autorisierung ist die folgende Google IAM-Berechtigung für die angegebene Ressource name erforderlich:

  • automl.modelEvaluations.get

GetModelRequest

Anfragenachricht für AutoMl.GetModel.

Felder
name

string

Ressourcenname des Modells.

Zur Autorisierung ist die folgende Google IAM-Berechtigung für die angegebene Ressource name erforderlich:

  • automl.models.get

Image

Darstellung eines Bilds.

Felder
thumbnail_uri

string

Nur Ausgabe. HTTP-URI zur Miniaturansicht.

Union-Feld data. Nur Eingabe. Die Daten, die das Bild darstellen. Für Predict-Aufrufe muss [image_bytes] [] festgelegt werden, da andere Optionen derzeit nicht von der Prediction API unterstützt werden. Mit dem Feld [content_uri][] können Sie den Inhalt eines hochgeladenen Bilds lesen. Für data ist nur einer der folgenden Werte zulässig:
image_bytes

bytes

Bildinhalt, dargestellt als ein Bytestream. Hinweis: Wie bei allen bytes-Feldern verwenden auch Protokollpuffer eine reine Binärdarstellung, während JSON-Darstellungen Base64 verwenden.

input_config

InputConfig

Eine Eingabekonfiguration, die den Inhalt des Bilds angibt.

ImageClassificationDatasetMetadata

Für die Bildklassifizierung bestimmte Dataset-Metadaten.

Felder
classification_type

ClassificationType

Erforderlich. Typ des Klassifizierungsproblems.

ImageClassificationModelMetadata

Modellmetadaten für die Bildklassifizierung.

Felder
base_model_id

string

Optional. Die ID des base-Modells. Falls angegeben, wird das neue Modell auf der Grundlage des base-Modells erstellt. Andernfalls wird das neue Modell von Grund auf neu erstellt. Es wird davon ausgegangen, dass sich das base-Modell im selben project und am selben location wie das neu zu erstellende Modell befindet.

train_budget

int64

Erforderlich. Das Trainingsbudget zum Erstellen dieses Modells. Die tatsächliche Höhe der train_cost kann gleich oder kleiner als dieser Wert sein.

train_cost

int64

Nur Ausgabe. Die tatsächlichen Kosten für die Erstellung dieses Modells. Wenn dieses Modell auf Grundlage eines base-Modells erstellt wird, werden die Kosten, die durch das Erstellen des base-Modells entstehen, nicht eingerechnet.

stop_reason

string

Nur Ausgabe. Gibt den Grund an, warum der Vorgang zum Erstellen eines Modells angehalten wurde, z. B. BUDGET_REACHED, MODEL_CONVERGED.

ImportDataRequest

Anfragenachricht für AutoMl.ImportData.

Felder
name

string

Erforderlich. Name des Datasets. Das Dataset muss bereits vorhanden sein. Alle importierten Annotationen und Beispiele werden hinzugefügt.

Zur Autorisierung ist die folgende Google IAM-Berechtigung für die angegebene Ressource name erforderlich:

  • automl.datasets.import
input_config

InputConfig

Erforderlich. Der gewünschte Eingabeort.

InputConfig

Eingabekonfiguration.

Felder
gcs_source

GcsSource

Der Google Cloud Storage-Speicherort für den eingegebenen Inhalt.

ListDatasetsRequest

Anfragenachricht für AutoMl.ListDatasets.

Felder
parent

string

Der Ressourcenname des Projekts, das die aufzulistenden Datasets enthält.

Zur Autorisierung ist die folgende Google IAM-Berechtigung für die angegebene Ressource parent erforderlich:

  • automl.datasets.list
filter

string

Ein Ausdruck zum Filtern der Ergebnisse der Anfrage. Einfache Filtertypen:

  • image_classification_dataset_metadata:*
  • text_classification_dataset_metadata:*
  • translation_dataset_metadata:*

Beispiel für die Verwendung des Filters:

  • translation_dataset_metadata:* --> Das Dataset beinhaltet translation_dataset_metadata.
page_size

int32

Angeforderte Seitengröße. Der Server gibt möglicherweise weniger Ergebnisse als angefordert zurück. Wenn kein Wert angegeben wurde, wählt der Server eine Standardgröße.

page_token

string

Ein Token, das eine Ergebnisseite ermittelt, die der Server zurückgeben soll. Dieses Token wird in der Regel mit ListDatasetsResponse.next_page_token des vorherigen Aufrufs von AutoMl.ListDatasets abgerufen.

ListDatasetsResponse

Antwortnachricht für AutoMl.ListDatasets.

Felder
datasets[]

Dataset

Die eingelesenen Datasets.

next_page_token

string

Ein Token zum Abrufen der nächsten Ergebnisseite. Übergeben Sie es an ListDatasetsRequest.page_token, um die nächste Seite zu erhalten.

ListModelEvaluationsRequest

Anfragenachricht für AutoMl.ListModelEvaluations.

Felder
parent

string

Ressourcenname des Modells, für das die Modellbewertungen aufgelistet werden sollen. Wenn modelId auf "-" gesetzt ist, werden Modellbewertungen aus allen Modellen des übergeordneten Speicherorts aufgelistet.

Zur Autorisierung ist die folgende Google IAM-Berechtigung für die angegebene Ressource parent erforderlich:

  • automl.modelEvaluations.list
filter

string

Ein Ausdruck zum Filtern der Ergebnisse der Anfrage. Einfache Filtertypen:

  • annotation_spec_id=123

Einige Beispiele für die Verwendung des Filters sind:

  • annotation_spec_id!=4 --> Die Modellbewertung wurde für alle Annotationsspezifikationen durchgeführt, deren ID nicht 4 ist.
  • NOT annotation_spec_id:* --> Die Modellbewertung wurde für alle Annotationsspezifikationen durchgeführt.
page_size

int32

Angeforderte Seitengröße.

page_token

string

Ein Token, das eine Ergebnisseite ermittelt, die der Server zurückgeben soll. Dieses Token wird in der Regel mit ListModelEvaluationsResponse.next_page_token des vorherigen Aufrufs von AutoMl.ListModelEvaluations abgerufen.

ListModelEvaluationsResponse

Antwortnachricht für AutoMl.ListModelEvaluations.

Felder
model_evaluation[]

ModelEvaluation

Liste der Modellebewertungen auf der angeforderten Seite.

next_page_token

string

Ein Token zum Abrufen der nächsten Ergebnisseite. Übergeben Sie es an [ListModelEvaluations.page_token][], um die nächste Seite zu erhalten.

ListModelsRequest

Anfragenachricht für AutoMl.ListModels.

Felder
parent

string

Ressourcenname des Projekts, das die aufzulistenden Modelle enthält.

Zur Autorisierung ist die folgende Google IAM-Berechtigung für die angegebene Ressource parent erforderlich:

  • automl.models.list
filter

string

Ein Ausdruck zum Filtern der Ergebnisse der Anfrage. Einfache Filtertypen:

  • image_classification_model_metadata:*
  • text_classification_model_metadata:*
  • translation_model_metadata:*
  • dataset_id=123

Einige Beispiele für die Verwendung des Filters sind:

  • image_classification_model_metadata:* --> Das Modell beinhaltet image_classification_model_metadata.
  • dataset_id=5 --> Das Modell wurde aus einem Dataset mit der ID 5 erstellt.
page_size

int32

Angeforderte Seitengröße.

page_token

string

Ein Token, das eine Ergebnisseite ermittelt, die der Server zurückgeben soll. Dieses Token wird in der Regel mit ListModelsResponse.next_page_token des vorherigen Aufrufs von AutoMl.ListModels abgerufen.

ListModelsResponse

Antwortnachricht für AutoMl.ListModels.

Felder
model[]

Model

Liste der Modelle auf der angeforderten Seite.

next_page_token

string

Ein Token zum Abrufen der nächsten Ergebnisseite. Übergeben Sie es an [ListModels.page_token][], um die nächste Seite zu erhalten.

Model

API-Proto, der ein trainiertes Modell für maschinelles Lernen darstellt.

Felder
name

string

Nur Ausgabe. Ressourcenname des Modells. Format: projects/{project_id}/locations/{location_id}/models/{model_id}

display_name

string

Erforderlich. Der Name des Modells, das in der Benutzeroberfläche angezeigt werden soll. Der Name kann bis zu 32 Zeichen lang sein und darf gemäß ASCII-Codierung nur aus lateinischen Groß- und Kleinbuchstaben (A–Z bzw. a–z), Unterstrichen (_) und den Ziffern 0–9 bestehen.

dataset_id

string

Erforderlich. Die Ressourcen-ID des Datasets, das zum Erstellen des Modells verwendet wurde. Das Dataset muss aus demselben Ancestor-Projekt und vom selben Standort stammen.

create_time

Timestamp

Nur Ausgabe. Der Zeitstempel für den Zeitpunkt, zu dem dieses Modell erstellt wurde.

update_time

Timestamp

Nur Ausgabe. Der Zeitstempel für den Zeitpunkt, zu dem dieses Modell zuletzt aktualisiert wurde.

deployment_state

DeploymentState

Nur Ausgabe. Bereitstellungsstatus des Modells. Ein Modell kann Vorhersageanfragen erst bearbeiten, nachdem es bereitgestellt wurde.

Union-Feld model_metadata. Erforderlich. Die Modellmetadaten, die für den Problemtyp spezifisch sind. Muss mit dem Metadatentyp des Datasets übereinstimmen, das zum Trainieren des Modells verwendet wurde. Für model_metadata kommt nur eines der folgenden Möglichkeiten infrage:
image_classification_model_metadata

ImageClassificationModelMetadata

Metadaten für Bildklassifizierungsmodelle.

text_classification_model_metadata

TextClassificationModelMetadata

Metadaten für Textklassifizierungsmodelle.

translation_model_metadata

TranslationModelMetadata

Metadaten für Übersetzungsmodelle.

DeploymentState

Bereitstellungsstatus des Modells.

Enums
DEPLOYMENT_STATE_UNSPECIFIED Sollte nicht verwendet werden. Ein nicht festgelegtes Enum hat standardmäßig diesen Wert.
DEPLOYED Modell wurde bereitgestellt.
UNDEPLOYED Modell wurde nicht bereitgestellt.

ModelEvaluation

Bewertungsergebnisse eines Modells.

Felder
name

string

Nur Ausgabe. Ressourcenname der Modellbewertung. Format:

projects/{project_id}/locations/{location_id}/models/{model_id}/modelEvaluations/{model_evaluation_id}
annotation_spec_id

string

Nur Ausgabe. Die ID der Annotationsspezifikation, auf die die Modellbewertung angewendet wird. Die ID ist für die gesamte Modellbewertung leer. HINWEIS: Derzeit ist es nicht möglich, display_name der Annotationsspezifikation aus der ID abzurufen. Überprüfen Sie die Modellbewertungen in der Benutzeroberfläche, um display_names anzeigen zu lassen.

create_time

Timestamp

Nur Ausgabe. Der Zeitstempel für den Zeitpunkt, zu dem diese Modellbewertung erstellt wurde.

evaluated_example_count

int32

Nur Ausgabe. Die Anzahl der für die Modellbewertung verwendeten Beispiele.

Union-Feld metrics. Nur Ausgabe. Bewertungsmesswerte, die für den Problemtyp spezifisch sind. Für metrics kommt nur eine der folgenden Möglichkeiten infrage:
classification_evaluation_metrics

ClassificationEvaluationMetrics

Bewertungsmesswerte für Klassifizierungsproblemmodelle.

translation_evaluation_metrics

TranslationEvaluationMetrics

Bewertungsmesswerte für Übersetzungsmodelle.

OperationMetadata

Metadaten, die für alle lang andauernden Vorgänge verwendet werden, die von der AutoML API zurückgegeben werden.

Felder
progress_percent

int32

Nur Ausgabe. Fortschritt des Vorgangs. Bereich [0, 100].

partial_failures[]

Status

Nur Ausgabe. Partielle Fehler aufgetreten. Beispiel: einzelne Dateien, die nicht gelesen werden konnten. Dieses Feld sollte niemals 20 Einträge überschreiten. Das Feld "Statusdetails" enthält Informationen zu standardmäßigen GCP-Fehlern.

create_time

Timestamp

Nur Ausgabe. Zeitpunkt der Erstellung des Vorgangs.

update_time

Timestamp

Nur Ausgabe. Zeitpunkt, zu dem der Vorgang zuletzt aktualisiert wurde.

create_model_details

CreateModelOperationMetadata

Details zum Vorgang "CreateModel".

OutputConfig

Ausgabekonfiguration

Felder
gcs_destination

GcsDestination

Der Google Cloud Storage-Speicherort, in den die Ausgabe geschrieben werden muss.

PredictRequest

Anfragenachricht für PredictionService.Predict.

Felder
name

string

Name des Modells, das zur Vorhersage angefordert wurde.

Zur Autorisierung ist die folgende Google IAM-Berechtigung für die angegebene Ressource name erforderlich:

  • automl.models.predict
payload

ExamplePayload

Erforderlich. Nutzlast bei der Ausführung einer Vorhersage. Die Nutzlast muss mit dem Problemtyp übereinstimmen, für den das Modell trainiert wurde.

params

map<string, string>

Zusätzliche domainspezifische Parameter. Jeder String kann bis zu 25.000 Zeichen umfassen.

  • Für die Bildklassifizierung:

score_threshold – (float) Ein Wert von 0,0 bis 1,0. Wenn das Modell Vorhersagen für ein Bild trifft, werden nur Ergebnisse erzeugt, die mindestens diesen Konfidenzschwellenwert haben. Der Standardwert ist 0,5.

PredictResponse

Antwortnachricht für PredictionService.Predict.

Derzeit wird dies nur verwendet, um ein Vorhersageergebnis zur Bilderkennung auszugeben. Weitere Ausgaben von Metadaten zu Vorhersagen werden möglicherweise in Zukunft eingeführt.

Felder
payload[]

AnnotationPayload

Vorhersageergebnis.

metadata

map<string, string>

Zusätzliche domainspezifische Antwortmetadaten zu Vorhersagen.

TextClassificationDatasetMetadata

Dataset-Metadaten für die Klassifizierung.

Felder
classification_type

ClassificationType

Erforderlich. Typ des Klassifizierungsproblems.

TextClassificationModelMetadata

Modellmetadaten, die für die Textklassifizierung spezifisch sind.

TextSnippet

Darstellung eines Text-Snippets.

Felder
content

string

Erforderlich. Der Inhalt des Text-Snippets als String. Bis zu 250.000 Zeichen lang.

mime_type

string

Das Format des Ausgangstextes. Zum Beispiel "text/html" oder "text/plain". Wenn dieser Wert leer ist, wird das Format automatisch anhand des hochgeladenen Inhalts ermittelt. Die Standardeinstellung ist "text/html". Bis zu 25.000 Zeichen lang.

content_uri

string

Nur Ausgabe. HTTP-URI, unter dem Sie den Inhalt herunterladen können.

TranslationAnnotation

Spezifische Annotationsdetails für die Übersetzung.

Felder
translated_content

TextSnippet

Nur Ausgabe. Übersetzter Inhalt.

TranslationDatasetMetadata

Übersetzungsspezifische Dataset-Metadaten.

Felder
source_language_code

string

Erforderlich. Der BCP-47-Sprachcode der Ausgangssprache.

target_language_code

string

Erforderlich. Der BCP-47-Sprachcode der Zielsprache.

TranslationEvaluationMetrics

Bewertungsmesswerte für das Dataset.

Felder
bleu_score

double

Nur Ausgabe. BLEU-Wertung.

base_bleu_score

double

Nur Ausgabe. BLEU-Wertung für das Basismodell.

TranslationModelMetadata

Übersetzungsspezifische Modellmetadaten.

Felder
base_model

string

Der Ressourcenname des Modells, das als Ausgangsbasis zum Trainieren des benutzerdefinierten Modells verwendet wird. Wenn kein Wert festgelegt ist, wird das Standardbasismodell von Google Übersetzer verwendet. Format: projects/{project_id}/locations/{location_id}/models/{model_id}

source_language_code

string

Nur Ausgabe. Aus dem Dataset abgeleitet. Die Ausgangssprache (der BCP-47-Sprachcode), die für das Training verwendet wird.

target_language_code

string

Nur Ausgabe. Die Zielsprache (der BCP-47-Sprachcode), die für das Training verwendet wird.

UndeployModelRequest

Anfragenachricht für AutoMl.UndeployModel.

Felder
name

string

Ressourcenname des Modells, dessen Bereitstellung zurückgenommen werden soll.

Zur Autorisierung ist die folgende Google IAM-Berechtigung für die angegebene Ressource name erforderlich:

  • automl.models.undeploy