Get RAG Analytics

This route allows you to view the RAG analytics for a dataset.

POST /api/analytics/rag

Try it

Get RAG Analytics

cURL

curl --request POST \
  --url https://api.trieve.ai/api/analytics/rag \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'TR-Dataset: <tr-dataset>' \
  --data '{
  "type": "rag_queries",
  "filter": {
    "component_name": "<string>",
    "date_range": {
      "gt": "2021-01-01 00:00:00.000",
      "gte": "2021-01-01 00:00:00.000",
      "lt": "2021-01-01 00:00:00.000",
      "lte": "2021-01-01 00:00:00.000"
    },
    "query": "<string>",
    "query_rating": {
      "gt": 1,
      "gte": 1,
      "lt": 1,
      "lte": 1
    },
    "rag_type": "chosen_chunks"
  },
  "has_clicks": true,
  "page": 1,
  "sort_by": "hallucination_score",
  "sort_order": "desc"
}'

200

{
  "queries": [
    {
      "created_at": "<string>",
      "dataset_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "detected_hallucinations": [
        "<string>"
      ],
      "hallucination_score": 123,
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "llm_response": "<string>",
      "rag_type": "chosen_chunks",
      "results": [
        "<unknown>"
      ],
      "search_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "top_score": 123,
      "topic_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "user_id": "<string>",
      "user_message": "<string>",
      "metadata": "<unknown>",
      "query_rating": {
        "rating": 123,
        "metadata": "<unknown>",
        "note": "<string>"
      }
    }
  ]
}

Authorizations

Authorization · string · header · required

Headers

TR-Dataset · string<uuid> · required

The dataset id or tracking_id to use for the request. We assume you intend to use an id if the value is a valid uuid.

Body

application/json

JSON request payload to filter the graph

RAGQueries

type · enum<string> · required

Available options: rag_queries

filter · object

Show child attributes

filter. component_name · string | null

filter. date_range · object

DateRange is a JSON object which can be used to filter chunks by a range of dates. This leverages the time_stamp field on chunks in your dataset. You can specify this if you want values in a certain range. You must provide ISO 8601 combined date and time without timezone.

Show child attributes

filter.date_range. gt · string | null

filter.date_range. gte · string | null

filter.date_range. lt · string | null

filter.date_range. lte · string | null

Example:

{
  "gt": "2021-01-01 00:00:00.000",
  "gte": "2021-01-01 00:00:00.000",
  "lt": "2021-01-01 00:00:00.000",
  "lte": "2021-01-01 00:00:00.000"
}

filter. query · string | null

filter. query_rating · object

Show child attributes

filter.query_rating. gt · integer<int32> | null

Required range: x >= 0

filter.query_rating. gte · integer<int32> | null

Required range: x >= 0

filter.query_rating. lt · integer<int32> | null

Required range: x >= 0

filter.query_rating. lte · integer<int32> | null

Required range: x >= 0

Example:

{ "gt": 1, "gte": 1, "lt": 1, "lte": 1 }

filter. rag_type · enum<string>

Available options: chosen_chunks, all_chunks

has_clicks · boolean | null

page · integer<int32> | null

Required range: x >= 0

sort_by · enum<string>

Available options: hallucination_score, top_score, created_at

sort_order · enum<string>

Available options: desc, asc

Response

200

application/json

The RAG analytics for the dataset

RagQueryResponse

queries · RagQueryEvent · object[] · required

Show child attributes

queries. created_at · string · required

queries. dataset_id · string<uuid> · required

queries. detected_hallucinations · string[] · required

queries. hallucination_score · number<double> · required

queries. id · string<uuid> · required

queries. llm_response · string · required

queries. rag_type · enum<string> · required

Available options: chosen_chunks, all_chunks

queries. results · any[] · required

queries. search_id · string<uuid> · required

queries. top_score · number<float> · required

queries. topic_id · string<uuid> · required

queries. user_id · string · required

queries. user_message · string · required

queries. metadata · unknown

queries. query_rating · object

Show child attributes

queries.query_rating. rating · integer<int32> · required

queries.query_rating. metadata · unknown

queries.query_rating. note · string | null