记录检索器跟踪

注意

如果您未以正确格式记录检索器跟踪，不会导致任何错误，数据仍会被记录。但是，这些数据将无法以专门针对检索器步骤的方式进行渲染。

许多 LLM 应用需要从向量数据库、知识图谱或其他类型的索引中查找文档。检索器追踪（Retriever traces）是一种记录检索器所获取文档的方式。 LangSmith 为追踪中的检索步骤提供特殊渲染，以便更轻松地理解和诊断检索问题。为了使检索步骤能够正确渲染，需要执行几个小步骤。

1. 使用 run_type="retriever" 标注检索器步骤。
2. 从检索器步骤返回一个 Python 字典列表或 TypeScript 对象。每个字典应包含以下键：
   • page_content: 文档的文本内容。
   • type: 此值应始终为 \"Document\"。
   • metadata: 一个包含文档元数据的 Python 字典或 TypeScript 对象。该元数据将显示在跟踪中。

以下代码片段展示了如何在 Python 和 TypeScript 中记录检索步骤。

Python

from langsmith import traceable

def _convert_docs(results):
  return [
      {
          "page_content": r,
          "type": "Document",
          "metadata": {"foo": "bar"}
      }
      for r in results
  ]

@traceable(run_type="retriever")
def retrieve_docs(query):
  # Foo retriever returning hardcoded dummy documents.
  # In production, this could be a real vector datatabase or other document index.
  contents = ["Document contents 1", "Document contents 2", "Document contents 3"]
  return _convert_docs(contents)

retrieve_docs("User query")

TypeScript

import { traceable } from "langsmith/traceable";

interface Document {
page_content: string;
type: string;
metadata: { foo: string };
}

function convertDocs(results: string[]): Document[] {
return results.map((r) => ({
  page_content: r,
  type: "Document",
  metadata: { foo: "bar" }
}));
}

const retrieveDocs = traceable(
(query: string): Document[] => {
  // Foo retriever returning hardcoded dummy documents.
  // In production, this could be a real vector database or other document index.
  const contents = ["Document contents 1", "Document contents 2", "Document contents 3"];
  return convertDocs(contents);
},
{ name: "retrieveDocs", run_type: "retriever" } // Configuration for traceable
);

await retrieveDocs("User query");

以下图片展示了检索器步骤在追踪中的渲染方式。每个文档都会显示其内容以及元数据。