feature: add average search rating graph

densumesh · densumesh · commit a70cf762c39c · 2025-03-19T20:36:34.000-07:00
diff --git a/clients/trieve-shopify-extension/app/components/analytics/search/SearchAverageRating.tsx b/clients/trieve-shopify-extension/app/components/analytics/search/SearchAverageRating.tsx
@@ -0,0 +1,33 @@
+import { useQuery } from "@tanstack/react-query";
+import { useTrieve } from "app/context/trieveContext";
+import { RAGAnalyticsFilter } from "trieve-ts-sdk";
+import { Granularity } from "trieve-ts-sdk";
+import { GraphComponent } from "../GraphComponent";
+import { searchAverageRatingQuery } from "app/queries/analytics/search";
+
+export const SearchAverageRating = ({
+  filters,
+  granularity,
+}: {
+  filters: RAGAnalyticsFilter;
+  granularity: Granularity;
+}) => {
+  const { trieve } = useTrieve();
+  const { data, isLoading } = useQuery(
+    searchAverageRatingQuery(trieve, filters, granularity),
+  );
+
+  return (
+    <GraphComponent
+      loading={isLoading}
+      topLevelMetric={data?.avg_search_rating}
+      graphData={data?.points}
+      granularity={granularity}
+      date_range={filters.date_range}
+      xAxis={"time_stamp"}
+      yAxis={"point"}
+      label="Average Search Rating"
+      tooltipContent="The average rating that users give to the search."
+    />
+  );
+};
diff --git a/clients/trieve-shopify-extension/app/queries/analytics/search.ts b/clients/trieve-shopify-extension/app/queries/analytics/search.ts
@@ -11,6 +11,7 @@ import {
   CTRMetricsOverTimeResponse,
   SearchConversionRateResponse,
   SearchesPerUserResponse,
+  SearchAverageRatingResponse,
 } from "trieve-ts-sdk";
 import { subDays } from "date-fns";
 import { formatDateForApi } from "../../utils/formatting";
@@ -152,3 +153,21 @@ export const searchesPerUserQuery = (
     },
   } satisfies QueryOptions;
 };
+
+export const searchAverageRatingQuery = (
+  trieve: TrieveSDK,
+  filters: SearchAnalyticsFilter,
+  granularity: Granularity,
+) => {
+  return {
+    queryKey: ["search_average_rating", filters, granularity],
+    queryFn: async () => {
+      const result = await trieve.getSearchAnalytics({
+        filter: filters,
+        type: "search_average_rating",
+        granularity,
+      });
+      return result as SearchAverageRatingResponse;
+    },
+  } satisfies QueryOptions;
+};
diff --git a/clients/trieve-shopify-extension/app/routes/app._dashboard.search.tsx b/clients/trieve-shopify-extension/app/routes/app._dashboard.search.tsx
@@ -10,6 +10,8 @@ import { Granularity } from "trieve-ts-sdk";
 import { AllSearchesTable } from "app/components/analytics/search/AllSearchesTable";
 import { SearchCTRChart } from "app/components/analytics/search/SearchCTR";
 import { SearchesPerUser } from "app/components/analytics/search/SearchesPerUser";
+import { SearchAverageRating } from "app/components/analytics/search/SearchAverageRating";
+
 export default function SearchAnalyticsPage() {
   const [filters, setFilters] = useState(defaultSearchAnalyticsFilter);
   const [granularity, setGranularity] = useState<Granularity>("day");
@@ -46,8 +48,12 @@ export default function SearchAnalyticsPage() {
               <div className="flex flex-col gap-4">
                 <SearchUsageChart filters={filters} granularity={granularity} />
                 <SearchConversionRate
-                filters={filters}
-                granularity={granularity}
+                  filters={filters}
+                  granularity={granularity}
+                />
+                <SearchAverageRating
+                  filters={filters}
+                  granularity={granularity}
                 />
                 <NoResultQueriesTable filters={filters} />
               </div>
@@ -56,8 +62,8 @@ export default function SearchAnalyticsPage() {
               <div className="flex flex-col gap-4">
                 <SearchCTRChart filters={filters} granularity={granularity} />
                 <SearchesPerUser
-                filters={filters}
-                granularity={granularity}
+                  filters={filters}
+                  granularity={granularity}
                 />
                 <HeadQueriesTable filters={filters} />
               </div>
diff --git a/clients/trieve-shopify-extension/yarn.lock b/clients/trieve-shopify-extension/yarn.lock
@@ -8198,7 +8198,7 @@ tr46@~0.0.3:
   integrity sha512-N3WMsuqV66lT30CrXNbEjx4GEwlow3v6rr4mCcv6prnfwhS01rkgyFdjPNBYd9br7LpXV1+Emh01fHnq2Gdgrw==
 
 trieve-ts-sdk@../ts-sdk:
-  version "0.0.64"
+  version "0.0.67"
 
 trim-lines@^3.0.0:
   version "3.0.1"
diff --git a/clients/ts-sdk/openapi.json b/clients/ts-sdk/openapi.json
@@ -16519,6 +16519,37 @@
                 ]
               }
             }
