StreamingConfigurations¶
Structure Class¶
StreamingConfigurations
dataclass
¶
Configurations for streaming.
Attributes¶
apply_guardrail_interval
class-attribute
instance-attribute
¶
apply_guardrail_interval: int | None = None
The guardrail interval to apply as response is generated. By default,
the guardrail interval is set to 50 characters. If a larger interval is
specified, the response will be generated in larger chunks with fewer
ApplyGuardrail calls. The following examples show the response
generated for Hello, I am an agent input string.
Example response in chunks: Interval set to 3 characters
'Hel', 'lo, ','I am', ' an', ' Age', 'nt'
Each chunk has at least 3 characters except for the last chunk
Example response in chunks: Interval set to 20 or more characters
Hello, I am an Agent
stream_final_response
class-attribute
instance-attribute
¶
stream_final_response: bool = False
Specifies whether to enable streaming for the final response. This is
set to false by default.