StreamOptions

class oci.generative_ai_inference.models.StreamOptions(**kwargs)

Bases: object

Options for streaming response. Only set this when you set stream: true.

Methods:

__init__(**kwargs)

Initializes a new StreamOptions object with values from keyword arguments.

Attributes:

is_include_usage

Gets the is_include_usage of this StreamOptions.

__init__(**kwargs)

Initializes a new StreamOptions object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters

is_include_usage (bool) – The value to assign to the is_include_usage property of this StreamOptions.

property is_include_usage

Gets the is_include_usage of this StreamOptions. If set, an additional chunk will be streamed before the data: [DONE] message. The usage field on this chunk shows the token usage statistics for the entire request

Returns

The is_include_usage of this StreamOptions.

Return type

bool