Schemi di output per i client

Uno strumento strutturato può anche pubblicare uno schema dell'output: uno JSON Schema che indica ai client esattamente quali campi e tipi aspettarsi.

È una descrizione leggibile dalle macchine del risultato, che elenca il nome e il tipo di ogni campo. I client lo leggono prima di chiamare lo strumento.

Quando restituisce un modello Pydantic, l'SDK ricava automaticamente lo schema dell'output. Le Sue annotazioni di tipo diventano automaticamente il contratto pubblicato.

Lo schema viene incluso nell'elenco dello strumento, alla voce outputSchema. Un client che analizza gli strumenti apprende la struttura senza procedere per tentativi.

Con uno schema noto, un client può convalidare i risultati e creare in anticipo l'interfaccia. Non deve indovinare quali campi compariranno.

Lo schema indica temp_c come numero e condition come stringa. I consumatori si fidano di questi tipi invece di dedurli da un solo esempio.

I campi con valori predefiniti diventano facoltativi nello schema; gli altri sono obbligatori. I client apprendono quali chiavi sono garantite come presenti.

Consideri lo schema dell'output come una promessa. Quando i client iniziano a dipenderne, modificare i nomi o i tipi dei campi può romperli a valle.

I client rigorosi convalidano ogni risultato rispetto allo schema e rifiutano le corrispondenze errate. In questo modo gli errori del server vengono rilevati rapidamente, proprio al confine.

Uno schema dell'output funge anche da documentazione. I nuovi sviluppatori leggono lo schema per comprendere uno strumento senza dover esaminare il codice.

Si assicuri che lo strumento restituisca sempre ciò che dichiara lo schema. Un risultato che si discosta dal proprio schema indebolisce la fiducia che i client ripongono in esso.

Ha visto come uno strumento pubblica uno schema dell'output a partire dal modello. Questo documenta i campi, consente la convalida e costituisce un contratto stabile. ✅