Package org.springframework.ai.openai.api

Record Class OpenAiApi.ChatCompletionRequest.StreamOptions

java.lang.Object
java.lang.Record
org.springframework.ai.openai.api.OpenAiApi.ChatCompletionRequest.StreamOptions
Record Components:
includeUsage - 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.
Enclosing class:
OpenAiApi.ChatCompletionRequest
public static record OpenAiApi.ChatCompletionRequest.StreamOptions(Boolean includeUsage) extends Record
Options for streaming response.

  • Field Details

  • Constructor Details

    • StreamOptions

      public StreamOptions(Boolean includeUsage)
      Creates an instance of a StreamOptions record class.
      Parameters:
      includeUsage - the value for the includeUsage record component

  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • includeUsage

      public Boolean includeUsage()
      Returns the value of the includeUsage record component.
      Returns:
      the value of the includeUsage record component