with_query()

向 LexicalHighlighter 配置添加查询词定义，用于高亮由过滤表达式（例如 TEXT_MATCH）匹配的文本。这会为 highlight_query 增加一个条目，用于说明要高亮的字段和词项，以及生成这些词项的过滤类型。高亮作为后处理运行，不会影响检索、过滤、排序或评分。

请求语法

python

with_query(
    field: str,
    text: str,
    query_type: str
)

参数：

• field (str) -
  目标文本字段名称。当过滤表达式找到匹配项时，会对该字段中的内容进行标注。该字段必须对应 Collection Schema 中的 VARCHAR 文本字段。

• text (str) -
  从过滤表达式中提取并高亮的词项或短语。例如，"my doc" 将在指定字段中高亮 "my" 和 "doc" 的匹配项。

• query_type (str) -
  提供要高亮词项的过滤类型。对于基于文本的过滤，请使用 "TextMatch"，以对应 TEXT_MATCH 条件。

返回：

无

示例

python

from pymilvus import LexicalHighlighter

highlighter = LexicalHighlighter(
    pre_tags=["{"],
    post_tags=["}"],
)

highlighter.with_query(field="text", text="my doc", query_type="TextMatch")

results = client.search(
    collection_name="your_collection",
    data=["test"],
    anns_field="sparse_vector",
    limit=10,
    search_params={"metric_type": "BM25", "params": {"drop_ratio_search": 0.0}},
    output_fields=["text"],
    highlighter=highlighter,
)