程序包 com.lark.oapi.service.baike.v1.resource

类 Entity

java.lang.Object

com.lark.oapi.service.baike.v1.resource.Entity

public class Entity
extends Object

构造器概要

构造器

构造器	说明
Entity(Config config)

方法概要

修饰符和类型	方法	说明
CreateEntityResp	create(CreateEntityReq req)	创建免审词条，通过此接口创建的词条，不需要百科管理员审核可直接写入词库，请慎重使用【租户管理员请慎重审批】。
CreateEntityResp	create(CreateEntityReq req, RequestOptions reqOptions)	创建免审词条，通过此接口创建的词条，不需要百科管理员审核可直接写入词库，请慎重使用【租户管理员请慎重审批】。
ExtractEntityResp	extract(ExtractEntityReq req)	提取潜在的百科词条，提取文本中可能成为百科词条的词语，且不会过滤已经成为百科词条的词语。
ExtractEntityResp	extract(ExtractEntityReq req, RequestOptions reqOptions)	提取潜在的百科词条，提取文本中可能成为百科词条的词语，且不会过滤已经成为百科词条的词语。
GetEntityResp	get(GetEntityReq req)	获取词条详情，通过词条 id 拉取对应的词条详情信息。
GetEntityResp	get(GetEntityReq req, RequestOptions reqOptions)	获取词条详情，通过词条 id 拉取对应的词条详情信息。
HighlightEntityResp	highlight(HighlightEntityReq req)	词条高亮，传入一句话，智能识别句中对应的词条，并返回词条位置和 entity_id，可在外部系统中快速实现百科词条智能高亮。
HighlightEntityResp	highlight(HighlightEntityReq req, RequestOptions reqOptions)	词条高亮，传入一句话，智能识别句中对应的词条，并返回词条位置和 entity_id，可在外部系统中快速实现百科词条智能高亮。
ListEntityResp	list(ListEntityReq req)	获取词条列表，分页拉取词条列表数据，支持拉取租户内的全部词条。
ListEntityResp	list(ListEntityReq req, RequestOptions reqOptions)	获取词条列表，分页拉取词条列表数据，支持拉取租户内的全部词条。
MatchEntityResp	match(MatchEntityReq req)	精准搜索词条，将关键词与词条名、别名精准匹配，并返回对应的 词条 ID。
MatchEntityResp	match(MatchEntityReq req, RequestOptions reqOptions)	精准搜索词条，将关键词与词条名、别名精准匹配，并返回对应的 词条 ID。
SearchEntityResp	search(SearchEntityReq req)	模糊搜索词条，传入关键词，与词条名、别名、释义等信息进行模糊匹配，返回搜到的词条信息。
SearchEntityResp	search(SearchEntityReq req, RequestOptions reqOptions)	模糊搜索词条，传入关键词，与词条名、别名、释义等信息进行模糊匹配，返回搜到的词条信息。
UpdateEntityResp	update(UpdateEntityReq req)	更新免审词条，通过此接口更新已有的词条，不需要百科管理员审核可直接写入词库，请慎重使用【租户管理员请慎重审批】。
UpdateEntityResp	update(UpdateEntityReq req, RequestOptions reqOptions)	更新免审词条，通过此接口更新已有的词条，不需要百科管理员审核可直接写入词库，请慎重使用【租户管理员请慎重审批】。

从类继承的方法 java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

Entity

public Entity(Config config)

方法详细资料

create

public CreateEntityResp create(CreateEntityReq req,
 RequestOptions reqOptions)
                        throws Exception

创建免审词条，通过此接口创建的词条，不需要百科管理员审核可直接写入词库，请慎重使用【租户管理员请慎重审批】。

官网API文档链接:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/entity/create ;

使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/baikev1/CreateEntitySample.java ;

抛出:

Exception

create

public CreateEntityResp create(CreateEntityReq req)
                        throws Exception

创建免审词条，通过此接口创建的词条，不需要百科管理员审核可直接写入词库，请慎重使用【租户管理员请慎重审批】。

官网API文档链接:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/entity/create ;

使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/baikev1/CreateEntitySample.java ;

抛出:

Exception

extract

public ExtractEntityResp extract(ExtractEntityReq req,
 RequestOptions reqOptions)
                          throws Exception

提取潜在的百科词条，提取文本中可能成为百科词条的词语，且不会过滤已经成为百科词条的词语。同时，会返回推荐的别名。

官网API文档链接:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/entity/extract ;

使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/baikev1/ExtractEntitySample.java ;

抛出:

Exception

extract

