ホーム API/ツール API 文字認識

文字認識

    文字認識APIは、画像内の文字を読み取るWeb APIです。対象となる画像から文字や単語を抽出し、位置座標や認識精度を示すスコアも併せて得ることができます。

    API
    基本情報
    提供 : REST, SDK(Android™,iOS,Server side JAVA)
    • 審査 : アプリ審査
    利用条件 : あり※1

    ※1「ガイドライン(必読)」に記載の利用条件に予め同意していただく必要がございます。

    ご利用いただくためには「アカウント登録(無料)」が必要です。

    リファレンスを参照するAPI機能名を選択してください

    行画像認識要求

    情景画像から文字領域と単語の取得を行います。
    スマートフォンのカメラなどで撮影された画像から、一行分の文章・単語を切り出してご利用ください。手書き文字やデザインされた文字には対応していません。認識対応言語は日本語、英語です。

    リクエストURL

    https://api.apigw.smt.docomo.ne.jp/characterRecognition/v1/line

    メソッド : POST
    文字コード : UTF-8

    リクエストヘッダ

    キー 必須 説明
    Content-Type 送信データのMIMEタイプは、下記を指定。
    multipart/form-data

    リクエストクエリパラメータ

    キー 必須 説明
    APIKEY APIにアクセスするアプリの認証に利用する。

    リクエストボディ

    キー 必須 説明
    image 文字認識に用いる画像は、以下の条件を満たす画像のみ有効。
    ・jpeg, png形式の画像データ(透過pngは対象外)。
    ・幅8ピクセル以上、高8ピクセル以上、幅x高さ200キロピクセル以下。
    ・サイズ10メガバイト以下。
    ・認識対象文字の高さまたは幅が12ピクセル以上。
    lang 認識する言語は、下記のいずれかを指定。
    jpn (省略時)
    eng

    レスポンスヘッダ

    キー 必須 説明
    Content-type - 受信データのMIMEタイプは、下記を返却。
    application/json

    レスポンスボディ(JSON形式)

    キー 必須 説明
    job - 認識ジョブ。
       @id - 認識ジョブのID。
    サンプル値) 32B8AB3FF55E4905A9C1E3905075C457
    @status - 認識ジョブの現在の状態は、下記のいずれかを返却。
    処理成功 : success
    処理失敗 : failure
    @queue-time - リクエストの受付時刻(yyyy/mm/dd hh:mm:ss 形式)。
    サンプル値) 2013/10/22 13:12:36
    words - 単語の情報。
       @count - 抽出した単語の個数。
    サンプル値) 4
    word - 認識した単語の情報。
    ※認識が成功したときにのみ返却。
       @text - 認識した単語。
    サンプル値) 煮込み
    @score - 認識結果の信頼度。
    数値が大きいほど正しい認識結果であると推定できる。
    信頼度の範囲 : 0~100.0
    サンプル値) 100.0
    @category - 抽出した単語のカテゴリ。
    カテゴリが不明な場合は空文字列を返却。
    サンプル値) 飲食
    shape - 抽出した単語の形状を表す座標情報。
    各頂点は反時計回りの順序で並び、終端は開放。
       @count - 頂点数。
    サンプル値) 4
    point - 頂点情報。
    @x - 認識対象画像の左上を原点(0,0)とするx座標(ピクセル単位)。
    サンプル値) 296
    @y - 認識対象画像の左上を原点(0,0)とするy座標(ピクセル単位)。
    サンプル値) 4
    message - メッセージ。
       @text - 進行状況に関する出力メッセージ。

    リクエストサンプル

    POST https://api.apigw.smt.docomo.ne.jp/characterRecognition/v1/line?APIKEY=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
    
    Content-Type:multipart/form-data; boundary=----WebKitFormBoundaryhwZz6hhFHARN6wAB
    
    ------WebKitFormBoundaryhwZz6hhFHARN6wAB
    Content-Disposition: form-data; name="lang"
    
    jpn
    ------WebKitFormBoundaryhwZz6hhFHARN6wAB
    Content-Disposition: form-data; name="image"; filename="sample.png"
    Content-Type: image/png
    
    画像データ(binary)
    ------WebKitFormBoundaryhwZz6hhFHARN6wAB--
    

    レスポンスサンプル

    {
        "job":{
            "@id":"AAAAAAAAAAAAAAAAAAAAAA",
            "@status":"success",
            "@queue-time":"2013/10/22 13:12:36"
        },
        "words":{
            "@count":"3",
            "word":[
                {
                    "@text":"台湾",
                    "@score":"100.0",
                    "@category":"旅行",
                    "shape":{
                        "point":[
                            {
                                "@x":"7",
                                "@y":"23"
                            },
                            {
                                "@x":"7",
                                "@y":"67"
                            },
                            {
                                "@x":"100",
                                "@y":"67"
                            },
                            {
                                "@x":"100",
                                "@y":"23"
                            }
                        ],
                        "@count":"4"
                    }
                },
                {
                    "@text":"煮込み",
                    "@score":"100.0",
                    "@category":"飲食",
                    "shape":{
                        "point":[
                            {
                                "@x":"154",
                                "@y":"25"
                            },
                            {
                                "@x":"154",
                                "@y":"67"
                            },
                            {
                                "@x":"296",
                                "@y":"67"
                            },
                            {
                                "@x":"296",
                                "@y":"25"
                            }
                        ],
                        "@count":"4"
                    }
                },
                {
                    "@text":"豚肉",
                    "@score":"100.0",
                    "@category":"飲食",
                    "shape":{
                        "point":[
                            {
                                "@x":"301",
                                "@y":"24"
                            },
                            {
                                "@x":"301",
                                "@y":"66"
                            },
                            {
                                "@x":"389",
                                "@y":"66"
                            },
                            {
                                "@x":"389",
                                "@y":"24"
                            }
                        ],
                        "@count":"4"
                    }
                }
            ]
        },
        "message":null
    }
    
    よくあるご質問
    APIなどの各サービスに関するよくある質問を掲載します。
    お問い合わせ
    「docomo Developer support」及び「作ろうスマートフォン/iモードコンテンツ」に関するお問い合わせです。よくあるご質問や技術ブログで解決しない場合は、お問い合わせください。