Skip to content

feat: Move the advisor name to low cardinality key values #1726

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

Closed
wants to merge 1 commit into from
Closed

feat: Move the advisor name to low cardinality key values #1726

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
11 changes: 6 additions & 5 deletions ...g/springframework/ai/chat/client/advisor/observation/AdvisorObservationDocumentation.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,11 +68,7 @@ public String asString() {
public String asString() {
return "spring.ai.advisor.type";
}
}

}

public enum HighCardinalityKeyNames implements KeyName {
},

/**
* Advisor name.
Expand All @@ -83,6 +79,11 @@ public String asString() {
return "spring.ai.advisor.name";
}
},

}

public enum HighCardinalityKeyNames implements KeyName {

/**
* Advisor order in the advisor chain.
*/
Expand Down
15 changes: 7 additions & 8 deletions ...ringframework/ai/chat/client/advisor/observation/DefaultAdvisorObservationConvention.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,16 +62,19 @@ public String getContextualName(AdvisorObservationContext context) {

@Override
public KeyValues getLowCardinalityKeyValues(AdvisorObservationContext context) {
return KeyValues.of(springAiKind(), advisorType(context));
return KeyValues.of(springAiKind(), advisorType(context), advisorName(context));
}

protected KeyValue advisorType(AdvisorObservationContext context) {
return KeyValue.of(LowCardinalityKeyNames.ADVISOR_TYPE, context.getAdvisorType().name());
}

protected KeyValue springAiKind() {
return KeyValue.of(AdvisorObservationDocumentation.LowCardinalityKeyNames.SPRING_AI_KIND,
SpringAiKind.ADVISOR.value());
return KeyValue.of(LowCardinalityKeyNames.SPRING_AI_KIND, SpringAiKind.ADVISOR.value());
}

protected KeyValue advisorName(AdvisorObservationContext context) {
return KeyValue.of(LowCardinalityKeyNames.ADVISOR_NAME, context.getAdvisorName());
}

// ------------------------
Expand All @@ -80,11 +83,7 @@ protected KeyValue springAiKind() {

@Override
public KeyValues getHighCardinalityKeyValues(AdvisorObservationContext context) {
return KeyValues.of(advisorName(context), advisorOrder(context));
}

protected KeyValue advisorName(AdvisorObservationContext context) {
return KeyValue.of(HighCardinalityKeyNames.ADVISOR_NAME, context.getAdvisorName());
return KeyValues.of(advisorOrder(context));
}

protected KeyValue advisorOrder(AdvisorObservationContext context) {
Expand Down
2 changes: 1 addition & 1 deletion ...ramework/ai/chat/client/advisor/observation/DefaultAdvisorObservationConventionTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,7 @@ void shouldHaveLowCardinalityKeyValuesWhenDefined() {
assertThat(this.observationConvention.getLowCardinalityKeyValues(observationContext)).contains(
KeyValue.of(LowCardinalityKeyNames.ADVISOR_TYPE.asString(),
AdvisorObservationContext.Type.AROUND.name()),
KeyValue.of(LowCardinalityKeyNames.ADVISOR_NAME.asString(), "MyName"),
KeyValue.of(LowCardinalityKeyNames.SPRING_AI_KIND.asString(), SpringAiKind.ADVISOR.value()));
}

Expand All @@ -81,7 +82,6 @@ void shouldHaveKeyValuesWhenDefinedAndResponse() {
.build();

assertThat(this.observationConvention.getHighCardinalityKeyValues(observationContext))
.contains(KeyValue.of(HighCardinalityKeyNames.ADVISOR_NAME.asString(), "MyName"))
.contains(KeyValue.of(HighCardinalityKeyNames.ADVISOR_ORDER.asString(), "678"));
}

Expand Down