パッケージ google.cloud.automl.v1beta1

索引

• AutoMl（インターフェース）
• PredictionService（インターフェース）
• AnnotationPayload（メッセージ）
• AnnotationSpec（メッセージ）
• BatchPredictOperationMetadata（メッセージ）
• BatchPredictOperationMetadata.BatchPredictionOutputInfo（メッセージ）
• BatchPredictRequest（メッセージ）
• BatchPredictResult（メッセージ）
• BatchPredictionInputConfig（メッセージ）
• BatchPredictionOutputConfig（メッセージ）
• ClassificationAnnotation（メッセージ）
• ClassificationEvaluationMetrics（メッセージ）
• ClassificationEvaluationMetrics.ConfidenceMetricsEntry（メッセージ）
• ClassificationEvaluationMetrics.ConfusionMatrix（メッセージ）
• ClassificationEvaluationMetrics.ConfusionMatrix.Row（メッセージ）
• ClassificationType（列挙型）
• CreateDatasetRequest（メッセージ）
• CreateModelOperationMetadata（メッセージ）
• CreateModelRequest（メッセージ）
• Dataset（メッセージ）
• DeleteDatasetRequest（メッセージ）
• DeleteModelRequest（メッセージ）
• DeleteOperationMetadata（メッセージ）
• DeployModelRequest（メッセージ）
• ExamplePayload（メッセージ）
• ExportDataRequest（メッセージ）
• GcsDestination（メッセージ）
• GcsSource（メッセージ）
• GetAnnotationSpecRequest（メッセージ）
• GetDatasetRequest（メッセージ）
• GetModelEvaluationRequest（メッセージ）
• GetModelRequest（メッセージ）
• Image（メッセージ）
• ImageClassificationDatasetMetadata（メッセージ）
• ImageClassificationModelMetadata（メッセージ）
• ImportDataOperationMetadata（メッセージ）
• ImportDataRequest（メッセージ）
• InputConfig（メッセージ）
• ListDatasetsRequest（メッセージ）
• ListDatasetsResponse（メッセージ）
• ListModelEvaluationsRequest（メッセージ）
• ListModelEvaluationsResponse（メッセージ）
• ListModelsRequest（メッセージ）
• ListModelsResponse（メッセージ）
• Model（メッセージ）
• Model.DeploymentState（列挙型）
• ModelEvaluation（メッセージ）
• OperationMetadata（メッセージ）
• OutputConfig（メッセージ）
• PredictRequest（メッセージ）
• PredictResponse（メッセージ）
• TextClassificationDatasetMetadata（メッセージ）
• TextClassificationModelMetadata（メッセージ）
• TextSnippet（メッセージ）
• TimeSegment（メッセージ）
• TranslationAnnotation（メッセージ）
• TranslationDatasetMetadata（メッセージ）
• TranslationEvaluationMetrics（メッセージ）
• TranslationModelMetadata（メッセージ）
• UndeployModelRequest（メッセージ）
• VideoClassificationAnnotation（メッセージ）
• VideoClassificationDatasetMetadata（メッセージ）
• VideoClassificationModelMetadata（メッセージ）

AutoMl

AutoML サーバー API。

リソース名はサーバーによって割り当てられます。サーバーは、作成した名前のリソースが削除された後、その名前を再利用しません。

リソースの ID は、アイテムのリソース名の最後の要素です。projects/{project_id}/locations/{location_id}/datasets/{dataset_id} の場合、アイテムの ID は {dataset_id} です。

CreateDataset
rpc CreateDataset(CreateDatasetRequest) returns (Dataset) データセットを作成します。 承認スコープ 次の OAuth スコープが必要です。 https://www.googleapis.com/auth/cloud-platform 詳細については、認証の概要をご覧ください。

CreateModel
rpc CreateModel(CreateModelRequest) returns (Operation) モデルを作成します。完了すると、response フィールドでモデルを返します。モデルを作成すると、そのモデルに対する複数のモデル評価（グローバル評価と、アノテーション仕様ごとに 1 つの評価）が作成されます。 承認スコープ 次の OAuth スコープが必要です。 https://www.googleapis.com/auth/cloud-platform 詳細については、認証の概要をご覧ください。

DeleteDataset
rpc DeleteDataset(DeleteDatasetRequest) returns (Operation) データセットとそのすべてのコンテンツを削除します。完了すると、response フィールドで空のレスポンスを返し、metadata フィールドで delete_details を返します。 承認スコープ 次の OAuth スコープが必要です。 https://www.googleapis.com/auth/cloud-platform 詳細については、認証の概要をご覧ください。

DeleteModel
rpc DeleteModel(DeleteModelRequest) returns (Operation) モデルを削除します。完了すると、google.protobuf.Empty を response フィールドで、delete_details を metadata フィールドで返します。 承認スコープ 次の OAuth スコープが必要です。 https://www.googleapis.com/auth/cloud-platform 詳細については、認証の概要をご覧ください。

DeployModel
rpc DeployModel(DeployModelRequest) returns (Operation) モデルをデプロイします。完了すると、response フィールドで [DeployModelResponse][] を返します。 承認スコープ 次の OAuth スコープが必要です。 https://www.googleapis.com/auth/cloud-platform 詳細については、認証の概要をご覧ください。

ExportData
rpc ExportData(ExportDataRequest) returns (Operation) データセットのデータを Google Cloud Storage バケットにエクスポートします。完了すると、response フィールドで空のレスポンスを返します。 承認スコープ 次の OAuth スコープが必要です。 https://www.googleapis.com/auth/cloud-platform 詳細については、認証の概要をご覧ください。

GetAnnotationSpec
rpc GetAnnotationSpec(GetAnnotationSpecRequest) returns (AnnotationSpec) アノテーション仕様を取得します。 承認スコープ 次の OAuth スコープが必要です。 https://www.googleapis.com/auth/cloud-platform 詳細については、認証の概要をご覧ください。

