本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。
Micoft Yammer
Microsoft Yammer 是一款用于消息、会议和文件共享的企业协作工具。如果你是微软 Yammer 用户,你可以使用 Amazon Kendra 索引你的微软 Yammer 数据源。
你可以使用Amazon Kendra 控制台和 TemplateConfigurationAPI Amazon Kendra 连接到你的 Microsoft Yammer 数据源。
要对 Amazon Kendra Microsoft Yammer 数据源连接器进行故障排除,请参阅数据来源故障排除。
支持的特征
先决条件
在使用 Amazon Kendra 索引微软 Yammer 数据源之前,请先在微软 Yammer 和 AWS 账户中进行这些更改。
在 Microsoft Yammer 中,请确保:
-
在 Office 365 中创建了微软 Yammer 管理账户。
-
记下您的 Microsoft Yammer 用户名和密码。
-
记下了您的 Microsoft 365 租户 ID。在 Azure Active Directory 门户的“属性”或 OAuth 应用程序中可以找到您的租户 ID。
-
在 Azure 门户中配置了 OAuth 应用程序,并记下了客户端 ID 和客户端密钥或客户端凭据。有关更多信息,请参阅 Microsoft 教程和注册应用程序示例。
在 Azure 门户中创建或注册应用程序时,密钥 ID 代表实际的密钥值。在创建密钥和应用程序时,您必须立即记下或保存实际的密钥值。你可以通过在 Azure 门户中选择应用程序的名称,然后导航到证书和密钥上的菜单选项来访问你的密钥。
你可以通过在 Azure 门户中选择应用程序的名称,然后导航到概述页面来访问你的客户端 ID。应用程序(客户端)ID 是客户端 ID。
我们建议您定期刷新或轮换您的凭证和密码。为了安全起见,请仅提供必要的访问权限级别。我们建议不要跨数据来源以及连接器版本 1.0 和 2.0(如果适用)重复使用凭证和密钥。
-
在 Microsoft Yammer 以及计划用于编制同一索引的其他数据来源中,已检查每个文档都是唯一的。您要用于编制索引的每个数据来源在所有数据来源中都不能包含相同的文档。文档 ID 对索引来说是全局性的,并且每个索引都必须是唯一的。
在你的 AWS 账户,请确保你有:
-
已创建 Amazon Kendra 索引,如果使用 API,则记下索引 ID。
-
为您的数据源@@ 创建了一个 IAM 角色,如果使用 API,请记下该角色的 ARN。 IAM
如果您更改了身份验证类型和证书,则必须更新您的 IAM 角色才能访问正确的 AWS Secrets Manager 密钥 ID。
-
将您的 Microsoft Yammer 身份验证凭证存储在 AWS Secrets Manager 密钥中,如果使用 API,请记下密钥的 ARN。
我们建议您定期刷新或轮换您的凭证和密码。为了安全起见,请仅提供必要的访问权限级别。我们建议不要跨数据来源以及连接器版本 1.0 和 2.0(如果适用)重复使用凭证和密钥。
如果你没有现有的 IAM 角色或密钥,则可以在将 Microsoft Yammer 数据源连接到 Amazon Kendra时使用控制台创建新的 IAM 角色和 Secrets Manager 密钥。如果您使用的是 API,则必须提供现有 IAM 角色和 Secrets Manager 密钥的 ARN 以及索引 ID。
连接说明
Amazon Kendra 要连接到你的 Microsoft Yammer 数据源,你必须提供微软 Yammer 数据源的必要细节,这样 Amazon Kendra 才能访问你的数据。如果你尚未为其配置 Microsoft Yammer Amazon Kendra,请参阅先决条件。
- Console
-
连接 Amazon Kendra 微软 Yammer
-
登录 AWS Management Console 并打开Amazon Kendra 控制台。
-
在左侧导航窗格中,选择索引,然后从索引列表中选择要使用的索引。
您可以选择在索引设置下配置或编辑您的用户访问控制设置。
-
在入门页面上,选择添加数据来源。
-
在添加数据源页面上,选择 Microsoft Yammer 连接器,然后选择添加连接器。如果使用版本 2(如果适用),请选择带有 “V2.0” 标签的 Microsoft Yammer 连接器。
-
在指定数据来源详细信息页面上输入以下信息:
-
在名称和描述中,在数据来源名称中输入您的数据来源的名称。可以包含连字符,但不能包含空格。
-
(可选)说明 - 为数据来源输入说明。
-
使用默认语言-选择一种语言来筛选文档中的索引。除非另行指定,否则语言默认为英语。在文档元数据中指定的语言会覆盖所选语言。
-
在标签中,用于添加新标签-包括可选标签以搜索和筛选您的资源或跟踪您的 AWS 成本。
-
选择下一步。
-
在定义访问权限和安全性页面上,请输入以下信息:
-
授权-如果您有 ACL 并想将其用于访问控制,请打开或关闭文档的访问控制列表 (ACL) 信息。ACL 指定用户和群组可以访问哪些文档。ACL 信息用于根据用户或用户组对文档的访问权限来筛选搜索结果。有关更多信息,请参阅用户上下文筛选。
-
AWS Secrets Manager 密钥 — 选择现有密钥或创建新 Secrets Manager 密钥来存储你的 Microsoft Yammer 身份验证凭据。如果您选择创建新密钥,则会打开 AWS Secrets Manager 密钥窗口。
-
在创建 AWS Secrets Manager 密钥窗口中输入以下信息:
-
密钥名称 - 密钥的名称。前缀 “AmazonKendra-Microsoft Yammer-” 会自动添加到你的密钥名称中。
-
对于用户名、密码-输入你的 Microsoft Yammer 用户名和密码。
-
对于客户端 ID,客户端密钥-在 Azure 门户中输入在 Microsoft Yammer 中配置的身份验证凭据。
-
保存并添加您的密钥。
-
虚拟私有云(VPC)- 您可以选择使用 VPC。如果是这样,则必须添加子网和 VPC 安全组。
-
I Amazon Kendra dent@@ ity Crawler-指定是否开启身份搜寻器。Identity Crawler 使用文档的访问控制列表 (ACL) 信息,根据用户或其群组对文档的访问权限筛选搜索结果。如果您的文档有 ACL 并选择使用您的 ACL,则也可以选择开启身份爬网程序来配置搜索结果 Amazon Kendra的用户上下文筛选。否则,如果身份搜寻器已关闭,则可以公开搜索所有文档。如果您想对文档使用访问控制并且身份搜寻器已关闭,则可以使用 PutPrincipalMappingAPI 上传用户和群组访问信息以进行用户上下文筛选。
-
IAM ro le —选择现有 IAM 角色或创建新 IAM 角色来访问您的存储库凭据和索引内容。
IAM 用于索引的角色不能用于数据源。如果您不确定是否将现有角色用于编制索引或常见问题解答,为了避免出错,请选择创建新角色。
-
选择下一步。
-
在配置同步设置页面上,请输入以下信息:
-
起始日期-指定开始在 Microsoft Yammer 中抓取数据的日期。
-
同步内容-选择要抓取的内容类型。例如,公共消息、私人消息和附件。
-
其他配置-指定要抓取的某些社区名称,还可以使用正则表达式模式来包含或排除某些内容。
-
同步模式 - 选择在数据来源内容发生变化时更新索引的方式。首次与同步数据源时, Amazon Kendra 默认情况下会对所有内容进行抓取和索引。如果初始同步失败,即使您没有选择完全同步作为同步模式选项,也必须对数据进行完全同步。
-
完全同步:对所有内容进行新索引,每次数据源与索引同步时都会替换现有内容。
-
修改过的新同步:每次数据源与索引同步时,仅为新增和修改过的内容编制索引。 Amazon Kendra 可以使用数据源的机制来跟踪内容更改并索引自上次同步以来更改的内容。
-
新增、已修改、已删除的同步:每次数据源与索引同步时,仅索引新内容、修改内容和已删除内容。 Amazon Kendra 可以使用数据源的机制来跟踪内容更改并索引自上次同步以来更改的内容。
-
在同步运行计划中,对于频率-选择同步数据源内容和更新索引的频率。
-
选择下一步。
-
在设置字段映射页面上,请输入以下信息:
-
默认数据源字段-从 Amazon Kendra 生成的默认数据源字段中选择要映射到索引的字段。
-
添加字段 - 添加自定义数据来源字段以创建要映射到的索引字段名称和字段数据类型。
-
选择下一步。
-
在查看和创建页面上,请检查输入的信息是否正确,然后选择添加数据来源。您也可以选择在此页面上编辑信息。成功添加数据来源后,您的数据来源将显示在数据来源页面上。
- API
-
连接 Amazon Kendra 微软 Yammer
您必须使用 TemplateConfigurationAPI 指定数据源架构的 JSON。您必须提供以下信息:
-
数据源-将数据源类型指定为使用 TemplateConfigurationJSON 架构YAMMER
时的类型。还要像调用 CreateDataSourceAPI TEMPLATE
时一样指定数据源。
-
同步模式-指定数据源内容发生变化时 Amazon Kendra 应如何更新索引。首次与同步数据源时, Amazon Kendra 默认情况下会对所有内容进行抓取和索引。如果初始同步失败,即使您没有选择完全同步作为同步模式选项,也必须对数据进行完全同步。您可以选择:
-
FORCED_FULL_CRAWL
对所有内容进行全新索引,每次数据源与索引同步时都要替换现有内容。
-
FULL_CRAWL
每次数据源与索引同步时,仅对新的、修改过的和已删除的内容编制索引。 Amazon Kendra 可以使用数据源的机制来跟踪内容更改并索引自上次同步以来更改的内容。
-
CHANGE_LOG
每次数据源与索引同步时,仅索引新的和修改过的内容。 Amazon Kendra 可以使用数据源的机制来跟踪内容更改并索引自上次同步以来更改的内容。
-
亚马逊秘密资源名称 (ARN)-提供密钥的亚马逊资源名称 (ARN),该 Secrets Manager 密钥包含你的 Microsoft Yammer 账户的身份验证凭证。密钥必须使用具有以下键的 JSON 结构存储:
{
"username": "user name
",
"password": "password
",
"clientId": "client ID
",
"clientSecret": "client secret
"
}
-
IAM 角色 —指定RoleArn
何时调用CreateDataSource
以向 IAM 角色提供访问您的 Secrets Manager 密钥和调用 Microsoft Yammer 连接器所需的公共 API 的权限,以及。 Amazon Kendra有关更多信息,请参阅 Microsoft Yammer 数据源的IAM 角色。
您还可以添加以下可选功能:
-
虚拟私有云(VPC)- 指定 VpcConfiguration
,以便调用 CreateDataSource
。有关更多信息,请参阅 配置 Amazon Kendra 为使用 Amazon VPC。
-
文档/内容类型-指定是否抓取社区内容、邮件和附件以及私人消息。
-
包含和排除过滤器-指定是包含还是排除某些内容。
大多数数据来源使用正则表达式模式,即称为筛选条件的包含或排除模式。如果您指定包含筛选条件,则只会为与包含筛选条件匹配的内容编制索引。不会为任何与包含筛选条件不匹配的文档编制索引。如果您指定包含和排除筛选条件,则不会为与排除筛选条件匹配的文档编制索引,即使它们与包含筛选条件相匹配。
-
I Amazon Kendra dent@@ ity Crawler-指定是否开启身份搜寻器。Identity Crawler 使用文档的访问控制列表 (ACL) 信息,根据用户或其群组对文档的访问权限筛选搜索结果。如果您的文档有 ACL 并选择使用您的 ACL,则也可以选择开启身份爬网程序来配置搜索结果 Amazon Kendra的用户上下文筛选。否则,如果身份搜寻器已关闭,则可以公开搜索所有文档。如果您想对文档使用访问控制并且身份搜寻器已关闭,则可以使用 PutPrincipalMappingAPI 上传用户和群组访问信息以进行用户上下文筛选。
-
字段映射-选择将 Microsoft Yammer 数据源字段映射到 Amazon Kendra 索引字段。有关更多信息,请参阅映射数据来源字段。
要搜索您的文档,必须输入文档正文字段或文档正文等效字段。 Amazon Kendra 您必须将数据源中的文档正文字段名称映射到索引字段名称_document_body
。其他所有字段均为可选字段。
有关要配置的其他重要 JSON 密钥的列表,请参阅 Microsoft Yammer 模板架构。
了解更多信息
要详细了解如何 Amazon Kendra 与 Microsoft Yammer 数据源集成,请参阅: