gen_ai_hub.orchestration_v2.models.streaming module

Streaming options for content generation.

class gen_ai_hub.orchestration_v2.models.streaming.GlobalStreamOptions(*, enabled: bool | None = False, chunk_size: int | None = 100, delimiters: List[str] | None = None)

Bases: ABCBaseModel

Represents options for streaming content generation. :param enabled: If true, the response will be streamed back to the client. :type enabled: bool, optional :param chunk_size: Minimum number of characters per chunk that post-LLM modules operate on. :type chunk_size: int, optional :param delimiters: List of delimiters to split the input text into chunks.Please note, :type delimiters: list(str), optional :param this is a required parameter when input_translation_module_config or: :param output_translation_module_config are configured.:

enabled: bool | None

chunk_size: int | None

delimiters: List[str] | None

model_dump(**kwargs)

Override model_dump to exclude chunk_size and delimiters when enabled is False.

model_config: ClassVar[ConfigDict] = {'extra': 'forbid', 'frozen': False}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].