GetDataset
rpc GetDataset(GetDatasetRequest) returns (Dataset) データセットを取得します。 承認スコープ 次の OAuth スコープが必要です。 https://www.googleapis.com/auth/cloud-platform 詳細については、認証の概要をご覧ください。

GetModel
rpc GetModel(GetModelRequest) returns (Model) モデルを取得します。 承認スコープ 次の OAuth スコープが必要です。 https://www.googleapis.com/auth/cloud-platform 詳細については、認証の概要をご覧ください。

GetModelEvaluation
rpc GetModelEvaluation(GetModelEvaluationRequest) returns (ModelEvaluation) モデル評価を取得します。 承認スコープ 次の OAuth スコープが必要です。 https://www.googleapis.com/auth/cloud-platform 詳細については、認証の概要をご覧ください。

ImportData
rpc ImportData(ImportDataRequest) returns (Operation) データセットにデータをインポートします。 承認スコープ 次の OAuth スコープが必要です。 https://www.googleapis.com/auth/cloud-platform 詳細については、認証の概要をご覧ください。

ListDatasets
rpc ListDatasets(ListDatasetsRequest) returns (ListDatasetsResponse) プロジェクト内のデータセットをリストします。 承認スコープ 次の OAuth スコープが必要です。 https://www.googleapis.com/auth/cloud-platform 詳細については、認証の概要をご覧ください。

ListModelEvaluations
rpc ListModelEvaluations(ListModelEvaluationsRequest) returns (ListModelEvaluationsResponse) モデル評価をリストします。 承認スコープ 次の OAuth スコープが必要です。 https://www.googleapis.com/auth/cloud-platform 詳細については、認証の概要をご覧ください。

ListModels
rpc ListModels(ListModelsRequest) returns (ListModelsResponse) モデルをリストします。 承認スコープ 次の OAuth スコープが必要です。 https://www.googleapis.com/auth/cloud-platform 詳細については、認証の概要をご覧ください。

UndeployModel
rpc UndeployModel(UndeployModelRequest) returns (Operation) モデルをデプロイ解除します。完了すると、response フィールドで UndeployModelResponse を返します。 承認スコープ 次の OAuth スコープが必要です。 https://www.googleapis.com/auth/cloud-platform 詳細については、認証の概要をご覧ください。

PredictionService

AutoML Prediction API。

BatchPredict
rpc BatchPredict(BatchPredictRequest) returns (Operation) バッチ予測を実行します。オンライン Predict と異なり、バッチ予測結果は即座にレスポンスで使用することはできません。代わりに、長時間実行オペレーション オブジェクトが返されます。ユーザーは、GetOperation メソッドを使用してオペレーション結果を問い合わせることができます。オペレーションが完了すると、BatchPredictResult が response フィールドで返されます。次の ML 問題に使用できます。 動画分類 承認スコープ 次の OAuth スコープが必要です。 https://www.googleapis.com/auth/cloud-platform 詳細については、認証の概要をご覧ください。

Predict
rpc Predict(PredictRequest) returns (PredictResponse) オンライン予測を実施します。予測結果は、レスポンスで直接返されます。 次の ML 問題およびその想定されるリクエスト ペイロードで使用できます。 画像分類 - 形式が .JPEG、.GIF、.PNG のいずれかで、image_bytes が最大 30 MB の画像。 テキスト分類 - コンテンツが最長 10,000 文字で、UTF-8 でエンコードされている TextSnippet。 翻訳 - コンテンツが最長 25,000 文字で、UTF-8 でエンコードされている TextSnippet。 承認スコープ 次の OAuth スコープが必要です。 https://www.googleapis.com/auth/cloud-platform 詳細については、認証の概要をご覧ください。

AnnotationPayload

AutoML に関連するアノテーション情報を格納します。

フィールド
annotation_spec_id	string 出力のみ。このアノテーションが関係するアノテーション仕様のリソース ID。アノテーション仕様は、祖先のデータセット、または使用中のモデルのトレーニングに使用されたデータセットのいずれかから取得されます。
display_name	string 出力のみ。モデルがトレーニングされたときの AnnotationSpec.display_name の値。このフィールドはモデルのトレーニング時に値を返すため、異なるモデルが同じデータセットを使用してトレーニングされていても、任意の 2 つのモデルのトレーニングの間にモデルオーナーが display_name を更新した場合などは、モデルごとに戻り値が異なる可能性があります。
共用体フィールド detail。出力のみ。AutoML ソリューションに固有のアノテーションに関する追加情報です。detail は、次のいずれかになります。
translation	TranslationAnnotation 翻訳のアノテーション詳細。
classification	ClassificationAnnotation コンテンツ分類または画像分類のアノテーション詳細。
video_classification	VideoClassificationAnnotation 動画分類のアノテーション詳細。動画分類予測に対して返されます。

AnnotationSpec

アノテーションの定義。

フィールド
name	string 出力のみ。アノテーション仕様のリソース名。形式は次のとおりです。 'projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/annotationSpecs/{annotation_spec_id}'
display_name	string 必須。インターフェースに表示するアノテーション仕様の名前。名前は最長 32 文字で、ASCII ラテン文字の A～Z と a～z、アンダースコア（_）、ASCII 数字 0～9 のみを使用できます。
example_count	int32 出力のみ。アノテーションによって明確にラベル付けされた親データセットに含まれるサンプルの数。

BatchPredictOperationMetadata

BatchPredict オペレーションの詳細。

フィールド
input_config	BatchPredictionInputConfig 出力のみ。このバッチ予測オペレーションの開始時に与えられた入力構成。
output_info	BatchPredictionOutputInfo 出力のみ。このバッチ予測の出力についてさらに説明した情報。

