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

文字認識

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

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

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

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

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

    文章画像認識結果取得

    文章画像認識の処理結果を取得します。

    テクニカルガイドライン

    本機能は文章画像認識要求で要求された処理の結果を問い合わせる機能です。
    レスポンスパラメータの進捗状況(job/@status)の値が「success」となりましたら単語の情報(lines/line)に認識結果が格納されます。

    リクエストURL

    https://api.apigw.smt.docomo.ne.jp/characterRecognition/v1/document/{@id}

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

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

    キー 必須 説明
    @id 認識ジョブIDは、文章画像認識要求のレスポンスから取得した@idを指定。
    サンプル値) 4A0485BB09AA43B7B3B600BA52570BC5

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

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

    レスポンスヘッダ

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

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

    キー 必須 説明
    job - 認識ジョブ。
       @id - 文章画像認識要求のレスポンスに含まれる認識ジョブID。
    サンプル値) 4A0485BB09AA43B7B3B600BA52570BC5
    @status - 認識ジョブの進行状況は、下記のいずれかを返却。
    要求受付済 : queue
    認識処理中 : process
    処理成功 : success
    処理失敗 : failure
    削除済 : deleted
    @queue-time - リクエストの受付時刻(yyyy/mm/dd hh:mm:ss 形式)。
    サンプル値) 2013/10/22 11:45:48
    lines - 行の情報。
       @count - 認識した行数。
    サンプル値) 4
    line - 認識した行の情報。
    ※認識が成功したときにのみ返却。
       @text - 認識した行。
    サンプル値) こんにちは、今日はよい天気ですね
    shape - 抽出した行の形状を表す座標情報。
    各頂点は反時計回りの順序で並び、終端は開放。
       @count - 頂点情報の数。
    サンプル値) 4
    point - 頂点情報。
    @x - 認識対象画像の左上を原点(0,0)とするx座標(ピクセル単位)。
    サンプル値) 296
    @y - 認識対象画像の左上を原点(0,0)とするy座標(ピクセル単位)。
    サンプル値) 4
    message - メッセージ。
       @text - 進行状況に関する出力メッセージ。
    サンプル値) 文字認識処理待ちです[2001]

    リクエストサンプル

    GET https://api.apigw.smt.docomo.ne.jp/characterRecognition/v1/document/AAAAAAAAAAAAAAAAAAAAAAAAA?APIKEY=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
    

    レスポンスサンプル1

    {
        "job":{
            "@id":"AAAAAAAAAAAAAAAAAAAAAAAAA",
            "@status":"queue",
            "@queue-time":"2013/10/22 13:11:26"
        },
        "lines":null,
        "message":{
            "@text":"文字認識処理待ちです[2001]"
        }
    }
    

    レスポンスサンプル2

    {
        "job":{
            "@id":"AAAAAAAAAAAAAAAAAAAAAAAAA",
            "@status":"success",
            "@queue-time":"2013/10/22 11:45:48"
        },
        "lines":{
            "@count":"3",
            "line":[
                {
                    "@text":"こんにちは、今日はよい天気ですね",
                    "shape":{
                        "point":[
                            {
                                "@x":"6",
                                "@y":"10"
                            },
                            {
                                "@x":"6",
                                "@y":"36"
                            },
                            {
                                "@x":"448",
                                "@y":"36"
                            },
                            {
                                "@x":"448",
                                "@y":"10"
                            }
                        ],
                        "@count":"4"
                    }
                },
                {
                    "@text":"こんにちは、ええ、そうですね。今日はどこかお出かけ",
                    "shape":{
                        "point":[
                            {
                                "@x":"6",
                                "@y":"42"
                            },
                            {
                                "@x":"6",
                                "@y":"68"
                            },
                            {
                                "@x":"656",
                                "@y":"68"
                            },
                            {
                                "@x":"656",
                                "@y":"42"
                            }
                        ],
                        "@count":"4"
                    }
                },
                {
                    "@text":"ですか?",
                    "shape":{
                        "point":[
                            {
                                "@x":"6",
                                "@y":"74"
                            },
                            {
                                "@x":"6",
                                "@y":"100"
                            },
                            {
                                "@x":"110",
                                "@y":"100"
                            },
                            {
                                "@x":"110",
                                "@y":"74"
                            }
                        ],
                        "@count":"4"
                    }
               }
            ]
        },
        "message":null
    }
    
    よくあるご質問
    APIなどの各サービスに関するよくある質問を掲載します。
    お問い合わせ
    「docomo Developer support」及び「作ろうスマートフォン/iモードコンテンツ」に関するお問い合わせです。よくあるご質問や技術ブログで解決しない場合は、お問い合わせください。