メソッド: projects.locations.models.predict

予測を実施します。

HTTP リクエスト

POST https://automl.googleapis.com/v1beta1/{name}:predict

パスパラメータ

パラメータ
name

string

予測を行うためにリクエストするモデルの名前。

承認には、指定したリソース name に対する次の Google IAM 権限が必要です。

  • automl.models.predict

リクエストの本文

リクエストの本文には、次の構造を使用したデータが含まれます。

JSON 表現 

{
  "payload": {
    object(ExamplePayload)
  },
  "params": {
    string: string,
    ...
  }
}
フィールド
payload

object(ExamplePayload)

必須。予測を実施するペイロード。ペイロードは、解決のためにモデルがトレーニングされた問題のタイプと一致している必要があります。

params

map (key: string, value: string)

ドメイン固有の追加パラメータ。25,000 文字以下の文字列にする必要があります。

  • 画像分類の場合:

score_threshold - （不動小数点数）0.0～1.0 の値。モデルで画像に対する予測を行うと、ここで指定した信頼スコアしきい値以上の結果のみが生成されます。デフォルトは 0.5 です。

"key": value ペアのリストが含まれるオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" }。

レスポンスの本文

成功すると、レスポンスの本文に次の構造のデータが組み込まれます。

PredictionService.Predict のレスポンス メッセージ。

現在、これは画像認識予測結果を返すためにのみ使用されます。将来的に、さらに多くの予測出力メタデータが導入される可能性があります。

JSON 表現 

{
  "payload": [
    {
      object(AnnotationPayload)
    }
  ],
  "metadata": {
    string: string,
    ...
  }
}
フィールド
payload[]

object(AnnotationPayload)

予測結果。

metadata

map (key: string, value: string)

追加のドメイン固有の予測レスポンス メタデータ。

"key": value ペアのリストが含まれるオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" }。

承認スコープ

次の OAuth スコープが必要です。

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

詳細については、認証の概要をご覧ください。

ExamplePayload

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

JSON 表現 

{

  // Union field payload can be only one of the following:
  "image": {
    object(Image)
  },
  "textSnippet": {
    object(TextSnippet)
  }
  // End of list of possible types for union field payload.
}
フィールド
共用体フィールド payload。必須。入力のみ。サンプルデータ。payload には次のいずれかのみを使用できます。
image

object(Image)

サンプル画像

textSnippet

object(TextSnippet)

サンプル テキスト。

Image

画像の表現。

JSON 表現 

{
  "thumbnailUri": string,

  // Union field data can be only one of the following:
  "imageBytes": string,
  "inputConfig": {
    object(InputConfig)
  }
  // End of list of possible types for union field data.
}
フィールド
thumbnailUri

string

出力のみ。サムネイル画像への HTTP URI。

共用体フィールド data。入力のみ。画像を表すデータ。現在、Prediction API では他のオプションがサポートされていないため、Predict 呼び出しでは [image_bytes][] を設定する必要があります。アップロードされた画像のコンテンツは、[content_uri][] フィールドを使用して読み取ることができます。data は次のいずれかになります。
imageBytes

string (bytes format)

バイト ストリームとして表される画像コンテンツ。注: すべての bytes フィールドと同様に、protobuffer では純 2 進表現が使用され、JSON 表現では base64 が使用されます。

Base64 でエンコードされた文字列。
inputConfig

object(InputConfig)

画像のコンテンツを指定する入力構成。

TextSnippet

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

JSON 表現 

{
  "content": string,
  "mimeType": string,
  "contentUri": string
}
フィールド
content

string

必須。文字列形式によるテキスト スニペットのコンテンツ。最長 250,000 文字です。

mimeType

string

ソーステキストの形式。たとえば、「text/html」や「text/plain」などです。空白のままにすると、アップロードされたコンテンツの型から自動的に形式が判断されます。デフォルトは「text/html」です。最長 25,000 文字です。

contentUri

string

出力のみ。コンテンツをダウンロードできる HTTP URI。

AnnotationPayload

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

JSON 表現 

{
  "annotationSpecId": string,
  "displayName": string,

  // Union field detail can be only one of the following:
  "translation": {
    object(TranslationAnnotation)
  },
  "classification": {
    object(ClassificationAnnotation)
  }
  // End of list of possible types for union field detail.
}
フィールド
annotationSpecId

string

出力のみ。このアノテーションが関係するアノテーション仕様のリソース ID。アノテーション仕様は、祖先のデータセット、または使用中のモデルのトレーニングに使用されたデータセットのいずれかから取得されます。

displayName

string

出力のみ。モデルがトレーニングされたときの AnnotationSpec.display_name の値。このフィールドはモデルのトレーニング時に値を返すため、異なるモデルが同じデータセットを使用してトレーニングされていても、任意の 2 つのモデルのトレーニングの間にモデルオーナーが displayName を更新した場合などは、モデルごとに戻り値が異なる可能性があります。

共用体フィールド detail。出力のみ。AutoML ソリューションに固有のアノテーションに関する追加情報。detail は、次のいずれかになります。
translation

object(TranslationAnnotation)

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

classification

object(ClassificationAnnotation)

コンテンツ分類または画像分類のアノテーション詳細。

TranslationAnnotation

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

JSON 表現 

{
  "translatedContent": {
    object(TextSnippet)
  }
}
フィールド
translatedContent

object(TextSnippet)

出力のみ。翻訳されたコンテンツ。

ClassificationAnnotation

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

JSON 表現 

{
  "score": number
}
フィールド
score

number

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