View a markdown version of this page

连接到 Salesforce 来为知识库摄取内容 - Amazon Bedrock
支持的特征先决条件连接配置

本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

连接到 Salesforce 来为知识库摄取内容

重要

为了优化检索准确性和托管体验，我们建议使用 Amazon Bedrock 托管知识库。

Salesforce 是一款客户关系管理（CRM）工具，用于管理支持、销售和营销团队。你可以使用适用于亚马逊 Bedrock 的AWS管理控制台或 CreateDataSourceAPI（参见亚马逊 Bedrock 支持的软件开发工具包和）连接到你的 Salesforc e 实例，以获取你的 Amazon Bedrock 知识库。AWS CLI

注意

Salesforce 数据来源连接器目前为预览版，可能随时发生变化。

Salesforce 数据来源不支持多模态数据，例如表、曲线图、图表或其他图像。

目前，只有 Amazon OpenSearch Serverless 矢量存储可用于此数据源。

对可爬取的文件数和文件的 MB 数是有限制的。请参阅 Quotas for knowledge bases。

支持的特征

  • 自动检测主要文档字段

  • Inclusion/exclusion 内容过滤器

  • 对已添加、更新、删除的内容进行增量内容同步

  • OAuth 2.0 身份验证

先决条件

在 Salesforce 中，请确保：

  • 记下 Salesforce 实例 URL。例如 https://company.salesforce.com/。实例必须运行与 Salesforce 连接的应用程序。

  • 创建与 Salesforce 连接的应用程序并配置客户端凭证。然后，对于您选择的应用程序，从 OAuth 设置中复制用户密钥（客户端 ID）和使用者密钥（客户端密钥）。有关更多信息，请参阅关于创建连接的应用程序和为 OAuth 2.0 客户端凭证配置连接的应用程序的 Salesforce 文档。

    注意

    对于与 Salesforce 连接的应用程序，在“客户端凭证流”下，确保在“运行方式”字段中为客户端凭证搜索并选择用户名或别名。

在您的AWS账户中，请确保：

  • 将身份验证凭证存储在 AWS Secrets Manager 密钥中，并记下该密钥的 Amazon 资源名称（ARN）。按照此页面上的连接配置说明添加密钥中必须包含的键值对。

  • 在知识库的 AWS Identity and Access Management (IAM) role/permissions 策略中包括连接数据源的必要权限。有关将此数据源添加到知识库IAM角色所需的权限的信息，请参阅访问数据源的权限。

注意

如果您使用控制台，则可以AWS Secrets Manager前往添加您的密钥或使用现有密钥作为数据源配置步骤的一部分。作为创建知识库的控制台步骤的一部分，可以为您创建具有所有所需权限的IAM角色。配置数据源和其他配置后，具有所有必需权限的IAM角色将应用于您的特定知识库。

我们建议您定期刷新或轮换您的凭证和密码。为了安全起见，请仅提供必要的访问权限级别。建议不要跨数据来源重复使用凭证和密钥。

连接配置

要连接到 Salesforce 实例，您必须提供必要的配置信息，以便 Amazon Bedrock 可以访问和爬取您的数据。您还必须遵循先决条件。

本部分包含此数据来源的配置示例。

有关自动检测文档字段、 inclusion/exclusion 筛选器、增量同步、秘密身份验证凭据及其工作原理的更多信息，请选择以下选项：

数据来源连接器会自动检测并爬取文档或内容的所有主要元数据字段。例如，数据来源连接器可以爬取与您的文档等效的文档正文、文档标题、文档创建或修改日期或其他可能适用于您文档的核心字段。

重要

如果您的内容包含敏感信息，则Amazon Bedrock可以使用敏感信息进行响应。

您可以对元数据字段应用筛选运算符，以帮助您进一步提高响应的相关性。例如，文档“epoch_modification_time”或文档在 1970 年 1 月 1 日最后一次更新之后经历的秒数。您可以通过将“epoch_modification_time”设置为大于某个数值，筛选出最新的数据。有关可以应用于元数据字段的筛选运算符的更多信息，请参阅元数据和筛选。

您可以包含或排除对某些内容的爬取。例如，您可以指定排除 prefix/regular 表达式模式来跳过对文件名中包含 “private” 的任何文件的抓取。您也可以指定包含 prefix/regular 表达式模式以包含某些内容实体或内容类型。如果您指定了包含和排除筛选条件，且两者都与文档匹配，则优先执行排除筛选条件，不爬取该文档。

排除或筛选掉活动名称中包含“private”的活动的正则表达式模式示例：".*private.*"

您可以对以下内容类型应用 inclusion/exclusion 过滤器：

  • Account: 账户 number/identifier

  • Attachment：附件文件名及其扩展名

  • Campaign：活动名称和相关标识符

  • ContentVersion：文档版本和相关标识符

  • Partner：合作伙伴信息字段，包括相关标识符

  • Pricebook2: Product/price 列表名称

  • Case: 客户 inquiry/issue 编号和其他信息字段，包括相关标识符（请注意：可能包含个人信息，您可以选择排除或过滤掉这些信息）

  • Contact：客户信息字段（请注意：可能包含个人信息，您可以选择排除或筛选掉这些信息）

  • Contract：合同名称和相关标识符

  • Document：文件名及其扩展名

  • Idea：想法信息字段和相关标识符

  • Lead：潜在新客户信息字段（请注意：可能包含个人信息，您可以选择排除或筛选掉这些信息）

  • Opportunity: 待处理的 sale/deal 信息字段和相关的标识符

  • Product2：商品信息字段和相关标识符

  • Solution: 客户的解决方案名称 inquiry/issue 和相关标识符

  • Task：任务信息字段和相关标识符

  • FeedItem：聊天源帖子的标识符

  • FeedComment：评论所属的聊天源帖子的标识符

  • Knowledge__kav：知识文章标题

  • User：组织内的用户别名

  • CollaborationGroup：聊天组名称（唯一）

