[OPIK-441] Split feedback score name endpoints (#704)

* [OPIK-441] Split feedback score name endpoints * Add tests
comet-ml · Nov 25, 2024 · 5ea57cd · 5ea57cd
1 parent f832acc
commit 5ea57cd
Show file tree

Hide file tree

Showing 16 changed files with 930 additions and 549 deletions.
diff --git a/apps/opik-backend/src/main/java/com/comet/opik/api/filter/FiltersFactory.java b/apps/opik-backend/src/main/java/com/comet/opik/api/filter/FiltersFactory.java
@@ -67,6 +67,7 @@ public <T extends Filter> List<? extends Filter> newFilters(String queryParam,
         } catch (UncheckedIOException exception) {
             throw new BadRequestException("Invalid filters query parameter '%s'".formatted(queryParam), exception);
         }
+
         filters = filters.stream()
                 .distinct()
                 .map(this::toValidAndDecoded)

diff --git a/apps/opik-backend/src/main/java/com/comet/opik/api/queryparams/UUIDListParamConverter.java b/apps/opik-backend/src/main/java/com/comet/opik/api/queryparams/UUIDListParamConverter.java
@@ -0,0 +1,30 @@
+package com.comet.opik.api.queryparams;
+
+import jakarta.ws.rs.ext.ParamConverter;
+
+import java.util.Arrays;
+import java.util.List;
+import java.util.UUID;
+
+import static java.util.stream.Collectors.joining;
+
+public class UUIDListParamConverter implements ParamConverter<List<UUID>> {
+
+    @Override
+    public List<UUID> fromString(String value) {
+        if (value == null || value.trim().isEmpty()) {
+            return List.of(); // Return an empty list if no value is provided
+        }
+        return Arrays.stream(value.split(","))
+                .map(String::trim)
+                .map(UUID::fromString)
+                .toList();
+    }
+
+    @Override
+    public String toString(List<UUID> value) {
+        return value.stream()
+                .map(UUID::toString)
+                .collect(joining(","));
+    }
+}
diff --git a/...-backend/src/main/java/com/comet/opik/api/queryparams/UUIDListParamConverterProvider.java b/...-backend/src/main/java/com/comet/opik/api/queryparams/UUIDListParamConverterProvider.java
@@ -0,0 +1,22 @@
+package com.comet.opik.api.queryparams;
+
+import jakarta.ws.rs.ext.ParamConverter;
+import jakarta.ws.rs.ext.ParamConverterProvider;
+import jakarta.ws.rs.ext.Provider;
+
+import java.lang.reflect.Type;
+import java.util.List;
+
+@Provider
+public class UUIDListParamConverterProvider implements ParamConverterProvider {
+
+    @Override
+    @SuppressWarnings("unchecked")
+    public <T> ParamConverter<T> getConverter(Class<T> rawType, Type genericType,
+            java.lang.annotation.Annotation[] annotations) {
+        if (rawType.equals(List.class) && genericType.getTypeName().contains("UUID")) {
+            return (ParamConverter<T>) new UUIDListParamConverter();
+        }
+        return null;
+    }
+}
diff --git a/.../opik-backend/src/main/java/com/comet/opik/api/resources/v1/priv/ExperimentsResource.java b/.../opik-backend/src/main/java/com/comet/opik/api/resources/v1/priv/ExperimentsResource.java
@@ -8,8 +8,11 @@
 import com.comet.opik.api.ExperimentItemsDelete;
 import com.comet.opik.api.ExperimentSearchCriteria;
 import com.comet.opik.api.ExperimentsDelete;
+import com.comet.opik.api.FeedbackDefinition;
+import com.comet.opik.api.FeedbackScoreNames;
 import com.comet.opik.domain.ExperimentItemService;
 import com.comet.opik.domain.ExperimentService;
+import com.comet.opik.domain.FeedbackScoreService;
 import com.comet.opik.domain.IdGenerator;
 import com.comet.opik.domain.Streamer;
 import com.comet.opik.infrastructure.auth.RequestContext;
@@ -48,6 +51,7 @@
 import lombok.extern.slf4j.Slf4j;
 import org.glassfish.jersey.server.ChunkedOutput;
 
+import java.util.List;
 import java.util.Set;
 import java.util.UUID;
 import java.util.stream.Collectors;
@@ -66,6 +70,7 @@ public class ExperimentsResource {
 
     private final @NonNull ExperimentService experimentService;
     private final @NonNull ExperimentItemService experimentItemService;
+    private final @NonNull FeedbackScoreService feedbackScoreService;
     private final @NonNull Provider<RequestContext> requestContext;
     private final @NonNull IdGenerator idGenerator;
     private final @NonNull Streamer streamer;
@@ -241,4 +246,26 @@ public Response deleteExperimentItems(
         log.info("Deleted experiment items, count '{}'", request.ids().size());
         return Response.noContent().build();
     }
+
+    @GET
+    @Path("/feedback-scores/names")
+    @Operation(operationId = "findFeedbackScoreNames", summary = "Find Feedback Score names", description = "Find Feedback Score names", responses = {
+            @ApiResponse(responseCode = "200", description = "Feedback Scores resource", content = @Content(array = @ArraySchema(schema = @Schema(implementation = String.class))))
+    })
+    @JsonView({FeedbackDefinition.View.Public.class})
+    public Response findFeedbackScoreNames(@QueryParam("experiment_ids") List<UUID> experimentIds) {
+
+        String workspaceId = requestContext.get().getWorkspaceId();
+
+        log.info("Find feedback score names by experiment_ids '{}', on workspaceId '{}'",
+                experimentIds, workspaceId);
+        FeedbackScoreNames feedbackScoreNames = feedbackScoreService
+                .getExperimentsFeedbackScoreNames(experimentIds)
+                .contextWrite(ctx -> setRequestContext(ctx, requestContext))
+                .block();
+        log.info("Found feedback score names '{}' by experiment_ids '{}', on workspaceId '{}'",
+                feedbackScoreNames.scores().size(), experimentIds, workspaceId);
+
+        return Response.ok(feedbackScoreNames).build();
+    }
 }
diff --git a/...pik-backend/src/main/java/com/comet/opik/api/resources/v1/priv/FeedbackScoreResource.java b/...pik-backend/src/main/java/com/comet/opik/api/resources/v1/priv/FeedbackScoreResource.java
diff --git a/apps/opik-backend/src/main/java/com/comet/opik/api/resources/v1/priv/SpansResource.java b/apps/opik-backend/src/main/java/com/comet/opik/api/resources/v1/priv/SpansResource.java
@@ -2,8 +2,10 @@
 
 import com.codahale.metrics.annotation.Timed;
 import com.comet.opik.api.DeleteFeedbackScore;
+import com.comet.opik.api.FeedbackDefinition;
 import com.comet.opik.api.FeedbackScore;
 import com.comet.opik.api.FeedbackScoreBatch;
+import com.comet.opik.api.FeedbackScoreNames;
 import com.comet.opik.api.Span;
 import com.comet.opik.api.SpanBatch;
 import com.comet.opik.api.SpanSearchCriteria;
@@ -19,6 +21,7 @@
 import com.fasterxml.jackson.annotation.JsonView;
 import io.swagger.v3.oas.annotations.Operation;
 import io.swagger.v3.oas.annotations.headers.Header;
+import io.swagger.v3.oas.annotations.media.ArraySchema;
 import io.swagger.v3.oas.annotations.media.Content;
 import io.swagger.v3.oas.annotations.media.Schema;
 import io.swagger.v3.oas.annotations.parameters.RequestBody;
@@ -29,6 +32,7 @@
 import jakarta.validation.Valid;
 import jakarta.validation.constraints.Min;
 import jakarta.validation.constraints.NotNull;
+import jakarta.ws.rs.BadRequestException;
 import jakarta.ws.rs.ClientErrorException;
 import jakarta.ws.rs.Consumes;
 import jakarta.ws.rs.DELETE;
@@ -258,4 +262,31 @@ public Response scoreBatchOfSpans(
         return Response.noContent().build();
     }
 
+    @GET
+    @Path("/feedback-scores/names")
+    @Operation(operationId = "findFeedbackScoreNames", summary = "Find Feedback Score names", description = "Find Feedback Score names", responses = {
+            @ApiResponse(responseCode = "200", description = "Feedback Scores resource", content = @Content(array = @ArraySchema(schema = @Schema(implementation = String.class))))
+    })
+    @JsonView({FeedbackDefinition.View.Public.class})
+    public Response findFeedbackScoreNames(@QueryParam("project_id") UUID projectId,
+            @QueryParam("type") SpanType type) {
+
+        if (projectId == null) {
+            throw new BadRequestException("project_id must be provided");
+        }
+
+        String workspaceId = requestContext.get().getWorkspaceId();
+
+        log.info("Find feedback score names by project_id '{}', on workspaceId '{}'",
+                projectId, workspaceId);
+        FeedbackScoreNames feedbackScoreNames = feedbackScoreService
+                .getSpanFeedbackScoreNames(projectId, type)
+                .contextWrite(ctx -> setRequestContext(ctx, requestContext))
+                .block();
+        log.info("Found feedback score names '{}' by project_id '{}', on workspaceId '{}'",
+                feedbackScoreNames.scores().size(), projectId, workspaceId);
+
+        return Response.ok(feedbackScoreNames).build();
+    }
+
 }