BatchPredictionOutputInfo

このバッチ予測の出力についてさらに説明します。後述の

BatchPredictionOutputConfig に関する補足情報。

フィールド
gcs_output_directory	string 作成された Google Cloud Storage ディレクトリのフルパス。ここに、予測出力が書き込まれています。

BatchPredictRequest

PredictionService.BatchPredict に対するリクエスト メッセージ。

フィールド
name	string バッチ予測を行うためにリクエストするモデルの名前。 承認には、指定したリソース name に対する次の Google IAM 権限が必要です。 automl.models.predict
input_config	BatchPredictionInputConfig 必須。バッチ予測の入力構成。
output_config	BatchPredictionOutputConfig 必須。出力予測の書き込み先を指定する構成。
params	map<string, string> 予測に対するドメイン固有の追加パラメータ。25,000 文字以下の文字列にする必要があります。 詳細については、動画へのアノテーション付けをご覧ください。 次のパラメータを指定できます。 score_threshold -（浮動小数点数）0.0～1.0 の値。モデルが動画の予測を行うと、ここで指定した信頼スコア以上の結果のみが生成されます。デフォルトは 0.5 です。 segment_classification -（ブール値）セグメント レベルの分類をリクエストするには、true に設定します。AutoML Video Intelligence は、ユーザーがリクエストの構成で指定した動画のセグメント全体のラベルとその信頼スコアを返します。デフォルトは「true」です。 shot_classification -（ブール値）ショットレベルの分類をリクエストするには、true に設定します。AutoML Video Intelligence は、ユーザーがリクエストの構成で指定した動画のセグメント全体で各カメラショットの境界を特定します。AutoML Video Intelligence は、検出されたショットごとのラベルとその信頼スコアとともに、ショットの開始時間と終了時間を返します。警告: この分類タイプでは、モデル評価は行われません。その品質はトレーニング データによって異なりますが、その品質を説明するための指標はありません。デフォルトは「false」です。 1s_interval -（ブール値）1 秒間隔で動画の分類をリクエストするには、true に設定します。AutoML Video Intelligence は、ユーザーがリクエストの構成で指定した動画のセグメント全体のラベルとその信頼スコアを 1 秒ごとに返します。警告: この分類タイプでは、モデル評価は行われません。その品質はトレーニング データによって異なりますが、その品質を説明するための指標はありません。デフォルトは「false」です。

BatchPredictResult

バッチ予測結果。

BatchPredictionInputConfig

batchPredict メソッドの入力構成。

入力ファイルの形式は、予測に使用されるモデルの ML 問題によって異なります。詳細については、ドキュメントの「データの準備」をご覧ください。入力 CSV ファイルは、gcs_source フィールドを使用して指定します。

形式は EBNF で表され、カンマはリテラルであり、このコメントの末尾付近に非終端記号が定義されます。形式は次のとおりです。

動画分類:

CSV ファイルの各行の形式は次のとおりです。

GCS_FILE_PATH,TIME_SEGMENT_START,TIME_SEGMENT_END

• GCS_FILE_PATH - 長さが最大 1 時間の動画への Google Cloud Storage パス。サポートされている拡張子は、.MOV、.MPEG4、.MP4、.AVI です。ffmpeg でサポートされているすべてのファイル形式もサポートされています。

• TIME_SEGMENT_START と TIME_SEGMENT_END - アノテーションを付ける動画のセグメントの開始時間と終了時間のタイムスタンプ。値は動画の長さの範囲内である必要があります。また、TIME_SEGMENT_END は TIME_SEGMENT_START より後である必要があります。

例:

gs://folder/video1.mp4,10,40
gs://folder/video1.mp4,20,60
gs://folder/vid2.mov,0,inf

エラー: 指定された CSV ファイルのいずれも解析できない場合や一定の割合を超える CSV の行を処理できない場合、オペレーションは失敗し、予測は行われません。全体が成功したか失敗したかに関係なく、行ごとの失敗は、特定の上限数まで Operation.metadata.partial_failures にリストされます。

フィールド
gcs_source	GcsSource 入力コンテンツの Google Cloud Storage 上の場所。

BatchPredictionOutputConfig

batchPredict メソッドの出力構成。

新しいディレクトリは、prediction-[model-display-name]-[timestamp-of-prediction-call] という形式で名前が指定された gcs_destination に作成されます。ここで、タイムスタンプは YYYY-MM-DDThh:mm:ss.sssZ という ISO-8601 形式になります。このディレクトリには、ML 予測オペレーションの結果が含まれています。

動画分類:

video_classification.csv というファイルが出力ディレクトリに作成されます。この CSV ファイルは、アノテーション付きの動画ごとに出力が書き込まれた JSON ファイルです。つまり、video_classification_1.json、video_classification_2.json、... というように video_classification_N.json まで続きます。N は、入力から batchPredict リクエストまでの動画分類リクエストの数です。

video_classification.csv のフィールドは次のとおりです。

GCS_FILE_PATH,TIME_SEGMENT_START,TIME_SEGMENT_END,JSON_FILE_NAME,STATUS

• GCS_FILE_PATH、TIME_SEGMENT_START、TIME_SEGMENT_END - batchPredict リクエストの入力 CSV ファイルにある各行の値。

• JSON_FILE_NAME - 動画セグメントの予測レスポンスが含まれている出力ディレクトリ内の json ファイルの名前。

• STATUS - 予測が正常に完了した場合は「OK」、それ以外の場合はエラー メッセージになります。エラー メッセージには、参照先の動画ファイルが存在しない、空であるなどのエラーの理由が示されます。

