Record Class ChatClientResponse

java.lang.Object
java.lang.Record
org.springframework.ai.chat.client.ChatClientResponse
Record Components:
chatResponse - The response returned by the AI model
context - The contextual data propagated through the execution chain
public record ChatClientResponse(@Nullable org.springframework.ai.chat.model.ChatResponse chatResponse, Map<String, @Nullable Object> context) extends Record
Represents a response returned by a ChatClient.
Since:
1.0.0
Author:
Thomas Vitale

  • Constructor Details

    • ChatClientResponse

      public ChatClientResponse(@Nullable org.springframework.ai.chat.model.ChatResponse chatResponse, Map<String, @Nullable Object> context)
      Creates an instance of a ChatClientResponse record class.
      Parameters:
      chatResponse - the value for the chatResponse record component
      context - the value for the context record component

  • Method Details

    • copy

      public ChatClientResponse copy()

    • mutate

      public ChatClientResponse.Builder mutate()

    • builder

      public static ChatClientResponse.Builder builder()

    • 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.

    • chatResponse

      public @Nullable org.springframework.ai.chat.model.ChatResponse chatResponse()
      Returns the value of the chatResponse record component.
      Returns:
      the value of the chatResponse record component

    • context

      public Map<String, @Nullable Object> context()
      Returns the value of the context record component.
      Returns:
      the value of the context record component