Skip to content

fix: add missing avgLogprobs, finishReason and usageMetadata fields #571

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
copybara-service merged 1 commit into from
Nov 7, 2025
Merged

fix: add missing avgLogprobs, finishReason and usageMetadata fields #571

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
86 changes: 85 additions & 1 deletion core/src/main/java/com/google/adk/events/Event.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@
import com.google.genai.types.FinishReason;
import com.google.genai.types.FunctionCall;
import com.google.genai.types.FunctionResponse;
import com.google.genai.types.GenerateContentResponseUsageMetadata;
import com.google.genai.types.GroundingMetadata;
import java.time.Instant;
import java.util.List;
Expand All @@ -54,6 +55,9 @@ public class Event extends JsonBaseModel {
private Optional<Boolean> turnComplete = Optional.empty();
private Optional<FinishReason> errorCode = Optional.empty();
private Optional<String> errorMessage = Optional.empty();
private Optional<FinishReason> finishReason = Optional.empty();
private Optional<GenerateContentResponseUsageMetadata> usageMetadata = Optional.empty();
private Optional<Double> avgLogprobs = Optional.empty();
private Optional<Boolean> interrupted = Optional.empty();
private Optional<String> branch = Optional.empty();
private Optional<GroundingMetadata> groundingMetadata = Optional.empty();
Expand Down Expand Up @@ -153,10 +157,19 @@ public Optional<FinishReason> errorCode() {
return errorCode;
}

@JsonProperty("finishReason")
public Optional<FinishReason> finishReason() {
return finishReason;
}

public void setErrorCode(Optional<FinishReason> errorCode) {
this.errorCode = errorCode;
}

public void setFinishReason(Optional<FinishReason> finishReason) {
this.finishReason = finishReason;
}

@JsonProperty("errorMessage")
public Optional<String> errorMessage() {
return errorMessage;
Expand All @@ -166,6 +179,24 @@ public void setErrorMessage(Optional<String> errorMessage) {
this.errorMessage = errorMessage;
}

@JsonProperty("usageMetadata")
public Optional<GenerateContentResponseUsageMetadata> usageMetadata() {
return usageMetadata;
}

public void setUsageMetadata(Optional<GenerateContentResponseUsageMetadata> usageMetadata) {
this.usageMetadata = usageMetadata;
}

@JsonProperty("avgLogprobs")
public Optional<Double> avgLogprobs() {
return avgLogprobs;
}

public void setAvgLogprobs(Optional<Double> avgLogprobs) {
this.avgLogprobs = avgLogprobs;
}

@JsonProperty("interrupted")
public Optional<Boolean> interrupted() {
return interrupted;
Expand Down Expand Up @@ -299,6 +330,9 @@ public static class Builder {
private Optional<Boolean> turnComplete = Optional.empty();
private Optional<FinishReason> errorCode = Optional.empty();
private Optional<String> errorMessage = Optional.empty();
private Optional<FinishReason> finishReason = Optional.empty();
private Optional<GenerateContentResponseUsageMetadata> usageMetadata = Optional.empty();
private Optional<Double> avgLogprobs = Optional.empty();
private Optional<Boolean> interrupted = Optional.empty();
private Optional<String> branch = Optional.empty();
private Optional<GroundingMetadata> groundingMetadata = Optional.empty();
Expand Down Expand Up @@ -419,6 +453,45 @@ public Builder errorMessage(Optional<String> value) {
return this;
}

@CanIgnoreReturnValue
@JsonProperty("finishReason")
public Builder finishReason(@Nullable FinishReason value) {
this.finishReason = Optional.ofNullable(value);
return this;
}

@CanIgnoreReturnValue
public Builder finishReason(Optional<FinishReason> value) {
this.finishReason = value;
return this;
}

@CanIgnoreReturnValue
@JsonProperty("usageMetadata")
public Builder usageMetadata(@Nullable GenerateContentResponseUsageMetadata value) {
this.usageMetadata = Optional.ofNullable(value);
return this;
}

@CanIgnoreReturnValue
public Builder usageMetadata(Optional<GenerateContentResponseUsageMetadata> value) {
this.usageMetadata = value;
return this;
}

@CanIgnoreReturnValue
@JsonProperty("avgLogprobs")
public Builder avgLogprobs(@Nullable Double value) {
this.avgLogprobs = Optional.ofNullable(value);
return this;
}

@CanIgnoreReturnValue
public Builder avgLogprobs(Optional<Double> value) {
this.avgLogprobs = value;
return this;
}

@CanIgnoreReturnValue
@JsonProperty("interrupted")
public Builder interrupted(@Nullable Boolean value) {
Expand Down Expand Up @@ -496,10 +569,12 @@ public Event build() {
event.setTurnComplete(turnComplete);
event.setErrorCode(errorCode);
event.setErrorMessage(errorMessage);
event.setFinishReason(finishReason);
event.setUsageMetadata(usageMetadata);
event.setAvgLogprobs(avgLogprobs);
event.setInterrupted(interrupted);
event.branch(branch);
event.setGroundingMetadata(groundingMetadata);

event.setActions(actions().orElse(EventActions.builder().build()));
event.setTimestamp(timestamp().orElse(Instant.now().toEpochMilli()));
return event;
Expand Down Expand Up @@ -529,6 +604,9 @@ public Builder toBuilder() {
.turnComplete(this.turnComplete)
.errorCode(this.errorCode)
.errorMessage(this.errorMessage)
.finishReason(this.finishReason)
.usageMetadata(this.usageMetadata)
.avgLogprobs(this.avgLogprobs)
.interrupted(this.interrupted)
.branch(this.branch)
.groundingMetadata(this.groundingMetadata);
Expand Down Expand Up @@ -557,6 +635,9 @@ public boolean equals(Object obj) {
&& Objects.equals(turnComplete, other.turnComplete)
&& Objects.equals(errorCode, other.errorCode)
&& Objects.equals(errorMessage, other.errorMessage)
&& Objects.equals(finishReason, other.finishReason)
&& Objects.equals(usageMetadata, other.usageMetadata)
&& Objects.equals(avgLogprobs, other.avgLogprobs)
&& Objects.equals(interrupted, other.interrupted)
&& Objects.equals(branch, other.branch)
&& Objects.equals(groundingMetadata, other.groundingMetadata);
Expand All @@ -580,6 +661,9 @@ public int hashCode() {
turnComplete,
errorCode,
errorMessage,
finishReason,
usageMetadata,
avgLogprobs,
interrupted,
branch,
groundingMetadata,
Expand Down
5 changes: 4 additions & 1 deletion core/src/main/java/com/google/adk/flows/llmflows/BaseLlmFlow.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -633,7 +633,10 @@ private Event buildModelResponseEvent(
.errorMessage(llmResponse.errorMessage())
.interrupted(llmResponse.interrupted())
.turnComplete(llmResponse.turnComplete())
.groundingMetadata(llmResponse.groundingMetadata());
.groundingMetadata(llmResponse.groundingMetadata())
.avgLogprobs(llmResponse.avgLogprobs())
.finishReason(llmResponse.finishReason())
.usageMetadata(llmResponse.usageMetadata());

Event event = eventBuilder.build();

Expand Down
18 changes: 18 additions & 0 deletions core/src/main/java/com/google/adk/models/LlmResponse.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,14 @@ public abstract class LlmResponse extends JsonBaseModel {
@JsonProperty("errorCode")
public abstract Optional<FinishReason> errorCode();

/** Error code if the response is an error. Code varies by model. */
@JsonProperty("finishReason")
public abstract Optional<FinishReason> finishReason();

/** Error code if the response is an error. Code varies by model. */
@JsonProperty("avgLogprobs")
public abstract Optional<Double> avgLogprobs();

/** Error message if the response is an error. */
@JsonProperty("errorMessage")
public abstract Optional<String> errorMessage();
Expand Down Expand Up @@ -136,6 +144,16 @@ static LlmResponse.Builder jacksonBuilder() {

public abstract Builder errorCode(Optional<FinishReason> errorCode);

@JsonProperty("finishReason")
public abstract Builder finishReason(@Nullable FinishReason finishReason);

public abstract Builder finishReason(Optional<FinishReason> finishReason);

@JsonProperty("avgLogprobs")
public abstract Builder avgLogprobs(@Nullable Double avgLogprobs);

public abstract Builder avgLogprobs(Optional<Double> avgLogprobs);

@JsonProperty("errorMessage")
public abstract Builder errorMessage(@Nullable String errorMessage);

Expand Down
18 changes: 18 additions & 0 deletions core/src/test/java/com/google/adk/events/EventTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@
import com.google.genai.types.Content;
import com.google.genai.types.FinishReason;
import com.google.genai.types.FunctionCall;
import com.google.genai.types.GenerateContentResponseUsageMetadata;
import com.google.genai.types.Part;
import java.time.Instant;
import java.util.concurrent.ConcurrentHashMap;
Expand Down Expand Up @@ -67,6 +68,14 @@ public final class EventTest {
.turnComplete(true)
.errorCode(new FinishReason("error_code"))
.errorMessage("error_message")
.finishReason(new FinishReason("finish_reason"))
.usageMetadata(
GenerateContentResponseUsageMetadata.builder()
.promptTokenCount(10)
.candidatesTokenCount(20)
.totalTokenCount(30)
.build())
.avgLogprobs(0.5)
.interrupted(true)
.timestamp(123456789L)
.build();
Expand All @@ -80,6 +89,15 @@ public void event_builder_works() {
assertThat(EVENT.turnComplete().get()).isTrue();
assertThat(EVENT.errorCode()).hasValue(new FinishReason("error_code"));
assertThat(EVENT.errorMessage()).hasValue("error_message");
assertThat(EVENT.finishReason()).hasValue(new FinishReason("finish_reason"));
assertThat(EVENT.usageMetadata())
.hasValue(
GenerateContentResponseUsageMetadata.builder()
.promptTokenCount(10)
.candidatesTokenCount(20)
.totalTokenCount(30)
.build());
assertThat(EVENT.avgLogprobs()).hasValue(0.5);
assertThat(EVENT.interrupted()).hasValue(true);
assertThat(EVENT.timestamp()).isEqualTo(123456789L);
assertThat(EVENT.actions()).isEqualTo(EVENT_ACTIONS);
Expand Down
41 changes: 40 additions & 1 deletion core/src/test/java/com/google/adk/flows/llmflows/BaseLlmFlowTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,9 @@
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;
import com.google.genai.types.Content;
import com.google.genai.types.FinishReason;
import com.google.genai.types.FunctionDeclaration;
import com.google.genai.types.GenerateContentResponseUsageMetadata;
import com.google.genai.types.Part;
import io.reactivex.rxjava3.core.Flowable;
import io.reactivex.rxjava3.core.Single;
Expand All @@ -63,7 +65,44 @@ public void run_singleTextResponse_returnsSingleEvent() {
List<Event> events = baseLlmFlow.run(invocationContext).toList().blockingGet();

assertThat(events).hasSize(1);
assertThat(getOnlyElement(events).content()).hasValue(content);
Event event = getOnlyElement(events);
assertThat(event.content()).hasValue(content);
assertThat(event.avgLogprobs()).isEmpty();
assertThat(event.finishReason()).isEmpty();
assertThat(event.usageMetadata()).isEmpty();
}

@Test
public void run_singleTextResponse_withMetadata_returnsSingleEventWithMetadata() {
Content content = Content.fromParts(Part.fromText("LLM response"));
LlmResponse llmResponse =
LlmResponse.builder()
.content(content)
.avgLogprobs(-0.123)
.finishReason(new FinishReason(FinishReason.Known.STOP))
.usageMetadata(
GenerateContentResponseUsageMetadata.builder()
.promptTokenCount(10)
.candidatesTokenCount(20)
.build())
.build();
TestLlm testLlm = createTestLlm(llmResponse);
InvocationContext invocationContext = createInvocationContext(createTestAgent(testLlm));
BaseLlmFlow baseLlmFlow = createBaseLlmFlowWithoutProcessors();

List<Event> events = baseLlmFlow.run(invocationContext).toList().blockingGet();

assertThat(events).hasSize(1);
Event event = getOnlyElement(events);
assertThat(event.content()).hasValue(content);
assertThat(event.avgLogprobs()).hasValue(-0.123);
assertThat(event.finishReason()).hasValue(new FinishReason(FinishReason.Known.STOP));
assertThat(event.usageMetadata())
.hasValue(
GenerateContentResponseUsageMetadata.builder()
.promptTokenCount(10)
.candidatesTokenCount(20)
.build());
}

@Test
Expand Down