docomo MEC™ docomo MEC™ docomo MEC™
お問い合わせ ドキュメント ログインページ
検索
お問い合わせ ドキュメント ログインページ
  • Compute V
  • Compute O
  • Compute D
  • MECダイレクト
  • MECダイレクト(SA)
  • ドコモ画像認識PF
  • ネットワークセキュリティサービス
  • docomo MECポータルへのログイン方法
  • 用語集
  • 改訂履歴
Compute V
Compute O
Compute D
MECダイレクト
MECダイレクト(SA)
ドコモ画像認識PF
ネットワークセキュリティサービス
docomo MECポータルへのログイン方法
用語集
改訂履歴

›リファレンス

  • ドコモ画像認識プラットフォームとは

  • はじめに
  • 一般物体認識

    • 画像収集
    • アノテーション
    • データセット
    • 学習
    • 評価
    • デプロイ
    • 推論
    • クリーンアップ

    物体検出

    • 画像収集
    • アノテーション
    • データセット
    • 学習
    • 評価
    • デプロイ
    • 推論
    • クリーンアップ

    類似画像検索

    • 画像収集
    • アノテーション
    • データセット
    • デプロイ
    • データの追加
    • 推論
    • クリーンアップ

    特定物体認識

    • 画像収集
    • アノテーション
    • データセット
    • 辞書作成
    • デプロイ
    • 推論
    • クリーンアップ

    姿勢推定

    • 概要
    • デプロイ
    • 推論
    • クリーンアップ

    文字認識

    • 概要
    • デプロイ
    • 推論
    • クリーンアップ

    複数API組み合わせ用コンテナ

    • 概要
    • デプロイ
    • 推論
    • クリーンアップ

    管理画面

    • 認証キー管理
    • アノテーション管理
    • 学習モデル管理
    • 辞書管理
    • API管理
    • ユーザー管理

    APIリファレンス

    • 一般物体認識
    • 物体検出
    • 類似画像検索
    • 特定物体認識
    • 姿勢推定
    • 文字認識
    • 複数API組み合わせ用コンテナ
    • エラーレスポンス

  • 使用上の注意

類似画像検索

類似検索API

REST APIエンドポイントに指定のFormデータをPOSTすると分類結果のJSONを応答します。入力画像一枚につき1回APIをリクエストする必要があります。
処理に成功するとHTTPstatus200のステータスコードと共にJSONが応答されます。

類似検索APIリクエスト

  • エンドポイント

    POST https://imagepf.dcm-dc.biz/api/predict?auth_key={APIKEY}
    key 値 必須 説明
    APIKEY 文字列 ○ 払い出したAPIキーを設定します
  • ボディ

    リクエストボディは Content-Type: multipart/form-data 形式でリクエストを送信します。

    multipartキー 値 必須
    image 画像ファイルのバイナリ ○
    numOfCandidates 実数  
    threshold 実数  
    apiRequestKey 実数 〇
    • image
    • 分類する画像ファイルです。対応しているフォーマットはJPEG、png、bmp、gif、tiffです。
    • numOfCandidates
    • 返却候補件数を指定してください。
      指定しない場合、検索コンテナ起動時の設定内容を使用します。
      1以上の整数を入力してください。
    • threshold
    • 閾値処理をしたい場合は、指定してください。
      指定しない場合、検索コンテナ起動時の設定内容を使用します。
      設定範囲は、0.0~1.0です。
    • apiRequestKey
    • 0 を指定した場合、「指定した辞書(dictionaryId)から指定した画像(image)に近い画像のURL情報を取得する機能」を指定します。
      1 :を指定した場合、「指定した辞書(dictionaryId)から指定した画像(image)に近い画像のタグ情報を取得する機能」を指定します。
    • サンプル
    • ------WebKitFormBoundaryhwZz6hhFHARN6wAB
      Content-Disposition: form-data; name="image"; filename="sample.png"
      Content-Type: image/png
      画像データ(binary)
      ------WebKitFormBoundaryhwZz6hhFHARN6wAB--
      Content-Disposition: form-data; name="numOfCandidates"
      5
      ------WebKitFormBoundaryhwZz6hhFHARN6wAB
      Content-Disposition: form-data; name="threshold"
      0.5
      ------WebKitFormBoundaryhwZz6hhFHARN6wAB
      Content-Disposition: form-data; name="apiRequestKey"
      0
      ------WebKitFormBoundaryhwZz6hhFHARN6wAB

