Package akka.javasdk.agent

Interface Agent.Effect.OnSuccessBuilder

Enclosing interface:

Agent.Effect<T>

public static interface Agent.Effect.OnSuccessBuilder

Method Summary

Modifier and Type	Method	Description
<T> Agent.Effect.MappingResponseBuilder<T>	map(Function<String,T> mapper)	Map the String response from the model into a different response type.
Agent.Effect.FailureBuilder<String>	onFailure(Function<Throwable,String> exceptionHandler)	Handle failures that occur during model processing.
<T> Agent.Effect.MappingResponseBuilder<T>	responseAs(Class<T> responseType)	Parse the response from the model into a structured response of a given responseType.
<T> Agent.Effect.MappingResponseBuilder<T>	responseConformsTo(Class<T> responseType)	Parse the response from the model into a structured response of a given responseType.
Agent.Effect<String>	thenReply()	Reply with the response from the model.
Agent.Effect<String>	thenReply(Metadata metadata)	Reply with the response from the model.

Method Details

thenReply

Agent.Effect<String> thenReply()

Reply with the response from the model.

Returns:

A message reply.

thenReply

Agent.Effect<String> thenReply(Metadata metadata)

Reply with the response from the model.

Parameters:

metadata - The metadata for the message.

Returns:

A message reply.

responseAs

<T> Agent.Effect.MappingResponseBuilder<T> responseAs(Class<T> responseType)

Parse the response from the model into a structured response of a given responseType. The system message must have instruction or example of how the JSON should be structured. Alternatively, or as a compliment, the JSON schema of the responseType can be included automatically in the request by using responseConformsTo(java.lang.Class<T>).

Parameters:

responseType - The structured response type.

See Also:

• responseConformsTo(java.lang.Class<T>)

responseConformsTo

<T> Agent.Effect.MappingResponseBuilder<T> responseConformsTo(Class<T> responseType)

Parse the response from the model into a structured response of a given responseType. The JSON schema of the responseType is included in the model request. At least OpenAI and Google Gemini support this structured model output feature. For other models that don't support it, you have to give more detailed instructions about the expected output format in the system message.

Parameters:

responseType - The structured response type.

See Also:

• responseAs(java.lang.Class<T>)

map

<T> Agent.Effect.MappingResponseBuilder<T> map(Function<String,T> mapper)

Map the String response from the model into a different response type.

onFailure

Agent.Effect.FailureBuilder<String> onFailure(Function<Throwable,String> exceptionHandler)

Handle failures that occur during model processing. This method allows recovery from various types of exceptions including:

• ModelException - General model processing failures
• RateLimitException - API rate limiting exceeded
• ModelTimeoutException - Model request timeout
• UnsupportedFeatureException - Unsupported model features
• InternalServerException - Internal service errors
• JsonParsingException - Response parsing failures
• ToolCallLimitReachedException - Tool call limit exceeded
• ToolCallExecutionException - Function tool execution errors
• McpToolCallExecutionException - MCP tool execution errors