Skip to main contentSkip to footer
EsempioscriptbeginnerEseguibileresearch-brief

Recupero

Esempio rieseguibile beginner di tipo script che usa openai, pydantic.

Fatti chiave

Livello
beginner
Runtime
Python • API OpenAI
Pattern
Ricerca supportata dal contesto con evidenza esplicita
Interazione
Sandbox live • Script
Aggiornato
14 marzo 2026

Naviga questo esempio

Vista rapida del flusso

Come questo esempio si muove tra input, esecuzione e risultato rivedibile
Recupero -> Retrieve relevant context -> Richiesta utente -> Esecuzione del sistema -> Output verificabile -> Progettare per la delega…

Ingresso

Recupero

Processo

Retrieve relevant context

Esito

Esecuzione del sistema

Perché esiste questa pagina

Questo esempio è mostrato sia come codice sorgente reale che come pattern di interazione orientato al prodotto, così i discenti possono collegare implementazione, UX e dottrina senza lasciare la libreria.

Flusso visivoCodice realeSandbox o walkthroughAccesso MCP
Come dovrebbe essere usato questo esempio nella piattaforma?

Usa prima la sandbox per comprendere il pattern di esperienza, poi ispeziona il sorgente per vedere come il confine del prodotto, il confine del modello e il confine della dottrina sono effettivamente implementati.

UX pattern: Ricerca supportata dal contesto con evidenza esplicita
Progettare per la delega piuttosto che per la manipolazione diretta
Rendere espliciti i passaggi, le approvazioni e i blocchi
Rappresentare il lavoro delegato come un sistema, non solo come una conversazione
Riferimenti sorgente
Voce di libreria
workflows-1-introduction-4-retrieval
Percorso sorgente
content/example-library/sources/workflows/1-introduction/4-retrieval.py
Librerie
openai, pydantic
Requisiti di runtime
OPENAI_API_KEY
Principi correlati
Progettare per la delega piuttosto che per la manipolazione diretta, Rendere espliciti i passaggi, le approvazioni e i blocchi, Rappresentare il lavoro delegato come un sistema, non solo come una conversazione, Ottimizzare per la guida, non solo per l'inizio

4-retrieval.py

python
import json
import os

from openai import OpenAI
from pydantic import BaseModel, Field

client = OpenAI(api_key=os.getenv("OPENAI_API_KEY"))

"""
docs: https://platform.openai.com/docs/guides/function-calling
"""

# --------------------------------------------------------------
# Define the knowledge base retrieval tool
# --------------------------------------------------------------


def search_kb(question: str):
    """
    Load the whole knowledge base from the JSON file.
    (This is a mock function for demonstration purposes, we don't search)
    """
    with open("kb.json", "r") as f:
        return json.load(f)


# --------------------------------------------------------------
# Step 1: Call model with search_kb tool defined
# --------------------------------------------------------------

tools = [
    {
        "type": "function",
        "function": {
            "name": "search_kb",
            "description": "Get the answer to the user's question from the knowledge base.",
            "parameters": {
                "type": "object",
                "properties": {
                    "question": {"type": "string"},
                },
                "required": ["question"],
                "additionalProperties": False,
            },
            "strict": True,
        },
    }
]

system_prompt = "You are a helpful assistant that answers questions from the knowledge base about our e-commerce store."

messages = [
    {"role": "system", "content": system_prompt},
    {"role": "user", "content": "What is the return policy?"},
]

completion = client.chat.completions.create(
    model="gpt-4o",
    messages=messages,
    tools=tools,
)

# --------------------------------------------------------------
# Step 2: Model decides to call function(s)
# --------------------------------------------------------------

completion.model_dump()

# --------------------------------------------------------------
# Step 3: Execute search_kb function
# --------------------------------------------------------------


def call_function(name, args):
    if name == "search_kb":
        return search_kb(**args)


