Struct ChatCompletionStreamOptions

pub struct ChatCompletionStreamOptions {
    pub include_usage: Option<bool>,
}

on openapi.yaml

ChatCompletionStreamOptions:
  description: >
    Options for streaming response. Only set this when you set `stream:
    true`.
  type: object
  nullable: true
  default: null
  properties:
    include_usage:
      type: boolean
      description: >
        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, and the `choices` field will always be an
        empty

        array.


        All other chunks will also include a `usage` field, but with a null

        value. **NOTE:** If the stream is interrupted, you may not receive
        the

        final usage chunk which contains the total token usage for the
        request.

Fields

include_usage: Option<bool>

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, and the choices field will always be an empty array. All other chunks will also include a usage field, but with a null value. NOTE: If the stream is interrupted, you may not receive the final usage chunk which contains the total token usage for the request.

Trait Implementations

impl Debug for ChatCompletionStreamOptions

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ChatCompletionStreamOptions

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ChatCompletionStreamOptions

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.