搜索结果内容块通过适当的源归属启用自然引用,为您的自定义应用程序带来网络搜索质量的引用。此功能对于RAG(检索增强生成)应用程序特别强大,在这些应用程序中,您需要Claude准确引用来源。
搜索结果功能在以下模型上可用:
claude-opus-4-5-20251101)claude-opus-4-1-20250805)claude-opus-4-20250514)claude-sonnet-4-5-20250929)claude-sonnet-4-20250514)claude-3-7-sonnet-20250219)claude-haiku-4-5-20251001)claude-3-5-haiku-20241022)搜索结果可以通过两种方式提供:
在这两种情况下,Claude都可以自动引用搜索结果中的信息,并进行适当的源归属。
搜索结果使用以下结构:
{
"type": "search_result",
"source": "https://example.com/article", // 必需:源URL或标识符
"title": "Article Title", // 必需:结果的标题
"content": [ // 必需:文本块数组
{
"type": "text",
"text": "The actual content of the search result..."
}
],
"citations": { // 可选:引用配置
"enabled": true // 启用/禁用此结果的引用
}
}| 字段 | 类型 | 描述 |
|---|---|---|
type | string | 必须为 "search_result" |
source | string | 内容的源URL或标识符 |
title | string | 搜索结果的描述性标题 |
content | array | 包含实际内容的文本块数组 |
| 字段 | 类型 | 描述 |
|---|---|---|
citations | object | 引用配置,包含 enabled 布尔字段 |
cache_control | object | 缓存控制设置(例如,{"type": "ephemeral"}) |
content 数组中的每一项必须是一个文本块,包含:
type:必须为 "text"text:实际文本内容(非空字符串)最强大的用例是从您的自定义工具返回搜索结果。这启用了动态RAG应用程序,其中工具获取并返回相关内容,并自动进行引用。
from anthropic import Anthropic
from anthropic.types import (
MessageParam,
TextBlockParam,
SearchResultBlockParam,
ToolResultBlockParam
)
client = Anthropic()
# 定义知识库搜索工具
knowledge_base_tool = {
"name": "search_knowledge_base",
"description": "Search the company knowledge base for information",
"input_schema": {
"type": "object",
"properties": {
"query": {
"type": "string",
"description": "The search query"
}
},
"required": ["query"]
}
}
# 处理工具调用的函数
def search_knowledge_base(query):
# 您的搜索逻辑在这里
# 返回正确格式的搜索结果
return [
SearchResultBlockParam(
type="search_result",
source="https://docs.company.com/product-guide",
title="Product Configuration Guide",
content=[
TextBlockParam(
type="text",
text="To configure the product, navigate to Settings > Configuration. The default timeout is 30 seconds, but can be adjusted between 10-120 seconds based on your needs."
)
],
citations={"enabled": True}
),
SearchResultBlockParam(
type="search_result",
source="https://docs.company.com/troubleshooting",
title="Troubleshooting Guide",
content=[
TextBlockParam(
type="text",
text="If you encounter timeout errors, first check the configuration settings. Common causes include network latency and incorrect timeout values."
)
],
citations={"enabled": True}
)
]
# 使用工具创建消息
response = client.messages.create(
model="claude-sonnet-4-5", # 适用于所有支持的模型
max_tokens=1024,
tools=[knowledge_base_tool],
messages=[
MessageParam(
role="user",
content="How do I configure the timeout settings?"
)
]
)
# 当Claude调用工具时,提供搜索结果
if response.content[0].type == "tool_use":
tool_result = search_knowledge_base(response.content[0].input["query"])
# 将工具结果发送回去
final_response = client.messages.create(
model="claude-sonnet-4-5", # 适用于所有支持的模型
max_tokens=1024,
messages=[
MessageParam(role="user", content="How do I configure the timeout settings?"),
MessageParam(role="assistant", content=response.content),
MessageParam(
role="user",
content=[
ToolResultBlockParam(
type="tool_result",
tool_use_id=response.content[0].id,
content=tool_result # 搜索结果在这里
)
]
)
]
)您也可以直接在用户消息中提供搜索结果。这对以下情况很有用:
from anthropic import Anthropic
from anthropic.types import (
MessageParam,
TextBlockParam,
SearchResultBlockParam
)
client = Anthropic()
# 直接在用户消息中提供搜索结果
response = client.messages.create(
model="claude-sonnet-4-5",
max_tokens=1024,
messages=[
MessageParam(
role="user",
content=[
SearchResultBlockParam(
type="search_result",
source="https://docs.company.com/api-reference",
title="API Reference - Authentication",
content=[
TextBlockParam(
type="text",
text="All API requests must include an API key in the Authorization header. Keys can be generated from the dashboard. Rate limits: 1000 requests per hour for standard tier, 10000 for premium."
)
],
citations={"enabled": True}
),
SearchResultBlockParam(
type="search_result",
source="https://docs.company.com/quickstart",
title="Getting Started Guide",
content=[
TextBlockParam(
type="text",
text="To get started: 1) Sign up for an account, 2) Generate an API key from the dashboard, 3) Install our SDK using pip install company-sdk, 4) Initialize the client with your API key."
)
],
citations={"enabled": True}
),
TextBlockParam(
type="text",
text="Based on these search results, how do I authenticate API requests and what are the rate limits?"
)
]
)
]
)
print(response.model_dump_json(indent=2))无论如何提供搜索结果,Claude在使用搜索结果中的信息时都会自动包含引用:
{
"role": "assistant",
"content": [
{
"type": "text",
"text": "To authenticate API requests, you need to include an API key in the Authorization header",
"citations": [
{
"type": "search_result_location",
"source": "https://docs.company.com/api-reference",
"title": "API Reference - Authentication",
"cited_text": "All API requests must include an API key in the Authorization header",
"search_result_index": 0,
"start_block_index": 0,
"end_block_index": 0
}
]
},
{
"type": "text",
"text": ". You can generate API keys from your dashboard",
"citations": [
{
"type": "search_result_location",
"source": "https://docs.company.com/api-reference",
"title": "API Reference - Authentication",
"cited_text": "Keys can be generated from the dashboard",
"search_result_index": 0,
"start_block_index": 0,
"end_block_index": 0
}
]
},
{
"type": "text",
"text": ". The rate limits are 1,000 requests per hour for the standard tier and 10,000 requests per hour for the premium tier.",
"citations": [
{
"type": "search_result_location",
"source": "https://docs.company.com/api-reference",
"title": "API Reference - Authentication",
"cited_text": "Rate limits: 1000 requests per hour for standard tier, 10000 for premium",
"search_result_index": 0,
"start_block_index": 0,
"end_block_index": 0
}
]
}
]
}每个引用包含:
| 字段 | 类型 | 描述 |
|---|---|---|
type | string | 对于搜索结果引用,始终为 "search_result_location" |
source | string | 原始搜索结果中的源 |
title | string or null | 原始搜索结果中的标题 |
cited_text | string | 被引用的确切文本 |
search_result_index | integer | 搜索结果的索引(从0开始) |
start_block_index | integer | 内容数组中的起始位置 |
end_block_index | integer | 内容数组中的结束位置 |
注意:search_result_index 指的是搜索结果内容块的索引(从0开始),无论搜索结果如何提供(工具调用或顶级内容)。
搜索结果可以在 content 数组中包含多个文本块:
{
"type": "search_result",
"source": "https://docs.company.com/api-guide",
"title": "API Documentation",
"content": [
{
"type": "text",
"text": "Authentication: All API requests require an API key."
},
{
"type": "text",
"text": "Rate Limits: The API allows 1000 requests per hour per key."
},
{
"type": "text",
"text": "Error Handling: The API returns standard HTTP status codes."
}
]
}Claude可以使用 start_block_index 和 end_block_index 字段引用特定块。
您可以在同一对话中同时使用基于工具的搜索结果和顶级搜索结果:
# 第一条消息,包含顶级搜索结果
messages = [
MessageParam(
role="user",
content=[
SearchResultBlockParam(
type="search_result",
source="https://docs.company.com/overview",
title="Product Overview",
content=[
TextBlockParam(type="text", text="Our product helps teams collaborate...")
],
citations={"enabled": True}
),
TextBlockParam(
type="text",
text="Tell me about this product and search for pricing information"
)
]
)
]
# Claude可能会响应并调用工具来搜索定价信息
# 然后您提供包含更多搜索结果的工具结果两种方法都支持将搜索结果与其他内容混合:
# 在工具结果中
tool_result = [
SearchResultBlockParam(
type="search_result",
source="https://docs.company.com/guide",
title="User Guide",
content=[TextBlockParam(type="text", text="Configuration details...")],
citations={"enabled": True}
),
TextBlockParam(
type="text",
text="Additional context: This applies to version 2.0 and later."
)
]
# 在顶级内容中
user_content = [
SearchResultBlockParam(
type="search_result",
source="https://research.com/paper",
title="Research Paper",
content=[TextBlockParam(type="text", text="Key findings...")],
citations={"enabled": True}
),
{
"type": "image",
"source": {"type": "url", "url": "https://example.com/chart.png"}
},
TextBlockParam(
type="text",
text="How does the chart relate to the research findings?"
)
]添加缓存控制以获得更好的性能:
{
"type": "search_result",
"source": "https://docs.company.com/guide",
"title": "User Guide",
"content": [{"type": "text", "text": "..."}],
"cache_control": {
"type": "ephemeral"
}
}默认情况下,搜索结果的引用被禁用。您可以通过显式设置 citations 配置来启用引用:
{
"type": "search_result",
"source": "https://docs.company.com/guide",
"title": "User Guide",
"content": [{"type": "text", "text": "Important documentation..."}],
"citations": {
"enabled": true // 为此结果启用引用
}
}当 citations.enabled 设置为 true 时,Claude在使用搜索结果中的信息时会包含引用参考。这启用了:
如果省略 citations 字段,默认情况下引用被禁用。
引用是全有或全无的:请求中的所有搜索结果要么都必须启用引用,要么都必须禁用引用。混合具有不同引用设置的搜索结果将导致错误。如果您需要为某些源禁用引用,必须为该请求中的所有搜索结果禁用引用。
有效地构建结果
保持一致性
优雅地处理错误
def search_with_fallback(query):
try:
results = perform_search(query)
if not results:
return {"type": "text", "text": "No results found."}
return format_as_search_results(results)
except Exception as e:
return {"type": "text", "text": f"Search error: {str(e)}"}content 数组必须至少包含一个文本块