Image Analysis - Analyze Stream

リファレンス

サービス:: Azure AI Services

API バージョン:: 2023-04-01-preview

入力イメージを分析します。要求には、任意のコンテンツタイプ ['image/*'、'application/octet-stream']を持つ画像ストリーム、または画像ストリームの取得に使用する URL プロパティを含む JSON ペイロードが含まれます。

POST /imageanalysis:analyze?overload=stream&api-version=2023-04-01-preview

省略可能なパラメーターを含む:

POST /imageanalysis:analyze?overload=stream&features={features}&model-name={model-name}&language={language}&smartcrops-aspect-ratios={smartcrops-aspect-ratios}&gender-neutral-caption={gender-neutral-caption}&api-version=2023-04-01-preview

URI パラメーター

名前	/	必須	型	説明
api-version	query	True	string	要求された API バージョン。
features	query		VisualFeature[]	要求されるビジュアル機能: タグ、オブジェクト、キャプション、denseCaptions、read、smartCrops、people。パラメーター "model-name" が指定されていない場合は、このパラメーターを指定する必要があります。
gender-neutral-caption	query		boolean	キャプション機能と denseCaptions 機能に対して性別に依存しないキャプションを有効にするブール型フラグ。このパラメーターを指定しない場合、既定値は "false" になります。
language	query		string	出力生成に必要な言語。このパラメーターが指定されていない場合、既定値は "en" です。サポートされている言語の一覧については、https://aka.ms/cv-languages を参照してください。
model-name	query		string	カスタムトレーニング済みモデルの名前。パラメーター "features" が指定されていない場合は、このパラメーターを指定する必要があります。
smartcrops-aspect-ratios	query		string	smartCrops 機能に使用する縦横比の一覧。縦横比は、ターゲットのトリミング幅を高さで割ることによって計算されます。サポートされる値は、0.75 ~ 1.8 (含む) です。複数の値をコンマ区切りにする必要があります。このパラメーターが指定されていない場合、サービスは、縦横比が 0.5 ~ 2.0 (含む) の間に収まる 1 つのトリミング候補を返します。

要求本文

Media Types: "application/octet-stream", "image/jpeg", "image/gif", "image/tiff", "image/bmp", "image/png"

名前	型	説明
body	string (byte)	イメージストリーム。

応答

名前	型	説明
200 OK	ImageAnalysisResult	成功
Other Status Codes	ErrorResponse	エラーヘッダー x-ms-error-code: string

名前

型

説明

200 OK

ImageAnalysisResult

成功

Other Status Codes

ErrorResponse

エラー

ヘッダー

x-ms-error-code: string

例

AnalyzeImageFromImageStream_CustomModel

要求のサンプル

HTTP

POST /imageanalysis:analyze?overload=stream&model-name=my_model_name&api-version=2023-04-01-preview

"Ynl0ZXM="

応答のサンプル

状態コード:: 200

{
  "modelVersion": "2023-04-01-preview",
  "customModelResult": {
    "objectsResult": {
      "values": [
        {
          "id": "1",
          "boundingBox": {
            "x": 197,
            "y": 68,
            "w": 356,
            "h": 394
          },
          "tags": [
            {
              "name": "class1",
              "confidence": 0.92431640625
            }
          ]
        },
        {
          "id": "2",
          "boundingBox": {
            "x": 0,
            "y": 77,
            "w": 241,
            "h": 359
          },
          "tags": [
            {
              "name": "class1",
              "confidence": 0.87890625
            }
          ]
        }
      ]
    }
  },
  "metadata": {
    "width": 660,
    "height": 495
  }
}

定義

