如何设置企业搜索
企业搜索vs REST API
值得指出的是,企业搜索API与REST API完全不同。
为了使用Enterprise Search,您不需要使用REST API进行身份验证
简介
Enterprise Search允许您开发应用程序,将来自另一个系统的信息推入到交互搜索索引中,允许来自外部系统的文档与交互自己的搜索结果一起显示在搜索结果中。
从用户的角度来看,存储在内部网中的信息与存储在其他地方的信息之间的唯一区别是搜索结果中显示的图标,并且可以在设置应用程序时进行配置。
为了做到这一点,您需要创建自己的连接器。接口进行通信交互企业搜索API.这将允许您选择将什么内容推入搜索索引以及何时。还可以将安全设置写入连接器。
配置新应用
添加到Interact的文档被分组为“应用程序”。这个应用程序将管理为文档显示的图标,以及在搜索结果右侧的过滤器中出现的名称。
API
要添加文档,需要使用作为内部网一部分公开的REST端点。
URL是:
http:// {your_intranet_url} / api / searchapp
然后,您可以使用它来管理搜索应用程序的文档。
http:// {your_intranet_url} / api / searchapp / {appid} /文档
确定应用程序id
URL的appid组件引用了交互中企业搜索配置的id。可以通过编辑企业搜索配置并查看URL来发现这一点。
例如,URL可能是https://interactgo.com/InteractV7/SearchApp/Edit/1
本例中appid为1
content-type必须是application/json。
上面的方法接受一个HTTP PUT请求,并接受JSON数据和您想要提交的文档文本。
删除
要删除文档,只需使用下面的HTTP delete谓词。
http:// {your_intranet_url} / api / searchapp / 1 /文档/ {documentid}
身份验证
您创建的每个搜索应用程序都有自己的身份验证密钥。这是在X-ApiKey头中作为请求的一部分发送的。
可以使用企业内部网络中的管理企业搜索页面设置和更改密钥。
可选字段为:
字段名 | 类型 | 可搜索的 | 结果显示 | 要求 |
---|---|---|---|---|
Id | 文本(最多45个字符) | 没有 | 没有 | 是的 |
标题 | 文本 | 是的 | 是的 | 是的 |
总结 | 文本 | 是的 | 是的 | 是的 |
身体 | 文本 | 是的 | 没有 | 是的 |
Url | 文本 | 没有 | 是的 | 是的 |
作者 | 测试 | 是的 | 是的 | 没有 |
BestBets | 文本数组 | 是的 | 是的 | 没有 |
关键字 | 文本 | 是的 | 没有 | 没有 |
IsPublic | 布尔 | 没有 | 没有 | 是的 |
AllowedPeople | 整型数组 | 没有 | 没有 | 没有 |
DisallowedPeople | 整型数组 | 没有 | 没有 | 没有 |
AllowedOrganisations | 整型数组 | 没有 | 没有 | 没有 |
DisallowedOrganisations | 整型数组 | 没有 | 没有 | 没有 |
如。
{"Url": "http://example/example。aspx", "Id": "12345a", "Title": "I'm from SearchApps", "IsPublic": "true", "正文":"此文本仅可搜索,不可查看","摘要":"用户将看到此截短的部分","作者":"Peter Smith", "BestBets": ["SearchApps"], "关键词":"Keyword1 Keyword2"}
安全
这5个安全字段允许您在粒度级别上定义谁可以在搜索结果中查看文档。
用户是否可以看到内容的逻辑是:
如果我在DisallowedPeople中
我将无法访问。
如果我的任何组织在不允许的组织
我将无法访问。
如果“IsPublic”为真,或者如果我在AllowedPeople或我的一个组织是在allowedorganizations
我会被允许进入的
设置企业搜索应用程序
在Intranet主页上,选择Profile图标,然后选择Application Settings。
在“应用程序设置”页面中,选择“控制面板”,然后选择“开发人员框架”。
下一步选择企业搜索。
进入企业搜索应用程序页面。
要添加一个新的搜索应用程序,单击创建新的搜索应用程序按钮。
在App Data界面。
添加搜索应用程序名称-搜索应用程序的名称。
添加秘密密钥-请添加秘密密钥,尽管你不应该在任何公共网站的客户端代码中暴露你的秘密api密钥。
你在这里输入的秘密密钥应该包含在任何请求中,作为一个名为“X-ApiKey”的HTTP头
添加内容类型名称-请添加内容类型名称,这将在搜索结果中作为过滤器选项使用。
添加文档图标资产-请添加您想要用于图标的图像资产的ID。
单击Save。
更新 13天前