1. TOP
  2. PRODUCT
  3. Image Search API

画像とテキストの相互検索APIです。
マルチモーダルDeep Learningという技術により画像とテキストの関係を学習することでテキストから画像を検索したり、画像からテキストを検索したりといったことが可能となります。
現在はオリジナルの画像は利用できませんが、サンプルデータでの利用ができます。

DETAIL

Image Search APIを利用することで下記のような事ができます。

・自然な言葉で画像を見つけることができます。
・画像をもとに関連する言葉を見つけることができます。
・画像をもとに類似の画像を見つけることができます。
・文章から関連する単語を見つけることができます。

NOTES

他人の名称・メールアドレス・住所・電話番号など個人を特定しうる情報はアップロードしないでください。

ライセンス



画像とテキストの相互検索モデルにはMS COCOの画像データに対して日本語のキャプションを付与したデータセットである「STAIR Captions」を利用しております。
https://stair-lab-cit.github.io/STAIR-captions-web/


Yuya Yoshikawa, Yutaro Shigeto and Akikazu Takeuchi. STAIR Captions: Constructing a Large-Scale Japanese Image Caption Dataset. Annual Meeting of the Association for Computational Linguistics (ACL), Short Paper, 2017.



このAPIで利用している画像は、MS COCOにて収集/アノテーション対象となった画像です。 個々の画像のライセンスは、クリエイティブ・コモンズまたはFlickrの"no known copyright restrictions"により規定されています。 表示されるimgタグ内のaltには画像URLとそのライセンスを記載しており、下記ライセンス表示と対応しています。
・Attribution-NonCommercial-ShareAlike License: http://creativecommons.org/licenses/by-nc-sa/2.0/
・Attribution-NonCommercial License: http://creativecommons.org/licenses/by-nc/2.0/
・Attribution-NonCommercial-NoDerivs License: http://creativecommons.org/licenses/by-nc-nd/2.0/
・Attribution License: http://creativecommons.org/licenses/by/2.0/
・Attribution-ShareAlike License: http://creativecommons.org/licenses/by-sa/2.0/
・Attribution-NoDerivs License: http://creativecommons.org/licenses/by-nd/2.0/
・no known copyright restrictions: http://flickr.com/commons/usage/

DEMO

DEMOの使用には、API KEYが必要になります。


DEMO

REFERENCE

  • Search by Text API
  • Search by Image API
  • Random API

Search by Text API

テキストを与えると画像IDリストと関連するキーワードを返却します。

エンドポイント

URL:
https://api.a3rt.recruit-tech.co.jp/image_search/v1/search_by_text
メソッド:
GET

リクエストパラメータ

No. パラメータ名 説明 値サンプル 制約 必須
1 apikey APIキーを指定します AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA 半角英数字
2 query 入力テキストを指定します 馬に乗った男性 最大文50文字

レスポンスフィールド

No. 説明 値サンプル 返却条件 複数項目
1 status 処理ステータス 0 int 常に返却 -
2 message メッセージ ok string 常に返却 -
3 result 結果 正常時に返却 -
img 画像リスト 正常時に返却 -
id 画像ID 15649 int 正常時に返却
file_name 画像ファイル名 6847113924_5b1798672a_z.jpg string 正常時に返却
url 画像URL http://farm8.staticflickr.com/7181/6847113924_5b1798672a_z.jpg string 正常時に返却
license 画像ライセンス Attribution-NonCommercial-ShareAlike License string 正常時に返却
txt キーワードリスト ["馬", "乗る", "男性", "カウボーイ", ..] list 正常時に返却 -

ステータスコード / メッセージ

No. status HTTP
status
message 返却条件
1 0 200 ok 正常応答
2 1000 400 apikey is null APIキー未指定
3 1001 400 apikey not found APIキーが見つからない
4 1002 400 deleted account 退会済み
5 1003 400 temporary account アカウント未承認
6 1010 400 server not found サーバが見つからない
7 1011 400 server parameter error サーバ設定エラー
8 1030 403 access deny アクセス拒否
9 1031 400 query is empty クエリ文字列が空
10 1032 400 query is too long クエリ文字列が50文字を超えている
11 1404 404 not found エンドポイントが不正
12 1405 405 method not allowed リクエストメソッドが不正
13 1500 500 internal server error サーバ処理中に想定外のエラーが発生

Search by Image API

画像IDを与えると類似する画像IDリストと関連するキーワードを返却します。

エンドポイント

URL:
https://api.a3rt.recruit-tech.co.jp/image_search/v1/search_by_image
メソッド:
GET

リクエストパラメータ

No. パラメータ名 説明 値サンプル 制約 必須
1 apikey APIキーを指定します AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA 半角英数字
2 query 画像IDを指定します 123 半角数字

レスポンスフィールド

No. 説明 値サンプル 返却条件 複数項目
1 status 処理ステータス 0 int 常に返却 -
2 message メッセージ ok string 常に返却 -
3 result 結果 正常時に返却 -
img 画像リスト 正常時に返却 -
id 画像ID 3720 int 正常時に返却
file_name 画像ファイル名 2253047406_434581aeb4_z.jpg string 正常時に返却
url 画像URL http://farm3.staticflickr.com/2355/2253047406_434581aeb4_z.jpg string 正常時に返却
license 画像ライセンス Attribution-NoDerivs License string 正常時に返却
txt キーワードリスト [“スノーボード“, “雪”, “座る“, “ウェア“, .. ] list 正常時に返却 -