名前	説明
AdultMatch	成人コンテンツの一致を記述するオブジェクト。
AdultResult	画像に成人向けのコンテンツが含まれているか、わいせつであるかを示すオブジェクト。
BoundingBox	イメージ内の領域の境界ボックス。
CaptionResult	画像が示す内容の簡単な説明。
CropRegion	スマートトリミング用に識別されたリージョン。要求された縦横比ごとに 1 つの領域が返されます。
DenseCaption	画像が示す内容の簡単な説明。
DenseCaptionsResult	キャプションの一覧。
DetectedObject	画像内で検出されたオブジェクトについての説明。
DetectedPerson	画像内で検出された人物。
DocumentLine	単語や選択マークなどのコンテンツ要素の隣接するシーケンスで構成されるコンテンツ行オブジェクト。
DocumentPage	入力からページから抽出されたコンテンツ要素とレイアウト要素。
DocumentSpan	オフセットと長さとして指定された、連結されたコンテンツプロパティの連続した領域。
DocumentStyle	観察されたテキストスタイルを表すオブジェクト。
DocumentWord	連続する文字シーケンスで構成される単語オブジェクト。中国語、日本語、韓国語などのスペース区切り以外の言語の場合、各文字は独自の単語として表されます。
ErrorResponse	エラーが発生したときに返される応答。
ErrorResponseDetails	エラー情報。
ErrorResponseInnerError	詳細なエラー。
ImageAnalysisResult	さまざまな種類の画像分析の組み合わせ結果について説明します。
ImageMetadataApiModel	高さと幅などの画像メタデータ情報。
ImagePredictionResult	画像の予測結果について説明します。
ObjectsResult	画像内で検出されたオブジェクトについて説明します。
PeopleResult	画像に人物が含まれているかどうかを示すオブジェクト。
ReadResult	読み取り操作の結果。
SmartCropsResult	スマートトリミングの結果。
Tag	信頼度スコアと共に、画像内のエンティティの観察。
TagsResult	信頼度レベルを持つタグの一覧。
VisualFeature	要求されるビジュアル機能: タグ、オブジェクト、キャプション、denseCaptions、read、smartCrops、people。パラメーター "model-name" が指定されていない場合は、このパラメーターを指定する必要があります。

AdultMatch

Object

成人コンテンツの一致を記述するオブジェクト。

名前	型	説明
confidence	number (double) minimum: 0 maximum: 1	一致した成人コンテンツの信頼度レベルを示す値。
isMatch	boolean	画像が成人コンテンツと一致するかどうかを示す値。

AdultResult

Object

画像に成人向けのコンテンツが含まれているか、わいせつであるかを示すオブジェクト。

名前	型	説明
adult	AdultMatch	成人コンテンツの一致を記述するオブジェクト。
gore	AdultMatch	成人コンテンツの一致を記述するオブジェクト。
racy	AdultMatch	成人コンテンツの一致を記述するオブジェクト。

BoundingBox

Object

イメージ内の領域の境界ボックス。

名前	型	説明
h	integer (int32) minimum: 1	領域の左上のポイントからピクセル単位で測定された高さ。
w	integer (int32) minimum: 1	領域の左上のポイントからピクセル単位で測定された幅。
x	integer (int32) minimum: 0	領域の左上の点の左座標 (ピクセル単位)。
y	integer (int32) minimum: 0	領域の左上の点の上座標 (ピクセル単位)。

CaptionResult

Object

画像が示す内容の簡単な説明。

名前	型	説明
confidence	number (double) minimum: 0 maximum: 1	サービスがキャプションに持つ信頼度。
text	string minLength: 1	キャプションのテキスト。

CropRegion

Object

スマートトリミング用に識別されたリージョン。要求された縦横比ごとに 1 つの領域が返されます。

名前	型	説明
aspectRatio	number (double)	トリミング領域の縦横比。
boundingBox	BoundingBox	イメージ内の領域の境界ボックス。

DenseCaption

Object

画像が示す内容の簡単な説明。

名前	型	説明
boundingBox	BoundingBox	イメージ内の領域の境界ボックス。
confidence	number (double) minimum: 0 maximum: 1	サービスがキャプションに持つ信頼度。
text	string minLength: 1	キャプションのテキスト。

DenseCaptionsResult

Object

キャプションの一覧。

名前	型	説明
values	DenseCaption[]	キャプションの一覧。

DetectedObject

Object

画像内で検出されたオブジェクトについての説明。

名前	型	説明
boundingBox	BoundingBox	イメージ内の領域の境界ボックス。
id	string minLength: 1	検出されたオブジェクトの ID。
tags	Tag[]	検出されたオブジェクトの分類の信頼度。

DetectedPerson

Object

画像内で検出された人物。

名前	型	説明
boundingBox	BoundingBox	イメージ内の領域の境界ボックス。
confidence	number (double) minimum: 0 maximum: 1	画像中の人物を観察した信頼度スコアは、0から1までの範囲の値として得られる。

DocumentLine

Object

単語や選択マークなどのコンテンツ要素の隣接するシーケンスで構成されるコンテンツ行オブジェクト。

名前	型	説明
boundingBox	number[] (double)	線の境界ボックス。
content	string minLength: 1	読み取り順序で含まれる要素の連結されたコンテンツ。
spans	DocumentSpan[]	読み取り順序の連結されたコンテンツ内の行の場所。

DocumentPage

Object

入力からページから抽出されたコンテンツ要素とレイアウト要素。

名前	型	説明
angle	number (double)	時計回りの方向のコンテンツの一般的な向き。(-180, 180] の間の度数で測定されます。
height	number (double)	画像/PDF の高さ (ピクセル/インチ単位)。
lines	DocumentLine[]	ページから抽出された行。テキスト要素とビジュアル要素の両方を含む可能性があります。
pageNumber	integer (int32)	入力ドキュメント内の 1 から始まるページ番号。
spans	DocumentSpan[]	読み取り順序の連結されたコンテンツ内のページの場所。
width	number (double)	イメージ/PDF の幅 (ピクセル/インチ単位)。
words	DocumentWord[]	ページから抽出された単語。

DocumentSpan

Object

オフセットと長さとして指定された、連結されたコンテンツプロパティの連続した領域。

名前	型	説明
length	integer (int32)	スパンで表されるコンテンツ内の文字数。
offset	integer (int32)	スパンで表されるコンテンツの 0 から始まるインデックス。

DocumentStyle

Object

観察されたテキストスタイルを表すオブジェクト。

名前	型	説明
confidence	number (double)	スタイルを正しく識別する信頼度。
isHandwritten	boolean	コンテンツが手書きかどうか。
spans	DocumentSpan[]	スタイルが適用される連結コンテンツ内のテキスト要素の場所。

DocumentWord

Object

連続する文字シーケンスで構成される単語オブジェクト。中国語、日本語、韓国語などのスペース区切り以外の言語の場合、各文字は独自の単語として表されます。

名前	型	説明
boundingBox	number[] (double)	単語の境界ボックス。
confidence	number (double)	単語を正しく抽出する信頼度。
content	string minLength: 1	単語のテキストコンテンツ。
span	DocumentSpan	オフセットと長さとして指定された、連結されたコンテンツプロパティの連続した領域。

ErrorResponse

Object

エラーが発生したときに返される応答。

名前	型	説明
error	ErrorResponseDetails	エラー情報。

ErrorResponseDetails

Object

エラー情報。

名前	型	説明
code	string	エラーコード。
details	ErrorResponseDetails[]	詳細なエラーの一覧。
innererror	ErrorResponseInnerError	詳細なエラー。
message	string	エラーメッセージ。
target	string	エラーのターゲット。

ErrorResponseInnerError

Object

詳細なエラー。

名前	型	説明
code	string	エラーコード。
innererror	ErrorResponseInnerError	詳細なエラー。
message	string	エラーメッセージ。

ImageAnalysisResult

Object

さまざまな種類の画像分析の組み合わせ結果について説明します。