類似検索APIレスポンス

  • ボディ

    JSONキー 値 必須
    jobid 文字列 ○
    status 文字列 ○
    Candidates object配列  

    • jobid
      物体認識 API のプロトコルバージョン です。

    • status
      処理状態です。
      状態は以下の通りです。

      Status 意味
      success 成功
      failure 失敗
    • Candidates
      分類結果のcandidates objectをスコアの高い順にソートして配列で設定します。

    • candidates object
      必須:△については入力した apiRequestKey によっていずれかが返却されます。

      JSONキー 値 必須
      dictionaryImageId 文字列 ○
      score 実数 ○
      imageUrl 文字列 △
      tag 文字列 △
      appendix 文字列  ○

      • dictionaryImageId
        分類した画像のIDです
      • score
        分類した画像の精度を表します。値の範囲は-2147483648~2147483647です。
      • imageUrl
        類似画像のURLです。
      • tag
        類似画像のタグです。
      • appendix
        追加情報の文字列です。
    • サンプル
    • {
        "jobid": "some-id-shown-here",
        "Status": "SUCCESS",
        "Candidates": [
          {
            "dictionaryImageId": "8",
            "Score": 57,
            "imageUrl": "http://url.to.image",
            "appendix": "some information",
          }
        ]
      }

画像追加API

REST APIエンドポイントに指定のFormデータをPOSTすると類似検索APIに画像が追加されます。入力画像一枚につき1回APIをリクエストする必要があります。
処理に成功するとHTTPstatus200のステータスコードと共にJSONが応答されます。

画像追加APIリクエスト

   
  • エンドポイント

    POST https://imagepf.dcm-dc.biz/api/search/add-image?auth_key={APIKEY}
    key 値 必須 説明
    APIKEY 文字列 ○ 払い出したAPIキーを設定します
  • ボディ

    リクエストボディは Content-Type: multipart/form-data 形式でリクエストを送信します。

    multipartキー 値 必須
    image 画像ファイルのバイナリ ○
    tag 文字列の配列 ○
    imageUrl 文字列 ○
    appendix 文字列  
    • image
    • 分類する画像ファイルです。対応しているフォーマットはJPEG、png、bmp、gif、tiffです。
    • tag
    • タグ名の配列を指定してください。
    • imageUrl
    • 類似画像のURLを指定してください。
    • appendix
    • 追加情報がある場合ここに記載してください。
    • サンプル
    • ------WebKitFormBoundaryhwZz6hhFHARN6wAB
      Content-Disposition: form-data; name="image"; filename="sample.png"
      Content-Type: image/png
      画像データ(binary)
      ------WebKitFormBoundaryhwZz6hhFHARN6wAB--
      Content-Disposition: form-data; name="tag"
      some-tag
      ------WebKitFormBoundaryhwZz6hhFHARN6wAB
      Content-Disposition: form-data; name="imageUrl"
      http://link.to.image
      ------WebKitFormBoundaryhwZz6hhFHARN6wAB
      Content-Disposition: form-data; name="appendix"
      sample
      ------WebKitFormBoundaryhwZz6hhFHARN6wAB

画像追加APIレスポンス

  • ボディ

    JSONキー 値 必須
    jobid 文字列 ○
    status 文字列 ○
    records object配列  

    • jobid
      物体認識 API のプロトコルバージョン です。

    • status
      処理状態です。
      状態は以下の通りです。

      Status 意味
      success 成功
      failure 失敗
    • records
      処理結果を示したオブジェクト配列です。

    • records object

      JSONキー 値 必須
      dictionaryImageId 文字列 ○
      tag 実数 ○
      imageUrl 文字列 ○
      appendix 文字列 ○
      • dictionaryImageId
        分類した画像のIDです
      • tag
        類似画像のタグです。
      • imageUrl
        類似画像のURLです。
      • appendix
        追加情報の文字列です。
    • サンプル
    • {
        "jobid": "some-id-shown-here",
        "Status": "SUCCESS",
        "Candidates": [
          {
            "dictionaryImageId": "8",
            "tag": "some-tag",
            "imageUrl": "http://url.to.image",
            "appendix": "sample",
          }
        ]
      }

画像削除API

REST APIエンドポイントに指定のFormデータをPOSTすると類似検索APIの画像が削除されます。対象画像一枚につき1回APIをリクエストする必要があります。
処理に成功するとHTTPstatus200のステータスコードと共にJSONが応答されます。

