Record Class StreamingChatCompletionResults

java.lang.Object
java.lang.Record
org.elasticsearch.xpack.core.inference.results.StreamingChatCompletionResults
All Implemented Interfaces:
NamedWriteable, Writeable, ChunkedToXContent, InferenceServiceResults

public record StreamingChatCompletionResults(Flow.Publisher<? extends InferenceServiceResults.Result> publisher) extends Record implements InferenceServiceResults
Chat Completion results that only contain a Flow.Publisher.
  • Constructor Details

    • StreamingChatCompletionResults

      public StreamingChatCompletionResults(Flow.Publisher<? extends InferenceServiceResults.Result> publisher)
      Creates an instance of a StreamingChatCompletionResults record class.
      Parameters:
      publisher - the value for the publisher record component
  • Method Details

    • isStreaming

      public boolean isStreaming()
      Specified by:
      isStreaming in interface InferenceServiceResults
    • 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.
    • publisher

      public Flow.Publisher<? extends InferenceServiceResults.Result> publisher()
      Returns the value of the publisher record component.
      Specified by:
      publisher in interface InferenceServiceResults
      Returns:
      the value of the publisher record component