索引
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 | |
---|---|
データセットを作成します。
|
CreateModel | |
---|---|
モデルを作成します。完了すると、
|
DeleteDataset | |
---|---|
データセットとそのすべてのコンテンツを削除します。完了すると、
|
DeleteModel | |
---|---|
モデルを削除します。完了すると、
|
DeployModel | |
---|---|
モデルをデプロイします。完了すると、
|
ExportData | |
---|---|
データセットのデータを Google Cloud Storage バケットにエクスポートします。完了すると、
|
GetAnnotationSpec | |
---|---|
アノテーション仕様を取得します。
|
GetDataset | |
---|---|
データセットを取得します。
|
GetModel | |
---|---|
モデルを取得します。
|
GetModelEvaluation | |
---|---|
モデル評価を取得します。
|
ImportData | |
---|---|
データセットにデータをインポートします。
|
ListDatasets | |
---|---|
プロジェクト内のデータセットをリストします。
|
ListModelEvaluations | |
---|---|
モデル評価をリストします。
|
ListModels | |
---|---|
モデルをリストします。
|
UndeployModel | |
---|---|
モデルをデプロイ解除します。完了すると、
|
PredictionService
AutoML Prediction API。
BatchPredict | |
---|---|
バッチ予測を実行します。オンライン
|
Predict | |
---|---|
オンライン予測を実施します。予測結果は、レスポンスで直接返されます。 次の ML 問題およびその想定されるリクエスト ペイロードで使用できます。
|
AnnotationPayload
AutoML に関連するアノテーション情報を格納します。
フィールド | ||
---|---|---|
annotation_spec_id |
出力のみ。このアノテーションが関係するアノテーション仕様のリソース ID。アノテーション仕様は、祖先のデータセット、または使用中のモデルのトレーニングに使用されたデータセットのいずれかから取得されます。 |
|
display_name |
出力のみ。モデルがトレーニングされたときの |
|
共用体フィールド detail 。出力のみ。AutoML ソリューションに固有のアノテーションに関する追加情報です。detail は、次のいずれかになります。 |
||
translation |
翻訳のアノテーション詳細。 |
|
classification |
コンテンツ分類または画像分類のアノテーション詳細。 |
|
video_classification |
動画分類のアノテーション詳細。動画分類予測に対して返されます。 |
AnnotationSpec
アノテーションの定義。
フィールド | |
---|---|
name |
出力のみ。アノテーション仕様のリソース名。形式は次のとおりです。 'projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/annotationSpecs/{annotation_spec_id}' |
display_name |
必須。インターフェースに表示するアノテーション仕様の名前。名前は最長 32 文字で、ASCII ラテン文字の A~Z と a~z、アンダースコア(_)、ASCII 数字 0~9 のみを使用できます。 |
example_count |
出力のみ。アノテーションによって明確にラベル付けされた親データセットに含まれるサンプルの数。 |
BatchPredictOperationMetadata
BatchPredict オペレーションの詳細。
フィールド | |
---|---|
input_config |
出力のみ。このバッチ予測オペレーションの開始時に与えられた入力構成。 |
output_info |
出力のみ。このバッチ予測の出力についてさらに説明した情報。 |
BatchPredictionOutputInfo
このバッチ予測の出力についてさらに説明します。後述の
BatchPredictionOutputConfig
に関する補足情報。
フィールド | |
---|---|
gcs_output_directory |
作成された Google Cloud Storage ディレクトリのフルパス。ここに、予測出力が書き込まれています。 |
BatchPredictRequest
PredictionService.BatchPredict
に対するリクエスト メッセージ。
フィールド | |
---|---|
name |
バッチ予測を行うためにリクエストするモデルの名前。 承認には、指定したリソース
|
input_config |
必須。バッチ予測の入力構成。 |
output_config |
必須。出力予測の書き込み先を指定する構成。 |
params |
予測に対するドメイン固有の追加パラメータ。25,000 文字以下の文字列にする必要があります。 詳細については、動画へのアノテーション付けをご覧ください。 次のパラメータを指定できます。
|
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 |
入力コンテンツの 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 |
出力の書き込み先とする Google Cloud Storage 上のディレクトリの場所。 |
ClassificationAnnotation
分類に固有のアノテーション詳細が格納されます。
フィールド | |
---|---|
score |
出力のみ。0.0~1.0 の推定信頼度。値が大きいほど、アノテーションが肯定的であるという信頼度が高くなります。ユーザーがアノテーションを否定的または肯定的として承認した場合、スコア値は変更されません。ユーザーがアノテーションを作成すると、否定的な場合はスコア 0 に、肯定的な場合はスコア 1 になります。 |
ClassificationEvaluationMetrics
分類問題のモデル評価指標。注: 動画分類の場合、この指標は「segment_classification」タイプの動画分類予測の品質のみを表します。
フィールド | |
---|---|
au_prc |
出力のみ。適合率 / 再現率曲線指標を下回る領域。 |
base_au_prc |
出力のみ。以前のデータに基づく適合率 / 再現率曲線指標を下回る領域。 |
confidence_metrics_entry[] |
出力のみ。0.05、0.10、... から、0.95、0.96、0.97、0.98、0.99 まで続く各 confidence_threshold の指標。ここから適合率 / 再現率曲線が導出されます。 |
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 |
テキスト分類に使用されるデータセットのメタデータ。 |
|
video_classification_dataset_metadata |
動画分類に使用されるデータセットのメタデータ。 |
DeleteDatasetRequest
AutoMl.DeleteDataset
に対するリクエスト メッセージ。
フィールド | |
---|---|
name |
削除するデータセットのリソース名。 承認には、指定したリソース
|
DeleteModelRequest
AutoMl.DeleteModel
に対するリクエスト メッセージ。
フィールド | |
---|---|
name |
削除するモデルのリソース名。 承認には、指定したリソース
|
DeleteOperationMetadata
エンティティの削除を実行するオペレーションの詳細。
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 など) |
GetAnnotationSpecRequest
AutoMl.GetAnnotationSpec
に対するリクエスト メッセージ。
フィールド | |
---|---|
name |
取得するアノテーション仕様のリソース名。 承認には、指定したリソース
|
GetDatasetRequest
AutoMl.GetDataset
に対するリクエスト メッセージ。
フィールド | |
---|---|
name |
取得するデータセットのリソース名。 承認には、指定したリソース
|
GetModelEvaluationRequest
AutoMl.GetModelEvaluation
に対するリクエスト メッセージ。
フィールド | |
---|---|
name |
モデル評価のリソース名。 承認には、指定したリソース
|
GetModelRequest
AutoMl.GetModel
に対するリクエスト メッセージ。
フィールド | |
---|---|
name |
モデルのリソース名。 承認には、指定したリソース
|
Image
画像の表現。最大 30 MB の画像のみがサポートされています。
フィールド | ||
---|---|---|
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 |
出力のみ。このモデルの作成オペレーションが停止した理由( |
ImportDataOperationMetadata
ImportData オペレーションの詳細。
ImportDataRequest
AutoMl.ImportData
に対するリクエスト メッセージ。
フィールド | |
---|---|
name |
必須。データセット名。データセットはすでに存在している必要があります。インポートされたアノテーションとサンプルがすべて追加されます。 承認には、指定したリソース
|
input_config |
必須。目的の入力の場所とそのドメイン固有のセマンティクス(ある場合)。 |
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 |
インポートされるデータのセマンティクスを記述するドメイン固有の追加パラメータ。文字列は 25,000 文字以下である必要があります。
|
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 は、次のいずれかになります。 |
||
translation_model_metadata |
翻訳モデルのメタデータ。 |
|
image_classification_model_metadata |
画像分類モデルのメタデータ。 |
|
text_classification_model_metadata |
テキスト分類モデルのメタデータ。 |
|
video_classification_model_metadata |
動画分類モデルのメタデータ。 |
DeploymentState
モデルのデプロイ状態。
列挙値 | |
---|---|
DEPLOYMENT_STATE_UNSPECIFIED |
使用しないでください。未指定の列挙値にはこの値がデフォルトで設定されます。 |
DEPLOYED |
モデルはデプロイされています。 |
UNDEPLOYED |
モデルはデプロイされていません。 |
ModelEvaluation
モデルの評価結果。
フィールド | ||
---|---|---|
name |
出力のみ。モデル評価のリソース名。次の形式になります。
|
|
annotation_spec_id |
出力のみ。モデル評価が適用されるアノテーション仕様の ID。この ID は、モデル評価全体で空白です。注: 現在、アノテーション仕様の ID からこの仕様の display_name を取得する方法はありません。display_name を調べるには、UI でモデル評価を確認します。 |
|
display_name |
出力のみ。モデルがトレーニングされたときの |
|
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 |
出力のみ。オペレーションが最後に更新された時刻。 |
|
Union フィールド details 。出力のみ。特定のオペレーションの詳細です。このフィールドは空であっても、存在することで、さまざまなタイプのオペレーションを区別できます。details は、次のいずれかになります。 |
||
delete_details |
Delete オペレーションの詳細。 |
|
create_model_details |
CreateModel オペレーションの詳細。 |
|
import_data_details |
ImportData オペレーションの詳細。 |
|
batch_predict_details |
BatchPredict オペレーションの詳細。 |
OutputConfig
出力構成。
フィールド | |
---|---|
gcs_destination |
出力の書き込み先とする Google Cloud Storage の場所。 |
PredictRequest
PredictionService.Predict
に対するリクエスト メッセージ。
フィールド | |
---|---|
name |
予測を行うためにリクエストするモデルの名前。 承認には、指定したリソース
|
payload |
必須。予測を実施するためのペイロード。ペイロードは、モデルが解決するようにトレーニングされた問題タイプと一致している必要があります。 |
params |
ドメイン固有の追加パラメータ。25,000 文字以下の文字列にする必要があります。
|
PredictResponse
PredictionService.Predict
に対するレスポンス メッセージ。
フィールド | |
---|---|
payload[] |
予測結果。翻訳とテキスト感情は、ただ 1 つのペイロードを返します。 |
metadata |
追加のドメイン固有の予測レスポンス メタデータ。 |
TextClassificationDatasetMetadata
分類のデータセット メタデータ。
フィールド | |
---|---|
classification_type |
必須。分類問題のタイプ。 |
TextClassificationModelMetadata
テキスト分類に固有のモデル メタデータ。
TextSnippet
テキスト スニペットの表現。
フィールド | |
---|---|
content |
必須。文字列形式によるテキスト スニペットのコンテンツ。最長 250,000 文字です。 |
mime_type |
ソーステキストの形式。現在のところ、指定できる値は「text/html」と「text/plain」の 2 つだけです。空白のままにすると、アップロードされたコンテンツの型から自動的に形式が判断されます。 |
content_uri |
出力のみ。コンテンツをダウンロードできる HTTP URI。 |
TimeSegment
時間ディメンションを持つサンプル(たとえば、動画)内にある期間。
フィールド | |
---|---|
start_time_offset |
時間セグメントの開始点(その時間を含む)。サンプルを開始してから経過した時間で表されます。 |
end_time_offset |
時間セグメントの終点(その時間を含まない)。サンプルを開始してから経過した時間で表されます。 |
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 |
デプロイ解除するモデルのリソース名。 承認には、指定したリソース
|
VideoClassificationAnnotation
動画分類に固有のアノテーション詳細が格納されます。
フィールド | |
---|---|
type |
出力のみ。動画分類のタイプを表します。有効な値は次のとおりです。* |
classification_annotation |
出力のみ。このアノテーションの分類詳細。 |
time_segment |
出力のみ。アノテーションが適用される動画の時間セグメント。 |
VideoClassificationDatasetMetadata
動画分類に固有のデータセット メタデータ。
VideoClassificationModelMetadata
動画分類に固有のモデル メタデータ。