LLM智能问答版如何查询文档列表_智能开放搜索 OpenSearch(Open Search)-阿里云帮助中心

本文介绍查询文档列表API，您可通过返回参数的status字段查看文档处理状态。

前提条件

获取身份鉴权API Key：调用OpenSearch-LLM智能问答版服务时，需要对调用者身份进行鉴权，具体请参见管理API Key。
获取服务调用地址：调用OpenSearch-LLM智能问答版服务时，需要提供服务的调用地址，具体请参见获取服务调用地址。

接口信息

请求方法	请求协议	请求数据格式

请求方法	请求协议	请求数据格式
GET	HTTP	JSON

请求URL

{host}/v3/openapi/apps/[app_group_identity]/knowledge/documents

{host}：调用服务的地址，支持通过公网和VPC两种方式调用API服务，可参见获取服务调用地址。
{app_group_identity}：应用名称（需要指定应用名访问，主要针对服务中的应用版本）。需要登录OpenSearch-LLM智能问答版控制台，在实例列表中查看对应实例的应用名称。

请求参数

参数	类型	位置	是否必填	描述

参数	类型	位置	是否必填	描述
app_group_identity	String	Path	是	应用名称/ID/实例ID。
id	String	Query	否	文档ID。
title	String	Query	否	文档的标题（模糊匹配）。
category	String	Query	否	文档分类。
page_number	Integer	Query	否	页码。
page_size	Integer	Query	否	每页数量。
table_name	String	Query	否	要查询的表名，置空默认为main表。

请求体示例

{
    "title": "测试",
    "category": "test",
    "page_number": 1,
    "page_size": "20"
}

返回参数

参数	类型	描述

参数	类型	描述
id	String	主键ID。
title	String	文档的标题。
score	Float	文档内容分。
timestamp	Integer	文档时间。
status	String	表示文档处理状态。 ok：处理成功 failed：处理失败 processing：处理中 indexing：索引中

响应体示例

[
    {
        "id": "5241",
        "title": "购买自住住房提取住房公积金",
        "score": 0,
        "timestamp": 0,
        "status": "ok"
    },
    {
        "id": "5238",
        "title": "社会保障卡业务操作规范",
        "score": 0,
        "timestamp": 0,
        "status": "ok"
    },
    {
        "id": "5234",
        "title": "内资分公司注销登记提交材料规范",
        "score": 0,
        "timestamp": 0,
        "status": "ok"
    }
]