インデックス
ImageAnnotator(インターフェース)ProductSearch(インターフェース)AddProductToProductSetRequest(メッセージ)AnnotateFileRequest(メッセージ)AnnotateFileResponse(メッセージ)AnnotateImageRequest(メッセージ)AnnotateImageResponse(メッセージ)AsyncAnnotateFileRequest(メッセージ)AsyncAnnotateFileResponse(メッセージ)AsyncBatchAnnotateFilesRequest(メッセージ)AsyncBatchAnnotateFilesResponse(メッセージ)AsyncBatchAnnotateImagesRequest(メッセージ)AsyncBatchAnnotateImagesResponse(メッセージ)BatchAnnotateFilesRequest(メッセージ)BatchAnnotateFilesResponse(メッセージ)BatchAnnotateImagesRequest(メッセージ)BatchAnnotateImagesResponse(メッセージ)BatchOperationMetadata(メッセージ)BatchOperationMetadata.State(列挙型)Block(メッセージ)Block.BlockType(列挙型)BoundingPoly(メッセージ)ColorInfo(メッセージ)CreateProductRequest(メッセージ)CreateProductSetRequest(メッセージ)CreateReferenceImageRequest(メッセージ)CropHint(メッセージ)CropHintsAnnotation(メッセージ)CropHintsParams(メッセージ)CustomEntityAnnotation(メッセージ)DeleteProductRequest(メッセージ)DeleteProductSetRequest(メッセージ)DeleteReferenceImageRequest(メッセージ)DocumentParsingParams(メッセージ)DominantColorsAnnotation(メッセージ)EntityAnnotation(メッセージ)FaceAnnotation(メッセージ)FaceAnnotation.Landmark(メッセージ)FaceAnnotation.Landmark.Type(列挙型)Feature(メッセージ)Feature.Type(列挙型)GcsDestination(メッセージ)GcsSource(メッセージ)GetProductRequest(メッセージ)GetProductSetRequest(メッセージ)GetReferenceImageRequest(メッセージ)Image(メッセージ)ImageAnnotationContext(メッセージ)ImageContext(メッセージ)ImageProperties(メッセージ)ImageQuality(メッセージ)ImageSource(メッセージ)ImportProductSetsGcsSource(メッセージ)ImportProductSetsInputConfig(メッセージ)ImportProductSetsRequest(メッセージ)ImportProductSetsResponse(メッセージ)InputConfig(メッセージ)KeyValuePair(メッセージ)LatLongRect(メッセージ)Likelihood(列挙型)ListProductSetsRequest(メッセージ)ListProductSetsResponse(メッセージ)ListProductsInProductSetRequest(メッセージ)ListProductsInProductSetResponse(メッセージ)ListProductsRequest(メッセージ)ListProductsResponse(メッセージ)ListReferenceImagesRequest(メッセージ)ListReferenceImagesResponse(メッセージ)LocalizedBarcodeAnnotation(メッセージ)LocalizedObjectAnnotation(メッセージ)LocationInfo(メッセージ)NormalizedVertex(メッセージ)OperationMetadata(メッセージ)OperationMetadata.State(列挙型)OutputConfig(メッセージ)Page(メッセージ)Paragraph(メッセージ)Position(メッセージ)Product(メッセージ)Product.KeyValue(メッセージ)ProductSearchParams(メッセージ)ProductSearchResults(メッセージ)ProductSearchResults.GroupedResult(メッセージ)ProductSearchResults.ObjectAnnotation(メッセージ)ProductSearchResults.Result(メッセージ)ProductSet(メッセージ)Property(メッセージ)QualityOptimizationParams(メッセージ)QualityOptimizationParams.CompressionConfig(メッセージ)QualityOptimizationParams.EnhancementConfig(メッセージ)QualityOptimizationParams.QualityScoreConfig(メッセージ)QualityOptimizationParams.Type(列挙型)QualityOptimizationResult(メッセージ)ReferenceImage(メッセージ)RemoveProductFromProductSetRequest(メッセージ)SafeSearchAnnotation(メッセージ)Symbol(メッセージ)Table(メッセージ)Table.TableCell(メッセージ)Table.TableRow(メッセージ)TableBoundHint(メッセージ)TableDetectionOptions(メッセージ)TextAnnotation(メッセージ)TextAnnotation.DetectedBreak(メッセージ)TextAnnotation.DetectedBreak.BreakType(列挙型)TextAnnotation.DetectedLanguage(メッセージ)TextAnnotation.TextProperty(メッセージ)TextDetectionParams(メッセージ)UpdateProductRequest(メッセージ)UpdateProductSetRequest(メッセージ)Vertex(メッセージ)WebDetection(メッセージ)WebDetection.WebEntity(メッセージ)WebDetection.WebImage(メッセージ)WebDetection.WebLabel(メッセージ)WebDetection.WebPage(メッセージ)WebDetectionParams(メッセージ)Word(メッセージ)
ImageAnnotator
クライアント画像に対して Google Cloud Vision API の顔検出、ランドマーク検出、ロゴ検出、ラベル検出、テキスト検出などの検出タスクを実行するサービス。ImageAnnotator サービスは、画像から検出されたエンティティを返します。
| AsyncBatchAnnotateFiles | |
|---|---|
|
PDF ファイルなど、汎用ファイルのリストに対して非同期で画像検出とアノテーションを実行します。このファイルには複数のページが含まれている場合があります。また、各ページに複数の画像が存在することもあります。進行状況と結果は、
|
|
| AsyncBatchAnnotateImages | |
|---|---|
|
画像のリストに対して非同期で画像検出とアノテーションを実行します。 進行状況と結果は、 このサービスは、お客様の Google Cloud Storage バケット内の JSON ファイルに画像アノテーション出力を書き込みます。各 JSON ファイルには BatchAnnotateImagesResponse proto が含まれます。
|
|
| BatchAnnotateFiles | |
|---|---|
|
複数のファイルに対して一括で画像検出とアノテーションを実行するサービス。現在、「application/pdf」、「image/tiff」、「image/gif」のみがサポートされています。 このサービスは、指定されたファイルから最大で最初の 10 個のフレーム(gif)またはページ(PDF または tiff)抽出して、抽出した各画像の検出とアノテーションを実行します。
|
|
| BatchAnnotateImages | |
|---|---|
|
画像のバッチに対して画像の検出とアノテーションを実行します。
|
|
ProductSearch
Product Search で使用する参照画像の Products と ProductSet を管理します。次のリソースモデルを使用します。
- API には、
projects/*/locations/*/productSets/*という名前のProductSetリソースのコレクションがあります。これは、さまざまな商品をグループにまとめて ID を制限するための方法として機能します。
並行して
API には、
projects/*/locations/*/products/*という名前のProductリソースのコレクションがあります。各
Productには、projects/*/locations/*/products/*/referenceImages/*という名前のReferenceImageリソースのコレクションがあります。
| AddProductToProductSet | |
|---|---|
|
指定した ProductSet に Product を追加します。Product がすでに存在する場合、変更は行われません。 1 つの Product を最大 100 個の ProductSets に追加できます。 発生する可能性があるエラー:
|
|
| CreateProduct | |
|---|---|
|
新しい商品リソースを作成して返します。 発生する可能性があるエラー:
|
|
| CreateProductSet | |
|---|---|
|
新しい ProductSet リソースを作成して返します。 発生する可能性があるエラー:
|
|
| CreateReferenceImage | |
|---|---|
|
新しい ReferenceImage リソースを作成して返します。
画像の解像度が高すぎて処理できない場合(50 メガピクセルを超える場合)、パイプラインによって画像のサイズが変更されます。 発生する可能性があるエラー:
|
|
| DeleteProduct | |
|---|---|
|
商品とその参照画像を完全に削除します。 商品のメタデータとそのすべての画像がすぐに削除されますが、その商品が含まれる ProductSet に対する検索クエリは、関連するすべてのキャッシュが更新されるまでは機能します。 発生する可能性があるエラー:
|
|
| DeleteProductSet | |
|---|---|
|
ProductSet を完全に削除します。ProductSet 内の Products と ReferenceImages は削除されません。 実際の画像ファイルは Google Cloud Storage から削除されません。 発生する可能性があるエラー:
|
|
| DeleteReferenceImage | |
|---|---|
|
参照画像を完全に削除します。 画像メタデータはすぐに削除されますが、関連するすべてのキャッシュが更新されるまで、画像が含まれている ProductSets に対する検索クエリは引き続き機能します。 実際の画像ファイルは Google Cloud Storage から削除されません。 発生する可能性があるエラー:
|
|
| GetProduct | |
|---|---|
|
Product に関連付けられた情報を取得します。 発生する可能性があるエラー:
|
|
| GetProductSet | |
|---|---|
|
ProductSet に関連付けられている情報を取得します。 発生する可能性があるエラー:
|
|
| GetReferenceImage | |
|---|---|
|
ReferenceImage に関連付けられた情報を取得します。 発生する可能性があるエラー:
|
|
| ImportProductSets | |
|---|---|
|
画像情報のリストに基づいて、指定した商品セットに参照画像をインポートする非同期 API。
このメソッドの入力ソースは Google Cloud Storage 上の csv ファイルです。CSV ファイルの形式については、
|
|
| ListProductSets | |
|---|---|
|
不特定の順序で ProductSets を一覧表示します。 発生する可能性があるエラー:
|
|
| ListProducts | |
|---|---|
|
不特定の順序で商品を一覧表示します。 発生する可能性があるエラー:
|
|
| ListProductsInProductSet | |
|---|---|
|
ProductSet 内の Products を不特定の順序で一覧表示します。ProductSet が存在しない場合、レスポンスの products フィールドは空になります。 発生する可能性があるエラー:
|
|
| ListReferenceImages | |
|---|---|
|
参照画像を一覧表示します。 発生する可能性があるエラー:
|
|
| RemoveProductFromProductSet | |
|---|---|
|
指定した ProductSet から Product を削除します。 発生する可能性があるエラー:
|
|
| UpdateProduct | |
|---|---|
|
Product リソースを変更します。現時点で更新できるのは、 ラベルが更新されると、次のインデックス時間まで変更がクエリに反映されません。 発生する可能性があるエラー:
|
|
| UpdateProductSet | |
|---|---|
|
ProductSet リソースを変更します。現在更新できるのは display_name のみです。 発生する可能性があるエラー:
|
|
AddProductToProductSetRequest
AddProductToProductSet メソッドに対するリクエスト メッセージ。
| フィールド | |
|---|---|
name |
変更する ProductSet のリソース名。 形式は |
product |
この ProductSet に追加する Product のリソース名。 形式は |
AnnotateFileRequest
1 つのファイル(PDF、TIFF、GIF など)にアノテーションを付けるリクエスト。
| フィールド | |
|---|---|
input_config |
必須。入力ファイルに関する情報。 |
features[] |
必須。要求する機能。 |
image_context |
ファイル内の画像に付随する可能性のある追加のコンテキスト。 |
pages[] |
画像アノテーションを実行するファイルのページ数。 ページは 1 から始まり、ファイルの先頭ページが 1 ページであるとみなされます。1 回のリクエストにつき最大 5 ページがサポートされています。ページには負の値を設定できます。 ページ 1 は最初のページを意味します。ページ 2 は 2 ページ目を意味します。ページ -1 は最後のページを意味します。ページ -2 は最後から 2 番目のページを意味します。 ファイルが PDF や TIFF ではなく GIF の場合、ページは GIF フレームになります。 このフィールドが空の場合、デフォルトでは、ファイルの最初の 5 ページに対して画像アノテーションが実行されます。 |
AnnotateFileResponse
単一ファイルのアノテーション リクエストへのレスポンス。1 つのファイルには 1 つ以上の画像が含まれる場合があります。各画像にそれぞれ固有のレスポンスが存在します。
| フィールド | |
|---|---|
input_config |
このレスポンスが生成されるファイルに関する情報。 |
responses[] |
ファイルに含まれる画像に対する個々のレスポンス。 |
AnnotateImageRequest
ユーザーがリクエストした機能とコンテキスト情報を使用して、ユーザーが指定した画像に対して Google Cloud Vision API タスクを実行するようにリクエストします。
| フィールド | |
|---|---|
image |
処理される画像。 |
features[] |
リクエストする機能。 |
image_context |
画像に関連する追加のコンテキスト。 |
custom_label_detection_models[] |
|
AnnotateImageResponse
画像アノテーション リクエストに対するレスポンス。
| フィールド | |
|---|---|
face_annotations[] |
存在する場合、顔検出が正常に完了しています。 |
landmark_annotations[] |
存在する場合、ランドマーク検出が正常に完了しています。 |
logo_annotations[] |
存在する場合、ロゴ検出が正常に完了しています。 |
label_annotations[] |
存在する場合、ラベル検出が正常に完了しています。 |
localized_object_annotations[] |
存在する場合、ローカライズされたオブジェクト検出が正常に完了しています。信頼スコアの降順で並べ替えられます。 |
custom_label_annotations[] |
存在する場合、カスタム アノテーションが正常に完了しています。 |
text_annotations[] |
存在する場合、テキスト(OCR)検出が正常に完了しています。 |
full_text_annotation |
存在する場合、テキスト(OCR)検出またはドキュメント(OCR)テキスト検出が正常に完了しています。このアノテーションは、OCR で検出されたテキストの構造的階層を提供します。 |
safe_search_annotation |
存在する場合、セーフサーチ アノテーションが正常に完了しています。 |
image_properties_annotation |
存在する場合、画像のプロパティが正常に抽出されています。 |
crop_hints_annotation |
存在する場合、クロップヒントが正常に完了しています。 |
web_detection |
存在する場合、ウェブ検出が正常に完了しています。 |
product_search_results |
存在する場合、Product Search は正常に完了しています。 |
error |
設定されている場合、オペレーションのエラー メッセージを表します。 |
context |
存在する場合は、この画像の取得元を特定するためにコンテキスト情報が必要になります。 |
image_quality_annotation |
存在する場合、画質の計算は正常に完了しています。 |
object_attribute_annotations[] |
オブジェクトが存在する場合、オブジェクト属性の計算は正常に完了しています。属性値は EntityAnnotation.properties に示されます。例: object_attribute_annotations { properties { name: "color" value: "blue" confidence: 0.1 } properties { name: "color" value: "white" confidence: 0.2 } properties { name: "material" value: "silk" confidence: 0.3 } } |
quality_optimization_result |
存在する場合、画質の最適化は正常に完了しています。 |
localized_barcode_annotations[] |
ローカライズされたバーコード検出が正常に完了しています。 |
AsyncAnnotateFileRequest
オフライン ファイルのアノテーション リクエスト。
| フィールド | |
|---|---|
input_config |
必須。入力ファイルに関する情報。 |
features[] |
必須。要求する機能。 |
image_context |
ファイル内の画像に付随する可能性のある追加のコンテキスト。 |
output_config |
必須。目的の出力場所とメタデータ(例: フォーマット)。 |
AsyncAnnotateFileResponse
単一オフライン ファイルのアノテーション リクエストに対するレスポンス。
| フィールド | |
|---|---|
output_config |
AsyncAnnotateFileRequest からの出力場所とメタデータ。 |
AsyncBatchAnnotateFilesRequest
複数の非同期ファイルのアノテーション リクエストが 1 回のサービス呼び出しでバッチ処理されます。
| フィールド | |
|---|---|
requests[] |
このバッチの個々の非同期ファイルのアノテーション リクエスト。 |
AsyncBatchAnnotateFilesResponse
非同期のバッチ ファイル アノテーション リクエストに対するレスポンス。
| フィールド | |
|---|---|
responses[] |
ファイル アノテーション レスポンスのリスト。AsyncBatchAnnotateFilesRequest の各リクエストに 1 つのレスポンスがあります。 |
AsyncBatchAnnotateImagesRequest
画像のリストに対する非同期画像アノテーションのリクエスト。
| フィールド | |
|---|---|
requests[] |
このバッチの個々の画像アノテーション リクエスト。 |
output_config |
必須。目的の出力場所とメタデータ(例: フォーマット)。 |
AsyncBatchAnnotateImagesResponse
非同期のバッチ画像アノテーション リクエストに対するレスポンス。
| フィールド | |
|---|---|
output_config |
AsyncBatchAnnotateImagesRequest からの出力場所とメタデータ。 |
BatchAnnotateFilesRequest
BatchAnnotateFiles API を使用してファイルにアノテーションを設定するリクエストのリスト。
| フィールド | |
|---|---|
requests[] |
ファイル アノテーション リクエストのリスト。現在、BatchAnnotateFilesRequest では AnnotateFileRequest が 1 つだけサポートされています。 |
BatchAnnotateFilesResponse
ファイル アノテーション レスポンスのリスト。
| フィールド | |
|---|---|
responses[] |
ファイル アノテーション レスポンスのリスト。各レスポンスは、BatchAnnotateFilesRequest 内の各 AnnotateFileRequest に対応しています。 |
BatchAnnotateImagesRequest
複数の画像アノテーション リクエストが 1 回のサービス呼び出しでバッチ処理されます。
| フィールド | |
|---|---|
requests[] |
このバッチの個々の画像アノテーション リクエスト。 |
BatchAnnotateImagesResponse
バッチ画像アノテーション リクエストに対するレスポンス。
| フィールド | |
|---|---|
responses[] |
バッチ内の画像アノテーション リクエストに対する個々のレスポンス。 |
BatchOperationMetadata
バッチ オペレーションのメタデータ(現在の状態など)。
google::longrunning::Operations サービスの GetOperation 呼び出しによって返される Operation の metadata フィールドに含まれます。
| フィールド | |
|---|---|
state |
バッチ オペレーションの現在の状態。 |
submit_time |
バッチ リクエストがサーバーに送信された時刻。 |
end_time |
バッチ リクエストが終了し、 |
状態
バッチ リクエストの状態は、次のいずれかになります。
| 列挙型 | |
|---|---|
STATE_UNSPECIFIED |
無効。 |
PROCESSING |
リクエストがアクティブに処理されています。 |
SUCCESSFUL |
リクエストが完了し、少なくとも 1 つの項目が正常に処理されました。 |
FAILED |
リクエストが完了し、どの項目も正常に処理されませんでした。 |
CANCELLED |
リクエストは、longrunning.Operations.CancelOperation がユーザーによって呼び出された後に完了しました。キャンセル コマンドの前に処理されたレコードは、リクエストで指定されたように出力されます。 |
Block
ページ上の論理的な要素。
| フィールド | |
|---|---|
property |
ブロックについて検出された追加情報。 |
bounding_box |
ブロックの境界ボックス。頂点は、左上、右上、右下、左下の順に並んでいます。境界ボックスの回転が検出された場合、回転はテキストを「自然な」方向で読み取るときの左上隅を中心と定義して表されます。例:
頂点の順序は (0, 1, 2, 3) のままです。 |
paragraphs[] |
このブロック内の段落のリスト(このブロックのタイプがテキストの場合)。 |
block_type |
このブロックの検出されたブロックタイプ(テキスト、イメージなど)。 |
confidence |
このブロックの OCR 実行結果の信頼性。範囲は [0, 1] です。 |
table |
TABLE block_type で検出されたテーブル。デフォルトでは、TextDetectionParams.table_detection_options で有効にしない限り、このフィールドは返されません。このブロックの |
key_value_pair |
KEY_VALUE_PAIR block_type に検出されたペア。DocumentType を指定しない限り、このフィールドはデフォルトで返されません。 |
merged_text |
このブロックで検出されたすべての UTF-8 テキスト。TextDetectionParams.block_filter で指定しない限り、このフィールドはデフォルトでは返されません。 |
BlockType
OCR で特定されたブロックのタイプ(テキスト、画像など)。
| 列挙型 | |
|---|---|
UNKNOWN |
不明なブロックタイプ。 |
TEXT |
標準テキスト ブロック。 |
TABLE |
テーブル ブロック。 |
PICTURE |
画像ブロック。 |
RULER |
水平線 / 垂直線ボックス。 |
BARCODE |
バーコード ブロック。 |
KEY_VALUE_PAIR |
Key-Value ペアのブロック。 |
BoundingPoly
検出された画像アノテーションの境界ポリゴン。
| フィールド | |
|---|---|
vertices[] |
境界ポリゴンの頂点。 |
normalized_vertices[] |
境界ポリゴンの正規化された頂点。 |
ColorInfo
カラー情報は、RGB チャネル、スコア、画像内でその色が占有する割合で構成されます。
| フィールド | |
|---|---|
color |
色の RGB 構成要素。 |
score |
この色の画像固有のスコア。値の範囲は [0, 1] です。 |
pixel_fraction |
画像でその色が占有するピクセルの割合。値の範囲は [0, 1] です。 |
CreateProductRequest
CreateProduct メソッドに対するリクエスト メッセージ。
| フィールド | |
|---|---|
parent |
Product が作成されるプロジェクト。 形式は |
product |
作成する商品。 |
product_id |
この Product のユーザー指定のリソース ID。設定すると、サーバーはこの値をリソース ID として使用します。すでに使用されている場合は、ALREADY_EXISTS コードとともにエラーが返されます。128 文字以内で指定してください。文字 |
CreateProductSetRequest
CreateProductSet メソッドに対するリクエスト メッセージ。
| フィールド | |
|---|---|
parent |
ProductSet が作成されるプロジェクト。 形式は |
product_set |
作成する ProductSet。 |
product_set_id |
この ProductSet のユーザー指定のリソース ID。設定すると、サーバーはこの値をリソース ID として使用します。すでに使用されている場合は、ALREADY_EXISTS コードとともにエラーが返されます。128 文字以内で指定してください。文字 |
CreateReferenceImageRequest
CreateReferenceImage メソッドに対するリクエスト メッセージ。
| フィールド | |
|---|---|
parent |
参照画像を作成する商品のリソース名。 形式は |
reference_image |
作成する参照画像。イメージ ID が指定されていない場合は、無視されます。 |
reference_image_id |
追加する ReferenceImage のユーザー指定のリソース ID。設定すると、サーバーはこの値をリソース ID として使用します。すでに使用されている場合は、ALREADY_EXISTS コードとともにエラーが返されます。128 文字以内で指定してください。文字 |
CropHint
画像を処理するときに新しいクロップを生成するために使用される 1 つのクロップヒント。
| フィールド | |
|---|---|
bounding_poly |
クロップ領域の境界ポリゴン。境界ボックスの座標は元の画像のスケールで示されます。 |
confidence |
注目領域であることの信頼度。範囲は [0, 1] です。 |
importance_fraction |
元の画像を基準にしたこの注目領域の重要度の割合。 |
CropHintsAnnotation
画像を処理するときに新しいクロップを生成するために使用されるクロップヒントのセット。
| フィールド | |
|---|---|
crop_hints[] |
クロップヒントの結果。 |
CropHintsParams
クロップヒント アノテーション リクエストのパラメータ。
| フィールド | |
|---|---|
aspect_ratios[] |
浮動小数点数で示されるアスペクト比。画像の幅対高さの比率を表します。たとえば、必要なアスペクト比が 4/3 の場合、対応する浮動小数点値は 1.33333 です。指定しない場合は、最適なクロップが返されます。指定できるアスペクト比の数は最大で 16 個です。17 番目以降のアスペクト比はすべて無視されます。 |
CustomEntityAnnotation
CustomEntityAnnotation には、Vision カスタムモデルを使用して予測されたアノテーションが含まれます。
| フィールド | |
|---|---|
model |
このアノテーションの作成に使用されるカスタムモデルを識別します。モデル名の形式は、クエリされたカスタムモデルのリソース URL( |
label |
カスタムモデルによって予測されたラベル。 |
score |
カスタムモデルによるラベルの信頼スコア。 |
DeleteProductRequest
DeleteProduct メソッドに対するリクエスト メッセージ。
| フィールド | |
|---|---|
name |
削除する商品のリソース名。 形式は |
DeleteProductSetRequest
DeleteProductSet メソッドに対するリクエスト メッセージ。
| フィールド | |
|---|---|
name |
削除する ProductSet のリソース名。 形式は |
DeleteReferenceImageRequest
DeleteReferenceImage メソッドに対するリクエスト メッセージ。
| フィールド | |
|---|---|
name |
削除する参照画像のリソース名。 形式:
|
DocumentParsingParams
DOCUMENT_PARSING 機能のパラメータ。
| フィールド | |
|---|---|
disable_orientation_detection |
回転されたテキストが検出されないように、方向の検出を無効にします。 |
table_detection_options |
テーブル検出の動作を制御します。このフィールドを設定しない場合、テーブル検出は無効になります。 |
document_type |
より深い構造検出を行う場合は、既知のドキュメント タイプを指定します。現時点で有効な値は invoice か general です。 |
DominantColorsAnnotation
ドミナント カラーとその対応するスコアのセット。
| フィールド | |
|---|---|
colors[] |
RGB カラーの値とそのスコアおよびピクセルの割合。 |
EntityAnnotation
検出されたエンティティの特徴のセット。
| フィールド | |
|---|---|
mid |
不透明エンティティの ID。一部の ID は Google Knowledge Graph Search API で使用できます。 |
locale |
エンティティ テキスト |
description |
エンティティ テキストの説明。 |
score |
結果の全体的なスコア。範囲は [0, 1] です。 |
confidence |
サポートを終了しました。代わりに |
topicality |
画像に対する ICA(Image Content Annotation)ラベルの関連度。たとえば、「Eiffel Tower」が検出された画像と遠方にある塔(Tower)が検出された画像の場合、塔があることの信頼度が同一であっても、「Tower」の関連度は「Eiffel Tower」が検出された画像の方が高くなります。範囲は [0, 1] です。 |
bounding_poly |
このエンティティが属する画像領域。 |
locations[] |
検出されたエンティティの位置情報。複数の |
properties[] |
エンティティの中には、エンティティを修飾するスコアや文字列など、オプションのユーザー指定 |
FaceAnnotation
顔アノテーション オブジェクトには、顔検出の結果が含まれます。
| フィールド | |
|---|---|
bounding_poly |
顔の輪郭の境界ポリゴン。境界ボックスの座標は元の画像のスケールで示されます。人間の顔と考えられる顔を「囲む」ため、境界ボックスが計算されます。これは、ランドマーカーの結果に基づいています。アノテーションが付けられる画像に顔の一部だけが表示される場合には、 |
fd_bounding_poly |
(顔検出)接頭辞が使用されます。 |
landmarks[] |
検出された顔ランドマーク。 |
roll_angle |
ロール角。これは、画像の垂直方向を基準に、顔の垂直軸が時計回り / 反時計回りで回転する量を示します。範囲は [-180,180] です。 |
pan_angle |
ヨー角。これは、画像の真正面方向を基準に、顔の真正面が向いている角度(左方向 / 右方向)を示します。範囲は [-180,180] です。 |
tilt_angle |
ピッチ角。これは、画像の水平方向を基準に、顔が向いている上方向 / 下方向の角度を示します。範囲は [-180,180] です。 |
detection_confidence |
検出の信頼度。範囲は [0, 1] です。 |
landmarking_confidence |
顔のランドマークの信頼度。範囲は [0, 1] です。 |
joy_likelihood |
喜んでいる可能性。 |
sorrow_likelihood |
悲しんでいる可能性。 |
anger_likelihood |
怒っている可能性。 |
surprise_likelihood |
驚いている可能性。 |
under_exposed_likelihood |
露出不足の可能性。 |
blurred_likelihood |
ピントが合っていない可能性。 |
headwear_likelihood |
ヘッドウェアを着けている可能性。 |
ランドマーク
顔特有のランドマーク(顔の特徴など)。
| フィールド | |
|---|---|
type |
顔のランドマークのタイプ。 |
position |
顔のランドマークの位置。 |
型
顔のランドマーク(特徴)のタイプ。左と右は、写真の一般的な鏡像投影を考慮せず、画像を見るユーザーの視点から定義されています。したがって 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 |
顎の右オトガイ点。 |
機能
実行する Google Cloud Vision API 検出のタイプ。そのタイプで返される結果の最大数。features リストでは複数の Feature オブジェクトを指定できます。
| フィールド | |
|---|---|
type |
機能のタイプ。 |
max_results |
このタイプの結果の最大数。 |
model |
この機能で使用するモデル。サポートされている値: builtin/stable(未設定の場合のデフォルト)、builtin/latest |
型
抽出される 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 |
ウェブ検出を実行します。 |
PRODUCT_SEARCH |
Product Search を実行します。 |
CUSTOM_LABEL_DETECTION |
カスタムラベル検出を実行します。 |
OBJECT_LOCALIZATION |
オブジェクト検出のために localizer を実行します。 |
IMAGE_QUALITY |
品質スコアラーを実行します。 |
OBJECT_ATTRIBUTES |
画像内で検出されたオブジェクトの属性を計算します。オブジェクトの 4 つのドメインがサポートされています。Feature.model で、builtin/apparel、builtin/car、builtin/food、builtin/nativelife のいずれかを選択してください(必須)。 |
QUALITY_OPTIMIZATION |
品質最適化アルゴリズムを実行します。オペレーションには、COMPRESSION、ENHANCEMENT、QUALITY_SCORE の 3 種類があります。COMPRESSION と ENHANCEMENT パラメータ、QUALITY_SCORE モデルの選択は、image_context.quality_optimization_params で指定できます。 |
BARCODE_DETECTION |
バーコード検出と認識を実行します。 |
DOCUMENT_PARSING |
ドキュメント解析アルゴリズムを実行して、テーブルやフォームなどの構造化データを抽出します。結果は full_text_annotation -> page -> block にあります。テーブルの場合は TABLE、フォーム内の Key-Value ペアの場合は KEY_VALUE_PAIR タイプになります。 |
GcsDestination
出力の書き込み先とする Google Cloud Storage のロケーション。
| フィールド | |
|---|---|
uri |
結果が保存される Google Cloud Storage URI。結果は JSON 形式で、対応する入力 URI が先頭に付加されます。このフィールドは、単一ファイルまたは複数出力の接頭辞を表します。接頭辞は 例:
複数の出力がある場合、各レスポンスは AnnotateFileResponse で、各レスポンスには、AnnotateImageResponse の全リストのサブセットが含まれます。たとえば、出力 JSON が大きすぎて複数の分割ファイルにオーバーフローする場合は、複数の出力が発生する可能性があります。 |
GcsSource
入力の読み取り元となる Google Cloud Storage のロケーション。
| フィールド | |
|---|---|
uri |
入力ファイルの Google Cloud Storage URI。これは Google Cloud Storage オブジェクトにする必要があります。現在、ワイルドカードはサポートされていません。 |
GetProductRequest
GetProduct メソッドに対するリクエスト メッセージ。
| フィールド | |
|---|---|
name |
取得する Product のリソース名。 形式は |
GetProductSetRequest
GetProductSet メソッドに対するリクエスト メッセージ。
| フィールド | |
|---|---|
name |
取得する ProductSet のリソース名。 形式は |
GetReferenceImageRequest
GetReferenceImage メソッドに対するリクエスト メッセージ。
| フィールド | |
|---|---|
name |
取得する ReferenceImage のリソース名。 形式:
|
画像
Google Cloud Vision API タスクの実行対象クライアント画像。
| フィールド | |
|---|---|
content |
バイト ストリームとして表される画像コンテンツ。注: すべての |
source |
Google Cloud Storage の画像の場所、または一般にアクセス可能な画像の URL。1 つの画像に対して |
ImageAnnotationContext
ファイルから(PDF など)画像が生成された場合は、このメッセージに画像のソースに関する情報が表示されます。
| フィールド | |
|---|---|
uri |
画像の生成に使用されるファイルの URI。 |
page_number |
ファイルが PDF または TIFF の場合、このフィールドには、画像の生成に使用されたファイル内のページ番号が示されます。 |
ImageContext
画像コンテキストおよび機能固有のパラメータ。
| フィールド | |
|---|---|
lat_long_rect |
使用されません。 |
language_hints[] |
TEXT_DETECTION に使用する言語のリスト。ほとんどの場合、値を空にして自動言語検出を有効にしておくことによって最善の結果が得られます。ラテン アルファベット系の言語の場合、 |
crop_hints_params |
クロップヒント アノテーション リクエストのパラメータ。 |
product_search_params |
Product Search のパラメータ。 |
web_detection_params |
ウェブ検出のパラメータ。 |
text_detection_params |
ドキュメント テキスト検出のパラメータ。 |
quality_optimization_params |
画像品質最適化のパラメータ。 |
document_parsing_params |
ドキュメント解析のパラメータ。 |
ImageProperties
ドミナント カラーなどの画像プロパティを格納します。
| フィールド | |
|---|---|
dominant_colors |
存在する場合、ドミナント カラーが正常に完了しました。 |
ImageQuality
画像の品質スコアを保存します。美的品質または技術品質です。
| フィールド | |
|---|---|
quality_score |
画像の外観の美しさ、技術的な質を表すスコア。スコアの範囲は [0, 1] です。値が大きいほど、プロフェッショナルな写真になります。0 は画像がかなり悪いことを表し、1 は高品質の画像であることを示します。 |
ImageSource
外部画像ソース(Google Cloud Storage またはウェブ URL イメージの場所)。
| フィールド | |
|---|---|
gcs_image_uri |
代わりに
|
image_uri |
ソース画像の URI。以下のいずれかです。
|
ImportProductSetsGcsSource
各行に ImportProductSetRequests のリストを保持する csv ファイルが存在する Google Cloud Storage のロケーション。
| フィールド | |
|---|---|
csv_file_uri |
入力 csv ファイルの Google Cloud Storage の URI。 URI は、 入力 csv ファイルでは、各行に画像が 1 つ含まれている必要があります。各行には次の 8 つの列があります。
画像の解像度が高すぎる(20MP を超える)場合は、画像のサイズが変更されます。 |
ImportProductSetsInputConfig
ImportProductSets メソッドの入力コンテンツ。
| フィールド | |
|---|---|
gcs_source |
各行に ImportProductSetRequests のリストを保持する csv ファイルが存在する Google Cloud Storage のロケーション。 |
ImportProductSetsRequest
ImportProductSets メソッドに対するリクエスト メッセージ。
| フィールド | |
|---|---|
parent |
ProductSets がインポートされるプロジェクト。 形式は |
input_config |
リクエスト リストの入力コンテンツ。 |
ImportProductSetsResponse
ImportProductSets メソッドに対するレスポンス メッセージ。
このメッセージは、google.longrunning.Operations.GetOperation メソッドによって google.longrunning.Operation.response フィールドで返されます。
| フィールド | |
|---|---|
reference_images[] |
正常にインポートされた reference_images のリスト。 |
statuses[] |
各 ImportProductSet リクエストの RPC ステータス(成功とエラーの両方)。 ここに示されるステータスの数は csv ファイルの行数と一致し、statuses[i] は CSV ファイルの i 行目の処理の成否ステータスを 0 から順に格納します。 |
InputConfig
目的の入力ロケーションとメタデータ。
| フィールド | |
|---|---|
gcs_source |
入力の読み取り元の Google Cloud Storage のロケーション。 |
content |
バイト ストリームとして表されるファイル コンテンツ。注: すべての 現在、このフィールドは BatchAnnotateFiles リクエストでのみ機能します。AsyncBatchAnnotateFiles リクエストでは機能しません。 |
mime_type |
ファイルのタイプ。現在は、application/pdf と image/tiff のみがサポートされています。ワイルドカードはサポートされていません。 |
KeyValuePair
Key-Value ペアの Proto。
| フィールド | |
|---|---|
key |
キー文字列の値。 |
key_block |
正規化された境界ボックスとキーテキストを含むペアのキーブロック。 |
value_block |
正規化された境界ボックスと値テキストを含むペアの値ブロック。値テキスト内のより深い構造を含む可能性があります。 |
value_type |
値の型。有効な文字列は次のとおりです。 generic - 値にマッピングされる汎用テキスト。number - 数値型、id - 汎用識別子。currency - 通貨の値。date - 日付。time - 時間と期間の値。date_range - 期間。address - アドレス値(長い場合もあります)。person - 人の名前またはその他の個人識別子。phone - 電話番号。 |
normalized_key |
(省略可)正規化されたキーテキスト(テキストが一般的で、分類されている場合)。 たとえば、TOTAL DUE は Total amount に正規化されます。 |
LatLongRect
最小および最大 LatLng のペアにより決定する長方形。
| フィールド | |
|---|---|
min_lat_lng |
最小緯度 / 経度ペア。 |
max_lat_lng |
最大緯度/経度ペア。 |
Likelihood
バケット化された可能性の表現。これは、モデルのアップグレードで非常に安定した結果をクライアントに提供することを目的としています。
| 列挙型 | |
|---|---|
UNKNOWN |
不明な可能性。 |
VERY_UNLIKELY |
指定されたカテゴリに画像が属している可能性はほとんどありません。 |
UNLIKELY |
指定されたカテゴリに画像が属している可能性は低いです。 |
POSSIBLE |
指定されたカテゴリに画像が属している可能性があります。 |
LIKELY |
指定されたカテゴリに画像が属している可能性は高いです。 |
VERY_LIKELY |
指定されたカテゴリに画像が属している可能性は非常に高いです。 |
ListProductSetsRequest
ListProductSets メソッドに対するリクエスト メッセージ。
| フィールド | |
|---|---|
parent |
ProductSets が一覧表示されるプロジェクト。 形式は |
page_size |
返される最大アイテム数。デフォルト 10、最大 100。 |
page_token |
前の List リクエストから返された next_page_token(存在する場合)。 |
ListProductSetsResponse
ListProductSets メソッドに対するレスポンス メッセージ。
| フィールド | |
|---|---|
product_sets[] |
ProductSets のリスト。 |
next_page_token |
結果の次のページを取得するためのトークン。リストにそれ以上の結果がない場合は空です。 |
ListProductsInProductSetRequest
ListProductsInProductSet メソッドに対するリクエスト メッセージ。
| フィールド | |
|---|---|
name |
Products を取得する ProductSet リソース。 形式は |
page_size |
返される最大アイテム数。デフォルト 10、最大 100。 |
page_token |
前の List リクエストから返された next_page_token(存在する場合)。 |
ListProductsInProductSetResponse
ListProductsInProductSet メソッドに対するレスポンス メッセージ。
| フィールド | |
|---|---|
products[] |
Products のリスト。 |
next_page_token |
結果の次のページを取得するためのトークン。リストにそれ以上の結果がない場合は空です。 |
ListProductsRequest
ListProducts メソッドに対するリクエスト メッセージ。
| フィールド | |
|---|---|
parent |
Products が一覧表示されるプロジェクトまたは ProductSet。 形式: |
page_size |
返される最大アイテム数。デフォルト 10、最大 100。 |
page_token |
前の List リクエストから返された next_page_token(存在する場合)。 |
ListProductsResponse
ListProducts メソッドに対するレスポンス メッセージ。
| フィールド | |
|---|---|
products[] |
商品のリスト。 |
next_page_token |
結果の次のページを取得するためのトークン。リストにそれ以上の結果がない場合は空です。 |
ListReferenceImagesRequest
ListReferenceImages メソッドに対するリクエスト メッセージ。
| フィールド | |
|---|---|
parent |
参照画像が含まれる商品のリソース名。 形式は |
page_size |
返される最大アイテム数。デフォルト 10、最大 100。 |
page_token |
返される結果のページを特定するトークンです。これは、前の参照画像の list リクエストで返された 指定しない場合、デフォルトで先頭ページになります。 |
ListReferenceImagesResponse
ListReferenceImages メソッドに対するレスポンス メッセージ。
| フィールド | |
|---|---|
reference_images[] |
参照画像のリスト。 |
page_size |
返される最大アイテム数。デフォルト 10、最大 100。 |
next_page_token |
前の List リクエストから返された next_page_token(存在する場合)。 |
LocalizedBarcodeAnnotation
検出された境界ボックス付きバーコードのセット。
| フィールド | |
|---|---|
format |
バーコードの形式は次のとおりです。サポートされている形式: CODE_128: Code 128 タイプ。CODE_39: Code 39 タイプ。CODE_93: Code 93 タイプ。CODABAR: Codabar タイプ。DATA_MATRIX: 2D データ行列タイプ。ITF: ITF タイプ。EAN_13: EAN-13 タイプ。EAN_8: EAN-8 タイプ。QR_CODE: 2D QR コードタイプ。UPC_A: UPC-A タイプ。UPC_E: UPC-E タイプ。PDF417: PDF417 タイプ。AZTEC: 2D Aztec コードタイプ。DATABAR: GS1 DataBar コードタイプ。 |
value_format |
バーコード値の形式は、バーコードがエンコードする値の形式を記述します。サポートされている値の形式: CONTACT_INFO: 連絡先情報。EMAIL: メールアドレス。ISBN: ISBN 識別子。PHONE: 電話番号。PRODUCT: 商品。SMS: SMS メッセージ。TEXT: テキスト文字列。URL: URL アドレス。WIFI: Wi-Fi 情報。GEO: 地理的ローカライズ(経度と緯度)CALENDAR_EVENT: カレンダーの予定。DRIVER_LICENSE: 運転免許証。 |
value |
バーコードでキャプチャされた ASCII 値のバーコード値。バーコードは構造化された値をエンコードできます。たとえば、'MEBKM:TITLE:Google;URL:https://www.google.com;;' となります。 |
confidence |
結果の信頼値。範囲は [0, 1] です。 |
bounding_poly |
このバーコードが属する画像領域。この値は入力する必要があります。 |
LocalizedObjectAnnotation
検出された境界ボックス付きオブジェクトのセット。
| フィールド | |
|---|---|
mid |
EntityAnnotation mid と一致するオブジェクト ID。 |
language_code |
「en-US」や「sr-Latn」などの BCP-47 言語コード。詳細については、http://www.unicode.org/reports/tr35/#Unicode_locale_identifier をご覧ください。 |
name |
オブジェクト名。 |
score |
結果のスコア。範囲は [0, 1] です。 |
bounding_poly |
このオブジェクトが属する画像領域。この値は入力する必要があります。 |
LocationInfo
検出されたエンティティの位置情報。
| フィールド | |
|---|---|
lat_lng |
緯度 / 経度での位置座標。 |
NormalizedVertex
頂点は、画像上の 2D の点を表します。注: 正規化された頂点座標は、元の画像と相対しており、0~1 の範囲になります。
| フィールド | |
|---|---|
x |
X 座標。 |
y |
Y 座標。 |
OperationMetadata
BatchAnnotateImages オペレーションのメタデータが含まれます。
| フィールド | |
|---|---|
state |
バッチ オペレーションの現在の状態。 |
create_time |
バッチ リクエストを受信した時刻。 |
update_time |
オペレーション結果が最後に更新された時刻。 |
状態
バッチ オペレーションの状態。
| 列挙型 | |
|---|---|
STATE_UNSPECIFIED |
無効。 |
CREATED |
リクエストが受信されました。 |
RUNNING |
リクエストがアクティブに処理されています。 |
DONE |
バッチ処理が完了しました。 |
CANCELLED |
バッチ処理がキャンセルされました。 |
OutputConfig
目的の出力場所とメタデータ。
| フィールド | |
|---|---|
gcs_destination |
出力を書き込む Google Cloud Storage の場所。 |
batch_size |
Google Cloud Storage の各出力 JSON ファイルに追加するレスポンス proto の最大数。有効な範囲は [1, 100] です。指定しない場合、デフォルト値は 20 です。 たとえば、100 ページの PDF の場合、100 個のレスポンス proto が生成されます。 現在、batch_size は GcsDestination にのみ適用されますが、将来的には他の出力構成もサポートされます。 |
ページ
OCR から検出されたページ。
| フィールド | |
|---|---|
property |
ページで検出された追加情報。 |
width |
ページの幅。PDF の場合、単位はポイントです。画像(TIFF を含む)の場合、単位はピクセルです。 |
height |
ページの高さ。PDF の場合、単位はポイントです。画像(TIFF を含む)の場合、単位はピクセルです。 |
blocks[] |
このページのテキスト、画像などのブロックのリスト。 |
confidence |
ページの OCR 結果の信頼度。範囲は [0, 1] です。 |
merged_text |
このページで検出されたすべての UTF-8 テキスト。TextDetectionParams.page_filter で指定しない限り、このフィールドはデフォルトでは返されません。 |
段落
多数の単語を特定の順序で示すテキストの構造単位。
| フィールド | |
|---|---|
property |
段落について検出された追加情報。 |
bounding_box |
段落の境界ボックス。頂点は、左上、右上、右下、左下の順に並んでいます。境界ボックスの回転が検出された場合、回転はテキストを「自然な」方向で読み取るときの左上隅を中心と定義して表されます。例: * テキストが水平の場合、0----1 | | 3----2 なります。* 左上隅を中心に 180 度回転すると、2----3 | | 1----0 となり、頂点の順序は(0、1、2、3)のままです。 |
words[] |
この段落の単語のリスト。 |
confidence |
この段落の OCR 結果の信頼度。範囲は [0, 1] です。 |
merged_text |
この段落で検出されたすべての UTF-8 テキスト。TextDetectionParams.paragraph_filter で指定しない限り、このフィールドはデフォルトでは返されません。 |
Position
画像で、主に顔検出ランドマークに使用される 3D 位置。有効な Position には、x 座標と y 座標の両方が指定されているはずです。位置の座標は元の画像と同じスケールです。
| フィールド | |
|---|---|
x |
X 座標。 |
y |
Y 座標。 |
z |
Z 座標(または深さ)。 |
Product
Product には ReferenceImages が含まれます。
| フィールド | |
|---|---|
name |
商品のリソース名。 形式: 商品の作成では、このフィールドは無視されます。 |
display_name |
この Product のユーザー指定の名前。空にすることはできません4,096 文字以内で指定してください。 |
description |
この商品とともに保存されるユーザー提供のメタデータ。4,096 文字以内で指定してください。 |
product_category |
参照画像によって特定する商品のカテゴリ。homegoods、apparel、toys のいずれかを指定します。 このフィールドは変更できません。 |
product_labels[] |
商品に関連付けることができる Key-Value ペア。クエリ時に、product_labels に基づいて制約を指定できます。 整数値は「1199」のように、文字列として指定できます。整数値が含まれる文字列のみが範囲ベースの制限と一致します。これは間もなくサポートされます。 複数の値を同じキーに割り当てることができます。1 つの商品に最大 100 個の product_labels を設定できます。 |
KeyValue
Key-Value ペアとして表される商品ラベル。
| フィールド | |
|---|---|
key |
商品に適用されたラベルのキー。空白にすることはできません。128 バイト以下にする必要があります。 |
value |
商品に適用されたラベルの値。空白にすることはできません。128 バイト以下にする必要があります。 |
ProductSearchParams
Product Search リクエストのパラメータ。
| フィールド | |
|---|---|
bounding_poly |
画像内の関心領域を囲む境界ポリゴン。省略可。指定しない場合は、自動的に適用されます。 |
product_set |
類似画像を検索する 形式: |
product_categories[] |
検索する商品カテゴリのリスト。現在、最初のカテゴリのみが考慮されます。homegoods、apparel、toys のいずれかを指定する必要があります。 |
filter |
フィルタ式。商品ラベルに基づいて検索結果を制限できます。現在、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 |
これらの結果を生成したインデックスのタイムスタンプ。この時間以降に行われた変更は、現在の結果には反映されません。 |
results[] |
一致する商品の結果リスト(商品ごとに 1 つ)。 |
product_grouped_results[] |
クエリ画像で検出された商品別にグループ化された結果のリスト。各エントリはクエリ画像内の 1 つの境界ポリゴンに対応し、その領域に固有の一致商品が含まれます。商品ごとのすべての検索結果では、重複した商品が存在する可能性があります。 |
GroupedResult
クエリ画像に含まれる 1 つの商品に類似する商品に関する情報。
| フィールド | |
|---|---|
bounding_poly |
クエリ画像で検出された商品を囲む境界ポリゴン。 |
results[] |
一致する商品の結果リスト(商品ごとに 1 つ)。 |
object_annotations[] |
境界ボックス内のオブジェクトの汎用予測のリスト。 |
ObjectAnnotation
境界ボックス内のオブジェクトの予測。
| フィールド | |
|---|---|
mid |
EntityAnnotation mid と一致するオブジェクト ID。 |
language_code |
「en-US」や「sr-Latn」などの BCP-47 言語コード。詳細については、http://www.unicode.org/reports/tr35/#Unicode_locale_identifier をご覧ください。 |
name |
オブジェクト名。 |
score |
結果のスコア。範囲は [0, 1] です。 |
結果
商品に関する情報。
| フィールド | |
|---|---|
product |
Product。 |
score |
一致の信頼度レベル。0(最低の信頼度)から 1(最高の信頼度)の範囲になります。 |
image |
クエリに最も一致する商品の画像のリソース名。 |
ProductSet
ProductSet には Products が含まれています。ProductSet には、最大 100 万個の参照画像を含めることができます。上限を超えた場合、定期的なインデックス登録は失敗します。
| フィールド | |
|---|---|
name |
ProductSet のリソース名。 形式: ProductSet の作成では、このフィールドは無視されます。 |
display_name |
この ProductSet のユーザー指定の名前。空にすることはできません4,096 文字以内で指定してください。 |
index_time |
出力のみ。この ProductSet が最後にインデックス登録された時刻。クエリの結果には、この日時より前に行われたすべての更新が反映されます。この ProductSet がインデックスに登録されていない場合、タイムスタンプはデフォルト値の 1970-01-01T00:00:00Z になります。 ProductSet の作成では、このフィールドは無視されます。 |
index_error |
出力のみ。商品セットのインデックス登録中にエラーが発生した場合は、このフィールドにデータが入力されます。 ProductSet の作成では、このフィールドは無視されます。 |
プロパティ
Property は、ユーザー指定の名前と値のペアで構成されます。
| フィールド | |
|---|---|
name |
プロパティの名前。 |
value |
プロパティの値。 |
uint64_value |
数値プロパティの値。 |
confidence |
値の範囲は [0..1] です。このプロパティ値の信頼度。 |
mid |
不透明プロパティ値の ID。一部の ID は Google Knowledge Graph Search API で使用できます。青いコートのサンプル プロパティ: Property { name: 'color' value: 'blue' mid: '/m/01g5v' // 青色の場合 } |
QualityOptimizationParams
画像品質最適化のパラメータ。
| フィールド | |
|---|---|
type |
最適化タイプを 1 つ選択します。 |
compression_config |
圧縮構成を指定します。 |
enhancement_config |
自動補正の構成を指定します。 |
quality_score_config |
品質スコアの構成を指定します。 |
CompressionConfig
COMPRESSION の構成。
| フィールド | |
|---|---|
target_quality |
範囲は [0, 1] です。圧縮後のターゲットの品質。1 は、入力画像と比べて損失がないことを意味します。0 は、最小品質要件がないことを意味します。 |
EnhancementConfig
ENHANCMENT の構成。enhancedment_config を指定していない場合、デフォルト値 shaenening_level が 0.5 に、auto_hdr_level が 0.5、premium_ratio が 1 になります。これらのパラメータのいずれかをカスタマイズする場合は、EnhancementConfig 全体を指定する必要があります。たとえば、auto_hdr_level の値を高めにすると、画像が明るくなり、シャープ処理レベルとスケールアップ率がデフォルトになります。この場合、enhancement_config { sharpening_level: 0.5 auto_hdr_level: 1.0 upscale_ratio: 1 } のように構成を設定します。
| フィールド | |
|---|---|
sharpening_level |
範囲は [0,1] です。シャープ処理のレベル。0 はシャープ処理なし、1 は最大のシャープ処理レベルを意味します。デフォルト値は 0.5 です。 |
auto_hdr_level |
範囲は [0,1] です。自動 HDR のレベル。0 は自動 HDR なし、1 は最大の AutoHDR を意味します。デフォルト値は 0.5 です。 |
upscale_ratio |
範囲は [1, 2] です。アップスケーリングを行うかどうか。デフォルト値は 1 で、この場合、アップスケーリングは行われません。指定すると、出力の高さと幅は、元の高さと幅に upscale_ratio を掛けた値と同じになります。 |
QualityScoreConfig
QUALITY_SCORE の構成。
| フィールド | |
|---|---|
quality_model |
使用するモデルを指定します。デフォルト値は空の文字列で、美的スコアが返されます。サポートしているもう一つの品質モデルは builtin/Technical-score で、これは画像の技術的な品質を返します。 |
タイプ
品質最適化タイプの列挙型。
| 列挙型 | |
|---|---|
TYPE_UNSPECIFIED |
無効。1 つの Type を選択する必要があります。 |
COMPRESSION |
画像ファイルのサイズを小さくします。CompressionConfig で指定された詳細なパラメータ。CompressionConfig を指定しなかった場合、画像ファイルのサイズは小さくなりますが、画質は低下しません。CompressionConfig を指定すると、CompressionParams.target_quality を維持しながらファイルサイズを縮小できます。 |
ENHANCEMENT |
ノイズ除去、シャープ、HDR、アップスケーリング。EnhancementConfig で指定された詳細なパラメータ。EnhancmentConfig を指定しない場合は、デフォルト値を使用して画像補正を行います。upscale_ratio が指定されていない場合、出力画像の解像度は入力画像と同じになります。 |
QUALITY_SCORE |
画像の品質スコアをクエリします。QualityScoreConfig で指定された詳細なパラメータ。QualityScoreConfig を指定しなかった場合、画像の外観スコアが返されます。 |
QualityOptimizationResult
補正された画像のバイトを格納します。
| フィールド | |
|---|---|
quality_optimization_type |
必須の最適化タイプ。 |
image |
最適化された画像のバイト数。 |
mime_type |
出力画像の MIME タイプ。 |
ReferenceImage
ReferenceImage は、商品画像とそれに関連するメタデータ(境界ボックスなど)を表します。
| フィールド | |
|---|---|
name |
参照画像のリソース名。 形式:
参照画像を作成する場合、このフィールドは無視されます。 |
uri |
参照画像の Google Cloud Storage URI。 URI は、 必須。 |
bounding_polys[] |
参照画像内の関心領域を囲む境界ポリゴン。省略可。このフィールドが空の場合、システムは関心領域の検出を試みます。境界ポリゴンは、最大 10 個使用されます。 指定したシェイプは、回転しない長方形に変換されます。変換後、長方形の小さい端を 300 ピクセル以上にする必要があります。アスペクト比は 1:4 以下でなければなりません(1:3 は許容されますが、1:5 は許容されません)。 |
RemoveProductFromProductSetRequest
RemoveProductFromProductSet メソッドに対するリクエスト メッセージ。
| フィールド | |
|---|---|
name |
変更する ProductSet のリソース名。 形式は |
product |
この ProductSet から削除する Product のリソース名。 形式は |
SafeSearchAnnotation
画像の特徴のセット。これらの特徴は、セーフサーチ カテゴリ(アダルト、パロディ、医療、暴力など)に関してコンピュータ ビジョン メソッドにより計算されます。
| フィールド | |
|---|---|
adult |
画像がアダルト コンテンツである可能性を表します。アダルト コンテンツには、ヌード、ポルノ画像や漫画、性行為などの要素が含まれている可能性があります。 |
spoof |
パロディの可能性。これは、面白くするため、または侮辱的にするため、正規の画像が改ざんされた可能性です。 |
medical |
医療画像である可能性。 |
violence |
この画像に暴力的なコンテンツが含まれている可能性。 |
racy |
リクエスト画像に露骨なコンテンツが含まれている可能性。露骨な内容には、露出度の高い服や薄手の服、意図的に一部が覆われたヌード、猥褻または挑発的なポーズ、または局部のクローズアップなどがあります。 |
記号
1 つの記号表現。
| フィールド | |
|---|---|
property |
記号について検出された追加情報。 |
bounding_box |
記号の境界ボックス。頂点は、左上、右上、右下、左下の順に並んでいます。境界ボックスの回転が検出された場合、回転はテキストを「自然な」方向で読み取るときの左上隅を中心と定義して表されます。例: * テキストが水平の場合、0----1 | | 3----2 なります。* 左上隅を中心に 180 度回転すると、2----3 | | 1----0 となり、頂点の順序は(0、1、2、3)のままです。 |
text |
記号の実際の UTF-8 表現。 |
confidence |
記号の OCR 結果の信頼度。範囲は [0, 1] です。 |
テーブル
HTML のテーブル構造に類似したテーブル表現。
| フィールド | |
|---|---|
header_rows[] |
テーブルのヘッダー行 |
body_rows[] |
テーブルの本文行 |
TableCell
テーブル内のセル表現。
| フィールド | |
|---|---|
row_span |
このセルがまたがっている行の数。 |
col_span |
このセルがまたがっている列の数。 |
text_block |
このセルのテキスト ブロック。セルの正規化された境界ボックスとセル内のより深い構造(存在する場合)が含まれます。 |
text |
このセルの結合されたテキストの値。 |
TableRow
テーブルセルの行。
| フィールド | |
|---|---|
cells[] |
この行を構成するセル。 |
TableBoundHint
テーブル解析用のページに対するテーブル境界ボックスのヒント。
| フィールド | |
|---|---|
page_number |
このヒントが適用される複数のページ入力のページ番号(省略可)。指定しなかった場合、このヒントはデフォルトですべてのページに適用されます。この値は、1 から始まるインデックスです。 |
bounding_box |
このページのテーブルに対する境界ボックスのヒント。座標は [0,1] に正規化され、境界ボックスは軸を合わせた長方形になります。 |
TableDetectionOptions
テーブル検出のオプション。
| フィールド | |
|---|---|
table_bound_hints[] |
アルゴリズムでテーブルの場所を特定できない複雑なケースで表示されるオプションのテーブル境界ボックスのヒント。 |
TextAnnotation
TextAnnotation には、OCR 抽出テキストの構造化表現が含まれています。OCR 抽出テキスト構造の階層は、TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol のようになります。Page 以降の各構造コンポーネントには独自のプロパティが設定されていることがあります。プロパティは、検出された言語、区切りなどを記述します。詳しくは、以下の TextAnnotation.TextProperty メッセージの定義をご覧ください。
| フィールド | |
|---|---|
pages[] |
OCR によって検出されたページのリスト。 |
text |
ページで検出された UTF-8 テキスト。 |
DetectedBreak
検出された構造コンポーネントの開始または終了。
| フィールド | |
|---|---|
type |
検出された区切りのタイプ。 |
is_prefix |
区切りが要素の前にある場合は True。 |
BreakType
検出された区切りのタイプを示す列挙型。改行、スペースなどです。
| 列挙型 | |
|---|---|
UNKNOWN |
不明な区切りラベルタイプ。 |
SPACE |
標準スペース。 |
SURE_SPACE |
広幅のスペース。 |
EOL_SURE_SPACE |
行折り返しの区切り。 |
HYPHEN |
テキストに存在しない行末ハイフン。SPACE、LEADER_SPACE、LINE_BREAK と組み合わせて出現することはありません。 |
LINE_BREAK |
段落を終了する改行。 |
DetectedLanguage
検出された構造コンポーネントの言語。
| フィールド | |
|---|---|
language_code |
「en-US」や「sr-Latn」などの BCP-47 言語コード。詳細については、http://www.unicode.org/reports/tr35/#Unicode_locale_identifier をご覧ください。 |
confidence |
検出された言語の信頼度。範囲は [0, 1] です。 |
TextProperty
構造コンポーネントで検出された追加情報。
| フィールド | |
|---|---|
detected_languages[] |
検出された言語と信頼度のリスト。 |
detected_break |
検出されたテキスト セグメントの開始または終了。 |
TextDetectionParams
テキスト検出のパラメータ。TEXT_DETECTION 機能と DOCUMENT_TEXT_DETECTION 機能の制御に使用されます。
| フィールド | |
|---|---|
disable_orientation_detection |
回転されたテキストが検出されないように、方向の検出を無効にします。これは DOCUMENT_TEXT_DETECTION でのみサポートされています。 |
disable_text_annotations |
古い text_annotations フィールドを無効にします。full_text_annotations のみが返されます。 |
page_filter |
full_text_annotation のページレベルで返されるデータを制御します。未設定の場合のデフォルト: すべてのフィールドが含まれます。 |
block_filter |
full_text_annotation によりブロックレベルで返されるデータを制御します。未設定の場合のデフォルト: |
paragraph_filter |
full_text_annotation で段落レベルで返されるデータを制御します。未設定の場合のデフォルト: |
word_filter |
full_text_annotation で単語レベルで返されるデータを制御します。未設定の場合のデフォルト: |
symbol_filter |
full_text_annotation によりシンボルレベルで返されるデータを制御します。未設定の場合のデフォルト: |
UpdateProductRequest
UpdateProduct メソッドに対するリクエスト メッセージ。
| フィールド | |
|---|---|
product |
サーバー上のリソースを置き換える Product リソース。product.name は変更できません。 |
update_mask |
更新するフィールドを指定する |
UpdateProductSetRequest
UpdateProductSet メソッドに対するリクエスト メッセージ。
| フィールド | |
|---|---|
product_set |
サーバー上のリソースを置き換える ProductSet リソース。 |
update_mask |
更新するフィールドを指定する |
Vertex
頂点は、画像上の 2D の点を表します。注: 頂点の座標は元の画像と同じスケールです。
| フィールド | |
|---|---|
x |
X 座標。 |
y |
Y 座標。 |
WebDetection
インターネットからの画像に関する関連情報。
| フィールド | |
|---|---|
web_entities[] |
インターネット上の類似画像から推測されたエンティティ。 |
full_matching_images[] |
完全に一致するインターネット上の画像。クエリ画像のサイズを変更したコピーも含まれます。 |
partial_matching_images[] |
部分的に一致するインターネットの画像。これらの画像は十分に類似しており、いくつかの主要な特徴を共有しています。たとえば、元の画像とそのクロップした画像とは部分一致する可能性があります。 |
pages_with_matching_images[] |
一致するインターネットの画像を含むウェブページ。 |
visually_similar_images[] |
視覚的に類似した画像結果。 |
best_guess_labels[] |
サービスが、リクエスト画像のトピックに最も近いとする推測です。オープンウェブ上の類似画像から推定されます。 |
WebEntity
インターネット上の類似画像から推測されたエンティティ。
| フィールド | |
|---|---|
entity_id |
不透明エンティティ ID。 |
score |
エンティティの全体的な関連性スコア。正規化されておらず、異なる画像クエリ間で比較することはできません。 |
description |
エンティティの標準的な説明(英語)。 |
WebImage
オンライン画像のメタデータ。
| フィールド | |
|---|---|
url |
結果画像の URL。 |
score |
(非推奨)画像の全体的な関連性スコア。 |
WebLabel
ウェブ検出のための追加メタデータを提供するラベル。
| フィールド | |
|---|---|
label |
追加メタデータのラベル。 |
language_code |
「en-US」や「sr-Latn」などの |
WebPage
ウェブページのメタデータ。
| フィールド | |
|---|---|
url |
結果のウェブページの URL。 |
score |
(非推奨)ウェブページの全体的な関連性スコア。 |
page_title |
ウェブページのタイトル。HTML マークアップが含まれていることがあります。 |
full_matching_images[] |
ページ上の完全一致画像。クエリ画像のサイズを変更したコピーも含まれます。 |
partial_matching_images[] |
ページ上の部分一致画像。これらの画像は十分に類似しており、いくつかの主要な特徴を共有しています。たとえば、元の画像とそのクロップした画像とは部分一致する可能性があります。 |
WebDetectionParams
ウェブ検出リクエストのパラメータ。
| フィールド | |
|---|---|
include_geo_results |
地理情報から得られた結果を画像に組み込むかどうか。 |
Word
単語の表現。
| フィールド | |
|---|---|
property |
単語について検出された追加情報。 |
bounding_box |
単語の境界ボックス。頂点は、左上、右上、右下、左下の順に並んでいます。境界ボックスの回転が検出された場合、回転はテキストを「自然な」方向で読み取るときの左上隅を中心と定義して表されます。例: * テキストが水平の場合、0----1 | | 3----2 なります。* 左上隅を中心に 180 度回転すると、2----3 | | 1----0 となり、頂点の順序は(0、1、2、3)のままです。 |
symbols[] |
単語内の記号のリスト。記号の順序は、自然な読み順に従います。 |
confidence |
単語に対する OCR 結果の信頼度。範囲は [0, 1] です。 |
merged_text |
この単語で検出されたすべての UTF-8 テキスト。TextDetectionParams.word_filter で指定しない限り、このフィールドはデフォルトでは返されません。 |