Package google.cloud.vision.v1p4beta1

索引

ImageAnnotator

クライアント画像に対して Google Cloud Vision API の顔検出、ランドマーク検出、ロゴ検出、ラベル検出、テキスト検出などの検出タスクを実行するサービス。ImageAnnotator サービスは、画像から検出されたエンティティを返します。

AsyncBatchAnnotateFiles

rpc AsyncBatchAnnotateFiles(AsyncBatchAnnotateFilesRequest) returns (Operation)

PDF ファイルなど、汎用ファイルのリストに対して非同期で画像検出とアノテーションを実行します。このファイルには複数のページが含まれている場合があります。また、各ページに複数の画像が存在することもあります。進行状況と結果は、google.longrunning.Operations インターフェースを介して取得できます。Operation.metadata には、OperationMetadata（メタデータ）が含まれます。Operation.response には、AsyncBatchAnnotateFilesResponse（結果）が含まれます。

認証スコープ

次の OAuth スコープのいずれかが必要です。

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

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

rpc AsyncBatchAnnotateImages(AsyncBatchAnnotateImagesRequest) returns (Operation)

画像のリストに対して非同期で画像検出とアノテーションを実行します。

進行状況と結果は、google.longrunning.Operations インターフェースを介して取得できます。Operation.metadata には、OperationMetadata（メタデータ）が含まれます。Operation.response には、AsyncBatchAnnotateImagesResponse（結果）が含まれます。

このサービスは、お客様の Google Cloud Storage バケット内の JSON ファイルに画像アノテーション出力を書き込みます。各 JSON ファイルには BatchAnnotateImagesResponse proto が含まれます。

認証スコープ

次の OAuth スコープのいずれかが必要です。

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

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

rpc BatchAnnotateFiles(BatchAnnotateFilesRequest) returns (BatchAnnotateFilesResponse)

複数のファイルに対して一括で画像検出とアノテーションを実行するサービス。現在、application/pdf、image/tiff、image/gif のみがサポートされています。

このサービスは、指定されたファイルから最大で 5 個のフレーム（gif）またはページ（PDF または tiff）を抽出して、抽出した各画像の検出とアノテーションを実行します（抽出対象は AnnotateFileRequest.pages で指定できます）。

認証スコープ

次の OAuth スコープのいずれかが必要です。

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

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

rpc BatchAnnotateImages(BatchAnnotateImagesRequest) returns (BatchAnnotateImagesResponse)

画像のバッチに対して画像の検出とアノテーションを実行します。

認証スコープ

次の OAuth スコープのいずれかが必要です。

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

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

ProductSearch

