检索所有搜索历史 | 大装置帮助中心
跳到主要内容

检索所有搜索历史

GET /studio/rag/data/v1/search:allSearchHistory

请求头（Request Header）​

Authorization 可以使用如下两种Header

-H "X-Date: $xdate" \
-H "Authorization: $auth"
  • 直接提供完整的 Authorization Header,可以通过浏览器的开发者工具DevTools查看并复制接口调用的完整信息
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6InB...'

请求参数（Request Parameters）​

无请求参数

请求示例（Request Example）​

curl 'https://aidmp.cn-sh-01.sensecoreapi.cn/studio/rag/data/v1/search:allSearchHistory' \
  -H "X-Date: $xdate" \
  -H "Authorization: $auth" \
  -X GET

响应（Response）​

名称类型描述
listarray[object]历史记录列表.

其中，list的参数如下

名称类型描述
idstring历史记录ID.
requestobject历史记录的请求参数.
resultsarray[object]历史记录的搜索结果.

其中，list.request的参数如下

名称类型描述
configobject搜索配置.
page_sizeint32每页大小.
page_tokenstring分页令牌；如果从头开始，不要传递.
keywordstring要检索的文本.

其中，request.config的参数如下

名称类型描述
dataset_listarray[object]要搜索的知识库列表.
top_kint32返回结果的Top K值.
confidencefloat置信度.
weightfloat权重：表示两种方法之间的比例.
open_windowbool是否在提示中包含检索段的前后片段.

其中，config.dataset_list的参数如下

名称类型描述
idstring知识库ID.
display_namestring知识库显示名称.

其中，list.results的参数如下

名称类型描述
page_contentstring页面内容.
documentobject相关知识文档.
confidencefloat结果置信度.
token_countint64内容的token数量.
segment_numberint32段落数量.
wordsint32段落的字数.
typeinteger($enum)段落类型.
display_typeinteger($enum)显示类型.
table_contentstring表格内容.
image_uristring图片URI.
image_keystring图片键.
image_keysarray[string]图片键集合.
display_contentstring显示内容.

其中，results.document的参数如下

名称类型描述
document_idstring知识文档的ID.
display_namestring知识文档的名称.
typeinteger($enum)知识文档的类型.
document_sizeint64知识文档的大小.
token_countint64知识文档的令牌计数.
segment_countint64知识文档的段落计数.
dataset_idstring知识文档所属知识库的ID.
dataset_displaystring知识文档所属知识库的显示名称.
p_idstring父知识文档的ID.
data_source_typeinteger($enum)知识文档的数据源类型.
creatorstring知识文档的创建者.
create_timestring($date-time)知识文档的创建时间.
update_timestring($date-time)知识文档的更新时间.
segmentsarray[object]知识文档的段落详细信息列表.
uristring知识文档在OSS中的预签名URI.

其中，document.type有如下情况

枚举值数值含义
DOCUMENT_TYPE_UNSPECIFIED0未指定
WEBPAGE1网页
FOLDER2文件夹
TXT3文本文件
PDF4PDF文件
HTML5HTML文件
XLSX6XLSX文件
XLS7XLS文件
DOCX8DOCX文件
CSV9CSV文件
PPTX10PPTX文件
PPT11PPT文件，暂不支持
XML12XML文件
MARKDOWN13Markdown文件
MD14MD文件
JSON15Json文件

其中，document.data_source_type有如下情况

枚举值数值含义
DATA_SOURCE_TYPE_UNSPECIFIED0开始，默认
LOCAL_FILE1本地知识
WEB2网络知识
NOTION3Notion知识

其中，document.segments的参数如下

名称类型描述
segment_idstring段ID.
dataset_idstring知识库ID
document_idstring文档ID
contentstring段落内容
token_countint32词元数量
numberint32段落编号
metadataobject元数据
wordsint32单词数量
segment_typeinteger($enum)段落类型
table_contentstring表格内容
image_keystring图片键值
image_uristring图片URI
display_typeinteger($enum)显示类型
image_keysarray[string]图片键值列表
display_contentstring展示内容

其中，segments.metadata的参数如下

名称类型描述
key_wordsarray[string]关键词
image_name_valuestring图片名称
image_sizeint32图片大小
table_name_valuestring表格名称
table_rowsint32表格行数
table_columnsarray[string]表格列
scorefloat分数

其中，results.type和segments.segment_type有如下情况

枚举值数值含义
SEGMENT_TYPE_UNSPECIFIED0未指定状态
SEGMENT_TYPE_TEXT1文字
SEGMENT_TYPE_IMAGE2图片
SEGMENT_TYPE_TABLE3表格
SEGMENT_TYPE_WEB_IMAGE4网页图片

其中，results.display_type和segments.display_type有如下情况

枚举值数值含义
DISPLAY_TYPE_UNSPECIFIED0未指定状态
DISPLAY_TYPE_TEXT1文字
DISPLAY_TYPE_MARKDOWN2Markdown

响应示例（Response Example）​

{
    "list": [
        {
            "id": "10c67a2f-3e8e-49b7-8ec7-88edd5174892",
            "request": {
                "config": {
                    "dataset_list": [
                        {
                            "id": "rag_709be04165094a78b12d60df29817b54",
                            "display_name": "uploadurl"
                        },
                        {
                            "id": "d3e045538a124300a050864a95c7bd30",
                            "display_name": "r14t4641"
                        },
                        {
                            "id": "rag_feca3cbcc636484ca14195716d8aa588",
                            "display_name": "test01"
                        }
                    ],
                    "top_k": 3,
                    "confidence": 0
                },
                "page_size": 0,
                "page_token": "",
                "keyword": "银行"
            },
            "results": [
                {
                    "page_content": "*****",
                    "document": {
                        "name": "",
                        "document_id": "1b41913407d64de895b481efa61dddda",
                        "display_name": "newke.com/pract",
                        "type": 0,
                        "document_size": "6477",
                        "token_count": "231",
                        "segment_count": "6",
                        "dataset_id": "rag_feca3cbcc636484ca14195716d8aa588",
                        "dataset_display": "test01",
                        "p_id": "",
                        "data_source_type": 2,
                        "creator": "7e1d3847-d467-44b6-a3f9-acf019ae9cc3",
                        "create_time": "2024-07-11T10:10:09.414562Z",
                        "update_time": "2024-07-18T09:22:30.807009Z",
                        "segments": [],
                        "uri": ""
                    },
                    "confidence": 0.008333334,
                    "token_count": "40",
                    "segment_number": 5,
                    "words": 0
                },
                {
                    "page_content": "xsad",
                    "document": {
                        "name": "",
                        "document_id": "0d65c4675f3e4b8693177f77aba7bbd1",
                        "display_name": "1.txt",
                        "type": 3,
                        "document_size": "4",
                        "token_count": "0",
                        "segment_count": "0",
                        "dataset_id": "rag_709be04165094a78b12d60df29817b54",
                        "dataset_display": "uploadurl",
                        "p_id": "",
                        "data_source_type": 1,
                        "creator": "7e1d3847-d467-44b6-a3f9-acf019ae9cc3",
                        "create_time": "2024-07-11T07:49:51.460208Z",
                        "update_time": "2024-07-11T07:49:51.460220Z",
                        "segments": [],
                        "uri": ""
                    },
                    "confidence": 0.008333334,
                    "token_count": "1",
                    "segment_number": 1,
                    "words": 0
                }
            ]
        }
    ]
}