飞书开放平台 Server API 文档

主题

修改数据范式 ​

修改数据范式。

请求 ​

项目值
HTTP URLhttps://open.feishu.cn/open-apis/search/v2/schemas/:schema_id
HTTP MethodPATCH
支持的应用类型custom,isv
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 开启任一权限即可search:data_source 查询、创建、修改和删除自定义搜索数据源、数据范式或数据项 search:data_source:readonly 查询自定义搜索数据源、数据范式或数据项

请求头 ​

名称类型必填描述
Authorizationstring是tenant_access_token 值格式："Bearer access_token" 示例值："Bearer t-7f1bcd13fc57d46bac21793a18e560" 了解更多：如何选择与获取 access token
Content-Typestring是固定值："application/json; charset=utf-8"

路径参数 ​

名称类型描述
schema_idstring用户自定义数据范式的唯一标识
示例值："custom_schema_id"
数据校验规则：
- 最大长度：40 字符
- 正则校验：^[a-zA-Z][a-zA-Z0-9-_].*$

请求体 ​

名称类型必填描述
displayschema_display否数据展示相关配置
  └ card_keystring是搜索数据的展示卡片
卡片详细信息请参考 通用模块接入指南 "请求创建数据范式"部分
示例值："search_common_card"
可选值有：
- search_common_card: 普通 common 卡片
  └ fields_mappingschema_display_field_mapping\[\]否数据字段名称和展示字段名称的映射关系。如果没有设置，则只会展示 与展示字段名称同名的 数据字段
    └ display_fieldstring是展示字段名称，与 card_key 有关，每个模版能展示的字段不同。该字段不能重复
示例值："summary"
    └ data_fieldstring是数据字段的名称。需要确保该字段对应在 schema 属性定义中的 is_returnable 为 true，否则无法展示。需要使用 ${xxx} 的规则来描述
示例值："${description}"

请求体示例 ​

json
{
    "display": {
        "card_key": "search_common_card",
        "fields_mapping": [
            {
                "data_field": "${description}",
                "display_field": "summary"
            }
        ]
    }
}

响应 ​

响应体 ​

名称类型描述
codeint错误码，非 0 表示失败
msgstring错误描述
data\--
  └ schemaschema数据范式实例
    └ propertiesschema_property\[\]数据范式的属性定义
      └ namestring属性名
      └ typestring属性类型
可选值有：
- text: 长文本类型 - int: 64位整数类型 - tag: 标签类型 - timestamp: Unix 时间戳类型（单位为秒） - double: 浮点数类型（小数） - tinytext: 短文本类型，（utf8 编码）长度小于 140 的文本。在设置 search_options 时，与 text 类型有区别，支持更多召回策略
      └ is_searchableboolean该属性是否可用作搜索，默认为 false
      └ is_sortableboolean该属性是否可用作搜索结果排序，默认为 false。如果为 true，需要再配置 sortOptions
      └ is_returnableboolean该属性是否可用作返回字段，为 false 时，该字段不会被召回和展示。默认为 false
      └ sort_optionsschema_sort_options属性排序的可选配置，当 is_sortable 为 true 时，该字段为必填字段
        └ priorityint排序的优先级，可选范围为 0~4，0为最高优先级。如果优先级相同，则随机进行排序。默认为0
可选值有：
- 0: 最高优先级 - 1: 次高优先级 - 2: 次次高优先级 - 3: 次低优先级 - 4: 最低优先级
        └ orderstring排序的顺序。默认为 desc
可选值有：
- asc: 升序 - desc: 降序
      └ type_definitionsschema_type_definitions相关类型数据的定义和约束
        └ tagschema_tag_options\[\]标签类型的定义
          └ namestringtag 对应的枚举值名称
          └ colorstring标签对应的颜色
可选值有：
- red: 含警示性、敏感性的提示信息 - green: 表示成功、完成、完毕的提示信息 - blue: 组件架构、职能等中性信息 - grey: 中立系统提示信息（慎重使用） - yellow: 焦点信息、推广性信息
          └ textstring标签中展示的文本
      └ search_optionsschema_search_options属性搜索的可选配置，当 is_searchable 为 true 时，该字段为必填参数
        └ enable_semantic_matchboolean是否支持语义切词召回。默认不支持（推荐使用在长文本的场景）
        └ enable_exact_matchboolean是否支持精确匹配。默认不支持（推荐使用在短文本、需要精确查找的场景）
        └ enable_prefix_matchboolean是否支持前缀匹配（短文本的默认的分词/召回策略。前缀长度为 1-12）
        └ enable_number_suffix_matchboolean是否支持数据后缀匹配。默认不支持（推荐使用在短文本、有数字后缀查找的场景。后缀长度为3-12）
        └ enable_camel_matchboolean是否支持驼峰英文匹配。默认不支持（推荐使用在短文本，且包含驼峰形式英文的查找场景）
    └ displayschema_display数据展示相关配置
      └ card_keystring搜索数据的展示卡片
卡片详细信息请参考 通用模块接入指南 "请求创建数据范式"部分
可选值有：
- search_common_card: 普通 common 卡片
      └ fields_mappingschema_display_field_mapping\[\]数据字段名称和展示字段名称的映射关系。如果没有设置，则只会展示 与展示字段名称同名的 数据字段
        └ display_fieldstring展示字段名称，与 card_key 有关，每个模版能展示的字段不同。该字段不能重复
        └ data_fieldstring数据字段的名称。需要确保该字段对应在 schema 属性定义中的 is_returnable 为 true，否则无法展示。需要使用 ${xxx} 的规则来描述
    └ schema_idstring用户自定义数据范式的唯一标识

响应体示例 ​

json
{
    "code": 0,
    "data": {
        "schema": {
            "display": {
                "card_key": "search_common_card",
                "fields_mapping": [
                    {
                        "data_field": "${description}",
                        "display_field": "summary"
                    }
                ]
            },
            "properties": [
                {
                    "is_returnable": true,
                    "is_searchable": true,
                    "name": "description",
                    "search_options": {
                        "enable_camel_match": false,
                        "enable_exact_match": false,
                        "enable_number_suffix_match": false,
                        "enable_prefix_match": false,
                        "enable_semantic_match": true
                    },
                    "type": "text"
                },
                {
                    "is_returnable": true,
                    "name": "icon_url",
                    "type": "text"
                },
                {
                    "name": "rank",
                    "sort_options": {
                        "order": "asc"
                    },
                    "type": "int"
                },
                {
                    "is_returnable": true,
                    "name": "priority",
                    "type": "tag",
                    "type_definitions": {
                        "tag": [
                            {
                                "color": "red",
                                "name": "type",
                                "text": "type"
                            }
                        ]
                    }
                }
            ],
            "schema_id": "example_schema"
        }
    },
    "msg": "success"
}

错误码 ​

HTTP状态码错误码描述排查建议
5001270001系统内部错误联系系统开发人员协助定位
4001270002参数错误根据错误信息和文档排查非法参数
4001270005该功能仅对旗舰版可用请联系销售人员升级套餐以使用此高级功能
4001273004记录不存在检查请求的记录是否真实存在
4001273005请求体参数错误或缺失根据错误信息和文档排查
4001274002定义的字段名称重复修改重复字段
4001274008字段和类型不匹配检查字段的名称是否可以设置为对应类型
4001274010字段名称不符合规范检查对应字段是否包含非法字符和长度是否合规

内容来源：飞书开放平台 · 自动爬取整理

本镜像仅供学习与查阅，文档版权归飞书所有