Questa funzionalità è idonea per la Zero Data Retention (ZDR). Quando la tua organizzazione dispone di un accordo ZDR, i dati inviati tramite questa funzionalità non vengono conservati dopo che la risposta dell'API è stata restituita.
I blocchi di contenuto dei risultati di ricerca abilitano citazioni naturali con una corretta attribuzione della fonte, portando citazioni di qualità pari alla ricerca web nelle tue applicazioni personalizzate. Questa funzionalità è particolarmente potente per le applicazioni "RAG" (Retrieval-Augmented Generation, generazione aumentata dal recupero) in cui hai bisogno che Claude citi le fonti in modo accurato.
La funzionalità dei risultati di ricerca è disponibile sui seguenti modelli:
claude-opus-4-7)claude-opus-4-6)claude-sonnet-5)claude-sonnet-4-6)claude-sonnet-4-5-20250929)claude-opus-4-5-20251101)claude-opus-4-1-20250805)claude-opus-4-20250514)claude-sonnet-4-20250514)claude-haiku-4-5-20251001)claude-3-5-haiku-20241022)I risultati di ricerca possono essere forniti in due modi:
In entrambi i casi, Claude può citare automaticamente le informazioni dai risultati di ricerca con una corretta attribuzione della fonte.
I risultati di ricerca utilizzano la seguente struttura:
{
"type": "search_result",
"source": "https://example.com/article", // Required: Source URL or identifier
"title": "Article Title", // Required: Title of the result
"content": [
// Required: Array of text blocks
{
"type": "text",
"text": "The actual content of the search result..."
}
],
"citations": {
// Optional: Citation configuration
"enabled": true // Enable/disable citations for this result
}
}| Campo | Tipo | Descrizione |
|---|---|---|
type | string | Deve essere "search_result" |
source | string | L'URL o l'identificatore della fonte per il contenuto |
title | string | Un titolo descrittivo per il risultato di ricerca |
content | array | Un array di blocchi di testo contenenti il contenuto effettivo |
| Campo | Tipo | Descrizione |
|---|---|---|
citations | object | Configurazione delle citazioni con campo booleano enabled |
cache_control | object | Impostazioni di controllo della cache (ad es., {"type": "ephemeral"}) |
Ogni elemento nell'array content deve essere un blocco di testo con:
type: Deve essere "text"text: Il contenuto testuale effettivo (stringa non vuota)Il caso d'uso più potente è restituire risultati di ricerca dai tuoi strumenti personalizzati. Questo abilita applicazioni RAG dinamiche in cui gli strumenti recuperano e restituiscono contenuti rilevanti con citazioni automatiche.
from anthropic.types import (
MessageParam,
TextBlockParam,
SearchResultBlockParam,
ToolResultBlockParam,
)
client = Anthropic()
# Definisci uno strumento di ricerca nella knowledge base
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"],
},
}
# Funzione per gestire la chiamata allo strumento
def search_knowledge_base(query):
# La tua logica di ricerca qui
# Restituisce i risultati della ricerca nel formato corretto
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},
),
]
# Crea un messaggio con lo strumento
response = client.messages.create(
model="claude-opus-4-8", # Works with all supported models
max_tokens=1024,
tools=[knowledge_base_tool],
messages=[
MessageParam(role="user", content="How do I configure the timeout settings?")
],
)
# Quando Claude chiama lo strumento, fornisci i risultati della ricerca
if response.content[0].type == "tool_use":
tool_result = search_knowledge_base(response.content[0].input["query"])
# Invia il risultato dello strumento
final_response = client.messages.create(
model="claude-opus-4-8", # Works with all supported models
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, # Search results go here
)
],
),
],
)Puoi anche fornire risultati di ricerca direttamente nei messaggi utente. Questo è utile per:
from anthropic.types import MessageParam, TextBlockParam, SearchResultBlockParam
client = Anthropic()
# Fornisci i risultati di ricerca direttamente nel messaggio dell'utente
response = client.messages.create(
model="claude-opus-4-8",
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)Indipendentemente da come vengono forniti i risultati di ricerca, Claude include automaticamente le citazioni quando utilizza informazioni da essi:
{
"role": "assistant",
"content": [
{
"type": "text",
"text": "All API requests must include an API key in the Authorization header. Keys can be generated from the dashboard.",
"citations": [
{
"type": "search_result_location",
"cited_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.",
"source": "https://docs.company.com/api-reference",
"title": "API Reference - Authentication",
"search_result_index": 0,
"start_block_index": 0,
"end_block_index": 1
}
]
},
{
"type": "text",
"text": "\n\nTo set this up from scratch, you'll need to "
},
{
"type": "text",
"text": "sign up for an account, generate an API key from the dashboard, install the SDK using `pip install company-sdk`, and initialize the client with your API key.",
"citations": [
{
"type": "search_result_location",
"cited_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.",
"source": "https://docs.company.com/quickstart",
"title": "Getting Started Guide",
"search_result_index": 1,
"start_block_index": 0,
"end_block_index": 1
}
]
}
]
}Ogni citazione include:
| Campo | Tipo | Descrizione |
|---|---|---|
type | string | Sempre "search_result_location" per le citazioni dei risultati di ricerca |
source | string | La fonte dal risultato di ricerca originale |
title | string o null | Il titolo dal risultato di ricerca originale |
cited_text | string | Il testo completo dei blocchi citati, concatenato. Equivale al contenuto di content[start_block_index:end_block_index] unito insieme. Non conteggiato nei token di output. |
search_result_index | integer | Indice a base 0 del risultato di ricerca citato tra tutti i blocchi search_result nella richiesta, nell'ordine in cui appaiono (attraverso tutti i messaggi e i risultati degli strumenti). |
start_block_index | integer | Indice a base 0 del primo blocco citato nell'array content del risultato di ricerca. |
end_block_index | integer | Indice finale esclusivo dell'intervallo di blocchi citati nell'array content del risultato di ricerca. Sempre maggiore di start_block_index. |
Gli indici dei blocchi identificano una porzione dell'array content del risultato di ricerca, e cited_text è il testo completo di quella porzione. Il blocco di testo è l'unità minima citabile: Claude cita blocchi interi, non sottostringhe all'interno di un blocco. Per ottenere citazioni più granulari, suddividi il contenuto del tuo risultato di ricerca in blocchi più piccoli (vedi Blocchi di contenuto multipli).
I risultati di ricerca possono contenere più blocchi di testo nell'array 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."
}
]
}Una citazione che fa riferimento al blocco dei limiti di velocità appare così:
{
"type": "search_result_location",
"cited_text": "Rate Limits: The API allows 1000 requests per hour per key.",
"source": "https://docs.company.com/api-guide",
"title": "API Documentation",
"search_result_index": 0,
"start_block_index": 1,
"end_block_index": 2
}Quando questo risultato di ricerca viene citato, start_block_index e end_block_index identificano quali di questi blocchi sono coperti dalla citazione, e cited_text contiene esattamente il testo di quei blocchi. Suddividere il contenuto in blocchi più piccoli e mirati offre a Claude confini di citazione più precisi; combinare il contenuto in un unico blocco significa che ogni citazione restituisce il testo completo. Questo è lo stesso modello utilizzato dai documenti con contenuto personalizzato nella funzionalità Citazioni.
Puoi utilizzare sia i risultati di ricerca basati su strumenti che quelli di primo livello nella stessa conversazione:
from anthropic.types import MessageParam, SearchResultBlockParam, TextBlockParam
# Primo messaggio con risultati di ricerca di primo livello
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 potrebbe rispondere e chiamare uno strumento per cercare i prezzi
# Poi fornisci i risultati dello strumento con altri risultati di ricercaEntrambi i metodi supportano la combinazione di risultati di ricerca con altri contenuti:
from anthropic.types import SearchResultBlockParam, TextBlockParam
# Nei risultati degli strumenti
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."
),
]
# Nel contenuto di primo livello
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?"
),
]Aggiungi il controllo della cache per prestazioni migliori:
{
"type": "search_result",
"source": "https://docs.company.com/guide",
"title": "User Guide",
"content": [{ "type": "text", "text": "..." }],
"cache_control": {
"type": "ephemeral"
}
}Per impostazione predefinita, le citazioni sono disabilitate per i risultati di ricerca. Puoi abilitare le citazioni impostando esplicitamente la configurazione citations:
{
"type": "search_result",
"source": "https://docs.company.com/guide",
"title": "User Guide",
"content": [{ "type": "text", "text": "Important documentation..." }],
"citations": {
"enabled": true // Enable citations for this result
}
}Quando citations.enabled è impostato su true, Claude include riferimenti di citazione quando utilizza informazioni dal risultato di ricerca. Questo abilita:
Le citazioni sono tutto o niente: tutti i risultati di ricerca in una richiesta devono avere le citazioni abilitate, oppure tutti devono averle disabilitate. Mescolare risultati di ricerca con impostazioni di citazione diverse genera un errore.
Struttura i risultati in modo efficace:
Mantieni la coerenza:
Gestisci gli errori con eleganza:
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 deve contenere almeno un blocco di testoScopri come funzionano le citazioni tra documenti, contenuti personalizzati e risultati di ricerca.
Consenti a Claude di cercare sul web e citare le fonti automaticamente utilizzando uno strumento server.
Consulta la documentazione completa dell'API Messages, inclusi i tipi di blocchi di contenuto.
Memorizza nella cache i risultati di ricerca con cache_control per ridurre costi e latenza su richieste ripetute.
Was this page helpful?