Describe Image - Describe Image

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

POST {Endpoint}/vision/v3.1/describe
POST {Endpoint}/vision/v3.1/describe?maxCandidates={maxCandidates}&language={language}&descriptionExclude={descriptionExclude}

URI パラメーター

Name In Required Type Description
Endpoint
path True
  • string

サポートされている Cognitive Services エンドポイント。

descriptionExclude
query
  • array

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

language
query
  • string

出力生成に必要な言語。 このパラメーターが指定されていない場合、既定値は "en" です。サポートされている言語:en - 英語、既定値。 es - スペイン語、ja - 日本語、pt - ポルトガル語、zh - 簡体字中国語。

maxCandidates
query
  • integer
int32

返される候補の説明の最大数。 既定値は 1 です。

要求ヘッダー

Name Required Type Description
Ocp-Apim-Subscription-Key True
  • string

要求本文

Name Required Type Description
url True
  • string

イメージのパブリックに到達可能な URL。

応答

Name Type Description
200 OK

イメージの説明オブジェクト。

Other Status Codes

エラー応答。

セキュリティ

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Successful DescribeImage request

Sample Request

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


{
  "url": "{url}"
}

Sample Response

{
  "description": {
    "tags": [
      "person",
      "man",
      "outdoor",
      "window",
      "glasses"
    ],
    "captions": [
      {
        "text": "Satya Nadella sitting on a bench",
        "confidence": 0.48293603002174407
      },
      {
        "text": "Satya Nadella is sitting on a bench",
        "confidence": 0.4003700681542283
      },
      {
        "text": "Satya Nadella sitting in front of a building",
        "confidence": 0.38035155997373377
      }
    ]
  },
  "requestId": "ed2de1c6-fb55-4686-b0da-4da6e05d283f",
  "metadata": {
    "width": 1500,
    "height": 1000,
    "format": "Jpeg"
  }
}

定義

ComputerVisionError

API 要求エラーの詳細。

ComputerVisionErrorCodes

エラー コード。

ImageCaption

画像キャプション、つまり、画像が示しているものの簡単な説明。

ImageDescription

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

ImageMetadata

イメージ メタデータ。

ImageUrl

ComputerVisionError

API 要求エラーの詳細。

Name Type Description
code

エラー コード。

message
  • string

サービスによって報告されたエラーを説明するメッセージ。

requestId
  • string

一意の要求識別子。

ComputerVisionErrorCodes

エラー コード。

Name Type Description
BadArgument
  • string
CancelledRequest
  • string
DetectFaceError
  • string
FailedToProcess
  • string
InternalServerError
  • string
InvalidDetails
  • string
InvalidImageFormat
  • string
InvalidImageSize
  • string
InvalidImageUrl
  • string
InvalidModel
  • string
InvalidThumbnailSize
  • string
NotSupportedFeature
  • string
NotSupportedImage
  • string
NotSupportedLanguage
  • string
NotSupportedVisualFeature
  • string
StorageException
  • string
Timeout
  • string
Unspecified
  • string
UnsupportedMediaType
  • string

ImageCaption

画像キャプション、つまり、画像が示しているものの簡単な説明。

Name Type Description
confidence
  • number

サービスがキャプションに持つ信頼度のレベル。

text
  • string

キャプションのテキスト。

ImageDescription

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

Name Type Description
description.captions

信頼レベルで並べ替えられたキャプションの一覧。

description.tags
  • string[]

イメージ タグのコレクション。

metadata

イメージ メタデータ。

requestId
  • string

REST API 要求の ID。

ImageMetadata

イメージ メタデータ。

Name Type Description
format
  • string

イメージ形式。

height
  • integer

画像の高さ (ピクセル単位)。

width
  • integer

画像の幅 (ピクセル単位)。

ImageUrl

Name Type Description
url
  • string

イメージのパブリックに到達可能な URL。