+          },
+          {
+            "type": "object",
+            "title": "SearchAverageRating",
+            "required": [
+              "type"
+            ],
+            "properties": {
+              "filter": {
+                "allOf": [
+                  {
+                    "$ref": "#/components/schemas/SearchAnalyticsFilter"
+                  }
+                ],
+                "nullable": true
+              },
+              "granularity": {
+                "allOf": [
+                  {
+                    "$ref": "#/components/schemas/Granularity"
+                  }
+                ],
+                "nullable": true
+              },
+              "type": {
+                "type": "string",
+                "enum": [
+                  "search_average_rating"
+                ]
+              }
+            }
           }
         ],
         "discriminator": {
@@ -16618,9 +16649,31 @@
           },
           {
             "$ref": "#/components/schemas/SearchesPerUserResponse"
+          },
+          {
+            "$ref": "#/components/schemas/SearchAverageRatingResponse"
           }
         ]
       },
+      "SearchAverageRatingResponse": {
+        "type": "object",
+        "required": [
+          "avg_search_rating",
+          "points"
+        ],
+        "properties": {
+          "avg_search_rating": {
+            "type": "number",
+            "format": "double"
+          },
+          "points": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/FloatTimePoint"
+            }
+          }
+        }
+      },
       "SearchCTRMetrics": {
         "type": "object",
         "title": "Search CTR Metrics",
diff --git a/clients/ts-sdk/src/types.gen.ts b/clients/ts-sdk/src/types.gen.ts
@@ -3068,6 +3068,10 @@ export type SearchAnalytics = {
     filter?: ((SearchAnalyticsFilter) | null);
     granularity?: ((Granularity) | null);
     type: 'searches_per_user';
+} | {
+    filter?: ((SearchAnalyticsFilter) | null);
+    granularity?: ((Granularity) | null);
+    type: 'search_average_rating';
 };
 
 export type type7 = 'latency_graph';
@@ -3082,7 +3086,12 @@ export type SearchAnalyticsFilter = {
     top_score?: ((FloatRange) | null);
 };
 
-export type SearchAnalyticsResponse = LatencyGraphResponse | SearchUsageGraphResponse | DatasetAnalytics | HeadQueryResponse | SearchQueryResponse | QueryCountResponse | SearchQueryEvent | PopularFiltersResponse | CTRMetricsOverTimeResponse | SearchConversionRateResponse | SearchesPerUserResponse;
+export type SearchAnalyticsResponse = LatencyGraphResponse | SearchUsageGraphResponse | DatasetAnalytics | HeadQueryResponse | SearchQueryResponse | QueryCountResponse | SearchQueryEvent | PopularFiltersResponse | CTRMetricsOverTimeResponse | SearchConversionRateResponse | SearchesPerUserResponse | SearchAverageRatingResponse;
+
+export type SearchAverageRatingResponse = {
+    avg_search_rating: number;
+    points: Array<FloatTimePoint>;
+};
 
 export type SearchCTRMetrics = {
     avg_position_of_click: number;
diff --git a/server/src/data/models.rs b/server/src/data/models.rs
@@ -7250,6 +7250,11 @@ pub enum SearchAnalytics {
         filter: Option<SearchAnalyticsFilter>,
         granularity: Option<Granularity>,
     },
+    #[schema(title = "SearchAverageRating")]
+    SearchAverageRating {
+        filter: Option<SearchAnalyticsFilter>,
+        granularity: Option<Granularity>,
+    },
 }
 
 #[derive(Debug, Serialize, Deserialize, ToSchema)]
@@ -7511,6 +7516,12 @@ pub struct SearchesPerUserResponse {
     pub points: Vec<FloatTimePoint>,
 }
 
+#[derive(Debug, Row, Serialize, Deserialize, ToSchema)]
+pub struct SearchAverageRatingResponse {
+    pub avg_search_rating: f64,
+    pub points: Vec<FloatTimePoint>,
+}
+
 #[derive(Debug, Row, Serialize, Deserialize, ToSchema)]
 pub struct TopicQueriesResponse {
     pub topics: Vec<TopicAnalyticsSummary>,
@@ -7605,6 +7616,8 @@ pub enum SearchAnalyticsResponse {
     SearchConversionRate(SearchConversionRateResponse),
     #[schema(title = "SearchesPerUser")]
     SearchesPerUser(SearchesPerUserResponse),
+    #[schema(title = "SearchAverageRating")]
+    SearchAverageRating(SearchAverageRatingResponse)
 }
 
 #[derive(Debug, Serialize, Deserialize, ToSchema)]
@@ -7616,6 +7629,7 @@ pub enum ClusterAnalyticsResponse {
     ClusterQueries(SearchQueryResponse),
 }
 
+
 #[derive(Debug, Serialize, Deserialize, ToSchema)]
 #[serde(untagged)]
 pub enum RecommendationAnalyticsResponse {
diff --git a/server/src/handlers/analytics_handler.rs b/server/src/handlers/analytics_handler.rs
@@ -344,6 +344,19 @@ pub async fn get_search_analytics(
             .await?;
             SearchAnalyticsResponse::SearchesPerUser(searches_per_user)
         }
+        SearchAnalytics::SearchAverageRating {
+            filter,
+            granularity,
+        } => {
+            let search_average_rating = get_search_average_rating_query(
+                dataset_org_plan_sub.dataset.id,
+                filter,
+                granularity,
+                clickhouse_client.get_ref(),
+            )
+            .await?;
+            SearchAnalyticsResponse::SearchAverageRating(search_average_rating)
+        }
     };
 
     Ok(HttpResponse::Ok().json(response))
diff --git a/server/src/lib.rs b/server/src/lib.rs
@@ -596,6 +596,7 @@ impl Modify for SecurityAddon {
             data::models::MessagesPerUserResponse,
             data::models::SearchesPerUserResponse,
             data::models::ChatAverageRatingResponse,
+            data::models::SearchAverageRatingResponse,
             errors::ErrorResponseBody,
             middleware::api_version::APIVersion,
         )
diff --git a/server/src/operators/analytics_operator.rs b/server/src/operators/analytics_operator.rs
@@ -13,15 +13,16 @@ use crate::{
         RecommendationsConversionRateResponse, RecommendationsPerUserResponse,
         RecommendationsWithClicksCTRResponse, RecommendationsWithClicksCTRResponseClickhouse,
         RecommendationsWithoutClicksCTRResponse, RecommendationsWithoutClicksCTRResponseClickhouse,
-        SearchAnalyticsFilter, SearchCTRMetrics, SearchCTRMetricsClickhouse, SearchClusterTopics,
-        SearchConversionRateResponse, SearchQueriesWithClicksCTRResponse,
-        SearchQueriesWithClicksCTRResponseClickhouse, SearchQueriesWithoutClicksCTRResponse,
-        SearchQueriesWithoutClicksCTRResponseClickhouse, SearchQueryEvent,
-        SearchQueryEventClickhouse, SearchSortBy, SearchTypeCount, SearchesPerUserResponse,
-        SortOrder, TopComponents, TopComponentsResponse, TopDatasetsResponse,
-        TopDatasetsResponseClickhouse, TopPages, TopPagesResponse, TopicAnalyticsFilter,
-        TopicAnalyticsSummaryClickhouse, TopicDetailsResponse, TopicQueriesResponse,
-        TopicQueryClickhouse, TopicsOverTimeResponse, TotalUniqueUsersResponse,
+        SearchAnalyticsFilter, SearchAverageRatingResponse, SearchCTRMetrics,
+        SearchCTRMetricsClickhouse, SearchClusterTopics, SearchConversionRateResponse,
+        SearchQueriesWithClicksCTRResponse, SearchQueriesWithClicksCTRResponseClickhouse,
+        SearchQueriesWithoutClicksCTRResponse, SearchQueriesWithoutClicksCTRResponseClickhouse,
+        SearchQueryEvent, SearchQueryEventClickhouse, SearchSortBy, SearchTypeCount,
+        SearchesPerUserResponse, SortOrder, TopComponents, TopComponentsResponse,
+        TopDatasetsResponse, TopDatasetsResponseClickhouse, TopPages, TopPagesResponse,
+        TopicAnalyticsFilter, TopicAnalyticsSummaryClickhouse, TopicDetailsResponse,
+        TopicQueriesResponse, TopicQueryClickhouse, TopicsOverTimeResponse,
+        TotalUniqueUsersResponse,
     },
     errors::ServiceError,
     handlers::analytics_handler::GetTopDatasetsRequestBody,
@@ -2697,3 +2698,67 @@ pub async fn get_chat_average_rating_query(
         points: chat_average_rating.into_iter().map(|x| x.into()).collect(),
     })
 }
