为指定数据项创建索引

POST

/open-apis/search/v2/data_sources/{data_source_id}/items

自建应用商店应用

索引一条数据记录

错误码

HTTP状态码	错误码	描述	排查建议
500	1270001	系统内部错误	联系系统开发人员协助定位
400	1270002	参数错误	根据错误信息和文档排查非法参数
400	1270004	数据源不存在	确认 datasource ID 是否正确
400	1270005	该功能仅对旗舰版可用	请联系销售人员升级套餐以使用此高级功能
400	1271004	acl字段填写不完整	填写数据项的可见性
401	1272001	无权限操作数据源	确认 datasource ID 是否合法
500	1272002	操作鉴权失败	如果重试后仍然失败，请联系系统开发人员协助定位

请求示例

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://open.feishu.cn/open-apis/search/v2/data_sources/service_ticket/items' \
--header 'Authorization;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "id": "01010111",
    "acl": [
        {
            "access": "allow",
            "value": "everyone",
            "type": "user"
        }
    ],
    "metadata": {
        "title": "工单：无法创建文章",
        "source_url": "http://www.abc.com.cn",
        "create_time": 1618831236,
        "update_time": 1618831236
    },
    "structured_data": "{\"key\":\"value\"}",
    "content": {
        "format": "html",
        "content_data": "这是一个很长的文本"
    }
}'

响应示例

{
  "code": 0,
  "data": {},
  "msg": "success"
}

请求参数

Path 参数

data_source_id

必需

数据源的ID 示例值："service_ticket"

示例值:

service_ticket

Header 参数

Authorization

string

必需

tenant_access_token 或 user_access_token 值格式："Bearer access_token" 示例值："Bearer u-7f1bcd13fc57d46bac21793a18e560"

默认值:

Bearer {{access_token}}

Content-Type

string

必需

固定值："application/json; charset=utf-8"

默认值:

application/json; charset=utf-8

Body 参数application/json

string

必需

item 在 datasource 中的唯一标识示例值："01010111"

acl

array [object {3}]

必需

item 的访问权限控制

access

string

可选

权限类型，优先级：Deny > Allow。默认为全员不可见，即 deny。示例值："allow" 可选值有： allow：允许访问 deny：禁止访问

value

string

可选

设置的权限值，例如 userID 、groupID，依赖 type 描述。注：在 type 为 user 且 access 为 allow 时，可填 "everyone" 来表示该数据项对全员可见。示例值："6629468020840333501"

type

string

可选

权限值类型示例值："user" 可选值有： user：访问权限控制中指定用户可以访问或拒绝访问该条数据 group：访问权限控制中指定用户组可以访问或拒绝访问该条数据

metadata

object

item 的元信息

必需

title

string

必需

该条数据记录对应的标题示例值："工单：无法创建文章"

source_url

string

必需

该条数据记录对应的跳转url 示例值："http://www.abc.com.cn"

create_time

integer

必需

数据项的创建时间。Unix 时间，单位为秒示例值：1618831236

update_time

integer

必需

数据项的更新时间。Unix 时间，单位为秒示例值：1618831236

structured_data

string

必需

结构化数据（以 json 字符串传递），这些字段是搜索结果的展示字段（title字段无须在此另外指定）；目前支持的key为： summary：搜索结果的摘要； icon_url：搜索结果的icon地址； footer：搜索结果的脚注示例值："{"key":"value"}"

content

object

必需

非结构化数据，如文档文本，飞书搜索会用来做召回

format

string

必需

内容的格式示例值："html" 可选值有： html：html格式 plaintext：纯文本格式

content_data

string

必需

全文数据示例值："这是一个很长的文本"

示例

返回响应

🟢200200 Success

application/json

Body

code

integer

必需

错误码，非 0 表示失败

msg

string

错误描述

必需

data

object

必需

修改于 2023-02-03 07:10:57

批量为数据项创建索引

获取数据项

为指定数据项创建索引

错误码#

请求参数

返回响应

错误码