This feature requires theTo receive partial results definestream
option to be set totrue
.
onPartialUpdate()
callback that will be called
on every update of the deserializad object.
Instructor is smart about updates, it calculates and compares hashes of the previous
and newly deserialized version of the model, so you won’t get them on every token
received, but only when any property of the object is updated.
get()
call is fully validated, so you can safely work
with it, e.g. save it to the database.
stream
option to true
and calling the stream()
method
instead of get()
. It returns Stream
object, which gives you access to the response streamed from LLM and
processed by Instructor into structured data.
Following methods are available to process the stream:
partials()
: Returns a generator of partial updates from the stream. Only final update is validated, partial updates are only deserialized and transformed.sequence()
: Dedicated to processing Sequence
response models - returns only completed items in the sequence.getLastUpdate()
: Returns the last object received and processed by Instructor.Stream
is final()
. It returns only the final response object. It blocks until the response is fully processed. It is typically used when you only need final result and prefer to use onPartialUpdate()
or onSequenceUpdate()
to process partial updates. It’s an equivalent to calling get()
method (but requires stream
option set to true
).