+
+pub async fn get_search_average_rating_query(
+    dataset_id: uuid::Uuid,
+    filter: Option<SearchAnalyticsFilter>,
+    granularity: Option<Granularity>,
+    clickhouse_client: &clickhouse::Client,
+) -> Result<SearchAverageRatingResponse, ServiceError> {
+    let interval = match granularity {
+        Some(Granularity::Second) => "1 SECOND",
+        Some(Granularity::Minute) => "1 MINUTE",
+        Some(Granularity::Hour) => "1 HOUR",
+        Some(Granularity::Day) => "1 DAY",
+        Some(Granularity::Month) => "1 MONTH",
+        None => "1 HOUR",
+    };
+
+    let mut query_string = format!(
+        "SELECT 
+            CAST(toStartOfInterval(created_at, INTERVAL {}) AS DateTime) AS time_stamp,
+            avg(JSONExtract(search_queries.query_rating, 'rating', 'Float64')) as avg_rating
+        FROM search_queries
+        WHERE dataset_id = ? AND search_queries.query_rating != ''
+        ",
+        interval,
+    );
+
+    if let Some(filter_params) = &filter {
+        query_string = filter_params.add_to_query(query_string);
+    }
+
+    query_string.push_str(
+        "
+        GROUP BY 
+            time_stamp
+        ORDER BY 
+            time_stamp
+        LIMIT 1000",
+    );
+
+    let search_average_rating = clickhouse_client
+        .query(query_string.as_str())
+        .bind(dataset_id)
+        .fetch_all::<FloatTimePointClickhouse>()
+        .await
+        .map_err(|e| {
+            log::error!("Error fetching search average rating: {:?}", e);
+            ServiceError::InternalServerError("Error fetching search average rating".to_string())
+        })?;
+
+    let avg_search_rating = if !search_average_rating.is_empty() {
+        search_average_rating.iter().map(|x| x.point).sum::<f64>()
+            / search_average_rating.len() as f64
+    } else {
+        0.0
+    };
+
+    Ok(SearchAverageRatingResponse {
+        avg_search_rating,
+        points: search_average_rating
+            .into_iter()
+            .map(|x| x.into())
+            .collect(),
+    })
+}
diff --git a/yarn.lock b/yarn.lock
@@ -3337,6 +3337,8 @@ eslint-utils@^3.0.0:
   version "3.0.0"
   resolved "https://registry.yarnpkg.com/eslint-utils/-/eslint-utils-3.0.0.tgz#8aebaface7345bb33559db0a1f13a1d2d48c3672"
   integrity sha512-uuQC43IGctw68pJA1RgbQS8/NP7rch6Cwd4j3ZBtgo4/8Flj4eGE7ZYSZRN3iq5pVUv6GPdW5Z1RFleo84uLDA==