for tool_call in completion.choices[0].message.tool_calls:
    name = tool_call.function.name
    args = json.loads(tool_call.function.arguments)
    messages.append(completion.choices[0].message)

    result = call_function(name, args)
    messages.append(
        {"role": "tool", "tool_call_id": tool_call.id, "content": json.dumps(result)}
    )

# --------------------------------------------------------------
# Step 4: Supply result and call model again
# --------------------------------------------------------------


class KBResponse(BaseModel):
    answer: str = Field(description="The answer to the user's question.")
    source: int = Field(description="The record id of the answer.")


completion_2 = client.beta.chat.completions.parse(
    model="gpt-4o",
    messages=messages,
    tools=tools,
    response_format=KBResponse,
)

# --------------------------------------------------------------
# Step 5: Check model response
# --------------------------------------------------------------

final_response = completion_2.choices[0].message.parsed
final_response.answer
final_response.source

# --------------------------------------------------------------
# Question that doesn't trigger the tool
# --------------------------------------------------------------

messages = [
    {"role": "system", "content": system_prompt},
    {"role": "user", "content": "What is the weather in Tokyo?"},
]

completion_3 = client.beta.chat.completions.parse(
    model="gpt-4o",
    messages=messages,
    tools=tools,
)

completion_3.choices[0].message.content
Cosa dovrebbe ispezionare il discente nel codice?

Cerca il punto esatto in cui lo scope del sistema è delimitato: definizioni di schema, impostazione del prompt, configurazione di runtime e il punto di chiamata che trasforma l'intenzione dell'utente in un'azione concreta del modello o del workflow.

Cerca i contratti di output e la validazione
Cerca la chiamata di esecuzione esatta
Cerca cosa il prodotto potrebbe esporre all'utente
Come si relaziona la sandbox al sorgente?

La sandbox dovrebbe rendere leggibile l'UX: cosa vede l'utente, cosa sta decidendo il sistema e come il risultato diventa revisionabile. Il sorgente mostra poi come quel comportamento è effettivamente implementato.

Inserisci una domanda o scegli una query di esempio.
Esegui la ricerca o il recupero del contesto.
Rivedi il brief finale con le fonti e il contesto usato.
SandboxRicerca supportata dal contesto con evidenza esplicita
Laboratorio di ricerca

Questa sandbox mostra come una richiesta di ricerca o retrieval dovrebbe rendere visibili query, contesto recuperato e risposta finale.

Spiegazione UX

L'utente non dovrebbe vedere solo una risposta finale. Il prodotto deve rendere leggibile che cosa è stato cercato, quale contesto è entrato nella risposta e dove finiscono i confini del sistema.

Spiegazione AI Design

Questi esempi uniscono retrieval, ricerca web o contesto file a un passaggio di sintesi. La superficie migliore espone il piano di ricerca, il contesto utile e il risultato rivedibile.

Guida all'interazione

  1. 1Inserisci una domanda o scegli una query di esempio.
  2. 2Esegui la ricerca o il recupero del contesto.
  3. 3Rivedi il brief finale con le fonti e il contesto usato.

Domanda di ricerca

Piano di ricercaContesto recuperato

Piano

Il piano di ricerca appare qui.

Brief finale

Il brief finale compare qui insieme al contesto usato.

Usato in corsi e percorsi

Questo esempio attualmente è indipendente nella libreria, ma si connette comunque al sistema dei principi e alla famiglia di esempi più ampia.

Principi correlati

Runtime architecture

Usa questo esempio nei tuoi agenti

Questo esempio è disponibile anche tramite il layer agent-ready del blueprint. Usa la pagina Per agenti per recuperare MCP pubblico, export deterministici e setup per Claude o Cursor.

Definisci trigger, contesto e confini prima di aumentare l'autonomia
Rendi espliciti controllo, osservabilita e recovery nel runtime
Scegli i pattern operativi giusti prima di delegare ai workflow