Product Search で使用する参照画像の Products と ProductSet を管理します。次のリソースモデルを使用します。

  • API には、projects/*/locations/*/productSets/* という名前の ProductSet リソースのコレクションがあります。これは、さまざまな商品をグループにまとめて ID を制限するための方法として機能します。

並行して

  • API には、projects/*/locations/*/products/* という名前の Product リソースのコレクションがあります。

  • 各 Product には、projects/*/locations/*/products/*/referenceImages/* という名前の ReferenceImage リソースのコレクションがあります。

AddProductToProductSet

rpc AddProductToProductSet(AddProductToProductSetRequest) returns (Empty)

指定した ProductSet に Product を追加します。Product がすでに存在する場合、変更は行われません。

1 つの Product を最大 100 個の ProductSets に追加できます。

発生する可能性があるエラー:

  • Product または ProductSet が存在していない場合は NOT_FOUND を返します。
認証スコープ

次の OAuth スコープのいずれかが必要です。

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

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

rpc CreateProduct(CreateProductRequest) returns (Product)

新しい商品リソースを作成して返します。

発生する可能性があるエラー:

  • display_name が不明な場合、または 4,096 文字を超える場合、INVALID_ARGUMENT を返します。
  • description が 4,096 文字を超える場合、INVALID_ARGUMENT を返します。
  • product_category が不明であるか、無効な場合、INVALID_ARGUMENT を返します。
認証スコープ

次の OAuth スコープのいずれかが必要です。

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

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

rpc CreateProductSet(CreateProductSetRequest) returns (ProductSet)

新しい ProductSet リソースを作成して返します。

発生する可能性があるエラー:

  • display_name が不明な場合、または 4,096 文字を超える場合、INVALID_ARGUMENT を返します。
認証スコープ

次の OAuth スコープのいずれかが必要です。

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

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

rpc CreateReferenceImage(CreateReferenceImageRequest) returns (ReferenceImage)

新しい ReferenceImage リソースを作成して返します。

bounding_poly フィールドは省略可能です。bounding_poly が指定されていない場合、画像内で親商品の product_category と互換性のある関心領域の検出を試みます。指定されている場合、検出は常にスキップされます。ポリゴンが、回転しない長方形に変換されます。

画像の解像度が高すぎて処理できない場合（50 メガピクセルを超える場合）、パイプラインによって画像のサイズが変更されます。

発生する可能性があるエラー:

  • image_uri が不明であるか、4,096 文字を超える場合、INVALID_ARGUMENT を返します。
  • 商品が存在しない場合は INVALID_ARGUMENT を返します。
  • bound_poly_ が指定されておらず、親商品の product_category との互換性が検出されない場合、INVALID_ARGUMENT を返します。
  • bound_poly に 10 個を超えるポリゴンが含まれている場合、INVALID_ARGUMENT を返します。
認証スコープ

次の OAuth スコープのいずれかが必要です。

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

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

rpc DeleteProduct(DeleteProductRequest) returns (Empty)

商品とその参照画像を完全に削除します。

商品のメタデータとそのすべての画像がすぐに削除されますが、その商品が含まれる ProductSet に対する検索クエリは、関連するすべてのキャッシュが更新されるまでは機能します。

認証スコープ

次の OAuth スコープのいずれかが必要です。

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

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

rpc DeleteProductSet(DeleteProductSetRequest) returns (Empty)

ProductSet を完全に削除します。ProductSet 内の Products と ReferenceImages は削除されません。

実際の画像ファイルは Google Cloud Storage から削除されません。

認証スコープ

次の OAuth スコープのいずれかが必要です。

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

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

rpc DeleteReferenceImage(DeleteReferenceImageRequest) returns (Empty)

参照画像を完全に削除します。

画像メタデータはすぐに削除されますが、関連するすべてのキャッシュが更新されるまで、画像が含まれている ProductSets に対する検索クエリは引き続き機能します。

実際の画像ファイルは Google Cloud Storage から削除されません。

認証スコープ

次の OAuth スコープのいずれかが必要です。

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

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

rpc GetProduct(GetProductRequest) returns (Product)

Product に関連付けられた情報を取得します。

発生する可能性があるエラー:

  • Product が存在しない場合は NOT_FOUND を返します。
認証スコープ

次の OAuth スコープのいずれかが必要です。

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

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

rpc GetProductSet(GetProductSetRequest) returns (ProductSet)

ProductSet に関連付けられている情報を取得します。

発生する可能性があるエラー:

  • ProductSet が存在しない場合は NOT_FOUND を返します。
認証スコープ

次の OAuth スコープのいずれかが必要です。

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

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

rpc GetReferenceImage(GetReferenceImageRequest) returns (ReferenceImage)

ReferenceImage に関連付けられた情報を取得します。

発生する可能性があるエラー:

  • 指定された画像が存在しない場合、NOT_FOUND を返します。
認証スコープ

次の OAuth スコープのいずれかが必要です。

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

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

rpc ImportProductSets(ImportProductSetsRequest) returns (Operation)

画像情報のリストに基づいて、指定した商品セットに参照画像をインポートする非同期 API。

google.longrunning.Operation API を使用すると、リクエストの進行状況と結果を追跡できます。Operation.metadata には BatchOperationMetadata が含まれます。（進行状況）Operation.response には ImportProductSetsResponse が含まれます。（結果）

このメソッドの入力ソースは Google Cloud Storage 上の csv ファイルです。CSV ファイルの形式については、ImportProductSetsGcsSource.csv_file_uri をご覧ください。

認証スコープ

次の OAuth スコープのいずれかが必要です。

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

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

rpc ListProductSets(ListProductSetsRequest) returns (ListProductSetsResponse)

不特定の順序で ProductSets を一覧表示します。

発生する可能性があるエラー:

  • page_size が 100 より大きいか 1 未満の場合は、INVALID_ARGUMENT を返します。
認証スコープ

次の OAuth スコープのいずれかが必要です。

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

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

rpc ListProducts(ListProductsRequest) returns (ListProductsResponse)

不特定の順序で商品を一覧表示します。

発生する可能性があるエラー:

  • page_size が 100 より大きいか 1 未満の場合は、INVALID_ARGUMENT を返します。
認証スコープ

次の OAuth スコープのいずれかが必要です。

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

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

rpc ListProductsInProductSet(ListProductsInProductSetRequest) returns (ListProductsInProductSetResponse)

ProductSet 内の Products を不特定の順序で一覧表示します。ProductSet が存在しない場合、レスポンスの products フィールドは空になります。

発生する可能性があるエラー:

  • page_size が 100 より大きいか 1 未満の場合は、INVALID_ARGUMENT を返します。
認証スコープ

次の OAuth スコープのいずれかが必要です。

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

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

rpc ListReferenceImages(ListReferenceImagesRequest) returns (ListReferenceImagesResponse)

参照画像を一覧表示します。

発生する可能性があるエラー:

  • 親商品が存在しない場合、NOT_FOUND を返します。
  • page_size が 100 より大きいか 1 未満の場合は、INVALID_ARGUMENT を返します。
認証スコープ

次の OAuth スコープのいずれかが必要です。

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

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

rpc RemoveProductFromProductSet(RemoveProductFromProductSetRequest) returns (Empty)

指定した ProductSet から Product を削除します。

認証スコープ

次の OAuth スコープのいずれかが必要です。

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

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

rpc UpdateProduct(UpdateProductRequest) returns (Product)

Product リソースを変更します。現時点で更新できるのは、display_name、description、labels フィールドのみです。

ラベルが更新されると、次のインデックス時間まで変更がクエリに反映されません。

発生する可能性があるエラー:

  • Product が存在しない場合は NOT_FOUND を返します。
  • display_name が update_mask に存在するものの、リクエストにないか 4,096 文字を超えている場合、INVALID_ARGUMENT を返します。
  • description が update_mask に存在するものの、4,096 文字を超えている場合、INVALID_ARGUMENT を返します。
  • product_category が update_mask に存在している場合、INVALID_ARGUMENT を返します。
認証スコープ

次の OAuth スコープのいずれかが必要です。

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

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

rpc UpdateProductSet(UpdateProductSetRequest) returns (ProductSet)

ProductSet リソースを変更します。現在更新できるのは display_name のみです。

発生する可能性があるエラー:

  • ProductSet が存在しない場合は NOT_FOUND を返します。
  • display_name が update_mask に存在するものの、リクエストにないか 4,096 文字を超えている場合、INVALID_ARGUMENT を返します。
認証スコープ

次の OAuth スコープのいずれかが必要です。

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

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

AddProductToProductSetRequest

AddProductToProductSet メソッドに対するリクエスト メッセージ。

フィールド
name

string

変更する ProductSet のリソース名。

形式: projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID
product

string

この ProductSet に追加する Product のリソース名。

形式: projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID

AnnotateFileRequest

1 つのファイル（PDF、TIFF、GIF など）にアノテーションを付けるリクエスト。

フィールド
input_config

InputConfig

必須。入力ファイルに関する情報。
features[]

Feature

必須。リクエストする機能。
image_context

ImageContext

ファイル内の画像に付随する可能性のある追加のコンテキスト。
pages[]

int32

画像アノテーションを実行するファイルのページ数。

ページは 1 から始まり、ファイルの先頭ページが 1 ページであるとみなされます。1 回のリクエストにつき最大 5 ページがサポートされています。ページには負の値を設定できます。

ページ 1 は最初のページを意味します。ページ 2 は 2 ページ目を意味します。ページ -1 は最後のページを意味します。ページ -2 は最後から 2 番目のページを意味します。

ファイルが PDF や TIFF ではなく GIF の場合、ページは GIF フレームになります。

このフィールドが空の場合、デフォルトでは、ファイルの最初の 5 ページに対して画像アノテーションが実行されます。

AnnotateFileResponse

単一ファイルのアノテーション リクエストへのレスポンス。1 つのファイルには 1 つ以上の画像が含まれる場合があります。各画像にそれぞれ固有のレスポンスが存在します。

フィールド
input_config

InputConfig

このレスポンスが生成されるファイルに関する情報。
responses[]

AnnotateImageResponse

ファイルに含まれる画像に対する個々のレスポンス。
total_pages

int32

このフィールドには、ファイル内の総ページ数が表示されます。

AnnotateImageRequest

ユーザーがリクエストした機能とコンテキスト情報を使用して、ユーザーが指定した画像に対して Google Cloud Vision API タスクを実行するようにリクエストします。

フィールド
image

Image

処理される画像。
features[]

Feature

リクエストする機能。
image_context

ImageContext

画像に関連する追加のコンテキスト。

AnnotateImageResponse

画像アノテーション リクエストに対するレスポンス。

フィールド
face_annotations[]

FaceAnnotation

存在する場合、顔検出が正常に完了しています。
landmark_annotations[]

EntityAnnotation

存在する場合、ランドマーク検出が正常に完了しています。
logo_annotations[]

EntityAnnotation

存在する場合、ロゴ検出が正常に完了しています。
label_annotations[]

EntityAnnotation

存在する場合、ラベル検出が正常に完了しています。
localized_object_annotations[]

LocalizedObjectAnnotation

存在する場合、ローカライズされたオブジェクト検出が正常に完了しています。信頼スコアの降順で並べ替えられます。
text_annotations[]

EntityAnnotation

存在する場合、テキスト（OCR）検出が正常に完了しています。
full_text_annotation

TextAnnotation

存在する場合、テキスト（OCR）検出またはドキュメント（OCR）テキスト検出が正常に完了しています。このアノテーションは、OCR で検出されたテキストの構造的階層を提供します。
safe_search_annotation

SafeSearchAnnotation

存在する場合、セーフサーチ アノテーションが正常に完了しています。
image_properties_annotation

ImageProperties

存在する場合、画像のプロパティが正常に抽出されています。
crop_hints_annotation

CropHintsAnnotation

存在する場合、クロップヒントが正常に完了しています。
web_detection

WebDetection

存在する場合、ウェブ検出が正常に完了しています。
product_search_results

ProductSearchResults

存在する場合、Product Search は正常に完了しています。
error

Status

設定されている場合、オペレーションのエラー メッセージを表します。error が設定されている場合でも、存在する画像アノテーションは正しいことが保証されます。
context

ImageAnnotationContext

存在する場合は、この画像の取得元を特定するためにコンテキスト情報が必要になります。

AsyncAnnotateFileRequest

オフライン ファイルのアノテーション リクエスト。

フィールド
input_config

InputConfig

必須。入力ファイルに関する情報。
features[]

Feature

必須。リクエストする機能。
image_context

ImageContext

ファイル内の画像に付随する可能性のある追加のコンテキスト。
output_config

OutputConfig

必須。目的の出力場所とメタデータ（例: フォーマット）。

AsyncAnnotateFileResponse

単一オフライン ファイルのアノテーション リクエストに対するレスポンス。

フィールド
output_config

OutputConfig

AsyncAnnotateFileRequest からの出力場所とメタデータ。

AsyncBatchAnnotateFilesRequest

複数の非同期ファイルのアノテーション リクエストが 1 回のサービス呼び出しでバッチ処理されます。

フィールド
requests[]

AsyncAnnotateFileRequest

このバッチの個々の非同期ファイルのアノテーション リクエスト。

AsyncBatchAnnotateFilesResponse

非同期のバッチ ファイル アノテーション リクエストに対するレスポンス。

フィールド
responses[]

AsyncAnnotateFileResponse

ファイル アノテーション レスポンスのリスト。AsyncBatchAnnotateFilesRequest の各リクエストに 1 つのレスポンスがあります。

AsyncBatchAnnotateImagesRequest

画像のリストに対する非同期画像アノテーションのリクエスト。

フィールド
requests[]

AnnotateImageRequest

このバッチの個々の画像アノテーション リクエスト。
output_config

OutputConfig

必須。目的の出力場所とメタデータ（例: フォーマット）。

AsyncBatchAnnotateImagesResponse

非同期のバッチ画像アノテーション リクエストに対するレスポンス。

フィールド
output_config

OutputConfig

AsyncBatchAnnotateImagesRequest からの出力場所とメタデータ。

BatchAnnotateFilesRequest

BatchAnnotateFiles API を使用してファイルにアノテーションを設定するリクエストのリスト。

フィールド
requests[]

AnnotateFileRequest

ファイル アノテーション リクエストのリスト。現在、BatchAnnotateFilesRequest では AnnotateFileRequest が 1 つだけサポートされています。

BatchAnnotateFilesResponse

ファイル アノテーション レスポンスのリスト。

フィールド
responses[]

AnnotateFileResponse

ファイル アノテーション レスポンスのリスト。各レスポンスは、BatchAnnotateFilesRequest 内の各 AnnotateFileRequest に対応しています。

BatchAnnotateImagesRequest

複数の画像アノテーション リクエストが 1 回のサービス呼び出しでバッチ処理されます。

フィールド
requests[]

AnnotateImageRequest

このバッチの個々の画像アノテーション リクエスト。

BatchAnnotateImagesResponse

バッチ画像アノテーション リクエストに対するレスポンス。

フィールド
responses[]

AnnotateImageResponse

バッチ内の画像アノテーション リクエストに対する個々のレスポンス。

BatchOperationMetadata

バッチ オペレーションのメタデータ（現在の状態など）。

google::longrunning::Operations サービスの GetOperation 呼び出しによって返される Operation の metadata フィールドに含まれます。

フィールド
state
(deprecated)

State

バッチ オペレーションの現在の状態。
submit_time

Timestamp

バッチ リクエストがサーバーに送信された時刻。
end_time

Timestamp

バッチ リクエストが終了し、google.longrunning.Operation.done が true に設定された時刻。

State

バッチ リクエストの状態は、次のいずれかになります。

列挙型
STATE_UNSPECIFIED 無効。
PROCESSING リクエストがアクティブに処理されています。
SUCCESSFUL リクエストが完了し、少なくとも 1 つの項目が正常に処理されました。
FAILED リクエストが完了し、どの項目も正常に処理されませんでした。
CANCELLED リクエストは、longrunning.Operations.CancelOperation がユーザーによって呼び出された後に完了しました。キャンセル コマンドの前に処理されたレコードは、リクエストで指定されたように出力されます。

Block

ページ上の論理的な要素。

フィールド
property

TextProperty

ブロックについて検出された追加情報。
bounding_box

BoundingPoly

ブロックの境界ボックス。頂点は、左上、右上、右下、左下の順に並んでいます。境界ボックスの回転が検出された場合、回転はテキストを「自然な」方向で読み取るときの左上隅を中心と定義して表されます。例:

  • テキストが水平の場合、次のようになります。
    0----1
    |    |
    3----2
  • テキストが左上隅を中心として 180 度回転した場合は、次のようになります。
    2----3
    |    |
    1----0

頂点の順序は (0, 1, 2, 3) のままです。
paragraphs[]

Paragraph

このブロック内の段落のリスト（このブロックのタイプがテキストの場合）。
block_type

BlockType

このブロックの検出されたブロックタイプ（テキスト、イメージなど）。
confidence

float

このブロックの OCR 実行結果の信頼性。範囲は [0, 1] です。

BlockType

OCR で特定されたブロックのタイプ（テキスト、画像など）。

列挙型
UNKNOWN 不明なブロックタイプ。
TEXT 標準テキスト ブロック。
TABLE テーブル ブロック。
PICTURE 画像ブロック。
RULER 水平線 / 垂直線ボックス。
BARCODE バーコード ブロック。

BoundingPoly

検出された画像アノテーションの境界ポリゴン。

フィールド
vertices[]

Vertex

境界ポリゴンの頂点。
normalized_vertices[]

NormalizedVertex

境界ポリゴンの正規化された頂点。

ColorInfo

カラー情報は、RGB チャネル、スコア、画像内でその色が占有する割合で構成されます。

フィールド
color

Color

色の RGB 構成要素。
score

float

この色の画像固有のスコア。値の範囲は [0, 1] です。
pixel_fraction

float

画像でその色が占有するピクセルの割合。値の範囲は [0, 1] です。

CreateProductRequest

CreateProduct メソッドに対するリクエスト メッセージ。

フィールド
parent

string

Product が作成されるプロジェクト。

形式は projects/PROJECT_ID/locations/LOC_ID です。
product

Product

作成する商品。
product_id

string

この Product のユーザー指定のリソース ID。設定すると、サーバーはこの値をリソース ID として使用します。すでに使用されている場合は、ALREADY_EXISTS コードとともにエラーが返されます。128 文字以内で指定してください。文字 / を含めることはできません。

CreateProductSetRequest

CreateProductSet メソッドに対するリクエスト メッセージ。

フィールド
parent

string

ProductSet が作成されるプロジェクト。

形式は projects/PROJECT_ID/locations/LOC_ID です。
product_set

ProductSet

作成する ProductSet。
product_set_id

string

この ProductSet のユーザー指定のリソース ID。設定すると、サーバーはこの値をリソース ID として使用します。すでに使用されている場合は、ALREADY_EXISTS コードとともにエラーが返されます。128 文字以内で指定してください。文字 / を含めることはできません。

CreateReferenceImageRequest

CreateReferenceImage メソッドに対するリクエスト メッセージ。

フィールド
parent

string

参照画像を作成する商品のリソース名。

形式は projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID です。
reference_image

ReferenceImage

作成する参照画像。イメージ ID が指定されていない場合は、無視されます。
reference_image_id

string

追加する ReferenceImage のユーザー指定のリソース ID。設定すると、サーバーはこの値をリソース ID として使用します。すでに使用されている場合は、ALREADY_EXISTS コードとともにエラーが返されます。128 文字以内で指定してください。文字 / を含めることはできません。

CropHint

画像を処理するときに新しいクロップを生成するために使用される 1 つのクロップヒント。

フィールド
bounding_poly

BoundingPoly

クロップ領域の境界ポリゴン。境界ボックスの座標は元の画像のスケールで示されます。
confidence

float

注目領域であることの信頼度。範囲は [0, 1] です。
importance_fraction

float

元の画像を基準にしたこの注目領域の重要度の割合。

CropHintsAnnotation

画像を処理するときに新しいクロップを生成するために使用されるクロップヒントのセット。

フィールド
crop_hints[]

CropHint

クロップヒントの結果。

CropHintsParams

クロップヒント アノテーション リクエストのパラメータ。

フィールド
aspect_ratios[]

float

浮動小数点数で示されるアスペクト比。画像の幅対高さの比率を表します。たとえば、必要なアスペクト比が 4/3 の場合、対応する浮動小数点値は 1.33333 です。指定しない場合は、最適なクロップが返されます。指定できるアスペクト比の数は最大で 16 個です。17 番目以降のアスペクト比はすべて無視されます。

DeleteProductRequest

DeleteProduct メソッドに対するリクエスト メッセージ。

フィールド
name

string

削除する商品のリソース名。

形式: projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID

DeleteProductSetRequest

DeleteProductSet メソッドに対するリクエスト メッセージ。

フィールド
name

string

削除する ProductSet のリソース名。

形式: projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID

DeleteReferenceImageRequest

DeleteReferenceImage メソッドに対するリクエスト メッセージ。

フィールド
name

string

削除する参照画像のリソース名。

形式:

projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID

DominantColorsAnnotation

ドミナント カラーとその対応するスコアのセット。

フィールド
colors[]

ColorInfo

RGB カラーの値とそのスコアおよびピクセルの割合。

EntityAnnotation

検出されたエンティティの特徴のセット。

フィールド
mid

string

不透明エンティティの ID。一部の ID は Google Knowledge Graph Search API で使用できます。
locale

string

エンティティ テキスト description が表現されているロケールの言語コード。
description

string

エンティティ テキストの説明。locale の言語で表現されます。

score

float

結果の全体的なスコア。範囲は [0, 1] です。
confidence
(deprecated)

float

サポートを終了しました。代わりに score を使用してください。画像でのエンティティ検出の精度。たとえば、「Eiffel Tower」というエンティティが検出された画像の場合、このフィールドは、クエリ画像内に塔があることの信頼度を表します。範囲は [0, 1] です。
topicality

float

画像に対する ICA（Image Content Annotation）ラベルの関連度。たとえば、「Eiffel Tower」が検出された画像と遠方にある塔（Tower）が検出された画像の場合、塔があることの信頼度が同一であっても、「Tower」の関連度は「Eiffel Tower」が検出された画像の方が高くなります。範囲は [0, 1] です。
bounding_poly

BoundingPoly

このエンティティが属する画像領域。LABEL_DETECTION 機能では作成されません。
locations[]

LocationInfo

検出されたエンティティの位置情報。複数の LocationInfo 要素が存在していることがあります。これは、ある位置が画像内のシーンの位置を示し、別の位置が画像撮影場所の位置を示している可能性があるためです。位置情報は通常、ランドマークのために存在しています。
properties[]

Property

エンティティの中には、エンティティを修飾するスコアや文字列など、オプションのユーザー指定 Property（名前 / 値）フィールドを持つものがあります。

FaceAnnotation

顔アノテーション オブジェクトには、顔検出の結果が含まれます。

フィールド
bounding_poly

BoundingPoly

顔の輪郭の境界ポリゴン。境界ボックスの座標は元の画像のスケールで示されます。人間の顔と考えられる顔を「囲む」ため、境界ボックスが計算されます。これは、ランドマーカーの結果に基づいています。アノテーションが付けられる画像に顔の一部だけが表示される場合には、BoundingPoly で 1 つ以上の x 座標または y 座標が生成されない可能性があります（ポリゴンが閉じません）。
fd_bounding_poly

BoundingPoly

fd_bounding_poly 境界ポリゴンは boundingPoly よりも細かく、顔の肌部分だけを囲みます。一般に、画像分析で画像に「ある程度の量の肌」が写っていることが検出された場合に、顔を除外するために使用されます。これは、ランドマーカーの結果には基づいておらず、初期顔検出だけに基づいているため、次の

fd

（顔検出）接頭辞が使用されます。
landmarks[]

Landmark

検出された顔ランドマーク。
roll_angle

float

ロール角。これは、画像の垂直方向を基準に、顔の垂直軸が時計回り / 反時計回りで回転する量を示します。範囲は [-180,180] です。
pan_angle

float

ヨー角。これは、画像の真正面方向を基準に、顔の真正面が向いている角度（左方向 / 右方向）を示します。範囲は [-180,180] です。
tilt_angle

float

ピッチ角。これは、画像の水平方向を基準に、顔が向いている上方向 / 下方向の角度を示します。範囲は [-180,180] です。
detection_confidence

float

検出の信頼度。範囲は [0, 1] です。
landmarking_confidence

float

顔のランドマークの信頼度。範囲は [0, 1] です。
joy_likelihood

Likelihood

喜んでいる可能性。
sorrow_likelihood

Likelihood

悲しんでいる可能性。
anger_likelihood

Likelihood

怒っている可能性。
surprise_likelihood

Likelihood

驚いている可能性。
under_exposed_likelihood

Likelihood

露出不足の可能性。
blurred_likelihood

Likelihood

ピントが合っていない可能性。
headwear_likelihood

Likelihood

ヘッドウェアを着けている可能性。

Landmark

顔特有のランドマーク（顔の特徴など）。

フィールド
type

Type

顔のランドマークのタイプ。
position

Position

顔のランドマークの位置。

Type

顔のランドマーク（特徴）のタイプ。左と右は、写真の一般的な鏡像投影を考慮せず、画像を見るユーザーの視点から定義されています。したがって LEFT_EYE は通常、人物の右目です。

列挙型
UNKNOWN_LANDMARK 検出された不明な顔のランドマーク。何も入力されていないはずです。
LEFT_EYE 左目。
RIGHT_EYE 右目。
LEFT_OF_LEFT_EYEBROW 左眉毛の左。
RIGHT_OF_LEFT_EYEBROW 左眉毛の右。
LEFT_OF_RIGHT_EYEBROW 右眉毛の左。
RIGHT_OF_RIGHT_EYEBROW 右眉毛の右。
MIDPOINT_BETWEEN_EYES 目の間の中間点。
NOSE_TIP 鼻の先端。
UPPER_LIP 上唇。
LOWER_LIP 下唇。
MOUTH_LEFT 口の左側。
MOUTH_RIGHT 口の右側。
MOUTH_CENTER 口の中心。
NOSE_BOTTOM_RIGHT 鼻、右下。
NOSE_BOTTOM_LEFT 鼻、左下。
NOSE_BOTTOM_CENTER 鼻、下中点。
LEFT_EYE_TOP_BOUNDARY 左目、上部境界。
LEFT_EYE_RIGHT_CORNER 左目、右隅。
LEFT_EYE_BOTTOM_BOUNDARY 左目、下部境界。
LEFT_EYE_LEFT_CORNER 左目、左隅。
RIGHT_EYE_TOP_BOUNDARY 右目、上部境界。
RIGHT_EYE_RIGHT_CORNER 右目、右隅。
RIGHT_EYE_BOTTOM_BOUNDARY 右目、下部境界。
RIGHT_EYE_LEFT_CORNER 右目、左隅。
LEFT_EYEBROW_UPPER_MIDPOINT 左眉、上中点。
RIGHT_EYEBROW_UPPER_MIDPOINT 右眉、上中点。
LEFT_EAR_TRAGION 左耳の耳珠点。
RIGHT_EAR_TRAGION 右耳の耳珠点。
LEFT_EYE_PUPIL 左目の瞳孔。
RIGHT_EYE_PUPIL 右目の瞳孔。
FOREHEAD_GLABELLA 額の眉間点。
CHIN_GNATHION 顎のオトガイ点。
CHIN_LEFT_GONION 顎の左オトガイ点。
CHIN_RIGHT_GONION 顎の右オトガイ点。

Feature

実行する Google Cloud Vision API 検出のタイプ。そのタイプで返される結果の最大数。features リストでは複数の Feature オブジェクトを指定できます。

フィールド
type

Type

機能のタイプ。
max_results

int32

このタイプの結果の最大数。TEXT_DETECTION、DOCUMENT_TEXT_DETECTION、CROP_HINTS には適用されません。
model

string

この機能で使用するモデル。サポートされている値: builtin/stable（未設定の場合のデフォルト）、builtin/latest

Type

抽出される Google Cloud Vision API 機能のタイプ。

列挙型
TYPE_UNSPECIFIED 機能タイプを指定しません。
FACE_DETECTION 顔検出を実行します。
LANDMARK_DETECTION ランドマーク検出を実行します。
LOGO_DETECTION ロゴ検出を実行します。
LABEL_DETECTION ラベル検出を実行します。
TEXT_DETECTION テキスト検出 / 光学式文字認識（OCR）を実行します。テキスト検出は、より大きな画像のテキスト領域用に最適化されています。画像がドキュメントの場合は、代わりに DOCUMENT_TEXT_DETECTION を使用します。
DOCUMENT_TEXT_DETECTION 高密度テキスト ドキュメントの OCR を実行します。DOCUMENT_TEXT_DETECTION と TEXT_DETECTION の両方が存在する場合に優先されます。
SAFE_SEARCH_DETECTION セーフサーチを実行して、安全でない可能性のあるコンテンツや不適切なコンテンツを検出します。
IMAGE_PROPERTIES 画像のドミナント カラーなどの一連の画像プロパティを計算します。
CROP_HINTS クロップヒントを実行します。
WEB_DETECTION ウェブ検出を実行します。
OBJECT_LOCALIZATION オブジェクト検出のために localizer を実行します。

GcsDestination

出力の書き込み先とする Google Cloud Storage のロケーション。

フィールド
uri

string

結果が保存される Google Cloud Storage URI プリフィックス。結果は JSON 形式で、対応する入力 URI 接頭辞が先頭に付加されます。このフィールドは、Google Cloud Storage ファイルの接頭辞または Google Cloud Storage ディレクトリを表すことができます。いずれの場合も、すべての出力ファイルを取得するには、指定した URI 接頭辞でワイルドカードを使用して Google Cloud Storage を検索する必要があるので、URI は一意である必要があります。

例:

複数の出力がある場合、各レスポンスは AnnotateFileResponse で、各レスポンスには、AnnotateImageResponse の全リストのサブセットが含まれます。たとえば、出力 JSON が大きすぎて複数の分割ファイルにオーバーフローする場合は、複数の出力が発生する可能性があります。

GcsSource

入力の読み取り元となる Google Cloud Storage のロケーション。

フィールド
uri

string

入力ファイルの Google Cloud Storage URI。これは Google Cloud Storage オブジェクトにする必要があります。現在、ワイルドカードはサポートされていません。

GetProductRequest

GetProduct メソッドに対するリクエスト メッセージ。

フィールド
name

string

取得する Product のリソース名。

形式: projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID

GetProductSetRequest

GetProductSet メソッドに対するリクエスト メッセージ。

フィールド
name

string

取得する ProductSet のリソース名。

形式: projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID

GetReferenceImageRequest

GetReferenceImage メソッドに対するリクエスト メッセージ。

フィールド
name

string

取得する ReferenceImage のリソース名。

形式:

projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID。

Image

Google Cloud Vision API タスクの実行対象クライアント画像。

フィールド
content

bytes

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

ImageSource

Google Cloud Storage の画像の場所、または一般にアクセス可能な画像の URL。1 つの画像に対して content と source の両方が指定されている場合、content が優先され、画像アノテーション リクエストの実行時に使用されます。

ImageAnnotationContext

ファイルから（PDF など）画像が生成された場合は、このメッセージに画像のソースに関する情報が表示されます。

フィールド
uri

string

画像の生成に使用されるファイルの URI。
page_number

int32

ファイルが PDF または TIFF の場合、このフィールドには、画像の生成に使用されたファイル内のページ番号が示されます。

ImageContext

画像コンテキストおよび機能固有のパラメータ。

フィールド
lat_long_rect

LatLongRect

使用されません。
language_hints[]

string

TEXT_DETECTION に使用する言語のリスト。ほとんどの場合、値を空にして自動言語検出を有効にしておくことによって最善の結果が得られます。ラテン アルファベット系の言語の場合、language_hints の設定は不要です。画像中のテキストの言語がわかっている場合などに、ヒントを設定すると結果が少し良くなります（逆に、ヒントを間違えると大きく阻害します）。サポートされる言語以外の言語が 1 つでも指定されていると、テキスト検出でエラーが返されます。
crop_hints_params

CropHintsParams

クロップヒント アノテーション リクエストのパラメータ。
product_search_params

ProductSearchParams

Product Search のパラメータ。
web_detection_params

WebDetectionParams

ウェブ検出のパラメータ。

ImageProperties

ドミナント カラーなどの画像プロパティを格納します。

フィールド
dominant_colors

DominantColorsAnnotation

存在する場合、ドミナント カラーが正常に完了しました。

ImageSource

外部画像ソース（Google Cloud Storage またはウェブ URL イメージの場所）。

フィールド
gcs_image_uri

string

代わりに image_uri を使用してください。

gs://bucket_name/object_name 形式の Google Cloud Storage URI。オブジェクトのバージョニングはサポートされていません。詳しくは、Google Cloud Storage のリクエスト URI をご覧ください。
image_uri

string

ソース画像の URI。以下のいずれかです。

  1. gs://bucket_name/object_name 形式の Google Cloud Storage URI。オブジェクトのバージョニングはサポートされていません。詳しくは、Google Cloud Storage のリクエスト URI をご覧ください。

  2. 一般公開されている画像の HTTP / HTTPS URL。HTTP / HTTPS URL から画像を取得する場合、リクエストが完了するとは限りません。リクエストの調整や DOS 防止などのため、指定したホストがリクエストを拒否することがあります。また、不正利用を防止するため、Google がサイトに対するリクエストを調整することもあります。このような状況ではリクエストが失敗します。したがって、本番環境のアプリケーションが外部ホストの画像に頼ることはよくありません。

gcs_image_uri と image_uri の両方が指定された場合は、image_uri が優先されます。

ImportProductSetsGcsSource

各行に ImportProductSetRequests のリストを保持する csv ファイルが存在する Google Cloud Storage のロケーション。

フィールド
csv_file_uri

string

入力 csv ファイルの Google Cloud Storage の URI。

URI は、gs:// で始める必要があります。

入力 csv ファイルでは、各行に画像が 1 つ含まれている必要があります。各行には次の 8 つの列があります。

  1. image-uri
  2. image-id
  3. product-set-id
  4. product-id
  5. product-category
  6. product-display-name
  7. labels
  8. bounding-poly

image-uri、product-set-id、product-id、product-category 列は必須です。その他の列はすべて省略可能です。

product-set-id 値と product-id 値で指定された ProductSet または Product が存在しない場合、その画像に対して新しい ProductSet または Product が作成されます。この場合、product-display-name 列は display_name、product-category 列は product_category、labels 列は product_labels を表します。

image-id 列は省略可能ですが、指定する場合は一意にする必要があります。空の場合、画像に固有の ID が自動的に割り当てられます。

product-display-name 列は省略可能です。空の場合、商品の display_name フィールドはスペース（「 」）に設定されます。display_name は、API を使用して後で更新できます。

product-id が指定された Product が存在している場合、product-display-name、product-category、labels 列は無視されます。

labels 列（省略可）には、次の形式の Key-Value ペアのカンマ区切りリストが含まれます。

"key_1=value_1,key_2=value_2,...,key_n=value_n"

CreateReferenceImage と同様に、bounding-poly 列（省略可）には画像の関心領域を 1 つ指定します。bounding-poly 列を指定しない場合、関心領域が自動的に検出されます。

bounding-poly 列は 1 行に 1 つだけ指定できます。画像に複数の関心領域が存在する場合は、同じ商品情報と各関心領域の bounding-poly 値が含まれる行を CSV ファイルに追加します。

bounding-poly 列には「p1_x,p1_y,p2_x,p2_y,...,pn_x,pn_y」の形式で、カンマ区切りの数字が偶数個含まれている必要があります。絶対的な境界ポリゴンには負でない整数を使用し、正規化された境界ポリゴンには [0, 1] の浮動小数点値を使用する必要があります。

画像の解像度が高すぎる（20MP を超える）場合は、画像のサイズが変更されます。

ImportProductSetsInputConfig

ImportProductSets メソッドの入力コンテンツ。

フィールド
gcs_source

ImportProductSetsGcsSource

各行に ImportProductSetRequests のリストを保持する csv ファイルが存在する Google Cloud Storage のロケーション。

ImportProductSetsRequest

ImportProductSets メソッドに対するリクエスト メッセージ。

フィールド
parent

string

ProductSets がインポートされるプロジェクト。

形式は projects/PROJECT_ID/locations/LOC_ID です。
input_config

ImportProductSetsInputConfig

リクエスト リストの入力コンテンツ。

ImportProductSetsResponse

ImportProductSets メソッドに対するレスポンス メッセージ。

このメッセージは、google.longrunning.Operations.GetOperation メソッドによって google.longrunning.Operation.response フィールドで返されます。

フィールド
reference_images[]

ReferenceImage

正常にインポートされた reference_images のリスト。
statuses[]

Status

各 ImportProductSet リクエストの RPC ステータス（成功とエラーの両方）。

ここに示されるステータスの数は csv ファイルの行数と一致し、statuses[i] は CSV ファイルの i 行目の処理の成否ステータスを 0 から順に格納します。

InputConfig

目的の入力ロケーションとメタデータ。

フィールド
gcs_source

GcsSource

入力の読み取り元の Google Cloud Storage のロケーション。
content

bytes

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

現在、このフィールドは BatchAnnotateFiles リクエストでのみ機能します。AsyncBatchAnnotateFiles リクエストでは機能しません。
mime_type

string

ファイルのタイプ。現在、application/pdf、image/tiff、image/gif のみがサポートされています。ワイルドカードはサポートされていません。

LatLongRect

最小および最大 LatLng のペアにより決定する長方形。

フィールド
min_lat_lng

LatLng

最小緯度 / 経度ペア。
max_lat_lng

LatLng

最大緯度 / 経度ペア。

Likelihood

バケット化された可能性の表現。これは、モデルのアップグレードで非常に安定した結果をクライアントに提供することを目的としています。

列挙型
UNKNOWN 不明な可能性。
VERY_UNLIKELY 指定されたカテゴリに画像が属している可能性はほとんどありません。
UNLIKELY 指定されたカテゴリに画像が属している可能性は低いです。
POSSIBLE 指定されたカテゴリに画像が属している可能性があります。
LIKELY 指定されたカテゴリに画像が属している可能性は高いです。
VERY_LIKELY 指定されたカテゴリに画像が属している可能性は非常に高いです。

ListProductSetsRequest

ListProductSets メソッドに対するリクエスト メッセージ。

フィールド
parent

string

ProductSets が一覧表示されるプロジェクト。

形式は projects/PROJECT_ID/locations/LOC_ID です。
page_size

int32

返される最大アイテム数。デフォルト 10、最大 100。
page_token

string

前の List リクエストから返された next_page_token（存在する場合）。

ListProductSetsResponse

ListProductSets メソッドに対するレスポンス メッセージ。

フィールド
product_sets[]

ProductSet

ProductSets のリスト。
next_page_token

string

結果の次のページを取得するためのトークン。それ以上の結果がない場合は空。

ListProductsInProductSetRequest

ListProductsInProductSet メソッドに対するリクエスト メッセージ。

フィールド
name

string

Products を取得する ProductSet リソース。

形式: projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID
page_size

int32

返される最大アイテム数。デフォルト 10、最大 100。
page_token

string

前の List リクエストから返された next_page_token（存在する場合）。

ListProductsInProductSetResponse

ListProductsInProductSet メソッドに対するレスポンス メッセージ。

フィールド
products[]

Product

Products のリスト。
next_page_token

string

結果の次のページを取得するためのトークン。それ以上の結果がない場合は空。

ListProductsRequest

ListProducts メソッドに対するリクエスト メッセージ。

フィールド
parent

string

Products が一覧表示されるプロジェクトまたは ProductSet。

形式: projects/PROJECT_ID/locations/LOC_ID
page_size

int32

返される最大アイテム数。デフォルト 10、最大 100。
page_token

string

前の List リクエストから返された next_page_token（存在する場合）。

ListProductsResponse

ListProducts メソッドに対するレスポンス メッセージ。

フィールド
products[]

Product

商品のリスト。
next_page_token

string

結果の次のページを取得するためのトークン。それ以上の結果がない場合は空。

ListReferenceImagesRequest

ListReferenceImages メソッドに対するリクエスト メッセージ。

フィールド
parent

string

参照画像が含まれる商品のリソース名。

形式は projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID です。
page_size

int32

返される最大アイテム数。デフォルト 10、最大 100。
page_token

string

返される結果のページを特定するトークンです。これは、前の参照画像の list リクエストで返された nextPageToken の値です。

指定しない場合、デフォルトで先頭ページになります。

ListReferenceImagesResponse

ListReferenceImages メソッドに対するレスポンス メッセージ。

フィールド
reference_images[]

ReferenceImage

参照画像のリスト。
page_size

int32

返される最大アイテム数。デフォルト 10、最大 100。
next_page_token

string

前の List リクエストから返された next_page_token（存在する場合）。

LocalizedObjectAnnotation

検出された境界ボックス付きオブジェクトのセット。

フィールド
mid

string

EntityAnnotation mid と一致するオブジェクト ID。
language_code

string

「en-US」や「sr-Latn」などの BCP-47 言語コード。詳細については、http://www.unicode.org/reports/tr35/#Unicode_locale_identifier をご覧ください。
name

string

オブジェクト名。language_code 言語で表現されます。
score

float

結果のスコア。範囲は [0, 1] です。
bounding_poly

BoundingPoly

このオブジェクトが属する画像領域。この値は入力する必要があります。

LocationInfo

検出されたエンティティの位置情報。

フィールド
lat_lng

LatLng

緯度 / 経度での位置座標。

NormalizedVertex

頂点は、画像上の 2D の点を表します。注: 正規化された頂点座標は、元の画像と相対しており、0～1 の範囲になります。

フィールド
x

float

X 座標。
y

float

Y 座標。

OperationMetadata

BatchAnnotateImages オペレーションのメタデータが含まれます。

フィールド
state
(deprecated)

State

バッチ オペレーションの現在の状態。
create_time

Timestamp

バッチ リクエストを受信した時刻。
update_time

Timestamp

オペレーション結果が最後に更新された時刻。

State

バッチ オペレーションの状態。

列挙型
STATE_UNSPECIFIED 無効。
CREATED リクエストが受信されました。
RUNNING リクエストがアクティブに処理されています。
DONE バッチ処理が完了しました。
CANCELLED バッチ処理がキャンセルされました。

OutputConfig

目的の出力場所とメタデータ。

フィールド
gcs_destination

GcsDestination

出力を書き込む Google Cloud Storage の場所。
batch_size

int32

Google Cloud Storage の各出力 JSON ファイルに追加するレスポンス proto の最大数。有効な範囲は [1, 100] です。指定しない場合、デフォルト値は 20 です。

たとえば、100 ページの PDF の場合、100 個のレスポンス proto が生成されます。batch_size = 20 の場合、20 個のレスポンス proto を含む 5 つの JSON ファイルが、それぞれ接頭辞 gcs_destination.uri の下に記述されます。

現在、batch_size は GcsDestination にのみ適用されますが、将来的には他の出力構成もサポートされます。

Page

OCR から検出されたページ。

フィールド
property

TextProperty

ページで検出された追加情報。
width

int32

ページの幅。PDF の場合、単位はポイントです。画像（TIFF を含む）の場合、単位はピクセルです。
height

int32

ページの高さ。PDF の場合、単位はポイントです。画像（TIFF を含む）の場合、単位はピクセルです。
blocks[]

Block

このページのテキスト、画像などのブロックのリスト。
confidence

float

ページの OCR 結果の信頼度。範囲は [0, 1] です。

Paragraph

多数の単語を特定の順序で示すテキストの構造単位。

フィールド
property

TextProperty

段落について検出された追加情報。
bounding_box

BoundingPoly

段落の境界ボックス。頂点は、左上、右上、右下、左下の順に並んでいます。境界ボックスの回転が検出された場合、回転はテキストを「自然な」方向で読み取るときの左上隅を中心と定義して表されます。例: * テキストが水平の場合、0----1 | | 3----2 なります。* 左上隅を中心に 180 度回転すると、2----3 | | 1----0 となり、頂点の順序は（0、1、2、3）のままです。
words[]

Word

この段落の単語のリスト。
confidence

float

この段落の OCR 結果の信頼度。範囲は [0, 1] です。

Position

画像で、主に顔検出ランドマークに使用される 3D 位置。有効な Position には、x 座標と y 座標の両方が指定されているはずです。位置の座標は元の画像と同じスケールです。

フィールド
x

float

X 座標。
y

float

Y 座標。
z

float

Z 座標（または深さ）。

Product

Product には ReferenceImages が含まれます。

フィールド
name

string

商品のリソース名。

形式: projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID

商品の作成では、このフィールドは無視されます。
display_name

string

この Product のユーザー指定の名前。空にすることはできません4,096 文字以内で指定してください。
description

string

この商品とともに保存されるユーザー提供のメタデータ。4,096 文字以内で指定してください。
product_category

string

参照画像によって特定する商品のカテゴリ。homegoods-v2、apparel-v2、toys-v2、packagedgoods-v1 のいずれかを指定します。従来のカテゴリ（homegoods、apparel、toys）は引き続きサポートされますが、これらは非推奨になる予定です。新しい商品の場合、商品検索の精度を高めるため、homegoods-v2、apparel-v2、toys-v2 を使用してください。既存の商品もこれらのカテゴリに移行することをおすすめします。

このフィールドは変更できません。
product_labels[]

KeyValue

商品に関連付けることができる Key-Value ペア。クエリ時に、product_labels に基づいて制約を指定できます。

整数値は「1199」のように、文字列として指定できます。整数値が含まれる文字列のみが範囲ベースの制限と一致します。これは間もなくサポートされます。

複数の値を同じキーに割り当てることができます。1 つの商品に最大 100 個の product_labels を設定できます。

KeyValue

Key-Value ペアとして表される商品ラベル。

フィールド
key

string

商品に適用されたラベルのキー。空白にすることはできません。128 バイト以下にする必要があります。
value

string

商品に適用されたラベルの値。空白にすることはできません。128 バイト以下にする必要があります。

ProductSearchParams

Product Search リクエストのパラメータ。

フィールド
bounding_poly

BoundingPoly

画像内の関心領域を囲む境界ポリゴン。省略可。指定しない場合は、自動的に適用されます。
product_set

string

類似画像を検索する ProductSet のリソース名。

形式: projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID
product_categories[]

string

検索する商品カテゴリのリスト。現在、最初のカテゴリのみが考慮されます。homegoods-v2、apparel-v2、toys-v2 のいずれかを指定する必要があります。従来のカテゴリ（homegoods、apparel、toys）は引き続きサポートされますが、これらは廃止される予定です。新しい商品の場合、商品検索の精度を高めるため、homegoods-v2、apparel-v2、toys-v2 を使用してください。既存の商品もこれらのカテゴリに移行することをおすすめします。
filter

string

フィルタ式。商品ラベルに基づいて検索結果を制限できます。現在、Key-Value 式の OR の AND がサポートされています。OR 内の各式は同じキーにする必要があります。キーと値を連結するには「=」を使用する必要があります。

たとえば、(color = red OR color = blue) AND brand = Google は使用できますが、(color = red OR brand = Google) は使用できません。color: red は、「=」ではなく「:」を使用しているため許容されません。

ProductSearchResults

Product Search リクエストの結果。

フィールド
index_time

Timestamp

これらの結果を生成したインデックスのタイムスタンプ。商品セットに追加された商品と、この期間の後に商品セットから削除された商品は、現在の結果に反映されません。
results[]

Result

一致する商品の結果リスト（商品ごとに 1 つ）。
product_grouped_results[]

GroupedResult

クエリ画像で検出された商品別にグループ化された結果のリスト。各エントリはクエリ画像内の 1 つの境界ポリゴンに対応し、その領域に固有の一致商品が含まれます。商品ごとのすべての検索結果では、重複した商品が存在する可能性があります。

GroupedResult

クエリ画像に含まれる 1 つの商品に類似する商品に関する情報。

フィールド
bounding_poly

BoundingPoly

クエリ画像で検出された商品を囲む境界ポリゴン。
results[]

Result

一致する商品の結果リスト（商品ごとに 1 つ）。

Result

商品に関する情報。

フィールド
product

Product

Product。
score

float

一致の信頼度レベル。0（最低の信頼度）から 1（最高の信頼度）の範囲になります。
image

string

クエリに最も一致する商品の画像のリソース名。

ProductSet

ProductSet には Products が含まれています。ProductSet には、最大 100 万個の参照画像を含めることができます。上限を超えた場合、定期的なインデックス登録は失敗します。

フィールド
name

string

ProductSet のリソース名。

形式: projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID

ProductSet の作成では、このフィールドは無視されます。
display_name

string

この ProductSet のユーザー指定の名前。空にすることはできません4,096 文字以内で指定してください。
index_time

Timestamp

出力のみ。この ProductSet が最後にインデックス登録された時刻。クエリの結果には、この日時より前に行われたすべての更新が反映されます。この ProductSet がインデックスに登録されていない場合、タイムスタンプはデフォルト値の 1970-01-01T00:00:00Z になります。

ProductSet の作成では、このフィールドは無視されます。
index_error

Status

出力のみ。商品セットのインデックス登録中にエラーが発生した場合は、このフィールドにデータが入力されます。

ProductSet の作成では、このフィールドは無視されます。

Property

Property は、ユーザー指定の名前と値のペアで構成されます。

フィールド
name

string

プロパティの名前。
value

string

プロパティの値。
uint64_value

uint64

数値プロパティの値。

ReferenceImage

ReferenceImage は、商品画像とそれに関連するメタデータ（境界ボックスなど）を表します。

フィールド
name

string

参照画像のリソース名。

形式:

projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID。

参照画像を作成する場合、このフィールドは無視されます。
uri

string

参照画像の Google Cloud Storage URI。

URI は、gs:// で始める必要があります。

必須。
bounding_polys[]

BoundingPoly

参照画像内の関心領域を囲む境界ポリゴン。省略可。このフィールドが空の場合、システムは関心領域の検出を試みます。境界ポリゴンは、最大 10 個使用されます。

指定したシェイプは、回転しない長方形に変換されます。変換後、長方形の小さい端を 300 ピクセル以上にする必要があります。アスペクト比は 1:4 以下でなければなりません（1:3 は許容されますが、1:5 は許容されません）。

RemoveProductFromProductSetRequest

RemoveProductFromProductSet メソッドに対するリクエスト メッセージ。

フィールド
name

string

変更する ProductSet のリソース名。

形式: projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID
product

string

この ProductSet から削除する Product のリソース名。

形式: projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID

SafeSearchAnnotation

画像の特徴のセット。これらの特徴は、セーフサーチ カテゴリ（アダルト、パロディ、医療、暴力など）に関してコンピュータ ビジョン メソッドにより計算されます。

フィールド
adult

Likelihood

画像がアダルト コンテンツである可能性を表します。アダルト コンテンツには、ヌード、ポルノ画像や漫画、性行為などの要素が含まれている可能性があります。
spoof

Likelihood

パロディの可能性。これは、面白くするため、または侮辱的にするため、正規の画像が改ざんされた可能性です。
medical

Likelihood

医療画像である可能性。
violence

Likelihood

この画像に暴力的なコンテンツが含まれている可能性。
racy

Likelihood

リクエスト画像に露骨なコンテンツが含まれている可能性。露骨な内容には、露出度の高い服や薄手の服、意図的に一部が覆われたヌード、猥褻または挑発的なポーズ、または局部のクローズアップなどがあります。

Symbol

1 つの記号表現。

フィールド
property

TextProperty

記号について検出された追加情報。
bounding_box

BoundingPoly

記号の境界ボックス。頂点は、左上、右上、右下、左下の順に並んでいます。境界ボックスの回転が検出された場合、回転はテキストを「自然な」方向で読み取るときの左上隅を中心と定義して表されます。例: * テキストが水平の場合、0----1 | | 3----2 なります。* 左上隅を中心に 180 度回転すると、2----3 | | 1----0 となり、頂点の順序は（0、1、2、3）のままです。
text

string

記号の実際の UTF-8 表現。
confidence

float

記号の OCR 結果の信頼度。範囲は [0, 1] です。

TextAnnotation

TextAnnotation には、OCR 抽出テキストの構造化表現が含まれています。OCR 抽出テキスト構造の階層は、TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol のようになります。Page 以降の各構造コンポーネントには独自のプロパティが設定されていることがあります。プロパティは、検出された言語、区切りなどを記述します。詳しくは、以下の TextAnnotation.TextProperty メッセージの定義をご覧ください。

フィールド
pages[]

Page

OCR によって検出されたページのリスト。
text

string

ページで検出された UTF-8 テキスト。

DetectedBreak

検出された構造コンポーネントの開始または終了。

フィールド
type

BreakType

検出された区切りのタイプ。
is_prefix

bool

区切りが要素の前にある場合は True。

BreakType

検出された区切りのタイプを示す列挙型。改行、スペースなどです。

列挙型
UNKNOWN 不明な区切りラベルタイプ。
SPACE 標準スペース。
SURE_SPACE 広幅のスペース。
EOL_SURE_SPACE 行折り返しの区切り。
HYPHEN テキストに存在しない行末ハイフン。SPACE、LEADER_SPACE、LINE_BREAK と組み合わせて出現することはありません。
LINE_BREAK 段落を終了する改行。

DetectedLanguage

検出された構造コンポーネントの言語。

フィールド
language_code

string

「en-US」や「sr-Latn」などの BCP-47 言語コード。詳細については、http://www.unicode.org/reports/tr35/#Unicode_locale_identifier をご覧ください。
confidence

float

検出された言語の信頼度。範囲は [0, 1] です。

TextProperty

構造コンポーネントで検出された追加情報。

フィールド
detected_languages[]

DetectedLanguage

検出された言語と信頼度のリスト。
detected_break

DetectedBreak

検出されたテキスト セグメントの開始または終了。

UpdateProductRequest

UpdateProduct メソッドに対するリクエスト メッセージ。

フィールド
product

Product

サーバー上のリソースを置き換える Product リソース。product.name は変更できません。
update_mask

FieldMask

更新するフィールドを指定する FieldMask。update_mask が指定されていない場合、すべての変更可能なフィールドが更新されます。有効なマスクパスは product_labels、display_name、description です。

UpdateProductSetRequest

UpdateProductSet メソッドに対するリクエスト メッセージ。

フィールド
product_set

ProductSet

サーバー上のリソースを置き換える ProductSet リソース。
update_mask

FieldMask

更新するフィールドを指定する FieldMask。update_mask が指定されていない場合、すべての変更可能なフィールドが更新されます。有効なマスクパスは display_name です。

Vertex

頂点は、画像上の 2D の点を表します。注: 頂点の座標は元の画像と同じスケールです。

フィールド
x

int32

X 座標。
y

int32

Y 座標。

WebDetection

インターネットからの画像に関する関連情報。

フィールド
web_entities[]

WebEntity

インターネット上の類似画像から推測されたエンティティ。
full_matching_images[]

WebImage

完全に一致するインターネット上の画像。クエリ画像のサイズを変更したコピーも含まれます。
partial_matching_images[]

WebImage

部分的に一致するインターネットの画像。これらの画像は十分に類似しており、いくつかの主要な特徴を共有しています。たとえば、元の画像とそのクロップした画像とは部分一致する可能性があります。
pages_with_matching_images[]

WebPage

一致するインターネットの画像を含むウェブページ。
visually_similar_images[]

WebImage

視覚的に類似した画像結果。
best_guess_labels[]

WebLabel

サービスが、リクエスト画像のトピックに最も近いとする推測です。オープンウェブ上の類似画像から推定されます。

WebEntity

インターネット上の類似画像から推測されたエンティティ。

フィールド
entity_id

string

不透明エンティティ ID。
score

float

エンティティの全体的な関連性スコア。正規化されておらず、異なる画像クエリ間で比較することはできません。
description

string

エンティティの標準的な説明（英語）。

WebImage

オンライン画像のメタデータ。

フィールド
url

string

結果画像の URL。
score

float

（非推奨）画像の全体的な関連性スコア。

WebLabel

ウェブ検出のための追加メタデータを提供するラベル。

フィールド
label

string

追加メタデータのラベル。
language_code

string

「en-US」や「sr-Latn」などの label の BCP-47 言語コード。詳細については、http://www.unicode.org/reports/tr35/#Unicode_locale_identifier をご覧ください。

WebPage

ウェブページのメタデータ。

フィールド
url

string

結果のウェブページの URL。
score

float

（非推奨）ウェブページの全体的な関連性スコア。
page_title

string

ウェブページのタイトル。HTML マークアップが含まれていることがあります。
full_matching_images[]

WebImage

ページ上の完全一致画像。クエリ画像のサイズを変更したコピーも含まれます。
partial_matching_images[]

WebImage

ページ上の部分一致画像。これらの画像は十分に類似しており、いくつかの主要な特徴を共有しています。たとえば、元の画像とそのクロップした画像とは部分一致する可能性があります。

WebDetectionParams

ウェブ検出リクエストのパラメータ。

フィールド
include_geo_results

bool

地理情報から得られた結果を画像に組み込むかどうか。

Word

単語の表現。

フィールド
property

TextProperty

単語について検出された追加情報。
bounding_box

BoundingPoly

単語の境界ボックス。頂点は、左上、右上、右下、左下の順に並んでいます。境界ボックスの回転が検出された場合、回転はテキストを「自然な」方向で読み取るときの左上隅を中心と定義して表されます。例: * テキストが水平の場合、0----1 | | 3----2 なります。* 左上隅を中心に 180 度回転すると、2----3 | | 1----0 となり、頂点の順序は（0、1、2、3）のままです。
symbols[]

Symbol

単語内の記号のリスト。記号の順序は、自然な読み順に従います。
confidence

float

単語に対する OCR 結果の信頼度。範囲は [0, 1] です。