索引
AutoMl
(インターフェース)PredictionService
(インターフェース)AnnotationPayload
(メッセージ)ClassificationAnnotation
(メッセージ)ClassificationEvaluationMetrics
(メッセージ)ClassificationEvaluationMetrics.ConfidenceMetricsEntry
(メッセージ)ClassificationEvaluationMetrics.ConfusionMatrix
(メッセージ)ClassificationEvaluationMetrics.ConfusionMatrix.Row
(メッセージ)ClassificationType
(列挙型)CreateDatasetRequest
(メッセージ)CreateModelOperationMetadata
(メッセージ)CreateModelRequest
(メッセージ)Dataset
(メッセージ)DeleteDatasetRequest
(メッセージ)DeleteModelRequest
(メッセージ)DeployModelRequest
(メッセージ)ExamplePayload
(メッセージ)ExportDataRequest
(メッセージ)GcsDestination
(メッセージ)GcsSource
(メッセージ)GetDatasetRequest
(メッセージ)GetModelEvaluationRequest
(メッセージ)GetModelRequest
(メッセージ)Image
(メッセージ)ImageClassificationDatasetMetadata
(メッセージ)ImageClassificationModelMetadata
(メッセージ)ImportDataRequest
(メッセージ)InputConfig
(メッセージ)ListDatasetsRequest
(メッセージ)ListDatasetsResponse
(メッセージ)ListModelEvaluationsRequest
(メッセージ)ListModelEvaluationsResponse
(メッセージ)ListModelsRequest
(メッセージ)ListModelsResponse
(メッセージ)Model
(メッセージ)Model.DeploymentState
(列挙型)ModelEvaluation
(メッセージ)OperationMetadata
(メッセージ)OutputConfig
(メッセージ)PredictRequest
(メッセージ)PredictResponse
(メッセージ)TextClassificationDatasetMetadata
(メッセージ)TextClassificationModelMetadata
(メッセージ)TextSnippet
(メッセージ)TranslationAnnotation
(メッセージ)TranslationDatasetMetadata
(メッセージ)TranslationEvaluationMetrics
(メッセージ)TranslationModelMetadata
(メッセージ)UndeployModelRequest
(メッセージ)
AutoMl
AutoML サーバー API。
リソース名はサーバーによって割り当てられます。サーバーは、作成した名前のリソースが削除された後、その名前を再利用しません。
リソースの ID は、アイテムのリソース名の最後の要素です。projects/{project_id}/locations/{location_id}/datasets/{dataset_id}
の場合、アイテムの ID は {dataset_id}
です。
CreateDataset | |
---|---|
データセットを作成します。
|
CreateModel | |
---|---|
モデルを作成します。完了すると、
|
DeleteDataset | |
---|---|
データセットとそのすべてのコンテンツを削除します。完了すると、
|
DeleteModel | |
---|---|
モデルを削除します。モデルがすでにデプロイされている場合は、AutoML BE でのみモデルが削除され、本番環境でデプロイされたモデルのステータスは変更されません。完了すると
|
DeployModel | |
---|---|
モデルをデプロイします。完了すると、
|
ExportData | |
---|---|
データセットのデータを Google Cloud Storage バケットにエクスポートします。完了すると、
|
GetDataset | |
---|---|
データセットを取得します。
|
GetModel | |
---|---|
モデルを取得します。
|
GetModelEvaluation | |
---|---|
モデル評価を取得します。
|
ImportData | |
---|---|
データセットにデータをインポートします。完了すると、
|
ListDatasets | |
---|---|
プロジェクト内のデータセットをリストします。
|
ListModelEvaluations | |
---|---|
モデル評価をリストします。
|
ListModels | |
---|---|
モデルをリストします。
|
UndeployModel | |
---|---|
モデルをデプロイ解除します。完了すると、
|
PredictionService
AutoML Prediction API。
Predict | |
---|---|
予測を実施します。
|
AnnotationPayload
AutoML に関連するアノテーション情報を格納します。
フィールド | ||
---|---|---|
annotation_spec_id |
出力のみ。このアノテーションが関係するアノテーション仕様のリソース ID。アノテーション仕様は、祖先のデータセット、または使用中のモデルのトレーニングに使用されたデータセットのいずれかから取得されます。 |
|
display_name |
出力のみ。モデルがトレーニングされたときの |
|
共用体フィールド detail 。出力のみ。AutoML ソリューションに固有のアノテーションに関する追加情報です。detail は、次のいずれかになります。 |
||
translation |
翻訳のアノテーション詳細。 |
|
classification |
コンテンツ分類または画像分類のアノテーション詳細。 |
ClassificationAnnotation
分類に固有のアノテーション詳細が格納されます。
フィールド | |
---|---|
score |
出力のみ。0.0~1.0 の推定信頼度。値が大きいほど、アノテーションが肯定的であるという信頼度が高くなります。ユーザーがアノテーションを否定的または肯定的として承認した場合、スコア値は変更されません。ユーザーがアノテーションを作成すると、否定的な場合はスコア 0 に、肯定的な場合はスコア 1 になります。 |
ClassificationEvaluationMetrics
分類問題のモデル評価指標。v1beta1 でのみ表示可能。
フィールド | |
---|---|
au_prc |
出力のみ。適合率 / 再現率曲線指標を下回る領域。 |
base_au_prc |
出力のみ。以前のデータに基づく適合率 / 再現率曲線指標を下回る領域。 |
confidence_metrics_entry[] |
出力のみ。信頼度のしきい値を使用した指標。ここから適合率 / 再現率曲線を導出できます。 |
confusion_matrix |
出力のみ。評価の混同行列。ラベルの数が 10 個以下の MULTICLASS 分類問題にのみ設定されます。モデルレベルの評価にのみ設定され、ラベル別の評価には設定されません。 |
annotation_spec_id[] |
出力のみ。この評価に使用されたアノテーション仕様 ID。 |
ConfidenceMetricsEntry
単一の信頼度のしきい値の指標。
フィールド | |
---|---|
confidence_threshold |
出力のみ。指標の計算に使用される信頼度のしきい値。 |
recall |
出力のみ。指定された信頼度のしきい値に基づく再現率。 |
precision |
出力のみ。指定された信頼度のしきい値に基づく適合率。 |
f1_score |
出力のみ。再現率と適合率の調和平均。 |
recall_at1 |
出力のみ。予測スコアが最も高く、各サンプルの信頼度のしきい値を下回らないラベルのみを考慮した場合の再現率。 |
precision_at1 |
出力のみ。予測スコアが最も高く、各サンプルの信頼度のしきい値を下回らないラベルのみを考慮した場合の適合率。 |
f1_score_at1 |
出力のみ。 |
ConfusionMatrix
分類を行うモデルの混同行列。
フィールド | |
---|---|
annotation_spec_id[] |
出力のみ。混同行列で使用されるアノテーション仕様の ID。 |
row[] |
出力のみ。混同行列の行。行数は |
Row
出力のみ。混同行列の行。
フィールド | |
---|---|
example_count[] |
出力のみ。混同行列内の特定のセルの値。各行の値の数は、annotatin_spec_id のサイズと等しくなります。 |
ClassificationType
分類問題のタイプ。
列挙値 | |
---|---|
CLASSIFICATION_TYPE_UNSPECIFIED |
使用しないでください。未指定の列挙値にはこの値がデフォルトで設定されます。 |
MULTICLASS |
1 つのサンプルに最大で 1 つのラベルが許可されます。 |
MULTILABEL |
1 つのサンプルに複数のラベルが許可されます。 |
CreateDatasetRequest
AutoMl.CreateDataset
に対するリクエスト メッセージ。
フィールド | |
---|---|
parent |
データセットを作成するプロジェクトのリソース名。 承認には、指定したリソース
|
dataset |
作成するデータセット。 |
CreateModelOperationMetadata
CreateModel オペレーションの詳細。
CreateModelRequest
AutoMl.CreateModel
に対するリクエスト メッセージ。
フィールド | |
---|---|
parent |
モデルが作成される親プロジェクトのリソース名。 承認には、指定したリソース
|
model |
作成するモデル。 |
Dataset
単一の特定の機械学習(ML)の問題を解決するためのワークスペース。ワークスペースには、アノテーションを付けることができるサンプルが含まれます。
フィールド | ||
---|---|---|
name |
出力のみ。データセットのリソース名。次の形式になります。 |
|
display_name |
必須。インターフェースに表示するデータセット名。名前は最長 32 文字で、ASCII ラテン文字の A~Z と a~z、アンダースコア(_)、ASCII 数字 0~9 のみを使用できます。 |
|
example_count |
出力のみ。データセットに含まれるサンプルの数。 |
|
create_time |
出力のみ。このデータセットが作成されたときのタイムスタンプ。 |
|
共用体フィールド dataset_metadata 。必須。問題タイプに固有のデータセットのメタデータ。dataset_metadata は、次のいずれかになります。 |
||
translation_dataset_metadata |
翻訳に使用されるデータセットのメタデータ。 |
|
image_classification_dataset_metadata |
画像分類に使用されるデータセットのメタデータ。 |
|
text_classification_dataset_metadata |
テキスト分類に使用されるデータセットのメタデータ。 |
DeleteDatasetRequest
AutoMl.DeleteDataset
に対するリクエスト メッセージ。
フィールド | |
---|---|
name |
削除するデータセットのリソース名。 承認には、指定したリソース
|
DeleteModelRequest
AutoMl.DeleteModel
に対するリクエスト メッセージ。
フィールド | |
---|---|
name |
削除するモデルのリソース名。 承認には、指定したリソース
|
DeployModelRequest
AutoMl.DeployModel
に対するリクエスト メッセージ。
フィールド | |
---|---|
name |
デプロイするモデルのリソース名。 承認には、指定したリソース
|
ExamplePayload
トレーニングまたは予測に使用されるサンプルデータ。
フィールド | ||
---|---|---|
共用体フィールド payload 。必須。入力のみのサンプルデータです。payload は、次のいずれかになります。 |
||
image |
サンプル画像。 |
|
text_snippet |
サンプル テキスト。 |
ExportDataRequest
AutoMl.ExportData
に対するリクエスト メッセージ。
フィールド | |
---|---|
name |
必須。データセットのリソース名。 承認には、指定したリソース
|
output_config |
必須。目的の出力場所。 |
GcsDestination
出力を書き込む必要がある Google Cloud Storage の場所。
フィールド | |
---|---|
output_uri_prefix |
必須。出力ディレクトリへの Google Cloud Storage の URI。最長 2,000 文字です。許容される形式: * 接頭辞パス: gs://bucket/directory。リクエスト側のユーザーには、バケットへの書き込み権限が必要です。ディレクトリが存在しない場合は作成されます。 |
GcsSource
入力コンテンツの Google Cloud Storage 上の場所。
フィールド | |
---|---|
input_uris[] |
必須。入力ファイルへの Google Cloud Storage の URI。最長 2,000 文字です。許容される形式: * オブジェクトの絶対パス: gs://bucket/directory/object.csv |
GetDatasetRequest
AutoMl.GetDataset
に対するリクエスト メッセージ。
フィールド | |
---|---|
name |
取得するデータセットのリソース名。 承認には、指定したリソース
|
GetModelEvaluationRequest
AutoMl.GetModelEvaluation
に対するリクエスト メッセージ。
フィールド | |
---|---|
name |
モデル評価のリソース名。 承認には、指定したリソース
|
GetModelRequest
AutoMl.GetModel
に対するリクエスト メッセージ。
フィールド | |
---|---|
name |
モデルのリソース名。 承認には、指定したリソース
|
Image
画像の表現。
フィールド | ||
---|---|---|
thumbnail_uri |
出力のみ。サムネイル画像への HTTP URI。 |
|
共用体フィールド data 。入力のみ。画像を表すデータです。現在、Prediction API では他のオプションがサポートされていないため、Predict 呼び出しでは [image_bytes][] を設定する必要があります。アップロードされた画像のコンテンツは、[content_uri][] フィールドを使用して読み取ることができます。data は次のいずれかになります。 |
||
image_bytes |
バイト ストリームとして表される画像コンテンツ。注: すべての |
|
input_config |
画像のコンテンツを指定する入力構成。 |
ImageClassificationDatasetMetadata
画像分類に固有のデータセット メタデータ。
フィールド | |
---|---|
classification_type |
必須。分類問題のタイプ。 |
ImageClassificationModelMetadata
画像分類のモデル メタデータ。
フィールド | |
---|---|
base_model_id |
省略可。 |
train_budget |
必須。このモデル作成のトレーニング予算。実際の |
train_cost |
出力のみ。このモデル作成の実際のトレーニング コスト。このモデルが |
stop_reason |
出力のみ。このモデルの作成オペレーションが停止した理由(BUDGET_REACHED、MODEL_CONVERGED など)。 |
ImportDataRequest
AutoMl.ImportData
に対するリクエスト メッセージ。
フィールド | |
---|---|
name |
必須。データセット名。データセットはすでに存在している必要があります。インポートされたアノテーションとサンプルがすべて追加されます。 承認には、指定したリソース
|
input_config |
必須。目的の入力場所。 |
InputConfig
入力構成。
フィールド | |
---|---|
gcs_source |
入力コンテンツ用の Google Cloud Storage 上の場所。 |
ListDatasetsRequest
AutoMl.ListDatasets
に対するリクエスト メッセージ。
フィールド | |
---|---|
parent |
リストするデータセットが含まれるプロジェクトのリソース名。 承認には、指定したリソース
|
filter |
リクエストの結果をフィルタリングする式。シンプルなフィルタの種類は次のとおりです。
フィルタの使用例:
|
page_size |
リクエストされたページサイズ。サーバーはリクエストされた数よりも少ない結果を返すことがあります。指定しない場合は、サーバーでデフォルト サイズが選択されます。 |
page_token |
サーバーが返す結果のページを特定するトークン。通常は、前回の |
ListDatasetsResponse
AutoMl.ListDatasets
に対するレスポンス メッセージ。
フィールド | |
---|---|
datasets[] |
読み取られたデータセット。 |
next_page_token |
結果の次のページを取得するためのトークン。当該ページを取得するために |
ListModelEvaluationsRequest
AutoMl.ListModelEvaluations
に対するリクエスト メッセージ。
フィールド | |
---|---|
parent |
モデル評価をリストするモデルのリソース名。modelId を「-」に設定すると、親のロケーションのすべてのモデルの評価がリストされます。 承認には、指定したリソース
|
filter |
リクエストの結果をフィルタリングする式。シンプルなフィルタの種類は次のとおりです。
フィルタの使用例:
|
page_size |
リクエストされたページサイズ。 |
page_token |
サーバーが返す結果のページを特定するトークン。通常は、前回の |
ListModelEvaluationsResponse
AutoMl.ListModelEvaluations
に対するレスポンス メッセージ。
フィールド | |
---|---|
model_evaluation[] |
リクエストされたページのモデル評価のリスト。 |
next_page_token |
結果の次のページを取得するためのトークン。当該ページを取得するために [ListModelEvaluations.page_token][] に渡されます。 |
ListModelsRequest
AutoMl.ListModels
に対するリクエスト メッセージ。
フィールド | |
---|---|
parent |
モデルをリストするプロジェクトのリソース名。 承認には、指定したリソース
|
filter |
リクエストの結果をフィルタリングする式。シンプルなフィルタの種類は次のとおりです。
フィルタの使用例:
|
page_size |
リクエストされたページサイズ。 |
page_token |
サーバーが返す結果のページを特定するトークン。通常は、前回の |
ListModelsResponse
AutoMl.ListModels
に対するレスポンス メッセージ。
フィールド | |
---|---|
model[] |
リクエストされたページのモデルのリスト。 |
next_page_token |
結果の次のページを取得するためのトークン。当該ページを取得するために [ListModels.page_token][] に渡されます。 |
Model
トレーニングされた機械学習モデルを表す API proto。
フィールド | ||
---|---|---|
name |
出力のみ。モデルのリソース名。次の形式になります。 |
|
display_name |
必須。インターフェースに表示するモデル名。名前は最長 32 文字で、ASCII ラテン文字の A~Z と a~z、アンダースコア(_)、ASCII 数字 0~9 のみを使用できます。 |
|
dataset_id |
必須。モデルの作成に使用されるデータセットのリソース ID。データセットは、同じ祖先プロジェクトとロケーションから取得する必要があります。 |
|
create_time |
出力のみ。このモデルが作成されたときのタイムスタンプ。 |
|
update_time |
出力のみ。このモデルが最後に更新されたときのタイムスタンプ。 |
|
deployment_state |
出力のみ。モデルのデプロイ状態。モデルは、デプロイ後にのみ予測リクエストを処理できます。 |
|
共用体フィールド model_metadata 。必須。問題のタイプに固有のモデル メタデータです。モデルのトレーニングに使用されたデータセットのメタデータ タイプと一致する必要があります。model_metadata は、次のいずれかになります。 |
||
image_classification_model_metadata |
画像分類モデルのメタデータ。 |
|
text_classification_model_metadata |
テキスト分類モデルのメタデータ。 |
|
translation_model_metadata |
翻訳モデルのメタデータ。 |
DeploymentState
モデルのデプロイ状態。
列挙値 | |
---|---|
DEPLOYMENT_STATE_UNSPECIFIED |
使用しないでください。未指定の列挙値にはこの値がデフォルトで設定されます。 |
DEPLOYED |
モデルはデプロイされています。 |
UNDEPLOYED |
モデルはデプロイされていません。 |
ModelEvaluation
モデルの評価結果。
フィールド | ||
---|---|---|
name |
出力のみ。モデル評価のリソース名。次の形式になります。
|
|
annotation_spec_id |
出力のみ。モデル評価が適用されるアノテーション仕様の ID。この ID は、モデル評価全体で空白です。注: 現在、アノテーション仕様の ID からこの仕様の display_name を取得する方法はありません。display_name を調べるには、UI でモデル評価を確認します。 |
|
create_time |
出力のみ。このモデル評価が作成されたときのタイムスタンプ。 |
|
evaluated_example_count |
出力のみ。モデル評価に使用されたサンプルの数。 |
|
共用体フィールド metrics 。出力のみ。問題タイプに固有の評価指標です。metrics は、次のいずれかになります。 |
||
classification_evaluation_metrics |
分類問題のモデルに関するモデルの評価指標。 |
|
translation_evaluation_metrics |
翻訳モデルに関するモデルの評価指標。 |
OperationMetadata
AutoML API によって返されるすべての長時間実行オペレーションで使用されるメタデータ。
フィールド | |
---|---|
progress_percent |
出力のみ。オペレーションの進行状況。範囲は [0, 100] です。 |
partial_failures[] |
出力のみ。発生した部分的な障害。たとえば、単一のファイルを読み取れなかった場合などです。このフィールドのエントリが 20 個を超えることはできません。ステータス詳細フィールドには、標準の GCP エラーの詳細が格納されます。 |
create_time |
出力のみ。オペレーションが作成された時刻。 |
update_time |
出力のみ。オペレーションが最後に更新された時刻。 |
create_model_details |
CreateModel オペレーションの詳細。 |
OutputConfig
出力構成。
フィールド | |
---|---|
gcs_destination |
出力の書き込み先とする Google Cloud Storage の場所。 |
PredictRequest
PredictionService.Predict
に対するリクエスト メッセージ。
フィールド | |
---|---|
name |
予測を行うためにリクエストするモデルの名前。 承認には、指定したリソース
|
payload |
必須。予測を実施するためのペイロード。ペイロードは、モデルが解決するようにトレーニングされた問題タイプと一致している必要があります。 |
params |
ドメイン固有の追加パラメータ。25,000 文字以下の文字列にする必要があります。
|
PredictResponse
PredictionService.Predict
に対するレスポンス メッセージ。
現時点では、これは画像認識予測結果を返すためにのみ使用されます。今後、さらに多くの予測出力メタデータが導入される可能性があります。
フィールド | |
---|---|
payload[] |
予測結果。 |
metadata |
追加のドメイン固有の予測レスポンス メタデータ。 |
TextClassificationDatasetMetadata
分類のデータセット メタデータ。
フィールド | |
---|---|
classification_type |
必須。分類問題のタイプ。 |
TextClassificationModelMetadata
テキスト分類に固有のモデル メタデータ。
TextSnippet
テキスト スニペットの表現。
フィールド | |
---|---|
content |
必須。文字列形式によるテキスト スニペットのコンテンツ。最長 250,000 文字です。 |
mime_type |
ソーステキストの形式。たとえば、「text/html」や「text/plain」などです。空白のままにすると、アップロードされたコンテンツの型から自動的に形式が判断されます。デフォルトは「text/html」です。最長 25,000 文字です。 |
content_uri |
出力のみ。コンテンツをダウンロードできる HTTP URI。 |
TranslationAnnotation
翻訳に固有のアノテーション詳細。
フィールド | |
---|---|
translated_content |
出力のみ。翻訳されたコンテンツ。 |
TranslationDatasetMetadata
翻訳に固有のデータセット メタデータ。
フィールド | |
---|---|
source_language_code |
必須。ソース言語の BCP-47 言語コード。 |
target_language_code |
必須。ターゲット言語の BCP-47 言語コード。 |
TranslationEvaluationMetrics
データセットの評価指標。
フィールド | |
---|---|
bleu_score |
出力のみ。BLEU スコア。 |
base_bleu_score |
出力のみ。ベースモデルの BLEU スコア。 |
TranslationModelMetadata
翻訳に固有のモデル メタデータ。
フィールド | |
---|---|
base_model |
カスタムモデルのトレーニングのベースラインとして使用するモデルのリソース名。設定しない場合、Google 翻訳で提供されるデフォルトのベースモデルが使用されます。次の形式になります。 |
source_language_code |
出力のみ。データセットから推定されます。トレーニングに使用されるソース言語(BCP-47 言語コード)。 |
target_language_code |
出力のみ。トレーニングに使用されるターゲット言語(BCP-47 言語コード)。 |
UndeployModelRequest
AutoMl.UndeployModel
に対するリクエスト メッセージ。
フィールド | |
---|---|
name |
デプロイ解除するモデルのリソース名。 承認には、指定したリソース
|