每次您的数据源与知识库同步时，数据源连接器都会抓取新内容、修改内容和已删除内容。 Amazon Bedrock可以使用数据源的机制来跟踪内容更改并抓取自上次同步以来更改的内容。首次将数据来源与知识库同步时，默认爬取所有内容。

要将您的数据源与知识库同步，请使用 StartIngestionJobAPI 或在控制台中选择您的知识库，然后在数据源概述部分中选择同步。

重要

您从数据来源同步的所有数据都可供有检索数据的 bedrock:Retrieve 权限的任何人使用。这也可以包括任何具有受控数据来源权限的数据。有关更多信息，请参阅知识库权限。

（对于 OAuth 2.0 身份验证）您在 AWS Secrets Manager 中的密钥身份验证凭证应包含以下键值对：

  • consumerKey: app client ID

  • consumerSecret: app client secret

  • authenticationUrl: Salesforce instance URL or the URL to request the authentication token from

注意

您的密钥AWS Secrets Manager必须使用知识库中的相同区域。

Console
将 Salesforce 实例连接到知识库

  1. 按照在 Amazon Bedrock 知识库中通过连接到数据来源创建知识库中的步骤操作，然后选择 Salesforce 作为数据来源。

  2. 提供数据来源的名称和可选的描述。

  3. 提供你的 Salesforce 实例网址。例如 https://company.salesforce.com/。实例必须运行与 Salesforce 连接的应用程序。

  4. 在高级设置部分，您可以选择进行以下配置：

    • 用于临时数据存储的 KMS 密钥。— 您可以加密临时数据，同时使用默认密钥AWS 托管式密钥或您自己的 KMS 密钥将数据转换为嵌入内容。有关更多信息，请参阅 加密数据提取期间的临时数据存储。

    • 数据删除策略：您可以删除数据来源的向量嵌入（这些向量嵌入默认存储在向量存储中），也可以选择保留向量存储数据。

  5. 提供身份验证信息以连接 Salesforce 实例：

    1. 对于 OAuth 2.0 身份验证，请AWS Secrets Manager前往添加您的秘密身份验证凭证或使用您创建的密钥的现有 Amazon 资源名称 (ARN)。您的密钥必须包含与 Salesforce 连接的应用程序的用户密钥（客户端 ID）、使用者密钥（客户端密钥）以及 Salesforce 实例 URL 或请求身份验证词元的 URL。有关更多信息，请参阅关于创建连接的应用程序和为 OAuth 2.0 客户端凭证配置连接的应用程序的 Salesforce 文档。

  6. （可选）在内容解析和分块部分，您可以自定义如何对数据进行解析和分块。要了解有关这些定制设置的更多信息，请参阅以下资源：

  7. 选择使用 filters/regular 表达式模式来包含或排除某些内容。否则，所有标准内容都会被抓取。

  8. 继续选择嵌入模型和向量存储。要查看剩余步骤，请在连接数据来源后返回在 Amazon Bedrock 知识库中通过连接到数据来源创建知识库，然后继续执行该步骤。

API

以下是 Amazon Bedrock 知识库连接到 Salesforce 的配置示例。您可以使用带有AWS CLI或支持的软件开发工具包（例如 Python）的 API 来配置数据源。调用后 CreateKnowledgeBase，您可以调CreateDataSource用创建数据源，其中包含您的连接信息dataSourceConfiguration。

要了解可以通过添加可选的 vectorIngestionConfiguration 字段来应用于摄取的定制设置，请参阅自定义数据来源的摄取。

AWS Command Line Interface

aws bedrock create-data-source \
 --name "Salesforce connector" \
 --description "Salesforce data source connector for Amazon Bedrock to use content in Salesforce" \
 --knowledge-base-id "your-knowledge-base-id" \
 --data-source-configuration file://salesforce-bedrock-connector-configuration.json \
 --data-deletion-policy "DELETE" \
 --vector-ingestion-configuration '{"chunkingConfiguration":[{"chunkingStrategy":"FIXED_SIZE","fixedSizeChunkingConfiguration":[{"maxTokens":"100","overlapPercentage":"10"}]}]}'

salesforce-bedrock-connector-configuration.json
{
    "salesforceConfiguration": {
        "sourceConfiguration": {
            "hostUrl": "https://company.salesforce.com/",
            "authType": "OAUTH2_CLIENT_CREDENTIALS",
            "credentialsSecretArn": "arn:aws::secretsmanager:your-region:secret:AmazonBedrock-Salesforce"
        },
        "crawlerConfiguration": {
            "filterConfiguration": {
                "type": "PATTERN",
                "patternObjectFilter": {
                    "filters": [
                        {
                            "objectType": "Campaign",
                            "inclusionFilters": [
                                ".*public.*"
                            ],
                            "exclusionFilters": [
                                ".*private.*"
                            ]
                        }
                    ]
                }
            }
        }
    },
    "type": "SALESFORCE"
}