名前	型	説明
adultResult	AdultResult	画像に成人向けのコンテンツが含まれているか、わいせつであるかを示すオブジェクト。
captionResult	CaptionResult	画像が示す内容の簡単な説明。
customModelResult	ImagePredictionResult	画像の予測結果について説明します。
denseCaptionsResult	DenseCaptionsResult	キャプションの一覧。
metadata	ImageMetadataApiModel	高さと幅などの画像メタデータ情報。
modelVersion	string minLength: 1	モデルのバージョン。
objectsResult	ObjectsResult	画像内で検出されたオブジェクトについて説明します。
peopleResult	PeopleResult	画像に人物が含まれているかどうかを示すオブジェクト。
readResult	ReadResult	読み取り操作の結果。
smartCropsResult	SmartCropsResult	スマートトリミングの結果。
tagsResult	TagsResult	信頼度レベルを持つタグの一覧。

ImageMetadataApiModel

Object

高さと幅などの画像メタデータ情報。

名前	型	説明
height	integer (int32) minimum: 1	イメージの高さ (ピクセル単位)。
width	integer (int32) minimum: 1	イメージの幅 (ピクセル単位)。

ImagePredictionResult

Object

画像の予測結果について説明します。

名前	型	説明
objectsResult	ObjectsResult	画像内で検出されたオブジェクトについて説明します。
tagsResult	TagsResult	信頼度レベルを持つタグの一覧。

ObjectsResult

Object

画像内で検出されたオブジェクトについて説明します。

名前	型	説明
values	DetectedObject[]	検出されたオブジェクトの配列。

PeopleResult

Object

画像に人物が含まれているかどうかを示すオブジェクト。

名前	型	説明
values	DetectedPerson[]	検出されたユーザーの配列。

ReadResult

Object

読み取り操作の結果。

名前	型	説明
content	string minLength: 1	すべてのテキスト要素とビジュアル要素の文字列表現を読み取り順に連結します。
pages	DocumentPage[]	分析されたページの一覧。
stringIndexType	string minLength: 1	文字列のオフセットと長さを計算するために使用されるメソッド。可能な値には、'textElements'、'unicodeCodePoint'、'utf16CodeUnit' などがあります。
styles	DocumentStyle[]	抽出されたフォントスタイル。

SmartCropsResult

Object

スマートトリミングの結果。

名前	型	説明
values	CropRegion[]	イメージをトリミングするための推奨リージョン。

Tag

Object

信頼度スコアと共に、画像内のエンティティの観察。

名前	型	説明
confidence	number (double) minimum: 0 maximum: 1	エンティティが観察された信頼度。
name	string minLength: 1	エンティティの名前。

TagsResult

Object

信頼度レベルを持つタグの一覧。

名前	型	説明
values	Tag[]	信頼度レベルを持つタグの一覧。

VisualFeature

列挙

要求されるビジュアル機能: タグ、オブジェクト、キャプション、denseCaptions、read、smartCrops、people。パラメーター "model-name" が指定されていない場合は、このパラメーターを指定する必要があります。

値	説明
caption
denseCaptions
objects
people
read
smartCrops
tags

次の方法で共有

Image Analysis - Analyze Stream

URI パラメーター

要求本文

応答

例

AnalyzeImageFromImageStream_CustomModel

要求のサンプル

応答のサンプル

定義

AdultMatch

AdultResult

BoundingBox

CaptionResult

CropRegion

DenseCaption

DenseCaptionsResult

DetectedObject

DetectedPerson

DocumentLine

DocumentPage

DocumentSpan

DocumentStyle

DocumentWord

ErrorResponse

ErrorResponseDetails

ErrorResponseInnerError

ImageAnalysisResult

ImageMetadataApiModel

ImagePredictionResult

ObjectsResult

PeopleResult

ReadResult

SmartCropsResult

Tag

TagsResult

VisualFeature