# 前置条件 ## 访问域名： https://console.volcengine.com ## 访问方式 HTTP 请求方式访问 ## 公共请求头 | | | | | \ |请求头名称 |请求头值 |字段说明 |备注 | |---|---|---|---| | | | | | \ |x-org |2102067676 |主账号ID | | | | | | | \ |x-tenant | |\ | |2985149 |项目ID |![Image](https://p9-arcosite.byteimg.com/tos-cn-i-goo7wpa0wc/12d4e1ba6a9d4d0aaf42d7d49bf183c2~tplv-goo7wpa0wc-image.image =3338x) |\ | | | |URL中的数字部分 | | | | | | \ |x-user | |用户ID |![Image](https://p9-arcosite.byteimg.com/tos-cn-i-goo7wpa0wc/acd6703d219d4ff291243fc2398957a6~tplv-goo7wpa0wc-image.image =3352x) |\ | | | |或者用主账号登录，知识库-权限管理也可以查看子账号的ID | | | | | | \ |Authorization |Bearer API_KEY |\ | | |API KEY 认证 |\ | | | |![Image](https://p9-arcosite.byteimg.com/tos-cn-i-goo7wpa0wc/db0ef02eaa874a2084b8ba354c2a88f7~tplv-goo7wpa0wc-image.image =1270x) |\ | | | |![Image](https://p9-arcosite.byteimg.com/tos-cn-i-goo7wpa0wc/beefe8a7e65446ebbe74c5189e221d75~tplv-goo7wpa0wc-image.image =1740x) |\ | | | | |\ | | | |注意 Bearer与 API_KEY之间有空格 |\ | | | |应用的编辑权限才有发布功能 | ### 请求样例 ```SQL curl 'https://console.volcengine.com/cdp/api/v2/rag/xxx' \ -H 'accept: application/json, text/plain, */*' \ -H 'accept-language: zh-CN,zh;q=0.9,en-US;q=0.8,en;q=0.7' \ -H 'content-language: cn' \ -H 'content-type: application/json' \ -H 'dnt: 1' \ -H 'origin: https://console.volcengine.com' \ -H 'priority: u=1, i' \ -H 'referer: https://console.volcengine.com/cdp/knowledge-base/2985149/knowledge/detail?id=102' \ -H 'sec-ch-ua: "Chromium";v="133", "Not(A:Brand";v="99"' \ -H 'sec-ch-ua-mobile: ?0' \ -H 'sec-ch-ua-platform: "macOS"' \ -H 'sec-fetch-dest: empty' \ -H 'sec-fetch-mode: cors' \ -H 'sec-fetch-site: same-origin' \ -H 'user-agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/133.0.0.0 Safari/537.36' \ -H 'x-org: xxx' \ -H 'x-region: cn' \ -H 'x-tenant: xxx' \ -H 'x-user: xxx' \ -H 'Authorization: Bearer xx' \ --data-raw '{"}' ``` # API详情 ## 新增文档 ### 上传文件 #### 请求方式及路径 ```Shell POST https://console.volcengine.com/cdp/api/v2/rag/file/upload ``` #### 请求参数 | | | | | | \ |参数名称 |参数值类型 |参数示例 |说明 |备注 | |---|---|---|---|---| | | | | | | \ |files |List |\ | | | |要上传的文件列表 | | #### 响应参数 | | | | | \ |参数名称 |参数类型 |参数示例 |说明 | |---|---|---|---| | | | | | \ |code |number |0 |0->成功 |\ | | | |非0->失败 | | | | | | \ |msg |string |"success" |当code为非0是包含错误信息 | | | | | | \ |data |List |[] |上传成功的文件 | ##### File | | | | | \ |参数名称 |参数值类型 |参数示例 |说明 | |---|---|---|---| | | | | | \ |id |number |329 |会话ID | | | | | | \ |created_by |string |admin |发起上传的用户名 | | | | | | \ |name |string |"" |文件名 | #### 请求示例 ```SQL curl 'https://console.volcengine.com/cdp/api/v2/rag/file/upload' \ -H 'accept: application/json, text/plain, */*' \ -H 'accept-language: zh-CN,zh;q=0.9' \ -H 'content-language: cn' \ -H 'content-type: multipart/form-data; boundary=----WebKitFormBoundaryuj6PEx480JA7BpFb' \ -b 'vcloudWebId=caaa960d-aa79-42f8-b610-20bcb16c48f5; monitor_huoshan_web_id=3748351128612115054; monitor_session_id=0711109975673790130; monitor_session_id_flag=1; user_locale=zh; volc_platform_clear_user_locale=1; s_v_web_id=mb4quj0s_UEqGmfK3_07RM_4UU0_8qVI_OnqT8iqP3CSP; signin_i18next=zh; connect.sid=s%3Ab090794a-37ba-4011-9e1d-88fe58f04a08.i%2B6ulo4J0W%2B4ANiwKr%2F67MBDRg7r2ZRCTVlnpMwCpwc; connect.sid=s%3Ab090794a-37ba-4011-9e1d-88fe58f04a08.i%2B6ulo4J0W%2B4ANiwKr%2F67MBDRg7r2ZRCTVlnpMwCpwc; userInfo=eyJhbGciOiJSUzI1NiIsImtpZCI6IjViZmU3Y2M2NGJjNDExZWY5NGU2ZThlYmQzMmVlNmUyIn0.eyJhY2NfaSI6MjEwMDA4OTg4NiwiYXVkIjpbInZvbGNlbmdpbmUiXSwiZXhwIjoxNzUwODM1MTgyLCJpIjoiZDQ2MWQ0NTgtOWZhZi00YmRiLThmNzgtNjBhN2FhNTNhOTQ5IiwiaWRfbiI6IndzbDExMjAxIiwibXNnIjpudWxsLCJzc19uIjoid3NsMTEyMDEiLCJ0IjoiQWNjb3VudCIsInRvcGljIjoic2lnbmluX3VzZXJfaW5mbyIsInZlcnNpb24iOiJ2MSIsInppcCI6IiJ9.iK59lQO8kevghUTkAI_AeZ3qf1TVoOGPxAQTvHBDxr4rEHU-zXHrVUO3UJANaQhEGLJ3Seykw7jAi91E6A3pJPFu3gLezdX6B7sBV5uBI92SlFyMSOlsyaaESp1tXrrl4vkg0Ja2Cd_MimaUE-Otea3qMtE388z73256s0aZkB6fTson-Ax71-w36bcny1PNXFRRIUE-Ns75s8KfYXUE_xvVCXMgqMeK81W3zAo72VPVZ_KhmlaqcXzL_HqLHN1O1wcmntg0oPIfxbWjtMqd7eyxJkVeDFt4IfxrNNj9wvMkW5lC_M5Zo3qmZpPwq6t3YLBDpwPGI5zp7u2u4mdYGQ; login_scene=11; csrfToken=b10e639ae00ba2d3093bc81ddbcba493; csrfToken=b10e639ae00ba2d3093bc81ddbcba493; __tea_cache_tokens_3569={%22web_id%22:%227508647195731183114%22%2C%22user_unique_id%22:%227508647195731183114%22%2C%22timestamp%22:1748243183973%2C%22_type_%22:%22default%22}; VOLCFE_im_uuid=1748243184026964694; digest=eyJhbGciOiJSUzI1NiIsImtpZCI6IjZjYmMxNjBhNGJjNDExZWY5NGU2ZThlYmQzMmVlNmUyIn0.eyJhdWQiOlsidm9sY2VuZ2luZSJdLCJleHAiOjE3NDg0MTU5ODIsImlhdCI6MTc0ODI0MzE4MiwiaXNzIjoiaHR0cHM6Ly9zaWduaW4udm9sY2VuZ2luZS5jb20iLCJqdGkiOiJkNDYxZDQ1OC05ZmFmLTRiZGItOGY3OC02MGE3YWE1M2E5NDkiLCJtc2ciOiJINHNJQUFBQUFBQUMvK0tTNFdMeFM4eE5GZUlvTDg0eE5EUXlNSlI0dnZUQ1FUYUZkeUJTeUpDTDNURTVPYjgwcjBSZzNvck5MOW1sNE1xVXdOcTAySkx6YzNQejg3emc0b0FBQUFELy8xM08xeDFSQUFBQSIsIm5hbWUiOiJ3c2wxMTIwMSIsInN1YiI6IjIxMDAwODk4ODYiLCJ0b3BpYyI6InNpZ25pbl9jcmVkZW50aWFsIiwidHJuIjoidHJuOmlhbTo6MjEwMDA4OTg4Njpyb290IiwidmVyc2lvbiI6InYxIiwiemlwIjoiZ3ppcCJ9.dmCfO1MFLVymF4NJnOhauwh9S_xfzJME5LCPrBj6phs-fWg5sts_8Pv3O5bV1vVGS2oOQEuAKpodEIvtwvLKD7Ut3_Xebec0P2e8Xxvxo02aLmXx_z1yEEfmbPGgjfprDV8tpYFkJFInzGTCFRViZaqm7bSBtgDAOFCBpoNfLTVx-pbFOFoZtYdMfRA-KmLFhBahpwGyaWBr_Ixwnq6zsMnXWQpjAAvJVzI0SKW4WBLFYxGTNr9Z8J_50UB_Hgmd2NvezVGnHn_Uq6_kTuJZYachHXD8c4IOwXgRtN83J-7hdEvgwen_SdGsjXKAskJoCJVp_UUeUEjOGQzUmX7tNg; digest=eyJhbGciOiJSUzI1NiIsImtpZCI6IjZjYmMxNjBhNGJjNDExZWY5NGU2ZThlYmQzMmVlNmUyIn0.eyJhdWQiOlsidm9sY2VuZ2luZSJdLCJleHAiOjE3NDg0MTU5ODIsImlhdCI6MTc0ODI0MzE4MiwiaXNzIjoiaHR0cHM6Ly9zaWduaW4udm9sY2VuZ2luZS5jb20iLCJqdGkiOiJkNDYxZDQ1OC05ZmFmLTRiZGItOGY3OC02MGE3YWE1M2E5NDkiLCJtc2ciOiJINHNJQUFBQUFBQUMvK0tTNFdMeFM4eE5GZUlvTDg0eE5EUXlNSlI0dnZUQ1FUYUZkeUJTeUpDTDNURTVPYjgwcjBSZzNvck5MOW1sNE1xVXdOcTAySkx6YzNQejg3emc0b0FBQUFELy8xM08xeDFSQUFBQSIsIm5hbWUiOiJ3c2wxMTIwMSIsInN1YiI6IjIxMDAwODk4ODYiLCJ0b3BpYyI6InNpZ25pbl9jcmVkZW50aWFsIiwidHJuIjoidHJuOmlhbTo6MjEwMDA4OTg4Njpyb290IiwidmVyc2lvbiI6InYxIiwiemlwIjoiZ3ppcCJ9.dmCfO1MFLVymF4NJnOhauwh9S_xfzJME5LCPrBj6phs-fWg5sts_8Pv3O5bV1vVGS2oOQEuAKpodEIvtwvLKD7Ut3_Xebec0P2e8Xxvxo02aLmXx_z1yEEfmbPGgjfprDV8tpYFkJFInzGTCFRViZaqm7bSBtgDAOFCBpoNfLTVx-pbFOFoZtYdMfRA-KmLFhBahpwGyaWBr_Ixwnq6zsMnXWQpjAAvJVzI0SKW4WBLFYxGTNr9Z8J_50UB_Hgmd2NvezVGnHn_Uq6_kTuJZYachHXD8c4IOwXgRtN83J-7hdEvgwen_SdGsjXKAskJoCJVp_UUeUEjOGQzUmX7tNg; AccountID=2100089886; AccountID=2100089886; monitor_tracing_cookie=[{%22curUrl%22:%22https://console.volcengine.com/cdp/knowledge-base/1010249/app%22%2C%22curRenderId%22:%229fcc2182-f2a1-4da7-b14e-5ca194ac9fb1%22%2C%22targetUrl%22:%22https://console.volcengine.com/cdp/knowledge-base/1010249/app%22%2C%22landingPageUrl%22:%22https://console.volcengine.com/cdp/knowledge-base%22}%2C{%22curUrl%22:%22https://console.volcengine.com/cdp/knowledge-base/1010249/knowledge%22%2C%22curRenderId%22:%22d475f9f4-e56d-4c53-bfa3-8939f68d1d37%22%2C%22targetUrl%22:%22https://console.volcengine.com/cdp/knowledge-base/1010249/knowledge%22%2C%22landingPageUrl%22:%22https://console.volcengine.com/cdp/knowledge-base%22}]' \ -H 'origin: https://console.volcengine.com' \ -H 'priority: u=1, i' \ -H 'referer: https://console.volcengine.com/cdp/knowledge-base/1010249/knowledge/create?id=323' \ -H 'sec-ch-ua: "Chromium";v="133", "Not(A:Brand";v="99"' \ -H 'sec-ch-ua-mobile: ?0' \ -H 'sec-ch-ua-platform: "macOS"' \ -H 'sec-fetch-dest: empty' \ -H 'sec-fetch-mode: cors' \ -H 'sec-fetch-site: same-origin' \ -H 'user-agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/133.0.0.0 Safari/537.36' \ -H 'x-org: xx' \ -H 'x-tenant: xx' \ -H 'X-User: xx' \ -H 'Authorization: Bearer xx' \ --data-raw $'------WebKitFormBoundaryuj6PEx480JA7BpFb\r\nContent-Disposition: form-data; name="files"; filename="食谱.pdf"\r\nContent-Type: application/pdf\r\n\r\n\r\n------WebKitFormBoundaryuj6PEx480JA7BpFb--\r\n' ``` ### 文件关联知识库 #### 请求方式及路径 ```Shell POST https://console.volcengine.com/cdp/api/v2/rag/file2document/convert ``` #### 请求参数 | | | | | \ |参数名称 |参数值类型 |参数示例 |说明 | |---|---|---|---| | | | | | \ |embd_factory |string |VolcEngine |选用的embd模型厂商 | | | | | | \ |embd_name |String |Doubao-embedding |选用的embd模型名称 | | | | | | \ |file_ids |List |[3413] |文件id，从上传文件接口返回值中获取 | | | | | | \ |kb_ids |List |[323] |要关联的知识库id | | | | | | \ |parse_config |Config |{} |解析设置 | ##### Config | | | | | \ |参数名称 |参数值类型 |参数示例 |说明 | |---|---|---|---| | | | | | \ |auto_keywords |number |0 |在查询此类关键词时，为每个块提取 N 个关键词以提高其排名得分 | | | | | | \ |auto_questions |number |0 |在查询此类问题时，为每个块提取 N 个问题以提高其排名得分 | | | | | | \ |strategy |number |2 |0 - 基于plaintext切分 |\ | | | |1 - 基于段落切分 |\ | | | |2 - 基于文档逻辑结构切分 | | | | | | \ |chunk_size |number |512 |每个块的字符长度 | | | | | | \ |detect_pdf_table |bool |true |是否识别pdf表格 | | | | | | \ |page_size_limit |number |1000 |pdf页数限制 | | | | | | \ |merge_small_chunks |bool |true |是否合并小chunk | | | | | | \ |pdf_with_ocr |bool |true |是否解析扫描件 | | | | | | \ |doctree_with_outline |bool |true |是否使用pdf的outline进行章节理解 | | | | | | \ |to_md |bool |true |是否以Markdown返回 | | | | | | \ |md_collapsed |bool |false |Markdown是否折叠 | | | | | | \ |detect_header |bool |true |excel解析是否开启表格识别 | #### 响应参数 | | | | | \ |参数名称 |参数类型 |参数示例 |说明 | |---|---|---|---| | | | | | \ |code |number |0 |0->成功 |\ | | | |非0->失败 | | | | | | \ |msg |string |"success" |当code为非0是包含错误信息 | | | | | | \ |data |List |[] |关联成功的文档 | ##### Document | | | | | \ |参数名称 |参数值类型 |参数示例 |说明 | |---|---|---|---| | | | | | \ |id |number |1 |文件 - 文档关联关系的id | | | | | | \ |file_id |number |1 |文件id | | | | | | \ |document_id |number |1 |文档id | #### 请求示例 ```SQL curl 'https://console.volcengine.com/cdp/api/v2/rag/file2document/convert' \ -H 'accept: application/json, text/plain, */*' \ -H 'accept-language: zh-CN,zh;q=0.9' \ -H 'content-language: cn' \ -H 'content-type: application/json' \ -b 'vcloudWebId=caaa960d-aa79-42f8-b610-20bcb16c48f5; monitor_huoshan_web_id=3748351128612115054; monitor_session_id=0711109975673790130; monitor_session_id_flag=1; user_locale=zh; volc_platform_clear_user_locale=1; s_v_web_id=mb4quj0s_UEqGmfK3_07RM_4UU0_8qVI_OnqT8iqP3CSP; signin_i18next=zh; connect.sid=s%3Ab090794a-37ba-4011-9e1d-88fe58f04a08.i%2B6ulo4J0W%2B4ANiwKr%2F67MBDRg7r2ZRCTVlnpMwCpwc; connect.sid=s%3Ab090794a-37ba-4011-9e1d-88fe58f04a08.i%2B6ulo4J0W%2B4ANiwKr%2F67MBDRg7r2ZRCTVlnpMwCpwc; userInfo=eyJhbGciOiJSUzI1NiIsImtpZCI6IjViZmU3Y2M2NGJjNDExZWY5NGU2ZThlYmQzMmVlNmUyIn0.eyJhY2NfaSI6MjEwMDA4OTg4NiwiYXVkIjpbInZvbGNlbmdpbmUiXSwiZXhwIjoxNzUwODM1MTgyLCJpIjoiZDQ2MWQ0NTgtOWZhZi00YmRiLThmNzgtNjBhN2FhNTNhOTQ5IiwiaWRfbiI6IndzbDExMjAxIiwibXNnIjpudWxsLCJzc19uIjoid3NsMTEyMDEiLCJ0IjoiQWNjb3VudCIsInRvcGljIjoic2lnbmluX3VzZXJfaW5mbyIsInZlcnNpb24iOiJ2MSIsInppcCI6IiJ9.iK59lQO8kevghUTkAI_AeZ3qf1TVoOGPxAQTvHBDxr4rEHU-zXHrVUO3UJANaQhEGLJ3Seykw7jAi91E6A3pJPFu3gLezdX6B7sBV5uBI92SlFyMSOlsyaaESp1tXrrl4vkg0Ja2Cd_MimaUE-Otea3qMtE388z73256s0aZkB6fTson-Ax71-w36bcny1PNXFRRIUE-Ns75s8KfYXUE_xvVCXMgqMeK81W3zAo72VPVZ_KhmlaqcXzL_HqLHN1O1wcmntg0oPIfxbWjtMqd7eyxJkVeDFt4IfxrNNj9wvMkW5lC_M5Zo3qmZpPwq6t3YLBDpwPGI5zp7u2u4mdYGQ; login_scene=11; csrfToken=b10e639ae00ba2d3093bc81ddbcba493; csrfToken=b10e639ae00ba2d3093bc81ddbcba493; __tea_cache_tokens_3569={%22web_id%22:%227508647195731183114%22%2C%22user_unique_id%22:%227508647195731183114%22%2C%22timestamp%22:1748243183973%2C%22_type_%22:%22default%22}; VOLCFE_im_uuid=1748243184026964694; digest=eyJhbGciOiJSUzI1NiIsImtpZCI6IjZjYmMxNjBhNGJjNDExZWY5NGU2ZThlYmQzMmVlNmUyIn0.eyJhdWQiOlsidm9sY2VuZ2luZSJdLCJleHAiOjE3NDg0MTU5ODIsImlhdCI6MTc0ODI0MzE4MiwiaXNzIjoiaHR0cHM6Ly9zaWduaW4udm9sY2VuZ2luZS5jb20iLCJqdGkiOiJkNDYxZDQ1OC05ZmFmLTRiZGItOGY3OC02MGE3YWE1M2E5NDkiLCJtc2ciOiJINHNJQUFBQUFBQUMvK0tTNFdMeFM4eE5GZUlvTDg0eE5EUXlNSlI0dnZUQ1FUYUZkeUJTeUpDTDNURTVPYjgwcjBSZzNvck5MOW1sNE1xVXdOcTAySkx6YzNQejg3emc0b0FBQUFELy8xM08xeDFSQUFBQSIsIm5hbWUiOiJ3c2wxMTIwMSIsInN1YiI6IjIxMDAwODk4ODYiLCJ0b3BpYyI6InNpZ25pbl9jcmVkZW50aWFsIiwidHJuIjoidHJuOmlhbTo6MjEwMDA4OTg4Njpyb290IiwidmVyc2lvbiI6InYxIiwiemlwIjoiZ3ppcCJ9.dmCfO1MFLVymF4NJnOhauwh9S_xfzJME5LCPrBj6phs-fWg5sts_8Pv3O5bV1vVGS2oOQEuAKpodEIvtwvLKD7Ut3_Xebec0P2e8Xxvxo02aLmXx_z1yEEfmbPGgjfprDV8tpYFkJFInzGTCFRViZaqm7bSBtgDAOFCBpoNfLTVx-pbFOFoZtYdMfRA-KmLFhBahpwGyaWBr_Ixwnq6zsMnXWQpjAAvJVzI0SKW4WBLFYxGTNr9Z8J_50UB_Hgmd2NvezVGnHn_Uq6_kTuJZYachHXD8c4IOwXgRtN83J-7hdEvgwen_SdGsjXKAskJoCJVp_UUeUEjOGQzUmX7tNg; digest=eyJhbGciOiJSUzI1NiIsImtpZCI6IjZjYmMxNjBhNGJjNDExZWY5NGU2ZThlYmQzMmVlNmUyIn0.eyJhdWQiOlsidm9sY2VuZ2luZSJdLCJleHAiOjE3NDg0MTU5ODIsImlhdCI6MTc0ODI0MzE4MiwiaXNzIjoiaHR0cHM6Ly9zaWduaW4udm9sY2VuZ2luZS5jb20iLCJqdGkiOiJkNDYxZDQ1OC05ZmFmLTRiZGItOGY3OC02MGE3YWE1M2E5NDkiLCJtc2ciOiJINHNJQUFBQUFBQUMvK0tTNFdMeFM4eE5GZUlvTDg0eE5EUXlNSlI0dnZUQ1FUYUZkeUJTeUpDTDNURTVPYjgwcjBSZzNvck5MOW1sNE1xVXdOcTAySkx6YzNQejg3emc0b0FBQUFELy8xM08xeDFSQUFBQSIsIm5hbWUiOiJ3c2wxMTIwMSIsInN1YiI6IjIxMDAwODk4ODYiLCJ0b3BpYyI6InNpZ25pbl9jcmVkZW50aWFsIiwidHJuIjoidHJuOmlhbTo6MjEwMDA4OTg4Njpyb290IiwidmVyc2lvbiI6InYxIiwiemlwIjoiZ3ppcCJ9.dmCfO1MFLVymF4NJnOhauwh9S_xfzJME5LCPrBj6phs-fWg5sts_8Pv3O5bV1vVGS2oOQEuAKpodEIvtwvLKD7Ut3_Xebec0P2e8Xxvxo02aLmXx_z1yEEfmbPGgjfprDV8tpYFkJFInzGTCFRViZaqm7bSBtgDAOFCBpoNfLTVx-pbFOFoZtYdMfRA-KmLFhBahpwGyaWBr_Ixwnq6zsMnXWQpjAAvJVzI0SKW4WBLFYxGTNr9Z8J_50UB_Hgmd2NvezVGnHn_Uq6_kTuJZYachHXD8c4IOwXgRtN83J-7hdEvgwen_SdGsjXKAskJoCJVp_UUeUEjOGQzUmX7tNg; AccountID=2100089886; AccountID=2100089886' \ -H 'origin: https://console.volcengine.com' \ -H 'priority: u=1, i' \ -H 'referer: https://console.volcengine.com/cdp/knowledge-base/1010249/knowledge/create?id=323' \ -H 'sec-ch-ua: "Chromium";v="133", "Not(A:Brand";v="99"' \ -H 'sec-ch-ua-mobile: ?0' \ -H 'sec-ch-ua-platform: "macOS"' \ -H 'sec-fetch-dest: empty' \ -H 'sec-fetch-mode: cors' \ -H 'sec-fetch-site: same-origin' \ -H 'user-agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/133.0.0.0 Safari/537.36' \ -H 'x-org: xx' \ -H 'x-tenant: xx' \ -H 'X-User: xx' \ -H 'Authorization: Bearer xx' \ --data-raw '{"embd_factory":"VolcEngine","embd_name":"Doubao-embedding","file_ids":[3413],"kb_ids":[323],"parser_config":{"auto_keywords":0,"auto_questions":0,"strategy":2,"chunk_size":512,"detect_pdf_table":true,"page_size_limit":1000,"merge_small_chunks":true,"pdf_with_ocr":true,"doctree_with_outline":true,"to_md":true,"md_collapsed":false,"detect_header":true},"source_type":"lark"}' ``` ### 开始解析 #### 请求方式及路径 ```Shell POST https://console.volcengine.com/cdp/api/v2/rag/document/run ``` #### 请求参数 | | | | | \ |参数名称 |参数值类型 |参数示例 |说明 | |---|---|---|---| | | | | | \ |doc_id |List |[1] |要开始解析的文档id，从convert接口返回值中获取 | | | | | | \ |run |string |"1" |表示开始解析 | #### 响应参数 | | | | | \ |参数名称 |参数类型 |参数示例 |说明 | |---|---|---|---| | | | | | \ |code |number |0 |0->成功 |\ | | | |非0->失败 | | | | | | \ |msg |string |"success" |当code为非0是包含错误信息 | | | | | | \ |data |bool |true | | #### 请求示例 ```SQL curl 'https://console.volcengine.com/cdp/api/v2/rag/document/run' \ -H 'accept: application/json, text/plain, */*' \ -H 'accept-language: zh-CN,zh;q=0.9' \ -H 'content-language: cn' \ -H 'content-type: application/json' \ -b 'vcloudWebId=caaa960d-aa79-42f8-b610-20bcb16c48f5; monitor_huoshan_web_id=3748351128612115054; monitor_session_id=0711109975673790130; monitor_session_id_flag=1; user_locale=zh; volc_platform_clear_user_locale=1; s_v_web_id=mb4quj0s_UEqGmfK3_07RM_4UU0_8qVI_OnqT8iqP3CSP; signin_i18next=zh; connect.sid=s%3Ab090794a-37ba-4011-9e1d-88fe58f04a08.i%2B6ulo4J0W%2B4ANiwKr%2F67MBDRg7r2ZRCTVlnpMwCpwc; connect.sid=s%3Ab090794a-37ba-4011-9e1d-88fe58f04a08.i%2B6ulo4J0W%2B4ANiwKr%2F67MBDRg7r2ZRCTVlnpMwCpwc; userInfo=eyJhbGciOiJSUzI1NiIsImtpZCI6IjViZmU3Y2M2NGJjNDExZWY5NGU2ZThlYmQzMmVlNmUyIn0.eyJhY2NfaSI6MjEwMDA4OTg4NiwiYXVkIjpbInZvbGNlbmdpbmUiXSwiZXhwIjoxNzUwODM1MTgyLCJpIjoiZDQ2MWQ0NTgtOWZhZi00YmRiLThmNzgtNjBhN2FhNTNhOTQ5IiwiaWRfbiI6IndzbDExMjAxIiwibXNnIjpudWxsLCJzc19uIjoid3NsMTEyMDEiLCJ0IjoiQWNjb3VudCIsInRvcGljIjoic2lnbmluX3VzZXJfaW5mbyIsInZlcnNpb24iOiJ2MSIsInppcCI6IiJ9.iK59lQO8kevghUTkAI_AeZ3qf1TVoOGPxAQTvHBDxr4rEHU-zXHrVUO3UJANaQhEGLJ3Seykw7jAi91E6A3pJPFu3gLezdX6B7sBV5uBI92SlFyMSOlsyaaESp1tXrrl4vkg0Ja2Cd_MimaUE-Otea3qMtE388z73256s0aZkB6fTson-Ax71-w36bcny1PNXFRRIUE-Ns75s8KfYXUE_xvVCXMgqMeK81W3zAo72VPVZ_KhmlaqcXzL_HqLHN1O1wcmntg0oPIfxbWjtMqd7eyxJkVeDFt4IfxrNNj9wvMkW5lC_M5Zo3qmZpPwq6t3YLBDpwPGI5zp7u2u4mdYGQ; login_scene=11; csrfToken=b10e639ae00ba2d3093bc81ddbcba493; csrfToken=b10e639ae00ba2d3093bc81ddbcba493; __tea_cache_tokens_3569={%22web_id%22:%227508647195731183114%22%2C%22user_unique_id%22:%227508647195731183114%22%2C%22timestamp%22:1748243183973%2C%22_type_%22:%22default%22}; VOLCFE_im_uuid=1748243184026964694; digest=eyJhbGciOiJSUzI1NiIsImtpZCI6IjZjYmMxNjBhNGJjNDExZWY5NGU2ZThlYmQzMmVlNmUyIn0.eyJhdWQiOlsidm9sY2VuZ2luZSJdLCJleHAiOjE3NDg0MTU5ODIsImlhdCI6MTc0ODI0MzE4MiwiaXNzIjoiaHR0cHM6Ly9zaWduaW4udm9sY2VuZ2luZS5jb20iLCJqdGkiOiJkNDYxZDQ1OC05ZmFmLTRiZGItOGY3OC02MGE3YWE1M2E5NDkiLCJtc2ciOiJINHNJQUFBQUFBQUMvK0tTNFdMeFM4eE5GZUlvTDg0eE5EUXlNSlI0dnZUQ1FUYUZkeUJTeUpDTDNURTVPYjgwcjBSZzNvck5MOW1sNE1xVXdOcTAySkx6YzNQejg3emc0b0FBQUFELy8xM08xeDFSQUFBQSIsIm5hbWUiOiJ3c2wxMTIwMSIsInN1YiI6IjIxMDAwODk4ODYiLCJ0b3BpYyI6InNpZ25pbl9jcmVkZW50aWFsIiwidHJuIjoidHJuOmlhbTo6MjEwMDA4OTg4Njpyb290IiwidmVyc2lvbiI6InYxIiwiemlwIjoiZ3ppcCJ9.dmCfO1MFLVymF4NJnOhauwh9S_xfzJME5LCPrBj6phs-fWg5sts_8Pv3O5bV1vVGS2oOQEuAKpodEIvtwvLKD7Ut3_Xebec0P2e8Xxvxo02aLmXx_z1yEEfmbPGgjfprDV8tpYFkJFInzGTCFRViZaqm7bSBtgDAOFCBpoNfLTVx-pbFOFoZtYdMfRA-KmLFhBahpwGyaWBr_Ixwnq6zsMnXWQpjAAvJVzI0SKW4WBLFYxGTNr9Z8J_50UB_Hgmd2NvezVGnHn_Uq6_kTuJZYachHXD8c4IOwXgRtN83J-7hdEvgwen_SdGsjXKAskJoCJVp_UUeUEjOGQzUmX7tNg; digest=eyJhbGciOiJSUzI1NiIsImtpZCI6IjZjYmMxNjBhNGJjNDExZWY5NGU2ZThlYmQzMmVlNmUyIn0.eyJhdWQiOlsidm9sY2VuZ2luZSJdLCJleHAiOjE3NDg0MTU5ODIsImlhdCI6MTc0ODI0MzE4MiwiaXNzIjoiaHR0cHM6Ly9zaWduaW4udm9sY2VuZ2luZS5jb20iLCJqdGkiOiJkNDYxZDQ1OC05ZmFmLTRiZGItOGY3OC02MGE3YWE1M2E5NDkiLCJtc2ciOiJINHNJQUFBQUFBQUMvK0tTNFdMeFM4eE5GZUlvTDg0eE5EUXlNSlI0dnZUQ1FUYUZkeUJTeUpDTDNURTVPYjgwcjBSZzNvck5MOW1sNE1xVXdOcTAySkx6YzNQejg3emc0b0FBQUFELy8xM08xeDFSQUFBQSIsIm5hbWUiOiJ3c2wxMTIwMSIsInN1YiI6IjIxMDAwODk4ODYiLCJ0b3BpYyI6InNpZ25pbl9jcmVkZW50aWFsIiwidHJuIjoidHJuOmlhbTo6MjEwMDA4OTg4Njpyb290IiwidmVyc2lvbiI6InYxIiwiemlwIjoiZ3ppcCJ9.dmCfO1MFLVymF4NJnOhauwh9S_xfzJME5LCPrBj6phs-fWg5sts_8Pv3O5bV1vVGS2oOQEuAKpodEIvtwvLKD7Ut3_Xebec0P2e8Xxvxo02aLmXx_z1yEEfmbPGgjfprDV8tpYFkJFInzGTCFRViZaqm7bSBtgDAOFCBpoNfLTVx-pbFOFoZtYdMfRA-KmLFhBahpwGyaWBr_Ixwnq6zsMnXWQpjAAvJVzI0SKW4WBLFYxGTNr9Z8J_50UB_Hgmd2NvezVGnHn_Uq6_kTuJZYachHXD8c4IOwXgRtN83J-7hdEvgwen_SdGsjXKAskJoCJVp_UUeUEjOGQzUmX7tNg; AccountID=2100089886; AccountID=2100089886' \ -H 'origin: https://console.volcengine.com' \ -H 'priority: u=1, i' \ -H 'referer: https://console.volcengine.com/cdp/knowledge-base/1010249/knowledge/detail?id=323' \ -H 'sec-ch-ua: "Chromium";v="133", "Not(A:Brand";v="99"' \ -H 'sec-ch-ua-mobile: ?0' \ -H 'sec-ch-ua-platform: "macOS"' \ -H 'sec-fetch-dest: empty' \ -H 'sec-fetch-mode: cors' \ -H 'sec-fetch-site: same-origin' \ -H 'user-agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/133.0.0.0 Safari/537.36' \ -H 'x-org: xx' \ -H 'x-tenant: xx' \ -H 'X-User: xx' \ -H 'Authorization: Bearer xx' \ --data-raw '{"doc_ids":[3278],"run":"1"}' ``` ## 删除文档 ### 请求方式及路径 ```Shell POST https://console.volcengine.com/cdp/api/v2/rag/document/rm/{doc_id} ``` ### 请求参数 | | | | | \ |参数名称 |参数值类型 |参数示例 |说明 | |---|---|---|---| | | | | | \ |doc_id |number |300 |放在请求路径中 | ### 响应参数 | | | | | \ |参数名称 |参数类型 |参数示例 |说明 | |---|---|---|---| | | | | | \ |code |number |0 |0->成功 |\ | | | |非0->失败 | | | | | | \ |msg |string |"success" |当code为非0是包含错误信息 | | | | | | \ |data |bool |true | | ### 请求示例 ```SQL curl 'https://console.volcengine.com/cdp/api/v2/rag/document/rm/3278' \ -H 'accept: application/json, text/plain, */*' \ -H 'accept-language: zh-CN,zh;q=0.9' \ -H 'content-language: cn' \ -H 'content-type: application/json' \ -b 'vcloudWebId=caaa960d-aa79-42f8-b610-20bcb16c48f5; monitor_huoshan_web_id=3748351128612115054; monitor_session_id=0711109975673790130; monitor_session_id_flag=1; user_locale=zh; volc_platform_clear_user_locale=1; s_v_web_id=mb4quj0s_UEqGmfK3_07RM_4UU0_8qVI_OnqT8iqP3CSP; signin_i18next=zh; connect.sid=s%3Ab090794a-37ba-4011-9e1d-88fe58f04a08.i%2B6ulo4J0W%2B4ANiwKr%2F67MBDRg7r2ZRCTVlnpMwCpwc; connect.sid=s%3Ab090794a-37ba-4011-9e1d-88fe58f04a08.i%2B6ulo4J0W%2B4ANiwKr%2F67MBDRg7r2ZRCTVlnpMwCpwc; userInfo=eyJhbGciOiJSUzI1NiIsImtpZCI6IjViZmU3Y2M2NGJjNDExZWY5NGU2ZThlYmQzMmVlNmUyIn0.eyJhY2NfaSI6MjEwMDA4OTg4NiwiYXVkIjpbInZvbGNlbmdpbmUiXSwiZXhwIjoxNzUwODM1MTgyLCJpIjoiZDQ2MWQ0NTgtOWZhZi00YmRiLThmNzgtNjBhN2FhNTNhOTQ5IiwiaWRfbiI6IndzbDExMjAxIiwibXNnIjpudWxsLCJzc19uIjoid3NsMTEyMDEiLCJ0IjoiQWNjb3VudCIsInRvcGljIjoic2lnbmluX3VzZXJfaW5mbyIsInZlcnNpb24iOiJ2MSIsInppcCI6IiJ9.iK59lQO8kevghUTkAI_AeZ3qf1TVoOGPxAQTvHBDxr4rEHU-zXHrVUO3UJANaQhEGLJ3Seykw7jAi91E6A3pJPFu3gLezdX6B7sBV5uBI92SlFyMSOlsyaaESp1tXrrl4vkg0Ja2Cd_MimaUE-Otea3qMtE388z73256s0aZkB6fTson-Ax71-w36bcny1PNXFRRIUE-Ns75s8KfYXUE_xvVCXMgqMeK81W3zAo72VPVZ_KhmlaqcXzL_HqLHN1O1wcmntg0oPIfxbWjtMqd7eyxJkVeDFt4IfxrNNj9wvMkW5lC_M5Zo3qmZpPwq6t3YLBDpwPGI5zp7u2u4mdYGQ; login_scene=11; csrfToken=b10e639ae00ba2d3093bc81ddbcba493; csrfToken=b10e639ae00ba2d3093bc81ddbcba493; VOLCFE_im_uuid=1748243184026964694; __tea_cache_tokens_3569={%22web_id%22:%227508647195731183114%22%2C%22user_unique_id%22:%227508647195731183114%22%2C%22timestamp%22:1748249248365%2C%22_type_%22:%22default%22}; digest=eyJhbGciOiJSUzI1NiIsImtpZCI6IjZjYmMxNjBhNGJjNDExZWY5NGU2ZThlYmQzMmVlNmUyIn0.eyJhdWQiOlsidm9sY2VuZ2luZSJdLCJleHAiOjE3NDg0MTU5ODIsImlhdCI6MTc0ODI0MzE4MiwiaXNzIjoiaHR0cHM6Ly9zaWduaW4udm9sY2VuZ2luZS5jb20iLCJqdGkiOiJkNDYxZDQ1OC05ZmFmLTRiZGItOGY3OC02MGE3YWE1M2E5NDkiLCJtc2ciOiJINHNJQUFBQUFBQUMvK0tTNFdMeFM4eE5GZUlvTDg0eE5EUXlNSlI0dnZUQ1FUYUZkeUJTeUpDTDNURTVPYjgwcjBSZzNvck5MOW1sNE1xVXdOcTAySkx6YzNQejg3emc0b0FBQUFELy8xM08xeDFSQUFBQSIsIm5hbWUiOiJ3c2wxMTIwMSIsInN1YiI6IjIxMDAwODk4ODYiLCJ0b3BpYyI6InNpZ25pbl9jcmVkZW50aWFsIiwidHJuIjoidHJuOmlhbTo6MjEwMDA4OTg4Njpyb290IiwidmVyc2lvbiI6InYxIiwiemlwIjoiZ3ppcCJ9.dmCfO1MFLVymF4NJnOhauwh9S_xfzJME5LCPrBj6phs-fWg5sts_8Pv3O5bV1vVGS2oOQEuAKpodEIvtwvLKD7Ut3_Xebec0P2e8Xxvxo02aLmXx_z1yEEfmbPGgjfprDV8tpYFkJFInzGTCFRViZaqm7bSBtgDAOFCBpoNfLTVx-pbFOFoZtYdMfRA-KmLFhBahpwGyaWBr_Ixwnq6zsMnXWQpjAAvJVzI0SKW4WBLFYxGTNr9Z8J_50UB_Hgmd2NvezVGnHn_Uq6_kTuJZYachHXD8c4IOwXgRtN83J-7hdEvgwen_SdGsjXKAskJoCJVp_UUeUEjOGQzUmX7tNg; digest=eyJhbGciOiJSUzI1NiIsImtpZCI6IjZjYmMxNjBhNGJjNDExZWY5NGU2ZThlYmQzMmVlNmUyIn0.eyJhdWQiOlsidm9sY2VuZ2luZSJdLCJleHAiOjE3NDg0MTU5ODIsImlhdCI6MTc0ODI0MzE4MiwiaXNzIjoiaHR0cHM6Ly9zaWduaW4udm9sY2VuZ2luZS5jb20iLCJqdGkiOiJkNDYxZDQ1OC05ZmFmLTRiZGItOGY3OC02MGE3YWE1M2E5NDkiLCJtc2ciOiJINHNJQUFBQUFBQUMvK0tTNFdMeFM4eE5GZUlvTDg0eE5EUXlNSlI0dnZUQ1FUYUZkeUJTeUpDTDNURTVPYjgwcjBSZzNvck5MOW1sNE1xVXdOcTAySkx6YzNQejg3emc0b0FBQUFELy8xM08xeDFSQUFBQSIsIm5hbWUiOiJ3c2wxMTIwMSIsInN1YiI6IjIxMDAwODk4ODYiLCJ0b3BpYyI6InNpZ25pbl9jcmVkZW50aWFsIiwidHJuIjoidHJuOmlhbTo6MjEwMDA4OTg4Njpyb290IiwidmVyc2lvbiI6InYxIiwiemlwIjoiZ3ppcCJ9.dmCfO1MFLVymF4NJnOhauwh9S_xfzJME5LCPrBj6phs-fWg5sts_8Pv3O5bV1vVGS2oOQEuAKpodEIvtwvLKD7Ut3_Xebec0P2e8Xxvxo02aLmXx_z1yEEfmbPGgjfprDV8tpYFkJFInzGTCFRViZaqm7bSBtgDAOFCBpoNfLTVx-pbFOFoZtYdMfRA-KmLFhBahpwGyaWBr_Ixwnq6zsMnXWQpjAAvJVzI0SKW4WBLFYxGTNr9Z8J_50UB_Hgmd2NvezVGnHn_Uq6_kTuJZYachHXD8c4IOwXgRtN83J-7hdEvgwen_SdGsjXKAskJoCJVp_UUeUEjOGQzUmX7tNg; AccountID=2100089886; AccountID=2100089886' \ -H 'origin: https://console.volcengine.com' \ -H 'priority: u=1, i' \ -H 'referer: https://console.volcengine.com/cdp/knowledge-base/1010249/knowledge/detail?id=323' \ -H 'sec-ch-ua: "Chromium";v="133", "Not(A:Brand";v="99"' \ -H 'sec-ch-ua-mobile: ?0' \ -H 'sec-ch-ua-platform: "macOS"' \ -H 'sec-fetch-dest: empty' \ -H 'sec-fetch-mode: cors' \ -H 'sec-fetch-site: same-origin' \ -H 'user-agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/133.0.0.0 Safari/537.36' \ -H 'x-org: xx' \ -H 'x-tenant: xx' \ -H 'X-User: xx' \ -H 'Authorization: Bearer xx' \ --data-raw '{}' ``` ## 修改Chunk ### 请求方式及路径 ```Shell POST https://console.volcengine.com/cdp/api/v2/rag/chunk/set ``` ### 请求参数 | | | | | \ |参数名称 |参数值类型 |参数示例 |说明 | |---|---|---|---| | | | | | \ |chunk_id |string |"" |chunk的ID | | | | | | \ |doc_id |string |"" |所属文件的id | | | | | | \ |content_with_weight |string |"" |修改后的chunk内容 | ### 响应参数 | | | | | \ |参数名称 |参数类型 |参数示例 |说明 | |---|---|---|---| | | | | | \ |code |number |0 |0->成功 |\ | | | |非0->失败 | | | | | | \ |msg |string |"success" |当code为非0是包含错误信息 | | | | | | \ |data |bool |true | | ### 请求示例 ```SQL curl 'https://console.volcengine.com/cdp/api/v2/rag/chunk/set' \ -H 'accept: application/json, text/plain, */*' \ -H 'accept-language: zh-CN,zh;q=0.9' \ -H 'content-language: cn' \ -H 'content-type: application/json' \ -b 'vcloudWebId=caaa960d-aa79-42f8-b610-20bcb16c48f5; monitor_huoshan_web_id=3748351128612115054; monitor_session_id=0711109975673790130; monitor_session_id_flag=1; user_locale=zh; volc_platform_clear_user_locale=1; s_v_web_id=mb4quj0s_UEqGmfK3_07RM_4UU0_8qVI_OnqT8iqP3CSP; signin_i18next=zh; connect.sid=s%3Ab090794a-37ba-4011-9e1d-88fe58f04a08.i%2B6ulo4J0W%2B4ANiwKr%2F67MBDRg7r2ZRCTVlnpMwCpwc; connect.sid=s%3Ab090794a-37ba-4011-9e1d-88fe58f04a08.i%2B6ulo4J0W%2B4ANiwKr%2F67MBDRg7r2ZRCTVlnpMwCpwc; userInfo=eyJhbGciOiJSUzI1NiIsImtpZCI6IjViZmU3Y2M2NGJjNDExZWY5NGU2ZThlYmQzMmVlNmUyIn0.eyJhY2NfaSI6MjEwMDA4OTg4NiwiYXVkIjpbInZvbGNlbmdpbmUiXSwiZXhwIjoxNzUwODM1MTgyLCJpIjoiZDQ2MWQ0NTgtOWZhZi00YmRiLThmNzgtNjBhN2FhNTNhOTQ5IiwiaWRfbiI6IndzbDExMjAxIiwibXNnIjpudWxsLCJzc19uIjoid3NsMTEyMDEiLCJ0IjoiQWNjb3VudCIsInRvcGljIjoic2lnbmluX3VzZXJfaW5mbyIsInZlcnNpb24iOiJ2MSIsInppcCI6IiJ9.iK59lQO8kevghUTkAI_AeZ3qf1TVoOGPxAQTvHBDxr4rEHU-zXHrVUO3UJANaQhEGLJ3Seykw7jAi91E6A3pJPFu3gLezdX6B7sBV5uBI92SlFyMSOlsyaaESp1tXrrl4vkg0Ja2Cd_MimaUE-Otea3qMtE388z73256s0aZkB6fTson-Ax71-w36bcny1PNXFRRIUE-Ns75s8KfYXUE_xvVCXMgqMeK81W3zAo72VPVZ_KhmlaqcXzL_HqLHN1O1wcmntg0oPIfxbWjtMqd7eyxJkVeDFt4IfxrNNj9wvMkW5lC_M5Zo3qmZpPwq6t3YLBDpwPGI5zp7u2u4mdYGQ; login_scene=11; csrfToken=b10e639ae00ba2d3093bc81ddbcba493; csrfToken=b10e639ae00ba2d3093bc81ddbcba493; VOLCFE_im_uuid=1748243184026964694; __tea_cache_tokens_3569={%22web_id%22:%227508647195731183114%22%2C%22user_unique_id%22:%227508647195731183114%22%2C%22timestamp%22:1748249248365%2C%22_type_%22:%22default%22}; digest=eyJhbGciOiJSUzI1NiIsImtpZCI6IjZjYmMxNjBhNGJjNDExZWY5NGU2ZThlYmQzMmVlNmUyIn0.eyJhdWQiOlsidm9sY2VuZ2luZSJdLCJleHAiOjE3NDg0MTU5ODIsImlhdCI6MTc0ODI0MzE4MiwiaXNzIjoiaHR0cHM6Ly9zaWduaW4udm9sY2VuZ2luZS5jb20iLCJqdGkiOiJkNDYxZDQ1OC05ZmFmLTRiZGItOGY3OC02MGE3YWE1M2E5NDkiLCJtc2ciOiJINHNJQUFBQUFBQUMvK0tTNFdMeFM4eE5GZUlvTDg0eE5EUXlNSlI0dnZUQ1FUYUZkeUJTeUpDTDNURTVPYjgwcjBSZzNvck5MOW1sNE1xVXdOcTAySkx6YzNQejg3emc0b0FBQUFELy8xM08xeDFSQUFBQSIsIm5hbWUiOiJ3c2wxMTIwMSIsInN1YiI6IjIxMDAwODk4ODYiLCJ0b3BpYyI6InNpZ25pbl9jcmVkZW50aWFsIiwidHJuIjoidHJuOmlhbTo6MjEwMDA4OTg4Njpyb290IiwidmVyc2lvbiI6InYxIiwiemlwIjoiZ3ppcCJ9.dmCfO1MFLVymF4NJnOhauwh9S_xfzJME5LCPrBj6phs-fWg5sts_8Pv3O5bV1vVGS2oOQEuAKpodEIvtwvLKD7Ut3_Xebec0P2e8Xxvxo02aLmXx_z1yEEfmbPGgjfprDV8tpYFkJFInzGTCFRViZaqm7bSBtgDAOFCBpoNfLTVx-pbFOFoZtYdMfRA-KmLFhBahpwGyaWBr_Ixwnq6zsMnXWQpjAAvJVzI0SKW4WBLFYxGTNr9Z8J_50UB_Hgmd2NvezVGnHn_Uq6_kTuJZYachHXD8c4IOwXgRtN83J-7hdEvgwen_SdGsjXKAskJoCJVp_UUeUEjOGQzUmX7tNg; digest=eyJhbGciOiJSUzI1NiIsImtpZCI6IjZjYmMxNjBhNGJjNDExZWY5NGU2ZThlYmQzMmVlNmUyIn0.eyJhdWQiOlsidm9sY2VuZ2luZSJdLCJleHAiOjE3NDg0MTU5ODIsImlhdCI6MTc0ODI0MzE4MiwiaXNzIjoiaHR0cHM6Ly9zaWduaW4udm9sY2VuZ2luZS5jb20iLCJqdGkiOiJkNDYxZDQ1OC05ZmFmLTRiZGItOGY3OC02MGE3YWE1M2E5NDkiLCJtc2ciOiJINHNJQUFBQUFBQUMvK0tTNFdMeFM4eE5GZUlvTDg0eE5EUXlNSlI0dnZUQ1FUYUZkeUJTeUpDTDNURTVPYjgwcjBSZzNvck5MOW1sNE1xVXdOcTAySkx6YzNQejg3emc0b0FBQUFELy8xM08xeDFSQUFBQSIsIm5hbWUiOiJ3c2wxMTIwMSIsInN1YiI6IjIxMDAwODk4ODYiLCJ0b3BpYyI6InNpZ25pbl9jcmVkZW50aWFsIiwidHJuIjoidHJuOmlhbTo6MjEwMDA4OTg4Njpyb290IiwidmVyc2lvbiI6InYxIiwiemlwIjoiZ3ppcCJ9.dmCfO1MFLVymF4NJnOhauwh9S_xfzJME5LCPrBj6phs-fWg5sts_8Pv3O5bV1vVGS2oOQEuAKpodEIvtwvLKD7Ut3_Xebec0P2e8Xxvxo02aLmXx_z1yEEfmbPGgjfprDV8tpYFkJFInzGTCFRViZaqm7bSBtgDAOFCBpoNfLTVx-pbFOFoZtYdMfRA-KmLFhBahpwGyaWBr_Ixwnq6zsMnXWQpjAAvJVzI0SKW4WBLFYxGTNr9Z8J_50UB_Hgmd2NvezVGnHn_Uq6_kTuJZYachHXD8c4IOwXgRtN83J-7hdEvgwen_SdGsjXKAskJoCJVp_UUeUEjOGQzUmX7tNg; AccountID=2100089886; AccountID=2100089886' \ -H 'origin: https://console.volcengine.com' \ -H 'priority: u=1, i' \ -H 'referer: https://console.volcengine.com/cdp/knowledge-base/1010249/knowledge/document-detail?id=3047&kb_id=323&category=general' \ -H 'sec-ch-ua: "Chromium";v="133", "Not(A:Brand";v="99"' \ -H 'sec-ch-ua-mobile: ?0' \ -H 'sec-ch-ua-platform: "macOS"' \ -H 'sec-fetch-dest: empty' \ -H 'sec-fetch-mode: cors' \ -H 'sec-fetch-site: same-origin' \ -H 'user-agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/133.0.0.0 Safari/537.36' \ -H 'x-org: xx' \ -H 'x-tenant: xx' \ -H 'X-User: xx' \ -H 'Authorization: Bearer xx' \ --data-raw '{"available_int":1,"important_kwd":[],"content_with_weight":"# 务必自行转向、制动或加速,尤其当主动式侧面盲点辅助警告您或施加路线校正制动时。\n务必保持两侧的安全车距","chunk_id":"bc2d3ab54ac449ad8cdb371a84fca15b","doc_id":3047}' ``` ## 查询文档 ### 请求方式及路径 ```Shell GET https://console.volcengine.com/cdp/api/v2/rag/document/list?page_size=xx&keywords=xx&kb_id=xx ``` ### 请求参数 | | | | | \ |参数名称 |参数值类型 |参数示例 |说明 | |---|---|---|---| | | | | | \ |page |number |1 |页码 | | | | | | \ |page_size |number |20 |页大小 | | | | | | \ |keywords |string |"hello" |模糊匹配，查询关键词 | | | | | | \ |kb_id |number |20 |所属知识库id | ### 响应参数 | | | | | \ |参数名称 |参数类型 |参数示例 |说明 | |---|---|---|---| | | | | | \ |code |number |0 |0->成功 |\ | | | |非0->失败 | | | | | | \ |msg |string |"success" |当code为非0是包含错误信息 | | | | | | \ |data |RelavantDocument |{} | | #### RelavantDocument | | | | | \ |参数名称 |参数类型 |参数示例 |说明 | |---|---|---|---| | | | | | \ |total |number |1 |查询到的文档总数 | | | | | | \ |page |number |1 |页码 | | | | | | \ |page_size |number |20 |页大小 | | | | | | \ |item |List | |文档详情 | #### Document | | | | | \ |参数名称 |参数类型 |参数示例 |说明 | |---|---|---|---| | | | | | \ |name |string |"hello.html" |文档名 | | | | | | \ |kb_id |number |1 |所属知识库id | | | | | | \ |token_num |number |10000 |文档tokens总数 | | | | | | \ |chunk_num |number |5000 |文档划分出的chunk数 | | | | | | \ |source_type |string |"lark" |lark - 飞书解析 |\ | | | |local - 原生解析 | | | | | | \ |parser_config |Config |{} |文档解析设置，与“文件关联知识库”的请求参数 - Config相同 | ### 请求示例 ```SQL curl 'https://console.volcengine.com/cdp/api/v2/rag/document/list?page=1&page_size=50&keywords=EQE&kb_id=323' \ -H 'accept: application/json, text/plain, */*' \ -H 'accept-language: zh-CN,zh;q=0.9' \ -H 'content-language: cn' \ -b 'vcloudWebId=caaa960d-aa79-42f8-b610-20bcb16c48f5; monitor_huoshan_web_id=3748351128612115054; monitor_session_id=0711109975673790130; monitor_session_id_flag=1; user_locale=zh; volc_platform_clear_user_locale=1; s_v_web_id=mb4quj0s_UEqGmfK3_07RM_4UU0_8qVI_OnqT8iqP3CSP; signin_i18next=zh; connect.sid=s%3Ab090794a-37ba-4011-9e1d-88fe58f04a08.i%2B6ulo4J0W%2B4ANiwKr%2F67MBDRg7r2ZRCTVlnpMwCpwc; connect.sid=s%3Ab090794a-37ba-4011-9e1d-88fe58f04a08.i%2B6ulo4J0W%2B4ANiwKr%2F67MBDRg7r2ZRCTVlnpMwCpwc; userInfo=eyJhbGciOiJSUzI1NiIsImtpZCI6IjViZmU3Y2M2NGJjNDExZWY5NGU2ZThlYmQzMmVlNmUyIn0.eyJhY2NfaSI6MjEwMDA4OTg4NiwiYXVkIjpbInZvbGNlbmdpbmUiXSwiZXhwIjoxNzUwODM1MTgyLCJpIjoiZDQ2MWQ0NTgtOWZhZi00YmRiLThmNzgtNjBhN2FhNTNhOTQ5IiwiaWRfbiI6IndzbDExMjAxIiwibXNnIjpudWxsLCJzc19uIjoid3NsMTEyMDEiLCJ0IjoiQWNjb3VudCIsInRvcGljIjoic2lnbmluX3VzZXJfaW5mbyIsInZlcnNpb24iOiJ2MSIsInppcCI6IiJ9.iK59lQO8kevghUTkAI_AeZ3qf1TVoOGPxAQTvHBDxr4rEHU-zXHrVUO3UJANaQhEGLJ3Seykw7jAi91E6A3pJPFu3gLezdX6B7sBV5uBI92SlFyMSOlsyaaESp1tXrrl4vkg0Ja2Cd_MimaUE-Otea3qMtE388z73256s0aZkB6fTson-Ax71-w36bcny1PNXFRRIUE-Ns75s8KfYXUE_xvVCXMgqMeK81W3zAo72VPVZ_KhmlaqcXzL_HqLHN1O1wcmntg0oPIfxbWjtMqd7eyxJkVeDFt4IfxrNNj9wvMkW5lC_M5Zo3qmZpPwq6t3YLBDpwPGI5zp7u2u4mdYGQ; login_scene=11; csrfToken=b10e639ae00ba2d3093bc81ddbcba493; csrfToken=b10e639ae00ba2d3093bc81ddbcba493; VOLCFE_im_uuid=1748243184026964694; __tea_cache_tokens_3569={%22web_id%22:%227508647195731183114%22%2C%22user_unique_id%22:%227508647195731183114%22%2C%22timestamp%22:1748249248365%2C%22_type_%22:%22default%22}; digest=eyJhbGciOiJSUzI1NiIsImtpZCI6IjZjYmMxNjBhNGJjNDExZWY5NGU2ZThlYmQzMmVlNmUyIn0.eyJhdWQiOlsidm9sY2VuZ2luZSJdLCJleHAiOjE3NDg0MTU5ODIsImlhdCI6MTc0ODI0MzE4MiwiaXNzIjoiaHR0cHM6Ly9zaWduaW4udm9sY2VuZ2luZS5jb20iLCJqdGkiOiJkNDYxZDQ1OC05ZmFmLTRiZGItOGY3OC02MGE3YWE1M2E5NDkiLCJtc2ciOiJINHNJQUFBQUFBQUMvK0tTNFdMeFM4eE5GZUlvTDg0eE5EUXlNSlI0dnZUQ1FUYUZkeUJTeUpDTDNURTVPYjgwcjBSZzNvck5MOW1sNE1xVXdOcTAySkx6YzNQejg3emc0b0FBQUFELy8xM08xeDFSQUFBQSIsIm5hbWUiOiJ3c2wxMTIwMSIsInN1YiI6IjIxMDAwODk4ODYiLCJ0b3BpYyI6InNpZ25pbl9jcmVkZW50aWFsIiwidHJuIjoidHJuOmlhbTo6MjEwMDA4OTg4Njpyb290IiwidmVyc2lvbiI6InYxIiwiemlwIjoiZ3ppcCJ9.dmCfO1MFLVymF4NJnOhauwh9S_xfzJME5LCPrBj6phs-fWg5sts_8Pv3O5bV1vVGS2oOQEuAKpodEIvtwvLKD7Ut3_Xebec0P2e8Xxvxo02aLmXx_z1yEEfmbPGgjfprDV8tpYFkJFInzGTCFRViZaqm7bSBtgDAOFCBpoNfLTVx-pbFOFoZtYdMfRA-KmLFhBahpwGyaWBr_Ixwnq6zsMnXWQpjAAvJVzI0SKW4WBLFYxGTNr9Z8J_50UB_Hgmd2NvezVGnHn_Uq6_kTuJZYachHXD8c4IOwXgRtN83J-7hdEvgwen_SdGsjXKAskJoCJVp_UUeUEjOGQzUmX7tNg; digest=eyJhbGciOiJSUzI1NiIsImtpZCI6IjZjYmMxNjBhNGJjNDExZWY5NGU2ZThlYmQzMmVlNmUyIn0.eyJhdWQiOlsidm9sY2VuZ2luZSJdLCJleHAiOjE3NDg0MTU5ODIsImlhdCI6MTc0ODI0MzE4MiwiaXNzIjoiaHR0cHM6Ly9zaWduaW4udm9sY2VuZ2luZS5jb20iLCJqdGkiOiJkNDYxZDQ1OC05ZmFmLTRiZGItOGY3OC02MGE3YWE1M2E5NDkiLCJtc2ciOiJINHNJQUFBQUFBQUMvK0tTNFdMeFM4eE5GZUlvTDg0eE5EUXlNSlI0dnZUQ1FUYUZkeUJTeUpDTDNURTVPYjgwcjBSZzNvck5MOW1sNE1xVXdOcTAySkx6YzNQejg3emc0b0FBQUFELy8xM08xeDFSQUFBQSIsIm5hbWUiOiJ3c2wxMTIwMSIsInN1YiI6IjIxMDAwODk4ODYiLCJ0b3BpYyI6InNpZ25pbl9jcmVkZW50aWFsIiwidHJuIjoidHJuOmlhbTo6MjEwMDA4OTg4Njpyb290IiwidmVyc2lvbiI6InYxIiwiemlwIjoiZ3ppcCJ9.dmCfO1MFLVymF4NJnOhauwh9S_xfzJME5LCPrBj6phs-fWg5sts_8Pv3O5bV1vVGS2oOQEuAKpodEIvtwvLKD7Ut3_Xebec0P2e8Xxvxo02aLmXx_z1yEEfmbPGgjfprDV8tpYFkJFInzGTCFRViZaqm7bSBtgDAOFCBpoNfLTVx-pbFOFoZtYdMfRA-KmLFhBahpwGyaWBr_Ixwnq6zsMnXWQpjAAvJVzI0SKW4WBLFYxGTNr9Z8J_50UB_Hgmd2NvezVGnHn_Uq6_kTuJZYachHXD8c4IOwXgRtN83J-7hdEvgwen_SdGsjXKAskJoCJVp_UUeUEjOGQzUmX7tNg; AccountID=2100089886; AccountID=2100089886; monitor_tracing_cookie=[{%22curUrl%22:%22https://console.volcengine.com/cdp/knowledge-base/1010249/knowledge/list%22%2C%22curRenderId%22:%2247964890-c8ae-49be-9b7d-6b761ad16425%22%2C%22targetUrl%22:%22https://console.volcengine.com/cdp/knowledge-base/1010249/knowledge%22%2C%22landingPageUrl%22:%22https://console.volcengine.com/cdp/knowledge-base%22}]' \ -H 'priority: u=1, i' \ -H 'referer: https://console.volcengine.com/cdp/knowledge-base/1010249/knowledge/detail?id=323' \ -H 'sec-ch-ua: "Chromium";v="133", "Not(A:Brand";v="99"' \ -H 'sec-ch-ua-mobile: ?0' \ -H 'sec-ch-ua-platform: "macOS"' \ -H 'sec-fetch-dest: empty' \ -H 'sec-fetch-mode: cors' \ -H 'sec-fetch-site: same-origin' \ -H 'user-agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/133.0.0.0 Safari/537.36' \ -H 'x-org: xx' \ -H 'x-tenant: xx' \ -H 'X-User: xx' \ -H 'Authorization: Bearer xx' \ ``` ### 响应示例 ```JSON { "code": 0, "msg": "success", "data": { "total": 1, "page": 1, "page_size": 50, "items": [ { "create_time": 1747400449824, "create_date": "2025-05-16 21:00:49", "update_time": 1748251097357, "update_date": "2025-05-26 17:18:17", "id": 3047, "thumbnail": null, "kb_id": 323, "parser_id": "7505027800571740179", "parser_config": { "auto_keywords": 0, "auto_questions": 0, "strategy": 2, "chunk_size": 512, "detect_pdf_table": true, "detect_pdf_img": false, "page_size_limit": 1000, "merge_small_chunks": true, "pdf_with_ocr": true, "doctree_with_outline": true, "to_md": true, "md_collapsed": false, "detect_header": true, "file_trans_timeout": 60, "slides_full_page_as_image": false, "chunk_with_vlm": false }, "source_type": "lark", "type": "markdown", "created_by": "wsl11201", "name": "hello.md", "location": "hello.md", "size": 969988, "token_num": 495135, "chunk_num": 5261, "progress": 1.0, "progress_msg": "Task Process Done!", "process_begin_at": "2025-05-16 21:00:53", "process_duation": 131.621, "run": "3", "status": "1" } ] }, "message": null } ``` ## 拉取会话列表 ### 请求方式及路径 ```Shell GET https://console.volcengine.com/cdp/api/v2/rag/conversation/list ``` ### 请求参数 | | | | | | \ |参数名称 |参数值类型 |参数示例 |说明 |备注 | |---|---|---|---|---| | | | | | | \ |dialog_id |number |81 |应用ID |\ | | | | |![Image](https://p9-arcosite.byteimg.com/tos-cn-i-goo7wpa0wc/5fe16ee3cfcb4de49283e573c893e6eb~tplv-goo7wpa0wc-image.image =2726x) |\ | | | | |URL中dialog_id=xx | ### 响应参数 | | | | | \ |参数名称 |参数类型 |参数示例 |说明 | |---|---|---|---| | | | | | \ |code |number |0 |0->成功 |\ | | | |非0->失败 | | | | | | \ |msg |string |"success" |当code为非0是包含错误信息 | | | | | | \ |data |List |[] |会话列表 | #### Conversation | | | | | \ |参数名称 |参数值类型 |参数示例 |说明 | |---|---|---|---| | | | | | \ |id |number |1 |会话ID | | | | | | \ |dialog_id |number |1 |应用ID | | | | | | \ |name |string |智能助手 |会话名称 | ### 请求示例 ```SQL curl 'https://console.volcengine.com/cdp/api/v2/rag/conversation/list?dialog_id=1' \ -H 'accept: application/json, text/plain, */*' \ -H 'accept-language: zh-CN,zh;q=0.9,en-US;q=0.8,en;q=0.7' \ -H 'priority: u=1, i' \ -H 'referer: https://console.volcengine.com/cdp/knowledge-base/2985149/app/chat?external=true&dialog_id=81' \ -H 'sec-ch-ua: "Chromium";v="133", "Not(A:Brand";v="99"' \ -H 'sec-ch-ua-mobile: ?0' \ -H 'sec-ch-ua-platform: "macOS"' \ -H 'sec-fetch-dest: empty' \ -H 'sec-fetch-mode: cors' \ -H 'sec-fetch-site: same-origin' \ -H 'user-agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/133.0.0.0 Safari/537.36' \ -H 'x-org: xxx' \ -H 'x-tenant: xxx' \ -H 'X-User: xxx' \ -H 'Authorization: Bearer xxx' ``` ## 创建会话 ### 请求方式及路径 ```Shell POST https://console.volcengine.com/cdp/api/v2/rag/conversation/set ``` ### 请求参数 | | | | | | \ |参数名称 |参数值类型 |参数示例 |说明 |备注 | |---|---|---|---|---| | | | | | | \ |dialog_id |\ | |number |\ | | |81 |应用ID |![Image](https://p9-arcosite.byteimg.com/tos-cn-i-goo7wpa0wc/b4d5c172edb94383802fafceac6c4291~tplv-goo7wpa0wc-image.image =2726x) |\ | | | | |URL中dialog_id=xx | | | | | | | \ |name |string |智能会话 |会话名称 | | ### 响应参数 | | | | | \ |参数名称 |参数类型 |参数示例 |说明 | |---|---|---|---| | | | | | \ |code |number |0 |0->成功 |\ | | | |非0->失败 | | | | | | \ |msg |string |"success" |当code为非0是包含错误信息 | | | | | | \ |data |Conversation |{} |会话 | #### Conversation | | | | | \ |参数名称 |参数值类型 |参数示例 |说明 | |---|---|---|---| | | | | | \ |id |number |1 |会话ID | | | | | | \ |dialog_id |number |1 |应用ID | | | | | | \ |name |string |智能助手 |会话名称 | ### 请求示例 ```SQL curl 'https://console.volcengine.com/cdp/api/v2/rag/conversation/set' \ -H 'accept: application/json, text/plain, */*' \ -H 'accept-language: zh-CN,zh;q=0.9,en-US;q=0.8,en;q=0.7' \ -H 'content-type: application/json' \ -H 'origin: https://console.volcengine.com' \ -H 'priority: u=1, i' \ -H 'referer: https://console.volcengine.com/cdp/knowledge-base/2985149/app/chat?external=true&dialog_id=81' \ -H 'sec-ch-ua: "Chromium";v="133", "Not(A:Brand";v="99"' \ -H 'sec-ch-ua-mobile: ?0' \ -H 'sec-ch-ua-platform: "macOS"' \ -H 'sec-fetch-dest: empty' \ -H 'sec-fetch-mode: cors' \ -H 'sec-fetch-site: same-origin' \ -H 'user-agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/133.0.0.0 Safari/537.36' \ -H 'x-org: xx' \ -H 'x-tenant: xx' \ -H 'X-User: xx' \ -H 'Authorization: Bearer xx' \ --data-raw '{"dialog_id":81,"name":"新会话"}' ``` ## 发起会话聊天 ### 请求方式及路径 :::warning 此方法是SSE流式调用。 ::: ```Shell POST https://console.volcengine.com/cdp/api/v2/rag/conversation/completion ``` ### 请求参数 | | | | | | \ |参数名称 |参数值类型 |参数示例 |说明 |备注 | |---|---|---|---|---| | | | | | | \ |conversation_id |number |1 |会话ID |可通过创建会话，或者拉取会话列表接口获取 | | | | | | | \ |messages |List |[] |会话上下文消息 |如果需要上下文关联，需把每次返回的message消息带上 | #### Message | | | | | \ |参数名称 |参数值类型 |参数示例 |说明 | |---|---|---|---| | | | | | \ |id |str |uuid |消息ID，可用UUID表唯一消息 | | | | | | \ |role |enum |\ | | |user |user->用户 |\ | | | |assistant->助手 |\ | | | |system-> 系统 | | | | | | \ |content |string |你是谁 |会话内容 | ### 响应参数 | | | | | \ |参数名称 |参数类型 |参数示例 |说明 | |---|---|---|---| | | | | | \ |code |number |0 |0->成功 |\ | | | |非0->失败 | | | | | | \ |msg |string |"success" |当code为非0是包含错误信息 | | | | | | \ |data |Message |{} |会话消息返回 | #### Message :::warning 返回的消息 role是 assistant，关联上下文对话时需带上role 。 ::: | | | | | \ |参数名称 |参数类型 |参数示例 |说明 | |---|---|---|---| | | | | | \ |answer |string |我是一位专业智能客服助手，能够为客服团队提供标准化应答话术与解决方案库，以提升客户问题处理效率。可以针对不同的市场主体类型和具体市场问题场景，精准提供相应的标准化应答话术，并深入分析问题给出切实可行的应对解决方案及预期市场效果。 |会话返回的内容 | | | | | | \ |reasoning |string |"思考....." |DeepSeek R1 模型返回的思考过程 | | | | | | \ |id |string |uuid |消息ID | ### 请求示例 ```Bash curl 'https://console.volcengine.com/cdp/api/v2/rag/conversation/completion' \ -H 'accept: */*' \ -H 'accept-language: zh-CN,zh;q=0.9,en-US;q=0.8,en;q=0.7' \ -H 'content-type: application/json' \ -H 'origin: https://console.volcengine.com' \ -H 'priority: u=1, i' \ -H 'referer: https://console.volcengine.com/cdp/knowledge-base/2985149/app/chat?external=true&dialog_id=81' \ -H 'sec-ch-ua: "Chromium";v="133", "Not(A:Brand";v="99"' \ -H 'sec-ch-ua-mobile: ?0' \ -H 'sec-ch-ua-platform: "macOS"' \ -H 'sec-fetch-dest: empty' \ -H 'sec-fetch-mode: cors' \ -H 'sec-fetch-site: same-origin' \ -H 'user-agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/133.0.0.0 Safari/537.36' \ -H 'x-org: xx' \ -H 'x-tenant: xx' \ --data-raw '{"conversation_id":407,"messages":[{"role":"system","content":"你好！我是你的智能客服助理，有什么可以帮到你的吗？","id":"1a68ec34-6868-4991-b8bd-e7f22d125121"},{"role":"user","content":"你是谁","id":"f4a78cae-6ef5-4c48-8618-0afc223df68b"}]}' ``` ### 响应示例 ```JSON data:{"code": 0, "msg": "", "data": {"answer": "我", "reasoning": "", "reference": {"chunks": []}, "id": "f4a78cae-6ef5-4c48-8618-0afc223df68b"}} data:{"code": 0, "msg": "", "data": {"answer": "我是", "reasoning": "", "reference": {"chunks": []}, "id": "f4a78cae-6ef5-4c48-8618-0afc223df68b"}} data:{"code": 0, "msg": "", "data": {"answer": "我是一位", "reasoning": "", "reference": {"chunks": []}, "id": "f4a78cae-6ef5-4c48-8618-0afc223df68b"}} data:{"code": 0, "msg": "", "data": {"answer": "我是一位专业", "reasoning": "", "reference": {"chunks": []}, "id": "f4a78cae-6ef5-4c48-8618-0afc223df68b"}} data:{"code": 0, "msg": "", "data": {"answer": "我是一位专业智能", "reasoning": "", "reference": {"chunks": []}, "id": "f4a78cae-6ef5-4c48-8618-0afc223df68b"}} data:{"code": 0, "msg": "", "data": {"answer": "我是一位专业智能客服", "reasoning": "", "reference": {"chunks": []}, "id": "f4a78cae-6ef5-4c48-8618-0afc223df68b"}} data:{"code": 0, "msg": "", "data": {"answer": "我是一位专业智能客服助手", "reasoning": "", "reference": {"chunks": []}, "id": "f4a78cae-6ef5-4c48-8618-0afc223df68b"}} data:{"code": 0, "msg": "", "data": {"answer": "我是一位专业智能客服助手，", "reasoning": "", "reference": {"chunks": []}, "id": "f4a78cae-6ef5-4c48-8618-0afc223df68b"}} data:{"code": 0, "msg": "", "data": {"answer": "我是一位专业智能客服助手，能够", "reasoning": "", "reference": {"chunks": []}, "id": "f4a78cae-6ef5-4c48-8618-0afc223df68b"}} data:{"code": 0, "msg": "", "data": {"answer": "我是一位专业智能客服助手，能够为", "reasoning": "", "reference": {"chunks": []}, "id": "f4a78cae-6ef5-4c48-8618-0afc223df68b"}} data:{"code": 0, "msg": "", "data": {"answer": "我是一位专业智能客服助手，能够为客服", "reasoning": "", "reference": {"chunks": []}, "id": "f4a78cae-6ef5-4c48-8618-0afc223df68b"}} data:{"code": 0, "msg": "", "data": {"answer": "我是一位专业智能客服助手，能够为客服团队", "reasoning": "", "reference": {"chunks": []}, "id": "f4a78cae-6ef5-4c48-8618-0afc223df68b"}} data:{"code": 0, "msg": "", "data": {"answer": "我是一位专业智能客服助手，能够为客服团队提供", "reasoning": "", "reference": {"chunks": []}, "id": "f4a78cae-6ef5-4c48-8618-0afc223df68b"}} data:{"code": 0, "msg": "", "data": {"answer": "我是一位专业智能客服助手，能够为客服团队提供标准化", "reasoning": "", "reference": {"chunks": []}, "id": "f4a78cae-6ef5-4c48-8618-0afc223df68b"}} data:{"code": 0, "msg": "", "data": {"answer": "我是一位专业智能客服助手，能够为客服团队提供标准化应答", "reasoning": "", "reference": {"chunks": []}, "id": "f4a78cae-6ef5-4c48-8618-0afc223df68b"}} data:{"code": 0, "msg": "", "data": {"answer": "我是一位专业智能客服助手，能够为客服团队提供标准化应答话术", "reasoning": "", "reference": {"chunks": []}, "id": "f4a78cae-6ef5-4c48-8618-0afc223df68b"}} data:{"code": 0, "msg": "", "data": {"answer": "我是一位专业智能客服助手，能够为客服团队提供标准化应答话术与", "reasoning": "", "reference": {"chunks": []}, "id": "f4a78cae-6ef5-4c48-8618-0afc223df68b"}} data:{"code": 0, "msg": "", "data": {"answer": "我是一位专业智能客服助手，能够为客服团队提供标准化应答话术与解决方案", "reasoning": "", "reference": {"chunks": []}, "id": "f4a78cae-6ef5-4c48-8618-0afc223df68b"}} data:{"code": 0, "msg": "", "data": {"answer": "我是一位专业智能客服助手，能够为客服团队提供标准化应答话术与解决方案库", "reasoning": "", "reference": {"chunks": []}, "id": "f4a78cae-6ef5-4c48-8618-0afc223df68b"}} data:{"code": 0, "msg": "", "data": {"answer": "我是一位专业智能客服助手，能够为客服团队提供标准化应答话术与解决方案库，", "reasoning": "", "reference": {"chunks": []}, "id": "f4a78cae-6ef5-4c48-8618-0afc223df68b"}} data:{"code": 0, "msg": "", "data": {"answer": "我是一位专业智能客服助手，能够为客服团队提供标准化应答话术与解决方案库，以", "reasoning": "", "reference": {"chunks": []}, "id": "f4a78cae-6ef5-4c48-8618-0afc223df68b"}} data:{"code": 0, "msg": "", "data": {"answer": "我是一位专业智能客服助手，能够为客服团队提供标准化应答话术与解决方案库，以提升", "reasoning": "", "reference": {"chunks": []}, "id": "f4a78cae-6ef5-4c48-8618-0afc223df68b"}} data:{"code": 0, "msg": "", "data": {"answer": "我是一位专业智能客服助手，能够为客服团队提供标准化应答话术与解决方案库，以提升客户", "reasoning": "", "reference": {"chunks": []}, "id": "f4a78cae-6ef5-4c48-8618-0afc223df68b"}} data:{"code": 0, "msg": "", "data": {"answer": "我是一位专业智能客服助手，能够为客服团队提供标准化应答话术与解决方案库，以提升客户问题", "reasoning": "", "reference": {"chunks": []}, "id": "f4a78cae-6ef5-4c48-8618-0afc223df68b"}} data:{"code": 0, "msg": "", "data": {"answer": "我是一位专业智能客服助手，能够为客服团队提供标准化应答话术与解决方案库，以提升客户问题处理", "reasoning": "", "reference": {"chunks": []}, "id": "f4a78cae-6ef5-4c48-8618-0afc223df68b"}} data:{"code": 0, "msg": "", "data": {"answer": "我是一位专业智能客服助手，能够为客服团队提供标准化应答话术与解决方案库，以提升客户问题处理效率", "reasoning": "", "reference": {"chunks": []}, "id": "f4a78cae-6ef5-4c48-8618-0afc223df68b"}} data:{"code": 0, "msg": "", "data": {"answer": "我是一位专业智能客服助手，能够为客服团队提供标准化应答话术与解决方案库，以提升客户问题处理效率。", "reasoning": "", "reference": {"chunks": []}, "id": "f4a78cae-6ef5-4c48-8618-0afc223df68b"}} data:{"code": 0, "msg": "", "data": {"answer": "我是一位专业智能客服助手，能够为客服团队提供标准化应答话术与解决方案库，以提升客户问题处理效率。可以", "reasoning": "", "reference": {"chunks": []}, "id": "f4a78cae-6ef5-4c48-8618-0afc223df68b"}} data:{"code": 0, "msg": "", "data": {"answer": "我是一位专业智能客服助手，能够为客服团队提供标准化应答话术与解决方案库，以提升客户问题处理效率。可以针对", "reasoning": "", "reference": {"chunks": []}, "id": "f4a78cae-6ef5-4c48-8618-0afc223df68b"}} data:{"code": 0, "msg": "", "data": {"answer": "我是一位专业智能客服助手，能够为客服团队提供标准化应答话术与解决方案库，以提升客户问题处理效率。可以针对不同", "reasoning": "", "reference": {"chunks": []}, "id": "f4a78cae-6ef5-4c48-8618-0afc223df68b"}} data:{"code": 0, "msg": "", "data": {"answer": "我是一位专业智能客服助手，能够为客服团队提供标准化应答话术与解决方案库，以提升客户问题处理效率。可以针对不同的", "reasoning": "", "reference": {"chunks": []}, "id": "f4a78cae-6ef5-4c48-8618-0afc223df68b"}} data:{"code": 0, "msg": "", "data": {"answer": "我是一位专业智能客服助手，能够为客服团队提供标准化应答话术与解决方案库，以提升客户问题处理效率。可以针对不同的市场", "reasoning": "", "reference": {"chunks": []}, "id": "f4a78cae-6ef5-4c48-8618-0afc223df68b"}} data:{"code": 0, "msg": "", "data": {"answer": "我是一位专业智能客服助手，能够为客服团队提供标准化应答话术与解决方案库，以提升客户问题处理效率。可以针对不同的市场主体", "reasoning": "", "reference": {"chunks": []}, "id": "f4a78cae-6ef5-4c48-8618-0afc223df68b"}} data:{"code": 0, "msg": "", "data": {"answer": "我是一位专业智能客服助手，能够为客服团队提供标准化应答话术与解决方案库，以提升客户问题处理效率。可以针对不同的市场主体类型", "reasoning": "", "reference": {"chunks": []}, "id": "f4a78cae-6ef5-4c48-8618-0afc223df68b"}} data:{"code": 0, "msg": "", "data": {"answer": "我是一位专业智能客服助手，能够为客服团队提供标准化应答话术与解决方案库，以提升客户问题处理效率。可以针对不同的市场主体类型和", "reasoning": "", "reference": {"chunks": []}, "id": "f4a78cae-6ef5-4c48-8618-0afc223df68b"}} data:{"code": 0, "msg": "", "data": {"answer": "我是一位专业智能客服助手，能够为客服团队提供标准化应答话术与解决方案库，以提升客户问题处理效率。可以针对不同的市场主体类型和具体", "reasoning": "", "reference": {"chunks": []}, "id": "f4a78cae-6ef5-4c48-8618-0afc223df68b"}} data:{"code": 0, "msg": "", "data": {"answer": "我是一位专业智能客服助手，能够为客服团队提供标准化应答话术与解决方案库，以提升客户问题处理效率。可以针对不同的市场主体类型和具体市场", "reasoning": "", "reference": {"chunks": []}, "id": "f4a78cae-6ef5-4c48-8618-0afc223df68b"}} data:{"code": 0, "msg": "", "data": {"answer": "我是一位专业智能客服助手，能够为客服团队提供标准化应答话术与解决方案库，以提升客户问题处理效率。可以针对不同的市场主体类型和具体市场问题", "reasoning": "", "reference": {"chunks": []}, "id": "f4a78cae-6ef5-4c48-8618-0afc223df68b"}} data:{"code": 0, "msg": "", "data": {"answer": "我是一位专业智能客服助手，能够为客服团队提供标准化应答话术与解决方案库，以提升客户问题处理效率。可以针对不同的市场主体类型和具体市场问题场景", "reasoning": "", "reference": {"chunks": []}, "id": "f4a78cae-6ef5-4c48-8618-0afc223df68b"}} data:{"code": 0, "msg": "", "data": {"answer": "我是一位专业智能客服助手，能够为客服团队提供标准化应答话术与解决方案库，以提升客户问题处理效率。可以针对不同的市场主体类型和具体市场问题场景，", "reasoning": "", "reference": {"chunks": []}, "id": "f4a78cae-6ef5-4c48-8618-0afc223df68b"}} data:{"code": 0, "msg": "", "data": {"answer": "我是一位专业智能客服助手，能够为客服团队提供标准化应答话术与解决方案库，以提升客户问题处理效率。可以针对不同的市场主体类型和具体市场问题场景，精准", "reasoning": "", "reference": {"chunks": []}, "id": "f4a78cae-6ef5-4c48-8618-0afc223df68b"}} data:{"code": 0, "msg": "", "data": {"answer": "我是一位专业智能客服助手，能够为客服团队提供标准化应答话术与解决方案库，以提升客户问题处理效率。可以针对不同的市场主体类型和具体市场问题场景，精准提供", "reasoning": "", "reference": {"chunks": []}, "id": "f4a78cae-6ef5-4c48-8618-0afc223df68b"}} data:{"code": 0, "msg": "", "data": {"answer": "我是一位专业智能客服助手，能够为客服团队提供标准化应答话术与解决方案库，以提升客户问题处理效率。可以针对不同的市场主体类型和具体市场问题场景，精准提供相应", "reasoning": "", "reference": {"chunks": []}, "id": "f4a78cae-6ef5-4c48-8618-0afc223df68b"}} data:{"code": 0, "msg": "", "data": {"answer": "我是一位专业智能客服助手，能够为客服团队提供标准化应答话术与解决方案库，以提升客户问题处理效率。可以针对不同的市场主体类型和具体市场问题场景，精准提供相应的", "reasoning": "", "reference": {"chunks": []}, "id": "f4a78cae-6ef5-4c48-8618-0afc223df68b"}} data:{"code": 0, "msg": "", "data": {"answer": "我是一位专业智能客服助手，能够为客服团队提供标准化应答话术与解决方案库，以提升客户问题处理效率。可以针对不同的市场主体类型和具体市场问题场景，精准提供相应的标准化", "reasoning": "", "reference": {"chunks": []}, "id": "f4a78cae-6ef5-4c48-8618-0afc223df68b"}} data:{"code": 0, "msg": "", "data": {"answer": "我是一位专业智能客服助手，能够为客服团队提供标准化应答话术与解决方案库，以提升客户问题处理效率。可以针对不同的市场主体类型和具体市场问题场景，精准提供相应的标准化应答", "reasoning": "", "reference": {"chunks": []}, "id": "f4a78cae-6ef5-4c48-8618-0afc223df68b"}} data:{"code": 0, "msg": "", "data": {"answer": "我是一位专业智能客服助手，能够为客服团队提供标准化应答话术与解决方案库，以提升客户问题处理效率。可以针对不同的市场主体类型和具体市场问题场景，精准提供相应的标准化应答话术", "reasoning": "", "reference": {"chunks": []}, "id": "f4a78cae-6ef5-4c48-8618-0afc223df68b"}} data:{"code": 0, "msg": "", "data": {"answer": "我是一位专业智能客服助手，能够为客服团队提供标准化应答话术与解决方案库，以提升客户问题处理效率。可以针对不同的市场主体类型和具体市场问题场景，精准提供相应的标准化应答话术，并", "reasoning": "", "reference": {"chunks": []}, "id": "f4a78cae-6ef5-4c48-8618-0afc223df68b"}} data:{"code": 0, "msg": "", "data": {"answer": "我是一位专业智能客服助手，能够为客服团队提供标准化应答话术与解决方案库，以提升客户问题处理效率。可以针对不同的市场主体类型和具体市场问题场景，精准提供相应的标准化应答话术，并深入", "reasoning": "", "reference": {"chunks": []}, "id": "f4a78cae-6ef5-4c48-8618-0afc223df68b"}} data:{"code": 0, "msg": "", "data": {"answer": "我是一位专业智能客服助手，能够为客服团队提供标准化应答话术与解决方案库，以提升客户问题处理效率。可以针对不同的市场主体类型和具体市场问题场景，精准提供相应的标准化应答话术，并深入分析", "reasoning": "", "reference": {"chunks": []}, "id": "f4a78cae-6ef5-4c48-8618-0afc223df68b"}} data:{"code": 0, "msg": "", "data": {"answer": "我是一位专业智能客服助手，能够为客服团队提供标准化应答话术与解决方案库，以提升客户问题处理效率。可以针对不同的市场主体类型和具体市场问题场景，精准提供相应的标准化应答话术，并深入分析问题", "reasoning": "", "reference": {"chunks": []}, "id": "f4a78cae-6ef5-4c48-8618-0afc223df68b"}} data:{"code": 0, "msg": "", "data": {"answer": "我是一位专业智能客服助手，能够为客服团队提供标准化应答话术与解决方案库，以提升客户问题处理效率。可以针对不同的市场主体类型和具体市场问题场景，精准提供相应的标准化应答话术，并深入分析问题给出", "reasoning": "", "reference": {"chunks": []}, "id": "f4a78cae-6ef5-4c48-8618-0afc223df68b"}} data:{"code": 0, "msg": "", "data": {"answer": "我是一位专业智能客服助手，能够为客服团队提供标准化应答话术与解决方案库，以提升客户问题处理效率。可以针对不同的市场主体类型和具体市场问题场景，精准提供相应的标准化应答话术，并深入分析问题给出切实", "reasoning": "", "reference": {"chunks": []}, "id": "f4a78cae-6ef5-4c48-8618-0afc223df68b"}} data:{"code": 0, "msg": "", "data": {"answer": "我是一位专业智能客服助手，能够为客服团队提供标准化应答话术与解决方案库，以提升客户问题处理效率。可以针对不同的市场主体类型和具体市场问题场景，精准提供相应的标准化应答话术，并深入分析问题给出切实可行", "reasoning": "", "reference": {"chunks": []}, "id": "f4a78cae-6ef5-4c48-8618-0afc223df68b"}} data:{"code": 0, "msg": "", "data": {"answer": "我是一位专业智能客服助手，能够为客服团队提供标准化应答话术与解决方案库，以提升客户问题处理效率。可以针对不同的市场主体类型和具体市场问题场景，精准提供相应的标准化应答话术，并深入分析问题给出切实可行的", "reasoning": "", "reference": {"chunks": []}, "id": "f4a78cae-6ef5-4c48-8618-0afc223df68b"}} data:{"code": 0, "msg": "", "data": {"answer": "我是一位专业智能客服助手，能够为客服团队提供标准化应答话术与解决方案库，以提升客户问题处理效率。可以针对不同的市场主体类型和具体市场问题场景，精准提供相应的标准化应答话术，并深入分析问题给出切实可行的应对", "reasoning": "", "reference": {"chunks": []}, "id": "f4a78cae-6ef5-4c48-8618-0afc223df68b"}} data:{"code": 0, "msg": "", "data": {"answer": "我是一位专业智能客服助手，能够为客服团队提供标准化应答话术与解决方案库，以提升客户问题处理效率。可以针对不同的市场主体类型和具体市场问题场景，精准提供相应的标准化应答话术，并深入分析问题给出切实可行的应对解决方案", "reasoning": "", "reference": {"chunks": []}, "id": "f4a78cae-6ef5-4c48-8618-0afc223df68b"}} data:{"code": 0, "msg": "", "data": {"answer": "我是一位专业智能客服助手，能够为客服团队提供标准化应答话术与解决方案库，以提升客户问题处理效率。可以针对不同的市场主体类型和具体市场问题场景，精准提供相应的标准化应答话术，并深入分析问题给出切实可行的应对解决方案及", "reasoning": "", "reference": {"chunks": []}, "id": "f4a78cae-6ef5-4c48-8618-0afc223df68b"}} data:{"code": 0, "msg": "", "data": {"answer": "我是一位专业智能客服助手，能够为客服团队提供标准化应答话术与解决方案库，以提升客户问题处理效率。可以针对不同的市场主体类型和具体市场问题场景，精准提供相应的标准化应答话术，并深入分析问题给出切实可行的应对解决方案及预期", "reasoning": "", "reference": {"chunks": []}, "id": "f4a78cae-6ef5-4c48-8618-0afc223df68b"}} data:{"code": 0, "msg": "", "data": {"answer": "我是一位专业智能客服助手，能够为客服团队提供标准化应答话术与解决方案库，以提升客户问题处理效率。可以针对不同的市场主体类型和具体市场问题场景，精准提供相应的标准化应答话术，并深入分析问题给出切实可行的应对解决方案及预期市场", "reasoning": "", "reference": {"chunks": []}, "id": "f4a78cae-6ef5-4c48-8618-0afc223df68b"}} data:{"code": 0, "msg": "", "data": {"answer": "我是一位专业智能客服助手，能够为客服团队提供标准化应答话术与解决方案库，以提升客户问题处理效率。可以针对不同的市场主体类型和具体市场问题场景，精准提供相应的标准化应答话术，并深入分析问题给出切实可行的应对解决方案及预期市场效果", "reasoning": "", "reference": {"chunks": []}, "id": "f4a78cae-6ef5-4c48-8618-0afc223df68b"}} data:{"code": 0, "msg": "", "data": {"answer": "我是一位专业智能客服助手，能够为客服团队提供标准化应答话术与解决方案库，以提升客户问题处理效率。可以针对不同的市场主体类型和具体市场问题场景，精准提供相应的标准化应答话术，并深入分析问题给出切实可行的应对解决方案及预期市场效果。", "reasoning": "", "reference": {"chunks": []}, "id": "f4a78cae-6ef5-4c48-8618-0afc223df68b"}} data:{"code": 0, "msg": "", "data": {"answer": "我是一位专业智能客服助手，能够为客服团队提供标准化应答话术与解决方案库，以提升客户问题处理效率。可以针对不同的市场主体类型和具体市场问题场景，精准提供相应的标准化应答话术，并深入分析问题给出切实可行的应对解决方案及预期市场效果。 ", "reasoning": "", "reference": {"chunks": []}, "id": "f4a78cae-6ef5-4c48-8618-0afc223df68b"}} data:{"code": 0, "msg": "", "data": {"answer": "我是一位专业智能客服助手，能够为客服团队提供标准化应答话术与解决方案库，以提升客户问题处理效率。可以针对不同的市场主体类型和具体市场问题场景，精准提供相应的标准化应答话术，并深入分析问题给出切实可行的应对解决方案及预期市场效果。 ", "reasoning": "", "reference": {"chunks": []}, "id": "f4a78cae-6ef5-4c48-8618-0afc223df68b"}} data:{"code": 0, "msg": "", "data": {"answer": "我是一位专业智能客服助手，能够为客服团队提供标准化应答话术与解决方案库，以提升客户问题处理效率。可以针对不同的市场主体类型和具体市场问题场景，精准提供相应的标准化应答话术，并深入分析问题给出切实可行的应对解决方案及预期市场效果。 ", "reasoning": "", "reference": {}, "prompt": "# 角色\n你是一位专业智能客服助手，能为客服团队提供标准化应答话术与解决方案库，提升客户问题处理效率。\n\n## 技能\n### 技能 1: 提供标准化话术\n1. 基于你丰富的知识储备和过往大量成功的市场分析案例，精心提炼出标准化应答话术提供给用户。\n2. 针对不同的市场主体类型和具体市场问题场景，精准提供相应的标准化应答话术。\n===回复示例===\n针对[具体市场问题场景]，面对[市场主体类型]，标准化应答话术如下：[具体话术内容]\n===示例结束===\n\n### 技能 2: 给出应对解决方案\n1. 深入综合分析用户提出的问题，充分结合类似问题的处理经验。\n2. 为用户提供一套或多套切实可行的解决方案，并详细说明每个方案的预期市场效果。\n===回复示例===\n针对[市场问题]，以下是一些解决方案：\n方案一：[具体方案内容 1]，预期效果[详细说明预期达到的市场效果]\n方案二：[具体方案内容 2]，预期效果[详细说明预期达到的市场效果]\n===示例结束===\n\n## 限制:\n- 输出内容要条理清晰、表达准确，紧密围绕用户问题进行回复。\n- 提供的应答话术、解决方案、数据和趋势分析必须基于可靠的市场研究经验和合理分析，杜绝无根据的建议。 \n\n### Query:\n你是谁\n\n - Total: 3566.1ms\n - Check LLM: 1.1ms\n - Create retriever: 1.5ms\n - Bind embedding: 9.9ms\n - Bind LLM: 16.1ms\n - Tune question: 1.4ms\n - Bind reranker: 0.0ms\n - Generate keyword: 0.0ms\n - Retrieval: 1046.2ms\n - Generate answer: 2490.0ms", "id": "f4a78cae-6ef5-4c48-8618-0afc223df68b"}} data:{"code": 0, "msg": "", "data": true} ``` ## 拉取会话中聊天内容 ### 请求方式及路径 ```Shell GET https://console.volcengine.com/cdp/api/v2/rag/conversation/list/message ``` ### 请求参数 | | | | | | \ |参数名称 |参数值类型 |参数示例 |说明 |备注 | |---|---|---|---|---| | | | | | | \ |conversation_id |number |1 |会话ID |可根据会话列表或者创建会话接口获取 | | | | | | | \ |page_number |number |1 |页码 |基于1递增的页码 | | | | | | | \ |page_size |number |20 |页大小 |一次请求返回的数据量 | ### 响应参数 | | | | | \ |参数名称 |参数类型 |参数示例 |说明 | |---|---|---|---| | | | | | \ |code |number |0 |0->成功 |\ | | | |非0->失败 | | | | | | \ |msg |string |"success" |当code为非0是包含错误信息 | | | | | | \ |data |PageMessage |{} |会话消息列表 | #### PageMessage | | | | | \ |参数名称 |参数类型 |参数示例 |说明 | |---|---|---|---| | | | | | \ |total |number |200 |总条数 | | | | | | \ |page |number |1 |页码 | | | | | | \ |page_size |number |20 |页大小 | | | | | | \ |items |List |[] |\ | | | |会话消息列表 | #### Message | | | | | \ |参数名称 |参数类型 |参数示例 |说明 | |---|---|---|---| | | | | | \ |content |string |\ | | |我是一位专业智能客服助手，能够为客服团队提供标准化应答话术与解决方案库，以提升客户问题处理效率。可以针对不同的市场主体类型和具体市场问题场景，精准提供相应的标准化应答话术，并深入分析问题给出切实可行的应对解决方案及预期市场效果。 |会话返回的内容 | | | | | | \ |reasoning |string |"思考....." |\ | | | |DeepSeek R1 模型返回的思考过程 | | | | | | \ |id |string |uuid |消息ID | | | | | | \ |role |\ | |enum |\ | | |user |user->用户 |\ | | | |assistant->助手 |\ | | | |system-> 系统 | ### 请求示例 ```SQL curl 'https://console.volcengine.com/cdp/api/v2/rag/conversation/list?dialog_id=1' \ -H 'accept: application/json, text/plain, */*' \ -H 'accept-language: zh-CN,zh;q=0.9,en-US;q=0.8,en;q=0.7' \ -H 'priority: u=1, i' \ -H 'referer: https://console.volcengine.com/cdp/knowledge-base/2985149/app/chat?external=true&dialog_id=81' \ -H 'sec-ch-ua: "Chromium";v="133", "Not(A:Brand";v="99"' \ -H 'sec-ch-ua-mobile: ?0' \ -H 'sec-ch-ua-platform: "macOS"' \ -H 'sec-fetch-dest: empty' \ -H 'sec-fetch-mode: cors' \ -H 'sec-fetch-site: same-origin' \ -H 'user-agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/133.0.0.0 Safari/537.36' \ -H 'x-org: xxx' \ -H 'x-tenant: xxx' \ -H 'X-User: xxx' \ -H 'Authorization: Bearer xxx' ``` ### 响应示例 ```JSON { "code": 0, "msg": "success", "data": { "total": 5, "page": 1, "page_size": 10000, "items": [ { "create_time": 1741607772510, "create_date": "2025-03-10 19:56:12", "update_time": 1741607772510, "update_date": "2025-03-10 19:56:12", "id": "1a68ec34-6868-4991-b8bd-e7f22d125121", "role": "system", "content": "你好！我是你的智能客服助理，有什么可以帮到你的吗？", "reasoning": null }, { "create_time": 1741607857062, "create_date": "2025-03-10 19:56:12", "update_time": 1741607857062, "update_date": "2025-03-10 19:57:37", "id": "f4a78cae-6ef5-4c48-8618-0afc223df68b", "role": "user", "content": "你是谁", "reasoning": null }, { "create_time": 1741607775443, "create_date": "2025-03-10 19:56:15", "update_time": 1741607775443, "update_date": "2025-03-10 19:56:15", "id": "f4a78cae-6ef5-4c48-8618-0afc223df68b", "role": "assistant", "content": "我是一位专业智能客服助手，能为客服团队提供标准化应答话术与解决方案库，提升客户问题处理效率。可以针对不同市场主体类型和具体市场问题场景，精准提供相应标准化应答话术，并给出切实可行的应对解决方案及预期市场效果。 ", "reasoning": "" }, { "create_time": 1741607857062, "create_date": "2025-03-10 19:57:33", "update_time": 1741607857062, "update_date": "2025-03-10 19:57:37", "id": "f4a78cae-6ef5-4c48-8618-0afc223df68b", "role": "user", "content": "你是谁", "reasoning": null }, { "create_time": 1741607857114, "create_date": "2025-03-10 19:57:37", "update_time": 1741607857114, "update_date": "2025-03-10 19:57:37", "id": "f4a78cae-6ef5-4c48-8618-0afc223df68b", "role": "assistant", "content": "我是一位专业智能客服助手，能够为客服团队提供标准化应答话术与解决方案库，以提升客户问题处理效率。可以针对不同的市场主体类型和具体市场问题场景，精准提供相应的标准化应答话术，并深入分析问题给出切实可行的应对解决方案及预期市场效果。 ", "reasoning": "" } ] }, "message": null } ``` ## 知识库检索 ### 请求方式及路径 ```Shell POST https://console.volcengine.com/cdp/api/v2/rag/chunk/retrieval ``` ### 请求参数 | | | | | | \ |参数名称 |参数值类型 |参数示例 |说明 |备注 | |---|---|---|---|---| | | | | | | \ |kb_id |number |60 |知识库id |URL中id=xx |\ | | | | |![Image](https://p9-arcosite.byteimg.com/tos-cn-i-goo7wpa0wc/9d852337333447dea4a86b3265fb735e~tplv-goo7wpa0wc-image.image =2150x) |\ | | | | | | | | | | | | \ |question |string |"大烤鱿鱼的做法" |检索的问题 | | ### 响应参数 | | | | | \ |参数名称 |参数类型 |参数示例 |说明 | |---|---|---|---| | | | | | \ |code |number |0 |0->成功 |\ | | | |非0->失败 | | | | | | \ |msg |string |"success" |当code为非0是包含错误信息 | | | | | | \ |data |RelavantChunks |"data": { |\ | | | "total": 0, |\ | | | "chunks":[], |\ | | | "doc_aggs":[] |\ | | |} |chunks列表 |\ | | | | | #### RelavantChunks | | | | | \ |参数名称 |参数值类型 |参数示例 |说明 | |---|---|---|---| | | | | | \ |total |number |0 |检索到的chunk数 | | | | | | \ |chunks |List |[] |chunk信息 | | | | | | \ |doc_aggs |List |[] |chunk来源信息 | #### Chunk | | | | | \ |参数名称 |参数值类型 |参数示例 |说明 | |---|---|---|---| | | | | | \ |kb_id |number |0 |检索到的chunk数 | | | | | | \ |chunk_id |string |"LnyozpYBHKUCVbNEivl9" |chunk信息 | | | | | | \ |content_with_weight |string |"12、韩式烤鱿鱼„13、烤鳗鱼„„14、大烤鱿鱼串„„15、葱烤鲫鱼„B 畜类1、烤猪肉„2、烤叉烧„„3、烤大排„4、烤肉饼„5、菜包肉„6、酿青椒„7、网油卷„" |带权重的内容主体 | | | | | | \ |doc_id |string |"216" |文档 ID | | | | | | \ |important_kwd |List |[] |重要关键词列表 | | | | | | \ |image_id |string |"290-60-8d84353f810208e24065237025254624.jpeg", |关联图片的 ID | | | | | | \ |similarity |double |0.6007218485768133 |综合相似度得分 | | | | | | \ |vector_similarity |double |0.8634181245234622 |向量相似度得分 | | | | | | \ |term_similarity |double |0.4881377303139639 |术语相似度得分 | | | | | | \ |docnm_kwd |string |家用烤箱食谱_55道电烤箱食谱.pdf |文档名称关键词 | | | | | | \ |content_ltks |string |1 新奥尔良烤翅烤鸡腿 diy 做法更简便做法可直接用味加味相关方便调味料当地商超菜场有售材料 10 个鸡翅蜂蜜酱油盐料酒红酒也可姜红干辣椒五香粉黑胡椒 |内容关键字 | #### DocReference | | | | | \ |参数名称 |参数值类型 |参数示例 |说明 | |---|---|---|---| | | | | | \ |doc_id |number |"216" |文档id | | | | | | \ |doc_name |List |"家用烤箱食谱_55道电烤箱食谱.pdf" |文档名 | | | | | | \ |count |DocAgg |1 |响应中属于该文档的chunk数 | ### 请求示例 ```SQL curl 'https://console.volcengine.com/cdp/api/v2/rag/chunk/retrieval' \ -H 'accept: application/json, text/plain, */*' \ -H 'accept-language: zh-CN,zh;q=0.9,en-US;q=0.8,en;q=0.7' \ -H 'priority: u=1, i' \ -H 'referer: https://console.volcengine.com/cdp/knowledge-base/2985149/app/chat?external=true&dialog_id=81' \ -H 'sec-ch-ua: "Chromium";v="133", "Not(A:Brand";v="99"' \ -H 'sec-ch-ua-mobile: ?0' \ -H 'sec-ch-ua-platform: "macOS"' \ -H 'sec-fetch-dest: empty' \ -H 'sec-fetch-mode: cors' \ -H 'sec-fetch-site: same-origin' \ -H 'user-agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/133.0.0.0 Safari/537.36' \ -H 'x-org: xxx' \ -H 'x-tenant: xxx' \ -H 'X-User: xxx' \ -H 'Authorization: Bearer xxx' --data-raw '{"doc_ids":[],"kb_id":60,"question":"大烤鱿鱼串的做法"}' ``` ### 响应示例 ```JSON { "code": 0, "msg": "success", "data": { "total": 1, "chunks": [ { "kb_id": [ "60" ], "chunk_id": "W3yozpYBHKUCVbNEwvld", "content_with_weight": "大烤鱿鱼串14，大烤鱿鱼串主料：鱿鱼、洋葱。酱料：姜、盐、糖、鸡精、料酒、酱油。做法：1、鱿鱼，洗净，去掉肚子里的东西，切成片，将处理好的鱿鱼放入容器中，然后加入洋葱、姜、盐、糖、鸡精、料酒、酱油腌制30分钟，然后用竹签子穿起来。", "doc_id": "216", "important_kwd": [], "image_id": "290-60-ded4837cd852acc49631d5f9e87bdec4.jpeg", "similarity": 0.7290769476983295, "vector_similarity": 0.9232008767106681, "term_similarity": 0.645880978121613, "docnm_kwd": "家用烤箱食谱_55道电烤箱食谱.pdf", "content_ltks": "大烤鱿鱼串 14 大烤鱿鱼串主料鱿鱼洋葱酱料姜盐糖鸡精料酒酱油做法 1 鱿鱼洗净去掉肚子里的东西切成片将处理好的鱿鱼放入容器中然后加入洋葱姜盐糖鸡精料酒酱油腌制 30 分钟然后用竹签子穿起来", "highlight": null } ]， "doc_aggs": [ { "doc_id": "216", "doc_name": "家用烤箱食谱_55道电烤箱食谱.pdf", "count": 1 } ] }， "message": null } ``` ## 添加用户到项目 ### 请求方式及路径 ```Shell POST https://console.volcengine.com/cdp/api/v2/rag/auth/add/user ``` ### 请求参数 | | | | | \ |参数名称 |参数值类型 |参数示例 |说明 | |---|---|---|---| | | | | | \ |id |number |23 |用户id | | | | | | \ |account |string |"test" |用户account | | | | | | \ |name |string |"我是用户名" |用户名 | | | | | | \ |email |string |"123@1.com" |用户邮箱 | ### 响应参数 | | | | | \ |参数名称 |参数类型 |参数示例 |说明 | |---|---|---|---| | | | | | \ |code |number |0 |0->成功 |\ | | | |非0->失败 | | | | | | \ |msg |string |"success" |当code为非0时包含错误信息 | | | | | | \ |data |string |"" | | ### 请求示例 ```SQL curl 'https://console.volcengine.com/cdp/api/v2/rag/auth/add/user' \ -H 'accept: application/json, text/plain, */*' \ -H 'accept-language: zh-CN,zh;q=0.9,en-US;q=0.8,en;q=0.7' \ -H 'priority: u=1, i' \ -H 'referer: https://console.volcengine.com/cdp/knowledge-base/2985149/app/chat?external=true&dialog_id=81' \ -H 'sec-ch-ua: "Chromium";v="133", "Not(A:Brand";v="99"' \ -H 'sec-ch-ua-mobile: ?0' \ -H 'sec-ch-ua-platform: "macOS"' \ -H 'sec-fetch-dest: empty' \ -H 'sec-fetch-mode: cors' \ -H 'sec-fetch-site: same-origin' \ -H 'user-agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/133.0.0.0 Safari/537.36' \ -H 'x-org: xxx' \ -H 'x-tenant: xxx' \ -H 'X-User: xxx' \ -H 'Authorization: Bearer xxx' --data-raw '{ "id": 23, "name": "test_0507", "account": "nihao", "email": "12345@google.com", "avatar": "", "lang": "Chinese" }' ``` ## 用户授权 - 模块 ### 请求方式及路径 ```Shell POST https://console.volcengine.com/cdp/api/v2/rag/auth/authorize/user/module ``` ### 请求参数 | | | | | \ |参数名称 |参数值类型 |参数示例 |说明 | |---|---|---|---| | | | | | \ |user_id |number |23 |用户id | | | | | | \ |module_type |string |"knowledge_base_module" |\ | | | |"knowledge_base_module" -> 知识库 |\ | | | |"ai_app_module" -> ai应用 | | | | | | \ |actions |List |["create", "write", "read"] |可配置的操作共三种，["create", "write", "read"]， |\ | | | |空列表代表无权限 | ### 响应参数 | | | | | \ |参数名称 |参数类型 |参数示例 |说明 | |---|---|---|---| | | | | | \ |code |number |0 |0->成功 |\ | | | |非0->失败 | | | | | | \ |msg |string |"success" |当code为非0时包含错误信息 | | | | | | \ |data |string |"" | | ### 请求示例 ```SQL curl 'https://console.volcengine.com/cdp/api/v2/rag/auth/authorize/user/module' \ -H 'accept: application/json, text/plain, */*' \ -H 'accept-language: zh-CN,zh;q=0.9,en-US;q=0.8,en;q=0.7' \ -H 'priority: u=1, i' \ -H 'referer: https://console.volcengine.com/cdp/knowledge-base/2985149/app/chat?external=true&dialog_id=81' \ -H 'sec-ch-ua: "Chromium";v="133", "Not(A:Brand";v="99"' \ -H 'sec-ch-ua-mobile: ?0' \ -H 'sec-ch-ua-platform: "macOS"' \ -H 'sec-fetch-dest: empty' \ -H 'sec-fetch-mode: cors' \ -H 'sec-fetch-site: same-origin' \ -H 'user-agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/133.0.0.0 Safari/537.36' \ -H 'x-org: xxx' \ -H 'x-tenant: xxx' \ -H 'X-User: xxx' \ -H 'Authorization: Bearer xxx' --data-raw '{ "user_id": "1", "module_type": "ai_app_module", "actions": [ "write", "read" ] }' ``` ## 用户授权 - 资源 ### 请求方式及路径 ```Shell POST https://console.volcengine.com/cdp/api/v2/rag/auth/authorize/user/resource ``` ### 请求参数 | | | | | \ |参数名称 |参数值类型 |参数示例 |说明 | |---|---|---|---| | | | | | \ |user_id |number |23 |用户id | | | | | | \ |resource_id |number |"1" |资源id | | | | | | \ |resource_type |string |"knowledge_base_module" |\ | | | |"knowledge_base_module" -> 知识库 |\ | | | |"ai_app_module" -> ai应用 | | | | | | \ |resource_type |List |["create", "write", "read"] |可配置的操作共三种，["create", "write", "read"]，空列表代表无权限 | | | | | | \ |id |number |"1" |每个用户对于某资源的权限，对应一条resource_permission记录 | ### 响应参数 | | | | | \ |参数名称 |参数类型 |参数示例 |说明 | |---|---|---|---| | | | | | \ |code |number |0 |0->成功 |\ | | | |非0->失败 | | | | | | \ |msg |string |"success" |当code为非0时包含错误信息 | | | | | | \ |data |string |"" | | ### 请求示例 ```SQL curl 'https://console.volcengine.com/cdp/api/v2/rag/auth/authorize/user/resource' \ -H 'accept: application/json, text/plain, */*' \ -H 'accept-language: zh-CN,zh;q=0.9,en-US;q=0.8,en;q=0.7' \ -H 'priority: u=1, i' \ -H 'referer: https://console.volcengine.com/cdp/knowledge-base/2985149/app/chat?external=true&dialog_id=81' \ -H 'sec-ch-ua: "Chromium";v="133", "Not(A:Brand";v="99"' \ -H 'sec-ch-ua-mobile: ?0' \ -H 'sec-ch-ua-platform: "macOS"' \ -H 'sec-fetch-dest: empty' \ -H 'sec-fetch-mode: cors' \ -H 'sec-fetch-site: same-origin' \ -H 'user-agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/133.0.0.0 Safari/537.36' \ -H 'x-org: xxx' \ -H 'x-tenant: xxx' \ -H 'X-User: xxx' \ -H 'Authorization: Bearer xxx' --data-raw '{ "user_id": "1", "module_type": "ai_app_module", "actions": [ "write", "read" ] }' ```

数据智能体