画像削除APIリクエスト

  • エンドポイント

    POST https://imagepf.dcm-dc.biz/api/search/delete-image?auth_key={APIKEY}
    key 値 必須 説明
    APIKEY 文字列 ○ 払い出したAPIキーを設定します
  • ボディ

    リクエストボディは Content-Type: multipart/form-data 形式でリクエストを送信します。

    multipartキー 値 必須
    dictionaryImageId 画像ファイルのID ○
    • dictionaryImageId
    • 削除対象の画像ファイルのIDです。
  • サンプル
  • ------WebKitFormBoundaryhwZz6hhFHARN6wAB
    Content-Disposition: form-data; name="dictionaryImageId"
    some-image-id
    ------WebKitFormBoundaryhwZz6hhFHARN6wAB

画像削除APIレスポンス

  • ボディ

    JSONキー 値 必須
    jobid 文字列 ○
    status 文字列 ○
    records object配列  
    • jobid
      物体認識 API のプロトコルバージョン です。

    • status
      処理状態です。
      状態は以下の通りです。

      Status 意味
      success 成功
      failure 失敗
    • records
      処理結果を示したオブジェクト配列です。

    • records object

      JSONキー 値 必須
      dictionaryImageId 文字列 ○
      tag 実数 ○
      imageUrl 文字列 ○
      appendix 文字列 ○
      • dictionaryImageId
        分類した画像のIDです
      • tag
        類似画像のタグです。
      • imageUrl
        類似画像のURLです。
      • appendix
        追加情報の文字列です。
    • サンプル
    • {
        "jobid": "some-id-shown-here",
        "Status": "SUCCESS",
        "Candidates": [
          {
            "dictionaryImageId": "8",
            "tag": "some-tag",
            "imageUrl": "http://url.to.image",
            "appendix": "sample",
          }
        ]
      }

辞書確認API

REST APIエンドポイントにGETすると類似検索APIの辞書に登録されている内容が出力されます。
処理に成功するとHTTPstatus200のステータスコードと共にJSONが応答されます。

辞書確認APIリクエスト

  • エンドポイント

    GET https://imagepf.dcm-dc.biz/api/search/get-dictinfo?auth_key={APIKEY}&page={PAGE}&per_page={PER_PAGE}
    key 値 必須 説明
    APIKEY 文字列 ○ 払い出したAPIキーを設定します
    PAGE 文字列   ページ番号を指定します
    PER_PAGE 文字列   1ページあたりの最大表示件数を設定します

辞書確認APIレスポンス

  • ボディ

    JSONキー 値 必須
    jobid 文字列 ○
    status 文字列 ○
    page 整数 ○
    totalPage 整数 ○
    records object配列  
    • jobid
      物体認識 API のプロトコルバージョン です。

    • status
      処理状態です。
      状態は以下の通りです。

      Status 意味
      success 成功
      failure 失敗
    • records
      処理結果を示したオブジェクト配列です。

    • page
      取得したページの番号です。

    • totalPage
      総ページ数です。

    • records object

      JSONキー 値 必須
      dictionaryImageId 文字列 ○
      tag 実数 ○
      imageUrl 文字列 ○
      appendix 文字列 ○
      • dictionaryImageId
        分類した画像のIDです
      • tag
        類似画像のタグです。
      • imageUrl
        類似画像のURLです。
      • appendix
        追加情報の文字列です。
    • サンプル
    • {
        "jobid": "some-id-shown-here",
        "Status": "SUCCESS",
        "page": 3,
        "totalPage": 10,
        "Candidates": [
          {
            "dictionaryImageId": "8",
            "tag": "some-tag",
            "imageUrl": "http://url.to.image",
            "appendix": "sample",
          }
        ]
      }
← 物体検出 特定物体認識 →
  • 類似検索API
    • 類似検索APIリクエスト
    • 類似検索APIレスポンス
  • 画像追加API
    • 画像追加APIリクエスト
    • 画像追加APIレスポンス
  • 画像削除API
    • 画像削除APIリクエスト
    • 画像削除APIレスポンス
  • 辞書確認API
    • 辞書確認APIリクエスト
    • 辞書確認APIレスポンス
  • ※「docomo MEC」は株式会社NTT ドコモの商標です。
docomo
© NTT DOCOMO, INC. All Rights Reserved