diff --git a/apps/opik-backend/src/main/java/com/comet/opik/api/resources/v1/priv/TracesResource.java b/apps/opik-backend/src/main/java/com/comet/opik/api/resources/v1/priv/TracesResource.java
@@ -2,8 +2,10 @@
 
 import com.codahale.metrics.annotation.Timed;
 import com.comet.opik.api.DeleteFeedbackScore;
+import com.comet.opik.api.FeedbackDefinition;
 import com.comet.opik.api.FeedbackScore;
 import com.comet.opik.api.FeedbackScoreBatch;
+import com.comet.opik.api.FeedbackScoreNames;
 import com.comet.opik.api.Trace;
 import com.comet.opik.api.Trace.TracePage;
 import com.comet.opik.api.TraceBatch;
@@ -20,6 +22,7 @@
 import com.fasterxml.jackson.annotation.JsonView;
 import io.swagger.v3.oas.annotations.Operation;
 import io.swagger.v3.oas.annotations.headers.Header;
+import io.swagger.v3.oas.annotations.media.ArraySchema;
 import io.swagger.v3.oas.annotations.media.Content;
 import io.swagger.v3.oas.annotations.media.Schema;
 import io.swagger.v3.oas.annotations.parameters.RequestBody;
@@ -29,6 +32,7 @@
 import jakarta.validation.Valid;
 import jakarta.validation.constraints.Min;
 import jakarta.validation.constraints.NotNull;
