NameSearch¶
按名称或标题搜索项目：文档名称、邮件主题、代理会话标题、频道名称、项目名称或通话记录名称。这是关键词搜索，不是语义搜索：查询只匹配索引标题/名称中出现的字面词/标记、前缀或精确引用的术语。请将其用于目标明确的名称/标题查找，而不是用于活动摘要类问题，例如“今天发生了什么”、“最近怎么样”、“给我补个进度”或“今天的站会发生了什么”；这些问题应使用带时间/类型/频道过滤器的 ListEntities 开始。对于邮件，以空格分隔的术语进行 AND 运算，每个术语都针对主题进行前缀匹配。对于所有其他类型，整个查询作为单个相邻短语前缀进行匹配——因此请从标题中会字面出现的词语中挑选 1-3 个目标关键词，而不是用户用自然语言描述的内容；长短语不会匹配。匹配默认为前缀匹配；将 matchType 设置为 'exact' 以匹配完整标记/短语，不进行前缀扩展。将多词短语用双引号括起来，使其作为一个相邻短语保持在一起。如果用户的请求将某个人与某个主题结合在一起，请分别运行搜索（针对人使用 NameSearch，针对主题使用 ContentSearch），而不是进行组合查询。默认将 entityTypes 留空；仅当用户明确限定到某种类型时才进行过滤。文档、邮件、项目和通话记录的结果包含用户可见的标签，以 {label, scope} 对的形式呈现；若要将搜索限制为仅带标签的项目，请在 tags 参数中传入标签名（ListTags 显示存在哪些标签）。
参数¶
| 参数 | 类型 | 必填 | 描述 |
|---|---|---|---|
name |
string | 是 | 要搜索的名称或标题。传递 1-3 个关键词，这些关键词取自标题中会字面出现的词语，而不是用户用自然语言描述的内容。以空格分隔的术语进行 AND 运算。对于非电子邮件类型，整个查询作为单个相邻短语前缀进行匹配，因此长短语不会匹配。对于电子邮件，每个术语都会针对主题进行匹配。将多词短语用双引号括起来，以作为一个短语进行匹配。使用 matchType 'exact' 进行整词匹配，而不是前缀匹配。 |
matchType |
"partial" | "exact" |
否 | 搜索工具如何匹配查询术语。仅限于 partial/exact——后端还支持 regexp 和内部查询模式，但这些不向模型提供。 |
entityTypes |
("agent_sessions" | "documents" | "emails" | "channels" | "projects" | "call_records" | "calendar_events")[] |
否 | 要搜索的项目类型。留空（默认）以搜索所有类型——这几乎总是你想要的。仅当用户的请求明确针对一个或多个特定类型时才设置此参数。示例：['documents']、['emails', 'documents']、['channels']、['call_records']。 |
inbox |
string | 否 | 将电子邮件结果限制为单个已连接的收件箱，以该收件箱的电子邮件地址形式给出（来自 ListInboxes）。省略此参数则可搜索用户可访问的所有收件箱。仅当用户将请求限定到特定邮箱时才设置此参数。仅影响电子邮件结果。 |
tags |
TagFilter[] | 否 | 将结果限制为带有给定标签的项目——默认匹配其中任意一个，设置 tagsMatch="all" 时则匹配每一个。每个条目通过其标签（label）来命名一个标签，与用户自己的标签进行不区分大小写的匹配；仅当用户区分个人标签和团队标签时才设置 scope（"personal" 或 "team"）。未知标签将失败，并返回可用标签列表——如果不确定存在哪些标签，请先调用 ListTags。只有可打标签的项目（文档、邮件、项目、通话记录、日历事件）才能匹配，因此在标签过滤器生效期间，频道会被丢弃。 |
tagsMatch |
"any" | "all" |
否 | 过滤项目时多个标签过滤器如何组合。 |
本页原文 Markdown：在 AtomGit 查看·内容源自开源项目 macro3/macro