openvino_genai.TextStreamer#

class openvino_genai.TextStreamer#

Bases: StreamerBase

TextStreamer is used to decode tokens into text and call a user-defined callback function.

tokenizer: Tokenizer object to decode tokens into text. callback: User-defined callback function to process the decoded text, callback should return either boolean flag or StreamingStatus.

__init__(self: openvino_genai.py_openvino_genai.TextStreamer, tokenizer: openvino_genai.py_openvino_genai.Tokenizer, callback: Callable[[str], bool | openvino_genai.py_openvino_genai.StreamingStatus]) → None#

Methods

__delattr__(name, /)	Implement delattr(self, name).
__dir__()	Default dir() implementation.
__eq__(value, /)	Return self==value.
__format__(format_spec, /)	Default object formatter.
__ge__(value, /)	Return self>=value.
__getattribute__(name, /)	Return getattr(self, name).
__gt__(value, /)	Return self>value.
__hash__()	Return hash(self).
__init__(self, tokenizer, callback)
__init_subclass__	This method is called when a class is subclassed.
__le__(value, /)	Return self<=value.
__lt__(value, /)	Return self<value.
__ne__(value, /)	Return self!=value.
__new__(**kwargs)
__reduce__()	Helper for pickle.
__reduce_ex__(protocol, /)	Helper for pickle.
__repr__()	Return repr(self).
__setattr__(name, value, /)	Implement setattr(self, name, value).
__sizeof__()	Size of object in memory, in bytes.
__str__()	Return str(self).
__subclasshook__	Abstract classes can override this to customize issubclass().
end(self)
put(self, token)	Put is called every time new token is decoded.
write(self, token)

__class__#

alias of pybind11_type

__delattr__(name, /)#

Implement delattr(self, name).

__dir__()#

Default dir() implementation.

__eq__(value, /)#

Return self==value.

__format__(format_spec, /)#

Default object formatter.

__ge__(value, /)#

Return self>=value.

__getattribute__(name, /)#

Return getattr(self, name).

__gt__(value, /)#

Return self>value.

__hash__()#

Return hash(self).

__init__(self: openvino_genai.py_openvino_genai.TextStreamer, tokenizer: openvino_genai.py_openvino_genai.Tokenizer, callback: Callable[[str], bool | openvino_genai.py_openvino_genai.StreamingStatus]) → None#

__init_subclass__()#

This method is called when a class is subclassed.

The default implementation does nothing. It may be overridden to extend subclasses.

__le__(value, /)#

Return self<=value.

__lt__(value, /)#

Return self<value.

__ne__(value, /)#

Return self!=value.

__new__(**kwargs)#

__reduce__()#

Helper for pickle.

__reduce_ex__(protocol, /)#

Helper for pickle.

__repr__()#

Return repr(self).

__setattr__(name, value, /)#

Implement setattr(self, name, value).

__sizeof__()#

Size of object in memory, in bytes.

__str__()#

Return str(self).

__subclasshook__()#

Abstract classes can override this to customize issubclass().

This is invoked early on by abc.ABCMeta.__subclasscheck__(). It should return True, False or NotImplemented. If it returns NotImplemented, the normal algorithm is used. Otherwise, it overrides the normal algorithm (and the outcome is cached).

end(self: openvino_genai.py_openvino_genai.TextStreamer) → None#

put(self: openvino_genai.py_openvino_genai.StreamerBase, token: int) → bool#

Put is called every time new token is decoded. Returns a bool flag to indicate whether generation should be stopped, if return true generation stops

write(self: openvino_genai.py_openvino_genai.TextStreamer, token: int | list[int]) → openvino_genai.py_openvino_genai.StreamingStatus#