跳至主要内容
Onyx 的连接器在您组织的数据源与 Onyx 的生成式 AI 功能之间架起了一座桥梁。几乎所有的连接器都是持久性的,并定期从您的源中同步更改。
从源获取的数据以及您的用户可以通过 Onyx 访问的数据都可以根据您的需求进行自定义!
要查找每个连接器的具体说明,请参阅受支持的连接器部分。 Onyx 添加连接器页面

添加连接器

要添加新连接器,请导航至管理面板,并在侧边栏中点击添加连接器。此页面显示所有官方支持的连接器。
您可以通过在环境中设置 SHOW_EXTRA_CONNECTORS=true 来查看非官方的、社区支持的连接器。
点击任何图块即可开始创建新连接器。

凭据

大多数连接器需要某种形式的身份验证,以便 Onyx 访问您的数据源。这种身份验证称为“凭据”,具体取决于不同的连接器。 Onyx 连接器凭据页面

配置

每个连接器都必须有一个名称。此外,每个连接器都有自己的配置选项,用于指定应索引的数据。 Onyx 连接器配置页面

文档访问控制

连接器可以配置为私有公开自动同步权限 私有:只有创建该连接器的用户才能在 Onyx 中看到来自此连接器的数据。您还可以为特定的用户和用户组分配对此连接器数据的访问权限。 公开:所有 Onyx 用户都可以看到来自此连接器的数据。
如果您将连接器配置为访问数据源中的私有数据,则所有 Onyx 用户都将能够看到该数据。

权限同步连接器

如果您将连接器的访问类型设置为自动同步权限,Onyx 将维护来自数据源的访问控制列表,并限制用户仅能查看他们有权访问的数据。 权限同步仅适用于以下连接器:
  • Confluence
  • Jira
  • Google Drive(必须使用服务账号或 Google Workspace 管理员 OAuth 凭据)
  • Gmail(必须使用服务账号或 Google Workspace 管理员 OAuth 凭据)
  • Slack(请参阅联合 Slack 文档)
  • Salesforce
  • GitHub
  • SharePoint(必须使用基于证书的身份验证)
权限同步连接器是企业版(Enterprise Edition)功能。

高级配置

点击连接器配置页面左下角的高级配置,将显示其他可选的索引设置。 清理频率:从 Onyx 中移除旧数据(源中已不存在的数据)的频率。默认设置为 30 天。 刷新频率:从源中获取新数据的频率。默认设置为 30 分钟。 索引开始日期:开始索引数据的日期和时间(在此日期之前创建或更新的数据将不会被索引)。默认设置为源中可能的最早日期。 Onyx 连接器高级配置页面

管理现有连接器

要查看现有的连接器,请导航至管理面板,并在侧边栏中点击现有连接器。此页面将显示连接器的概览、其状态以及已索引的数据量。 Onyx 现有连接器页面显示连接器状态

连接器状态

连接器的状态可以是

活跃

状态说明
已索引连接器功能正常,且所有数据已按照最近一次索引尝试完成同步。
已调度新创建的连接器,或者已达到刷新频率但尚未开始新索引尝试的连接器。
正在索引 / 初始索引连接器当前正在从源检索数据。

不活跃或半活跃

状态说明
已暂停连接器已被暂停,在取消暂停之前不会检索新数据。用户仍然可以访问已索引的数据。
错误连接器在索引过程中遇到错误。在错误发生之前已索引的任何数据将保持可用。Onyx 将尝试再次进行索引。如果发生过多错误,连接器将被暂停。
大多数错误状态都是暂时的,会在几小时内自行解决。如果您发现错误状态持续存在,请与我们联系。

连接器详情

点击现有连接器将向您显示有关其配置、状态和索引尝试的详细信息。 管理菜单中,您可以暂停、恢复、删除或启动连接器的完整重新索引。 高级部分,您可以查看清理和刷新设置,以及索引尝试的历史记录。 Onyx 连接器详情页面显示连接器详细信息 Onyx 连接器详情页面显示索引尝试和失败记录

索引失败

在极少数情况下,您会看到已完成,但有错误的索引尝试。如果发生这种情况,您可以点击解决所有错误按钮,以启动连接器的完整重新索引。

支持的连接器

找不到您要找的连接器?请通过 GitHub Discussions 告诉我们!

知识库与维基

Confluence

SharePoint

Notion

BookStack

Document360

Discourse

GitBook

Slab

Outline

Google Sites

Guru

云存储

Google Drive

Dropbox

AWS S3

Google Storage

Egnyte

Oracle Storage

Cloudflare R2

票务与任务管理

Jira

Zendesk

Airtable

Linear

Freshdesk

Asana

ClickUp

ProductBoard

通讯

Slack

Microsoft Teams

Gmail

Discord

XenForo

Zulip

销售

Salesforce

HubSpot

Gong

Fireflies

Highspot

代码仓库

GitHub

GitLab

Bitbucket

其他

网页爬虫

文件上传