Package dev.langchain4j.service

Class Result<T>

java.lang.Object

dev.langchain4j.service.Result<T>

Type Parameters:

T - The type of the content. Can be of any return type supported by AI Services, such as String, Enum, MyCustomPojo, etc.

public class Result<T>
extends Object

Represents the result of an AI Service invocation. It contains actual content (LLM response) and additional information associated with it, such as:

 - Aggregate TokenUsage over all calls to the ChatModel
 - FinishReason of the final ChatResponse
 - sources (Contents) retrieved during RAG retrieval
 - all executed tools (both requests and results)
 - all intermediate ChatResponses
 - final ChatResponse
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Result.ResultBuilder<T>

Constructor Summary

Constructors

Constructor	Description
Result(Result.ResultBuilder<T> builder)
Result(T content, TokenUsage tokenUsage, List<Content> sources, FinishReason finishReason, List<ToolExecution> toolExecutions)

Method Summary

Modifier and Type	Method	Description
static <T> Result.ResultBuilder<T>	builder()
T	content()
ChatResponse	finalResponse()	Returns final chat response returned by the ChatModel.
FinishReason	finishReason()	Returns finish reason of the final ChatModel response (taken from finalResponse()).
List<ChatResponse>	intermediateResponses()	Returns all intermediate chat responses that were returned by the ChatModel.
List<Content>	sources()	Returns all sources returned during RAG retrieval.
TokenUsage	tokenUsage()	Returns aggregate token usage over all calls to the ChatModel.
List<ToolExecution>	toolExecutions()	Returns all tool executions that happened during AI Service invocation.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Result

public Result(Result.ResultBuilder<T> builder)

Since:

1.2.0

Result

public Result(T content,
 TokenUsage tokenUsage,
 List<Content> sources,
 FinishReason finishReason,
 List<ToolExecution> toolExecutions)

Method Details

builder

public static <T> Result.ResultBuilder<T> builder()

content

public T content()

tokenUsage

public TokenUsage tokenUsage()

Returns aggregate token usage over all calls to the ChatModel.

sources

public List<Content> sources()

Returns all sources returned during RAG retrieval.

finishReason

public FinishReason finishReason()

Returns finish reason of the final ChatModel response (taken from finalResponse()).

toolExecutions

public List<ToolExecution> toolExecutions()

Returns all tool executions that happened during AI Service invocation.

intermediateResponses

public List<ChatResponse> intermediateResponses()

Returns all intermediate chat responses that were returned by the ChatModel. All of these responses contain ToolExecutionRequests.

Since:

1.2.0

finalResponse

public ChatResponse finalResponse()

Returns final chat response returned by the ChatModel. This response does not contain ToolExecutionRequests.

Since:

1.2.0