STATUS が「OK」の各 JSON 出力ファイルには、AnnotationPayload オブジェクトが json 形式でリストされています。これらは、video_classification.csv 内でファイルが割り当てられている動画セグメントの予測です。すべての AnnotationPayload オブジェクトに video_classification フィールドが設定され、各オブジェクトは video_classification.type フィールドで並べ替えられます。

フィールド
gcs_destination	GcsDestination 出力の書き込み先とする Google Cloud Storage 上のディレクトリの場所。

ClassificationAnnotation

分類に固有のアノテーション詳細が格納されます。

フィールド
score	float 出力のみ。0.0～1.0 の推定信頼度。値が大きいほど、アノテーションが肯定的であるという信頼度が高くなります。ユーザーがアノテーションを否定的または肯定的として承認した場合、スコア値は変更されません。ユーザーがアノテーションを作成すると、否定的な場合はスコア 0 に、肯定的な場合はスコア 1 になります。

ClassificationEvaluationMetrics

分類問題のモデル評価指標。注: 動画分類の場合、この指標は「segment_classification」タイプの動画分類予測の品質のみを表します。

フィールド
au_prc	float 出力のみ。適合率 / 再現率曲線指標を下回る領域。
base_au_prc	float 出力のみ。以前のデータに基づく適合率 / 再現率曲線指標を下回る領域。
confidence_metrics_entry[]	ConfidenceMetricsEntry 出力のみ。0.05、0.10、... から、0.95、0.96、0.97、0.98、0.99 まで続く各 confidence_threshold の指標。ここから適合率 / 再現率曲線が導出されます。
confusion_matrix	ConfusionMatrix 出力のみ。評価の混同行列。ラベルの数が 10 個以下の MULTICLASS 分類問題にのみ設定されます。モデルレベルの評価にのみ設定され、ラベル別の評価には設定されません。
annotation_spec_id[]	string 出力のみ。この評価に使用されたアノテーション仕様 ID。

ConfidenceMetricsEntry

単一の信頼度のしきい値の指標。

フィールド
confidence_threshold	float 出力のみ。指標の計算に使用される信頼度のしきい値。
recall	float 出力のみ。指定された信頼度のしきい値に基づく再現率。
precision	float 出力のみ。指定された信頼度のしきい値に基づく適合率。
f1_score	float 出力のみ。再現率と適合率の調和平均。
recall_at1	float 出力のみ。予測スコアが最も高く、各サンプルの信頼度のしきい値を下回らないラベルのみを考慮した場合の再現率。
precision_at1	float 出力のみ。予測スコアが最も高く、各サンプルの信頼度のしきい値を下回らないラベルのみを考慮した場合の適合率。
f1_score_at1	float 出力のみ。recall_at1 と precision_at1 の調和平均。

ConfusionMatrix

分類を行うモデルの混同行列。

フィールド
annotation_spec_id[]	string 出力のみ。混同行列で使用されるアノテーション仕様の ID。
row[]	Row 出力のみ。混同行列の行。行数は annotation_spec_id のサイズと等しくなります。row[i].value[j] は、グランド トゥルースが annotation_spec_id[i] に指定されていて、評価対象のモデルによって annotation_spec_id[j] として予測されたサンプルの数です。

Row

出力のみ。混同行列の行。

フィールド
example_count[]	int32 出力のみ。混同行列内の特定のセルの値。各行の値の数は、annotatin_spec_id のサイズと等しくなります。

ClassificationType

分類問題のタイプ。

列挙値
CLASSIFICATION_TYPE_UNSPECIFIED	使用しないでください。未指定の列挙値にはこの値がデフォルトで設定されます。
MULTICLASS	1 つのサンプルに最大で 1 つのラベルが許可されます。
MULTILABEL	1 つのサンプルに複数のラベルが許可されます。

CreateDatasetRequest

AutoMl.CreateDataset に対するリクエスト メッセージ。

フィールド
parent	string データセットを作成するプロジェクトのリソース名。 承認には、指定したリソース parent に対する次の Google IAM 権限が必要です。 automl.datasets.create
dataset	Dataset 作成するデータセット。

CreateModelOperationMetadata

CreateModel オペレーションの詳細。

CreateModelRequest

AutoMl.CreateModel に対するリクエスト メッセージ。

フィールド
parent	string モデルが作成される親プロジェクトのリソース名。 承認には、指定したリソース parent に対する次の Google IAM 権限が必要です。 automl.models.create
model	Model 作成するモデル。

Dataset

単一の特定の機械学習（ML）の問題を解決するためのワークスペース。ワークスペースには、アノテーションを付けることができるサンプルが含まれます。

フィールド
name	string 出力のみ。データセットのリソース名。次の形式になります。projects/{project_id}/locations/{location_id}/datasets/{dataset_id}
display_name	string 必須。インターフェースに表示するデータセット名。名前は最長 32 文字で、ASCII ラテン文字の A～Z と a～z、アンダースコア（_）、ASCII 数字 0～9 のみを使用できます。
example_count	int32 出力のみ。データセットに含まれるサンプルの数。
create_time	Timestamp 出力のみ。このデータセットが作成されたときのタイムスタンプ。
共用体フィールド dataset_metadata。必須。問題タイプに固有のデータセットのメタデータ。dataset_metadata は、次のいずれかになります。
translation_dataset_metadata	TranslationDatasetMetadata 翻訳に使用されるデータセットのメタデータ。
image_classification_dataset_metadata	ImageClassificationDatasetMetadata 画像分類に使用されるデータセットのメタデータ。
text_classification_dataset_metadata	TextClassificationDatasetMetadata テキスト分類に使用されるデータセットのメタデータ。
video_classification_dataset_metadata	VideoClassificationDatasetMetadata 動画分類に使用されるデータセットのメタデータ。

DeleteDatasetRequest

AutoMl.DeleteDataset に対するリクエスト メッセージ。

