sug_v2_with_eval_requery_yx.py 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383
  1. import asyncio
  2. import json
  3. import os
  4. import argparse
  5. from datetime import datetime
  6. from agents import Agent, Runner, function_tool
  7. from lib.my_trace import set_trace
  8. from typing import Literal
  9. from dataclasses import dataclass
  10. from pydantic import BaseModel, Field
  11. from lib.utils import read_file_as_string
  12. from script.search_recommendations.xiaohongshu_search_recommendations import XiaohongshuSearchRecommendations
  13. from agents import Agent, RunContextWrapper, Runner, function_tool
  14. from pydantic import BaseModel, Field
  15. class RunContext(BaseModel):
  16. version: str = Field(..., description="当前运行的脚本版本(文件名)")
  17. input_files: dict[str, str] = Field(..., description="输入文件路径映射,如 {'context_file': '...', 'q_file': '...'}")
  18. q_with_context: str
  19. q_context: str
  20. q: str
  21. log_url: str
  22. log_dir: str
  23. # 中间数据记录 - 按时间顺序记录所有操作
  24. operations_history: list[dict] = Field(default_factory=list, description="记录所有操作的历史,包括 get_query_suggestions 和 modify_query")
  25. # 最终输出结果
  26. final_output: str | None = Field(default=None, description="Agent的最终输出结果")
  27. eval_insrtuctions = """
  28. # 角色定义
  29. 你是一个 **专业的语言专家和语义相关性评判专家**。
  30. 你的任务是:判断我给你的平台sug词条,其与 <原始 query 问题> 和 <需求上下文> **共同形成的综合意图** 的相关度满足度百分比。
  31. ---
  32. # 输入信息
  33. 你将接收到以下输入:
  34. 1. <需求上下文>:文档的解构结果或语义说明,用于理解 query 所针对的核心任务与场景。
  35. 2. <原始 query 问题>:用户的初始查询问题。
  36. 3. <平台sug词条>:模型或算法推荐的 平台sug词条,其中包含待评估的词条。
  37. ---
  38. # 工作流程
  39. ## 第一步:理解综合意图
  40. - 仔细阅读 <需求上下文> 与 <原始 query 问题>;
  41. - 明确 <原始 query 问题> 的核心意图、主题焦点和任务目标;
  42. - 提炼 <需求上下文> 所描述的核心任务、场景、概念和语义范围;
  43. - **将 <原始 query 问题> 和 <需求上下文> 融合成一个单一的、完整的“综合意图”**,作为后续评估的唯一基准。这个综合意图代表了用户在特定场景下最核心、最全面的需求。
  44. ## 第二步:逐一评估 Sug 词条的综合相关度满足度
  45. 对于 我给你的sug词条:
  46. 1. **评估其与“综合意图”的相关度满足度:**
  47. - 将当前 sug 词条的语义与第一步中确定的“综合意图”(<原始 query 问题> 和 <需求上下文> 的结合体)进行比较。
  48. - 全面评估该 sug 词条在主题、目标动作、语义范围、场景匹配、核心概念覆盖等各方面与“综合意图”的匹配和满足程度。
  49. - 给出 0-1 之间的浮点数,代表其“相关度满足度”。数值比越高,表示该 sug 词条越能充分且精准地满足“综合意图”。
  50. **评估标准一致性要求:在评估 sug 词条时,请务必保持你对“相关度满足度”的判断标准和百分比给定的逻辑完全一致和稳定。**
  51. **相关性依据要求:** 简短叙述相关性依据,说明主要匹配点或差异点,以及该 sug 词条如何满足或未能完全满足“综合意图”的哪些方面。
  52. """
  53. @dataclass
  54. class EvaluationFeedback:
  55. reason: str=Field(..., description="简明扼要的理由")
  56. score: float=Field(..., description="评估结果,1表示等价,0表示不等价,中间值表示部分等价")
  57. evaluator = Agent[None](
  58. name="评估专家",
  59. instructions=eval_insrtuctions,
  60. output_type=EvaluationFeedback,
  61. )
  62. @function_tool
  63. async def get_query_suggestions(wrapper: RunContextWrapper[RunContext], query: str):
  64. """Fetch search recommendations from Xiaohongshu."""
  65. xiaohongshu_api = XiaohongshuSearchRecommendations()
  66. query_suggestions = xiaohongshu_api.get_recommendations(keyword=query)
  67. print(query_suggestions)
  68. async def evaluate_single_query(q_sug: str, q_with_context: str):
  69. """Evaluate a single query suggestion."""
  70. eval_input = f"""
  71. {q_with_context}
  72. <待评估的推荐query>
  73. {q_sug}
  74. </待评估的推荐query>
  75. """
  76. evaluator_result = await Runner.run(evaluator, eval_input)
  77. result: EvaluationFeedback = evaluator_result.final_output
  78. return {
  79. "query": q_sug,
  80. "score": result.score,
  81. "reason": result.reason,
  82. }
  83. # 并发执行所有评估任务
  84. q_with_context = wrapper.context.q_with_context
  85. res = []
  86. if query_suggestions:
  87. res = await asyncio.gather(*[evaluate_single_query(q_sug, q_with_context) for q_sug in query_suggestions])
  88. else:
  89. res = '未返回任何推荐词'
  90. # 记录到 RunContext
  91. wrapper.context.operations_history.append({
  92. "operation_type": "get_query_suggestions",
  93. "timestamp": datetime.now().isoformat(),
  94. "query": query,
  95. "suggestions": query_suggestions,
  96. "evaluations": res,
  97. })
  98. return res
  99. @function_tool
  100. def modify_query(wrapper: RunContextWrapper[RunContext], original_query: str, operation_type: str, new_query: str, reason: str):
  101. """
  102. Modify the search query with a specific operation.
  103. Args:
  104. original_query: The original query before modification
  105. operation_type: Type of modification - must be one of:
  106. - "增加": 增加query语句,添加具体化的关键词
  107. - "删减": 删减query词,去除冗余词汇
  108. - "调序": 调整query词的顺序,更符合用户习惯的词序
  109. - "替换": 替换query中的某个词,使用同义词或专业术语
  110. new_query: The modified query after applying the operation
  111. reason: Detailed explanation of why this modification was made and what insight from previous suggestions led to this change.
  112. Must reference specific data from get_query_suggestions results (e.g., scores, reasons, word patterns).
  113. Returns:
  114. A dict containing the modification record and the new query to use for next search
  115. """
  116. operation_types = ["增加", "删减", "调序", "替换"]
  117. if operation_type not in operation_types:
  118. return {
  119. "status": "error",
  120. "message": f"Invalid operation_type. Must be one of: {', '.join(operation_types)}"
  121. }
  122. modification_record = {
  123. "original_query": original_query,
  124. "operation_type": operation_type,
  125. "new_query": new_query,
  126. "reason": reason,
  127. }
  128. # 记录到 RunContext
  129. wrapper.context.operations_history.append({
  130. "operation_type": "modify_query",
  131. "timestamp": datetime.now().isoformat(),
  132. "modification_type": operation_type,
  133. "original_query": original_query,
  134. "new_query": new_query,
  135. "reason": reason,
  136. })
  137. return {
  138. "status": "success",
  139. "modification_record": modification_record,
  140. "new_query": new_query,
  141. "message": f"Query modified successfully. Use '{new_query}' for the next search."
  142. }
  143. insrtuctions = """
  144. 你是一个专业的搜索query优化专家,擅长通过动态探索找到最符合用户搜索习惯的query。
  145. ## 核心任务
  146. 给定原始问题,通过迭代调用搜索推荐接口(get_query_suggestions),找到与原始问题语义等价且更符合平台用户搜索习惯的推荐query。
  147. ## 重要说明
  148. - **你不需要自己评估query的等价性**
  149. - get_query_suggestions 函数内部已集成评估子agent,会自动对每个推荐词进行评估
  150. - 返回结果包含:query(推荐词)、score(评分,1表示等价,0表示不等价)、reason(评估理由)
  151. - **你的职责是分析评估结果,做出决策和策略调整**
  152. ## 防止幻觉 - 关键原则
  153. - **严禁编造数据**:只能基于 get_query_suggestions 实际返回的结果进行分析
  154. - **空结果处理**:如果返回的列表为空([]),必须明确说明"未返回任何推荐词"
  155. - **不要猜测**:在 modify_query 的 reason 中,不能引用不存在的推荐词或评分
  156. - **如实记录**:每次分析都要如实反映实际返回的数据
  157. ## 工作流程
  158. ### 1. 理解原始问题
  159. - 仔细阅读<需求上下文>和<当前问题>
  160. - 提取问题的核心需求和关键概念
  161. - 明确问题的本质意图(what)、应用场景(where)、实现方式(how)
  162. ### 2. 动态探索策略
  163. **第一轮尝试:**
  164. - 使用原始问题直接调用 get_query_suggestions(query="原始问题")
  165. - **检查返回结果**:
  166. - 如果返回空列表 []:说明"该query未返回任何推荐词",需要简化或替换query
  167. - 如果有推荐词:查看每个推荐词的 score 和 reason
  168. - **做出判断**:是否有 score >= 0.8 的高分推荐词?
  169. **后续迭代:**
  170. 如果没有高分推荐词(或返回空列表),必须先调用 modify_query 记录修改,然后再次搜索:
  171. **工具使用流程:**
  172. 1. **分析评估反馈**(必须基于实际返回的数据):
  173. - **情况A - 返回空列表**:
  174. * 在 reason 中说明:"第X轮未返回任何推荐词,可能是query过于复杂或生僻"
  175. * 不能编造任何推荐词或评分
  176. - **情况B - 有推荐词但无高分**:
  177. * 哪些推荐词得分较高?具体是多少分?评估理由是什么?
  178. * 哪些推荐词偏离了原问题?如何偏离的?
  179. * 推荐词整体趋势是什么?(过于泛化/具体化/领域偏移等)
  180. 2. **决策修改策略**:基于实际评估反馈,调用 modify_query(original_query, operation_type, new_query, reason)
  181. - reason 必须引用具体的数据,不能编造
  182. 3. 使用返回的 new_query 调用 get_query_suggestions
  183. 4. 分析新的评估结果,如果仍不满足,重复步骤1-3
  184. **四种操作类型(operation_type)及其详细判定标准:**
  185. **策略1:增加**
  186. - **判定标准**:
  187. * 有效sug列表中,sug_i 的语义比 Query 更具体,且词汇数量 > query 的词汇数量
  188. * sug list 中的每个词是 Query 的更具体或细化版本,是能将 Query 具体化描述的关键新词
  189. * sug_i 必须包含 Query 的大部分或所有核心关键词,且词汇数量都明显多于query
  190. * sug_j 中存在 query 中不存在的关键新词集合(例如:特定平台名称、特定功能词)
  191. - **使用时机**:当推荐词整体趋势是添加更具体的限定词或场景描述时
  192. **策略2:删减**
  193. - **判定标准**(满足以下任一条件即可):
  194. * 有效sug列表中,大部分 sug 的词汇数量都明显少于 query
  195. * 当sug列表为空时
  196. * sug 词汇数量明显少于 query,且与 Query 的核心搜索意图一致
  197. * 基于评估反馈,识别 query 中 1-2 个词为"非核心冗余词",且删除后不影响核心搜索意图
  198. - **使用时机**:当原query过于冗长复杂,推荐词都倾向于使用更简洁的表达时
  199. **策略3:调序**
  200. - **判定标准**:
  201. * 有效sug list中,存在多个 sug_i 与 query 拥有完全相同的核心关键词集合,只是词汇排列顺序不同
  202. * sug_i 与 query 的词序不同,但 sug_i 的词序变化与 query 的核心语义一致
  203. * sug_i 的词序更自然或更符合搜索习惯,且 sug_i 的词序频率高于 query 词的词序
  204. * 多个 Sug_List 中的 sug_i 都倾向于使用与 Query 不同但意思一致的词序
  205. - **使用时机**:当推荐词与原query关键词相同但顺序不同,且新顺序更符合用户习惯时
  206. **策略4:替换**
  207. - **判定标准**:
  208. * 存在 sug_i(来自有效suglist),其与 query 之间仅有 1-2 个核心词不同,但其他词均相同
  209. * sug_i 作为整体查询词,其语义与 query 等价或更优
  210. * sug_i 与 Query 在大部分词汇上重叠,但在 1-2 个关键位置使用了不同的词
  211. * 这些不同的词在语义上是同义、近义或在相关领域中更流行/专业的替代词
  212. * 差异词中的新词在 Platform Sug List 中出现频率更高,或被标记为更专业的术语
  213. - **使用时机**:当推荐词显示某个词的同义词或专业术语更受欢迎时
  214. **每次修改的reason必须包含:**
  215. - 上一轮评估结果的关键发现(引用具体的score和reason)
  216. - 基于评估反馈,为什么这样修改
  217. - 预期这次修改会带来什么改进
  218. ### 3. 决策标准
  219. - **score >= 0.8**:认为该推荐词与原问题等价,可以作为最终结果
  220. - **0.5 <= score < 0.8**:部分等价,分析reason看是否可接受
  221. - **score < 0.5**:不等价,需要继续优化
  222. ### 4. 迭代终止条件
  223. - **成功终止**:找到至少一个 score >= 0.8 的推荐query
  224. - **尝试上限**:最多迭代5轮,避免无限循环
  225. - **无推荐词**:推荐接口返回空列表或错误
  226. ### 5. 输出要求
  227. **成功找到等价query时,输出格式:**
  228. ```
  229. 原始问题:[原问题]
  230. 优化后的query:[最终找到的等价推荐query]
  231. 评分:[score]
  232. ```
  233. **未找到等价query时,输出格式:**
  234. ```
  235. 原始问题:[原问题]
  236. 结果:未找到完全等价的推荐query
  237. 建议:[简要建议,如:直接使用原问题搜索 或 使用最接近的推荐词]
  238. ```
  239. ## 注意事项
  240. - **第一轮必须使用原始问题**:直接调用 get_query_suggestions(query="原始问题")
  241. - **后续修改必须调用 modify_query**:不能直接用新query调用 get_query_suggestions
  242. - **重点关注评估结果**:每次都要仔细分析返回的 score 和 reason
  243. - **基于数据决策**:修改策略必须基于评估反馈,不能凭空猜测
  244. - **引用具体评分**:在分析和决策时,引用具体的score数值和reason内容
  245. - **优先选择高分推荐词**:score >= 0.8 即可认为等价
  246. - **严禁编造数据**:
  247. * 如果返回空列表,必须在 reason 中明确说明"未返回任何推荐词"
  248. * 不能引用不存在的推荐词、评分或评估理由
  249. * 每次 modify_query 的 reason 必须基于上一轮实际返回的结果
  250. """.strip()
  251. async def main(input_dir: str):
  252. current_time, log_url = set_trace()
  253. # 从目录中读取固定文件名
  254. input_context_file = os.path.join(input_dir, 'context.md')
  255. input_q_file = os.path.join(input_dir, 'q.md')
  256. q_context = read_file_as_string(input_context_file)
  257. q = read_file_as_string(input_q_file)
  258. q_with_context = f"""
  259. <需求上下文>
  260. {q_context}
  261. </需求上下文>
  262. <当前问题>
  263. {q}
  264. </当前问题>
  265. """.strip()
  266. # 获取当前文件名作为版本
  267. version = os.path.basename(__file__)
  268. version_name = os.path.splitext(version)[0] # 去掉 .py 后缀
  269. # 日志保存到输入目录的 output/版本/时间戳 目录下
  270. log_dir = os.path.join(input_dir, "output", version_name, current_time)
  271. run_context = RunContext(
  272. version=version,
  273. input_files={
  274. "input_dir": input_dir,
  275. "context_file": input_context_file,
  276. "q_file": input_q_file,
  277. },
  278. q_with_context=q_with_context,
  279. q_context=q_context,
  280. q=q,
  281. log_dir=log_dir,
  282. log_url=log_url,
  283. )
  284. agent = Agent[RunContext](
  285. name="Query Optimization Agent",
  286. instructions=insrtuctions,
  287. tools=[get_query_suggestions, modify_query],
  288. )
  289. result = await Runner.run(agent, input=q_with_context, context = run_context,)
  290. print(result.final_output)
  291. # 保存最终输出到 RunContext
  292. run_context.final_output = str(result.final_output)
  293. # 保存 RunContext 到 log_dir
  294. os.makedirs(run_context.log_dir, exist_ok=True)
  295. context_file_path = os.path.join(run_context.log_dir, "run_context.json")
  296. with open(context_file_path, "w", encoding="utf-8") as f:
  297. json.dump(run_context.model_dump(), f, ensure_ascii=False, indent=2)
  298. print(f"\nRunContext saved to: {context_file_path}")
  299. if __name__ == "__main__":
  300. parser = argparse.ArgumentParser(description="搜索query优化工具")
  301. parser.add_argument(
  302. "--input-dir",
  303. type=str,
  304. default="input/简单扣图",
  305. help="输入目录路径,默认: input/简单扣图"
  306. )
  307. args = parser.parse_args()
  308. asyncio.run(main(args.input_dir))