Agrégat de feedback

Agréger le feedback typé du scorer (tags, scores) par intervalles de temps.

POST /feedback/aggregate

Agrégat de feedback

cURL

curl --request POST \
  --url https://api.example.com/feedback/aggregate \
  --header 'Content-Type: application/json' \
  --data '
{
  "after_ms": 1,
  "before_ms": 1,
  "project_id": "<string>",
  "feedback_types": [
    "<string>"
  ],
  "group_by": [],
  "monitor_ids": [
    "<string>"
  ],
  "rating_max": 0.5,
  "rating_min": 0.5,
  "scorer_ids": [
    "<string>"
  ],
  "span_agent_names": [
    "<string>"
  ],
  "span_types": [],
  "tags": [
    "<string>"
  ],
  "time_bucket_seconds": 1
}
'

import requests

url = "https://api.example.com/feedback/aggregate"

payload = {
    "after_ms": 1,
    "before_ms": 1,
    "project_id": "<string>",
    "feedback_types": ["<string>"],
    "group_by": [],
    "monitor_ids": ["<string>"],
    "rating_max": 0.5,
    "rating_min": 0.5,
    "scorer_ids": ["<string>"],
    "span_agent_names": ["<string>"],
    "span_types": [],
    "tags": ["<string>"],
    "time_bucket_seconds": 1
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    after_ms: 1,
    before_ms: 1,
    project_id: '<string>',
    feedback_types: ['<string>'],
    group_by: [],
    monitor_ids: ['<string>'],
    rating_max: 0.5,
    rating_min: 0.5,
    scorer_ids: ['<string>'],
    span_agent_names: ['<string>'],
    span_types: [],
    tags: ['<string>'],
    time_bucket_seconds: 1
  })
};

fetch('https://api.example.com/feedback/aggregate', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/feedback/aggregate",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'after_ms' => 1,
    'before_ms' => 1,
    'project_id' => '<string>',
    'feedback_types' => [
        '<string>'
    ],
    'group_by' => [
        
    ],
    'monitor_ids' => [
        '<string>'
    ],
    'rating_max' => 0.5,
    'rating_min' => 0.5,
    'scorer_ids' => [
        '<string>'
    ],
    'span_agent_names' => [
        '<string>'
    ],
    'span_types' => [
        
    ],
    'tags' => [
        '<string>'
    ],
    'time_bucket_seconds' => 1
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/feedback/aggregate"

	payload := strings.NewReader("{\n  \"after_ms\": 1,\n  \"before_ms\": 1,\n  \"project_id\": \"<string>\",\n  \"feedback_types\": [\n    \"<string>\"\n  ],\n  \"group_by\": [],\n  \"monitor_ids\": [\n    \"<string>\"\n  ],\n  \"rating_max\": 0.5,\n  \"rating_min\": 0.5,\n  \"scorer_ids\": [\n    \"<string>\"\n  ],\n  \"span_agent_names\": [\n    \"<string>\"\n  ],\n  \"span_types\": [],\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"time_bucket_seconds\": 1\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.example.com/feedback/aggregate")
  .header("Content-Type", "application/json")
  .body("{\n  \"after_ms\": 1,\n  \"before_ms\": 1,\n  \"project_id\": \"<string>\",\n  \"feedback_types\": [\n    \"<string>\"\n  ],\n  \"group_by\": [],\n  \"monitor_ids\": [\n    \"<string>\"\n  ],\n  \"rating_max\": 0.5,\n  \"rating_min\": 0.5,\n  \"scorer_ids\": [\n    \"<string>\"\n  ],\n  \"span_agent_names\": [\n    \"<string>\"\n  ],\n  \"span_types\": [],\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"time_bucket_seconds\": 1\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/feedback/aggregate")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"after_ms\": 1,\n  \"before_ms\": 1,\n  \"project_id\": \"<string>\",\n  \"feedback_types\": [\n    \"<string>\"\n  ],\n  \"group_by\": [],\n  \"monitor_ids\": [\n    \"<string>\"\n  ],\n  \"rating_max\": 0.5,\n  \"rating_min\": 0.5,\n  \"scorer_ids\": [\n    \"<string>\"\n  ],\n  \"span_agent_names\": [\n    \"<string>\"\n  ],\n  \"span_types\": [],\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"time_bucket_seconds\": 1\n}"

response = http.request(request)
puts response.read_body

200

{
  "after_ms": 123,
  "before_ms": 123,
  "buckets": [
    {
      "scored_count": 123,
      "total_count": 123,
      "group": {},
      "rating_counts": {},
      "rating_sums": {},
      "tag_counts": {},
      "time_bucket_start_ms": 123
    }
  ],
  "time_bucket_seconds": 123
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Corps

application/json

Requête pour agréger les scores par intervalle de temps et dimension.

after_ms · integer · requis

Borne inférieure incluse sur created_at (millisecondes depuis l’époque Unix).

Plage requise: x >= 0

before_ms · integer · requis

Borne supérieure exclue sur created_at (millisecondes depuis l’époque Unix).

Plage requise: x >= 0

project_id · string · requis

Exemple:

"entity/project"

feedback_types · string[]

Filtre sur feedback_type par préfixe

group_by · enum<string>[]

Valeurs autorisées : ['scorer_id', 'span_agent_name', 'span_agent_version', 'span_status_code'].

Options disponibles: scorer_id, span_agent_name, span_agent_version, span_status_code

monitor_ids · string[]

Filtre sur ces ID de monitor (correspondance exacte ; ajoutez '*' en suffixe pour une correspondance par préfixe).

rating_max · number | null

Inclure uniquement les lignes avec un score <= à cette valeur

Plage requise: 0 <= x <= 1

rating_min · number | null

Inclure uniquement les lignes avec un score >= à cette valeur

Plage requise: 0 <= x <= 1

scorer_ids · string[]

Filtre sur ces ID de scorer (correspondance exacte ; ajoutez '*' en suffixe pour une correspondance par préfixe).

span_agent_names · string[]

Filtre sur les feedbacks dont span_agent_name correspond à l’une de ces valeurs (exact).

span_types · enum<string>[]

Filtre par type de span (tour de conversation ou conversation).

Options disponibles: agent_turn, agent_conversation

tags · string[]

Filtre sur les feedbacks incluant l’un des tags indiqués

time_bucket_seconds · integer | null

Taille de l’intervalle de temps en secondes, par ex. 3600 pour des intervalles d’1 h

Plage requise: x > 0

Réponse

200

application/json

Réponse réussie

Série temporelle clairsemée de feedback agrégé du scorer (intervalles vides omis).

after_ms · integer · requis

Borne inférieure incluse résolue, époque Unix en ms (UTC).

before_ms · integer · requis

Borne supérieure exclue résolue, époque Unix en ms (UTC).

buckets · FeedbackAggregateBucket · object[]

Show child attributes

time_bucket_seconds · integer | null

Taille de l’intervalle de temps utilisée (secondes). None en l’absence d’intervalles.