フィールド
name	string 削除するデータセットのリソース名。 承認には、指定したリソース name に対する次の Google IAM 権限が必要です。 automl.datasets.delete

DeleteModelRequest

AutoMl.DeleteModel に対するリクエスト メッセージ。

フィールド
name	string 削除するモデルのリソース名。 承認には、指定したリソース name に対する次の Google IAM 権限が必要です。 automl.models.delete

DeleteOperationMetadata

エンティティの削除を実行するオペレーションの詳細。

DeployModelRequest

AutoMl.DeployModel に対するリクエスト メッセージ。

フィールド
name	string デプロイするモデルのリソース名。 承認には、指定したリソース name に対する次の Google IAM 権限が必要です。 automl.models.deploy

ExamplePayload

トレーニングまたは予測に使用されるサンプルデータ。

フィールド
共用体フィールド payload。必須。入力のみのサンプルデータ。payload は、次のいずれかになります。
image	Image サンプル画像。
text_snippet	TextSnippet サンプル テキスト。

ExportDataRequest

AutoMl.ExportData に対するリクエスト メッセージ。

フィールド
name	string 必須。データセットのリソース名。 承認には、指定したリソース name に対する次の Google IAM 権限が必要です。 automl.datasets.export
output_config	OutputConfig 必須。目的の出力場所。

GcsDestination

出力の書き込み先とする Google Cloud Storage 上の場所。

フィールド
output_uri_prefix	string 必須。出力ディレクトリへの Google Cloud Storage の URI。最長 2,000 文字です。許容される形式: * 接頭辞パス: gs://bucket/directory。リクエスト側のユーザーには、バケットへの書き込み権限が必要です。ディレクトリが存在しない場合は作成されます。

GcsSource

入力コンテンツの Google Cloud Storage 上の場所。

フィールド
input_uris[]	string 必須。入力ファイルへの Google Cloud Storage の URI。最長 2,000 文字です。許容される形式: * オブジェクトの絶対パス（gs://bucket/directory/object.csv など）

GetAnnotationSpecRequest

AutoMl.GetAnnotationSpec に対するリクエスト メッセージ。

フィールド
name	string 取得するアノテーション仕様のリソース名。 承認には、指定したリソース name に対する次の Google IAM 権限が必要です。 automl.annotationSpecs.get

GetDatasetRequest

AutoMl.GetDataset に対するリクエスト メッセージ。

フィールド
name	string 取得するデータセットのリソース名。 承認には、指定したリソース name に対する次の Google IAM 権限が必要です。 automl.datasets.get

GetModelEvaluationRequest

AutoMl.GetModelEvaluation に対するリクエスト メッセージ。

フィールド
name	string モデル評価のリソース名。 承認には、指定したリソース name に対する次の Google IAM 権限が必要です。 automl.modelEvaluations.get

GetModelRequest

AutoMl.GetModel に対するリクエスト メッセージ。

フィールド
name	string モデルのリソース名。 承認には、指定したリソース name に対する次の Google IAM 権限が必要です。 automl.models.get

Image

画像の表現。最大 30 MB の画像のみがサポートされています。

フィールド
thumbnail_uri	string 出力のみ。サムネイル画像への HTTP URI。
共用体フィールド data。入力のみ。画像を表すデータです。現在、Prediction API では他のオプションがサポートされていないため、Predict 呼び出しでは [image_bytes][] を設定する必要があります。アップロードされた画像のコンテンツは、[content_uri][] フィールドを使用して読み取ることができます。data は次のいずれかになります。
image_bytes	bytes バイト ストリームとして表される画像コンテンツ。注: すべての bytes フィールドと同様に、protobuffers では純 2 進表現が使用され、JSON 表現では base64 が使用されます。
input_config	InputConfig 画像のコンテンツを指定する入力構成。

ImageClassificationDatasetMetadata

画像分類に固有のデータセット メタデータ。

フィールド
classification_type	ClassificationType 必須。分類問題のタイプ。

ImageClassificationModelMetadata

画像分類のモデル メタデータ。

フィールド
base_model_id	string 省略可。base モデルの ID。指定すると、base モデルに基づいて新しいモデルが作成されます。指定がない場合は、新しいモデルがゼロから作成されます。base モデルは、作成する新しいモデルと同じ project と location に存在すると想定されます。
train_budget	int64 必須。このモデル作成のトレーニング予算（時間単位）。実際の train_cost はこの値以下になります。
train_cost	int64 出力のみ。このモデル作成の実際のトレーニング コスト。このモデルが base モデルから作成されている場合、base モデルの作成に要したトレーニング コストは含まれません。
stop_reason	string 出力のみ。このモデルの作成オペレーションが停止した理由（BUDGET_REACHED や MODEL_CONVERGED など）。

ImportDataOperationMetadata

ImportData オペレーションの詳細。

ImportDataRequest

AutoMl.ImportData に対するリクエスト メッセージ。

フィールド
name	string 必須。データセット名。データセットはすでに存在している必要があります。インポートされたアノテーションとサンプルがすべて追加されます。 承認には、指定したリソース name に対する次の Google IAM 権限が必要です。 automl.datasets.import
input_config	InputConfig 必須。目的の入力の場所とそのドメイン固有のセマンティクス（ある場合）。

InputConfig

ImportData アクションの入力構成。

入力の形式は、インポートが行われるデータセットの dataset_metadata によって異なります。特に指定しない限り、入力ソースとして gcs_source が想定されます。同じ内容のファイルが（GCS_FILE_PATH が異なっていても）複数回記述されている場合は、そのラベル（境界ボックスなど）が追加されます。同じファイルには常に同じ ML_USE と GCS_FILE_PATH を指定する必要があります。そうでない場合、これらの値は、指定されたものから非決定論的に選択されます。

