有道速讀簡介

概念解釋

有道速讀服務有道速讀服務支持快速從文檔中提取、定位、匯總信息，為你一站式解決文檔摘要、文檔解析、文檔QA方面的問題

說明

Hi，您好，歡迎使用有道智云有道速讀接口服務。

本文檔主要針對需要集成HTTP API的技術開發(fā)工程師，詳細描述有道速讀能力相關的技術內容。

如果您有與我們商務合作的需求，可以通過以下方式聯(lián)系我們：

商務郵箱： AIcloud_Business@corp.youdao.com

如果您對文檔內容有任何疑問，可以通過以下幾種方式聯(lián)系我們：

客服QQ：1906538062

AIGC產品技術交流群 ：837394306

聯(lián)系郵箱： zhiyun@corp.youdao.com

溫馨提示：

• 本文檔主要針對開發(fā)人員，接入測試前需要獲取應用ID和應用密鑰，并創(chuàng)建應用；如果您還沒有，請按照 新手指南 獲取。
• 平臺向每個賬戶贈送50元的體驗金，供用戶集成前測試所用。

協(xié)議須知

調用方在集成文檔問答API時，請遵循以下規(guī)則。

接口調用參數

有道速讀線上調用地址：

https://openapi.youdao.com/document_qa

服務耗時說明

注意：
簽名生成方法如下：
signType=v3；
sign=sha256(應用ID+input+salt+curtime+應用密鑰)；
其中，input的計算方式為：input=q前10個字符 + q長度 + q后10個字符（當q長度大于20）或 input=q字符串（當q長度小于等于20）；

有道速讀接口定義

獲取版本接口

• 接口uri：/get_version
• 接口說明：
  獲取不同模型的最新版本號，不同版本號的模型生成的結果可能不同。

• 接口參數：

• 響應結果示例

{
    "requestId": "38c7d97c-affe-43cb-be80-2ce86c279116",
    "errorCode": "0",
    "msg": "SUCCESS",
    "result": {
        "reputation_service_version": "0.0.14_20231225_dev3",  // 當前最新的論文口碑算法版本。
        "parse_service_version": "1.0.16_20240131",   // 當前最新的 PDF 解析算法版本。
        "survey_service_version": "v0.1.2",  // 當前最新的自動綜述算法版本。
        "analyze_service_version": "0.0.3_20240112_dev2"  // 當前最新的文章解讀算法版本。
    }
}

pdf解析接口

• 接口uri：/parse_pdf
• 接口說明：
  對文檔進行解析。
• 接口參數：

• 響應結果

{
    "requestId": "b470ab36-e7ea-44e8-93bd-0b3830f6aac7",
    "errorCode": "0",
    "msg": "SUCCESS",
    "result": {
        "doc_id": "/RD4Jb29sEEmggjkDYWU8QuqZZ4vKUpwJGwvML12PgnAvJZqDL5kMapKmeDk3eg/", // pdf文檔的唯一標識，后續(xù)問答、綜述接口的請求參數之一。
        "generated_questions": "", // 自動生成的推薦問題，每行一個問題。
        "whole_doc_summary": null, // 保留字段，暫不使用。
        "chunks_json": [  // 文檔解析結果
            {
                "summary": {}, // 保留字段，暫不使用
                "page_ids": [  // 標識當前chunk跨了哪些頁
                    0
                ],
                "locations": [ // 每個元素是一個block
                    {
                        "page_id": 0,
                        "page_w": "612",
                        "bbox": "74,114,462,37",
                        "lines": [ // 各行文字的bbox
                            {
                                "line_text": "On the (in)consistency of perturbation theory at finite ",
                                "line_fontsize": 17,
                                "line_bbox": "74,114,462,15"
                            },
                            {
                                "line_text": "temperature ",
                                "line_fontsize": 17,
                                "line_bbox": "253,136,104,15"
                            }
                        ],
                        "page_h": "792"
                    }
                ],
                "summary_status": 0,  // 0-無需摘要（對于title和hi類型的chunk取值為0）； 1-需要請求摘要接口生成摘要（對于normal類型的chunk取值為1）；
                "text": "On the (in)consistency of perturbation theory at finite temperature ", // 當前chunk對應的文本內容
                "chunk_id": "0", // chunk id
                "chunk_type": "title" // 當前chunk對應的文本類型， 取值：title-大標題； h1-小標題； normal-正文；
            }
        ],
        "doc_page_num": "21", // pdf 文檔總頁數 計費使用該字段
        "parse_service_version": "1.0.16_20240131" // 算法服務版本號
    }
}

摘要接口

• 接口uri：/get_summary
• 接口說明：
  對入參文本生成摘要。
• 接口參數：

• 響應結果

{
    "requestId": "4c0e5494-ae63-4ce3-ba3e-b5b59fb13034",
    "errorCode": "0",
    "msg": "SUCCESS",
    "result": "" // 摘要
}

問答接口

• 接口uri：/chat
• 接口說明：
  對文檔內容進行問答。
• 接口參數：

• 響應結果

event:request info
data: {
    "requestId": "7ebb17fb-53c9-4da1-9024-3e1021fc60a0",
    "docId": "/RD4Jb29sEEmggjkDYWU8QuqZZ4vKUpwJGwvML12PgnAvJZqDL5kMapKmeDk3eg/",
    "qaId": "6a20b56a-6d18-45d7-9f71-fa03c9eb6d20"
}

data: {
    "content": "是"
}

data: {
    "content": "的"
}

// 省略其他data

event:docsrc // 倒數第二條消息
data: {
    "sources": [
        {
            "chunk_id": "27",
            "page_id": 12
        }
    ]
}

event:end // 表示是最后一條消息
data: {
    "message": "Connection closed",
    "sources": [ // 當前信息的來源
        {
            "chunk_id": "27",
            "page_id": 12
        }
    ]
}

綜述接口

• 接口uri：/get_review
• 接口說明：
  圍繞用戶指定的文檔，生成綜述。
• 接口參數：

• 響應結果

正常結果：

event:request info
data:{requestId='4897756f-015d-4725-a717-f7829bb0babf', docId='/RD4Jb29sEEmggjkDYWU8QuqZZ4vKUpwJGwvML12PgnAvJZqDL5kMapKmeDk3eg/', qaId='null'}

event:stream  // 一堆 event = stream 的片段，其 data 都是 json
data:{"content": "# Introduction\n\nPerturbation theory, finite temperature, quantum field theory, and propagators are fundamental concepts in theoretical physics. "}

// 省略其他的 event stream

event:finished  // 一條 event = finished 的片段，其 data 也是 json，json 的content 字段是完整的自動綜述內容全文.這個片段中，包含了model_version字段，用以表明當前論文自動綜述的算法版本號。
data:{"content": "# 1. Introduction\n\nPerturbation theory, finite temperature, quantum field theory, and propagators are fundamental concepts in theoretical physics. "}

event:end  // 一條 event = end 的片段，其內容為 {"message": "Connection closed"}。
data:{"message": "Connection closed"}

異常結果：
當請求的文檔不是論文時，會只返回一條 event = end 的消息：

event:end 
data:{"message": "Connection closed"}

錯誤代碼列表