+  dependencies:
+    eslint-visitor-keys "^2.0.0"
 
 eslint-visitor-keys@^1.1.0:
   version "1.3.0"
@@ -7066,6 +7068,11 @@ totalist@^3.0.0:
   resolved "https://registry.yarnpkg.com/totalist/-/totalist-3.0.1.tgz#ba3a3d600c915b1a97872348f79c127475f6acf8"
   integrity sha512-sf4i37nQ2LBx4m3wB74y+ubopq6W/dIzXg0FDGjsYnZHVa1Da8FH853wlL2gtUhg+xJXjfk3kUZS3BRoQeoQBQ==
 
+trieve-ts-sdk@0.0.64:
+  version "0.0.64"
+  resolved "https://registry.yarnpkg.com/trieve-ts-sdk/-/trieve-ts-sdk-0.0.64.tgz#16fb13508d269d8aa9f6ba0f5e0a795d2405a171"
+  integrity sha512-L0ZToejcoty4TQLa4yG4FKBGbg/Zuk4UVTUcR3DMrxu11d/EkzRw3b0DWyElUnWFbY1xPYHolFC5nMWKIN2S+A==
+
 trieve-ts-sdk@^0.0.50:
   version "0.0.50"
   resolved "https://registry.yarnpkg.com/trieve-ts-sdk/-/trieve-ts-sdk-0.0.50.tgz#8b16f7a0f7f77d81811aa0e3a7ed7050b5938379"

Original file line number	Diff line number	Diff line change
`@@ -596,6 +596,7 @@ impl Modify for SecurityAddon {`
`596`	`596`	`data::models::MessagesPerUserResponse,`
`597`	`597`	`data::models::SearchesPerUserResponse,`
`598`	`598`	`data::models::ChatAverageRatingResponse,`
	`599`	`+ data::models::SearchAverageRatingResponse,`
`599`	`600`	`errors::ErrorResponseBody,`
`600`	`601`	`middleware::api_version::APIVersion,`
`601`	`602`	`)`