public ExtractEntityResp extract(ExtractEntityReq req)
                          throws Exception

提取潜在的百科词条，提取文本中可能成为百科词条的词语，且不会过滤已经成为百科词条的词语。同时，会返回推荐的别名。

官网API文档链接:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/entity/extract ;

使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/baikev1/ExtractEntitySample.java ;

抛出:

Exception

get

public GetEntityResp get(GetEntityReq req,
 RequestOptions reqOptions)
                  throws Exception

获取词条详情，通过词条 id 拉取对应的词条详情信息。

也支持通过 provider 和 outer_id 返回对应实体的详情数据。此时路径中的 entity_id 为固定的 enterprise_0 ;

官网API文档链接:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/entity/get ;

使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/baikev1/GetEntitySample.java ;

抛出:

Exception

get

public GetEntityResp get(GetEntityReq req)
                  throws Exception

获取词条详情，通过词条 id 拉取对应的词条详情信息。

也支持通过 provider 和 outer_id 返回对应实体的详情数据。此时路径中的 entity_id 为固定的 enterprise_0 ;

官网API文档链接:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/entity/get ;

使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/baikev1/GetEntitySample.java ;

抛出:

Exception

highlight

public HighlightEntityResp highlight(HighlightEntityReq req,
 RequestOptions reqOptions)
                              throws Exception

词条高亮，传入一句话，智能识别句中对应的词条，并返回词条位置和 entity_id，可在外部系统中快速实现百科词条智能高亮。

官网API文档链接:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/entity/highlight ;

使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/baikev1/HighlightEntitySample.java ;

抛出:

Exception

highlight

public HighlightEntityResp highlight(HighlightEntityReq req)
                              throws Exception

词条高亮，传入一句话，智能识别句中对应的词条，并返回词条位置和 entity_id，可在外部系统中快速实现百科词条智能高亮。

官网API文档链接:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/entity/highlight ;

使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/baikev1/HighlightEntitySample.java ;

抛出:

Exception

list

public ListEntityResp list(ListEntityReq req,
 RequestOptions reqOptions)
                    throws Exception

获取词条列表，分页拉取词条列表数据，支持拉取租户内的全部词条。

官网API文档链接:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/entity/list ;

使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/baikev1/ListEntitySample.java ;

抛出:

Exception

list

public ListEntityResp list(ListEntityReq req)
                    throws Exception

获取词条列表，分页拉取词条列表数据，支持拉取租户内的全部词条。

官网API文档链接:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/entity/list ;

使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/baikev1/ListEntitySample.java ;

抛出:

Exception

match

public MatchEntityResp match(MatchEntityReq req,
 RequestOptions reqOptions)
                      throws Exception

精准搜索词条，将关键词与词条名、别名精准匹配，并返回对应的 词条 ID。

官网API文档链接:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/entity/match ;

使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/baikev1/MatchEntitySample.java ;

抛出:

Exception

match

public MatchEntityResp match(MatchEntityReq req)
                      throws Exception

精准搜索词条，将关键词与词条名、别名精准匹配，并返回对应的 词条 ID。

官网API文档链接:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/entity/match ;

使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/baikev1/MatchEntitySample.java ;

抛出:

Exception

search

public SearchEntityResp search(SearchEntityReq req,
 RequestOptions reqOptions)
                        throws Exception

模糊搜索词条，传入关键词，与词条名、别名、释义等信息进行模糊匹配，返回搜到的词条信息。

官网API文档链接:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/entity/search ;

使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/baikev1/SearchEntitySample.java ;

抛出:

Exception

search

public SearchEntityResp search(SearchEntityReq req)
                        throws Exception

模糊搜索词条，传入关键词，与词条名、别名、释义等信息进行模糊匹配，返回搜到的词条信息。

官网API文档链接:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/entity/search ;

使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/baikev1/SearchEntitySample.java ;

抛出:

Exception

update

public UpdateEntityResp update(UpdateEntityReq req,
 RequestOptions reqOptions)
                        throws Exception

更新免审词条，通过此接口更新已有的词条，不需要百科管理员审核可直接写入词库，请慎重使用【租户管理员请慎重审批】。

官网API文档链接:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/entity/update ;

使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/baikev1/UpdateEntitySample.java ;

抛出:

Exception

update

public UpdateEntityResp update(UpdateEntityReq req)
                        throws Exception

更新免审词条，通过此接口更新已有的词条，不需要百科管理员审核可直接写入词库，请慎重使用【租户管理员请慎重审批】。

官网API文档链接:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/entity/update ;

使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/baikev1/UpdateEntitySample.java ;

抛出:

Exception