ホーム API/ツール API 知識Q&A

知識Q&A

    質問文をテキストで受け付け、回答を返却するAPIです。
    質問は話しかけるような自然な文章を入力できます。回答はズバリの回答候補を返却します。

    知識Q&A
    API
    基本情報
    提供 : REST, SDK(Android™,Server side JAVA)
    利用条件 : あり ※1

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

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

    • 知識Q&A APIは質問をテキストでインプットすると、回答を返却するAPIです。
      質問は話しかけるような自然な文章を入力できます。回答はズバリの回答候補をJSON形式で返却します。

    リクエストURL

    https://api.apigw.smt.docomo.ne.jp/knowledgeQA/v1/ask

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

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

    キー 必須 説明
    q 質問文を半角/全角2000文字以内で設定する(URLエンコード)。
    APIKEY APIにアクセスするアプリの認証に利用する。

    レスポンスヘッダ

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

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

    キー 必須 説明
    code 質問回答のレスポンスコードは、下記のいずれかを返却。
    S020000: 内部のDBからリストアップした回答
    S020001: 知識Q&A APIが計算した回答
    S020010: 外部サイトから抽出した回答候補
    S020011: 外部サイトへのリンクを回答
    E010000: 回答不能(パラメータ不備)
    E020000: 回答不能(結果0件)
    E099999: 回答不能(処理エラー)
    ※Sで始まる場合は正常回答、Eで始まる場合は回答が得られていないことを示す。
    message ユーザに返却するメッセージに関する情報。
       textForDisplay メッセージ表示用のテキスト。
    サンプル値)
      富士山の高さは、3776mです。
      インターネットで調べたところ、一位は、ガガーリンです。
      平成3年生まれの人の干支は未です。
    textForSpeech メッセージ読み上げ用のテキスト。
    読みが難しい漢字などはひらがなやカタカナが返却される場合がある。
    サンプル値)
      富士山の高さは、3776メートルです。
      インターネットで調べたところ、一位は、ガガーリンです。
      平成3年生まれの人のえとは、ひつじです。
    answers answerオブジェクトのリストを返却(回答は最大5件)。
       answer - 各回答を示すオブジェクト。
    answerという要素名はJSONデータ内では使用しない。
       rank 回答の順位。
    上位から1~5を割り当てる。
    answerText 回答テキスト。
    サンプル値) 3776m
    linkText - 引用元テキスト。
    サンプル値) wikipedia「富士山」より(2013年5月時点)
    linkUrl - 引用元URL。
    サンプル値) http://ja.wikipedia.org/wiki/富士山

    リクエストサンプル

    GET https://api.apigw.smt.docomo.ne.jp/knowledgeQA/v1/ask?q=%E4%BA%BA%E9%A1%9E%E5%88%9D%E3%81%AE%E5%AE%87%E5%AE%99%E9%A3%9B%E8%A1%8C%E5%A3%AB%E3%81%AF&APIKEY=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
    ※上記URLは下記のリクエストURLをUTF-8でエンコードしております。
    (https://api.apigw.smt.docomo.ne.jp/knowledgeQA/v1/ask?q=人類初の宇宙飛行士は?APIKEY=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx)
    

    レスポンスサンプル

    {
    code: "S020010",
    message: 
      {
        textForDisplay: "インターネットで調べたところ、一位は、ガガーリンです。",
        textForSpeech: "インターネットで調べたところ、一位は、ガガーリンです。"
      },
    answers: [
      {
        rank: "1",
        answerText: "ガガーリン",
        linkText: "ページaタイトル",
        linkUrl: "http://aaa.aaa.com"
      },
      {
        rank: "2",
        answerText: "ユーリイ・ガガーリン",
        linkText: "ページbタイトル",
        linkUrl: "http://bbb.bbb.com"
      },
      {
        rank: "3",
        answerText: "ユーリー・ガガーリン",
        linkText: "ページcタイトル",
        linkUrl: "http://ccc.ccc.com"
      },
      {
        rank: "4",
        answerText: "テレシコワ",
        linkText: "ページdタイトル",
        linkUrl: "http://ddd.ddd.com"
      },
      {
        rank: "5",
        answerText: "エドウィン・オルドリン",
        linkText: "ページeタイトル",
        linkUrl:"http://eee.eee.com"
      }
    ]
    }
    
    よくあるご質問
    APIなどの各サービスに関するよくある質問を掲載します。
    お問い合わせ
    「docomo Developer support」及び「作ろうスマートフォン/iモードコンテンツ」に関するお問い合わせです。よくあるご質問や技術ブログで解決しない場合は、お問い合わせください。