Package dev.langchain4j.model.output

Class Response

  • All Implemented Interfaces:
    
public class Response<T>

    Represents the response from various types of models, including language, chat, embedding, and moderation models. This class encapsulates the generated content, token usage statistics, finish reason, and response metadata.

    • Constructor Detail

      • Response

        Response(T content)
        Create a new Response.
        Parameters:
        content - the content to wrap.

      • Response

        Response(T content, TokenUsage tokenUsage, FinishReason finishReason)
        Create a new Response.
        Parameters:
        content - the content to wrap.
        tokenUsage - the token usage statistics, or null.
        finishReason - the finish reason, or null.

      • Response

        Response(T content, TokenUsage tokenUsage, FinishReason finishReason, Map<String, Object> metadata)
        Create a new Response.
        Parameters:
        content - the content to wrap.
        tokenUsage - the token usage statistics, or null.
        finishReason - the finish reason, or null.
        metadata - the response metadata, or null.

    • Method Detail

      • content

        @NonNull() T content()

        Get the content.

        Returns:

        the content.

      • tokenUsage

         TokenUsage tokenUsage()

        Get the token usage statistics.

        Returns:

        the token usage statistics, or null.

      • from

        @NonNull() static <T> Response<T> from(@NonNull() T content)

        Create a new Response.

        Parameters:
        content - the content to wrap.
        Returns:

        the new Response.

      • from

        @NonNull() static <T> Response<T> from(@NonNull() T content, TokenUsage tokenUsage)

        Create a new Response.

        Parameters:
        content - the content to wrap.
        tokenUsage - the token usage statistics.
        Returns:

        the new Response.

      • from

        @NonNull() static <T> Response<T> from(@NonNull() T content, TokenUsage tokenUsage, FinishReason finishReason)

        Create a new Response.

        Parameters:
        content - the content to wrap.
        tokenUsage - the token usage statistics.
        finishReason - the finish reason.
        Returns:

        the new Response.

      • from

        @NonNull() static <T> Response<T> from(@NonNull() T content, TokenUsage tokenUsage, FinishReason finishReason, @Nullable() Map<String, Object> metadata)

        Create a new Response.

        Parameters:
        content - the content to wrap.
        tokenUsage - the token usage statistics.
        finishReason - the finish reason.
        metadata - the response metadata.
        Returns:

        the new Response.