+import jakarta.ws.rs.BadRequestException;
 import jakarta.ws.rs.ClientErrorException;
 import jakarta.ws.rs.Consumes;
 import jakarta.ws.rs.DELETE;
@@ -290,4 +294,30 @@ public Response scoreBatchOfTraces(
         return Response.noContent().build();
     }
 
+    @GET
+    @Path("/feedback-scores/names")
+    @Operation(operationId = "findFeedbackScoreNames", summary = "Find Feedback Score names", description = "Find Feedback Score names", responses = {
+            @ApiResponse(responseCode = "200", description = "Feedback Scores resource", content = @Content(array = @ArraySchema(schema = @Schema(implementation = String.class))))
+    })
+    @JsonView({FeedbackDefinition.View.Public.class})
+    public Response findFeedbackScoreNames(@QueryParam("project_id") UUID projectId) {
+
+        if (projectId == null) {
+            throw new BadRequestException("project_id must be provided");
+        }
+
+        String workspaceId = requestContext.get().getWorkspaceId();
+
+        log.info("Find feedback score names by project_id '{}', on workspaceId '{}'",
+                projectId, workspaceId);
+        FeedbackScoreNames feedbackScoreNames = feedbackScoreService
+                .getTraceFeedbackScoreNames(projectId)
+                .contextWrite(ctx -> setRequestContext(ctx, requestContext))
+                .block();
+        log.info("Found feedback score names '{}' by project_id '{}', on workspaceId '{}'",
+                feedbackScoreNames.scores().size(), projectId, workspaceId);
+
+        return Response.ok(feedbackScoreNames).build();
+    }
+
 }