ステータスコード / メッセージ

No. status HTTP
status
message 返却条件
1 0 200 ok 正常応答
2 1000 400 apikey is null APIキー未指定
3 1001 400 apikey not found APIキーが見つからない
4 1002 400 deleted account 退会済み
5 1003 400 temporary account アカウント未承認
6 1010 400 server not found サーバが見つからない
7 1011 400 server parameter error サーバ設定エラー
8 1030 403 access deny アクセス拒否
9 1031 400 query is empty クエリ文字列が空
10 1033 404 query image is not found クエリ画像が見つからない
11 1404 404 not found エンドポイントが不正
12 1405 405 method not allowed リクエストメソッドが不正
13 1500 500 internal server error サーバ処理中に想定外のエラーが発生

Random API

ランダムな画像リストを返却します。

エンドポイント

URL:
https://api.a3rt.recruit-tech.co.jp/image_search/v1/random
メソッド:
GET

リクエストパラメータ

No. パラメータ名 説明 値サンプル 制約 必須
1 apikey APIキーを指定します AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA 半角英数字

レスポンスフィールド

No. 説明 値サンプル 返却条件 複数項目
1 status 処理ステータス 0 int 常に返却 -
2 message メッセージ ok string 常に返却 -
3 result 結果 正常時に返却 -
img 画像リスト 正常時に返却 -
id 画像ID 37500 int 正常時に返却
file_name 画像ファイル名 3348961791_a229740c7c_z.jpg string 正常時に返却
url 画像URL http://farm3.staticflickr.com/2837/9070708379_4e1ef2d8ff_z.jpg string 正常時に返却
license 画像ライセンス Attribution-NonCommercial-ShareAlike License string 正常時に返却
txt キーワードリスト [] list 正常時に返却 -

ステータスコード / メッセージ

No. status HTTP
status
message 返却条件
1 0 200 ok 正常応答
2 1000 400 apikey is null APIキー未指定
3 1001 400 apikey not found APIキーが見つからない
4 1002 400 deleted account 退会済み
5 1003 400 temporary account アカウント未承認
6 1010 400 server not found サーバが見つからない
7 1011 400 server parameter error サーバ設定エラー
8 1030 403 access deny アクセス拒否
9 1404 404 not found エンドポイントが不正
10 1405 405 method not allowed リクエストメソッドが不正
11 1500 500 internal server error サーバ処理中に想定外のエラーが発生

SAMPLE REQUEST

  • Search by Text API
  • Search by Image API
  • Random API

1. 正常時

リクエスト curl -X GET "https://api.a3rt.recruit-tech.co.jp/image_search/v1/search_by_text?apikey=AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA&query=馬に乗った男性"
レスポンス

{						
  "status": 0,							
  "message": "ok",							
  "result": {							
    "img": [
      {
        "id": 15649,
        "file_name": "6847113924_5b1798672a_z.jpg",
        "url": "http://farm8.staticflickr.com/7181/6847113924_5b1798672a_z.jpg",
        "license": "Attribution-NonCommercial-ShareAlike License"
      },
      ...
    ],
    "txt": ["馬", "乗る", "男性", "カウボーイ", ... ]
  }							
}						

							              

2. 異常時

リクエスト curl -X GET "https://api.a3rt.recruit-tech.co.jp/image_search/v1/search_by_text?apikey=AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA"
レスポンス

{						
  "status": 1031,
  "message": "query is empty"
}						

							             

1. 正常時

リクエスト curl -X GET "https://api.a3rt.recruit-tech.co.jp/image_search/v1/search_by_image?apikey=AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA&query=123"
レスポンス

{							
  "status": 0,
  "message": "ok",
  "result": {							
    "img": [
      {
        "id": 3720,
        "file_name": "2253047406_434581aeb4_z.jpg",
        "url": "http://farm3.staticflickr.com/2355/2253047406_434581aeb4_z.jpg",
        "license": "Attribution-NoDerivs License"
      },
      ...
    ],
     "txt": ["スノーボード", "雪", "座る", "ウェア", ... ]
  }
}											

							             

2. 異常時

リクエスト curl -X GET "https://api.a3rt.recruit-tech.co.jp/image_search/v1/search_by_image?apikey=AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA"
レスポンス

{						
  "status": 1031,						
  "message": "query is empty"						
}											

							             

1. 正常時

リクエスト curl -X GET "https://api.a3rt.recruit-tech.co.jp/image_search/v1/random?apikey=AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA"
レスポンス

{							
  "status": 0,
  "message": "ok",
  "result": {
    "img": [
      {
        "id": 37500,
        "file_name": "9070708379_4e1ef2d8ff_z.jpg",
        "url": "http://farm3.staticflickr.com/2837/9070708379_4e1ef2d8ff_z.jpg",
        "license": "Attribution-NonCommercial-ShareAlike License"
      },
      ...
    ],
    "txt": []
  }
}													

							               

2. 異常時

リクエスト curl -X POST "https://api.a3rt.recruit-tech.co.jp/image_search/v1/random" -F "apikey=AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA"
レスポンス

{
  "status": 1405,
  "message": "method not allowed"
}