形式は EBNF で表され、カンマはリテラルであり、このコメントの末尾付近に非終端記号が定義されます。形式は次のとおりです。

動画分類:

詳細については、トレーニング データの準備をご覧ください。

CSV ファイルの各行の形式は次のとおりです。

ML_USE,GCS_FILE_PATH

• ML_USE - 現在の行（ファイル）が適用されるデータセットを指定します。この値は、次のいずれかにできます。

• TRAIN - このファイル内の行は、モデルのトレーニングに使用されます。

• TEST - このファイル内の行は、トレーニング中にモデルをテストするために使用されます。

• UNASSIGNED - このファイル内の行は分類されていません。トレーニング データとテストデータに自動的に分割されます。80% がトレーニングに、20% がテストに使用されます。

• GCS_FILE_PATH - Google Cloud Storage に保存されている、モデル トレーニング情報を含むファイルを指定します。

トレーニング データセットが TRAIN および UNASSIGNED CSV ファイルから決定された後、トレーニング データはトレーニング データセットと検証データセットに分割されます。70% がトレーニングに、30% が検証に使用されます。

GCS_FILE_PATH フィールドを使用して指定された各 CSV ファイルの形式は次のとおりです。

GCS_FILE_PATH,LABEL,TIME_SEGMENT_START,TIME_SEGMENT_END

• GCS_FILE_PATH - Google Cloud Storage に保存されている動画へのパス。動画の長さは最大 1 時間です。サポートされている拡張子は、.MOV、.MPEG4、.MP4、.AVI です。ffmpeg でサポートされているすべてのファイル形式もサポートされています。

• LABEL - 動画セグメントのオブジェクトを識別するラベル。

• TIME_SEGMENT_START と TIME_SEGMENT_END - アノテーションを付ける動画のセグメントの開始時間と終了時間のタイムスタンプ。値は動画の長さの範囲内である必要があります。また、TIME_SEGMENT_END は TIME_SEGMENT_START より後である必要があります。

ラベルが 1 つ以上付いている動画のフレームは、他のすべてのラベルについてハード ネガティブとみなされます。ラベルが付いていないフレームは、デフォルトでは不明とみなされます（is_exhaustively_labeled パラメータによってオーバーライドできます）。「-」という特別なラベルを使用すると、特定の時間セグメントがすべてのラベルについてハード ネガティブであることを表現できます。「-」でマークされたセグメントは、他のラベルのセグメントと重複することはできません。

サンプル ファイル:

TRAIN,gs://folder/train_videos.csv
TEST,gs://folder/test_videos.csv
UNASSIGNED,gs://folder/other_videos.csv

次に、gcsSource の「最上位」のファイルによって識別された CSV ファイルの 1 つの形式の例を示します。

 gs://folder/video1.avi,car,120,180.000021
 gs://folder/video1.avi,bike,150,180.000023
 gs://folder/video1.avi,-,180.000024,300.000999
 gs://folder/vid2.avi,car,0,60.5

エラー:

指定された CSV ファイルのいずれも解析できない場合や一定の割合を超える CSV の行を処理できない場合、オペレーションは失敗し、何もインポートされません。全体が成功したか失敗したかに関係なく、行ごとの失敗は、特定の上限数まで Operation.metadata.partial_failures にリストされます。

フィールド
params	map<string, string> インポートされるデータのセマンティクスを記述するドメイン固有の追加パラメータ。文字列は 25,000 文字以下である必要があります。 動画分類の場合: is_exhaustively_labeled -（ブール値）インポートされる動画に徹底的にラベルを付けるかどうか、つまり、ラベルが付いていない動画のすべての時間セグメントが（「-」ラベルが付いている場合と同様に）自動的にすべてのラベルについてハード ネガティブとして認識されるようにするかどうか。デフォルト値は「false」です。
gcs_source	GcsSource 入力コンテンツの Google Cloud Storage 上の場所。

ListDatasetsRequest

AutoMl.ListDatasets に対するリクエスト メッセージ。

フィールド
parent	string リストするデータセットが含まれるプロジェクトのリソース名。 承認には、指定したリソース parent に対する次の Google IAM 権限が必要です。 automl.datasets.list
filter	string リクエストの結果をフィルタリングする式。 dataset_metadata - ケースの有無を基準にする場合。 フィルタの使用例: translation_dataset_metadata:* --> translation_dataset_metadata が含まれるデータセット。
page_size	int32 リクエストされたページサイズ。サーバーはリクエストされた数よりも少ない結果を返すことがあります。指定しない場合は、サーバーでデフォルト サイズが選択されます。
page_token	string サーバーが返す結果のページを特定するトークン。通常は ListDatasetsResponse.next_page_token（以前の AutoMl.ListDatasets 呼び出し）で取得されます。

ListDatasetsResponse

AutoMl.ListDatasets に対するレスポンス メッセージ。

フィールド
datasets[]	Dataset 読み取られたデータセット。
next_page_token	string 結果の次のページを取得するためのトークン。当該ページを取得するために ListDatasetsRequest.page_token に渡されます。

ListModelEvaluationsRequest

AutoMl.ListModelEvaluations に対するリクエスト メッセージ。

フィールド
parent	string モデル評価をリストするモデルのリソース名。modelId を「-」に設定すると、親のロケーションのすべてのモデルの評価がリストされます。 承認には、指定したリソース parent に対する次の Google IAM 権限が必要です。 automl.modelEvaluations.list
filter	string リクエストの結果をフィルタリングする式。 annotation_spec_id - =、!=、または有無を基準にする場合。最後の基準については、次の例をご覧ください。 フィルタの使用例: annotation_spec_id!=4 --> 4 以外のアノテーション仕様 ID に対して実施されたモデル評価。 NOT annotation_spec_id:* --> すべてのアノテーション仕様の集計に対して実施されたモデル評価。
page_size	int32 リクエストされたページサイズ。
page_token	string サーバーが返す結果のページを特定するトークン。通常は ListModelEvaluationsResponse.next_page_token（以前の AutoMl.ListModelEvaluations 呼び出し）で取得されます。

