ContentSearch¶
按内容搜索条目:文档正文;电子邮件的主题/正文/发件人/收件人/抄送/密送,以及这些地址上的显示名称;agent 会话消息;通话记录。这是关键词搜索,不是语义搜索:查询只会匹配索引内容中出现的字面单词/词元、前缀或精确引用的短语。请将此工具用于定向的关键词/内容查找,不要用于“今天发生了什么”“现在怎么样”“给我补上进度”或“今天站会上发生了什么”这类活动摘要问题;这些问题应使用带时间/类型/频道筛选器的 ListEntities 开始。以空白分隔的词项之间是 AND 关系。对于文档和电子邮件,每个词项都必须匹配到文档中的某处——不同的词项可以出现在不同的块/页或不同字段中。具体来说,对于文档和电子邮件,每个单词词项按前缀匹配(因此 scri 可以匹配 script);对于电子邮件,前缀扩展还会对地址字段的本地部分(local-part)生效。对于 agent 会话、频道和通话记录,整个查询按单个相邻短语前缀进行匹配——因此请传入 1-3 个会字面出现在内容中的定向关键词,而不是用户的自然语言描述;长短语不会匹配。匹配默认使用前缀;将 matchType 设为 'exact' 可以匹配完整词元/短语,而不进行前缀扩展(例如精确的单词、标识符或完整电子邮件地址)。把多词短语放在双引号中,使其作为一个相邻短语保持在一起。如果用户的请求把一个人和一个话题组合在一起,请分别运行搜索,而不是合并为一个查询。默认将 entityTypes 留空;仅当用户明确限定到某一类型时才进行过滤。文档、电子邮件、项目和通话记录的结果会包含用户可见的标签,以 {label, scope} 对的形式呈现;要将搜索限制为带标签的条目,请在 tags 参数中传入这些标签的 label(ListTags 会显示存在哪些标签)。
参数¶
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
query |
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']。项目和日历事件没有可索引的内容,因此在这里永远不会匹配——请改用 NameSearch 按名称搜索它们。 |
agentSessionIds |
string[] | 否 | 仅按 id 搜索这些 agent 会话的转录内容,不搜索其他内容。将它与你的会话 id 一起使用,可以找到你之前对话中某句话的确切措辞,包括为了保持在你的上下文范围内而被摘要的部分。省略此项以搜索所有类型。 |
inbox |
string | 否 | 将电子邮件结果限制为单个已连接的收件箱,以该收件箱的电子邮件地址形式给出(来自 ListInboxes)。省略此项以搜索用户可访问的所有收件箱。仅当用户将请求限定到特定邮箱时才设置。仅影响电子邮件结果。 |
tags |
TagFilter[] | 否 | 将结果限制为带有给定标签的条目——默认匹配其中任意一个,设置 tagsMatch="all" 时需匹配所有。每个条目通过其 label 指定一个标签,并与用户自己的标签进行不区分大小写的匹配;仅当用户区分其个人标签和团队标签时才设置 scope("personal" 或 "team")。未知的 label 会失败并附带可用标签列表——如果不确定存在哪些标签,请先调用 ListTags。只有可打标签的条目(文档、电子邮件、项目、通话记录)才能匹配,因此在启用标签筛选时会丢弃频道。 |
tagsMatch |
"any" | "all" |
否 | 筛选条目时多个标签筛选条件如何组合。 |
本页原文 Markdown:在 AtomGit 查看·内容源自开源项目 macro3/macro