Get Table Sheet Score

Retrieve Table sheet score data.

GET /api/public/v2/tables/{table_id}/sheets/{sheet_id}/score

Get Table Sheet Score

cURL

curl --request GET \
  --url https://api.promptlayer.com/api/public/v2/tables/{table_id}/sheets/{sheet_id}/score \
  --header 'X-API-KEY: <api-key>'

import requests

url = "https://api.promptlayer.com/api/public/v2/tables/{table_id}/sheets/{sheet_id}/score"

headers = {"X-API-KEY": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};

fetch('https://api.promptlayer.com/api/public/v2/tables/{table_id}/sheets/{sheet_id}/score', 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.promptlayer.com/api/public/v2/tables/{table_id}/sheets/{sheet_id}/score",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-KEY: <api-key>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.promptlayer.com/api/public/v2/tables/{table_id}/sheets/{sheet_id}/score"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-KEY", "<api-key>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.promptlayer.com/api/public/v2/tables/{table_id}/sheets/{sheet_id}/score")
  .header("X-API-KEY", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.promptlayer.com/api/public/v2/tables/{table_id}/sheets/{sheet_id}/score")

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

request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<api-key>'

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

200

{
  "success": true,
  "sheet_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "columns": [
    {
      "column_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "title": "<string>",
      "score": 123,
      "included_count": 123,
      "excluded_count": 123
    }
  ],
  "aggregate_score": 123,
  "total_rows": 123,
  "scored_rows": 123,
  "excluded_rows": 123,
  "calculated_at": "2023-11-07T05:31:56Z",
  "score_matrix": [
    [
      123
    ]
  ],
  "score_matrix_metrics": [
    {
      "key": "<string>",
      "label": "<string>",
      "positive_metric": true
    }
  ],
  "score_calculation_error": "<string>",
  "has_custom_scoring": true,
  "score_configuration": {
    "score_config": {}
  },
  "overall_score": 123,
  "details": {},
  "aggregate": {},
  "per_column": {}
}

{
  "success": false,
  "message": "<string>",
  "error": "<string>"
}

{
  "success": false,
  "message": "<string>",
  "error": "<string>"
}

Retrieve the current score payload for a Table sheet.

When explicit scoring is not configured, PromptLayer returns the default score it can infer from output columns. Configured scoring responses include status and configuration metadata.

Authorizations

X-API-KEY · string · header · required

Headers

X-API-KEY · string · required

Your PromptLayer API key. The key's workspace scopes table resources for this request.

Path Parameters

table_id · string<uuid> · required

Table ID.

sheet_id · string<uuid> · required

Table sheet ID.

Response

200

application/json

Successful response

success · boolean · required

sheet_id · string<uuid> · required

scoring_type · enum<string> | null · required

Available options: auto, boolean, numeric, custom, null

columns · TableSheetScoreColumn · object[] · required

Show child attributes

aggregate_score · number | null · required

total_rows · integer · required

scored_rows · integer · required

excluded_rows · integer · required

calculated_at · string<date-time> | null · required

score_matrix · ((number | string | TableSheetScoreCellObject · object | null)[])[] | null · required

score_matrix_metrics · TableSheetScoreMetric · object[] | null · required

Show child attributes

status · enum<string> | null · required

Available options: queued, running, completed, failed, null

score_calculation_error · string | null · required

has_custom_scoring · boolean · required

score_configuration · TableSheetScoreConfiguration · object | null · required

Show child attributes

score_type · enum<string> · required

Available options: none, single_column, multi_column, custom

overall_score · number | null · required

details · object · required

aggregate · object · required

per_column · object · required