ListModelEvaluationsResponse

AutoMl.ListModelEvaluations に対するレスポンス メッセージ。

フィールド
model_evaluation[]	ModelEvaluation リクエストされたページのモデル評価のリスト。
next_page_token	string 結果の次のページを取得するためのトークン。当該ページを取得するために [ListModelEvaluations.page_token][] に渡されます。

ListModelsRequest

AutoMl.ListModels に対するリクエスト メッセージ。

フィールド
parent	string モデルをリストするプロジェクトのリソース名。 承認には、指定したリソース parent に対する次の Google IAM 権限が必要です。 automl.models.list
filter	string リクエストの結果をフィルタリングする式。 model_metadata - ケースの有無を基準にする場合。 dataset_id - = または != を使用する場合。 フィルタの使用例: image_classification_model_metadata:* --> image_classification_model_metadata が含まれるモデル。 dataset_id=5 --> ID 5 のデータセットから作成されたモデル。
page_size	int32 リクエストされたページサイズ。
page_token	string サーバーが返す結果のページを特定するトークン。通常は ListModelsResponse.next_page_token（以前の AutoMl.ListModels 呼び出し）で取得されます。

ListModelsResponse

AutoMl.ListModels に対するレスポンス メッセージ。

フィールド
model[]	Model リクエストされたページのモデルのリスト。
next_page_token	string 結果の次のページを取得するためのトークン。当該ページを取得するために [ListModels.page_token][] に渡されます。

Model

トレーニングされた機械学習モデルを表す API proto。

フィールド
name	string 出力のみ。モデルのリソース名。次の形式になります。projects/{project_id}/locations/{location_id}/models/{model_id}
display_name	string 必須。インターフェースに表示するモデル名。名前は最長 32 文字で、ASCII ラテン文字の A～Z と a～z、アンダースコア（_）、ASCII 数字 0～9 のみを使用できます。先頭は文字にする必要があります。
dataset_id	string 必須。モデルの作成に使用されるデータセットのリソース ID。データセットは、同じ祖先プロジェクトとロケーションから取得する必要があります。
create_time	Timestamp 出力のみ。このモデルが作成されたときのタイムスタンプ。
update_time	Timestamp 出力のみ。このモデルが最後に更新されたときのタイムスタンプ。
deployment_state	DeploymentState 出力のみ。モデルのデプロイ状態。モデルは、デプロイ後にのみ予測リクエストを処理できます。
共用体フィールド model_metadata。必須。問題のタイプに固有のモデル メタデータです。モデルのトレーニングに使用されたデータセットのメタデータ タイプと一致する必要があります。model_metadata は、次のいずれかになります。
translation_model_metadata	TranslationModelMetadata 翻訳モデルのメタデータ。
image_classification_model_metadata	ImageClassificationModelMetadata 画像分類モデルのメタデータ。
text_classification_model_metadata	TextClassificationModelMetadata テキスト分類モデルのメタデータ。
video_classification_model_metadata	VideoClassificationModelMetadata 動画分類モデルのメタデータ。

DeploymentState

モデルのデプロイ状態。

列挙値
DEPLOYMENT_STATE_UNSPECIFIED	使用しないでください。未指定の列挙値にはこの値がデフォルトで設定されます。
DEPLOYED	モデルはデプロイされています。
UNDEPLOYED	モデルはデプロイされていません。

ModelEvaluation

モデルの評価結果。

フィールド
name	string 出力のみ。モデル評価のリソース名。次の形式になります。 projects/{project_id}/locations/{location_id}/models/{model_id}/modelEvaluations/{model_evaluation_id}
annotation_spec_id	string 出力のみ。モデル評価が適用されるアノテーション仕様の ID。この ID は、モデル評価全体で空白です。注: 現在、アノテーション仕様の ID からこの仕様の display_name を取得する方法はありません。display_name を調べるには、UI でモデル評価を確認します。
display_name	string 出力のみ。モデルがトレーニングされたときの AnnotationSpec.display_name の値。このフィールドはモデルのトレーニング時に値を返すため、異なるモデルが同じデータセットを使用してトレーニングされていても、任意の 2 つのモデルのトレーニングの間にモデルオーナーが display_name を更新した場合などは、モデルごとに戻り値が異なる可能性があります。この display_name は、モデル評価全体で空白です。
create_time	Timestamp 出力のみ。このモデル評価が作成されたときのタイムスタンプ。
evaluated_example_count	int32 出力のみ。モデル評価に使用されたサンプルの数。
共用体フィールド metrics。出力のみ。評価指標に固有の問題タイプです。metrics は、次のいずれかになります。
classification_evaluation_metrics	ClassificationEvaluationMetrics 画像、テキスト、動画の分類のモデル評価指標。
translation_evaluation_metrics	TranslationEvaluationMetrics 翻訳のモデル評価指標。

OperationMetadata

AutoML API によって返されるすべての長時間実行オペレーションで使用されるメタデータ。

フィールド
progress_percent	int32 出力のみ。オペレーションの進行状況。範囲は [0, 100] です。現在使用されていません。
partial_failures[]	Status 出力のみ。発生した部分的な障害。たとえば、単一のファイルを読み取れなかった場合などです。このフィールドのエントリが 20 個を超えることはできません。ステータス詳細フィールドには、標準の GCP エラーの詳細が格納されます。
create_time	Timestamp 出力のみ。オペレーションが作成された時刻。
update_time	Timestamp 出力のみ。オペレーションが最後に更新された時刻。
Union フィールド details。出力のみ。特定のオペレーションの詳細です。このフィールドは空であっても、存在することで、さまざまなタイプのオペレーションを区別できます。details は、次のいずれかになります。
delete_details	DeleteOperationMetadata Delete オペレーションの詳細。
create_model_details	CreateModelOperationMetadata CreateModel オペレーションの詳細。
import_data_details	ImportDataOperationMetadata ImportData オペレーションの詳細。
batch_predict_details	BatchPredictOperationMetadata BatchPredict オペレーションの詳細。

