Describe Image - Describe Image

リファレンス

サービス:: Azure AI Services

API バージョン:: 3.2

この操作を実行すると、画像の記述が、ユーザーが読み取れる言語による完全な文で生成されます。説明はコンテンツタグのコレクションに基づいていますが、コンテンツタグもこの操作によって返されます。各画像に対して複数の説明が生成されることがあります。説明はその信頼度スコアの順に並んでいます。説明には、該当する場合、著名人およびランドマークドメインモデルの結果が含まれる場合があります。 2 つの入力方法がサポートされています。(1) イメージのアップロードまたは (2) イメージ URL の指定。成功した応答は JSON で返されます。要求が失敗した場合、応答にはエラーコードと、何が問題が発生したかを理解するのに役立つメッセージが含まれます。

POST {Endpoint}/vision/v3.2/describe

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

POST {Endpoint}/vision/v3.2/describe?maxCandidates={maxCandidates}&language={language}&descriptionExclude={descriptionExclude}&model-version={model-version}

URI パラメーター

名前	/	必須	型	説明
Endpoint	path	True	string	サポートされている Cognitive Services エンドポイント。
descriptionExclude	query		DescriptionExclude[]	説明を生成するときに、指定したドメインモデルをオフにします。
language	query		string	出力生成に必要な言語。このパラメーターが指定されていない場合、既定値は "en" です。サポートされている言語の一覧については、https://aka.ms/cv-languages を参照してください。
maxCandidates	query		integer (int32)	返される候補の説明の最大数。既定値は 1 です。
model-version	query		string pattern: ^(latest\|\d{4}-\d{2}-\d{2})(-preview)?$	AI モデルのバージョンを指定する省略可能なパラメーター。指定できる値は、"latest"、"2021-04-01"、"2021-05-01" です。既定値は "latest" です。

要求ヘッダー

名前	必須	型	説明
Ocp-Apim-Subscription-Key	True	string

要求本文

名前	必須	型	説明
url	True	string	イメージのパブリックに到達可能な URL。

応答

名前	型	説明
200 OK	ImageDescription	画像の説明オブジェクト。
Other Status Codes	ComputerVisionErrorResponse	エラー応答。

セキュリティ

Ocp-Apim-Subscription-Key

型: apiKey
/: header

例

Successful DescribeImage request

要求のサンプル

HTTP

POST https://westus.api.cognitive.microsoft.com/vision/v3.2/describe?maxCandidates=1


{
  "url": "{url}"
}

応答のサンプル

状態コード:: 200

{
  "description": {
    "tags": [
      "person",
      "man",
      "outdoor",
      "window",
      "glasses"
    ],
    "captions": [
      {
        "text": "Satya Nadella sitting on a bench",
        "confidence": 0.48293603002174407
      }
    ]
  },
  "requestId": "ed2de1c6-fb55-4686-b0da-4da6e05d283f",
  "metadata": {
    "width": 1500,
    "height": 1000,
    "format": "Jpeg"
  },
  "modelVersion": "2021-04-01"
}

定義

名前	説明
ComputerVisionError	API 要求エラー。
ComputerVisionErrorCodes	エラーコード。
ComputerVisionErrorResponse	API エラー応答。
ComputerVisionInnerError	API 要求エラーの詳細。
ComputerVisionInnerErrorCodeValue	エラーコード。
DescriptionExclude	説明を生成するときに、指定したドメインモデルをオフにします。
ImageCaption	画像のキャプション。つまり、画像が示す内容の簡単な説明です。
ImageDescription	コンテンツタグのコレクションと、信頼度レベルで並べ替えられたキャプションの一覧、および画像メタデータ。
ImageMetadata	イメージメタデータ。
ImageUrl

ComputerVisionError

Object

API 要求エラー。

名前	型	説明
code	ComputerVisionErrorCodes	エラーコード。
innererror	ComputerVisionInnerError	内部エラーには、より具体的な情報が含まれています。
message	string	サービスによって報告されたエラーを説明するメッセージ。

ComputerVisionErrorCodes

列挙

エラーコード。

値	説明
InternalServerError
InvalidArgument
InvalidRequest
ServiceUnavailable

ComputerVisionErrorResponse

Object

API エラー応答。

名前	型	説明
error	ComputerVisionError	エラーの内容。

ComputerVisionInnerError

Object

API 要求エラーの詳細。

名前	型	説明
code	ComputerVisionInnerErrorCodeValue	エラーコード。
message	string	エラーメッセージ。

ComputerVisionInnerErrorCodeValue

列挙

エラーコード。

値	説明
BadArgument
CancelledRequest
DetectFaceError
FailedToProcess
InternalServerError
InvalidDetails
InvalidImageFormat
InvalidImageSize
InvalidImageUrl
InvalidModel
InvalidThumbnailSize
NotSupportedFeature
NotSupportedImage
NotSupportedLanguage
NotSupportedVisualFeature
StorageException
Timeout
Unspecified
UnsupportedMediaType

DescriptionExclude

列挙

説明を生成するときに、指定したドメインモデルをオフにします。

値	説明
Celebrities
Landmarks

ImageCaption

Object

画像のキャプション。つまり、画像が示す内容の簡単な説明です。

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

ImageDescription

Object

コンテンツタグのコレクションと、信頼度レベルで並べ替えられたキャプションの一覧、および画像メタデータ。

名前	型	説明
description.captions	ImageCaption[]	信頼度レベルで並べ替えられたキャプションの一覧。
description.tags	string[]	イメージタグのコレクション。
metadata	ImageMetadata	イメージメタデータ。
modelVersion	string pattern: ^(latest\|\d{4}-\d{2}-\d{2})(-preview)?$	AI モデルのバージョン。
requestId	string	REST API 要求の ID。

ImageMetadata

Object

イメージメタデータ。

名前	型	説明
format	string	イメージ形式。
height	integer (int32)	画像の高さ (ピクセル単位)。
width	integer (int32)	画像の幅 (ピクセル単位)。

ImageUrl

Object

名前	型	説明
url	string	イメージのパブリックに到達可能な URL。

次の方法で共有

Describe Image - Describe Image

URI パラメーター

要求ヘッダー

要求本文

応答

セキュリティ

Ocp-Apim-Subscription-Key

例

Successful DescribeImage request

要求のサンプル

応答のサンプル

定義

ComputerVisionError

ComputerVisionErrorCodes

ComputerVisionErrorResponse

ComputerVisionInnerError

ComputerVisionInnerErrorCodeValue

DescriptionExclude

ImageCaption

ImageDescription

ImageMetadata

ImageUrl