OutputConfig

出力構成。

フィールド
gcs_destination	GcsDestination 出力の書き込み先とする Google Cloud Storage の場所。

PredictRequest

PredictionService.Predict に対するリクエスト メッセージ。

フィールド
name	string 予測を行うためにリクエストするモデルの名前。 承認には、指定したリソース name に対する次の Google IAM 権限が必要です。 automl.models.predict
payload	ExamplePayload 必須。予測を実施するためのペイロード。ペイロードは、モデルが解決するようにトレーニングされた問題タイプと一致している必要があります。
params	map<string, string> ドメイン固有の追加パラメータ。25,000 文字以下の文字列にする必要があります。 画像分類の場合: score_threshold -（浮動小数点数）0.0～1.0 の値。モデルで画像に対する予測を行うと、ここで指定した信頼スコア以上の結果のみが生成されます。デフォルトは 0.5 です。

PredictResponse

PredictionService.Predict に対するレスポンス メッセージ。

フィールド
payload[]	AnnotationPayload 予測結果。翻訳とテキスト感情は、ただ 1 つのペイロードを返します。
metadata	map<string, string> 追加のドメイン固有の予測レスポンス メタデータ。

TextClassificationDatasetMetadata

分類のデータセット メタデータ。

フィールド
classification_type	ClassificationType 必須。分類問題のタイプ。

TextClassificationModelMetadata

テキスト分類に固有のモデル メタデータ。

TextSnippet

テキスト スニペットの表現。

フィールド
content	string 必須。文字列形式によるテキスト スニペットのコンテンツ。最長 250,000 文字です。
mime_type	string ソーステキストの形式。現在のところ、指定できる値は「text/html」と「text/plain」の 2 つだけです。空白のままにすると、アップロードされたコンテンツの型から自動的に形式が判断されます。
content_uri	string 出力のみ。コンテンツをダウンロードできる HTTP URI。

TimeSegment

時間ディメンションを持つサンプル（たとえば、動画）内にある期間。

フィールド
start_time_offset	Duration 時間セグメントの開始点（その時間を含む）。サンプルを開始してから経過した時間で表されます。
end_time_offset	Duration 時間セグメントの終点（その時間を含まない）。サンプルを開始してから経過した時間で表されます。

TranslationAnnotation

翻訳に固有のアノテーション詳細。

フィールド
translated_content	TextSnippet 出力のみ。翻訳されたコンテンツ。

TranslationDatasetMetadata

翻訳に固有のデータセット メタデータ。

フィールド
source_language_code	string 必須。ソース言語の BCP-47 言語コード。
target_language_code	string 必須。ターゲット言語の BCP-47 言語コード。

TranslationEvaluationMetrics

データセットの評価指標。

フィールド
bleu_score	double 出力のみ。BLEU スコア。
base_bleu_score	double 出力のみ。ベースモデルの BLEU スコア。

TranslationModelMetadata

翻訳に固有のモデル メタデータ。

フィールド
base_model	string カスタムモデルのトレーニングのベースラインとして使用するモデルのリソース名。設定しない場合、Google 翻訳で提供されるデフォルトのベースモデルが使用されます。次の形式になります。projects/{project_id}/locations/{location_id}/models/{model_id}
source_language_code	string 出力のみ。データセットから推定されます。トレーニングに使用されるソース言語（BCP-47 言語コード）。
target_language_code	string 出力のみ。トレーニングに使用されるターゲット言語（BCP-47 言語コード）。

UndeployModelRequest

AutoMl.UndeployModel に対するリクエスト メッセージ。

フィールド
name	string デプロイ解除するモデルのリソース名。 承認には、指定したリソース name に対する次の Google IAM 権限が必要です。 automl.models.undeploy

VideoClassificationAnnotation

動画分類に固有のアノテーション詳細が格納されます。

フィールド
type	string 出力のみ。動画分類のタイプを表します。有効な値は次のとおりです。* segment - 分類は、ユーザーが指定した動画の時間セグメントに対して行われます。AnnotationSpec は、その時間セグメントのどこかに存在する場合、その中に存在すると応答されます。動画 ML モデル評価は、このタイプの分類に対してのみ行われます。* shot - ショットレベルの分類。AutoML Video Intelligence は、ユーザーがリクエストの構成で指定した動画のセグメント全体で各カメラショットの境界を特定します。AutoML Video Intelligence は、検出されたショットごとのラベルとその信頼スコアとともに、ショットの開始時間と終了時間を返します。警告: この分類タイプでは、モデル評価は行われません。その品質はトレーニング データによって異なりますが、その品質を説明するための指標はありません。1s_interval - AutoML Video Intelligence は、ユーザーがリクエストの構成で指定した動画のセグメント全体のラベルとその信頼スコアを 1 秒ごとに返します。警告: この分類タイプでは、モデル評価は行われません。その品質はトレーニング データによって異なりますが、その品質を説明するための指標はありません。
classification_annotation	ClassificationAnnotation 出力のみ。このアノテーションの分類詳細。
time_segment	TimeSegment 出力のみ。アノテーションが適用される動画の時間セグメント。

VideoClassificationDatasetMetadata

動画分類に固有のデータセット メタデータ。

VideoClassificationModelMetadata

動画分類に固有のモデル メタデータ。